From 3e84a774ef339cd1566062ed620aa668450f8dee Mon Sep 17 00:00:00 2001 From: charithaT07 Date: Wed, 27 May 2026 22:55:28 +0530 Subject: [PATCH 01/13] @W-22210602 cip analytics VS extension (#404) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * @W-22210602 CIP analytics vs extension dashboard * CIP analytics VS extension UX changes - claude assisted * @W-22210602: Adding Analytics report support in VS Code extension (#402) * @W-22210602: Adding CIP analytics to a new menu * @W-22210602: Adding Analytics report support in VS Code extension * @W-22210602: Adding Analytics report support in VS Code extension * fixing the result exports in csv and json * @W-22210602: Adding Analytics report support in VS Code extension * @W-22210602: Adding Analytics report support in VS Code extension * @W-22210602: Adding Analytics report support in VS Code extension * @W-22210602: Adding Analytics report support in VS Code extension * cip analytics report ux refinements --------- Co-authored-by: CharithaT07 * adding some changes in query builder * added some changes in cip analytics vs extension * initial changes for supporting multi realm in CIP * adding save query and multi realm support * adding save query and multi realm support * fixing lint * refactored to make the ux resuable * refactored to make the ux resuable * Merge remote-tracking branch 'upstream/main' into W-22210602-CIP-Analytics-VS-extension * docs: add page-specific SEO descriptions to SCAPI schemas and CI/CD pages These two pages were falling back to the site-wide default meta description. Add concise page-specific descriptions and a doc-only changeset. * fix: bump qs and picomatch to resolve CVE-2026-2391 and CVE-2026-33671 (#450) - qs: 6.14.1 → 6.15.2 (fixes CWE-770 resource allocation without limits) - picomatch: 2.3.1 → 2.3.2, 4.0.3 → 4.0.4 (fixes ReDoS vulnerability) * addressing the review comments * addressing the review comments * fix: dedupe @salesforce/b2c-tooling-sdk in vs-extension package.json after merge --------- Co-authored-by: amit-kumar8-sf Co-authored-by: Charles Lavery Co-authored-by: Kevin He --- .changeset/cip-analytics-vs-extension.md | 11 + .changeset/docs-seo-descriptions.md | 5 + .../fix-qs-picomatch-vulnerabilities.md | 5 + docs/guide/analytics-reports-cip-ccac.md | 36 + packages/b2c-vs-extension/README.md | 3 +- packages/b2c-vs-extension/eslint.config.mjs | 4 +- packages/b2c-vs-extension/package.json | 177 +- .../scripts/esbuild-bundle.mjs | 74 + .../cip-analytics/cip-connection-service.ts | 484 +++ .../cip-query-library-service.ts | 122 + .../src/cip-analytics/cip-styles.css | 3495 +++++++++++++++++ .../src/cip-analytics/cip-tree-provider.ts | 123 + .../src/cip-analytics/cip-webview-manager.ts | 1058 +++++ .../src/cip-analytics/index.ts | 532 +++ .../src/cip-analytics/types.ts | 219 ++ packages/b2c-vs-extension/src/extension.ts | 5 + packages/b2c-vs-extension/src/safety.ts | 1 + packages/b2c-vs-extension/src/telemetry.ts | 3 +- .../src/test/cip-analytics/build-sql.test.ts | 139 + .../format-connection-error.test.ts | 54 + .../query-library-service.test.ts | 115 + .../webview-ui/query-builder/QueryBuilder.tsx | 615 +++ .../query-builder/SaveQueryModal.tsx | 131 + .../query-builder/SavedQueriesMenu.tsx | 135 + .../src/webview-ui/query-builder/buildSql.ts | 52 + .../query-builder/clauses/FromClause.tsx | 30 + .../query-builder/clauses/LimitClause.tsx | 42 + .../query-builder/clauses/OrderByClause.tsx | 73 + .../query-builder/clauses/SelectClause.tsx | 55 + .../query-builder/clauses/WhereClause.tsx | 122 + .../src/webview-ui/query-builder/index.tsx | 13 + .../src/webview-ui/query-builder/reducer.ts | 120 + .../report-dashboard/DateRangePicker.tsx | 129 + .../report-dashboard/ReportDashboard.tsx | 308 ++ .../report-dashboard/ReportForm.tsx | 154 + .../src/webview-ui/report-dashboard/index.tsx | 11 + .../src/webview-ui/report-dashboard/types.ts | 26 + .../webview-ui/shared/bridge/useMessage.ts | 20 + .../src/webview-ui/shared/bridge/vscode.ts | 104 + .../src/webview-ui/shared/components/Chip.tsx | 28 + .../shared/components/ClauseCard.tsx | 38 + .../shared/components/ConnectionBar.tsx | 36 + .../shared/components/EmptyState.tsx | 28 + .../src/webview-ui/shared/components/Icon.tsx | 18 + .../webview-ui/shared/components/Modal.tsx | 47 + .../shared/components/PageHeader.tsx | 34 + .../shared/components/ResultsTable.tsx | 111 + .../shared/components/SegmentedControl.tsx | 33 + .../shared/components/SidebarSection.tsx | 58 + .../webview-ui/shared/components/Spinner.tsx | 16 + .../shared/components/SqlPreview.tsx | 88 + .../shared/components/StatusBar.tsx | 29 + .../src/webview-ui/shared/components/index.ts | 20 + .../shared/hooks/useClipboardCopy.ts | 28 + .../src/webview-ui/shared/types.ts | 72 + .../tables-browser/TablesBrowser.tsx | 311 ++ .../src/webview-ui/tables-browser/index.tsx | 11 + packages/b2c-vs-extension/tsconfig.json | 2 +- packages/b2c-vs-extension/tsconfig.test.json | 3 +- .../b2c-vs-extension/tsconfig.webview.json | 16 + pnpm-lock.yaml | 524 ++- 61 files changed, 10153 insertions(+), 203 deletions(-) create mode 100644 .changeset/cip-analytics-vs-extension.md create mode 100644 .changeset/docs-seo-descriptions.md create mode 100644 .changeset/fix-qs-picomatch-vulnerabilities.md create mode 100644 packages/b2c-vs-extension/src/cip-analytics/cip-connection-service.ts create mode 100644 packages/b2c-vs-extension/src/cip-analytics/cip-query-library-service.ts create mode 100644 packages/b2c-vs-extension/src/cip-analytics/cip-styles.css create mode 100644 packages/b2c-vs-extension/src/cip-analytics/cip-tree-provider.ts create mode 100644 packages/b2c-vs-extension/src/cip-analytics/cip-webview-manager.ts create mode 100644 packages/b2c-vs-extension/src/cip-analytics/index.ts create mode 100644 packages/b2c-vs-extension/src/cip-analytics/types.ts create mode 100644 packages/b2c-vs-extension/src/test/cip-analytics/build-sql.test.ts create mode 100644 packages/b2c-vs-extension/src/test/cip-analytics/format-connection-error.test.ts create mode 100644 packages/b2c-vs-extension/src/test/cip-analytics/query-library-service.test.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/QueryBuilder.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/SaveQueryModal.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/SavedQueriesMenu.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/buildSql.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/clauses/FromClause.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/clauses/LimitClause.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/clauses/OrderByClause.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/clauses/SelectClause.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/clauses/WhereClause.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/index.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/query-builder/reducer.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/report-dashboard/DateRangePicker.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/report-dashboard/ReportDashboard.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/report-dashboard/ReportForm.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/report-dashboard/index.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/report-dashboard/types.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/bridge/useMessage.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/bridge/vscode.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/Chip.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/ClauseCard.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/ConnectionBar.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/EmptyState.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/Icon.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/Modal.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/PageHeader.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/ResultsTable.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/SegmentedControl.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/SidebarSection.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/Spinner.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/SqlPreview.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/StatusBar.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/components/index.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/hooks/useClipboardCopy.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/shared/types.ts create mode 100644 packages/b2c-vs-extension/src/webview-ui/tables-browser/TablesBrowser.tsx create mode 100644 packages/b2c-vs-extension/src/webview-ui/tables-browser/index.tsx create mode 100644 packages/b2c-vs-extension/tsconfig.webview.json diff --git a/.changeset/cip-analytics-vs-extension.md b/.changeset/cip-analytics-vs-extension.md new file mode 100644 index 000000000..663b4be79 --- /dev/null +++ b/.changeset/cip-analytics-vs-extension.md @@ -0,0 +1,11 @@ +--- +'b2c-vs-extension': minor +--- + +Add B2C-DX Analytics (CIP/CCAC) feature to the VS Code extension. Surfaces three webview panels: + +- **Query Builder** — visual SELECT/FROM/WHERE/ORDER BY/LIMIT composer with raw-SQL toggle and a workspace-scoped Saved Queries library tagged per tenant. +- **Tables Browser** — schema explorer for the active CIP warehouse tenant. +- **Curated Reports** — parameter forms for every `cip report …` command with date pickers, validation, sortable result grid, and CSV/JSON export. + +Adds multi-realm management (group, add, edit, switch, remove) so a single workspace can target multiple tenants. CIP commands now route through `registerSafeCommand` so SafetyGuard policies are enforced and a `cipAnalytics` feature category is recorded by usage telemetry. The shared webview stylesheet is copied into `dist/cip-analytics/` at build time so the packaged extension no longer reaches into `src/` for runtime assets. diff --git a/.changeset/docs-seo-descriptions.md b/.changeset/docs-seo-descriptions.md new file mode 100644 index 000000000..f4480c5be --- /dev/null +++ b/.changeset/docs-seo-descriptions.md @@ -0,0 +1,5 @@ +--- +'@salesforce/b2c-dx-docs': patch +--- + +Add page-specific SEO meta descriptions to the SCAPI Schemas CLI reference and CI/CD guide pages, replacing the site-wide default description. diff --git a/.changeset/fix-qs-picomatch-vulnerabilities.md b/.changeset/fix-qs-picomatch-vulnerabilities.md new file mode 100644 index 000000000..68e554bec --- /dev/null +++ b/.changeset/fix-qs-picomatch-vulnerabilities.md @@ -0,0 +1,5 @@ +--- +'@salesforce/mrt-utilities': patch +--- + +Bump qs to 6.15.2 and picomatch to 2.3.2/4.0.4 to resolve CVE-2026-2391 and CVE-2026-33671 diff --git a/docs/guide/analytics-reports-cip-ccac.md b/docs/guide/analytics-reports-cip-ccac.md index 5156af6e8..58d281adf 100644 --- a/docs/guide/analytics-reports-cip-ccac.md +++ b/docs/guide/analytics-reports-cip-ccac.md @@ -260,6 +260,42 @@ See the SDK API reference: - [createCipClient helper](/api/clients/functions/createCipClient) - [CIP Operations API](/api/operations/cip/) +## VS Code IDE Integration + +The B2C Commerce Developer Tools VS Code extension exposes the same CIP analytics workflows as a graphical experience. Open the **B2C-DX Analytics** view in the activity bar to access them. + +::: tip +You don't need to install or configure the CLI separately — the extension uses the same SDK under the hood and reads from your workspace `dw.json` (or environment variables). +::: + +### Available panels + +- **Query Builder** — visual SELECT / FROM / WHERE / ORDER BY / LIMIT composer with a "Saved Queries" library so you can bookmark frequently-used queries per tenant. Switch to **SQL** mode for raw query editing. +- **Tables Browser** — schema explorer that lists every CIP warehouse table for the active tenant. Click a table to inspect its columns and types. +- **Curated Reports** — opens any `cip report` command (sales analytics, top-selling products, etc.) in a parameter form with date pickers, validation, CSV/JSON export, and a sortable result grid. + +### Realm management + +The sidebar tree groups tenants under named realms. Each realm can hold multiple connections (e.g., production + sandbox). Use the toolbar actions to: + +- **Add Realm** — create a new realm group (e.g. `abcd`). +- **Configure / Edit** — set tenant ID, environment (production / staging / custom host), and run a connection test. +- **Switch Connection** — change which realm/tenant the open panels query against. All open Query Builder, Tables Browser, and Report panels follow the active connection. + +### Saving queries + +Inside the Query Builder, the **Save** button persists the current SQL into a workspace-scoped library, tagged with the active tenant. Saved queries appear in the **Saved Queries** dropdown — those authored against the current tenant are listed first; queries from other tenants appear dimmed below a divider so you can still recall them after switching connections. + +The library is stored in VS Code workspace state (`b2c-dx.cipAnalytics.savedQueries`). It is not committed to source control. + +### Telemetry + +Opening any CIP Analytics panel records a single per-session usage event under the `cipAnalytics` feature category. No SQL text or query results are collected. To opt out, set `b2c-dx.telemetry.enabled` to `false` in VS Code settings (or disable VS Code's global telemetry). See the [VS Code extension configuration](/vscode-extension/configuration#verbosity-polling-telemetry) for details. + +### Safety mode + +CIP commands flow through the same SafetyGuard as the rest of the extension. If your workspace defines a [safety policy](/guide/safety) that blocks or confirms a CIP command, the policy is enforced before the panel opens. + ## Next Steps - [CIP Commands](/cli/cip) for full command reference and flags diff --git a/packages/b2c-vs-extension/README.md b/packages/b2c-vs-extension/README.md index e3080df22..1c3c2288e 100644 --- a/packages/b2c-vs-extension/README.md +++ b/packages/b2c-vs-extension/README.md @@ -1,6 +1,6 @@ # B2C DX - VS Code Extension -VS Code extension for B2C Commerce developer experience: sandbox realm explorer, cartridge code sync, WebDAV browser, content libraries, SCAPI API browser, B2C script debugger, scaffold/CAP install, log tailing, and a Page Designer Assistant. +VS Code extension for B2C Commerce developer experience: sandbox realm explorer, cartridge code sync, WebDAV browser, content libraries, SCAPI API browser, B2C script debugger, scaffold/CAP install, log tailing, CIP analytics (Query Builder + curated reports), and a Page Designer Assistant. **User-facing documentation:** [B2C DX VS Code Extension](https://salesforcecommercecloud.github.io/b2c-developer-tooling/vscode-extension/) — overview, installation, configuration, and feature tour. @@ -17,6 +17,7 @@ This README is the source of truth for repo-level developer info (build/watch, l - Scaffold (`New from Scaffold...`) and CAP install. - Log tailing into a dedicated output channel. - Page Designer Assistant webview (Storefront Next page generation). +- B2C-DX Analytics — CIP/CCAC Query Builder, Tables Browser, curated reports, multi-realm support, saved-query library. See the [docs site](https://salesforcecommercecloud.github.io/b2c-developer-tooling/vscode-extension/features) for the full tour. diff --git a/packages/b2c-vs-extension/eslint.config.mjs b/packages/b2c-vs-extension/eslint.config.mjs index 94458852a..cc8905264 100644 --- a/packages/b2c-vs-extension/eslint.config.mjs +++ b/packages/b2c-vs-extension/eslint.config.mjs @@ -22,12 +22,12 @@ export default [ ...tseslint.configs.recommended, prettierPlugin, { - files: ['**/*.ts'], + files: ['**/*.ts', '**/*.tsx'], plugins: { header: headerPlugin, }, languageOptions: { - parserOptions: {ecmaVersion: 2022, sourceType: 'module'}, + parserOptions: {ecmaVersion: 2022, sourceType: 'module', ecmaFeatures: {jsx: true}}, }, rules: { 'header/header': ['error', 'block', copyrightHeader], diff --git a/packages/b2c-vs-extension/package.json b/packages/b2c-vs-extension/package.json index 705ff9ef0..a98d86496 100644 --- a/packages/b2c-vs-extension/package.json +++ b/packages/b2c-vs-extension/package.json @@ -14,7 +14,9 @@ "type": "module", "dependencies": { "@salesforce/b2c-script-types": "workspace:*", - "@salesforce/b2c-tooling-sdk": "workspace:*" + "@salesforce/b2c-tooling-sdk": "workspace:*", + "react": "18.3.1", + "react-dom": "18.3.1" }, "engines": { "vscode": "^1.105.1" @@ -115,6 +117,11 @@ "type": "boolean", "default": true, "description": "Send anonymous usage telemetry (extension lifecycle and broad feature-category events). Honors VS Code's telemetry.telemetryLevel — disabling that disables this regardless of this setting." + }, + "b2c-dx.features.cipAnalytics": { + "type": "boolean", + "default": true, + "description": "Enable the B2C-DX Analytics (CIP) sidebar for browsing tables and running curated reports." } } }, @@ -140,6 +147,11 @@ "id": "b2c-dx-sandboxes", "title": "B2C-DX Sandboxes", "icon": "$(server-environment)" + }, + { + "id": "b2c-dx-analytics", + "title": "B2C-DX Analytics", + "icon": "$(graph)" } ] }, @@ -164,6 +176,14 @@ "contextualTitle": "B2C-DX" } ], + "b2c-dx-analytics": [ + { + "id": "b2cCipAnalytics", + "name": "CIP Analytics", + "icon": "$(graph)", + "contextualTitle": "B2C-DX Analytics" + } + ], "b2c-dx-scapi": [ { "id": "b2cApiBrowser", @@ -200,6 +220,10 @@ { "view": "b2cCartridgeExplorer", "contents": "No cartridges found.\n\nCartridges are identified by .project files in the workspace.\n\n[Refresh](command:b2c-dx.codeSync.refreshCartridges)" + }, + { + "view": "b2cCipAnalytics", + "contents": "Explore Commerce Intelligence Platform (CIP) data — build SQL queries visually, browse tables, and run curated reports.\n\n[Open Query Builder](command:b2c-dx.cipAnalytics.queryBuilder)\n[Browse Tables](command:b2c-dx.cipAnalytics.browseTables)\n\nRequires OAuth credentials (clientId, clientSecret) in dw.json.\n\n[Refresh](command:b2c-dx.cipAnalytics.refresh)" } ], "debuggers": [ @@ -266,6 +290,71 @@ "title": "Open API Documentation", "category": "B2C DX - API Browser" }, + { + "command": "b2c-dx.cipAnalytics.refresh", + "title": "Refresh", + "icon": "$(refresh)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.resetFromDwJson", + "title": "Reset from dw.json…", + "icon": "$(discard)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.openReport", + "title": "Open Report", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.browseTables", + "title": "Browse Tables", + "icon": "$(table)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.queryBuilder", + "title": "Open Query Builder", + "icon": "$(zap)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.configureConnection", + "title": "Configure Connection…", + "icon": "$(gear)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.testConnection", + "title": "Test Connection", + "icon": "$(debug-disconnect)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.switchRealm", + "title": "Switch Realm…", + "icon": "$(server)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.switchConnection", + "title": "Switch Connection…", + "icon": "$(plug)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.addRealm", + "title": "Add Realm…", + "icon": "$(add)", + "category": "B2C-DX Analytics" + }, + { + "command": "b2c-dx.cipAnalytics.removeRealm", + "title": "Remove Realm…", + "icon": "$(trash)", + "category": "B2C-DX Analytics" + }, { "command": "b2c-dx.sandbox.refresh", "title": "Refresh", @@ -664,6 +753,26 @@ "when": "view == b2cCartridgeExplorer", "group": "navigation" }, + { + "command": "b2c-dx.cipAnalytics.removeRealm", + "when": "view == b2cCipAnalytics", + "group": "navigation@0" + }, + { + "command": "b2c-dx.cipAnalytics.addRealm", + "when": "view == b2cCipAnalytics", + "group": "navigation@0" + }, + { + "command": "b2c-dx.cipAnalytics.refresh", + "when": "view == b2cCipAnalytics", + "group": "navigation@4" + }, + { + "command": "b2c-dx.cipAnalytics.resetFromDwJson", + "when": "view == b2cCipAnalytics", + "group": "navigation@9" + }, { "command": "b2c-dx.codeSync.deploy", "when": "view == b2cCartridgeExplorer", @@ -686,6 +795,26 @@ } ], "view/item/context": [ + { + "command": "b2c-dx.cipAnalytics.switchConnection", + "when": "view == b2cCipAnalytics && viewItem == cipRealm", + "group": "inline@0" + }, + { + "command": "b2c-dx.cipAnalytics.removeRealm", + "when": "view == b2cCipAnalytics && viewItem == cipRealm", + "group": "2_realm@0" + }, + { + "command": "b2c-dx.cipAnalytics.testConnection", + "when": "view == b2cCipAnalytics && viewItem == cipRealmInfo", + "group": "inline@0" + }, + { + "command": "b2c-dx.cipAnalytics.configureConnection", + "when": "view == b2cCipAnalytics && viewItem == cipRealmInfo", + "group": "inline@1" + }, { "command": "b2c-dx.webdav.addCatalog", "when": "view == b2cWebdavExplorer && viewItem == virtual-root-catalogs", @@ -899,6 +1028,50 @@ } ], "commandPalette": [ + { + "command": "b2c-dx.cipAnalytics.refresh", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.resetFromDwJson", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.openReport", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.browseTables", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.queryBuilder", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.configureConnection", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.testConnection", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.switchRealm", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.switchConnection", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.addRealm", + "when": "config.b2c-dx.features.cipAnalytics" + }, + { + "command": "b2c-dx.cipAnalytics.removeRealm", + "when": "config.b2c-dx.features.cipAnalytics" + }, { "command": "b2c-dx.apiBrowser.openSwagger", "when": "false" @@ -1061,6 +1234,8 @@ "@eslint/compat": "catalog:", "@types/mocha": "catalog:", "@types/node": "catalog:", + "@types/react": "18.3.12", + "@types/react-dom": "18.3.1", "@types/vscode": "^1.105.1", "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", diff --git a/packages/b2c-vs-extension/scripts/esbuild-bundle.mjs b/packages/b2c-vs-extension/scripts/esbuild-bundle.mjs index 3b36c9259..52713b54e 100644 --- a/packages/b2c-vs-extension/scripts/esbuild-bundle.mjs +++ b/packages/b2c-vs-extension/scripts/esbuild-bundle.mjs @@ -87,6 +87,32 @@ function copyScriptTypesPlugin() { console.log('[script-types] staged', path.relative(pkgRoot, dest)); } +function copyCipProtoFiles() { + const src = path.join(sdkRoot, 'data', 'cip-proto'); + const dest = path.join(pkgRoot, 'dist', 'data', 'cip-proto'); + if (!fs.existsSync(src)) return; + fs.mkdirSync(dest, {recursive: true}); + fs.cpSync(src, dest, {recursive: true}); + console.log('[cip-proto] Copied proto files to dist/data/cip-proto/'); +} + +/** + * Copy raw CIP webview stylesheet into dist/ so the packaged extension never + * reaches back into src/. Mirrors how cip-proto data files are copied above. + * + * The webview UI scripts go through esbuild → dist/webview-ui/ Copying it + * keeps the runtime resource layout consistent (everything under dist/). + * keeps the runtime resource layout consistent (everything under dist/). + */ +function copyCipStyles() { + const src = path.join(pkgRoot, 'src', 'cip-analytics', 'cip-styles.css'); + if (!fs.existsSync(src)) return; + const destDir = path.join(pkgRoot, 'dist', 'cip-analytics'); + fs.mkdirSync(destDir, {recursive: true}); + fs.copyFileSync(src, path.join(destDir, 'cip-styles.css')); + console.log('[cip-styles] Copied cip-styles.css to dist/cip-analytics/'); +} + function inlineSdkPackageJson() { const outPath = path.join(pkgRoot, 'dist', 'extension.cjs'); let str = fs.readFileSync(outPath, 'utf8'); @@ -132,20 +158,68 @@ const buildOptions = { logLevel: 'info', }; +// Webview UI bundles. Each entry compiles a React app for one webview panel +// (Query Builder, Tables Browser, Report Dashboard). Targets the browser since +// these run inside a VS Code webview, not the extension host. +const webviewUiSrc = path.join(pkgRoot, 'src', 'webview-ui'); +const webviewBuildOptions = { + entryPoints: { + 'query-builder': path.join(webviewUiSrc, 'query-builder', 'index.tsx'), + 'tables-browser': path.join(webviewUiSrc, 'tables-browser', 'index.tsx'), + 'report-dashboard': path.join(webviewUiSrc, 'report-dashboard', 'index.tsx'), + }, + outdir: path.join(pkgRoot, 'dist', 'webview-ui'), + bundle: true, + platform: 'browser', + format: 'esm', + target: 'es2022', + sourcemap: true, + jsx: 'automatic', + loader: {'.css': 'text'}, + define: { + 'process.env.NODE_ENV': watchMode ? '"development"' : '"production"', + }, + logLevel: 'info', +}; + if (watchMode) { copySdkScaffolds(); copyScriptTypesPlugin(); + copyCipProtoFiles(); + copyCipStyles(); const ctx = await esbuild.context(buildOptions); await ctx.watch(); console.log('[esbuild] watching for changes...'); + + // Watch webview-ui in parallel; failures inside the React bundles must not bring + // down the extension host build, so each runs in its own context. + if (fs.existsSync(webviewUiSrc)) { + const webviewCtx = await esbuild.context(webviewBuildOptions); + await webviewCtx.watch(); + console.log('[esbuild] watching webview-ui for changes...'); + } } else { const result = await esbuild.build(buildOptions); inlineSdkPackageJson(); copySdkScaffolds(); copyScriptTypesPlugin(); + copyCipProtoFiles(); + copyCipStyles(); copySwaggerUiAssets(); + if (fs.existsSync(webviewUiSrc)) { + try { + await esbuild.build(webviewBuildOptions); + console.log('[webview-ui] Built webview UI bundles into dist/webview-ui/'); + } catch (err) { + // Surface a clean error so CI logs a single recognisable line instead of + // letting esbuild's stack ride out as the top-level rejection. + console.error('[webview-ui] Build failed:', err instanceof Error ? err.message : err); + process.exit(1); + } + } + if (result.metafile && process.env.ANALYZE_BUNDLE) { const metaPath = path.join(pkgRoot, 'dist', 'meta.json'); fs.writeFileSync(metaPath, JSON.stringify(result.metafile, null, 2), 'utf-8'); diff --git a/packages/b2c-vs-extension/src/cip-analytics/cip-connection-service.ts b/packages/b2c-vs-extension/src/cip-analytics/cip-connection-service.ts new file mode 100644 index 000000000..d244e3052 --- /dev/null +++ b/packages/b2c-vs-extension/src/cip-analytics/cip-connection-service.ts @@ -0,0 +1,484 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ +import {createCipClient, DEFAULT_CIP_HOST, DEFAULT_CIP_STAGING_HOST} from '@salesforce/b2c-tooling-sdk/clients'; +import {listCipTables} from '@salesforce/b2c-tooling-sdk/operations/cip'; +import {randomUUID} from 'node:crypto'; +import * as vscode from 'vscode'; +import type {B2CExtensionConfig} from '../config-provider.js'; + +export type CipEnv = 'prod' | 'staging' | 'custom'; +export type CipStatus = 'disconnected' | 'testing' | 'connected'; + +/** A named realm group (e.g. "bjmp"). Contains one or more connections. */ +export interface CipRealmGroup { + id: string; + label: string; +} + +/** Persisted configuration for a single connection within a realm group. */ +export interface CipRealm { + id: string; + groupId: string; + label: string; + tenantId: string; + env: CipEnv; + host: string; +} + +/** Runtime connection state (realm config + live status). */ +export interface CipConnection extends CipRealm { + status: CipStatus; + message?: string; +} + +const GROUPS_KEY = 'b2c-dx.cipAnalytics.groups'; +const REALMS_KEY = 'b2c-dx.cipAnalytics.realms'; +const ACTIVE_REALM_KEY = 'b2c-dx.cipAnalytics.activeRealm'; +/** Legacy key — migrated on first load. */ +const LEGACY_KEY = 'b2c-dx.cipAnalytics.connection'; + +/** + * Single source of truth for CIP realm connections. + * + * Supports multiple saved realms (tenant + env + host) with a single active + * realm at any time. Every webview panel shares the same active connection. + */ +export class CipConnectionService implements vscode.Disposable { + private connection: CipConnection; + private groups: CipRealmGroup[]; + private realms: CipRealm[]; + /** Session-only per-connection status. Not persisted. */ + private readonly realmStatusMap = new Map(); + private readonly _onDidChange = new vscode.EventEmitter(); + readonly onDidChange = this._onDidChange.event; + + constructor( + private readonly configProvider: B2CExtensionConfig, + private readonly workspaceState: vscode.Memento, + private readonly log: vscode.OutputChannel, + ) { + const {groups, realms, active} = this.loadInitial(); + this.groups = groups; + this.realms = realms; + this.connection = {...active, status: 'disconnected'}; + + // Re-sync tenantId/host from dw.json whenever the config file changes. + this.configProvider.onDidReset(() => { + const {groups: refreshedGroups, realms: refreshed, active: refreshedActive} = this.loadInitial(); + this.groups = refreshedGroups; + this.realms = refreshed; + this.connection = {...refreshedActive, status: 'disconnected'}; + this.realmStatusMap.clear(); + this._onDidChange.fire(this.get()); + }); + } + + /** Current active connection (realm config + live status). */ + get(): CipConnection { + return {...this.connection}; + } + + /** All realm groups. */ + getRealmGroups(): CipRealmGroup[] { + return [...this.groups]; + } + + /** All connections belonging to a group. */ + getConnectionsForGroup(groupId: string): CipRealm[] { + return this.realms.filter((r) => r.groupId === groupId); + } + + /** All saved realms (connections). */ + getRealms(): CipRealm[] { + return [...this.realms]; + } + + /** Session status for a specific realm (defaults to disconnected). */ + getRealmStatus(realmId: string): CipStatus { + return this.realmStatusMap.get(realmId) ?? 'disconnected'; + } + + /** Resolved host for the active connection. */ + resolvedHost(): string { + return resolveHost(this.connection); + } + + /** + * Clear all persisted realms/groups and reload purely from dw.json. + * Called when the user clicks the Refresh button — only dw.json-derived + * realms survive; manually added realms and the legacy single-connection + * fallback are discarded. + */ + async resetToDefaults(): Promise { + // Derive fresh data from dw.json only, ignoring any legacy stored state. + const {groups, realms, active} = this.deriveFromConfig({ignoreLegacy: true}); + + // Overwrite stored state with the fresh dw.json-derived data. + this.groups = groups; + this.realms = realms; + this.connection = {...active, status: 'disconnected'}; + this.realmStatusMap.clear(); + + await this.workspaceState.update(GROUPS_KEY, this.groups); + await this.workspaceState.update(REALMS_KEY, this.realms); + await this.workspaceState.update(ACTIVE_REALM_KEY, undefined); + // Drop the legacy single-connection key so it can't resurrect stale state + // on the next reload — dw.json is now the sole source of truth. + await this.workspaceState.update(LEGACY_KEY, undefined); + this._onDidChange.fire(this.get()); + } + + /** + * Derive realm group + connection from dw.json config. + * + * On normal load we honor the legacy single-connection key as a fallback so + * users who upgraded from the older single-realm extension don't lose their + * settings. On a hard refresh (`ignoreLegacy: true`) we skip the legacy key + * entirely, making dw.json the sole source of truth. + */ + private deriveFromConfig(opts: {ignoreLegacy?: boolean} = {}): { + groups: CipRealmGroup[]; + realms: CipRealm[]; + active: CipConnection; + } { + const legacy = opts.ignoreLegacy ? undefined : this.workspaceState.get>(LEGACY_KEY); + const config = this.configProvider.getConfig(); + const cfgTenant = (config?.values.tenantId ?? '').toString(); + const cfgHost = config?.values.cipHost?.toString(); + + let env: CipEnv = 'prod'; + let host = DEFAULT_CIP_HOST; + + // dw.json wins over legacy when both are present — the user-edited file + // is always more authoritative than the older single-connection cache. + if (cfgHost && cfgHost !== DEFAULT_CIP_HOST && cfgHost !== DEFAULT_CIP_STAGING_HOST) { + env = 'custom'; + host = cfgHost; + } else if (cfgHost === DEFAULT_CIP_STAGING_HOST) { + env = 'staging'; + host = DEFAULT_CIP_STAGING_HOST; + } else if (legacy?.env) { + env = legacy.env; + host = legacy.host ?? (env === 'staging' ? DEFAULT_CIP_STAGING_HOST : DEFAULT_CIP_HOST); + } + + const tenantId = cfgTenant || legacy?.tenantId || ''; + if (!tenantId) { + return {groups: [], realms: [], active: makeBlankConnection()}; + } + + const groupLabel = labelFromTenantId(tenantId); + const group: CipRealmGroup = {id: generateId(), label: groupLabel}; + const realm: CipRealm = { + id: generateId(), + groupId: group.id, + label: groupLabel, + tenantId, + env, + host, + }; + return {groups: [group], realms: [realm], active: {...realm, status: 'disconnected'}}; + } + + /** + * Add a new realm group (just a label). Returns the group id. + */ + async addRealmGroup(label: string): Promise { + const existing = this.groups.find((g) => g.label.toLowerCase() === label.toLowerCase()); + if (existing) return existing.id; + const group: CipRealmGroup = {id: generateId(), label}; + this.groups.push(group); + await this.workspaceState.update(GROUPS_KEY, this.groups); + this._onDidChange.fire(this.get()); + return group.id; + } + + /** + * Add a new connection within a group. If a connection with the same tenantId+env already exists, + * updates it in place. Returns the connection id. + */ + async addRealm(config: Omit): Promise { + const existing = this.realms.find((r) => r.tenantId === config.tenantId && r.env === config.env); + if (existing) { + Object.assign(existing, config); + await this.persistRealms(); + return existing.id; + } + const realm: CipRealm = {id: generateId(), ...config}; + this.realms.push(realm); + await this.persistRealms(); + return realm.id; + } + + /** Remove a realm group and all connections within it. */ + async removeRealmGroup(groupId: string): Promise { + const exists = this.groups.some((g) => g.id === groupId); + if (!exists) return; + + const removedRealmIds = new Set(this.realms.filter((r) => r.groupId === groupId).map((r) => r.id)); + + this.groups = this.groups.filter((g) => g.id !== groupId); + this.realms = this.realms.filter((r) => r.groupId !== groupId); + for (const realmId of removedRealmIds) { + this.realmStatusMap.delete(realmId); + } + + await this.workspaceState.update(GROUPS_KEY, this.groups); + await this.persistRealms(); + + if (this.connection.groupId === groupId || removedRealmIds.has(this.connection.id)) { + const fallback = this.realms[0]; + if (fallback) { + this.connection = {...fallback, status: 'disconnected', message: undefined}; + await this.workspaceState.update(ACTIVE_REALM_KEY, fallback.id); + } else { + this.connection = makeBlankConnection(); + await this.workspaceState.update(ACTIVE_REALM_KEY, undefined); + } + } + + this._onDidChange.fire(this.get()); + } + + /** Remove a saved realm by id. If it was active, falls back to the first remaining realm. */ + async removeRealm(id: string): Promise { + const before = this.realms.length; + this.realms = this.realms.filter((r) => r.id !== id); + if (this.realms.length === before) return; + this.realmStatusMap.delete(id); + await this.persistRealms(); + if (this.connection.id === id) { + const fallback = this.realms[0]; + if (fallback) { + await this.switchRealm(fallback.id); + } else { + this.connection = makeBlankConnection(); + this._onDidChange.fire(this.get()); + } + } else { + // Always notify subscribers (tree, status bar) even when the active realm + // didn't change — a non-active realm went away and the sidebar needs to + // re-render to reflect it. + this._onDidChange.fire(this.get()); + } + } + + /** + * Switch the active realm. Resets status to disconnected. + */ + async switchRealm(id: string): Promise { + const realm = this.realms.find((r) => r.id === id); + if (!realm) return; + this.connection = {...realm, status: 'disconnected', message: undefined}; + await this.workspaceState.update(ACTIVE_REALM_KEY, id); + this._onDidChange.fire(this.get()); + } + + /** + * Update the active realm configuration. Resets status to `disconnected`. + */ + async update(partial: Partial>): Promise { + const next: CipConnection = { + ...this.connection, + ...partial, + status: 'disconnected', + message: undefined, + }; + // Auto-derive label from tenantId if not explicitly set. + if (!partial.label && partial.tenantId) { + next.label = labelFromTenantId(partial.tenantId); + } + + if (next.env === 'prod') next.host = DEFAULT_CIP_HOST; + else if (next.env === 'staging') next.host = DEFAULT_CIP_STAGING_HOST; + + this.connection = next; + + // Keep the realm list in sync. + const idx = this.realms.findIndex((r) => r.id === this.connection.id); + if (idx >= 0) { + this.realms[idx] = realmFrom(next); + } else { + this.realms.push(realmFrom(next)); + } + await this.persistRealms(); + await this.workspaceState.update(ACTIVE_REALM_KEY, this.connection.id); + this._onDidChange.fire(this.get()); + } + + /** + * Run a live connection test against the active realm and update status. + */ + async testConnection(): Promise { + if (!this.connection.tenantId) { + this.setStatus('disconnected', 'Tenant ID not set'); + return this.get(); + } + if (this.connection.env === 'custom' && !this.connection.host) { + this.setStatus('disconnected', 'Custom host not set'); + return this.get(); + } + + const host = resolveHost(this.connection); + this.setStatus('testing', `Connecting to CIP host ${host}`); + + const TIMEOUT_MS = 15_000; + // Track the timer so we can clear it once the handshake settles. Without + // the clear, a fast-returning request still keeps the timer pending and + // its rejection runs later as a no-op against an already-resolved race — + // not user-visible, but pollutes the event loop. + let timeoutId: ReturnType | undefined; + const timeoutPromise = new Promise((_, reject) => { + timeoutId = setTimeout(() => reject(new Error(`Connection timed out after ${TIMEOUT_MS / 1000}s`)), TIMEOUT_MS); + }); + + try { + const config = this.configProvider.getConfig(); + if (!config) throw new Error('No B2C configuration found'); + const client = createCipClient({instance: this.connection.tenantId, host}, config.createOAuth()); + const result = await Promise.race([listCipTables(client, {fetchSize: 1}), timeoutPromise]); + this.log.appendLine( + `[CIP Connection] OK · realm=${this.connection.label} tenant=${this.connection.tenantId} host=${host} tables=${result.tableCount}`, + ); + this.setStatus('connected', `${result.tableCount} tables available @ ${host}`); + } catch (err) { + const message = err instanceof Error ? err.message : String(err); + this.log.appendLine(`[CIP Connection] FAILED · ${message}`); + this.setStatus('disconnected', message); + } finally { + if (timeoutId !== undefined) clearTimeout(timeoutId); + } + return this.get(); + } + + /** Marks the connection healthy without a fresh handshake. */ + markConnected(detail?: string): void { + if (this.connection.status !== 'connected') { + this.setStatus('connected', detail); + } + } + + /** Marks the connection unhealthy. */ + markDisconnected(detail?: string): void { + this.setStatus('disconnected', detail); + } + + dispose(): void { + this._onDidChange.dispose(); + } + + private setStatus(status: CipStatus, message?: string): void { + this.connection = {...this.connection, status, message}; + this.realmStatusMap.set(this.connection.id, status); + this._onDidChange.fire(this.get()); + } + + private async persistRealms(): Promise { + await this.workspaceState.update(REALMS_KEY, this.realms); + } + + private loadInitial(): {groups: CipRealmGroup[]; realms: CipRealm[]; active: CipConnection} { + const storedGroups = this.workspaceState.get(GROUPS_KEY); + const storedRealms = this.workspaceState.get(REALMS_KEY); + const activeId = this.workspaceState.get(ACTIVE_REALM_KEY); + + if (storedRealms && storedRealms.length > 0) { + const config = this.configProvider.getConfig(); + const cfgHost = config?.values.cipHost?.toString().trim(); + + // Build group map from stored groups, or auto-create from realm labels. + const groupMap = new Map(); + if (storedGroups) { + for (const g of storedGroups) groupMap.set(g.id, g); + } + + // Fix stale labels, sync custom host, and backfill missing groupId. + let fixed = storedRealms.map((r) => { + let updated: CipRealm = r as CipRealm; + if (updated.label === updated.tenantId) { + updated = {...updated, label: labelFromTenantId(updated.tenantId)}; + } + if (updated.env === 'custom' && cfgHost && cfgHost !== updated.host) { + updated = {...updated, host: cfgHost}; + } + // Backfill groupId for realms saved before groups existed. + if (!updated.groupId) { + const groupLabel = updated.label; + const existing = [...groupMap.values()].find((g) => g.label === groupLabel); + if (existing) { + updated = {...updated, groupId: existing.id}; + } else { + const g: CipRealmGroup = {id: generateId(), label: groupLabel}; + groupMap.set(g.id, g); + updated = {...updated, groupId: g.id}; + } + } + return updated; + }); + + // Deduplicate by tenantId — keep the first occurrence. + const seen = new Set(); + fixed = fixed.filter((r) => { + if (seen.has(r.tenantId)) return false; + seen.add(r.tenantId); + return true; + }); + + const groups = [...groupMap.values()]; + const changed = fixed.length !== storedRealms.length || fixed.some((r, i) => r !== storedRealms[i]); + if (changed) { + void this.workspaceState.update(REALMS_KEY, fixed); + void this.workspaceState.update(GROUPS_KEY, groups); + } + const active = (activeId && fixed.find((r) => r.id === activeId)) || fixed[0]!; + return {groups, realms: fixed, active: {...active, status: 'disconnected'}}; + } + + // No stored realms — derive fresh from dw.json / legacy key. + return this.deriveFromConfig(); + } +} + +// ── helpers ────────────────────────────────────────────────────────────────── + +function resolveHost(realm: Pick): string { + if (realm.env === 'custom' && realm.host) return realm.host; + return realm.env === 'staging' ? DEFAULT_CIP_STAGING_HOST : DEFAULT_CIP_HOST; +} + +function realmFrom(conn: CipConnection): CipRealm { + return { + id: conn.id, + groupId: conn.groupId, + label: conn.label, + tenantId: conn.tenantId, + env: conn.env, + host: conn.host, + }; +} + +function generateId(): string { + return randomUUID(); +} + +/** Derive a short friendly label from a tenant ID by stripping common env suffixes. + * e.g. "bjmp_prd" → "bjmp", "acme_sbx001" → "acme", "myorg" → "myorg" + */ +function labelFromTenantId(tenantId: string): string { + return tenantId.replace(/_(?:prd|prod|pr|sbx|sandbox|sb|stg|staging|st|dev|dv|uat|qa)\w*$/i, '') || tenantId; +} + +function makeBlankConnection(): CipConnection { + return { + id: generateId(), + groupId: '', + label: '', + tenantId: '', + env: 'prod', + host: DEFAULT_CIP_HOST, + status: 'disconnected', + }; +} diff --git a/packages/b2c-vs-extension/src/cip-analytics/cip-query-library-service.ts b/packages/b2c-vs-extension/src/cip-analytics/cip-query-library-service.ts new file mode 100644 index 000000000..4fecbc069 --- /dev/null +++ b/packages/b2c-vs-extension/src/cip-analytics/cip-query-library-service.ts @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ +import {randomUUID} from 'node:crypto'; +import * as vscode from 'vscode'; + +/** A single query the user has saved for reuse from the Query Builder. */ +export interface CipSavedQuery { + id: string; + name: string; + sql: string; + description?: string; + /** Tenant the query was authored against. Used to scope visibility per realm. */ + tenantId: string; + createdAt: number; + updatedAt: number; +} + +/** Persistence key inside `vscode.Memento` (workspaceState). */ +const STORE_KEY = 'b2c-dx.cipAnalytics.savedQueries'; + +/** + * Workspace-scoped saved-query store for the Query Builder. Mirrors the shape of + * {@link CipConnectionService}: in-memory cache + persisted Memento + onDidChange event. + * + * Queries carry the tenant they were authored against so the UI can foreground + * the active tenant's queries and dim cross-tenant ones — handy when the same + * workspace switches between e.g. `zzat_prd` and `bjmp_prd`. + */ +export class CipQueryLibraryService implements vscode.Disposable { + private queries: CipSavedQuery[]; + private readonly _onDidChange = new vscode.EventEmitter(); + readonly onDidChange = this._onDidChange.event; + + constructor(private readonly workspaceState: vscode.Memento) { + const stored = this.workspaceState.get(STORE_KEY); + this.queries = Array.isArray(stored) ? stored.filter(this.isValid) : []; + } + + /** All saved queries across all tenants, newest-updated first. */ + list(): CipSavedQuery[] { + return [...this.queries].sort((a, b) => b.updatedAt - a.updatedAt); + } + + /** Saved queries scoped to a tenant, newest-updated first. */ + listForTenant(tenantId: string): CipSavedQuery[] { + return this.list().filter((q) => q.tenantId === tenantId); + } + + get(id: string): CipSavedQuery | undefined { + return this.queries.find((q) => q.id === id); + } + + async save(input: {name: string; sql: string; description?: string; tenantId: string}): Promise { + const now = Date.now(); + const entry: CipSavedQuery = { + id: randomUUID(), + name: input.name.trim(), + sql: input.sql, + description: input.description?.trim() || undefined, + tenantId: input.tenantId, + createdAt: now, + updatedAt: now, + }; + this.queries = [entry, ...this.queries]; + await this.persist(); + return entry; + } + + /** Update name / description / sql on an existing entry. Bumps `updatedAt`. */ + async update( + id: string, + patch: Partial>, + ): Promise { + const idx = this.queries.findIndex((q) => q.id === id); + if (idx < 0) return undefined; + const prev = this.queries[idx]; + const next: CipSavedQuery = { + ...prev, + ...(patch.name !== undefined ? {name: patch.name.trim()} : {}), + ...(patch.sql !== undefined ? {sql: patch.sql} : {}), + ...(patch.description !== undefined ? {description: patch.description.trim() || undefined} : {}), + updatedAt: Date.now(), + }; + this.queries = [...this.queries.slice(0, idx), next, ...this.queries.slice(idx + 1)]; + await this.persist(); + return next; + } + + async delete(id: string): Promise { + const before = this.queries.length; + this.queries = this.queries.filter((q) => q.id !== id); + if (this.queries.length !== before) { + await this.persist(); + } + } + + dispose(): void { + this._onDidChange.dispose(); + } + + private async persist(): Promise { + await this.workspaceState.update(STORE_KEY, this.queries); + this._onDidChange.fire(this.list()); + } + + /** Defensive validator — discards malformed entries from older versions of the schema. */ + private isValid = (q: unknown): q is CipSavedQuery => { + if (!q || typeof q !== 'object') return false; + const v = q as Record; + return ( + typeof v.id === 'string' && + typeof v.name === 'string' && + typeof v.sql === 'string' && + typeof v.tenantId === 'string' && + typeof v.createdAt === 'number' && + typeof v.updatedAt === 'number' + ); + }; +} diff --git a/packages/b2c-vs-extension/src/cip-analytics/cip-styles.css b/packages/b2c-vs-extension/src/cip-analytics/cip-styles.css new file mode 100644 index 000000000..e13e502dc --- /dev/null +++ b/packages/b2c-vs-extension/src/cip-analytics/cip-styles.css @@ -0,0 +1,3495 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2.0 + * + * Shared styles for the B2C-DX Analytics (CIP) webview panels. + * Uses VS Code theme tokens so the UI adapts to the user's theme. + */ + +:root { + --cip-accent: var(--vscode-textLink-foreground, var(--vscode-button-background, #0e639c)); + --cip-accent-hover: var(--vscode-textLink-activeForeground, var(--vscode-button-hoverBackground, #1177bb)); + --cip-accent-contrast: var(--vscode-button-foreground, #ffffff); + --cip-accent-soft: var(--vscode-editor-inactiveSelectionBackground, rgba(14, 99, 156, 0.12)); + --cip-accent-softer: var(--vscode-list-hoverBackground, rgba(14, 99, 156, 0.06)); + --cip-success: var(--vscode-testing-iconPassed, var(--vscode-gitDecoration-addedResourceForeground, #2ea043)); + --cip-success-soft: var(--vscode-diffEditor-insertedTextBackground, rgba(46, 160, 67, 0.12)); + --cip-error: var(--vscode-errorForeground, var(--vscode-inputValidation-errorBorder, #f14c4c)); + --cip-error-soft: var(--vscode-inputValidation-errorBackground, rgba(241, 76, 76, 0.12)); + --cip-warning: var(--vscode-editorWarning-foreground, #cca700); + --cip-warning-soft: var(--vscode-inputValidation-warningBackground, rgba(204, 167, 0, 0.12)); + --cip-card-radius: 6px; + --cip-radius-sm: 4px; + --cip-radius-md: 6px; + --cip-radius-lg: 8px; + --cip-shadow-sm: 0 1px 2px rgba(0, 0, 0, 0.08); + --cip-transition: all 0.12s ease; + --cip-sidebar-width: 320px; + + /* Shared dark-grey background for low-emphasis action controls (Load Entities, Run Query, + * AND/OR, Builder/SQL switch, count badges). One token means every surface shifts together + * when the palette evolves. */ + --cip-neutral: #3c4149; + --cip-neutral-hover: #2b2f36; + --cip-neutral-fg: #ffffff; +} + +/* Dark themes push the neutral a little lighter so it stays visible against near-black + * editor backgrounds without turning into a solid black slab. */ +.vscode-dark, +.vscode-high-contrast { + --cip-neutral: #5a616b; + --cip-neutral-hover: #6f7782; +} + +* { + box-sizing: border-box; + margin: 0; + padding: 0; +} + +body { + font-family: var(--vscode-font-family); + font-size: 13px; + color: var(--vscode-foreground); + background-color: var(--vscode-editor-background); + line-height: 1.5; + -webkit-font-smoothing: antialiased; +} + +/* === ICON SYSTEM === + * Use inline SVGs via mask-image so each icon inherits `currentColor`. The mask approach keeps + * icons crisp at any size and avoids bundling an icon font. `--cip-icon-size` lets consumers + * override the size when needed (`style="--cip-icon-size: 16px"`). + */ +.ic { + display: inline-block; + width: var(--cip-icon-size, 14px); + height: var(--cip-icon-size, 14px); + background-color: currentColor; + mask-repeat: no-repeat; + mask-position: center; + mask-size: contain; + -webkit-mask-repeat: no-repeat; + -webkit-mask-position: center; + -webkit-mask-size: contain; + flex-shrink: 0; + vertical-align: -2px; +} +.ic-play { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-plus { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-close { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-check { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-search { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-table { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-columns { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-filter { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-sort { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-hash { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-refresh { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-bookmark { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-download { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-code { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-inbox { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-arrow-up { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-arrow-down { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} +.ic-alert { + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); +} + +/* === PAGE / APP SHELL === */ +.page { + max-width: 1200px; + margin: 0 auto; + padding: 20px 20px 32px; +} + +/* Header inside .page: card-like container with rounded corners, proper padding, + * and a bottom margin so it reads as a distinct section above the form cards. */ +.page > .page-header { + border-radius: var(--cip-card-radius); + border: 1px solid var(--vscode-panel-border) !important; + border-bottom: 1px solid var(--vscode-panel-border) !important; + background: var(--vscode-editor-background) !important; + margin-bottom: 12px; + padding: 16px 14px; +} + +/* === PAGE HEADER === + * Compact app-shell header. Small pill eyebrow + title inline, subtitle on a new row, + * right-aligned connection metadata + action button. Hairline bottom border. */ +.page-header { + display: flex; + align-items: center; + justify-content: space-between; + gap: 24px; + padding: 10px 20px; + margin: 0 0 12px; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); +} + +/* Stack eyebrow / title / subtitle on their own rows so the header reads top-to-bottom. + * Previously eyebrow + title shared a grid row which let "B2C-DX ANALYTICS" inline next + * to the title text — visually inconsistent with the Entity Browser layout. */ +.page-header__body { + flex: 1; + min-width: 0; + display: flex; + flex-direction: column; + align-items: flex-start; + gap: 2px; +} + +/* Eyebrow — sits on its own line above the title. */ +.page-header__eyebrow { + font-size: 9.5px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 1px; + color: var(--vscode-descriptionForeground); + line-height: 1.2; + white-space: nowrap; + margin-bottom: 2px; +} + +.page-header__title { + font-size: 14px; + font-weight: 600; + line-height: 1.25; + color: var(--vscode-foreground); + letter-spacing: -0.1px; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + max-width: 100%; +} + +.page-header__subtitle { + font-size: 12px; + color: var(--vscode-descriptionForeground); + line-height: 1.4; + margin-top: 1px; +} + +.page-header__meta { + flex-shrink: 0; + display: flex; + align-items: center; + gap: 10px; +} + +/* Match the connection bar's 40px height so the two chips stand shoulder-to-shoulder + * without the button looking stubby next to the taller info bar. */ +.page-header__meta .btn { + height: 40px; + padding: 0 16px; +} + +/* === CONNECTION INFO BAR === + * A compact, horizontally-packed summary: STATUS · Tenant · Host. + * Each item uses a small uppercase label + value so the info is scannable without any icon noise. + */ +/* State-scoped surface tints. Using soft transparent fills so the bar reads as a single shape + * whose color telegraphs status at a glance. Strong cues sit on the status cell (left) only; + * tenant/host cells keep neutral foreground so values stay legible against the wash. */ +.conn-bar { + display: inline-flex; + align-items: stretch; + gap: 0; + background: var(--vscode-editorWidget-background); + border: 1px solid var(--vscode-panel-border); + border-left-width: 3px; + border-radius: var(--cip-radius-sm); + overflow: hidden; + height: 40px; + transition: + background-color 0.15s ease, + border-color 0.15s ease; +} + +/* Connected — distinct green wash with an emphasized left accent. */ +.conn-bar.is-connected { + background: rgba(22, 133, 68, 0.1); + border-color: var(--vscode-panel-border); + border-left-color: #1b5e20; +} + +/* Disconnected — subtle red wash so the user notices the problem without it shouting. */ +.conn-bar.is-disconnected { + background: rgba(198, 40, 40, 0.08); + border-left-color: #c62828; +} + +.conn-bar.is-testing { + background: var(--cip-accent-soft); + border-left-color: var(--cip-accent); +} + +/* Status cell sits flush-left, carries the colored pill. In the connected state we add a small + * solid-green emblem so the user's eye lands on it first. */ +.conn-bar__status { + display: inline-flex; + align-items: center; + padding: 0 12px; + font-size: 12px; + font-weight: 700; + letter-spacing: 0.2px; + border-right: 1px solid var(--vscode-panel-border); + background: transparent; +} + +.conn-bar.is-connected .conn-bar__status { + background: rgba(22, 133, 68, 0.12); + color: #1b5e20; +} +.vscode-dark .conn-bar.is-connected .conn-bar__status, +.vscode-high-contrast .conn-bar.is-connected .conn-bar__status { + background: rgba(0, 200, 83, 0.15); + color: #00c853; +} + +.conn-bar.is-disconnected .conn-bar__status { + background: rgba(198, 40, 40, 0.1); + color: #c62828; +} +.vscode-dark .conn-bar.is-disconnected .conn-bar__status, +.vscode-high-contrast .conn-bar.is-disconnected .conn-bar__status { + color: #ff5252; +} + +.conn-bar.is-testing .conn-bar__status { + background: var(--cip-accent-soft); + color: var(--cip-accent); +} + +/* Each meta cell gets generous horizontal padding so long host values don't visually + * collide with the tenant ID next to them. Vertical rhythm: label sits above value + * with a 3px gap so the two lines read as a labeled pair, not a mashed-together run. */ +.conn-bar__item { + display: inline-flex; + flex-direction: column; + justify-content: center; + gap: 3px; + padding: 4px 14px; + min-width: 0; + border-right: 1px solid var(--vscode-panel-border); +} + +.conn-bar__item:last-child { + border-right: none; +} + +.conn-bar__label { + font-size: 9px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.7px; + color: var(--vscode-descriptionForeground); + line-height: 1; +} + +.conn-bar__value { + font-size: 11px; + font-weight: 600; + font-family: var(--vscode-editor-font-family); + color: var(--vscode-foreground); + line-height: 1.2; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + max-width: 280px; +} + +/* Pill embedded in the status cell — remove its own dot, keep just the text. */ +.conn-bar__status .conn-pill { + padding: 0; + background: transparent; + color: inherit; +} +.conn-bar__status .conn-pill::before { + width: 8px; + height: 8px; + border-radius: 50%; + background: currentColor; + margin-right: 6px; +} +.conn-bar.is-testing .conn-bar__status .conn-pill::before { + /* Override the SVG refresh mask set at the base `.conn-pill.testing::before` rule so the + * dot stays clean in the tinted bar. The spin animation still applies. */ + mask-image: none; + -webkit-mask-image: none; +} + +/* Legacy hero selectors — kept as a no-op bridge so any stale markup compiles cleanly. */ +.hero { + padding: 10px 14px; + border-left: 2px solid var(--cip-accent); + border-bottom: 1px solid var(--vscode-panel-border); + margin: 0 0 16px; +} + +.hero-row { + display: flex; + align-items: baseline; + gap: 10px; +} + +/* Legacy icon class kept for back-compat; rendered invisible. */ +.hero-icon { + display: none; +} + +.hero-body { + flex: 1; + min-width: 0; +} + +.hero-category { + font-size: 10px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.8px; + color: var(--vscode-descriptionForeground); + margin: 0 0 2px; +} + +.hero-title { + font-size: 14px; + font-weight: 600; + margin: 0; + color: var(--vscode-foreground); + line-height: 1.3; +} + +.hero-description, +.hero-subtitle { + font-size: 12px; + color: var(--vscode-descriptionForeground); + line-height: 1.4; + margin-top: 2px; +} + +/* === CARDS — lightweight containers with a simple header === */ +.card { + background-color: var(--vscode-editor-background); + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-card-radius); + margin-bottom: 12px; + overflow: hidden; +} + +/* Soft widget-surface wash so section headings ("Fetch Size", "Report Parameters") + * read as bounded caps on their cards instead of blending into the body. Matches + * the toolbar + preview panel surface so all chrome shares one muted background. */ +.card-header { + display: flex; + align-items: baseline; + gap: 12px; + padding: 10px 14px; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); +} + +/* Legacy colored icon tile — removed. Kept hidden so older markup still compiles. */ +.card-icon { + display: none; +} + +.card-title-group { + flex: 1; + min-width: 0; +} + +.card-title { + font-size: 12px; + font-weight: 600; + color: var(--vscode-foreground); + line-height: 1.3; + letter-spacing: 0.2px; +} + +.card-subtitle { + font-size: 11px; + color: var(--vscode-descriptionForeground); + margin-top: 1px; +} + +.card-body { + padding: 12px 14px; +} + +/* === LAYOUT GRIDS === */ +.config-grid { + display: grid; + grid-template-columns: 1fr 1fr; + gap: 16px; +} + +@media (max-width: 700px) { + .config-grid { + grid-template-columns: 1fr; + } +} + +/* === FORM === */ +.field { + display: flex; + flex-direction: column; + gap: 6px; +} + +.field.inline { + display: grid; + grid-template-columns: 1fr auto; + gap: 8px; + align-items: end; +} + +.field.full { + grid-column: 1 / -1; +} + +/* Date fields (from/to ranges in Curated Reports) break onto a new grid row so + * scalar inputs and date ranges don't mingle. A date always starts at column 1 + * (forcing a row break if it was about to auto-flow into column 2), then the + * very next adjacent date slides into column 2 to pair with it. */ +.field--date { + grid-column-start: 1; +} +.field--date + .field--date { + grid-column-start: 2; +} + +/* === DATE RANGE PRESET WIDGET === */ +.date-range-presets { + display: flex; + flex-wrap: wrap; + gap: 8px; + margin-top: 4px; +} + +.date-preset-btn { + font-size: 12px; + padding: 4px 14px; + border-radius: 20px; +} + +.date-preset-btn.active { + background-color: var(--cip-accent); + color: #fff; + border-color: var(--cip-accent); +} + +.date-range-custom { + margin-top: 12px; +} + +.date-range-custom--hidden { + display: none; +} + +.date-range-custom__fields { + display: grid; + grid-template-columns: 1fr 1fr; + gap: 12px; +} + +@media (max-width: 500px) { + .date-range-custom__fields { + grid-template-columns: 1fr; + } +} + +.label { + font-size: 12px; + font-weight: 600; + color: var(--vscode-foreground); + display: flex; + align-items: center; + gap: 4px; +} + +.label .required { + color: var(--cip-error); + font-weight: 700; +} + +.hint { + font-size: 11px; + color: var(--vscode-descriptionForeground); + line-height: 1.4; +} + +.input, +.select { + width: 100%; + padding: 6px 10px; + background-color: var(--vscode-input-background); + color: var(--vscode-input-foreground); + border: 1px solid var(--vscode-input-border, var(--vscode-panel-border, #c0c4cc)); + border-radius: var(--cip-radius-sm); + font-size: 13px; + font-family: var(--vscode-font-family); + outline: none; +} + +.input:focus, +.select:focus { + border-color: var(--vscode-input-foreground, #6b7280); + outline: none; +} + +.input[type='date'] { + cursor: pointer; +} + +.checkbox-card { + display: flex; + align-items: center; + gap: 10px; + padding: 8px 12px; + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-input-border, var(--vscode-panel-border)); + border-radius: var(--cip-radius-sm); + cursor: pointer; + user-select: none; +} + +.checkbox-card:hover { + border-color: var(--vscode-panel-border); +} + +.checkbox-card input[type='checkbox'] { + cursor: pointer; +} +.checkbox-card-content { + flex: 1; +} +.checkbox-card-title { + font-size: 12px; + font-weight: 600; +} +.checkbox-card-hint { + font-size: 11px; + color: var(--vscode-descriptionForeground); + margin-top: 2px; +} + +/* === BUTTONS === */ +.btn { + padding: 6px 14px; + border-radius: var(--cip-radius-sm); + font-size: 12px; + font-weight: 600; + cursor: pointer; + border: 1px solid transparent; + font-family: var(--vscode-font-family); + display: inline-flex; + align-items: center; + gap: 6px; + white-space: nowrap; + transition: var(--cip-transition); +} + +.btn-primary { + background-color: var(--cip-neutral); + color: var(--cip-neutral-fg); + border-color: var(--cip-neutral); +} + +.btn-primary:hover:not(:disabled) { + background-color: var(--cip-neutral-hover); + border-color: var(--cip-neutral-hover); +} + +.btn-primary:disabled { + opacity: 0.5; + cursor: not-allowed; +} + +.btn-run { + background-color: var(--cip-neutral); + color: var(--cip-neutral-fg); + border-color: var(--cip-neutral); + padding: 8px 18px; + font-size: 13px; +} + +.btn-run:hover:not(:disabled) { + background-color: var(--cip-neutral-hover); + border-color: var(--cip-neutral-hover); +} + +.btn-run:disabled { + background: var(--vscode-button-secondaryBackground); + color: var(--vscode-button-secondaryForeground); + opacity: 0.5; + cursor: not-allowed; +} + +.btn-secondary { + background-color: var(--vscode-button-secondaryBackground); + color: var(--vscode-button-secondaryForeground); + border: 1px solid var(--vscode-button-border, transparent); +} + +.btn-secondary:hover:not(:disabled) { + background-color: var(--vscode-button-secondaryHoverBackground); + color: var(--vscode-button-secondaryForeground); +} + +.date-preset-btn.active:hover:not(:disabled) { + background-color: var(--cip-accent); + color: #fff; + border-color: var(--cip-accent); +} + +.btn-secondary:disabled { + opacity: 0.5; + cursor: not-allowed; +} + +/* Ghost button — secondary action inside a clause head. Reads as a subtle tag, hovers into + * a clear accent state so the user sees it's actionable. */ +.btn-ghost { + height: 26px; + padding: 0 10px; + font-size: 11px; + font-weight: 600; + background: transparent; + color: var(--vscode-foreground); + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-radius-sm); + cursor: pointer; + font-family: var(--vscode-font-family); + display: inline-flex; + align-items: center; + gap: 5px; + transition: var(--cip-transition); +} + +.btn-ghost .ic { + --cip-icon-size: 12px; + opacity: 0.85; +} + +.btn-ghost:hover:not(:disabled) { + background: var(--vscode-list-hoverBackground); + border-color: var(--vscode-panel-border); + color: var(--vscode-foreground); +} +.btn-ghost:hover:not(:disabled) .ic { + opacity: 1; +} + +.btn-ghost:disabled { + opacity: 0.5; + cursor: not-allowed; + color: var(--vscode-descriptionForeground); +} + +/* === ACTION BAR === */ +.action-bar { + position: sticky; + bottom: 0; + display: flex; + align-items: center; + gap: 12px; + padding: 12px 16px; + background: var(--vscode-editor-background); + border-top: 1px solid var(--vscode-panel-border); + margin-top: 8px; + z-index: 10; +} + +.action-bar .info { + font-size: 12px; + color: var(--vscode-descriptionForeground); + flex: 1; +} + +kbd { + padding: 1px 6px; + background: var(--vscode-input-background); + border: 1px solid var(--vscode-panel-border); + border-radius: 3px; + font-size: 11px; + font-family: var(--vscode-editor-font-family); +} + +/* === CONNECTION / STATUS === */ +.conn-status { + display: none; + padding: 8px 12px; + border-radius: var(--cip-radius-sm); + font-size: 12px; + margin-top: 8px; + line-height: 1.4; + gap: 8px; + align-items: center; +} + +.conn-status.visible { + display: flex; +} + +.conn-status.testing { + background: var(--cip-accent-soft); + color: var(--cip-accent); + border-left: 3px solid var(--cip-accent); +} + +.conn-status.success { + background: var(--cip-success-soft); + color: var(--cip-success); + border-left: 3px solid var(--cip-success); +} + +.conn-status.error { + background: var(--cip-error-soft); + color: var(--cip-error); + border-left: 3px solid var(--cip-error); +} + +.status-msg { + display: none; + padding: 8px 12px; + border-radius: var(--cip-radius-sm); + font-size: 12px; + margin-top: 12px; + align-items: center; + gap: 8px; +} + +.status-msg.visible { + display: flex; +} +.status-msg.loading { + background: var(--cip-accent-soft); + color: var(--cip-accent); +} +.status-msg.success { + background: var(--cip-success-soft); + color: var(--cip-success); +} +.status-msg.error { + background: var(--cip-error-soft); + color: var(--cip-error); +} + +.status-message { + padding: 8px 10px; + border-radius: var(--cip-radius-sm); + margin-bottom: 12px; + font-size: 12px; + display: none; +} + +.status-message.loading { + display: block; + background-color: var(--cip-accent-soft); + border-left: 2px solid var(--vscode-inputValidation-infoBorder, var(--cip-accent)); +} + +.status-message.error { + display: block; + background-color: var(--cip-error-soft); + border-left: 2px solid var(--vscode-inputValidation-errorBorder, var(--cip-error)); +} + +.status-message.success { + display: block; + background-color: var(--cip-success-soft); + border-left: 2px solid var(--cip-success); +} + +/* === SPINNER === + * Sized via width/height + border so variants can reuse the same keyframe. + */ +.spinner { + display: inline-block; + width: 12px; + height: 12px; + border: 2px solid currentColor; + border-top-color: transparent; + border-radius: 50%; + animation: cip-spin 0.8s linear infinite; + flex-shrink: 0; +} + +/* Medium spinner — inline with button labels and toolbar text. */ +.spinner--md { + width: 14px; + height: 14px; + border-width: 2px; +} + +/* Large spinner — used inside empty list panels while metadata is loading. */ +.spinner--lg { + width: 22px; + height: 22px; + border-width: 2.5px; +} + +/* A full-panel loading block used in place of the `.empty` placeholder when we're + * waiting on remote data (Tables list, Columns list). Keeps visual rhythm identical + * to the empty state so the panel doesn't jump around. */ +.loading-panel { + padding: 24px 16px; + display: flex; + flex-direction: column; + align-items: center; + gap: 10px; + color: var(--vscode-descriptionForeground); + text-align: center; +} + +.loading-panel .spinner--lg { + color: var(--cip-accent); +} +.loading-panel__title { + font-weight: 600; + color: var(--vscode-foreground); + font-size: 12px; +} +.loading-panel__hint { + font-size: 11px; + line-height: 1.45; + opacity: 0.85; + max-width: 220px; +} + +/* When a primary button is in its loading state, swap its icon for a spinner and + * keep the label flush so the button doesn't resize mid-click. */ +.btn.is-loading { + cursor: progress; +} +.btn.is-loading .spinner { + color: currentColor; +} + +@keyframes cip-spin { + to { + transform: rotate(360deg); + } +} + +/* === RESULTS TABLES === */ +.results { + display: none; +} +.results.visible { + display: block; +} + +.results-toolbar { + display: flex; + align-items: center; + gap: 10px; + padding: 10px 16px; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); +} + +.results-meta { + display: flex; + gap: 6px; +} + +.badge { + display: inline-flex; + align-items: center; + gap: 4px; + padding: 2px 10px; + background: var(--cip-success-soft); + color: var(--cip-success); + border-radius: 11px; + font-size: 11px; + font-weight: 700; + font-variant-numeric: tabular-nums; +} + +.badge.neutral { + background: var(--vscode-badge-background); + color: var(--vscode-badge-foreground); +} + +.results-actions { + margin-left: auto; + display: flex; + gap: 6px; +} + +.results-scroll { + max-height: 600px; + overflow: auto; +} + +.results-scroll::-webkit-scrollbar, +.content-scroll::-webkit-scrollbar, +.list::-webkit-scrollbar, +.results-body::-webkit-scrollbar { + width: 10px; + height: 10px; +} +.results-scroll::-webkit-scrollbar-thumb, +.content-scroll::-webkit-scrollbar-thumb, +.list::-webkit-scrollbar-thumb, +.results-body::-webkit-scrollbar-thumb { + background: var(--vscode-scrollbarSlider-background); + border-radius: 5px; +} + +.table { + width: 100%; + border-collapse: collapse; + font-size: 12px; +} + +.table thead { + position: sticky; + top: 0; + z-index: 10; +} + +.table th { + text-align: left; + padding: 8px 14px; + background: var(--vscode-editorWidget-background); + border-bottom: 2px solid var(--cip-accent); + font-weight: 700; + font-size: 11px; + text-transform: uppercase; + letter-spacing: 0.5px; + cursor: pointer; + user-select: none; + white-space: nowrap; +} + +.table th:hover { + background: var(--cip-accent-soft); + color: var(--cip-accent); +} + +.table th .sort { + margin-left: 6px; + opacity: 0.5; + font-size: 10px; +} + +.table th.sorted .sort { + opacity: 1; + color: var(--cip-accent); +} + +.table td { + padding: 7px 14px; + border-bottom: 1px solid var(--vscode-panel-border); + font-family: var(--vscode-editor-font-family); + max-width: 400px; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.table tr:hover { + background-color: var(--vscode-list-hoverBackground); +} + +.null-cell { + color: var(--vscode-descriptionForeground); + font-style: italic; +} + +.no-results { + padding: 40px 20px; + text-align: center; + color: var(--vscode-descriptionForeground); +} + +.no-results .icon { + font-size: 36px; + opacity: 0.4; + margin-bottom: 8px; +} + +/* === TABLES BROWSER SPECIFIC === */ +.header { + margin-bottom: 16px; + padding-bottom: 12px; + border-bottom: 1px solid var(--vscode-panel-border); +} + +.header h1 { + font-size: 18px; + font-weight: 600; + margin-bottom: 6px; + display: flex; + align-items: center; + gap: 8px; +} + +.header p { + color: var(--vscode-descriptionForeground); + font-size: 12px; + line-height: 1.4; +} + +.config-form { + background-color: var(--vscode-editor-background); + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-radius-sm); + padding: 12px; + margin-bottom: 16px; +} + +.form-row { + display: flex; + gap: 8px; + align-items: flex-end; + margin-bottom: 0; +} + +.form-group { + flex: 1; +} + +.form-group label { + display: block; + font-weight: 500; + margin-bottom: 4px; + font-size: 12px; +} + +.form-group input[type='text'] { + width: 100%; + padding: 6px 8px; + background-color: var(--vscode-input-background); + color: var(--vscode-input-foreground); + border: 1px solid var(--vscode-input-border, transparent); + border-radius: var(--cip-radius-sm); + font-family: var(--vscode-font-family); + font-size: 12px; +} + +.form-group input[type='text']:focus { + outline: none; + border-color: var(--vscode-focusBorder); +} + +.checkbox-label { + display: flex; + align-items: center; + gap: 6px; + cursor: pointer; + font-size: 12px; +} + +.checkbox-label input[type='checkbox'] { + width: 14px; + height: 14px; + cursor: pointer; +} + +.search-box { + margin-bottom: 12px; +} +.search-box input { + width: 100%; +} + +.tables-grid { + display: grid; + grid-template-columns: 1fr 2fr; + gap: 16px; + height: calc(100vh - 280px); +} + +.tables-list { + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-radius-sm); + overflow-y: auto; + background-color: var(--vscode-editor-background); +} + +.table-item { + padding: 8px 10px; + cursor: pointer; + border-bottom: 1px solid var(--vscode-panel-border); + font-size: 11px; + font-family: var(--vscode-editor-font-family); +} + +.table-item:hover { + background-color: var(--vscode-list-hoverBackground); +} + +.table-item.selected { + background-color: rgba(128, 128, 128, 0.18); + color: var(--vscode-foreground); +} + +.table-detail { + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-radius-sm); + padding: 12px; + overflow-y: auto; + background-color: var(--vscode-editor-background); +} + +.table-detail.empty { + display: flex; + align-items: center; + justify-content: center; + color: var(--vscode-descriptionForeground); + font-size: 12px; +} + +.table-detail h2 { + font-size: 14px; + font-weight: 600; + margin-bottom: 12px; + padding-bottom: 8px; + border-bottom: 1px solid var(--vscode-panel-border); +} + +.columns-table { + width: 100%; + border-collapse: collapse; + font-size: 11px; +} + +.columns-table th { + text-align: left; + padding: 6px 8px; + background-color: var(--vscode-editor-background); + border-bottom: 1px solid var(--vscode-panel-border); + font-weight: 600; +} + +.columns-table td { + padding: 6px 8px; + border-bottom: 1px solid var(--vscode-panel-border); +} + +.columns-table tr:hover { + background-color: var(--vscode-list-hoverBackground); +} + +.type-badge { + background-color: var(--vscode-badge-background); + color: var(--vscode-badge-foreground); + padding: 2px 6px; + border-radius: var(--cip-radius-sm); + font-size: 10px; + font-weight: 600; +} + +/* === QUERY BUILDER APP SHELL === */ +html.cip-query-builder, +body.cip-query-builder { + height: 100vh; + overflow: hidden; +} + +.app { + display: grid; + grid-template-rows: auto auto 1fr; + grid-template-columns: var(--cip-sidebar-width) 1fr; + grid-template-areas: + 'hero hero' + 'toolbar toolbar' + 'sidebar main'; + height: 100vh; + overflow: hidden; + background-color: var(--vscode-editor-background); + gap: 0; +} + +/* === QUERY BUILDER HEADER === + * The `.hero-header` lives in the `hero` grid slot and hosts the shared .page-header layout. + * All visual styling is inherited from .page-header — these rules only carve out the slot. */ +.hero-header { + grid-area: hero; + margin: 0; + border-radius: 0; + padding: 14px 20px; + background: linear-gradient(180deg, var(--vscode-editorWidget-background) 0%, var(--vscode-editor-background) 100%); +} + +/* Entity Browser (and any other flat page) uses the same .qb-hero typography but without + * the Query Builder's grid-slot gradient; it keeps the standard .page-header bottom border. */ +.qb-hero--flat { + padding: 14px 20px; + background: var(--vscode-editorWidget-background); +} + +.hero-header .hero-icon { + display: none; +} + +/* Enterprise title treatment — larger, heavier, tighter letter-spacing. */ +.qb-hero .qb-hero__title { + font-size: 20px; + font-weight: 700; + letter-spacing: -0.3px; + line-height: 1.2; + color: var(--vscode-foreground); +} + +.qb-hero .page-header__eyebrow { + font-size: 10px; + font-weight: 700; + letter-spacing: 1.1px; + color: var(--cip-accent); + text-transform: uppercase; + margin-bottom: 4px; +} + +.qb-hero .page-header__subtitle { + font-size: 12.5px; + color: var(--vscode-descriptionForeground); + margin-top: 4px; + max-width: 640px; +} + +.hero-text { + display: flex; + align-items: baseline; + flex-direction: row; + gap: 10px; + text-align: left; + flex: 1; +} + +.hero-text .hero-title { + font-size: 13px; + font-weight: 600; + color: var(--vscode-foreground); + letter-spacing: 0.2px; +} +.hero-text .hero-subtitle { + font-size: 11px; + color: var(--vscode-descriptionForeground); +} + +.config-bar { + grid-area: config; + padding: 8px 16px; + margin: 6px 16px 0; + background: transparent; + border: none; + border-bottom: 1px solid var(--vscode-panel-border); + border-radius: 0; +} + +.config-bar-inner { + display: flex; + align-items: flex-end; + justify-content: center; + gap: 20px; + flex-wrap: wrap; + max-width: 1000px; + margin: 0 auto; +} + +.config-label { + display: block; + font-size: 11px; + font-weight: 700; + color: var(--vscode-foreground); + text-transform: uppercase; + letter-spacing: 0.6px; + margin-bottom: 6px; +} + +.config-field { + display: flex; + flex-direction: column; + min-width: 0; +} + +.config-field .input, +.config-field .select, +.config-field .checkbox-pill, +.config-field .btn { + height: 32px; + font-size: 13px; +} + +/* === CIP HOST INPUT (disabled vs editable) === */ +.config-field .input[readonly] { + opacity: 0.75; + cursor: not-allowed; + background-color: var(--vscode-editorWidget-background); +} + +/* === ENV SEGMENTED CONTROL === */ +.env-segment { + display: inline-flex; + gap: 2px; + padding: 2px; + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-input-border, transparent); + border-radius: var(--cip-radius-sm); + height: 32px; +} + +.env-segment button { + padding: 0 10px; + border: none; + background: transparent; + color: var(--vscode-foreground); + cursor: pointer; + font-size: 11px; + font-weight: 700; + border-radius: 3px; + font-family: var(--vscode-font-family); + text-transform: uppercase; + letter-spacing: 0.5px; +} + +.env-segment button:hover:not(.active) { + background: var(--cip-accent-soft); +} + +.env-segment button.active { + background: var(--vscode-button-background); + color: var(--vscode-button-foreground); +} + +/* === CONNECTION STATUS PILL === + * Background stays transparent in every state. Icon + text color change. + * Uses emoji glyphs so the pill looks the same whether rendered in light or dark theme. + */ +.conn-pill { + display: inline-flex; + align-items: center; + gap: 6px; + padding: 3px 0; + border: none; + background: transparent; + font-size: 12px; + font-weight: 600; + font-variant-numeric: tabular-nums; + color: var(--vscode-descriptionForeground); +} + +/* Circular status dot in place of the emoji glyph. */ +.conn-pill::before { + content: ''; + width: 8px; + height: 8px; + border-radius: 50%; + background: currentColor; + flex-shrink: 0; +} + +.conn-pill.connected { + color: #1b5e20; +} +.conn-pill.disconnected { + color: #c62828; +} +.conn-pill.testing { + color: var(--cip-accent); +} +.conn-pill.testing::before { + animation: cip-spin 1.2s linear infinite; + border-radius: 0; + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); + mask-size: contain; + -webkit-mask-size: contain; + mask-repeat: no-repeat; + -webkit-mask-repeat: no-repeat; + width: 12px; + height: 12px; +} + +/* VS Code sets `.vscode-dark` / `.vscode-high-contrast` on the webview body. In those themes the + * deep colors above lose contrast against the near-black background, so nudge them brighter while + * still reading as "deep" rather than the faded success/error tokens. */ +.vscode-dark .conn-pill.connected, +.vscode-high-contrast .conn-pill.connected { + color: #00c853; +} +.vscode-dark .conn-pill.disconnected, +.vscode-high-contrast .conn-pill.disconnected { + color: #ff5252; +} + +/* Row for status + detail text under the config bar */ +.config-status-row { + display: flex; + align-items: center; + gap: 10px; + padding: 6px 20px 0; + margin: 0 20px; + font-size: 11px; + color: var(--vscode-descriptionForeground); +} + +/* Toolbar sits directly below the page header. Section label on the left, contextual settings + * on the right. No nested border since the page-header already supplies one. */ +.toolbar-bar { + grid-area: toolbar; + display: flex; + align-items: center; + gap: 14px; + padding: 8px 20px; + margin: 0; + background: var(--vscode-editor-background); + border: none; + border-bottom: 1px solid var(--vscode-panel-border); + border-radius: 0; + min-height: 48px; +} + +.toolbar-inline-field { + display: inline-flex; + align-items: center; + gap: 8px; + cursor: default; + padding-right: 10px; + border-right: 1px solid var(--vscode-panel-border); + height: 28px; +} + +.toolbar-inline-label { + font-size: 10px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.6px; + color: var(--vscode-descriptionForeground); + white-space: nowrap; +} + +.toolbar-bar .toolbar-inline-field .select { + height: 28px; + padding: 0 10px; + min-width: 130px; + font-size: 12px; +} + +.toolbar-bar .btn { + height: 28px; + padding: 0 14px; + font-size: 12px; + font-weight: 600; +} + +/* The "Query Composer" label is now a quiet section heading — small, baseline-aligned, + * and the helper text sits right next to it for context. */ +.toolbar-title { + display: flex; + align-items: baseline; + gap: 10px; + font-size: 11px; + font-weight: 700; + color: var(--vscode-foreground); + text-transform: uppercase; + letter-spacing: 0.6px; +} + +.toolbar-title .dot { + display: none; +} + +.toolbar-title .subtitle { + font-size: 11px; + font-weight: 400; + text-transform: none; + letter-spacing: 0; + color: var(--vscode-descriptionForeground); +} + +.spacer { + flex: 1; +} + +.checkbox-pill { + display: inline-flex; + align-items: center; + gap: 6px; + padding: 0 10px; + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-input-border, transparent); + border-radius: var(--cip-radius-sm); + cursor: pointer; + font-size: 12px; + user-select: none; +} + +.checkbox-pill:hover { + border-color: var(--vscode-focusBorder); +} + +/* Segmented control — both segments share equal weight; active state uses the theme's + * button background for a clear pressed look. Minimum width keeps labels from jiggling. */ +.view-toggle { + display: inline-flex; + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-input-border, var(--vscode-panel-border)); + border-radius: var(--cip-radius-md); + padding: 2px; + gap: 2px; + height: 30px; +} + +.view-toggle button { + min-width: 72px; + padding: 0 14px; + border: none; + background: transparent; + color: var(--vscode-foreground); + cursor: pointer; + font-size: 12px; + font-weight: 600; + border-radius: 4px; + display: inline-flex; + align-items: center; + justify-content: center; + gap: 6px; + font-family: var(--vscode-font-family); + transition: var(--cip-transition); +} + +.view-toggle button:hover:not(.active) { + background: var(--cip-accent-soft); +} + +.view-toggle button.active { + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.15); +} + +/* === SIDEBAR === + * Inspector-style vertical split: Tables on top, Columns on bottom. Both panes share the + * same head/search/list chrome so the rhythm repeats, which reduces visual noise. */ +.sidebar { + grid-area: sidebar; + display: flex; + flex-direction: column; + background-color: var(--vscode-sideBar-background); + border-right: 1px solid var(--vscode-panel-border); + margin: 0; + overflow-x: hidden; + overflow-y: hidden; + min-height: 0; +} + +.sidebar-section { + display: flex; + flex-direction: column; + border-bottom: 1px solid var(--vscode-panel-border); + overflow-x: auto; + overflow-y: hidden; + min-height: 0; +} + +/* Roughly equal split. */ +.sidebar-section.tables { + flex: 1 1 50%; + min-height: 180px; +} +.sidebar-section.columns { + flex: 1 1 50%; + min-height: 180px; +} +.sidebar-section:last-child { + border-bottom: none; +} + +/* Denser section head. Uses the widget surface so the sidebar lists read as lifted panes + * sitting on the sidebar background. */ +.section-head { + display: flex; + align-items: center; + justify-content: space-between; + padding: 6px 12px; + flex-shrink: 0; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); + min-height: 32px; +} + +.section-title { + font-size: 10.5px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.7px; + color: var(--vscode-foreground); + display: flex; + align-items: center; + gap: 7px; +} + +.section-title-icon { + display: inline-flex; + align-items: center; + justify-content: center; + color: var(--vscode-descriptionForeground); + opacity: 0.85; +} +.section-title-icon .ic { + --cip-icon-size: 13px; +} + +/* Count badge reads as metadata — border-only pill, tabular numerals. */ +.count-badge { + font-size: 10px; + font-weight: 600; + padding: 1px 7px; + background: transparent; + color: var(--vscode-descriptionForeground); + border: 1px solid var(--vscode-panel-border); + border-radius: 10px; + font-variant-numeric: tabular-nums; + line-height: 1.5; + min-width: 22px; + text-align: center; +} + +/* Search row — compact, with a leading glyph so the empty field reads as "search". */ +.search-bar { + padding: 6px 10px; + flex-shrink: 0; + border-bottom: 1px solid var(--vscode-panel-border); + background: var(--vscode-sideBar-background); + position: relative; +} + +.search-input { + width: 100%; + padding: 5px 10px 5px 26px; + background-color: var(--vscode-input-background); + color: var(--vscode-input-foreground); + border: 1px solid var(--vscode-input-border, var(--vscode-panel-border)); + border-radius: var(--cip-radius-sm); + font-size: 12px; + outline: none; + height: 26px; +} + +.search-input:focus { + border-color: var(--vscode-focusBorder); +} + +/* Leading magnifier glyph rendered via a CSS mask so it inherits `currentColor`. */ +.search-bar::before { + content: ''; + position: absolute; + left: 19px; + top: 50%; + transform: translateY(-50%); + width: 12px; + height: 12px; + background-color: var(--vscode-descriptionForeground); + opacity: 0.7; + pointer-events: none; + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); + mask-size: contain; + -webkit-mask-size: contain; + mask-repeat: no-repeat; + -webkit-mask-repeat: no-repeat; +} + +.list { + flex: 1; + overflow-x: auto; + overflow-y: auto; + padding: 4px 0; + min-height: 0; +} + +/* Row styling. Rows run edge-to-edge so hover/selected fill reads as a full strip. Left accent + * rail is reserved for the selected row — hovering should feel cheaper than selecting. */ +.list-item { + padding: 4px 12px 4px 10px; + cursor: pointer; + font-size: 12px; + font-family: var(--vscode-editor-font-family); + display: flex; + align-items: center; + gap: 8px; + user-select: none; + border-left: 2px solid transparent; + color: var(--vscode-foreground); + min-height: 26px; + white-space: nowrap; + min-width: max-content; +} + +.list-item:hover { + background-color: var(--vscode-list-hoverBackground); +} + +.list-item.selected { + background-color: rgba(128, 128, 128, 0.18); + color: var(--vscode-foreground); + border-left-color: var(--vscode-descriptionForeground); + font-weight: 500; +} + +.list-item .icon { + flex-shrink: 0; + display: inline-flex; + align-items: center; + justify-content: center; + color: var(--vscode-descriptionForeground); + opacity: 0.85; +} +.list-item.selected .icon { + color: var(--vscode-foreground); + opacity: 1; +} +.list-item .icon .ic { + --cip-icon-size: 12px; +} + +.list-item .label { + flex: 1; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +.field-checkbox { + width: 13px; + height: 13px; + cursor: pointer; + flex-shrink: 0; + margin: 0; + accent-color: var(--cip-neutral); +} + +/* Type tag — one uniform dark-grey pill across every SQL type. Tight max-width with + * ellipsis so long types like `VARCHAR(65536) CHARACTER SET "UTF-8" NOT NULL` never + * overrun the column name. Full value surfaces via the `title` attr on hover. */ +.type-tag { + font-size: 9px; + font-weight: 600; + padding: 1px 7px; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: 0.3px; + font-family: var(--vscode-font-family); + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + flex-shrink: 0; + border: 1px solid var(--cip-neutral); + max-width: 110px; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + display: inline-block; + line-height: 1.4; +} + +/* Drop the type-scoped color variants — single neutral pill reads quieter and stays + * aligned with the "low-emphasis controls share one neutral" rule. */ +.type-tag.str, +.type-tag.int, +.type-tag.date, +.type-tag.bool, +.type-tag.varchar, +.type-tag.text, +.type-tag.decimal, +.type-tag.double, +.type-tag.float, +.type-tag.num, +.type-tag.timestamp { + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + border-color: var(--cip-neutral); + opacity: 1; +} + +/* Empty states — quiet, balanced, with a bit more breathing room so the icon feels intentional. */ +.empty { + padding: 22px 16px; + text-align: center; + color: var(--vscode-descriptionForeground); + display: flex; + flex-direction: column; + align-items: center; + gap: 8px; + background: transparent; + border: none; + margin: 0; +} + +.empty-icon { + display: inline-flex; + align-items: center; + justify-content: center; + width: 36px; + height: 36px; + border-radius: 50%; + background: var(--vscode-editorWidget-background); + border: 1px solid var(--vscode-panel-border); + color: var(--vscode-descriptionForeground); + opacity: 0.9; +} +.empty-icon .ic { + --cip-icon-size: 16px; +} +.empty-title { + font-weight: 600; + color: var(--vscode-foreground); + font-size: 12px; +} +.empty-hint { + font-size: 11px; + line-height: 1.45; + opacity: 0.85; + max-width: 220px; +} + +/* === MAIN CONTENT === */ +.main { + grid-area: main; + display: grid; + grid-template-rows: 1fr auto; + overflow: hidden; + background-color: var(--vscode-editor-background); + border: none; + border-radius: 0; + margin: 0; + min-height: 0; +} + +.main-top { + overflow: hidden; + display: flex; + flex-direction: column; + min-height: 0; +} + +.content-scroll { + flex: 1; + overflow-y: auto; + min-height: 0; +} + +.builder { + padding: 16px 20px; + display: flex; + flex-direction: column; + gap: 14px; + max-width: 1100px; +} + +.run-bar { + display: flex; + align-items: center; + justify-content: flex-end; + gap: 12px; + padding: 12px 16px 16px; + background: var(--vscode-editor-background); +} + +.run-hint { + font-size: 11px; + color: var(--vscode-descriptionForeground); +} + +.builder.hidden, +.editor.hidden { + display: none; +} + +/* === CLAUSE CARDS === + * Each SQL clause sits in its own card with a left accent rail matching the SQL keyword color. + * The head has a subtle widget-surface background so the whole card reads as a bounded + * section against the editor canvas. Cards tighten on hover (no translate/scale — that feels + * jumpy in a form UI) and surface a small focus ring via box-shadow. */ +.clause { + background-color: var(--vscode-editor-background); + border: 1px solid var(--vscode-panel-border); + border-radius: var(--cip-radius-md); + overflow: hidden; + transition: + border-color 0.12s ease, + box-shadow 0.12s ease; +} + +.clause:hover { + border-color: var(--vscode-panel-border); + box-shadow: var(--cip-shadow-sm); +} + +/* Compact head: keyword capsule (monospaced) + title + description, all on one baseline. + * The keyword is what telegraphs the clause, so it sits first and reads visually loud. */ +.clause-head { + display: flex; + align-items: center; + gap: 12px; + padding: 8px 14px; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); +} + +.clause-icon { + display: none; +} + +.clause-title-group { + flex: 1; + min-width: 0; + display: flex; + align-items: center; + gap: 10px; + flex-wrap: wrap; +} + +.clause-title { + font-size: 12px; + font-weight: 600; + color: var(--vscode-foreground); + display: inline-flex; + align-items: center; + gap: 10px; +} + +/* Monospaced keyword capsule — filled with accent-soft, accent foreground, so the clause + * reads like a keyword tag the way SQL editors highlight keywords. */ +.clause-title .kw { + font-family: var(--vscode-editor-font-family); + font-size: 10.5px; + font-weight: 700; + letter-spacing: 0.6px; + color: var(--cip-accent); + background: var(--cip-accent-soft); + border: 1px solid transparent; + padding: 2px 8px; + border-radius: 3px; + text-transform: uppercase; + line-height: 1.3; +} + +.clause-desc { + font-size: 11px; + color: var(--vscode-descriptionForeground); + line-height: 1.35; +} + +.clause-actions { + display: flex; + gap: 6px; + flex-shrink: 0; +} + +.clause-body { + padding: 12px 14px; + min-height: 40px; +} + +/* Placeholder text inside a clause body — conversational, not italic (italic feels dated). */ +.placeholder { + color: var(--vscode-descriptionForeground); + font-size: 12px; + line-height: 1.5; + font-style: normal; +} + +/* LIMIT clause — inline row with a numeric input, a bolder suffix label, and a lighter hint. */ +.limit-row { + display: flex; + align-items: center; + gap: 10px; +} + +.limit-input { + width: 84px; + height: 28px; + font-size: 12px; + font-weight: 600; + text-align: center; + font-variant-numeric: tabular-nums; +} + +.limit-suffix { + font-size: 12px; + font-weight: 500; + color: var(--vscode-foreground); +} + +.limit-hint { + font-size: 11px; + color: var(--vscode-descriptionForeground); + padding-left: 6px; + border-left: 1px solid var(--vscode-panel-border); +} + +/* === CHIPS === */ +.chips { + display: flex; + flex-wrap: wrap; + gap: 6px; +} + +.chip { + display: inline-flex; + align-items: center; + gap: 4px; + padding: 3px 6px 3px 10px; + background: var(--vscode-editor-inactiveSelectionBackground, var(--cip-accent-soft)); + color: var(--vscode-foreground); + border: 1px solid transparent; + border-radius: 12px; + font-size: 11px; + font-family: var(--vscode-editor-font-family); + font-weight: 500; + max-width: 240px; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; +} + +/* Primary chip — highlights the currently selected FROM table so it reads distinctly from + * neutral SELECT chips. Uses accent-soft + accent border to match the clause rail. */ +.chip.primary { + background: var(--cip-accent-soft); + color: var(--cip-accent); + border-color: var(--cip-accent); + padding: 3px 12px; + font-weight: 600; + max-width: none; +} + +.chip .remove { + cursor: pointer; + width: 16px; + height: 16px; + border-radius: 50%; + display: flex; + align-items: center; + justify-content: center; + font-size: 10px; + font-weight: 700; + line-height: 1; + transition: var(--cip-transition); +} + +.chip .remove:hover { + background: var(--cip-error-soft); + color: var(--cip-error); +} + +/* === FILTER / ORDER ROWS === + * Tight grid, subtle card background so the row groups feel contained. Hover only adds a + * border tint — we don't shift the row's background because the inputs already have their + * own surface. */ +.filter-row, +.order-row { + display: grid; + gap: 8px; + margin-bottom: 6px; + align-items: center; + padding: 8px 10px; + background-color: var(--vscode-editorWidget-background); + border-radius: var(--cip-radius-sm); + border: 1px solid var(--vscode-panel-border); + transition: border-color 0.12s ease; +} + +.filter-row { + grid-template-columns: minmax(0, 2fr) 140px minmax(0, 2fr) 32px; +} +.order-row { + grid-template-columns: minmax(0, 2fr) 120px 32px; +} + +.filter-row:hover, +.order-row:hover { + border-color: var(--vscode-panel-border); +} +.filter-row:last-child, +.order-row:last-child { + margin-bottom: 0; +} + +.field-select, +.field-input { + width: 100%; + height: 28px; + padding: 0 8px; + background-color: var(--vscode-input-background); + color: var(--vscode-input-foreground); + border: 1px solid var(--vscode-input-border, transparent); + border-radius: var(--cip-radius-sm); + font-size: 12px; + font-family: var(--vscode-font-family); + outline: none; +} + +.field-select:focus, +.field-input:focus { + border-color: var(--vscode-focusBorder); +} + +.remove-btn { + width: 28px; + height: 28px; + display: flex; + align-items: center; + justify-content: center; + background: transparent; + color: var(--cip-error); + border: 1px solid transparent; + border-radius: var(--cip-radius-sm); + cursor: pointer; + font-size: 13px; +} + +.remove-btn:hover { + background: var(--cip-error-soft); + border-color: var(--cip-error); +} + +/* AND/OR segmented control — subtle border, labeled "Combine conditions with" via a + * pseudo-element so the purpose is self-evident even without a separate tooltip. */ +.logic-segment { + display: inline-flex; + gap: 2px; + padding: 2px; + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-input-border, var(--vscode-panel-border)); + border-radius: var(--cip-radius-sm); + margin-bottom: 10px; + height: 26px; + align-self: flex-start; +} + +.logic-segment button { + height: 22px; + min-width: 44px; + padding: 0 12px; + border: none; + background: transparent; + color: var(--vscode-foreground); + cursor: pointer; + font-size: 10.5px; + font-weight: 700; + border-radius: 3px; + font-family: var(--vscode-editor-font-family); + letter-spacing: 0.5px; + transition: var(--cip-transition); +} + +.logic-segment button:hover:not(.active) { + background: var(--cip-accent-soft); +} + +.logic-segment button.active { + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.15); +} + +/* === SQL EDITOR === */ +.editor { + flex: 1; + display: flex; + flex-direction: column; + overflow: hidden; + min-height: 400px; +} + +.editor-head { + padding: 8px 14px; + background: var(--cip-warning-soft); + border-bottom: 1px solid var(--vscode-panel-border); + font-size: 11px; + color: var(--cip-warning); + display: flex; + align-items: center; + gap: 8px; + flex-shrink: 0; +} + +.sql-editor { + flex: 1; + width: 100%; + padding: 14px 18px; + background-color: var(--vscode-editor-background); + color: var(--vscode-editor-foreground); + border: none; + outline: none; + font-family: var(--vscode-editor-font-family); + font-size: 13px; + line-height: 1.6; + resize: none; + tab-size: 2; +} + +/* === QUERY PREVIEW === */ +.preview-panel { + border-top: 1px solid var(--vscode-panel-border); + background: var(--vscode-editorWidget-background); + padding: 10px 14px 12px; + max-height: 140px; + overflow-y: auto; + flex-shrink: 0; +} + +.preview-label { + font-size: 10px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.8px; + color: var(--vscode-descriptionForeground); + margin-bottom: 6px; +} + +#queryPreviewText { + font-family: var(--vscode-editor-font-family); + font-size: 12px; + white-space: pre-wrap; + word-break: break-word; + line-height: 1.5; + color: var(--vscode-foreground); +} + +.sql-keyword { + color: var(--cip-accent); + font-weight: 600; +} +.sql-string { + color: var(--cip-success); +} +.sql-number { + color: var(--cip-warning); +} +.sql-comment { + color: var(--vscode-descriptionForeground); + font-style: italic; +} + +/* === RESULTS PANEL (query builder) === */ +.results-panel { + display: none; + flex-direction: column; + border-top: 2px solid var(--cip-accent); + max-height: 38vh; + min-height: 160px; + background-color: var(--vscode-editor-background); + overflow: hidden; +} + +.results-panel.visible { + display: flex; +} + +.results-head { + display: flex; + align-items: center; + gap: 12px; + padding: 10px 16px; + background: var(--vscode-editorWidget-background); + border-bottom: 1px solid var(--vscode-panel-border); + flex-shrink: 0; +} + +.results-title { + font-weight: 700; + font-size: 12px; + text-transform: uppercase; + letter-spacing: 0.5px; +} + +.badges { + display: flex; + gap: 6px; +} + +.results-body { + flex: 1; + overflow: auto; +} + +/* === FOOTER STATUS BAR === */ +.footer { + padding: 0 16px; + display: flex; + align-items: center; + gap: 10px; + font-size: 11px; + background: var(--vscode-statusBar-background); + color: var(--vscode-statusBar-foreground); + border-top: 1px solid var(--vscode-panel-border); +} + +.footer.error { + background: var(--cip-error-soft); + color: var(--cip-error); +} +.footer.success { + background: var(--cip-success-soft); + color: var(--cip-success); +} +.footer.loading { + background: var(--cip-accent-soft); + color: var(--cip-accent); +} + +.footer .hint { + margin-left: auto; + display: flex; + align-items: center; + gap: 6px; + opacity: 0.85; +} + +@media (max-width: 900px) { + .app { + grid-template-columns: 260px 1fr; + } +} + +/* ============================================================================ + * QUERY BUILDER — ENTERPRISE POLISH + * Targeted overrides layered on top of the base styles above. Keeping the + * polish here keeps the existing structure intact and concentrates the visual + * refinements in one place that's easy to tweak. + * ============================================================================ */ + +/* --- TOOLBAR ---------------------------------------------------------------- */ +.qb-toolbar { + padding: 10px 20px; + gap: 16px; + background: var(--vscode-editorWidget-background); +} + +.qb-toolbar__title { + gap: 10px; +} + +.qb-toolbar__label { + font-size: 11px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.9px; + color: var(--vscode-foreground); +} + +.qb-toolbar .toolbar-inline-label { + font-size: 9.5px; + letter-spacing: 0.8px; +} + +.qb-toolbar .select { + min-width: 150px; + height: 30px; +} + +.qb-toolbar .btn { + height: 30px; + padding: 0 14px; + font-size: 12px; +} + +/* Toolbar view-toggle — matches `.qb-toolbar .btn` height (30px). Zero inner padding + * so the inner buttons fill the full 30px active area, visually aligning the + * Builder/SQL switch with the Load Entities button beside it. */ +.qb-view-toggle { + height: 30px; + padding: 0; + border-radius: 5px; + align-items: stretch; +} + +.qb-view-toggle button { + padding: 0 16px; + font-size: 12px; + letter-spacing: 0.2px; + height: auto; +} + +.qb-view-toggle button.active { + box-shadow: 0 1px 0 rgba(0, 0, 0, 0.06); +} + +/* --- SIDEBAR --------------------------------------------------------------- */ +.cip-query-builder .sidebar { + background-color: var(--vscode-sideBar-background); +} + +/* Section heads (Entities / Columns) sit on the same white editor background as their + * body so each panel reads as one clean card. The title text is lighter weight and muted + * color — it's a category label, not an interactive row. */ +.cip-query-builder .section-head { + padding: 12px 14px 10px; + background: var(--vscode-editor-background); +} + +.cip-query-builder .section-title { + font-size: 10.5px; + letter-spacing: 0.9px; + font-weight: 500; + color: var(--vscode-descriptionForeground); + gap: 7px; +} + +.cip-query-builder .section-title-icon { + color: var(--vscode-descriptionForeground); +} + +.cip-query-builder .count-badge { + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + border-color: var(--cip-neutral); + padding: 2px 9px; + letter-spacing: 0.4px; +} + +.cip-query-builder .search-bar { + padding: 8px 12px; + position: relative; +} + +/* Inline search icon inside the input. Uses currentColor so theme-aware. */ +.cip-query-builder .search-bar::before { + content: ''; + position: absolute; + left: 22px; + top: 50%; + transform: translateY(-50%); + width: 13px; + height: 13px; + background-color: var(--vscode-descriptionForeground); + mask-image: url("data:image/svg+xml;utf8,"); + -webkit-mask-image: url("data:image/svg+xml;utf8,"); + mask-repeat: no-repeat; + -webkit-mask-repeat: no-repeat; + mask-size: contain; + -webkit-mask-size: contain; + pointer-events: none; + opacity: 0.65; +} + +.cip-query-builder .search-input { + padding-left: 30px; + height: 30px; + font-size: 12px; +} + +/* Match the Entity Browser's list chrome: sidebar rows render in the regular UI font at + * normal weight, with the selected row switching to the monospace editor font + semibold + * so the active entity/column reads as "this is the identifier" without every row feeling + * bold. Base `.list-item` uses the monospace font + a 600-weight `.label` child (inherited + * from the form-level `.label` rule), which is why every row was loud. */ +.cip-query-builder .list-item { + padding: 7px 14px; + border-radius: 0; + font-family: var(--vscode-font-family); + font-weight: 400; + transition: + background-color 0.1s ease, + border-left-color 0.1s ease; +} + +.cip-query-builder .list-item .label { + font-weight: 400; + color: var(--vscode-foreground); +} + +.cip-query-builder .list-item.selected { + background-color: rgba(128, 128, 128, 0.18); + color: var(--vscode-foreground); + border-left-color: var(--vscode-descriptionForeground); + font-family: var(--vscode-editor-font-family); + font-weight: 600; +} + +.cip-query-builder .list-item.selected .label { + font-weight: 600; +} + +.cip-query-builder .list-item .icon { + color: var(--vscode-descriptionForeground); +} + +/* Query Builder column-type tags — light grey pill with dark text so the badge + * is clearly visible but reads as an understated tag, not a primary-color shout. + * Theme-scoped: lighter grey wash in light mode, darker grey fill in dark mode. */ +.cip-query-builder .type-tag { + font-size: 9px; + padding: 2px 8px; + border-radius: 10px; + background: #e5e7eb; + color: #4b5563; + border: 1px solid #d1d5db; + max-width: 96px; + font-weight: 500; + opacity: 1; +} + +.cip-query-builder .type-tag.str, +.cip-query-builder .type-tag.varchar, +.cip-query-builder .type-tag.text, +.cip-query-builder .type-tag.int, +.cip-query-builder .type-tag.decimal, +.cip-query-builder .type-tag.double, +.cip-query-builder .type-tag.float, +.cip-query-builder .type-tag.num, +.cip-query-builder .type-tag.date, +.cip-query-builder .type-tag.timestamp, +.cip-query-builder .type-tag.bool { + background: #e5e7eb; + color: #4b5563; + border-color: #d1d5db; +} + +/* Dark themes: darker grey surface with light-grey text so the pill still reads + * as neutral against the near-black editor background. */ +.vscode-dark .cip-query-builder .type-tag, +.vscode-high-contrast .cip-query-builder .type-tag, +.vscode-dark .cip-query-builder .type-tag.str, +.vscode-dark .cip-query-builder .type-tag.varchar, +.vscode-dark .cip-query-builder .type-tag.text, +.vscode-dark .cip-query-builder .type-tag.int, +.vscode-dark .cip-query-builder .type-tag.decimal, +.vscode-dark .cip-query-builder .type-tag.double, +.vscode-dark .cip-query-builder .type-tag.float, +.vscode-dark .cip-query-builder .type-tag.num, +.vscode-dark .cip-query-builder .type-tag.date, +.vscode-dark .cip-query-builder .type-tag.timestamp, +.vscode-dark .cip-query-builder .type-tag.bool { + background: #3c4149; + color: #d1d5db; + border-color: #4b5563; +} + +/* --- CLAUSE CARDS ---------------------------------------------------------- */ +/* Accent strip on the left + keyword pill colored per clause. Each clause + * reads as a distinct SQL step while sharing the same shell. */ +.clause { + position: relative; + border-radius: 8px; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.03); + transition: + border-color 0.1s ease, + box-shadow 0.1s ease; +} + +.clause:hover { + border-color: var(--vscode-panel-border); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.06); +} + +/* Suppress the system's blue focus ring when a clause card gets keyboard focus — + * we use the existing border/box-shadow to convey focus state, not the default + * browser outline which resolves to VS Code's accent blue. */ +.clause:focus, +.clause:focus-within, +.clause:focus-visible { + outline: none; + border-color: var(--vscode-panel-border); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.06); +} + +.clause::before { + content: ''; + position: absolute; + left: 0; + top: 0; + bottom: 0; + width: 3px; + border-radius: 8px 0 0 8px; + background: var(--cip-accent); + opacity: 0.6; +} + + +.clause-head { + padding: 10px 16px; + gap: 12px; +} + +/* Small numbered badge indicating build order (1 SELECT → 5 LIMIT). */ +.clause-step { + flex-shrink: 0; + width: 22px; + height: 22px; + border-radius: 50%; + display: inline-flex; + align-items: center; + justify-content: center; + font-size: 10.5px; + font-weight: 700; + font-variant-numeric: tabular-nums; + background: rgba(14, 99, 156, 0.12); + color: var(--cip-accent); +} + + +.clause-title { + font-size: 13px; + gap: 8px; +} + +.clause-heading { + font-weight: 600; + color: var(--vscode-foreground); +} + +/* Keyword pill — colored per clause, monospace for the SQL feel. */ +.clause-title .kw { + font-size: 10px; + font-weight: 700; + letter-spacing: 0.8px; + padding: 2px 8px; + border-radius: 4px; + border: 1px solid rgba(14, 99, 156, 0.3); + background: rgba(14, 99, 156, 0.08); + color: var(--cip-accent); +} + + +.clause-desc { + font-size: 11.5px; + color: var(--vscode-descriptionForeground); + margin-top: 2px; +} + +.clause-body { + padding: 12px 16px; +} + +.placeholder { + font-style: normal; + font-size: 12px; + color: var(--vscode-descriptionForeground); + opacity: 0.85; +} + +/* LIMIT row — dedicated, labeled input. */ +.limit-row { + display: flex; + align-items: center; + gap: 12px; +} + +.limit-input { + width: 96px; + height: 32px; + font-size: 13px; + font-weight: 600; + text-align: center; + font-variant-numeric: tabular-nums; +} + +.limit-hint { + font-size: 11.5px; + color: var(--vscode-descriptionForeground); +} + +/* --- CHIPS (selected columns) --------------------------------------------- + * Neutral dark-grey pills so the FROM entity chip reads as an identifier tag, + * not a blue "tap me" affordance. Uses the same `--cip-neutral` token shared + * with other low-emphasis controls. */ +.cip-query-builder .chip { + background: rgba(128, 128, 128, 0.14); + color: var(--vscode-foreground); + border: 1px solid var(--vscode-panel-border); + border-radius: 11px; + padding: 3px 4px 3px 11px; + font-weight: 600; +} + +.cip-query-builder .chip.primary { + background: var(--cip-neutral); + color: var(--cip-neutral-fg); + border-color: var(--cip-neutral); + padding: 3px 12px; +} + +/* --- FILTER / ORDER ROWS --------------------------------------------------- */ +.filter-row, +.order-row { + background-color: var(--vscode-input-background); + border: 1px solid var(--vscode-panel-border); + padding: 8px; + gap: 10px; +} + +.filter-row:hover, +.order-row:hover { + border-color: var(--vscode-panel-border); +} + +.field-select, +.field-input { + height: 30px; + font-size: 12.5px; +} + +/* --- RUN BAR + SQL PREVIEW ------------------------------------------------- */ +/* Run bar layout: Show SQL toggle (left) · run hint (center-ish) · Run Query (right). + * `justify-content: flex-end` is overridden here because the toggle now shares the row. */ +.cip-query-builder .run-bar { + padding: 12px 20px 14px; + border-top: 1px solid var(--vscode-panel-border); + background: var(--vscode-editorWidget-background); + justify-content: flex-start; +} + +.cip-query-builder .run-bar .run-hint { + margin-left: 12px; +} +.cip-query-builder .run-bar .btn-run { + margin-left: auto; +} + +.cip-query-builder .btn-run { + padding: 8px 22px; + font-size: 13px; + font-weight: 700; + letter-spacing: 0.2px; + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.1); +} + +.cip-query-builder .btn-run:hover:not(:disabled) { + box-shadow: 0 2px 6px rgba(0, 0, 0, 0.14); + transform: translateY(-1px); +} + +.cip-query-builder .preview-panel { + padding: 10px 20px 12px; + max-height: 160px; +} + +.preview-head { + display: flex; + align-items: center; + gap: 10px; + margin-bottom: 6px; +} + +.preview-head .preview-label { + margin-bottom: 0; + letter-spacing: 1px; +} + +.btn-ghost--inline { + margin-left: auto; + height: 22px; + padding: 0 8px; + font-size: 10.5px; +} + +.cip-query-builder #queryPreviewText { + padding: 8px 10px; + background: var(--vscode-textCodeBlock-background, rgba(127, 127, 127, 0.08)); + border-radius: 4px; + border: 1px solid var(--vscode-panel-border); +} + +/* --- GHOST BUTTONS (clause actions) --------------------------------------- */ +.cip-query-builder .clause-actions .btn-ghost { + height: 28px; + padding: 0 12px; + font-size: 11.5px; + border-radius: 4px; +} + +/* --- RESULTS PANEL --------------------------------------------------------- */ +.cip-query-builder .results-panel { + border-top: 1px solid var(--vscode-panel-border); +} + +.cip-query-builder .results-head { + padding: 12px 20px; +} + +.cip-query-builder .results-title { + font-size: 11px; + letter-spacing: 0.9px; + color: var(--vscode-foreground); +} + +.cip-query-builder .badge { + padding: 3px 11px; + font-size: 11px; +} + +/* --- EMPTY STATES (sidebar) ----------------------------------------------- */ +.cip-query-builder .empty { + padding: 28px 16px; + gap: 8px; +} + +.cip-query-builder .empty-icon .ic { + --cip-icon-size: 22px; + opacity: 0.55; +} +.cip-query-builder .empty-title { + font-size: 12px; +} +.cip-query-builder .empty-hint { + font-size: 11.5px; +} + +/* ============================================================================ + * ENTITY BROWSER (tables-browser.html) + * Lives here (not inline in the template) because the page's CSP only allows + * styles from `cspSource` — inline +
+

Configure once and your AI tools share the same instance, dw.json, and cartridge layout this extension already understands.

+ +
+
+ ${targets.length}compatible + · + ${installedCount}detected + · + ${skillsInstalledCount}skills installed +
+ +
+ +
${cards}
+ +

One-click install. Click Install Skills on a detected IDE and a terminal opens with b2c setup skills b2c --ide <ide> queued. Press Enter to run; the CLI handles paths, downloads, and overwrites.

+ +

What gets installed

+
    +
  • Agent Skills — B2C-specific instructions, prompts, and conventions your AI tool can reference.
  • +
  • MCP server — exposes B2C-specific tools (deploy, log queries, sandbox info) to any MCP-aware client.
  • +
+ +

Agent Skills documentation · MCP server documentation

+
`; +} diff --git a/packages/b2c-vs-extension/src/walkthrough/commands.ts b/packages/b2c-vs-extension/src/walkthrough/commands.ts new file mode 100644 index 000000000..7b891b3a9 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/commands.ts @@ -0,0 +1,2093 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as vscode from 'vscode'; +import * as cp from 'child_process'; +import * as path from 'path'; +import * as fs from 'fs/promises'; + +/** + * Template for a basic dw.json configuration file. + * Users should replace placeholder values with their actual credentials. + */ +const DW_JSON_TEMPLATE = { + hostname: 'your-sandbox-name.demandware.net', + username: 'your-username', + password: 'your-password', + version: 'v1', + // Optional OAuth credentials for advanced features + // Uncomment and fill in to enable Sandbox Management and API Browser + // clientId: 'your-client-id', + // clientSecret: 'your-client-secret', + // shortCode: 'your-short-code', +}; + +/** + * Template for dw.json with multiple instances configuration + */ +const DW_JSON_MULTI_INSTANCE_TEMPLATE = { + instances: [ + { + name: 'dev', + hostname: 'dev-sandbox.demandware.net', + username: 'your-username', + password: 'your-password', + // Optional OAuth credentials + // clientId: 'your-client-id', + // clientSecret: 'your-client-secret', + // shortCode: 'your-short-code', + }, + { + name: 'staging', + hostname: 'staging-sandbox.demandware.net', + username: 'your-username', + password: 'your-password', + }, + ], +}; + +/** + * Register walkthrough-related commands. + * These commands support the getting started walkthrough experience. + */ +export function registerWalkthroughCommands(context: vscode.ExtensionContext): void { + // Command: Open the getting started walkthrough. + // The new onboarding panel replaces the built-in walkthrough surface; we + // redirect this legacy command to keep existing menu entries working. + context.subscriptions.push( + vscode.commands.registerCommand('b2c-dx.walkthrough.open', async () => { + try { + await vscode.commands.executeCommand('b2c-dx.onboarding.open'); + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + vscode.window.showErrorMessage(`Failed to open walkthrough: ${message}`); + } + }), + ); + + // Command: Create dw.json template file + context.subscriptions.push( + vscode.commands.registerCommand('b2c-dx.walkthrough.createDwJson', async () => { + await createDwJsonTemplate(); + }), + ); + + // Command: Credential-storage wizard. Field-level placement: non-secret + // connection fields go to dw.json, secret pairs are placed independently + // (Keychain / pass / env / dw.json) per Credential Grouping. + context.subscriptions.push( + vscode.commands.registerCommand('b2c-dx.walkthrough.chooseCredentialStorage', async () => { + await chooseCredentialStorage(context); + }), + ); + + // Command: `b2c setup inspect` — opens a terminal showing where each + // resolved config value came from (file / env / keychain / etc.). + context.subscriptions.push( + vscode.commands.registerCommand('b2c-dx.walkthrough.inspectSetup', async () => { + await openInspect(); + }), + ); + + // Per-step setup commands. Each one prompts only for the fields its step + // is responsible for; non-secret fields all go into the same `dw.json` + // configs[] entry (named once during the connection step and reused for + // the rest of the session). Secret pairs are placed independently per + // pair, exactly like the all-at-once wizard. + context.subscriptions.push( + vscode.commands.registerCommand('b2c-dx.setup.connection', async () => { + await runConnectionStep(context); + }), + vscode.commands.registerCommand('b2c-dx.setup.oauth', async () => { + await runOAuthStep(context); + }), + vscode.commands.registerCommand('b2c-dx.setup.webdav', async () => { + await runWebDavStep(context); + }), + vscode.commands.registerCommand('b2c-dx.setup.scapi', async () => { + await runScapiStep(context); + }), + vscode.commands.registerCommand('b2c-dx.setup.resetSession', async () => { + await resetSetupSession(context); + }), + ); +} + +// ─── Credential-storage wizard ───────────────────────── +// +// Walks the user through the documented placement model: +// • Non-secret connection fields → dw.json (single source of truth) +// • Secret pairs (OAuth, Basic) → Keychain / pass / env / dw.json (chosen +// independently per pair, per Credential +// Grouping rule). +// • SCAPI-only fields → dw.json +// • MRT credentials → ~/.mobify (managed by `b2c mrt +// save-credentials`); MRT_API_KEY env var. +// +// The flow asks pair-by-pair so a user can mix sources (OAuth in Keychain, +// WebDAV in dw.json) — the docs explicitly support this. + +type SecretPlacement = 'macos-keychain' | 'password-store' | 'env' | 'dw-json'; + +interface PlacementChoice extends vscode.QuickPickItem { + id: SecretPlacement; +} + +interface FlowChoice extends vscode.QuickPickItem { + id: 'oauth' | 'basic' | 'scapi' | 'mrt' | 'inspect' | 'done'; +} + +interface ConnectionConfig { + instanceName: string; + hostname: string; + codeVersion?: string; + shortCode?: string; + tenantId?: string; + oauthScopes?: string; + mrtProject?: string; + mrtEnvironment?: string; +} + +interface ConfigPlan { + connection: ConnectionConfig; + oauthPlacement?: SecretPlacement; + basicPlacement?: SecretPlacement; + mrtPlacement?: SecretPlacement; + enableSCAPI: boolean; + // Captured during the wizard so the apply phase can write them straight + // into the chosen target. Kept in-memory for the duration of the wizard + // call only; never persisted. + oauthClientId?: string; + oauthClientSecret?: string; + basicUsername?: string; + basicPassword?: string; + mrtApiKey?: string; +} + +/** Wrap showInputBox for the wizard's value-collection prompts. Returns + * `undefined` only if the user cancels (Esc); empty string is accepted so + * optional fields can be skipped without breaking flow. */ +async function secretInput(opts: { + title: string; + prompt: string; + placeholder?: string; + password?: boolean; +}): Promise { + const v = await vscode.window.showInputBox({ + title: opts.title, + prompt: opts.prompt, + placeHolder: opts.placeholder, + password: opts.password ?? false, + ignoreFocusOut: true, + }); + return v; +} + +function defaultSecretPlacement(): SecretPlacement { + if (process.env.SFCC_CI === '1' || process.env.CI === 'true') return 'env'; + if (process.platform === 'darwin') return 'macos-keychain'; + return 'password-store'; +} + +function placementItems(currentDefault: SecretPlacement): PlacementChoice[] { + const isMac = process.platform === 'darwin'; + const items: PlacementChoice[] = [ + { + id: 'macos-keychain', + label: `$(key) macOS Keychain${isMac ? '' : ' (macOS only)'}`, + description: 'Encrypted in the OS Keychain', + detail: + 'Uses the documented b2c-plugin-macos-keychain. Secrets live in the OS Keychain; ' + + 'never written to disk in plaintext.', + }, + { + id: 'password-store', + label: '$(lock) Password Store (pass)', + description: 'GPG-encrypted via the Unix `pass` tool', + detail: 'Cross-platform (macOS / Linux / WSL). Uses the documented b2c-plugin-password-store.', + }, + { + id: 'env', + label: '$(symbol-variable) Environment variables', + description: 'SFCC_* env vars — best for CI / shared machines', + detail: 'Highest precedence in the resolution chain. Nothing written to disk.', + }, + { + id: 'dw-json', + label: '$(file) dw.json (in workspace)', + description: 'Plaintext in your workspace — personal sandboxes only', + detail: 'Quickest. Only safe for personal sandboxes. Always added to .gitignore.', + }, + ]; + // Mark the platform default with "(recommended)" so it's visibly preselected. + const def = items.find((i) => i.id === currentDefault); + if (def) { + def.label = def.label.replace(/^(\$\([^)]+\)\s*)/, '$1') + ' · recommended'; + def.picked = true; + } + return items; +} + +async function chooseCredentialStorage(context: vscode.ExtensionContext): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a folder first — the wizard writes dw.json into your workspace root.'); + return; + } + + // Pick the instance name. Defaults to "dev"; user can override. + const instanceName = await vscode.window.showInputBox({ + title: 'Configure your B2C instance — 1 of 4', + prompt: 'Name this instance (used as the configs[] entry name in dw.json)', + placeHolder: 'dev', + value: 'dev', + ignoreFocusOut: true, + validateInput: (v) => (/^[A-Za-z0-9_-]+$/.test(v) ? null : 'Letters, digits, dash, underscore only'), + }); + if (!instanceName) return; + + const hostname = await vscode.window.showInputBox({ + title: 'Configure your B2C instance — 2 of 4 · Connection', + prompt: 'Instance hostname (no https://)', + placeHolder: 'abcd-123.dx.commercecloud.salesforce.com', + ignoreFocusOut: true, + validateInput: (v) => (v.trim().length > 0 ? null : 'Required'), + }); + if (!hostname) return; + + const codeVersion = await vscode.window.showInputBox({ + title: 'Configure your B2C instance — 2 of 4 · Connection (optional)', + prompt: 'Default code version targeted by deploys (optional)', + placeHolder: 'version1', + ignoreFocusOut: true, + }); + + // Pick which auth flows to wire up. + const flowsItems: FlowChoice[] = [ + { + id: 'oauth', + label: '$(shield) OAuth client credentials', + description: 'client-id + client-secret — Sandbox Explorer, OCAPI / SCAPI, jobs', + picked: true, + }, + { + id: 'basic', + label: '$(person) Basic auth (WebDAV)', + description: 'username + password — cartridge deploys, WebDAV browser', + picked: true, + }, + { + id: 'scapi', + label: '$(symbol-interface) SCAPI extras', + description: 'short-code + tenant-id + scopes — required by API Browser', + }, + { + id: 'mrt', + label: '$(rocket) MRT (Managed Runtime)', + description: 'mrtProject + mrtEnvironment + MRT_API_KEY', + }, + ]; + const flows = await vscode.window.showQuickPick(flowsItems, { + title: 'Configure your B2C instance — 3 of 4 · Auth flows', + placeHolder: 'Pick the flows you actually use (you can re-run later to add more)', + canPickMany: true, + ignoreFocusOut: true, + }); + if (!flows) return; + + const connection: ConnectionConfig = {instanceName, hostname, codeVersion: codeVersion || undefined}; + const plan: ConfigPlan = {connection, enableSCAPI: false}; + + // SCAPI extras + if (flows.some((f) => f.id === 'scapi')) { + plan.enableSCAPI = true; + connection.shortCode = + (await vscode.window.showInputBox({ + title: 'SCAPI · short-code', + prompt: 'Your organisation short code (from Account Manager)', + placeHolder: 'kv7kzm78', + ignoreFocusOut: true, + })) || undefined; + connection.tenantId = + (await vscode.window.showInputBox({ + title: 'SCAPI · tenant-id', + prompt: 'Your tenant ID (e.g. zzrf_001)', + placeHolder: 'zzrf_001', + ignoreFocusOut: true, + })) || undefined; + connection.oauthScopes = + (await vscode.window.showInputBox({ + title: 'SCAPI · oauth scopes (optional)', + prompt: 'Space-separated SCAPI scopes', + placeHolder: 'sfcc.shopper-customers sfcc.shopper-products', + ignoreFocusOut: true, + })) || undefined; + } + + // MRT non-secret fields + if (flows.some((f) => f.id === 'mrt')) { + connection.mrtProject = + (await vscode.window.showInputBox({ + title: 'MRT · project slug', + prompt: 'mrtProject — your MRT project slug', + ignoreFocusOut: true, + })) || undefined; + connection.mrtEnvironment = + (await vscode.window.showInputBox({ + title: 'MRT · environment slug', + prompt: 'mrtEnvironment — your MRT environment slug', + ignoreFocusOut: true, + })) || undefined; + } + + // Step 4: per-pair placement. + const def = defaultSecretPlacement(); + + if (flows.some((f) => f.id === 'oauth')) { + const picked = await vscode.window.showQuickPick(placementItems(def), { + title: 'Configure your B2C instance — 4 of 4 · Where should OAuth secrets live?', + placeHolder: 'client-id and client-secret stay together (Credential Grouping rule).', + ignoreFocusOut: true, + }); + if (!picked) return; + plan.oauthPlacement = picked.id; + plan.oauthClientId = await secretInput({ + title: 'OAuth · client-id', + prompt: 'Paste your client-id (visible — it is an identifier, not a secret).', + placeholder: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', + }); + if (plan.oauthClientId === undefined) return; + plan.oauthClientSecret = await secretInput({ + title: 'OAuth · client-secret', + prompt: 'Paste your client-secret (input is masked).', + placeholder: '••••••••••••••••••••', + password: true, + }); + if (plan.oauthClientSecret === undefined) return; + } + + if (flows.some((f) => f.id === 'basic')) { + const picked = await vscode.window.showQuickPick(placementItems(def), { + title: 'Configure your B2C instance — 4 of 4 · Where should WebDAV credentials live?', + placeHolder: 'username and password stay together (Credential Grouping rule).', + ignoreFocusOut: true, + }); + if (!picked) return; + plan.basicPlacement = picked.id; + plan.basicUsername = await secretInput({ + title: 'Basic · username', + prompt: 'Your Business Manager username.', + placeholder: 'you@example.com', + }); + if (plan.basicUsername === undefined) return; + plan.basicPassword = await secretInput({ + title: 'Basic · WebDAV access key (password)', + prompt: 'Paste your WebDAV access key (input is masked).', + placeholder: '••••••••••••••••••••', + password: true, + }); + if (plan.basicPassword === undefined) return; + } + + if (flows.some((f) => f.id === 'mrt')) { + // MRT_API_KEY pairing model: same chooser, but Keychain/pass shown as "via b2c mrt save-credentials". + const picked = await vscode.window.showQuickPick(placementItems(def), { + title: 'Configure your B2C instance — 4 of 4 · Where should the MRT API key live?', + placeHolder: 'The CLI manages ~/.mobify automatically when you pick Keychain or pass.', + ignoreFocusOut: true, + }); + if (!picked) return; + plan.mrtPlacement = picked.id; + if (picked.id !== 'dw-json') { + plan.mrtApiKey = await secretInput({ + title: 'MRT · API key', + prompt: 'Paste your MRT_API_KEY (input is masked).', + placeholder: '••••••••••••••••••••', + password: true, + }); + if (plan.mrtApiKey === undefined) return; + } + } + + await applyConfigPlan(context, plan); +} + +async function applyConfigPlan(context: vscode.ExtensionContext, plan: ConfigPlan): Promise { + const wsFolder = vscode.workspace.workspaceFolders![0]; + const dwJsonPath = path.join(wsFolder.uri.fsPath, 'dw.json'); + + // Build the dw.json entry: only non-secret fields go here, except where the + // user explicitly chose dw-json placement for a pair. + const entry: Record = { + name: plan.connection.instanceName, + active: true, + hostname: plan.connection.hostname, + }; + if (plan.connection.codeVersion) entry['code-version'] = plan.connection.codeVersion; + if (plan.enableSCAPI) { + if (plan.connection.shortCode) entry['short-code'] = plan.connection.shortCode; + if (plan.connection.tenantId) entry['tenant-id'] = plan.connection.tenantId; + if (plan.connection.oauthScopes) entry['oauth-scopes'] = plan.connection.oauthScopes; + } + if (plan.connection.mrtProject) entry.mrtProject = plan.connection.mrtProject; + if (plan.connection.mrtEnvironment) entry.mrtEnvironment = plan.connection.mrtEnvironment; + + // Merge into existing dw.json's configs[], or create new file with this entry. + let existing: {configs?: Record[]; [key: string]: unknown} = {}; + if (await checkFileExists(dwJsonPath)) { + try { + existing = JSON.parse(await fs.readFile(dwJsonPath, 'utf-8')); + } catch { + // Malformed dw.json — leave alone, ask user. + const action = await vscode.window.showWarningMessage( + 'dw.json exists but is not valid JSON. Open it for manual fix?', + 'Open', + 'Cancel', + ); + if (action === 'Open') await openFile(dwJsonPath); + return; + } + } + if (!Array.isArray(existing.configs)) existing.configs = []; + // Replace any same-named entry; otherwise append. + const idx = existing.configs.findIndex((c) => c && (c as {name?: string}).name === entry.name); + if (idx >= 0) existing.configs[idx] = entry; + else existing.configs.push(entry); + // Ensure single active. + for (const c of existing.configs) { + if (c && (c as {name?: string}).name !== entry.name) (c as {active?: boolean}).active = false; + } + + // Inline OAuth/basic into dw.json only when explicitly chosen. + if (plan.oauthPlacement === 'dw-json') { + if (plan.oauthClientId) entry['client-id'] = plan.oauthClientId; + if (plan.oauthClientSecret) entry['client-secret'] = plan.oauthClientSecret; + } + if (plan.basicPlacement === 'dw-json') { + if (plan.basicUsername) entry.username = plan.basicUsername; + if (plan.basicPassword) entry.password = plan.basicPassword; + } + + await fs.writeFile(dwJsonPath, JSON.stringify(existing, null, 2) + '\n', 'utf-8'); + await openFile(dwJsonPath); + await ensureGitIgnoreEntry(wsFolder.uri.fsPath, 'dw.json'); + + // Apply secrets to the chosen storage. Each placement is fired internally + // where it can be done safely (Keychain via execFile; env var export + // queued in a terminal because it must run in the user's shell). + const inst = plan.connection.instanceName; + const report: string[] = []; + const errors: string[] = []; + const pluginsToInstall = new Set(); + + if (plan.oauthPlacement === 'macos-keychain') pluginsToInstall.add('macos-keychain'); + if (plan.basicPlacement === 'macos-keychain') pluginsToInstall.add('macos-keychain'); + if (plan.oauthPlacement === 'password-store') pluginsToInstall.add('password-store'); + if (plan.basicPlacement === 'password-store') pluginsToInstall.add('password-store'); + + // Plugin installs queue a single terminal command per plugin. + const terminalLines: string[] = []; + for (const p of pluginsToInstall) { + if (p === 'macos-keychain') { + terminalLines.push('b2c plugins install sfcc-solutions-share/b2c-plugin-macos-keychain'); + } else if (p === 'password-store') { + terminalLines.push('b2c plugins install sfcc-solutions-share/b2c-plugin-password-store'); + } + } + + // OAuth pair + if (plan.oauthPlacement === 'macos-keychain' && plan.oauthClientId && plan.oauthClientSecret) { + try { + await writeKeychainPair(inst, { + clientId: plan.oauthClientId, + clientSecret: plan.oauthClientSecret, + }); + report.push(`Keychain: b2c-cli/${inst} (clientId, clientSecret) ✓`); + } catch (e) { + errors.push(`Keychain (OAuth): ${e instanceof Error ? e.message : String(e)}`); + } + } else if (plan.oauthPlacement === 'password-store' && plan.oauthClientId && plan.oauthClientSecret) { + terminalLines.push( + `pass insert -m b2c-cli/${inst}-oauth <<'EOF'`, + plan.oauthClientSecret, + `clientId: ${plan.oauthClientId}`, + `clientSecret: ${plan.oauthClientSecret}`, + `EOF`, + ); + report.push(`Password Store: b2c-cli/${inst}-oauth (queued in terminal)`); + } else if (plan.oauthPlacement === 'env' && plan.oauthClientId && plan.oauthClientSecret) { + terminalLines.push( + `export SFCC_CLIENT_ID=${shellEscape(plan.oauthClientId)}`, + `export SFCC_CLIENT_SECRET=${shellEscape(plan.oauthClientSecret)}`, + ); + report.push('Env vars: SFCC_CLIENT_ID, SFCC_CLIENT_SECRET (queued in terminal)'); + } else if (plan.oauthPlacement === 'dw-json') { + report.push('dw.json: client-id, client-secret ✓'); + } + + // Basic pair + if (plan.basicPlacement === 'macos-keychain' && plan.basicUsername && plan.basicPassword) { + try { + await writeKeychainPair(`${inst}-basic`, { + username: plan.basicUsername, + password: plan.basicPassword, + }); + report.push(`Keychain: b2c-cli/${inst}-basic (username, password) ✓`); + } catch (e) { + errors.push(`Keychain (Basic): ${e instanceof Error ? e.message : String(e)}`); + } + } else if (plan.basicPlacement === 'password-store' && plan.basicUsername && plan.basicPassword) { + terminalLines.push( + `pass insert -m b2c-cli/${inst}-basic <<'EOF'`, + plan.basicPassword, + `username: ${plan.basicUsername}`, + `password: ${plan.basicPassword}`, + `EOF`, + ); + report.push(`Password Store: b2c-cli/${inst}-basic (queued in terminal)`); + } else if (plan.basicPlacement === 'env' && plan.basicUsername && plan.basicPassword) { + terminalLines.push( + `export SFCC_USERNAME=${shellEscape(plan.basicUsername)}`, + `export SFCC_PASSWORD=${shellEscape(plan.basicPassword)}`, + ); + report.push('Env vars: SFCC_USERNAME, SFCC_PASSWORD (queued in terminal)'); + } else if (plan.basicPlacement === 'dw-json') { + report.push('dw.json: username, password ✓'); + } + + // MRT API key + if (plan.mrtPlacement === 'env' && plan.mrtApiKey) { + terminalLines.push(`export MRT_API_KEY=${shellEscape(plan.mrtApiKey)}`); + report.push('Env vars: MRT_API_KEY (queued in terminal)'); + } else if ((plan.mrtPlacement === 'macos-keychain' || plan.mrtPlacement === 'password-store') && plan.mrtApiKey) { + // MRT credentials live in ~/.mobify; the CLI manages that path. + terminalLines.push(`b2c mrt save-credentials # paste MRT_API_KEY when prompted`); + report.push('MRT: ~/.mobify (run `b2c mrt save-credentials` from the queued terminal)'); + } else if (plan.mrtPlacement === 'dw-json') { + vscode.window.showWarningMessage( + 'MRT_API_KEY cannot live in dw.json. Use env vars or `b2c mrt save-credentials` instead.', + ); + } + + // Persist chosen placement for next-run defaults. + await context.globalState.update('b2c-dx.lastSecretPlacement', plan.oauthPlacement ?? plan.basicPlacement); + + // Surface results. + if (terminalLines.length > 0) { + const term = vscode.window.createTerminal({name: `B2C DX — ${inst} setup`}); + term.show(); + term.sendText('# Review each line and press Enter to run.', false); + for (const l of terminalLines) term.sendText(l, false); + } + + const summary = report.length > 0 ? report.map((l) => ` • ${l}`).join('\n') : ' (none)'; + const errSummary = errors.length > 0 ? '\n\nErrors:\n' + errors.map((e) => ` • ${e}`).join('\n') : ''; + const action = await vscode.window.showInformationMessage( + `B2C DX: ${inst} configured.\n\nApplied:\n${summary}${errSummary}`, + {modal: true}, + 'Inspect resolved config', + 'Done', + ); + if (action === 'Inspect resolved config') { + await vscode.commands.executeCommand('b2c-dx.walkthrough.inspectSetup'); + } +} + +/** POSIX shell-escape: wrap in single quotes, escape any embedded ones. */ +function shellEscape(value: string): string { + return `'${value.replace(/'/g, `'\\''`)}'`; +} + +/** Write a `: ` JSON blob into the macOS Keychain under + * service `b2c-cli`, account ``. Uses `security add-generic-password` + * via execFile so we can pass arguments as an array (no shell injection + * risk from secret content). The `-U` flag updates if the entry exists. */ +async function writeKeychainPair(account: string, fields: Record): Promise { + if (process.platform !== 'darwin') { + throw new Error('Keychain integration is macOS-only.'); + } + const blob = JSON.stringify(fields); + await new Promise((resolve, reject) => { + cp.execFile( + 'security', + ['add-generic-password', '-s', 'b2c-cli', '-a', account, '-w', blob, '-U'], + {timeout: 5000}, + (err) => (err ? reject(err) : resolve()), + ); + }); +} + +async function ensureGitIgnoreEntry(workspaceRoot: string, entry: string): Promise { + const giPath = path.join(workspaceRoot, '.gitignore'); + let body = ''; + if (await checkFileExists(giPath)) { + body = await fs.readFile(giPath, 'utf-8'); + if (body.split(/\r?\n/).some((l) => l.trim() === entry)) return; + body = body.trimEnd() + '\n\n# B2C Commerce credentials\n' + entry + '\n'; + } else { + body = `# B2C Commerce credentials\n${entry}\n`; + } + await fs.writeFile(giPath, body, 'utf-8'); +} + +/** Fields whose values must be redacted before display. Names match every + * documented variant (kebab + camel + env-var) so accidental aliases are + * caught. */ +const SENSITIVE_FIELDS = new Set([ + 'password', + 'client-secret', + 'clientSecret', + 'sfcc_password', + 'sfcc_client_secret', + 'mrt_api_key', + 'mrtApiKey', + 'apiKey', + 'api-key', + 'certificate', + 'certificate-passphrase', + 'certificatePassphrase', +]); + +async function runB2cInspect(workingDir: string): Promise<{stdout: string; ok: boolean}> { + return new Promise((resolve) => { + cp.execFile('b2c', ['setup', 'inspect', '--json'], {cwd: workingDir, timeout: 8000}, (err, stdout) => { + if (err) resolve({stdout: stdout ?? '', ok: false}); + else resolve({stdout: stdout ?? '', ok: true}); + }); + }); +} + +/** Tries to coerce parsed inspect output into a list of `{field, value, source}` + * rows. The CLI's --json shape is `{ values: { field: { value, source } } }` + * on recent releases; older versions emit a flat object. We accept both. */ +interface InspectRow { + field: string; + value: string; + source?: string; + sensitive: boolean; +} + +function flattenInspect(parsed: unknown): InspectRow[] { + const rows: InspectRow[] = []; + const isSensitive = (key: string) => { + const lc = key.toLowerCase(); + return ( + SENSITIVE_FIELDS.has(key) || SENSITIVE_FIELDS.has(lc) || /(secret|password|api[-_]?key|passphrase)/i.test(key) + ); + }; + const stringifyVal = (v: unknown): string => { + if (v === null || v === undefined) return ''; + if (typeof v === 'string') return v; + if (typeof v === 'number' || typeof v === 'boolean') return String(v); + return JSON.stringify(v); + }; + + if (!parsed || typeof parsed !== 'object') return rows; + const obj = parsed as Record; + + // Shape A: { values: { field: { value, source } } } — older CLI versions. + if (obj.values && typeof obj.values === 'object') { + for (const [field, raw] of Object.entries(obj.values as Record)) { + if (raw && typeof raw === 'object' && 'value' in (raw as Record)) { + const r = raw as {value: unknown; source?: unknown}; + rows.push({ + field, + value: stringifyVal(r.value), + source: typeof r.source === 'string' ? r.source : undefined, + sensitive: isSensitive(field), + }); + } else { + rows.push({field, value: stringifyVal(raw), sensitive: isSensitive(field)}); + } + } + return rows; + } + + // Shape B: { config: { …fields }, sources: { field: 'source-name' } } + // (current `b2c setup inspect --json` shape). + if (obj.config && typeof obj.config === 'object') { + const config = obj.config as Record; + const sources = + obj.sources && typeof obj.sources === 'object' && !Array.isArray(obj.sources) + ? (obj.sources as Record) + : {}; + const sourcesArr = Array.isArray(obj.sources) ? (obj.sources as Array>) : null; + // Optional: Shape B-arr — sources is `[{name, fields:[…]}]`. + const arrSourceFor = (field: string): string | undefined => { + if (!sourcesArr) return undefined; + for (const s of sourcesArr) { + const fields = s && typeof s === 'object' ? (s as {fields?: unknown}).fields : undefined; + if (Array.isArray(fields) && fields.includes(field)) { + return typeof (s as {name?: unknown}).name === 'string' ? (s as {name: string}).name : 'unknown'; + } + } + return undefined; + }; + const flat = (prefix: string, val: unknown) => { + if (val && typeof val === 'object' && !Array.isArray(val)) { + for (const [k, v] of Object.entries(val as Record)) { + flat(prefix ? `${prefix}.${k}` : k, v); + } + return; + } + const src = typeof sources[prefix] === 'string' ? (sources[prefix] as string) : arrSourceFor(prefix); + rows.push({ + field: prefix, + value: stringifyVal(val), + source: src, + sensitive: isSensitive(prefix.split('.').pop() || prefix), + }); + }; + for (const [k, v] of Object.entries(config)) flat(k, v); + return rows; + } + + // Shape C: a plain map of field → primitive (no source info). + for (const [field, raw] of Object.entries(obj)) { + if (raw && typeof raw === 'object' && 'value' in (raw as Record)) { + const r = raw as {value: unknown; source?: unknown}; + rows.push({ + field, + value: stringifyVal(r.value), + source: typeof r.source === 'string' ? r.source : undefined, + sensitive: isSensitive(field), + }); + } else { + rows.push({field, value: stringifyVal(raw), sensitive: isSensitive(field)}); + } + } + return rows; +} + +let inspectPanelRef: vscode.WebviewPanel | undefined; + +async function openInspect(): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a folder first — inspect resolves config relative to the workspace.'); + return; + } + + const buildHtml = async (): Promise => { + const [{stdout, ok}, cliVersion] = await Promise.all([ + runB2cInspect(wsFolder.uri.fsPath), + new Promise((resolve) => { + cp.execFile('b2c', ['--version'], {timeout: 5000}, (err, out) => { + if (err) return resolve(undefined); + const match = out.trim().match(/(\d+\.\d+\.\d+(?:[-+][\w.]+)?)/); + resolve(match ? match[1] : out.trim() || undefined); + }); + }), + ]); + if (!ok) return renderInspectError(stdout); + let parsed: unknown; + try { + parsed = JSON.parse(stdout); + } catch { + parsed = stdout; + } + const rows = flattenInspect(parsed); + return renderInspectPanel(rows, parsed, cliVersion); + }; + + if (inspectPanelRef) { + inspectPanelRef.reveal(undefined, true); + inspectPanelRef.webview.html = await buildHtml(); + return; + } + + inspectPanelRef = vscode.window.createWebviewPanel( + 'b2c-dx.inspectSetup', + 'B2C DX · Resolved Config', + {viewColumn: vscode.ViewColumn.Active, preserveFocus: false}, + {enableScripts: true, retainContextWhenHidden: true}, + ); + inspectPanelRef.onDidDispose(() => { + inspectPanelRef = undefined; + }); + + // Attach the message handler exactly once per panel instance. + inspectPanelRef.webview.onDidReceiveMessage(async (msg: {type?: string}) => { + if (!inspectPanelRef) return; + if (msg && msg.type === 'refresh') { + inspectPanelRef.webview.html = await buildHtml(); + } else if (msg && msg.type === 'openTerminalUnmask') { + const term = vscode.window.createTerminal({name: 'B2C DX — setup inspect (unmasked)'}); + term.show(); + term.sendText('b2c setup inspect --unmask', false); + } + }); + + inspectPanelRef.webview.html = await buildHtml(); +} + +function escapeHtml(s: string): string { + return s.replace(/[&<>"']/g, (c) => + c === '&' ? '&' : c === '<' ? '<' : c === '>' ? '>' : c === '"' ? '"' : ''', + ); +} + +function renderInspectError(stdout: string): string { + const styles = inspectStyles(); + return ` +
+
+ B2C DX · Resolved Config +

Could not run b2c setup inspect

+

The CLI isn't installed or returned an error. Install via Phase 1, or run the command manually in a terminal.

+
+
+ + +
+
+ ${stdout ? `
${escapeHtml(stdout)}
` : ''} + + `; +} + +function renderInspectPanel(rows: InspectRow[], parsed: unknown, cliVersion?: string): string { + const styles = inspectStyles(); + // Group rows by source for the second view; keeps the per-source breakdown + // clean even when one field is supplied by multiple lower-priority sources. + const bySource = new Map(); + for (const r of rows) { + const key = r.source ?? 'unknown'; + if (!bySource.has(key)) bySource.set(key, []); + bySource.get(key)!.push(r); + } + + const sourceColor = (source: string | undefined): string => { + if (!source) return 'var(--src-fallback)'; + const s = source.toLowerCase(); + if (s.includes('env')) return 'var(--src-env)'; + if (s.includes('keychain')) return 'var(--src-keychain)'; + if (s.includes('pass')) return 'var(--src-pass)'; + if (s.includes('dw.json')) return 'var(--src-file)'; + if (s.includes('plugin')) return 'var(--src-plugin)'; + return 'var(--src-fallback)'; + }; + + const lockSvg = ``; + const copySvg = ``; + + const renderRow = (r: InspectRow, idx: number): string => { + const valueStr = r.value || ''; + const display = r.value + ? r.sensitive + ? `${lockSvg}••••••••` + : escapeHtml(r.value) + : ''; + const srcLabel = r.source ? escapeHtml(r.source) : 'unknown'; + const srcLower = (r.source ?? 'unknown').toLowerCase(); + const searchHaystack = `${r.field} ${valueStr} ${srcLabel}`.toLowerCase(); + return ` + + ${escapeHtml(r.field)} + + + + ${display} + ${!r.sensitive && r.value ? `` : ''} + + ${srcLabel} + `; + }; + + const renderSourceBlock = (source: string, items: InspectRow[]): string => ` +
+
+ ${escapeHtml(source)} + ${items.length} +
+
    + ${items + .map( + (r) => + `
  • ${escapeHtml(r.field)}${ + r.sensitive ? ` ${lockSvg}` : '' + }
  • `, + ) + .join('')} +
+
`; + + const fallbackJson = !rows.length + ? `
${escapeHtml(typeof parsed === 'string' ? parsed : JSON.stringify(parsed, null, 2))}
` + : ''; + + const secretCount = rows.filter((r) => r.sensitive).length; + const sourceCount = bySource.size; + + // Source legend — show distinct sources with their colors so users can decode the pills. + const legendItems = [...bySource.keys()] + .map( + (s) => + `${escapeHtml(s)}`, + ) + .join(''); + + return ` +
+
+ B2C DX · Resolved Config +

What the CLI sees right now

+

Source of truth for every config field — secrets are masked.

+
+ ${cliVersion ? `CLI v${escapeHtml(cliVersion)}` : ''} + ${ + rows.length + ? `${rows.length} field${rows.length === 1 ? '' : 's'} + ${sourceCount} source${sourceCount === 1 ? '' : 's'} + ${secretCount ? `${lockSvg}${secretCount} masked` : ''}` + : '' + } +
+
+
+ + +
+
+ + ${ + rows.length + ? ` +
+
+ + + +
+
+ + ${[...bySource.entries()] + .map( + ([s, items]) => + ``, + ) + .join('')} +
+
+ +
+
+

All fields

+ ${rows.length} + + +
+
+ + + ${rows.map((r, i) => renderRow(r, i)).join('')} +
FieldValueSource
+
+
+ +
+
+

Grouped by source

+ ${sourceCount} +
+ ${legendItems ? `
${legendItems}
` : ''} +
+ ${[...bySource.entries()].map(([s, items]) => renderSourceBlock(s, items)).join('')} +
+
+ + + ` + : `
+
+
🔍
+

No resolved fields

+
+

The CLI returned an empty configuration. This usually means one of the following:

+
    +
  • No dw.json was found in this workspace root
  • +
  • The dw.json exists but has no configured instances
  • +
  • Your B2C CLI version is too old to parse the file correctly
  • +
+
+

Tip: You have B2C CLI ${cliVersion ? `v${cliVersion}` : '(unknown version)'} installed. Run npm install -g @salesforce/b2c-cli@latest to update, then click Refresh.

+
+ ${fallbackJson ? `
Raw CLI output${fallbackJson}
` : ''} +
` + } + + + `; +} + +function inspectStyles(): string { + return ` + :root { + color-scheme: light dark; + --hairline: var(--vscode-panel-border, var(--vscode-editorGroup-border, rgba(128,128,128,0.22))); + --surface: var(--vscode-editorWidget-background, var(--vscode-editor-background)); + --row-zebra: color-mix(in srgb, var(--vscode-foreground) 4%, transparent); + --row-hover: color-mix(in srgb, var(--vscode-foreground) 8%, transparent); + --brand-blue: #0176D3; + --brand-blue-deep: #014486; + --brand-blue-soft: rgba(1, 118, 211, 0.10); + --brand-green: #1A8754; + --secret-amber: #C77700; + --secret-amber-soft: rgba(199, 119, 0, 0.10); + --src-env: #1A8754; + --src-keychain: #0176D3; + --src-pass: #6F42C1; + --src-file: #C77700; + --src-plugin: #1B96FF; + --src-fallback: rgba(127,127,127,0.55); + } + *, *::before, *::after { box-sizing: border-box; } + body { + margin: 0; padding: 32px 40px; + min-height: 100vh; + font-family: 'Salesforce Sans','IBM Plex Sans','Source Sans 3',-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,sans-serif; + color: var(--vscode-foreground); + background: var(--vscode-editor-background); + } + .muted { color: var(--vscode-descriptionForeground); } + code { font-family: var(--vscode-editor-font-family, ui-monospace, monospace); background: var(--brand-blue-soft); padding: 1px 6px; border-radius: 4px; color: var(--brand-blue-deep); font-size: 0.86em; } + .eyebrow { display: inline-block; font-size: 0.72rem; font-weight: 700; letter-spacing: 0.16em; color: var(--brand-blue); text-transform: uppercase; margin-bottom: 6px; } + h1 { margin: 0 0 6px; font-size: 1.7rem; font-weight: 700; letter-spacing: -0.02em; line-height: 1.15; } + h2 { margin: 0; font-size: 0.95rem; font-weight: 600; letter-spacing: -0.005em; } + .hdr { + display: flex; align-items: flex-start; justify-content: space-between; gap: 24px; + margin-bottom: 24px; flex-wrap: wrap; + } + .hdr-text { flex: 1 1 360px; min-width: 0; } + .hdr-text > p { margin: 0 0 12px; max-width: 720px; } + .hdr-actions { display: flex; gap: 8px; flex-wrap: wrap; } + .stats { + display: inline-flex; align-items: center; gap: 10px; + padding: 7px 12px; border-radius: 999px; + background: var(--surface); + border: 1px solid var(--hairline); + font-size: 0.82rem; + } + .stat { display: inline-flex; align-items: center; gap: 5px; color: var(--vscode-descriptionForeground); } + .stat strong { color: var(--vscode-foreground); font-weight: 700; } + .stat-sep { color: var(--vscode-descriptionForeground); opacity: 0.5; } + .secret-stat { color: var(--secret-amber); } + .secret-stat strong { color: var(--secret-amber); } + .secret-stat .lock-icon { color: var(--secret-amber); } + button { + display: inline-flex; align-items: center; gap: 6px; + font: inherit; cursor: pointer; padding: 8px 14px; + border-radius: 999px; font-weight: 600; font-size: 0.84rem; + transition: all 0.15s ease; + } + button svg { display: block; } + .btn-primary { background: var(--brand-blue); color: #fff; border: 1px solid var(--brand-blue); } + .btn-primary:hover { background: var(--brand-blue-deep); border-color: var(--brand-blue-deep); transform: translateY(-1px); box-shadow: 0 2px 8px rgba(1,118,211,0.30); } + .btn-ghost { background: transparent; color: var(--brand-blue); border: 1px solid var(--brand-blue); } + .btn-ghost:hover { background: var(--brand-blue-soft); } + .card { + background: var(--surface); border: 1px solid var(--hairline); + border-radius: 14px; padding: 22px 24px; margin-bottom: 18px; + box-shadow: 0 1px 2px rgba(0,0,0,0.04), 0 6px 18px rgba(0,0,0,0.04); + } + .card-hdr { display: flex; align-items: center; gap: 10px; margin-bottom: 14px; } + .badge { + display: inline-flex; align-items: center; justify-content: center; + min-width: 22px; height: 22px; padding: 0 8px; + border-radius: 999px; + background: var(--brand-blue-soft); + color: var(--brand-blue-deep); + font-size: 0.74rem; font-weight: 700; + letter-spacing: 0.02em; + } + .card.empty { text-align: center; padding: 36px 22px; } + table.tbl { width: 100%; border-collapse: separate; border-spacing: 0; } + .tbl th { text-align: left; font-size: 0.7rem; letter-spacing: 0.14em; text-transform: uppercase; font-weight: 700; color: var(--vscode-descriptionForeground); padding: 6px 14px 12px; border-bottom: 1px solid var(--hairline); } + .tbl th.th-source { text-align: left; } + .tbl td { padding: 11px 14px; font-size: 0.9rem; vertical-align: middle; border-bottom: 1px solid color-mix(in srgb, var(--hairline) 60%, transparent); } + .tbl tbody tr.row-odd td { background: var(--row-zebra); } + .tbl tbody tr:hover td { background: var(--row-hover); } + .tbl tbody tr:first-child td:first-child { border-top-left-radius: 8px; } + .tbl tbody tr:first-child td:last-child { border-top-right-radius: 8px; } + .tbl tbody tr:last-child td { border-bottom: none; } + .tbl tbody tr:last-child td:first-child { border-bottom-left-radius: 8px; } + .tbl tbody tr:last-child td:last-child { border-bottom-right-radius: 8px; } + .tbl .field { font-family: var(--vscode-editor-font-family, ui-monospace, monospace); font-size: 0.86rem; color: var(--vscode-foreground); white-space: nowrap; } + .tbl .value { font-family: var(--vscode-editor-font-family, ui-monospace, monospace); font-size: 0.86rem; word-break: break-all; } + .tbl .source { white-space: nowrap; width: 1%; } + .masked { + display: inline-flex; align-items: center; gap: 6px; + padding: 3px 10px; border-radius: 999px; + background: var(--secret-amber-soft); + border: 1px solid color-mix(in srgb, var(--secret-amber) 35%, transparent); + color: var(--secret-amber); + font-size: 0.78rem; font-weight: 600; + } + .masked-dots { letter-spacing: 0.18em; line-height: 1; } + .lock-icon { color: var(--secret-amber); flex-shrink: 0; } + .lock-inline { display: inline-flex; vertical-align: middle; opacity: 0.85; } + .src-pill { + display: inline-flex; align-items: center; gap: 7px; + padding: 3px 10px 3px 9px; + border-radius: 999px; + background: color-mix(in srgb, var(--src-color) 10%, transparent); + border: 1px solid color-mix(in srgb, var(--src-color) 30%, transparent); + color: var(--vscode-foreground); + font-size: 0.78rem; font-weight: 500; + } + .src-pill .dot { background: var(--src-color); width: 7px; height: 7px; margin: 0; border-radius: 50%; box-shadow: 0 0 0 2px color-mix(in srgb, var(--src-color) 18%, transparent); } + .src-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr)); gap: 14px; } + .src-block { + background: var(--vscode-editor-background); + border: 1px solid var(--hairline); + border-left: 3px solid var(--src-color); + border-radius: 10px; padding: 14px 16px; + transition: border-color 0.15s ease, transform 0.15s ease; + } + .src-block:hover { transform: translateY(-1px); border-color: color-mix(in srgb, var(--src-color) 50%, var(--hairline)); } + .src-hdr { display: flex; align-items: center; gap: 8px; margin-bottom: 10px; font-size: 0.88rem; font-weight: 600; } + .src-hdr .src-name { color: var(--vscode-foreground); } + .src-hdr .src-count { + margin-left: auto; + display: inline-flex; align-items: center; justify-content: center; + min-width: 22px; height: 20px; padding: 0 7px; + border-radius: 999px; + background: color-mix(in srgb, var(--src-color) 14%, transparent); + color: var(--src-color); + font-size: 0.72rem; font-weight: 700; + } + .src-fields { list-style: none; padding: 0; margin: 0; display: flex; flex-direction: column; gap: 5px; } + .src-fields li { font-family: var(--vscode-editor-font-family, ui-monospace, monospace); font-size: 0.82rem; color: var(--vscode-descriptionForeground); display: flex; align-items: center; gap: 6px; } + .src-fields li .field { color: var(--vscode-foreground); } + pre.raw { background: rgba(127,127,127,0.10); padding: 12px 14px; border-radius: 8px; border: 1px solid var(--hairline); overflow-x: auto; font-size: 0.82rem; line-height: 1.45; white-space: pre; } + + /* Meta chips in header */ + .meta-chips { display: inline-flex; flex-wrap: wrap; align-items: center; gap: 6px; margin-top: 4px; } + .meta-chip { + display: inline-flex; align-items: center; gap: 5px; + padding: 4px 10px; border-radius: 999px; + background: var(--surface); + border: 1px solid var(--hairline); + font-size: 0.78rem; + color: var(--vscode-descriptionForeground); + } + .meta-chip strong { color: var(--vscode-foreground); font-weight: 700; } + .meta-chip svg { color: var(--brand-blue); } + .meta-chip.secret-chip { color: var(--secret-amber); border-color: color-mix(in srgb, var(--secret-amber) 30%, transparent); background: var(--secret-amber-soft); } + .meta-chip.secret-chip strong { color: var(--secret-amber); } + .meta-chip.secret-chip .lock-icon { color: var(--secret-amber); } + + /* Toolbar (search + filter pills) */ + .toolbar { + display: flex; align-items: center; gap: 14px; flex-wrap: wrap; + margin-bottom: 16px; + padding: 12px 14px; + background: var(--surface); + border: 1px solid var(--hairline); + border-radius: 12px; + } + .search-wrap { + position: relative; + flex: 1 1 280px; + min-width: 240px; + display: flex; align-items: center; + } + .search-icon { + position: absolute; left: 12px; top: 50%; transform: translateY(-50%); + color: var(--vscode-descriptionForeground); pointer-events: none; + } + #search { + width: 100%; + padding: 8px 36px 8px 36px; + border-radius: 8px; + border: 1px solid var(--hairline); + background: var(--vscode-input-background, var(--vscode-editor-background)); + color: var(--vscode-input-foreground, var(--vscode-foreground)); + font: inherit; font-size: 0.88rem; + outline: none; + transition: border-color 0.15s ease, box-shadow 0.15s ease; + } + #search:focus { border-color: var(--brand-blue); box-shadow: 0 0 0 3px rgba(1,118,211,0.18); } + #search::placeholder { color: var(--vscode-input-placeholderForeground, var(--vscode-descriptionForeground)); opacity: 0.85; } + .search-clear { + position: absolute; right: 6px; top: 50%; transform: translateY(-50%); + width: 22px; height: 22px; + display: inline-flex; align-items: center; justify-content: center; + padding: 0; border-radius: 50%; border: 0; + background: transparent; + color: var(--vscode-descriptionForeground); + font-size: 1.1rem; line-height: 1; + cursor: pointer; + } + .search-clear:hover { background: var(--row-hover); color: var(--vscode-foreground); } + + .filter-pills { display: inline-flex; flex-wrap: wrap; gap: 6px; } + .filter-pill { + display: inline-flex; align-items: center; gap: 6px; + padding: 5px 11px; border-radius: 999px; + background: transparent; + border: 1px solid var(--hairline); + color: var(--vscode-descriptionForeground); + font-size: 0.78rem; font-weight: 500; + cursor: pointer; + transition: background 0.15s ease, color 0.15s ease, border-color 0.15s ease; + } + .filter-pill:hover { background: var(--row-hover); color: var(--vscode-foreground); } + .filter-pill.active { + background: var(--brand-blue); + color: #fff; border-color: var(--brand-blue); + } + .filter-pill.active .pill-count { background: rgba(255,255,255,0.22); color: #fff; } + .filter-pill .dot { + display: inline-block; width: 7px; height: 7px; border-radius: 50%; + background: var(--src-color, var(--src-fallback)); + } + .filter-pill.active .dot { background: rgba(255,255,255,0.85); } + .pill-count { + display: inline-flex; align-items: center; justify-content: center; + min-width: 18px; height: 16px; padding: 0 5px; + border-radius: 999px; + background: var(--brand-blue-soft); + color: var(--brand-blue-deep); + font-size: 0.68rem; font-weight: 700; + } + + /* Card header spacer + hint */ + .card-hdr-spacer { flex: 1 1 auto; } + .card-hdr .hint { font-size: 0.82rem; } + + /* Sticky table header */ + .tbl-wrap { position: relative; } + .tbl thead th { + position: sticky; top: 0; + background: var(--surface); + z-index: 2; + } + + /* Copy-to-clipboard buttons */ + .copy-btn { + display: inline-flex; align-items: center; justify-content: center; + width: 22px; height: 22px; + margin-left: 6px; + padding: 0; border-radius: 6px; + border: 1px solid transparent; + background: transparent; + color: var(--vscode-descriptionForeground); + cursor: pointer; + opacity: 0; + transition: opacity 0.15s ease, background 0.15s ease, color 0.15s ease; + vertical-align: middle; + } + .tbl tr:hover .copy-btn { opacity: 0.7; } + .copy-btn:hover { opacity: 1 !important; background: var(--row-hover); color: var(--brand-blue); } + .copy-btn:focus-visible { opacity: 1; outline: 2px solid var(--brand-blue); outline-offset: 1px; } + .field-name { display: inline-block; } + + /* Source legend */ + .legend { + display: flex; flex-wrap: wrap; gap: 8px; + padding: 8px 12px; + margin-bottom: 14px; + background: var(--vscode-editor-background); + border: 1px solid var(--hairline); + border-radius: 8px; + } + .legend-item { + display: inline-flex; align-items: center; gap: 6px; + padding: 3px 9px; border-radius: 999px; + background: color-mix(in srgb, var(--src-color) 8%, transparent); + border: 1px solid color-mix(in srgb, var(--src-color) 22%, transparent); + color: var(--vscode-foreground); + font-size: 0.76rem; font-weight: 500; + } + .legend-item .dot { + width: 8px; height: 8px; border-radius: 50%; + background: var(--src-color); + } + + /* Toast */ + .toast { + position: fixed; + bottom: 24px; left: 50%; transform: translateX(-50%) translateY(8px); + padding: 10px 18px; + background: var(--vscode-foreground); + color: var(--vscode-editor-background); + border-radius: 999px; + font-size: 0.84rem; font-weight: 600; + box-shadow: 0 6px 24px rgba(0,0,0,0.18); + opacity: 0; + pointer-events: none; + transition: opacity 0.2s ease, transform 0.2s ease; + z-index: 100; + } + .toast.show { opacity: 1; transform: translateX(-50%) translateY(0); } + `; +} + +/** + * Creates a dw.json template file in the workspace root. + * Prompts user for configuration type and handles existing file scenarios. + */ +async function createDwJsonTemplate(): Promise { + const workspaceFolder = vscode.workspace.workspaceFolders?.[0]; + + if (!workspaceFolder) { + vscode.window.showErrorMessage('No workspace folder open. Please open a folder first, then try again.'); + return; + } + + const dwJsonPath = path.join(workspaceFolder.uri.fsPath, 'dw.json'); + + // Check if dw.json already exists + const fileExists = await checkFileExists(dwJsonPath); + + if (fileExists) { + const action = await vscode.window.showWarningMessage( + 'dw.json already exists in this workspace.', + 'Open Existing', + 'Overwrite', + 'Cancel', + ); + + if (action === 'Cancel' || !action) { + return; + } + + if (action === 'Open Existing') { + await openFile(dwJsonPath); + return; + } + + // User chose "Overwrite", continue with creation + } + + // Ask user which template they want + const templateType = await vscode.window.showQuickPick( + [ + { + label: 'Single Instance', + description: 'Basic configuration with one B2C instance', + detail: 'Recommended for most users', + value: 'single', + }, + { + label: 'Multiple Instances', + description: 'Configuration with multiple B2C instances', + detail: 'Use if you need to switch between dev, staging, etc.', + value: 'multi', + }, + ], + { + title: 'Select dw.json Template', + placeHolder: 'Choose a configuration template', + }, + ); + + if (!templateType) { + return; // User cancelled + } + + // Select template based on user choice + const template = templateType.value === 'multi' ? DW_JSON_MULTI_INSTANCE_TEMPLATE : DW_JSON_TEMPLATE; + + try { + const content = JSON.stringify(template, null, 2); + await fs.writeFile(dwJsonPath, content, 'utf-8'); + await openFile(dwJsonPath); + + const action = await vscode.window.showInformationMessage( + 'dw.json created. Update it with your B2C Commerce credentials.', + 'Add to .gitignore', + 'Dismiss', + ); + if (action === 'Add to .gitignore') { + await addToGitignore(workspaceFolder.uri.fsPath); + } + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + vscode.window.showErrorMessage(`Failed to create dw.json: ${message}`); + } +} + +/** + * Opens a file in the editor. + */ +async function openFile(filePath: string): Promise { + try { + const doc = await vscode.workspace.openTextDocument(filePath); + await vscode.window.showTextDocument(doc, { + preview: false, + viewColumn: vscode.ViewColumn.One, + }); + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + vscode.window.showErrorMessage(`Failed to open file: ${message}`); + } +} + +/** + * Checks if a file exists. + */ +async function checkFileExists(filePath: string): Promise { + try { + await fs.access(filePath); + return true; + } catch { + return false; + } +} + +/** + * Adds dw.json to .gitignore file. + * Creates .gitignore if it doesn't exist. + */ +async function addToGitignore(workspaceRoot: string): Promise { + const gitignorePath = path.join(workspaceRoot, '.gitignore'); + + try { + let gitignoreContent = ''; + + // Read existing .gitignore if it exists + const gitignoreExists = await checkFileExists(gitignorePath); + if (gitignoreExists) { + gitignoreContent = await fs.readFile(gitignorePath, 'utf-8'); + + // Check if dw.json is already in .gitignore + if (gitignoreContent.includes('dw.json')) { + vscode.window.showInformationMessage('dw.json is already in .gitignore'); + return; + } + } + + // Add dw.json to .gitignore + const newContent = gitignoreContent.trim() + ? `${gitignoreContent}\n\n# B2C Commerce credentials\ndw.json\n` + : `# B2C Commerce credentials\ndw.json\n`; + + await fs.writeFile(gitignorePath, newContent, 'utf-8'); + + vscode.window.showInformationMessage('✅ Added dw.json to .gitignore'); + + // Ask if user wants to open .gitignore + const action = await vscode.window.showInformationMessage('Would you like to view .gitignore?', 'Yes', 'No'); + + if (action === 'Yes') { + await openFile(gitignorePath); + } + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + vscode.window.showErrorMessage(`Failed to update .gitignore: ${message}`); + } +} + +/** + * Defensive per-workspace cleanup of onboarding session state. Runs on every + * activation: if the current workspace has no dw.json, treat it as a fresh + * onboarding context — drop any stale `setup.activeInstance` (which would + * otherwise leak the previous workspace's instance name into chips/tooltips) + * and clear the auto-opened seen flag so the deep-dive panel triggers again. + * + * The OnboardingStateStore itself uses workspaceState and resets naturally + * per workspace; this function only mops up loose keys that aren't covered. + */ +export async function resetWorkspaceOnboardingIfFresh(context: vscode.ExtensionContext): Promise { + const folders = vscode.workspace.workspaceFolders ?? []; + if (folders.length === 0) return; + for (const folder of folders) { + try { + await fs.access(path.join(folder.uri.fsPath, 'dw.json')); + return; // workspace already configured — leave state alone + } catch { + // keep checking + } + } + await context.workspaceState.update('b2c-dx.setup.activeInstance', undefined); + await context.workspaceState.update('b2c-dx.gettingStarted.autoOpened', undefined); + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupSessionActive', false); + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupInstance', undefined); +} + +/** + * Open the native VS Code walkthrough automatically on first activation, but + * only when no dw.json exists in the workspace — i.e. the user hasn't set the + * extension up yet. Users can re-open it any time via "B2C DX: Open Getting + * Started Guide", and the role-based deep-dive panel via "B2C DX: Open + * Onboarding Panel". + */ +export async function showWalkthroughOnFirstActivation(context: vscode.ExtensionContext): Promise { + const SEEN_KEY = 'b2c-dx.gettingStarted.autoOpened'; + // Per-workspace flag: each workspace gets its own first-run experience. + if (context.workspaceState.get(SEEN_KEY, false)) return; + const folders = vscode.workspace.workspaceFolders; + if (!folders || folders.length === 0) return; + + // Skip auto-open when the workspace already has a dw.json — the user is + // returning, not starting fresh. + for (const folder of folders) { + try { + await fs.access(path.join(folder.uri.fsPath, 'dw.json')); + await context.workspaceState.update(SEEN_KEY, true); + return; + } catch { + // not present here, keep checking + } + } + + setTimeout(() => { + void vscode.commands.executeCommand( + 'workbench.action.openWalkthrough', + 'Salesforce.b2c-vs-extension#b2c-dx.gettingStarted', + false, + ); + void context.workspaceState.update(SEEN_KEY, true); + }, 1000); +} + +// ─── Per-step setup commands + session ────────────────── +// +// The single-shot wizard above asks everything in one go. Per the docs flow +// the user sees, we also expose four step-bound commands that each prompt +// only for the fields their step owns — and reuse the active instance name +// once the connection step has set it for the workspace. + +const SETUP_INSTANCE_KEY = 'b2c-dx.setup.activeInstance'; + +interface SetupSession { + instanceName: string; +} + +/** Read the active session for this workspace. */ +function getSetupSession(context: vscode.ExtensionContext): SetupSession | undefined { + const name = context.workspaceState.get(SETUP_INSTANCE_KEY); + return name ? {instanceName: name} : undefined; +} + +async function setSetupSession(context: vscode.ExtensionContext, instanceName: string): Promise { + await context.workspaceState.update(SETUP_INSTANCE_KEY, instanceName); + // Publish a context key so welcome views / panels can react. + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupSessionActive', true); + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupInstance', instanceName); +} + +async function clearSetupSession(context: vscode.ExtensionContext): Promise { + await context.workspaceState.update(SETUP_INSTANCE_KEY, undefined); + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupSessionActive', false); + void vscode.commands.executeCommand('setContext', 'b2c-dx.setupInstance', undefined); +} + +async function resetSetupSession(context: vscode.ExtensionContext): Promise { + const session = getSetupSession(context); + const choice = await vscode.window.showWarningMessage( + session + ? `Reset the setup session? The "${session.instanceName}" entry stays in dw.json — only the in-memory pointer is cleared, so the next setup step will ask for an instance name again.` + : 'No active setup session to reset.', + {modal: true}, + 'Reset', + 'Cancel', + ); + if (choice === 'Reset') { + await clearSetupSession(context); + vscode.window.showInformationMessage( + 'B2C DX: Setup session cleared. Run "Connect to Your B2C Instance" to start over.', + ); + } +} + +/** Resolve the active instance, prompting only when no session exists yet. */ +async function ensureInstanceName(context: vscode.ExtensionContext): Promise { + const existing = getSetupSession(context); + if (existing) return existing.instanceName; + const name = await vscode.window.showInputBox({ + title: 'Connect to Your B2C Instance', + prompt: 'Name this instance (becomes the configs[] entry in dw.json)', + placeHolder: 'dev', + value: 'dev', + ignoreFocusOut: true, + validateInput: (v) => (/^[A-Za-z0-9_-]+$/.test(v) ? null : 'Letters, digits, dash, underscore only'), + }); + if (!name) return undefined; + await setSetupSession(context, name); + return name; +} + +/** + * Read dw.json and return the name of the currently active config (or, if no + * entry is flagged active, the sole config when only one exists). Returns + * undefined if dw.json is missing, malformed, or has no usable entry. + */ +async function readActiveInstanceName(workspaceRoot: string): Promise { + const dwJsonPath = path.join(workspaceRoot, 'dw.json'); + if (!(await checkFileExists(dwJsonPath))) return undefined; + try { + const doc = JSON.parse(await fs.readFile(dwJsonPath, 'utf-8')) as { + configs?: {name?: string; active?: boolean}[]; + }; + const configs = Array.isArray(doc.configs) ? doc.configs : []; + const active = configs.find((c) => c?.active === true && typeof c.name === 'string'); + if (active?.name) return active.name; + // Fall back to the only entry when there's exactly one — it's implicitly active. + if (configs.length === 1 && typeof configs[0]?.name === 'string') return configs[0].name; + return undefined; + } catch { + return undefined; + } +} + +/** + * Resolve the instance name for follow-on setup steps (OAuth, WebDAV, SCAPI). + * These edit an existing config rather than creating one, so they should + * target the currently *active* entry in dw.json — not the workspace session, + * which can drift after the user activates a different instance externally. + * + * Order of preference: + * 1. Active config in dw.json (the canonical source of truth) + * 2. Workspace session (set by the Connection step) + * 3. Prompt the user (same UX as ensureInstanceName) + * + * Whenever we resolve from dw.json or by prompt, we sync the workspace session + * so the panel chip and inspect-resolved-config reflect the same target. + */ +async function ensureActiveInstanceName( + context: vscode.ExtensionContext, + workspaceRoot: string, +): Promise { + const activeName = await readActiveInstanceName(workspaceRoot); + if (activeName) { + const session = getSetupSession(context); + if (session?.instanceName !== activeName) { + await setSetupSession(context, activeName); + } + return activeName; + } + return ensureInstanceName(context); +} + +/** Read the workspace dw.json and return its `configs[]` entry for `name`, + * creating one (with `active: true`) if absent. Caller is responsible for + * writing the result back. */ +async function readOrCreateConfigEntry( + workspaceRoot: string, + name: string, +): Promise<{ + doc: {configs?: Record[]; [key: string]: unknown}; + entry: Record; +}> { + const dwJsonPath = path.join(workspaceRoot, 'dw.json'); + let doc: {configs?: Record[]; [key: string]: unknown} = {}; + if (await checkFileExists(dwJsonPath)) { + try { + doc = JSON.parse(await fs.readFile(dwJsonPath, 'utf-8')); + } catch { + // Malformed — surface and bail to caller. + throw new Error('dw.json exists but is not valid JSON. Open it for manual fix.'); + } + } + if (!Array.isArray(doc.configs)) doc.configs = []; + let entry = doc.configs.find((c) => c && (c as {name?: string}).name === name) as Record | undefined; + if (!entry) { + entry = {name, active: true}; + doc.configs.push(entry); + // Ensure single active. + for (const c of doc.configs) { + if (c && (c as {name?: string}).name !== name) (c as {active?: boolean}).active = false; + } + } + return {doc, entry}; +} + +async function writeConfigDoc(workspaceRoot: string, doc: unknown): Promise { + const dwJsonPath = path.join(workspaceRoot, 'dw.json'); + await fs.writeFile(dwJsonPath, JSON.stringify(doc, null, 2) + '\n', 'utf-8'); + await ensureGitIgnoreEntry(workspaceRoot, 'dw.json'); +} + +/** "Inspect resolved config" follow-up — surfaced after every step apply. */ +async function offerInspectFollowUp(message: string): Promise { + const action = await vscode.window.showInformationMessage(message, 'Inspect resolved config', 'Done'); + if (action === 'Inspect resolved config') { + await vscode.commands.executeCommand('b2c-dx.walkthrough.inspectSetup'); + } +} + +/** Reusable secret-placement → apply helper for an OAuth or Basic pair. */ +async function applySecretPair( + inst: string, + pair: 'oauth' | 'basic', + placement: SecretPlacement, + values: Record, + workspaceRoot: string, +): Promise<{report: string[]; errors: string[]; terminalLines: string[]}> { + const report: string[] = []; + const errors: string[] = []; + const terminalLines: string[] = []; + + const writeDwJsonInline = async (fields: Record) => { + const {doc, entry} = await readOrCreateConfigEntry(workspaceRoot, inst); + Object.assign(entry, fields); + await writeConfigDoc(workspaceRoot, doc); + }; + + if (pair === 'oauth') { + const {clientId, clientSecret} = values; + if (placement === 'macos-keychain') { + try { + await writeKeychainPair(inst, {clientId, clientSecret}); + report.push(`Keychain: b2c-cli/${inst} (clientId, clientSecret) ✓`); + } catch (e) { + errors.push(`Keychain (OAuth): ${e instanceof Error ? e.message : String(e)}`); + } + } else if (placement === 'password-store') { + terminalLines.push( + `b2c plugins install sfcc-solutions-share/b2c-plugin-password-store`, + `pass insert -m b2c-cli/${inst}-oauth <<'EOF'`, + clientSecret, + `clientId: ${clientId}`, + `clientSecret: ${clientSecret}`, + `EOF`, + ); + report.push(`Password Store: b2c-cli/${inst}-oauth (queued in terminal)`); + } else if (placement === 'env') { + terminalLines.push( + `export SFCC_CLIENT_ID=${shellEscape(clientId)}`, + `export SFCC_CLIENT_SECRET=${shellEscape(clientSecret)}`, + ); + report.push('Env vars: SFCC_CLIENT_ID, SFCC_CLIENT_SECRET (queued in terminal)'); + } else if (placement === 'dw-json') { + await writeDwJsonInline({'client-id': clientId, 'client-secret': clientSecret}); + report.push('dw.json: client-id, client-secret ✓'); + } + } else if (pair === 'basic') { + const {username, password} = values; + if (placement === 'macos-keychain') { + try { + await writeKeychainPair(`${inst}-basic`, {username, password}); + report.push(`Keychain: b2c-cli/${inst}-basic (username, password) ✓`); + } catch (e) { + errors.push(`Keychain (Basic): ${e instanceof Error ? e.message : String(e)}`); + } + } else if (placement === 'password-store') { + terminalLines.push( + `b2c plugins install sfcc-solutions-share/b2c-plugin-password-store`, + `pass insert -m b2c-cli/${inst}-basic <<'EOF'`, + password, + `username: ${username}`, + `password: ${password}`, + `EOF`, + ); + report.push(`Password Store: b2c-cli/${inst}-basic (queued in terminal)`); + } else if (placement === 'env') { + terminalLines.push( + `export SFCC_USERNAME=${shellEscape(username)}`, + `export SFCC_PASSWORD=${shellEscape(password)}`, + ); + report.push('Env vars: SFCC_USERNAME, SFCC_PASSWORD (queued in terminal)'); + } else if (placement === 'dw-json') { + await writeDwJsonInline({username, password}); + report.push('dw.json: username, password ✓'); + } + } + return {report, errors, terminalLines}; +} + +function flushTerminal(inst: string, lines: string[]): void { + if (!lines.length) return; + const term = vscode.window.createTerminal({name: `B2C DX — ${inst} setup`}); + term.show(); + term.sendText('# Review each line and press Enter to run.', false); + for (const l of lines) term.sendText(l, false); +} + +// ─── Step 1 — Connection (instance name + hostname + code-version) ────── +async function runConnectionStep(context: vscode.ExtensionContext): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a workspace folder first.'); + return; + } + const inst = await ensureInstanceName(context); + if (!inst) return; + + const hostname = await vscode.window.showInputBox({ + title: `Connect · ${inst} · hostname`, + prompt: 'Instance hostname (no https://)', + placeHolder: 'abcd-123.dx.commercecloud.salesforce.com', + ignoreFocusOut: true, + validateInput: (v) => (v.trim().length > 0 ? null : 'Required'), + }); + if (!hostname) return; + const codeVersion = await vscode.window.showInputBox({ + title: `Connect · ${inst} · code-version (optional)`, + prompt: 'Default code version targeted by deploys', + placeHolder: 'version1', + ignoreFocusOut: true, + }); + + try { + const {doc, entry} = await readOrCreateConfigEntry(wsFolder.uri.fsPath, inst); + entry.hostname = hostname; + if (codeVersion) entry['code-version'] = codeVersion; + else delete entry['code-version']; + // Derive and persist the realm from the hostname so the Sandbox Explorer + // can bootstrap directly off dw.json. Only set it if not already present — + // a user-set realm always wins. + if (!entry.realm) { + const derived = deriveRealmFromHostname(hostname); + if (derived) entry.realm = derived; + } + await writeConfigDoc(wsFolder.uri.fsPath, doc); + await openFile(path.join(wsFolder.uri.fsPath, 'dw.json')); + await offerInspectFollowUp(`Connection saved to dw.json (${inst}).`); + } catch (e) { + vscode.window.showErrorMessage(`B2C DX: ${e instanceof Error ? e.message : String(e)}`); + } +} + +/** + * Derive the ODS realm from a B2C Commerce hostname. + * e.g. "zzzz-005.test01.dx.unified.demandware.net" → "zzzz" + * "abcd-001.dx.commercecloud.salesforce.com" → "abcd" + */ +function deriveRealmFromHostname(hostname: string): string | undefined { + const trimmed = hostname.trim(); + if (!trimmed) return undefined; + const firstSegment = trimmed.split('.')[0] ?? ''; + const realm = firstSegment.split('-')[0]?.trim(); + if (!realm) return undefined; + // ODS realms are 4-character alphanumeric IDs. Defensive guard so we don't + // write a garbage value when the user types something unusual. + if (!/^[a-z0-9]{2,8}$/i.test(realm)) return undefined; + return realm.toLowerCase(); +} + +// ─── Step 2 — OAuth credentials ──────────────────────── +async function runOAuthStep(context: vscode.ExtensionContext): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a workspace folder first.'); + return; + } + const inst = await ensureActiveInstanceName(context, wsFolder.uri.fsPath); + if (!inst) return; + + const placementPicked = await vscode.window.showQuickPick(placementItems(defaultSecretPlacement()), { + title: `OAuth · ${inst} · where should client-id + client-secret live?`, + placeHolder: 'Both halves of the OAuth pair stay together (Credential Grouping rule).', + ignoreFocusOut: true, + }); + if (!placementPicked) return; + + const clientId = await secretInput({ + title: `OAuth · ${inst} · client-id`, + prompt: 'Paste your client-id (visible — it is an identifier).', + placeholder: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', + }); + if (clientId === undefined) return; + const clientSecret = await secretInput({ + title: `OAuth · ${inst} · client-secret`, + prompt: 'Paste your client-secret (input is masked).', + placeholder: '••••••••••••••••••••', + password: true, + }); + if (clientSecret === undefined) return; + + const {report, errors, terminalLines} = await applySecretPair( + inst, + 'oauth', + placementPicked.id, + {clientId, clientSecret}, + wsFolder.uri.fsPath, + ); + flushTerminal(inst, terminalLines); + const summary = report.length ? report.map((l) => ` • ${l}`).join('\n') : ' (none)'; + const errSummary = errors.length ? '\n\nErrors:\n' + errors.map((e) => ` • ${e}`).join('\n') : ''; + await offerInspectFollowUp(`OAuth credentials applied for ${inst}.\n\nApplied:\n${summary}${errSummary}`); +} + +// ─── Step 3 — WebDAV credentials (Basic auth) ────────── +async function runWebDavStep(context: vscode.ExtensionContext): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a workspace folder first.'); + return; + } + const inst = await ensureActiveInstanceName(context, wsFolder.uri.fsPath); + if (!inst) return; + + const placementPicked = await vscode.window.showQuickPick(placementItems(defaultSecretPlacement()), { + title: `WebDAV · ${inst} · where should username + password live?`, + placeHolder: 'Both halves of the Basic pair stay together (Credential Grouping rule).', + ignoreFocusOut: true, + }); + if (!placementPicked) return; + + const username = await secretInput({ + title: `WebDAV · ${inst} · username`, + prompt: 'Your Business Manager username.', + placeholder: 'you@example.com', + }); + if (username === undefined) return; + const password = await secretInput({ + title: `WebDAV · ${inst} · access key (password)`, + prompt: 'Paste your WebDAV access key (input is masked).', + placeholder: '••••••••••••••••••••', + password: true, + }); + if (password === undefined) return; + + const {report, errors, terminalLines} = await applySecretPair( + inst, + 'basic', + placementPicked.id, + {username, password}, + wsFolder.uri.fsPath, + ); + flushTerminal(inst, terminalLines); + const summary = report.length ? report.map((l) => ` • ${l}`).join('\n') : ' (none)'; + const errSummary = errors.length ? '\n\nErrors:\n' + errors.map((e) => ` • ${e}`).join('\n') : ''; + await offerInspectFollowUp(`WebDAV credentials applied for ${inst}.\n\nApplied:\n${summary}${errSummary}`); +} + +// ─── Step 4 — SCAPI extras ───────────────────────────── +async function runScapiStep(context: vscode.ExtensionContext): Promise { + const wsFolder = vscode.workspace.workspaceFolders?.[0]; + if (!wsFolder) { + vscode.window.showErrorMessage('B2C DX: Open a workspace folder first.'); + return; + } + const inst = await ensureActiveInstanceName(context, wsFolder.uri.fsPath); + if (!inst) return; + + const shortCode = await vscode.window.showInputBox({ + title: `SCAPI · ${inst} · short-code`, + prompt: 'Your organisation short code (from Account Manager)', + placeHolder: 'kv7kzm78', + ignoreFocusOut: true, + }); + if (shortCode === undefined) return; + const tenantId = await vscode.window.showInputBox({ + title: `SCAPI · ${inst} · tenant-id`, + prompt: 'Your tenant ID', + placeHolder: 'zzrf_001', + ignoreFocusOut: true, + }); + if (tenantId === undefined) return; + const oauthScopes = await vscode.window.showInputBox({ + title: `SCAPI · ${inst} · oauth-scopes (optional)`, + prompt: + 'Space- or comma-separated scopes the AM client is authorized to grant. ' + + 'Leave blank if your AM client uses default scopes — pinning shopper-* scopes ' + + 'will break Sandbox Explorer if the same client is not registered for them.', + placeHolder: 'e.g. sfcc.products sfcc.catalogs (leave blank to use AM defaults)', + ignoreFocusOut: true, + }); + + try { + const {doc, entry} = await readOrCreateConfigEntry(wsFolder.uri.fsPath, inst); + if (shortCode) entry['short-code'] = shortCode; + if (tenantId) entry['tenant-id'] = tenantId; + // Persist oauth-scopes as a string[] — the SDK / Sandbox Explorer expects + // an array; the older space-delimited string form trips `scopes.sort()`. + // Accept either delimiter from the user. + if (oauthScopes && oauthScopes.trim().length > 0) { + const scopes = oauthScopes + .split(/[\s,]+/) + .map((s) => s.trim()) + .filter(Boolean); + if (scopes.length > 0) entry['oauth-scopes'] = scopes; + } + await writeConfigDoc(wsFolder.uri.fsPath, doc); + await offerInspectFollowUp(`SCAPI fields saved to dw.json (${inst}).`); + } catch (e) { + vscode.window.showErrorMessage(`B2C DX: ${e instanceof Error ? e.message : String(e)}`); + } +} diff --git a/packages/b2c-vs-extension/src/walkthrough/index.ts b/packages/b2c-vs-extension/src/walkthrough/index.ts new file mode 100644 index 000000000..b455ac031 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/index.ts @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +export { + registerWalkthroughCommands, + resetWorkspaceOnboardingIfFresh, + showWalkthroughOnFirstActivation, +} from './commands.js'; +export {initializeTelemetry, getTelemetry} from './telemetry.js'; +export { + validateWalkthroughAccessibility, + formatAccessibilityReport, + checkWalkthroughAccessibilityCommand, +} from './accessibility.js'; +export {validateWalkthroughConfiguration, formatValidationResult, validateWalkthroughCommand} from './validator.js'; +export {OnboardingStateStore} from './state.js'; +export {OnboardingPanel} from './onboardingPanel.js'; +export {PERSONAS, listPersonas, resolveSteps, STEP_CATALOG} from './personas.js'; +export type {PersonaId, PersonaDefinition, StepDefinition, StepAction} from './personas.js'; +export {detectTools, generateInstallCliHtml} from './toolDetection.js'; +export type {ToolDetectionResult, ToolStatus} from './toolDetection.js'; +export {detectStepConfigurations, getDetectionForStep} from './stepDetection.js'; +export type {DetectionSummary, StepDetection} from './stepDetection.js'; diff --git a/packages/b2c-vs-extension/src/walkthrough/markdown.ts b/packages/b2c-vs-extension/src/walkthrough/markdown.ts new file mode 100644 index 000000000..f75259ca7 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/markdown.ts @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +/** + * Minimal, trust-the-source markdown renderer for our own walkthrough content. + * Handles the subset used by media/walkthrough/*.md: headings, paragraphs, lists + * (ordered + unordered, including nested), fenced code, inline code, emphasis, + * bold, links, and horizontal rules. Escapes all raw HTML — we never embed + * user-authored content here, but defense in depth. + * + * We avoid adding `marked` / `markdown-it` to the extension bundle for a + * ~30KB saving; the rule set below covers every construct present in the + * existing nine walkthrough pages. + */ + +const HTML_ESCAPE: Record = { + '&': '&', + '<': '<', + '>': '>', + '"': '"', + "'": ''', +}; + +function escapeHtml(text: string): string { + return text.replace(/[&<>"']/g, (c) => HTML_ESCAPE[c] ?? c); +} + +function renderInline(text: string): string { + let out = escapeHtml(text); + // Inline code: `foo` + out = out.replace(/`([^`]+)`/g, (_, code) => `${code}`); + // Links: [label](url) + out = out.replace(/\[([^\]]+)\]\(([^)\s]+)\)/g, (_, label, url) => { + const safeUrl = /^(https?:|mailto:|command:|#)/i.test(url) ? url : '#'; + return `${label}`; + }); + // Bold: **foo** or __foo__ + out = out.replace(/\*\*([^*]+)\*\*/g, '$1'); + out = out.replace(/__([^_]+)__/g, '$1'); + // Emphasis: *foo* or _foo_ + out = out.replace(/(^|[^*])\*([^*\n]+)\*/g, '$1$2'); + out = out.replace(/(^|[^_])_([^_\n]+)_/g, '$1$2'); + return out; +} + +interface ListState { + ordered: boolean; + indent: number; + items: string[]; +} + +export function renderMarkdown(input: string): string { + const lines = input.replace(/\r\n/g, '\n').split('\n'); + const out: string[] = []; + const listStack: ListState[] = []; + let paragraph: string[] = []; + let inCodeBlock = false; + let codeLang = ''; + let codeBuffer: string[] = []; + + const flushParagraph = () => { + if (paragraph.length === 0) return; + out.push(`

${renderInline(paragraph.join(' '))}

`); + paragraph = []; + }; + + const closeListsTo = (indent: number) => { + while (listStack.length > 0 && listStack[listStack.length - 1].indent >= indent) { + const list = listStack.pop()!; + const tag = list.ordered ? 'ol' : 'ul'; + out.push(`<${tag}>${list.items.map((i) => `
  • ${i}
  • `).join('')}`); + } + }; + + for (const rawLine of lines) { + const line = rawLine.replace(/\t/g, ' '); + + // Fenced code blocks. When consecutive code blocks are separated only + // by blank lines (the renderer's blank-line rule fires between them), + // we merge them into a single
     with newline separators so they
    +    // render as a tight stanza — no per-block padding stacking.
    +    const fence = line.match(/^```(\w*)\s*$/);
    +    if (fence) {
    +      if (inCodeBlock) {
    +        const html = `
    ${escapeHtml(
    +          codeBuffer.join('\n'),
    +        )}
    `; + // If the previous emission was a
     (i.e. nothing in between but
    +        // whitespace-driven flushParagraph/closeListsTo no-ops), merge the
    +        // two into one block by stripping the closing tag of the previous
    +        // and the opening tag of the new one.
    +        const last = out[out.length - 1];
    +        if (last && last.startsWith('
    ') && last.endsWith('
    ')) { + // Reuse the previous
    's opening; concatenate inner content
    +          // separated by a blank-line so commands stay readable.
    +          const merged =
    +            last.slice(0, last.length - '
    '.length) + + '\n' + + escapeHtml(codeBuffer.join('\n')) + + '
    '; + out[out.length - 1] = merged; + } else { + out.push(html); + } + inCodeBlock = false; + codeBuffer = []; + codeLang = ''; + } else { + flushParagraph(); + closeListsTo(0); + inCodeBlock = true; + codeLang = fence[1] ?? ''; + } + continue; + } + if (inCodeBlock) { + codeBuffer.push(line); + continue; + } + + // Blank line ends paragraph and any open lists at deeper indents than 0 + if (/^\s*$/.test(line)) { + flushParagraph(); + closeListsTo(0); + continue; + } + + // Horizontal rule + if (/^\s*(---|\*\*\*|___)\s*$/.test(line)) { + flushParagraph(); + closeListsTo(0); + out.push('
    '); + continue; + } + + // Heading + const heading = line.match(/^(#{1,6})\s+(.*)$/); + if (heading) { + flushParagraph(); + closeListsTo(0); + const level = heading[1].length; + out.push(`${renderInline(heading[2].trim())}`); + continue; + } + + // List item (unordered or ordered) + const listItem = line.match(/^(\s*)([-*+]|\d+\.)\s+(.*)$/); + if (listItem) { + flushParagraph(); + const indent = listItem[1].length; + const ordered = /^\d+\./.test(listItem[2]); + const content = renderInline(listItem[3]); + + // Close lists deeper than current indent + while (listStack.length > 0 && listStack[listStack.length - 1].indent > indent) { + const list = listStack.pop()!; + const tag = list.ordered ? 'ol' : 'ul'; + const html = `<${tag}>${list.items.map((i) => `
  • ${i}
  • `).join('')}`; + const parent = listStack[listStack.length - 1]; + if (parent) { + parent.items[parent.items.length - 1] += html; + } else { + out.push(html); + } + } + + const top = listStack[listStack.length - 1]; + if (top && top.indent === indent && top.ordered === ordered) { + top.items.push(content); + } else { + if (top && top.indent === indent && top.ordered !== ordered) { + // Same indent, different type — close the old one. + const list = listStack.pop()!; + const tag = list.ordered ? 'ol' : 'ul'; + const html = `<${tag}>${list.items.map((i) => `
  • ${i}
  • `).join('')}`; + const parent = listStack[listStack.length - 1]; + if (parent) parent.items[parent.items.length - 1] += html; + else out.push(html); + } + listStack.push({ordered, indent, items: [content]}); + } + continue; + } + + // Paragraph line + closeListsTo(0); + paragraph.push(line.trim()); + } + + flushParagraph(); + closeListsTo(0); + if (inCodeBlock) { + out.push(`
    ${escapeHtml(codeBuffer.join('\n'))}
    `); + } + return out.join('\n'); +} diff --git a/packages/b2c-vs-extension/src/walkthrough/onboardingPanel.ts b/packages/b2c-vs-extension/src/walkthrough/onboardingPanel.ts new file mode 100644 index 000000000..633f18727 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/onboardingPanel.ts @@ -0,0 +1,2500 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as vscode from 'vscode'; +import * as path from 'path'; +import * as fs from 'fs/promises'; + +import {OnboardingStateStore, StepStatus} from './state.js'; +import {PERSONAS, PersonaId, StepAction, StepDefinition, getPersona, listPersonas, resolveSteps} from './personas.js'; +import {renderMarkdown} from './markdown.js'; +import {detectTools, generateInstallCliHtml, ToolDetectionResult} from './toolDetection.js'; +import {detectAllTargets, generateAiSkillsHtml} from './aiSkillsContent.js'; +import { + detectStepConfigurations, + getDetectionForStep, + readDeployContext, + DetectionSummary, + StepDetection, +} from './stepDetection.js'; +import {findCartridges, listCodeVersions, type CodeVersion} from '@salesforce/b2c-tooling-sdk/operations/code'; +import type {B2CExtensionConfig} from '../config-provider.js'; + +type InboundMessage = + | {type: 'selectPersona'; personaId: PersonaId} + | {type: 'changePersona'} + | {type: 'openStep'; stepId: string} + | {type: 'completeStep'; stepId: string} + | {type: 'skipStep'; stepId: string} + | {type: 'goNext'} + | {type: 'goPrev'} + | {type: 'runAction'; command: string; args?: unknown[]; stepId?: string} + | {type: 'openLink'; url: string} + | {type: 'reset'} + | {type: 'ready'} + | {type: 'aiSkills.installSkills'; ide: string} + | {type: 'aiSkills.runCommand'; cmd: string; label: string} + | {type: 'aiSkills.recheck'}; + +interface PersonaView { + id: PersonaId; + label: string; + tagline: string; + description: string; + stepCount: number; + estimatedMinutes: number; + recommended?: boolean; +} + +interface StepView { + id: string; + title: string; + summary: string; + status: StepStatus; + actions: StepAction[]; + html: string; + /** Optional per-step detection chip ("1 configuration detected"). */ + detection?: {label: string; matchedNames: string[]} | null; +} + +interface ViewState { + persona: PersonaView | null; + personas: PersonaView[]; + steps: StepView[]; + activeStepId: string | null; + setupInstance: string | null; +} + +type DeployedCartridgesResult = + | {kind: 'ok'; names: string[]; source: 'ocapi' | 'webdav'} + | {kind: 'no-provider'} + | {kind: 'no-instance'; reason?: string} + | {kind: 'no-code-version'} + | {kind: 'error'; reason: string}; + +export class OnboardingPanel { + private static current: OnboardingPanel | undefined; + + static show( + context: vscode.ExtensionContext, + store: OnboardingStateStore, + log: vscode.OutputChannel, + getConfigProvider?: () => B2CExtensionConfig | null, + ): void { + if (OnboardingPanel.current) { + OnboardingPanel.current.panel.reveal(); + return; + } + const panel = vscode.window.createWebviewPanel('b2c-dx.onboarding', 'B2C DX: Get Started', vscode.ViewColumn.One, { + enableScripts: true, + retainContextWhenHidden: true, + localResourceRoots: [vscode.Uri.file(context.extensionPath)], + }); + OnboardingPanel.current = new OnboardingPanel(context, store, log, panel, getConfigProvider); + } + + private readonly disposables: vscode.Disposable[] = []; + private activeStepId: string | null = null; + + private constructor( + private readonly context: vscode.ExtensionContext, + private readonly store: OnboardingStateStore, + private readonly log: vscode.OutputChannel, + private readonly panel: vscode.WebviewPanel, + private readonly getConfigProvider?: () => B2CExtensionConfig | null, + ) { + this.panel.webview.html = this.renderShell(); + this.disposables.push( + this.panel.onDidDispose(() => this.dispose()), + this.panel.webview.onDidReceiveMessage((msg) => this.handleMessage(msg as InboundMessage)), + this.store.onDidChange(() => void this.refresh()), + // Re-check whenever the user returns to the panel — covers the case where + // they ran an install in the terminal and switched back. + this.panel.onDidChangeViewState((e) => { + if (e.webviewPanel.active) { + if (this.activeStepId === 'ai-skills') { + this.aiSkillsCache = null; + } + void this.refresh(); + } + }), + ); + } + + /** Cached AI-skills detection result, invalidated on install actions. */ + private aiSkillsCache: import('./aiSkillsContent.js').DetectedTarget[] | null = null; + /** Tracks the in-flight watcher so multiple installs don't stack. */ + private aiSkillsWatcher: NodeJS.Timeout | null = null; + /** Disposables for terminal-shell-execution and close listeners on the in-flight install. */ + private aiSkillsTermDisposables: vscode.Disposable[] = []; + + /** + * Subscribes to terminal events for the install terminal so we can + * deterministically refresh as soon as the install command exits — much + * more responsive than polling. + */ + private watchTerminalForAiSkills(terminal: vscode.Terminal): void { + // Clear any previous subscriptions; only one in-flight install at a time. + this.aiSkillsTermDisposables.forEach((d) => d.dispose()); + this.aiSkillsTermDisposables = []; + + // Stronger signal: shell-execution end (proposed but stable in 1.93+). + // Falls back silently on older runtimes via try/catch. + try { + const api = vscode.window as unknown as { + onDidEndTerminalShellExecution?: (listener: (e: {terminal: vscode.Terminal}) => void) => vscode.Disposable; + }; + if (typeof api.onDidEndTerminalShellExecution === 'function') { + const sub = api.onDidEndTerminalShellExecution((e) => { + if (e.terminal === terminal) { + this.aiSkillsCache = null; + void this.refresh(); + } + }); + this.aiSkillsTermDisposables.push(sub); + } + } catch { + // ignore + } + + // Fallback: when the user closes the terminal, refresh. + const closeSub = vscode.window.onDidCloseTerminal((closed) => { + if (closed === terminal) { + this.aiSkillsCache = null; + void this.refresh(); + this.aiSkillsTermDisposables.forEach((d) => d.dispose()); + this.aiSkillsTermDisposables = []; + } + }); + this.aiSkillsTermDisposables.push(closeSub); + } + + /** + * After kicking off an install in the terminal we don't get a deterministic + * completion signal, so we poll the filesystem every 2s for up to ~60s. + * As soon as detection produces a different snapshot we refresh and stop. + */ + private startAiSkillsWatcher(): void { + if (this.aiSkillsWatcher) clearInterval(this.aiSkillsWatcher); + const before = JSON.stringify(this.aiSkillsCache?.map((t) => ({id: t.id, status: t.status})) ?? []); + let elapsed = 0; + const TICK_MS = 2000; + const MAX_MS = 60000; + this.aiSkillsWatcher = setInterval(async () => { + elapsed += TICK_MS; + try { + const {detectAllTargets} = await import('./aiSkillsContent.js'); + const fresh = await detectAllTargets(); + const snapshot = JSON.stringify(fresh.map((t) => ({id: t.id, status: t.status}))); + if (snapshot !== before) { + this.aiSkillsCache = fresh; + if (this.aiSkillsWatcher) { + clearInterval(this.aiSkillsWatcher); + this.aiSkillsWatcher = null; + } + await this.refresh(); + return; + } + } catch { + // best-effort — keep polling + } + if (elapsed >= MAX_MS && this.aiSkillsWatcher) { + clearInterval(this.aiSkillsWatcher); + this.aiSkillsWatcher = null; + } + }, TICK_MS); + } + + private async handleMessage(msg: InboundMessage): Promise { + try { + switch (msg.type) { + case 'ready': + await this.refresh(); + return; + case 'selectPersona': + await this.store.setPersona(msg.personaId); + this.activeStepId = PERSONAS[msg.personaId]?.stepIds[0] ?? null; + await this.refresh(); + return; + case 'changePersona': + await this.store.setPersona(null); + this.activeStepId = null; + await this.refresh(); + return; + case 'openStep': { + const persona = this.store.getPersona(); + if (!persona) return; + // Ignore clicks on locked steps: the user must complete predecessors. + const view = await this.buildViewState(); + const target = view.steps.find((s) => s.id === msg.stepId); + if (!target || target.status === 'locked') return; + this.activeStepId = msg.stepId; + await this.store.markStarted(persona, msg.stepId); + await this.refresh(); + return; + } + case 'completeStep': { + const persona = this.store.getPersona(); + if (!persona) return; + await this.store.markCompleted(persona, msg.stepId); + return; + } + case 'skipStep': { + const persona = this.store.getPersona(); + if (!persona) return; + await this.store.markSkipped(persona, msg.stepId); + return; + } + case 'runAction': { + const persona = this.store.getPersona(); + if (persona && msg.stepId) { + await this.store.markStarted(persona, msg.stepId); + } + await vscode.commands.executeCommand(msg.command, ...(msg.args ?? [])); + // Setup commands mutate workspaceState; ensure the chip + Start Over + // button re-render once the action returns. + if (typeof msg.command === 'string' && msg.command.startsWith('b2c-dx.setup.')) { + await this.refresh(); + } + // CLI actions (install, recheck) should re-detect tools and refresh. + if (typeof msg.command === 'string' && msg.command.startsWith('b2c-dx.cli.')) { + this.invalidateToolDetection(); + await this.refresh(); + } + return; + } + case 'openLink': { + // All markdown link clicks route through here. Safely dispatch + // command: URIs and open http(s) externally; ignore anything else. + const url = msg.url; + if (url.startsWith('command:')) { + const rest = url.slice('command:'.length); + const qIdx = rest.indexOf('?'); + const commandId = qIdx >= 0 ? rest.slice(0, qIdx) : rest; + let args: unknown[] = []; + if (qIdx >= 0) { + try { + const parsed = JSON.parse(decodeURIComponent(rest.slice(qIdx + 1))); + args = Array.isArray(parsed) ? parsed : [parsed]; + } catch { + args = []; + } + } + await vscode.commands.executeCommand(commandId, ...args); + } else if (/^https?:/i.test(url) || url.startsWith('mailto:')) { + await vscode.env.openExternal(vscode.Uri.parse(url)); + } + return; + } + case 'goNext': { + const persona = this.store.getPersona(); + if (!persona) return; + const steps = resolveSteps(persona as PersonaId); + const currentIdx = steps.findIndex((s) => s.id === this.activeStepId); + if (currentIdx >= 0) { + await this.store.markCompleted(persona, steps[currentIdx].id); + } + const next = steps[currentIdx + 1]; + if (next) { + this.activeStepId = next.id; + await this.store.markStarted(persona, next.id); + } + await this.refresh(); + return; + } + case 'goPrev': { + const persona = this.store.getPersona(); + if (!persona) return; + const steps = resolveSteps(persona as PersonaId); + const currentIdx = steps.findIndex((s) => s.id === this.activeStepId); + const prev = currentIdx > 0 ? steps[currentIdx - 1] : null; + if (prev) { + this.activeStepId = prev.id; + await this.refresh(); + } + return; + } + case 'reset': + await this.store.reset(); + this.activeStepId = null; + await this.refresh(); + return; + case 'aiSkills.installSkills': { + // Open a terminal preloaded with `b2c setup skills b2c --ide `. + // We don't auto-run — the user reviews it and presses Enter. + const ide = msg.ide.replace(/[^a-z0-9-]/gi, ''); + if (!ide) return; + const term = vscode.window.createTerminal({name: `B2C DX — Skills (${ide})`}); + term.show(); + term.sendText(`b2c setup skills b2c --ide ${ide}`, false); + this.watchTerminalForAiSkills(term); + this.startAiSkillsWatcher(); + return; + } + case 'aiSkills.runCommand': { + const safeLabel = msg.label.replace(/[^\w\s—()-]/g, '').slice(0, 40) || 'Install'; + const term = vscode.window.createTerminal({name: `B2C DX — ${safeLabel}`}); + term.show(); + term.sendText(msg.cmd, false); + this.watchTerminalForAiSkills(term); + this.startAiSkillsWatcher(); + return; + } + case 'aiSkills.recheck': { + this.aiSkillsCache = null; + await this.refresh(); + return; + } + } + } catch (err) { + const message = err instanceof Error ? err.message : String(err); + this.log.appendLine(`[onboarding] handleMessage(${msg.type}) failed: ${message}`); + vscode.window.showErrorMessage(`Onboarding: ${message}`); + } + } + + private async refresh(): Promise { + const view = await this.buildViewState(); + if (view.persona) { + const active = view.steps.find((s) => s.id === this.activeStepId); + // If no active step, or the active one is now locked (shouldn't happen + // but defend against it), pick the first step the user can work on. + if (!active || active.status === 'locked') { + const pick = + view.steps.find((s) => s.status === 'in-progress') ?? + view.steps.find((s) => s.status === 'available') ?? + view.steps[0]; + this.activeStepId = pick?.id ?? null; + } + } + this.panel.webview.postMessage({type: 'state', state: {...view, activeStepId: this.activeStepId}}); + } + + private async buildViewState(): Promise { + // Per-persona time estimates (minutes). Tuned from real walkthrough runs; + // these override the previous step-count × 3.5 formula which over-counted + // assistive UI steps (welcome, next-steps) that take seconds, not minutes. + const PERSONA_MINUTES: Record = { + storefront: 8, + 'api-integration': 10, + 'devops-release': 6, + 'ai-augmented': 12, + }; + const estimateMinutes = (id: string, stepCount: number): number => + PERSONA_MINUTES[id] ?? Math.max(5, Math.round((stepCount * 1.25) / 1) * 1); + + // The "ai-augmented" persona gets a `recommended` flag so the gate + // highlights it as the new path. + const personas: PersonaView[] = listPersonas().map((p) => ({ + id: p.id, + label: p.label, + tagline: p.tagline, + description: p.description, + stepCount: p.stepIds.length, + estimatedMinutes: estimateMinutes(p.id, p.stepIds.length), + recommended: p.id === 'ai-augmented', + })); + const personaId = this.store.getPersona(); + const personaDef = getPersona(personaId); + const setupInstance = this.context.workspaceState.get('b2c-dx.setup.activeInstance') ?? null; + if (!personaDef) { + return {persona: null, personas, steps: [], activeStepId: null, setupInstance}; + } + const defs = resolveSteps(personaDef.id); + const workspaceRoot = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath; + const detectionSummary = await detectStepConfigurations(workspaceRoot); + const rawSteps = await Promise.all(defs.map((def) => this.buildStepView(personaDef.id, def, detectionSummary))); + // Sequential gating: a step is locked until every step before it is done + // or skipped. The first step is always available. + const steps = rawSteps.map((step, idx) => { + if (idx === 0) return step; + const allPriorResolved = rawSteps + .slice(0, idx) + .every((prior) => prior.status === 'done' || prior.status === 'skipped'); + if (!allPriorResolved && step.status !== 'done') { + return {...step, status: 'locked' as const}; + } + return step; + }); + const activePersonaView = personas.find((p) => p.id === personaDef.id) ?? { + id: personaDef.id, + label: personaDef.label, + tagline: personaDef.tagline, + description: personaDef.description, + stepCount: personaDef.stepIds.length, + estimatedMinutes: estimateMinutes(personaDef.id, personaDef.stepIds.length), + }; + return { + persona: activePersonaView, + personas, + steps, + activeStepId: this.activeStepId, + setupInstance, + }; + } + + private toolDetectionCache: ToolDetectionResult | null = null; + + private async buildStepView( + personaId: PersonaId, + def: StepDefinition, + detectionSummary?: DetectionSummary, + ): Promise { + const record = this.store.getStep(personaId, def.id); + let html: string; + let actions = def.actions ?? []; + + if (def.id === 'install-cli') { + const result = await this.getToolDetection(); + html = generateInstallCliHtml(result); + actions = this.buildInstallCliActions(result); + } else if (def.id === 'ai-skills') { + if (!this.aiSkillsCache) { + this.aiSkillsCache = await detectAllTargets(); + } + html = generateAiSkillsHtml(this.aiSkillsCache); + } else { + const markdown = await this.readMarkdown(def.markdown); + html = renderMarkdown(markdown); + // For the deploy step, prepend a banner showing exactly what will be + // deployed when the user clicks "Deploy Recommended Cartridge", and + // gray out the primary action if the recommended cartridge is already + // present in the active code version. + if (def.id === 'deploy-code') { + const result = await this.buildDeployBanner(); + if (result) { + html = result.html + html; + if (result.alreadyDeployed && actions.length > 0) { + actions = actions.map((a) => + a.command === 'b2c-dx.codeSync.deployOne' + ? { + ...a, + label: `Already Deployed${result.cartridgeName ? ` · ${result.cartridgeName}` : ''}`, + disabled: true, + tooltip: 'This cartridge is already in the active code version.', + } + : a, + ); + } + } + } + } + + let detection: StepView['detection'] = null; + if (detectionSummary) { + const found: StepDetection | null = getDetectionForStep(def.id, detectionSummary); + if (found && found.matchCount > 0 && found.label) { + detection = {label: found.label, matchedNames: found.matchedNames ?? []}; + } + } + + return { + id: def.id, + title: def.title, + summary: def.summary, + status: record?.status ?? 'available', + actions, + html, + detection, + }; + } + + /** Cached list of deployed cartridges per code-version, keyed by `host|version`. */ + private deployedCartridgesCache = new Map(); + + /** + * Fetch the cartridges currently deployed to the active code version. + * Tries OCAPI `/code_versions` first (richer data) and falls back to a + * WebDAV PROPFIND on `Cartridges//` (which is what the deploy + * command itself uses, so credentials are usually already set up). + * + * Returns a tagged result so the banner can show a specific reason instead + * of a generic "OAuth not configured" message. + * + * Cached for 30 seconds to avoid hammering the network on every refresh. + */ + private async fetchDeployedCartridges(codeVersion: string | undefined): Promise { + const provider = this.getConfigProvider?.(); + if (!provider) return {kind: 'no-provider'}; + const instance = provider.getInstance(); + if (!instance) { + const err = provider.getConfigError?.(); + return {kind: 'no-instance', reason: err ?? undefined}; + } + if (!codeVersion) return {kind: 'no-code-version'}; + + const host = provider.getConfig()?.values.hostname ?? 'unknown'; + const cacheKey = `${host}|${codeVersion}`; + const cached = this.deployedCartridgesCache.get(cacheKey); + if (cached && Date.now() - cached.fetchedAt < 30_000) return cached.result; + + let ocapiError: string | undefined; + + // 1) Try OCAPI — gives back the canonical list directly. + try { + const versions: CodeVersion[] = await listCodeVersions(instance); + const target = versions.find((v) => v.id === codeVersion); + if (target) { + const names = target.cartridges ?? []; + const result: DeployedCartridgesResult = {kind: 'ok', names, source: 'ocapi'}; + this.deployedCartridgesCache.set(cacheKey, {result, fetchedAt: Date.now()}); + return result; + } + ocapiError = `code version "${codeVersion}" not found on instance`; + } catch (err) { + ocapiError = err instanceof Error ? err.message : String(err); + this.log.appendLine(`[onboarding] OCAPI listCodeVersions failed: ${ocapiError}`); + } + + // 2) Fallback to WebDAV — same auth path as the deploy command itself. + try { + const entries = await instance.webdav.propfind(`Cartridges/${codeVersion}`, '1'); + const names = entries + .filter((e) => e.isCollection && e.displayName && e.displayName !== codeVersion) + .map((e) => e.displayName as string); + const result: DeployedCartridgesResult = {kind: 'ok', names, source: 'webdav'}; + this.deployedCartridgesCache.set(cacheKey, {result, fetchedAt: Date.now()}); + return result; + } catch (err) { + const webdavError = err instanceof Error ? err.message : String(err); + this.log.appendLine(`[onboarding] WebDAV propfind failed: ${webdavError}`); + return {kind: 'error', reason: ocapiError ?? webdavError}; + } + } + + /** + * Builds a "what will be deployed" + "already deployed" banner for the + * deploy-code step. Returns the HTML plus a flag indicating whether the + * recommended cartridge is already in the active code version (so the + * caller can disable the primary action). + */ + private async buildDeployBanner(): Promise<{html: string; alreadyDeployed: boolean; cartridgeName?: string} | null> { + const workspaceRoot = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath; + const ctx = await readDeployContext(workspaceRoot); + const lastScaffolded = this.context.workspaceState.get('b2c-dx.scaffold.lastCartridgeName'); + + // Mirror the resolution logic in createDeployOneCommand: + // 1. If the last-scaffolded cartridge still exists in the workspace, use it. + // 2. Otherwise, if there's only one cartridge, that's what gets deployed. + // 3. Otherwise the user is shown a picker (we can't predict the choice). + let resolvedCartridge: string | undefined; + let cartridgeSource: 'scaffolded' | 'only' | 'picker' | 'none' = 'none'; + if (workspaceRoot) { + try { + const cartridges = findCartridges(workspaceRoot); + if (lastScaffolded && cartridges.some((c) => c.name === lastScaffolded)) { + resolvedCartridge = lastScaffolded; + cartridgeSource = 'scaffolded'; + } else if (cartridges.length === 1) { + resolvedCartridge = cartridges[0].name; + cartridgeSource = 'only'; + } else if (cartridges.length > 1) { + cartridgeSource = 'picker'; + } + } catch { + // best-effort — leave as 'none' + } + } + + // Nothing to show if every field is empty. + if (!resolvedCartridge && cartridgeSource === 'none' && !ctx.hostname && !ctx.codeVersion) return null; + + const escape = (s: string) => + s.replace(/[&<>"']/g, (c) => + c === '&' ? '&' : c === '<' ? '<' : c === '>' ? '>' : c === '"' ? '"' : ''', + ); + const fmt = (v?: string) => + v ? `${escape(v)}` : `not set`; + + const sourceHint = + cartridgeSource === 'scaffolded' + ? 'recently scaffolded' + : cartridgeSource === 'only' + ? 'only cartridge in workspace' + : ''; + const cartridgeLabel = resolvedCartridge + ? `${escape(resolvedCartridge)} ${sourceHint}` + : cartridgeSource === 'picker' + ? `multiple found — you'll be asked to pick one` + : `no cartridges found in workspace`; + + const cartridgeReady = !!resolvedCartridge; + const allReady = cartridgeReady && !!ctx.codeVersion && !!ctx.hostname; + + // Fetch deployed cartridges (best-effort — falls back gracefully). + const deployedResult = await this.fetchDeployedCartridges(ctx.codeVersion); + const deployedNames = deployedResult.kind === 'ok' ? deployedResult.names : []; + const alreadyDeployed = !!(resolvedCartridge && deployedNames.includes(resolvedCartridge)); + + const deployedSection = (() => { + const folderIcon = ``; + const warnIcon = ``; + + if (deployedResult.kind === 'no-provider') { + return `
    + ${warnIcon} + Deployed + + resolving connection… + +
    `; + } + if (deployedResult.kind === 'no-instance') { + const detail = deployedResult.reason ? ` — ${escape(deployedResult.reason)}` : ''; + return `
    + ${warnIcon} + Deployed + + no active B2C instance${detail} + +
    `; + } + if (deployedResult.kind === 'no-code-version') { + return `
    + ${warnIcon} + Deployed + + code-version not set in dw.json + +
    `; + } + if (deployedResult.kind === 'error') { + return `
    + ${warnIcon} + Deployed + + unable to query — ${escape(deployedResult.reason)} + +
    `; + } + const names = deployedResult.names; + if (names.length === 0) { + return `
    + ${folderIcon} + Deployed + + no cartridges deployed yet + +
    `; + } + const chips = names + .map( + (n) => + `${escape(n)}`, + ) + .join(''); + return `
    + ${folderIcon} + Deployed ${names.length} + ${chips} +
    `; + })(); + + const html = ` +
    +
    + + + On click of "Deploy Recommended Cartridge" + + + + ${alreadyDeployed ? 'Already deployed' : allReady ? 'Ready to deploy' : 'Missing details'} + +
    +
    +
    + + Cartridge + ${cartridgeLabel} +
    +
    + + Code version + ${fmt(ctx.codeVersion)} +
    +
    + + Target host + ${fmt(ctx.hostname)} +
    + ${deployedSection} +
    +
    `; + + return {html, alreadyDeployed, cartridgeName: resolvedCartridge}; + } + + private async getToolDetection(): Promise { + if (!this.toolDetectionCache) { + const cached = this.context.globalState.get<{version: string; fetchedAt: number}>( + 'b2c-dx.cli.latestVersionCache', + ); + const latestVersion = cached?.version; + this.toolDetectionCache = await detectTools(latestVersion); + } + return this.toolDetectionCache; + } + + /** Invalidates cached detection so the next refresh re-detects. */ + invalidateToolDetection(): void { + this.toolDetectionCache = null; + } + + private buildInstallCliActions(result: ToolDetectionResult): StepAction[] { + const actions: StepAction[] = []; + + if (!result.b2cCli.installed) { + if (result.npm.installed) { + actions.push({label: 'Install via npm', command: 'b2c-dx.cli.installNpm', primary: true}); + } else if (result.homebrew.installed) { + actions.push({label: 'Install via Homebrew', command: 'b2c-dx.cli.installBrew', primary: true}); + } + actions.push({label: 'Verify CLI', command: 'b2c-dx.cli.verify'}); + actions.push({label: 'Re-check', command: 'b2c-dx.cli.recheck'}); + } else if (result.b2cCliOutdated) { + actions.push({label: 'Update CLI', command: 'b2c-dx.cli.update', primary: true}); + actions.push({label: 'Verify CLI', command: 'b2c-dx.cli.verify'}); + actions.push({label: 'Re-check', command: 'b2c-dx.cli.recheck'}); + } else { + actions.push({label: 'Verify CLI', command: 'b2c-dx.cli.verify', primary: true}); + actions.push({label: 'Update CLI', command: 'b2c-dx.cli.update'}); + actions.push({label: 'Re-check', command: 'b2c-dx.cli.recheck'}); + } + + return actions; + } + + private async readMarkdown(relativePath: string): Promise { + try { + const abs = path.join(this.context.extensionPath, relativePath); + return await fs.readFile(abs, 'utf-8'); + } catch (err) { + const message = err instanceof Error ? err.message : String(err); + this.log.appendLine(`[onboarding] failed to read ${relativePath}: ${message}`); + return `# Content unavailable\n\n\`${relativePath}\` could not be loaded.`; + } + } + + private renderShell(): string { + const webview = this.panel.webview; + const nonce = makeNonce(); + const cspSource = webview.cspSource; + const csp = [ + `default-src 'none'`, + `img-src ${cspSource} https: data:`, + `style-src ${cspSource} 'unsafe-inline'`, + `script-src 'nonce-${nonce}'`, + `font-src ${cspSource}`, + ].join('; '); + + return /* html */ ` + + + + + B2C DX: Get Started + + + + + + + + + + + +`; + } + + dispose(): void { + OnboardingPanel.current = undefined; + if (this.aiSkillsWatcher) { + clearInterval(this.aiSkillsWatcher); + this.aiSkillsWatcher = null; + } + this.aiSkillsTermDisposables.forEach((d) => d.dispose()); + this.aiSkillsTermDisposables = []; + this.disposables.forEach((d) => d.dispose()); + this.panel.dispose(); + } +} + +function makeNonce(): string { + const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; + let out = ''; + for (let i = 0; i < 32; i++) out += chars.charAt(Math.floor(Math.random() * chars.length)); + return out; +} + +const PANEL_CSS = ` +:root { + color-scheme: light dark; + --radius-sm: 6px; + --radius-md: 10px; + --radius-lg: 14px; + --sidebar-width: 308px; + --content-max: 920px; + --brand-blue: #0176D3; + --brand-blue-deep: #014486; + --brand-blue-soft: rgba(1, 118, 211, 0.10); + --brand-blue-hairline: rgba(1, 118, 211, 0.28); + --brand-green: #1A8754; + --brand-green-bright: #2FA86A; + --brand-green-soft: rgba(26, 135, 84, 0.12); + --brand-green-hairline: rgba(26, 135, 84, 0.40); + /* Status palette for the sidebar checklist: + done = green, in-progress = amber/yellow, idle/locked/skipped = neutral grey. */ + --status-amber: #C77700; + --status-amber-bright: #E58A0F; + --status-amber-soft: rgba(199, 119, 0, 0.14); + --status-grey: rgba(127, 127, 127, 0.45); + --status-grey-soft: rgba(127, 127, 127, 0.18); + --surface-card: var(--vscode-editorWidget-background, var(--vscode-editor-background)); + --surface-elevated: var(--vscode-sideBar-background, var(--vscode-editor-background)); + --hairline: var(--vscode-panel-border, var(--vscode-editorGroup-border, rgba(128,128,128,0.25))); + --shadow-sm: 0 1px 2px rgba(0,0,0,0.06), 0 2px 8px rgba(0,0,0,0.04); + --shadow-md: 0 4px 14px rgba(0,0,0,0.08), 0 2px 6px rgba(0,0,0,0.04); +} +* { box-sizing: border-box; } +body { + margin: 0; + font-family: var(--vscode-font-family); + color: var(--vscode-foreground); + /* Layered page gradient: a soft brand-blue radial wash at the top-left, + plus a faint diagonal gradient that fades into the editor background. + Reads as a polished hero surface in light mode and stays subtle in dark + mode because the brand-blue tints sit at low alpha against any base. */ + background: + radial-gradient(ellipse 1200px 600px at 8% -10%, var(--brand-blue-soft), transparent 60%), + radial-gradient(ellipse 900px 500px at 110% 0%, rgba(26, 135, 84, 0.06), transparent 55%), + linear-gradient(180deg, var(--vscode-editor-background) 0%, var(--vscode-editor-background) 100%); + background-attachment: fixed; + padding: 0; + min-height: 100vh; +} +h1, h2, h3 { letter-spacing: -0.01em; } +.muted { color: var(--vscode-descriptionForeground); margin: 0; } +.eyebrow { + display: inline-block; + text-transform: uppercase; + letter-spacing: 0.12em; + font-size: 0.7rem; + font-weight: 600; + color: var(--brand-blue); + margin-bottom: 8px; +} + +/* ─── Brand bar ─────────────────────────────────────── */ +.brand-bar { + position: sticky; + top: 0; + z-index: 10; + display: flex; + align-items: center; + justify-content: space-between; + gap: 16px; + padding: 14px 32px; + /* Translucent so the body's soft page gradient shows through. */ + background: color-mix(in srgb, var(--vscode-editor-background) 80%, transparent); + border-bottom: 1px solid var(--hairline); + backdrop-filter: saturate(180%) blur(8px); +} +.brand { display: flex; align-items: center; gap: 14px; min-width: 0; } +.brand-mark { + font-family: 'Inter', 'SF Pro Display', 'Segoe UI Variable Display', 'Segoe UI', system-ui, -apple-system, sans-serif; + font-weight: 800; + font-size: 1.55rem; + letter-spacing: -0.02em; + line-height: 1; + white-space: nowrap; +} +.brand-mark__b2c { + color: var(--brand-blue); + background: linear-gradient(135deg, #1B96FF 0%, var(--brand-blue) 50%, var(--brand-blue-deep) 100%); + -webkit-background-clip: text; + background-clip: text; + -webkit-text-fill-color: transparent; + padding-right: 6px; +} +.brand-mark__dx { + color: var(--brand-blue); + font-style: italic; + font-weight: 700; + position: relative; +} +.brand-mark__dx::before { + content: "·"; + color: var(--brand-blue); + margin-right: 6px; + font-style: normal; + font-weight: 700; +} +.brand-divider { + width: 1px; + height: 22px; + background: var(--hairline); + margin: 0 4px; +} +.brand-tag { + font-size: 0.78rem; + font-weight: 500; + text-transform: uppercase; + letter-spacing: 0.14em; + color: var(--vscode-descriptionForeground); +} +/* Active-session chip — shown when a dw.json setup session has named an + instance for this workspace. Clicking it isn't required; users reach the + reset action via the adjacent "Start over" button. */ +.setup-chip { + display: inline-flex; + align-items: center; + gap: 8px; + margin-left: 12px; + padding: 4px 10px; + border-radius: 999px; + background: var(--brand-green-soft); + border: 1px solid var(--brand-green-hairline); + color: var(--brand-green); + font-size: 0.74rem; + font-weight: 600; + letter-spacing: 0.04em; +} +.setup-chip__dot { + width: 7px; + height: 7px; + border-radius: 50%; + background: var(--brand-green); + box-shadow: 0 0 0 2px color-mix(in srgb, var(--brand-green) 22%, transparent); +} +.brand-actions { display: flex; gap: 8px; flex-shrink: 0; align-items: center; } +button.icon-only { + width: 36px; + height: 36px; + padding: 0; + display: inline-grid; + place-items: center; + border-radius: 50%; +} +button.icon-only .theme-glyph { + font-size: 1.05rem; + line-height: 1; + display: inline-block; + transition: transform 200ms ease; +} +button.icon-only:hover .theme-glyph { transform: rotate(20deg); } +button { + background: var(--brand-blue); + color: #fff; + border: 1px solid transparent; + border-radius: var(--radius-sm); + padding: 7px 14px; + font: inherit; + font-weight: 500; + cursor: pointer; + transition: background 120ms ease, border-color 120ms ease, transform 80ms ease, box-shadow 120ms ease; +} +button:hover { background: var(--brand-blue-deep); } +button:active { transform: translateY(1px); } +button:focus-visible { + outline: 2px solid var(--brand-blue); + outline-offset: 2px; +} +button.ghost { + background: transparent; + color: var(--vscode-foreground); + border-color: var(--hairline); +} +button.ghost:hover { + background: var(--brand-blue-soft); + border-color: var(--brand-blue-hairline); + color: var(--brand-blue); +} +button.secondary { + background: var(--vscode-button-secondaryBackground, transparent); + color: var(--vscode-button-secondaryForeground, var(--vscode-foreground)); + border-color: var(--hairline); +} +button.secondary:hover { + background: var(--vscode-button-secondaryHoverBackground, var(--brand-blue-soft)); +} + +/* ─── Persona gate ─────────────────────────────────── */ +#persona-gate { + position: relative; + max-width: 1080px; + margin: 0 auto; + padding: 64px 40px 56px; +} + +/* Top-right corner: phase chip + concentric rings */ +.gate-corner { + position: absolute; + top: 56px; + right: 40px; + display: flex; + flex-direction: column; + align-items: flex-end; + gap: 18px; + pointer-events: none; + z-index: 1; +} +.phase-chip { + display: inline-flex; + align-items: center; + gap: 8px; + padding: 7px 14px; + border-radius: 999px; + background: var(--surface-card); + border: 1px solid var(--brand-blue-hairline); + font-size: 0.72rem; + font-weight: 700; + letter-spacing: 0.18em; + color: var(--vscode-foreground); +} +.phase-dot { + width: 8px; + height: 8px; + border-radius: 50%; + background: var(--brand-green); + box-shadow: 0 0 0 3px var(--brand-green-soft); +} +.gate-rings { + width: 160px; + height: 160px; + opacity: 0.55; +} +.gate-ring { stroke: var(--brand-blue-hairline); stroke-width: 1; } +.gate-ring.dashed { stroke-dasharray: 2 6; } + +.gate-hero { + position: relative; + z-index: 2; + text-align: center; + margin: 24px auto 32px; + max-width: 760px; +} +.gate-hero .eyebrow { + margin-bottom: 14px; +} +.gate-hero h1 { + font-family: 'Inter','SF Pro Display','Segoe UI Variable Display','Segoe UI',system-ui,-apple-system,sans-serif; + font-size: 3.25rem; + font-weight: 800; + letter-spacing: -0.035em; + line-height: 1.05; + margin: 0 0 16px; +} +.gate-hero .lede { + max-width: 640px; + margin: 0 auto; + font-size: 1.05rem; + line-height: 1.6; + color: var(--vscode-descriptionForeground); +} + +/* Stat strip — enterprise trust signal */ +.stat-strip { + display: grid; + grid-template-columns: 1fr auto 1fr auto 1fr auto 1fr; + align-items: center; + gap: 0; + margin: 0 auto 36px; + max-width: 720px; + padding: 22px 12px; + border-top: 1px solid var(--hairline); + border-bottom: 1px solid var(--hairline); +} +.stat { + display: flex; + flex-direction: column; + align-items: center; + gap: 4px; +} +.stat-value { + font-family: 'Inter','SF Pro Display','Segoe UI Variable Display','Segoe UI',system-ui,-apple-system,sans-serif; + font-size: 1.85rem; + font-weight: 800; + letter-spacing: -0.03em; + line-height: 1; + color: var(--vscode-foreground); +} +.stat-value small { + font-size: 0.55em; + font-weight: 700; + margin-left: 2px; + color: var(--vscode-descriptionForeground); +} +.stat-value.stat-check { color: var(--brand-green); } +.stat-label { + font-size: 0.7rem; + font-weight: 700; + letter-spacing: 0.18em; + text-transform: uppercase; + color: var(--vscode-descriptionForeground); +} +.stat-divider { + width: 1px; + height: 36px; + background: var(--hairline); +} +@media (max-width: 720px) { + .stat-strip { grid-template-columns: 1fr 1fr; gap: 18px 0; } + .stat-divider { display: none; } +} + +/* Role cards */ +.persona-grid { + display: grid; + grid-template-columns: repeat(2, 1fr); + gap: 20px; + margin-bottom: 32px; +} +@media (max-width: 720px) { .persona-grid { grid-template-columns: 1fr; } } +.persona-card { + position: relative; + color: var(--vscode-foreground); + background: var(--surface-card); + border: 1px solid var(--hairline); + border-radius: 16px; + padding: 24px 28px 64px; + display: grid; + grid-template-columns: 56px 1fr; + column-gap: 20px; + row-gap: 6px; + align-items: start; + cursor: pointer; + user-select: none; + overflow: hidden; + box-shadow: var(--shadow-sm); + transition: border-color 160ms ease, box-shadow 160ms ease, transform 160ms ease; +} +.persona-card::before { + content: ""; + position: absolute; + inset: 0; + background: linear-gradient(135deg, var(--brand-blue-soft) 0%, transparent 55%); + opacity: 0; + transition: opacity 160ms ease; + pointer-events: none; +} +.persona-card:hover { + border-color: var(--brand-blue-hairline); + box-shadow: var(--shadow-md); + transform: translateY(-2px); +} +.persona-card:hover::before { opacity: 1; } +.persona-card:hover .persona-arrow { transform: translateX(3px); } +.persona-card:focus-visible { + outline: 2px solid var(--brand-blue); + outline-offset: 3px; +} +.persona-card.is-recommended { + border-color: var(--brand-green-hairline); +} +.persona-card.is-recommended::before { + background: linear-gradient(135deg, var(--brand-green-soft) 0%, transparent 55%); +} +.persona-card.is-recommended:hover { border-color: var(--brand-green-hairline); } + +.persona-avatar { + grid-row: 1 / span 3; + width: 56px; + height: 56px; + border-radius: 14px; + background: linear-gradient(135deg, #1B96FF, var(--brand-blue) 60%, var(--brand-blue-deep)); + color: #fff; + display: grid; + place-items: center; + font-weight: 700; + font-size: 1.05rem; + letter-spacing: 0.02em; + box-shadow: 0 4px 12px rgba(1, 118, 211, 0.25); + position: relative; + z-index: 1; + flex-shrink: 0; +} +.persona-avatar svg { + width: 28px; + height: 28px; + color: #fff; +} +.persona-card.is-recommended .persona-avatar { + background: linear-gradient(135deg, var(--brand-green-bright), var(--brand-green)); + box-shadow: 0 4px 12px rgba(26, 135, 84, 0.30); +} +.persona-card h3 { + margin: 0; + font-size: 1.10rem; + font-weight: 700; + line-height: 1.3; + position: relative; + z-index: 1; +} +.persona-card .tagline { + color: var(--brand-blue); + font-size: 0.86rem; + font-weight: 500; + margin: 0; + line-height: 1.4; + position: relative; + z-index: 1; +} +.persona-card.is-recommended .tagline { color: var(--brand-green); } +.persona-card .desc { + color: var(--vscode-foreground); + opacity: 0.78; + font-size: 0.88rem; + line-height: 1.55; + margin: 10px 0 0; + grid-column: 2; + position: relative; + z-index: 1; +} +.persona-meta { + position: absolute; + left: 28px; + bottom: 26px; + font-size: 0.74rem; + font-weight: 700; + letter-spacing: 0.14em; + text-transform: uppercase; + color: var(--brand-green); + z-index: 1; +} +/* Scoped under .persona-card so we beat the generic button.ghost rules + (same fix that the gate-cta pill needed). The pill renders large and + bright so it reads as "the action" at a glance. */ +.persona-card .persona-arrow, +.persona-card span.persona-arrow { + position: absolute; + right: 20px; + bottom: 16px; + display: inline-flex; + align-items: center; + gap: 8px; + padding: 9px 18px; + border-radius: 999px; + background: var(--brand-blue); + color: #FFFFFF; + font-size: 0.84rem; + font-weight: 700; + letter-spacing: 0.06em; + text-transform: uppercase; + box-shadow: 0 6px 14px rgba(1, 118, 211, 0.32), 0 1px 2px rgba(1, 118, 211, 0.30); + transition: transform 160ms ease, box-shadow 160ms ease, background 160ms ease; + z-index: 2; + pointer-events: none; /* card receives the click */ +} +.persona-card .persona-arrow > span { color: #FFFFFF; } +.persona-card .persona-arrow svg { color: #FFFFFF; stroke: #FFFFFF; } +.persona-card:hover .persona-arrow { + transform: translateX(4px); + box-shadow: 0 8px 18px rgba(1, 118, 211, 0.42), 0 1px 2px rgba(1, 118, 211, 0.30); +} +.persona-card.is-recommended .persona-arrow { + background: var(--brand-green); + box-shadow: 0 6px 14px rgba(26, 135, 84, 0.32), 0 1px 2px rgba(26, 135, 84, 0.30); +} +.persona-card.is-recommended:hover .persona-arrow { + box-shadow: 0 8px 18px rgba(26, 135, 84, 0.42), 0 1px 2px rgba(26, 135, 84, 0.30); +} +.persona-new-pill { + position: absolute; + top: 22px; + right: 22px; + padding: 3px 10px; + border-radius: 999px; + font-size: 0.66rem; + font-weight: 700; + letter-spacing: 0.16em; + background: var(--brand-green-soft); + color: var(--brand-green); + border: 1px solid var(--brand-green-hairline); + z-index: 1; +} + +/* Bottom CTA strip */ +.gate-cta { + display: flex; + align-items: center; + justify-content: space-between; + gap: 16px; + padding: 22px 28px; + border-radius: 16px; + background: linear-gradient(90deg, var(--brand-blue), var(--brand-blue-deep)); + color: #fff; + flex-wrap: wrap; + box-shadow: 0 6px 20px rgba(1, 118, 211, 0.20); +} +.gate-cta__copy { + display: flex; + flex-direction: column; + gap: 2px; +} +.gate-cta__copy strong { + font-size: 1.05rem; + font-weight: 700; +} +.gate-cta__copy span { + font-size: 0.85rem; + opacity: 0.85; +} +/* Scoped under .gate-cta to win against the generic button.ghost:hover + rule above, which would otherwise force the label back to brand-blue + on a brand-blue background. */ +.gate-cta .cta-pill, +.gate-cta button.ghost.cta-pill { + background: rgba(255, 255, 255, 0.16); + color: #FFFFFF; + border: 1px solid rgba(255, 255, 255, 0.55); + border-radius: 999px; + padding: 9px 18px; + font-weight: 600; + font-size: 0.86rem; + letter-spacing: 0.02em; + text-shadow: 0 1px 1px rgba(0, 0, 0, 0.15); +} +.gate-cta .cta-pill:hover, +.gate-cta button.ghost.cta-pill:hover, +.gate-cta button.ghost.cta-pill:focus-visible { + background: rgba(255, 255, 255, 0.28); + border-color: rgba(255, 255, 255, 0.85); + color: #FFFFFF; +} + +/* ─── Dashboard ─────────────────────────────────────── */ +#dashboard { + max-width: 1240px; + margin: 0 auto; + padding: 32px 32px 48px; +} +.dashboard-hero { + display: flex; + justify-content: space-between; + /* Vertically centre the progress block against the eyebrow + headline pair. */ + align-items: center; + gap: 32px; + margin-bottom: 28px; + flex-wrap: wrap; +} +.dashboard-hero h1 { + /* Refined enterprise serif-grotesk pairing: prefer Salesforce Sans → + IBM Plex Sans → Source Sans 3 (humanist sans, used by Stripe / Shopify) + before the system-ui fallbacks, so SCAPI / OCAPI sit cleanly without + the chunky display weight from the previous Inter/SF-Pro stack. */ + font-family: + 'Salesforce Sans', 'IBM Plex Sans', 'Source Sans 3', 'Source Sans Pro', + -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', + Arial, sans-serif; + font-size: 1.75rem; + font-weight: 600; + font-style: normal; + letter-spacing: -0.01em; + line-height: 1.25; + margin: 0; + max-width: 620px; + color: var(--vscode-foreground); +} +.progress-block { + flex: 0 0 auto; + align-self: center; + width: 320px; + max-width: 100%; +} +.progress-meta { + display: flex; + justify-content: space-between; + align-items: baseline; + font-size: 0.82rem; + font-weight: 500; + margin-bottom: 8px; +} +.progress-track { + height: 8px; + border-radius: 999px; + background: var(--brand-blue-soft); + overflow: hidden; + border: 1px solid var(--brand-blue-hairline); +} +.progress-fill { + height: 100%; + width: 0%; + background: linear-gradient(90deg, #1B96FF, var(--brand-blue) 60%, var(--brand-blue-deep)); + transition: width 240ms cubic-bezier(0.4, 0, 0.2, 1); +} + +.layout { + display: grid; + grid-template-columns: var(--sidebar-width) 1fr; + gap: 32px; + align-items: start; +} +@media (max-width: 900px) { .layout { grid-template-columns: 1fr; } } + +/* ─── Sidebar ───────────────────────────────────────── */ +.sidebar { + position: sticky; + top: 80px; + background: var(--surface-elevated); + border: 1px solid var(--hairline); + border-radius: var(--radius-md); + padding: 16px; +} +.sidebar-title { + text-transform: uppercase; + letter-spacing: 0.12em; + font-size: 0.7rem; + font-weight: 600; + color: var(--vscode-descriptionForeground); + padding: 0 6px 10px; +} +.step-list { + list-style: none; + padding: 0; + margin: 0; + display: flex; + flex-direction: column; + gap: 2px; +} +.step-item { + position: relative; + display: flex; + align-items: flex-start; + gap: 12px; + padding: 10px 12px; + border-radius: var(--radius-sm); + cursor: pointer; + border: 1px solid transparent; + color: var(--vscode-foreground); + transition: background 120ms ease, color 120ms ease; +} +.step-item:hover { background: var(--brand-blue-soft); } +.step-item.active { + background: var(--brand-blue-soft); + border-color: var(--brand-blue-hairline); +} +.step-item.active::before { + content: ""; + position: absolute; + left: -16px; + top: 12px; + bottom: 12px; + width: 3px; + background: var(--brand-blue); + border-radius: 0 3px 3px 0; +} +.step-item .status { + flex: 0 0 auto; + width: 22px; + height: 22px; + border-radius: 50%; + display: grid; + place-items: center; + font-size: 11px; + font-weight: 600; + margin-top: 1px; + /* Default = "available" / not-yet-touched: greyed disabled-looking dot. */ + background: var(--status-grey-soft); + color: var(--vscode-descriptionForeground); + border: 1px solid var(--status-grey); +} +.step-item[data-status="done"] .status { + background: var(--brand-green); + color: #fff; + border-color: var(--brand-green); + box-shadow: 0 0 0 2px var(--brand-green-soft); +} +.step-item[data-status="in-progress"] .status { + background: var(--status-amber); + color: #fff; + border-color: var(--status-amber); + box-shadow: 0 0 0 2px var(--status-amber-soft); +} +.step-item[data-status="skipped"] .status { + background: var(--status-grey-soft); + color: var(--vscode-descriptionForeground); + border-color: var(--status-grey); + border-style: dashed; +} +.step-item[data-status="locked"] .status { + background: transparent; + color: var(--vscode-descriptionForeground); + border-color: var(--status-grey); + border-style: dashed; +} +.step-item.locked { cursor: not-allowed; opacity: 0.55; } +.step-item.locked:hover { background: transparent; } +.step-item.locked .label { color: var(--vscode-descriptionForeground); } +/* Lighter type weight: the previous 500 read as bold at small sizes. */ +.step-item .label { + font-size: 0.9rem; + line-height: 1.4; + min-width: 0; + font-weight: 400; + letter-spacing: 0.005em; +} +.step-item .label .title { font-weight: 450; color: var(--vscode-foreground); } +.step-item.active .label .title { font-weight: 600; } +.step-item[data-status="done"] .label .title { color: var(--vscode-descriptionForeground); } +.step-item .label small { + display: block; + color: var(--vscode-descriptionForeground); + font-size: 0.72rem; + margin-top: 2px; + font-weight: 400; + letter-spacing: 0.02em; +} + +/* ─── Step card ─────────────────────────────────────── */ +.content { min-width: 0; } +.step-card { + position: relative; + background: var(--surface-card); + border: 1px solid var(--hairline); + border-radius: var(--radius-lg); + padding: 28px 32px; + box-shadow: var(--shadow-sm); + overflow: hidden; +} +.step-card__rail { + position: absolute; + left: 0; + top: 0; + bottom: 0; + width: 4px; + background: linear-gradient(180deg, #1B96FF, var(--brand-blue) 50%, var(--brand-blue-deep)); +} +.step-card__header { + display: grid; + grid-template-columns: 56px 1fr; + gap: 18px; + align-items: start; + margin-bottom: 6px; +} +.step-number { + width: 56px; + height: 56px; + border-radius: 14px; + background: linear-gradient(135deg, #1B96FF, var(--brand-blue) 60%, var(--brand-blue-deep)); + color: #fff; + display: grid; + place-items: center; + font-family: 'Inter', system-ui, sans-serif; + font-weight: 800; + font-size: 1.5rem; + letter-spacing: -0.02em; + box-shadow: var(--shadow-sm); +} +.step-card__title-block { min-width: 0; } +.step-position { + font-size: 0.74rem; + text-transform: uppercase; + letter-spacing: 0.12em; + font-weight: 600; + color: var(--brand-blue); + margin: 0 0 4px; + display: block; +} +.step-card__title-block h2 { + margin: 0 0 6px; + font-size: 1.45rem; + font-weight: 600; + line-height: 1.25; +} +.step-card__title-block p { + margin: 0; + color: var(--vscode-descriptionForeground); + font-size: 0.95rem; + line-height: 1.55; +} +.step-card__actions { + margin-top: 22px; + padding: 14px 16px; + background: var(--brand-blue-soft); + border: 1px solid var(--brand-blue-hairline); + border-radius: var(--radius-md); +} +.step-card__section-label { + display: block; + font-size: 0.7rem; + text-transform: uppercase; + letter-spacing: 0.12em; + font-weight: 600; + color: var(--brand-blue-deep); +} +.step-card__actions-header { + display: flex; + align-items: center; + justify-content: space-between; + gap: 12px; + flex-wrap: wrap; + margin-bottom: 10px; +} +.detection-chip { + display: inline-flex; + align-items: center; + gap: 6px; + padding: 3px 10px; + border-radius: 999px; + background: var(--brand-green-soft, rgba(26, 135, 84, 0.12)); + color: var(--brand-green, #1A8754); + border: 1px solid var(--brand-green-hairline, rgba(26, 135, 84, 0.40)); + font-size: 0.74rem; + font-weight: 600; + letter-spacing: 0.01em; + white-space: nowrap; + cursor: default; +} +.detection-chip svg { color: inherit; } +.step-actions { + display: flex; + gap: 10px; + flex-wrap: wrap; +} +.step-actions button { min-height: 36px; padding: 7px 16px; font-weight: 600; } +/* Scoped under .step-actions so we beat the generic button.ghost rule: + inside the Quick-actions panel a "secondary" button needs to read on + the brand-blue-soft tint, not vanish into it. */ +.step-actions button.ghost, +.step-actions button.ghost:hover, +.step-actions button.ghost:focus-visible { + background: var(--surface-card); + color: var(--brand-blue); + border: 1px solid var(--brand-blue-hairline); +} +.step-actions button.ghost:hover { + background: var(--brand-blue-soft); + border-color: var(--brand-blue); + color: var(--brand-blue-deep); +} +.step-actions button:disabled, +.step-actions button.ghost:disabled, +.step-actions button:disabled:hover { + cursor: not-allowed; + opacity: 0.55; + background: var(--surface-card); + color: var(--vscode-descriptionForeground); + border: 1px solid var(--hairline); + transform: none; + box-shadow: none; +} +.step-card__body { + margin-top: 22px; + padding-top: 22px; + border-top: 1px solid var(--hairline); +} + +/* ─── Markdown body ─────────────────────────────────── */ +.markdown-body { + line-height: 1.65; + font-size: 0.95rem; + max-width: 720px; +} +.markdown-body > *:first-child { margin-top: 0; } +.markdown-body h1, .markdown-body h2, .markdown-body h3 { + margin-top: 1.6em; + margin-bottom: 0.5em; + font-weight: 600; + letter-spacing: -0.01em; +} +.markdown-body h1 { font-size: 1.25rem; } +.markdown-body h2 { + font-size: 1.1rem; + padding-bottom: 6px; + border-bottom: 1px solid var(--hairline); +} +.markdown-body h3 { font-size: 1rem; color: var(--brand-blue-deep); } +.markdown-body p { margin: 0 0 0.9em; } +.markdown-body code { + background: var(--brand-blue-soft); + color: var(--brand-blue-deep); + padding: 1px 6px; + border-radius: 4px; + font-family: var(--vscode-editor-font-family, ui-monospace, SFMono-Regular, Menlo, monospace); + font-size: 0.86em; + border: 1px solid var(--brand-blue-hairline); +} +.markdown-body pre { + background: var(--vscode-textCodeBlock-background, rgba(127,127,127,0.10)); + padding: 10px 14px; + border-radius: var(--radius-sm); + overflow-x: auto; + border: 1px solid var(--hairline); + margin: 0 0 12px; + /* Tight single-line-height box. Body inherits 1.65; without these resets, + single-line commands render with empty rows of air. */ + line-height: 1.55; + font-family: var(--vscode-editor-font-family, ui-monospace, SFMono-Regular, Menlo, monospace); + font-size: 0.86em; + min-height: 0; + white-space: pre; +} +.markdown-body pre code { + background: transparent; + padding: 0; + border: none; + margin: 0; + color: var(--vscode-foreground); + font: inherit; + line-height: inherit; + /* Inline so the block doesn't add its own line-box height. */ + display: inline; + white-space: inherit; +} +/* Tight stanza for adjacent code blocks. The adjacent-sibling combinator + (+) breaks when the renderer joins blocks with newlines (whitespace + text nodes between siblings); use general-sibling (~) instead. */ +.markdown-body pre ~ pre { margin-top: 0; } +.markdown-body p + pre { margin-top: 0; } +.markdown-body pre + p { margin-top: 8px; } +.markdown-body a { color: var(--brand-blue); text-decoration: none; border-bottom: 1px solid var(--brand-blue-hairline); } +.markdown-body a:hover { color: var(--brand-blue-deep); border-bottom-color: var(--brand-blue); } +.markdown-body hr { border: none; border-top: 1px solid var(--hairline); margin: 24px 0; } +.markdown-body ul, .markdown-body ol { padding-left: 1.4em; } +.markdown-body li { margin: 0.25em 0; } +.markdown-body blockquote { + margin: 0 0 1em; + padding: 10px 16px; + border-left: 3px solid var(--brand-blue); + background: var(--brand-blue-soft); + border-radius: 0 var(--radius-sm) var(--radius-sm) 0; + color: var(--vscode-foreground); +} +.markdown-body table { + border-collapse: collapse; + width: 100%; + margin: 0 0 1em; + font-size: 0.9em; +} +.markdown-body th, .markdown-body td { + text-align: left; + padding: 8px 10px; + border-bottom: 1px solid var(--hairline); +} +.markdown-body th { + background: var(--brand-blue-soft); + color: var(--brand-blue-deep); + font-weight: 600; +} +.markdown-body strong { font-weight: 600; } + +/* ─── Bottom nav ───────────────────────────────────── */ +/* Sticky to the bottom of the viewport so Previous/Skip/Next stay reachable + without scrolling — matches the pattern Stripe and Datadog use for + long-form onboarding. Translucent background + backdrop-blur lets the + page wash bleed through. */ +.step-nav { + display: grid; + grid-template-columns: 1fr auto 1fr; + align-items: center; + gap: 16px; + margin-top: 24px; + position: sticky; + bottom: 0; + z-index: 5; + padding: 14px 16px 16px; + /* Solid editor background so scrolling body text doesn't bleed through. + The hairline + lifted shadow signal the sticky boundary cleanly. */ + background: var(--vscode-editor-background); + border-top: 1px solid var(--hairline); + border-radius: var(--radius-md) var(--radius-md) 0 0; + box-shadow: 0 -10px 24px -16px rgba(0, 0, 0, 0.18); +} +/* Bottom padding on .content so the last paragraph isn't trapped behind the + sticky bar (~96px = nav height + breathing room). */ +.content { padding-bottom: 96px; } +.nav-btn { + display: flex; + align-items: center; + gap: 12px; + padding: 12px 16px; + background: var(--surface-card); + color: var(--vscode-foreground); + border: 1px solid var(--hairline); + border-radius: var(--radius-md); + cursor: pointer; + text-align: left; + min-height: 56px; + width: 100%; + /* Use the same humanist sans as the dashboard headline so the nav reads + as part of the chrome, not the markdown body. */ + font-family: + 'Salesforce Sans', 'IBM Plex Sans', 'Source Sans 3', 'Source Sans Pro', + -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; + font-weight: 500; + letter-spacing: 0; +} +.nav-btn:hover:not([disabled]) { + border-color: var(--brand-blue-hairline); + background: var(--brand-blue-soft); + color: var(--vscode-foreground); +} +.nav-btn[disabled] { opacity: 0.4; cursor: not-allowed; } +.nav-btn.next { justify-content: flex-end; } +.nav-btn.next.primary { + background: var(--brand-blue); + color: #fff; + border-color: var(--brand-blue); +} +.nav-btn.next.primary:hover:not([disabled]) { + background: var(--brand-blue-deep); + color: #fff; +} +.nav-btn .nav-text { display: flex; flex-direction: column; min-width: 0; } +.nav-btn .nav-text.right { text-align: right; } +.nav-btn .nav-text small { + font-size: 0.68rem; + text-transform: uppercase; + letter-spacing: 0.14em; + font-weight: 700; + color: var(--vscode-descriptionForeground); + opacity: 0.85; +} +.nav-btn.next.primary .nav-text small { color: rgba(255, 255, 255, 0.85); opacity: 1; } +.nav-btn .nav-text span:not(small) { + font-size: 0.92rem; + font-weight: 600; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} +.nav-btn .nav-chevron { + font-size: 1.5rem; + line-height: 1; + flex-shrink: 0; +} +.nav-spacer { + display: flex; + flex-direction: column; + align-items: center; + gap: 6px; +} +.link-btn { + background: transparent; + color: var(--brand-blue); + border: none; + padding: 4px 10px; + cursor: pointer; + font-weight: 500; + font-size: 0.88rem; + border-radius: 4px; +} +.link-btn:hover { background: var(--brand-blue-soft); color: var(--brand-blue-deep); } +.kbd-hint { font-size: 0.75rem; } +.kbd-hint kbd { + background: var(--vscode-keybindingLabel-background, rgba(127,127,127,0.18)); + border: 1px solid var(--vscode-keybindingLabel-border, rgba(127,127,127,0.3)); + border-radius: 3px; + padding: 1px 5px; + font-family: var(--vscode-editor-font-family, monospace); + font-size: 0.72rem; +} +@media (max-width: 720px) { + .step-nav { grid-template-columns: 1fr; } + .nav-btn { width: 100%; } +} +`; + +const PANEL_JS = ` +(function () { + const vscode = acquireVsCodeApi(); + const gate = document.getElementById('persona-gate'); + const dashboard = document.getElementById('dashboard'); + const personaCards = document.getElementById('persona-cards'); + const personaLabel = document.getElementById('persona-label'); + const personaTagline = document.getElementById('persona-tagline'); + const stepList = document.getElementById('step-list'); + const stepNumber = document.getElementById('step-number'); + const stepPosition = document.getElementById('step-position'); + const stepTitle = document.getElementById('step-title'); + const stepSummary = document.getElementById('step-summary'); + const stepActions = document.getElementById('step-actions'); + const stepActionsWrap = document.getElementById('step-actions-wrap'); + const stepBody = document.getElementById('step-body'); + const stepCard = document.querySelector('.step-card'); + const btnPrev = document.getElementById('btn-prev'); + const btnNext = document.getElementById('btn-next'); + const btnPrevTop = document.getElementById('btn-prev-top'); + const btnNextTop = document.getElementById('btn-next-top'); + const prevTitleEl = document.getElementById('prev-title'); + const nextTitleEl = document.getElementById('next-title'); + const progressCounter = document.getElementById('progress-counter'); + const progressPercent = document.getElementById('progress-percent'); + const progressFill = document.getElementById('progress-fill'); + const btnSkip = document.getElementById('btn-skip'); + const btnChangePersona = document.getElementById('btn-change-persona'); + const btnReset = document.getElementById('btn-reset'); + const btnMarkAllDone = document.getElementById('btn-mark-all-done'); + const btnThemeToggle = document.getElementById('btn-theme-toggle'); + const btnCtaMarkAllDone = document.getElementById('btn-cta-mark-all-done'); + const btnStartOver = document.getElementById('btn-start-over'); + const setupChip = document.getElementById('setup-chip'); + const setupChipName = document.getElementById('setup-chip-name'); + + let currentState = null; + + function post(msg) { vscode.postMessage(msg); } + + function renderSetupChip(state) { + if (!setupChip || !btnStartOver || !setupChipName) return; + if (state.setupInstance) { + setupChipName.textContent = state.setupInstance; + setupChip.hidden = false; + btnStartOver.hidden = false; + } else { + setupChip.hidden = true; + btnStartOver.hidden = true; + } + } + + function render(state) { + currentState = state; + renderSetupChip(state); + if (!state.persona) { + gate.hidden = false; + dashboard.hidden = true; + renderPersonaGate(state.personas); + return; + } + gate.hidden = true; + dashboard.hidden = false; + personaLabel.textContent = state.persona.label; + // Headers don't carry trailing punctuation — strip a single period if + // the persona definition's tagline ends with one. + personaTagline.textContent = state.persona.tagline.replace(/\.$/, ''); + renderStepList(state.steps, state.activeStepId); + + const activeIdx = state.steps.findIndex((s) => s.id === state.activeStepId); + const idx = activeIdx >= 0 ? activeIdx : 0; + const active = state.steps[idx]; + const prevStep = idx > 0 ? state.steps[idx - 1] : null; + const nextStep = idx < state.steps.length - 1 ? state.steps[idx + 1] : null; + renderActiveStep(active, idx, state.steps.length); + renderNav(prevStep, nextStep); + renderProgress(state.steps, idx); + } + + function renderProgress(steps, idx) { + const total = steps.length; + const doneCount = steps.filter((s) => s.status === 'done').length; + const pct = total === 0 ? 0 : Math.round((doneCount / total) * 100); + progressCounter.textContent = 'Step ' + (idx + 1) + ' of ' + total; + progressPercent.textContent = pct + '% complete'; + progressFill.style.width = pct + '%'; + } + + function renderNav(prev, next) { + prevTitleEl.textContent = prev ? prev.title : 'Start of walkthrough'; + nextTitleEl.textContent = next ? next.title : 'Finish walkthrough'; + btnPrev.disabled = !prev; + if (btnPrevTop) btnPrevTop.disabled = !prev; + } + + // Per-persona icon SVGs. Stroke uses currentColor so the avatar tile's + // foreground (white inside the gradient square) drives them. + const PERSONA_ICONS = { + 'storefront': + '', + 'api-integration': + '', + 'devops-release': + '', + 'ai-augmented': + '', + }; + + function renderPersonaGate(personas) { + personaCards.innerHTML = ''; + personas.forEach((p) => { + const card = document.createElement('div'); + card.className = 'persona-card' + (p.recommended ? ' is-recommended' : ''); + card.setAttribute('role', 'button'); + card.setAttribute('tabindex', '0'); + card.setAttribute('aria-label', p.label); + const newPill = p.recommended ? 'NEW' : ''; + // Generic fallback icon (a small square cluster) for any persona that + // doesn't have a dedicated SVG yet — still icon-based, never letters. + const fallbackIcon = + ''; + const iconHtml = PERSONA_ICONS[p.id] || fallbackIcon; + card.innerHTML = [ + '', + '

    ', + '

    ', + '

    ', + '', + '', + newPill, + ].join(''); + card.querySelector('h3').textContent = p.label; + card.querySelector('.tagline').textContent = p.tagline.replace(/\.$/, ''); + card.querySelector('.desc').textContent = p.description; + card.querySelector('.persona-meta').textContent = + p.stepCount + ' phases · ~' + p.estimatedMinutes + ' min'; + const select = () => post({type: 'selectPersona', personaId: p.id}); + card.addEventListener('click', select); + card.addEventListener('keydown', (e) => { + if (e.key === 'Enter' || e.key === ' ') { + e.preventDefault(); + select(); + } + }); + personaCards.appendChild(card); + }); + } + + function renderStepList(steps, activeId) { + stepList.innerHTML = ''; + steps.forEach((step, idx) => { + const locked = step.status === 'locked'; + const li = document.createElement('li'); + li.className = 'step-item' + (step.id === activeId ? ' active' : '') + (locked ? ' locked' : ''); + li.dataset.status = step.status; + li.innerHTML = [ + '', + '', + ].join(''); + li.querySelector('.status').textContent = statusGlyph(step.status, idx + 1); + li.querySelector('.title').textContent = step.title; + li.querySelector('small').textContent = labelForStatus(step.status); + if (locked) { + li.setAttribute('aria-disabled', 'true'); + li.setAttribute('title', 'Complete the previous step to unlock this one.'); + } else { + li.setAttribute('role', 'button'); + li.setAttribute('tabindex', '0'); + li.addEventListener('click', () => post({type: 'openStep', stepId: step.id})); + li.addEventListener('keydown', (e) => { + if (e.key === 'Enter' || e.key === ' ') { + e.preventDefault(); + post({type: 'openStep', stepId: step.id}); + } + }); + } + stepList.appendChild(li); + }); + } + + function statusGlyph(status, ordinal) { + switch (status) { + case 'done': return '✓'; + case 'in-progress': return '●'; + case 'skipped': return '–'; + case 'locked': return '🔒'; + default: return String(ordinal); + } + } + + function labelForStatus(status) { + switch (status) { + case 'done': return 'Completed'; + case 'in-progress': return 'In progress'; + case 'skipped': return 'Skipped'; + case 'locked': return 'Locked — complete the previous step'; + default: return ''; + } + } + + function renderActiveStep(step, idx, total) { + const detectionChip = document.getElementById('step-detection-chip'); + const detectionLabel = document.getElementById('step-detection-label'); + if (!step) { + stepNumber.textContent = ''; + stepPosition.textContent = ''; + stepTitle.textContent = ''; + stepSummary.textContent = ''; + stepActions.innerHTML = ''; + stepActionsWrap.hidden = true; + stepBody.innerHTML = ''; + if (detectionChip) detectionChip.hidden = true; + return; + } + stepNumber.textContent = String(idx + 1); + stepPosition.textContent = 'Step ' + (idx + 1) + ' of ' + total; + stepTitle.textContent = step.title; + stepSummary.textContent = step.summary; + stepBody.innerHTML = step.html; + stepActions.innerHTML = ''; + if (step.actions && step.actions.length > 0) { + stepActionsWrap.hidden = false; + step.actions.forEach((action) => { + const btn = document.createElement('button'); + if (!action.primary) btn.className = 'ghost'; + btn.textContent = action.label; + if (action.tooltip) btn.title = action.tooltip; + if (action.disabled) { + btn.disabled = true; + btn.setAttribute('aria-disabled', 'true'); + } else { + btn.addEventListener('click', () => + post({type: 'runAction', command: action.command, args: action.args, stepId: step.id}), + ); + } + stepActions.appendChild(btn); + }); + } else { + stepActionsWrap.hidden = true; + } + // Per-step config detection chip (e.g., "1 configuration detected") + if (detectionChip && detectionLabel) { + if (step.detection && step.detection.label) { + detectionLabel.textContent = step.detection.label; + const names = step.detection.matchedNames || []; + detectionChip.title = names.length + ? 'Detected in dw.json: ' + names.join(', ') + : 'Detected in dw.json'; + detectionChip.hidden = false; + // Ensure the actions wrapper is visible even if there are no actions, + // so the chip alone can communicate "this step is already configured". + if (step.actions && step.actions.length === 0) stepActionsWrap.hidden = false; + } else { + detectionChip.hidden = true; + } + } + // Scroll the card (not the body) so step-header stays visible after navigation. + if (stepCard && typeof stepCard.scrollIntoView === 'function') { + stepCard.scrollIntoView({behavior: 'smooth', block: 'start'}); + } + } + + // AI skills step: dispatch button clicks (install skills / run cmd) before + // the generic link interceptor sees them. + document.addEventListener('click', (e) => { + const btn = e.target && e.target.closest && e.target.closest('[data-action]'); + if (!btn) return; + const action = btn.getAttribute('data-action'); + if (action === 'install-skills') { + const ide = btn.getAttribute('data-ide') || ''; + e.preventDefault(); + post({type: 'aiSkills.installSkills', ide: ide}); + } else if (action === 'run-cmd') { + const cmd = btn.getAttribute('data-cmd') || ''; + const label = btn.getAttribute('data-label') || 'Install'; + e.preventDefault(); + post({type: 'aiSkills.runCommand', cmd: cmd, label: label}); + } else if (action === 'ai-recheck') { + e.preventDefault(); + post({type: 'aiSkills.recheck'}); + } + }); + + // Intercept clicks on any link inside the content area. We NEVER let the + // webview follow command: or http links directly — all routing goes through + // the extension host via postMessage. + document.addEventListener('click', (e) => { + const anchor = e.target && e.target.closest && e.target.closest('a[href]'); + if (!anchor) return; + const href = anchor.getAttribute('href'); + if (!href || href === '#') return; + e.preventDefault(); + post({type: 'openLink', url: href}); + }); + + btnSkip.addEventListener('click', () => { + if (!currentState || !currentState.activeStepId) return; + post({type: 'skipStep', stepId: currentState.activeStepId}); + }); + btnPrev.addEventListener('click', () => post({type: 'goPrev'})); + btnNext.addEventListener('click', () => post({type: 'goNext'})); + if (btnPrevTop) btnPrevTop.addEventListener('click', () => post({type: 'goPrev'})); + if (btnNextTop) btnNextTop.addEventListener('click', () => post({type: 'goNext'})); + btnChangePersona.addEventListener('click', () => post({type: 'changePersona'})); + btnReset.addEventListener('click', () => post({type: 'reset'})); + if (btnMarkAllDone) { + btnMarkAllDone.addEventListener('click', () => + post({type: 'runAction', command: 'b2c-dx.walkthrough.markAllDone'}), + ); + } + if (btnThemeToggle) { + btnThemeToggle.addEventListener('click', () => post({type: 'runAction', command: 'b2c-dx.theme.toggle'})); + } + if (btnCtaMarkAllDone) { + btnCtaMarkAllDone.addEventListener('click', () => + post({type: 'runAction', command: 'b2c-dx.walkthrough.markAllDone'}), + ); + } + if (btnStartOver) { + btnStartOver.addEventListener('click', () => post({type: 'runAction', command: 'b2c-dx.setup.resetSession'})); + } + + // Keyboard navigation: Alt+← / Alt+→ (and the usual PageUp/Down pattern). + document.addEventListener('keydown', (e) => { + if (!currentState || !currentState.persona) return; + if (e.altKey && e.key === 'ArrowRight') { e.preventDefault(); post({type: 'goNext'}); } + else if (e.altKey && e.key === 'ArrowLeft') { e.preventDefault(); post({type: 'goPrev'}); } + }); + + window.addEventListener('message', (event) => { + const msg = event.data; + if (msg && msg.type === 'state') render(msg.state); + }); + + post({type: 'ready'}); +}()); +`; diff --git a/packages/b2c-vs-extension/src/walkthrough/personas.ts b/packages/b2c-vs-extension/src/walkthrough/personas.ts new file mode 100644 index 000000000..be12097b9 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/personas.ts @@ -0,0 +1,235 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +export type PersonaId = 'storefront' | 'api-integration' | 'devops-release' | 'ai-augmented'; + +export interface StepDefinition { + id: string; + title: string; + summary: string; + /** Path relative to the extension root. The onboarding panel resolves this via asWebviewUri. */ + markdown: string; + /** + * Commands the step can trigger from the UI. Surfaced as buttons in the panel header. + */ + actions?: StepAction[]; +} + +export interface StepAction { + label: string; + command: string; + args?: unknown[]; + /** Marks this as the primary call-to-action (rendered as a filled button). */ + primary?: boolean; + /** When true, the button renders disabled with a hint tooltip. */ + disabled?: boolean; + /** Tooltip / aria-label describing why the action is in its current state. */ + tooltip?: string; +} + +export interface PersonaDefinition { + id: PersonaId; + label: string; + tagline: string; + description: string; + stepIds: string[]; +} + +/** + * Catalog of every step that can appear in any persona flow. + * The markdown files are the existing walkthrough content — we render them inside the panel + * instead of the built-in VS Code walkthrough surface. + */ +export const STEP_CATALOG: Record = { + welcome: { + id: 'welcome', + title: 'Welcome to B2C Commerce Development', + summary: 'What the extension does and what you will learn.', + markdown: 'media/walkthrough/welcome.md', + }, + 'configure-dw-json': { + id: 'configure-dw-json', + title: 'Connect to Your B2C Instance', + summary: 'Connection-only: name the instance and pick its hostname / code-version.', + markdown: 'media/walkthrough/dw-json-setup.md', + actions: [ + {label: 'Set up connection', command: 'b2c-dx.setup.connection', primary: true}, + {label: 'Inspect resolved config', command: 'b2c-dx.walkthrough.inspectSetup'}, + {label: 'Open dw.json', command: 'workbench.action.quickOpen', args: ['dw.json']}, + ], + }, + 'setup-oauth': { + id: 'setup-oauth', + title: 'Set Up OAuth Credentials', + summary: 'Add `client-id` + `client-secret`. Pick where the secret lives.', + markdown: 'media/walkthrough/oauth-setup.md', + actions: [ + {label: 'Set up OAuth', command: 'b2c-dx.setup.oauth', primary: true}, + {label: 'Inspect resolved config', command: 'b2c-dx.walkthrough.inspectSetup'}, + ], + }, + 'explore-webdav': { + id: 'explore-webdav', + title: 'Browse Your Instance with WebDAV', + summary: 'Add `username` + `password`, then open the WebDAV browser.', + markdown: 'media/walkthrough/webdav-browser.md', + actions: [ + {label: 'Set up WebDAV credentials', command: 'b2c-dx.setup.webdav', primary: true}, + {label: 'Open WebDAV Browser', command: 'b2c-dx.listWebDav'}, + {label: 'Inspect resolved config', command: 'b2c-dx.walkthrough.inspectSetup'}, + ], + }, + 'setup-cartridges': { + id: 'setup-cartridges', + title: 'Set Up Cartridge Development', + summary: 'Detect or create cartridges. Add SCAPI fields here if you need the API Browser.', + markdown: 'media/walkthrough/cartridge-structure.md', + actions: [ + {label: 'Create New Cartridge', command: 'b2c-dx.scaffold.generate', primary: true}, + {label: 'Set up SCAPI (short-code, tenant-id)', command: 'b2c-dx.setup.scapi'}, + {label: 'Refresh Cartridge List', command: 'b2c-dx.codeSync.refreshCartridges'}, + {label: 'Inspect resolved config', command: 'b2c-dx.walkthrough.inspectSetup'}, + ], + }, + 'deploy-code': { + id: 'deploy-code', + title: 'Deploy Your First Cartridge', + summary: 'Upload cartridge code to your sandbox.', + markdown: 'media/walkthrough/deploy-cartridge.md', + actions: [ + {label: 'Deploy Recommended Cartridge', command: 'b2c-dx.codeSync.deployOne', primary: true}, + {label: 'Deploy All Cartridges', command: 'b2c-dx.codeSync.deploy'}, + {label: 'Refresh WebDAV Browser', command: 'b2c-dx.webdav.refresh'}, + ], + }, + 'manage-sandboxes': { + id: 'manage-sandboxes', + title: 'Work with Development Sandboxes', + summary: 'Create, start, stop, and extend sandboxes.', + markdown: 'media/walkthrough/sandbox-explorer.md', + actions: [{label: 'Open Sandbox Explorer', command: 'workbench.view.extension.b2c-dx-sandboxes', primary: true}], + }, + 'enable-code-sync': { + id: 'enable-code-sync', + title: 'Automate Deployment with Code Sync', + summary: 'Auto-upload cartridge changes as you save.', + markdown: 'media/walkthrough/code-sync.md', + actions: [ + {label: 'Start Code Sync', command: 'b2c-dx.codeSync.start', primary: true}, + {label: 'Stop Code Sync', command: 'b2c-dx.codeSync.stop'}, + ], + }, + 'next-steps': { + id: 'next-steps', + title: "You're Ready! Explore More Features", + summary: 'Where to go next.', + markdown: 'media/walkthrough/next-steps.md', + }, + 'install-cli': { + id: 'install-cli', + title: 'Install the B2C CLI', + summary: 'Optional, but unlocks deploys, log tailing, and sandbox commands from the terminal.', + markdown: 'media/walkthrough/install-cli.md', + actions: [ + {label: 'Verify CLI', command: 'b2c-dx.cli.verify', primary: true}, + {label: 'Update CLI', command: 'b2c-dx.cli.update'}, + ], + }, + 'ai-skills': { + id: 'ai-skills', + title: 'Set Up Agent Skills & MCP', + summary: + 'One-click install of B2C agent skills + MCP for Claude Code, Cursor, Copilot, Windsurf, Codex, OpenCode, and more.', + markdown: 'media/walkthrough/ai-skills.md', + }, +}; + +export const PERSONAS: Record = { + storefront: { + id: 'storefront', + label: 'Storefront developer', + tagline: 'Build SFRA / PWA Kit templates, controllers, and ISML.', + description: + 'Cartridge authoring, fast iteration with Code Sync, and WebDAV. If you used UX Studio or Prophet before, this is your closest map.', + stepIds: [ + 'welcome', + 'install-cli', + 'configure-dw-json', + 'setup-cartridges', + 'deploy-code', + 'enable-code-sync', + 'explore-webdav', + 'next-steps', + ], + }, + 'api-integration': { + id: 'api-integration', + label: 'API / integration developer', + tagline: 'Work with SCAPI, OCAPI, jobs, and hooks.', + description: 'OAuth setup and the API Browser are first-class; Code Sync is optional.', + stepIds: [ + 'welcome', + 'install-cli', + 'configure-dw-json', + 'setup-oauth', + 'explore-webdav', + 'setup-cartridges', + 'deploy-code', + 'next-steps', + ], + }, + 'devops-release': { + id: 'devops-release', + label: 'DevOps / release engineer', + tagline: 'Manage sandbox lifecycle, code versions, and CAPs.', + description: 'OAuth + Sandbox Explorer front and center. Less time on cartridge authoring.', + stepIds: [ + 'welcome', + 'install-cli', + 'configure-dw-json', + 'setup-oauth', + 'manage-sandboxes', + 'deploy-code', + 'next-steps', + ], + }, + 'ai-augmented': { + id: 'ai-augmented', + label: 'AI-augmented developer', + tagline: 'Pair Cursor / Claude Code / Copilot with this extension.', + description: + 'AI-first onboarding: get your IDE wired up to B2C agent skills and MCP first, then connect to a sandbox and deploy.', + // AI setup leads — agent skills + MCP get installed before instance config + // so the IDE has B2C context while the user works through the rest. + stepIds: [ + 'welcome', + 'install-cli', + 'ai-skills', + 'configure-dw-json', + 'setup-cartridges', + 'deploy-code', + 'enable-code-sync', + 'next-steps', + ], + }, +}; + +export function getPersona(id: string | null | undefined): PersonaDefinition | null { + if (!id) return null; + return (PERSONAS as Record)[id] ?? null; +} + +export function listPersonas(): PersonaDefinition[] { + return Object.values(PERSONAS); +} + +export function resolveSteps(personaId: PersonaId): StepDefinition[] { + return PERSONAS[personaId].stepIds.map((id) => { + const def = STEP_CATALOG[id]; + if (!def) throw new Error(`Unknown step id in persona ${personaId}: ${id}`); + return def; + }); +} diff --git a/packages/b2c-vs-extension/src/walkthrough/state.ts b/packages/b2c-vs-extension/src/walkthrough/state.ts new file mode 100644 index 000000000..e0d0bb260 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/state.ts @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as vscode from 'vscode'; + +export type StepStatus = 'locked' | 'available' | 'in-progress' | 'done' | 'skipped'; + +export interface StepRecord { + status: StepStatus; + startedAt?: string; + completedAt?: string; + skippedAt?: string; +} + +export interface OnboardingSnapshot { + persona: string | null; + steps: Record; + schemaVersion: number; +} + +const STATE_KEY = 'b2c-dx.onboarding.state'; +const CURRENT_SCHEMA_VERSION = 1; + +function emptySnapshot(): OnboardingSnapshot { + return {persona: null, steps: {}, schemaVersion: CURRENT_SCHEMA_VERSION}; +} + +function stepKey(persona: string, stepId: string): string { + return `${persona}:${stepId}`; +} + +export class OnboardingStateStore { + private readonly memento: vscode.Memento; + private readonly emitter = new vscode.EventEmitter(); + + readonly onDidChange = this.emitter.event; + + constructor(context: vscode.ExtensionContext) { + // Per-workspace state: each workspace has its own onboarding lifecycle. + // A fresh workspace = a fresh onboarding flow. + this.memento = context.workspaceState; + } + + get(): OnboardingSnapshot { + const raw = this.memento.get(STATE_KEY); + if (!raw || typeof raw !== 'object') return emptySnapshot(); + if (raw.schemaVersion !== CURRENT_SCHEMA_VERSION) { + return {...emptySnapshot(), persona: raw.persona ?? null}; + } + return raw; + } + + getPersona(): string | null { + return this.get().persona; + } + + async setPersona(persona: string | null): Promise { + const current = this.get(); + await this.write({...current, persona}); + } + + getStep(persona: string, stepId: string): StepRecord | undefined { + return this.get().steps[stepKey(persona, stepId)]; + } + + async updateStep(persona: string, stepId: string, patch: Partial): Promise { + const current = this.get(); + const key = stepKey(persona, stepId); + const existing: StepRecord = current.steps[key] ?? {status: 'available'}; + const next: StepRecord = {...existing, ...patch}; + await this.write({...current, steps: {...current.steps, [key]: next}}); + return next; + } + + async markStarted(persona: string, stepId: string): Promise { + const existing = this.getStep(persona, stepId); + if (existing?.status === 'done') return; + await this.updateStep(persona, stepId, { + status: 'in-progress', + startedAt: existing?.startedAt ?? new Date().toISOString(), + }); + } + + async markCompleted(persona: string, stepId: string): Promise { + await this.updateStep(persona, stepId, { + status: 'done', + completedAt: new Date().toISOString(), + }); + } + + async markSkipped(persona: string, stepId: string): Promise { + await this.updateStep(persona, stepId, { + status: 'skipped', + skippedAt: new Date().toISOString(), + }); + } + + async reset(): Promise { + await this.write(emptySnapshot()); + } + + private async write(next: OnboardingSnapshot): Promise { + await this.memento.update(STATE_KEY, next); + this.emitter.fire(next); + } + + dispose(): void { + this.emitter.dispose(); + } +} diff --git a/packages/b2c-vs-extension/src/walkthrough/stepDetection.ts b/packages/b2c-vs-extension/src/walkthrough/stepDetection.ts new file mode 100644 index 000000000..b48716283 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/stepDetection.ts @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as fs from 'fs/promises'; +import * as path from 'path'; + +/** + * Lightweight per-step config detection. Reads dw.json directly from the + * workspace root so the panel can show "1 similar configuration detected" + * style hints without depending on the b2c CLI being installed. + */ + +export interface StepDetection { + /** Number of matching configurations detected (e.g., instances with OAuth). */ + matchCount: number; + /** Total instance entries scanned. */ + totalInstances: number; + /** Short label to display in the chip (e.g., "1 similar configuration detected"). */ + label?: string; + /** Names of matched instances, when applicable. */ + matchedNames?: string[]; +} + +interface DwJsonInstance { + name?: string; + hostname?: string; + 'code-version'?: string; + codeVersion?: string; + username?: string; + password?: string; + 'client-id'?: string; + clientId?: string; + 'client-secret'?: string; + clientSecret?: string; + 'short-code'?: string; + shortCode?: string; + 'tenant-id'?: string; + tenantId?: string; + cartridge?: unknown; + cartridgesPath?: string; + active?: boolean; +} + +interface DwJsonShape extends DwJsonInstance { + configs?: DwJsonInstance[]; +} + +async function readDwJson(workspaceRoot: string): Promise { + try { + const raw = await fs.readFile(path.join(workspaceRoot, 'dw.json'), 'utf-8'); + return JSON.parse(raw) as DwJsonShape; + } catch { + return null; + } +} + +/** Flatten a dw.json into a list of instance config blocks. */ +function flattenInstances(dw: DwJsonShape | null): DwJsonInstance[] { + if (!dw) return []; + if (Array.isArray(dw.configs) && dw.configs.length > 0) { + return dw.configs; + } + // Top-level shape: dw.json itself describes one instance. + return [dw]; +} + +const has = (v: unknown): boolean => typeof v === 'string' && v.trim().length > 0; + +function pluralize(n: number, sing: string, plural: string): string { + return n === 1 ? sing : plural; +} + +/** Check what's configured on each instance and tally per category. */ +export interface DetectionSummary { + connection: StepDetection; + oauth: StepDetection; + webdav: StepDetection; + scapi: StepDetection; + cartridges: StepDetection; +} + +export async function detectStepConfigurations(workspaceRoot: string | undefined): Promise { + const empty: StepDetection = {matchCount: 0, totalInstances: 0}; + if (!workspaceRoot) { + return { + connection: {...empty}, + oauth: {...empty}, + webdav: {...empty}, + scapi: {...empty}, + cartridges: {...empty}, + }; + } + + const dw = await readDwJson(workspaceRoot); + const instances = flattenInstances(dw); + const total = instances.length; + + const namesWith = (predicate: (i: DwJsonInstance) => boolean): string[] => + instances + .filter(predicate) + .map((i) => i.name) + .filter((n): n is string => typeof n === 'string' && n.length > 0); + + const connectionNames = namesWith((i) => has(i.hostname)); + const oauthNames = namesWith((i) => has(i['client-id'] ?? i.clientId)); + const webdavNames = namesWith((i) => has(i.username) && has(i.password)); + const scapiNames = namesWith((i) => has(i['short-code'] ?? i.shortCode) && has(i['tenant-id'] ?? i.tenantId)); + const cartridgeNames = namesWith((i) => has(i.cartridgesPath) || Array.isArray(i.cartridge)); + + const make = (names: string[]): StepDetection => { + if (names.length === 0) return {matchCount: 0, totalInstances: total}; + return { + matchCount: names.length, + totalInstances: total, + matchedNames: names, + label: `${names.length} ${pluralize(names.length, 'configuration', 'configurations')} detected`, + }; + }; + + return { + connection: make(connectionNames), + oauth: make(oauthNames), + webdav: make(webdavNames), + scapi: make(scapiNames), + cartridges: make(cartridgeNames), + }; +} + +/** Pulled from dw.json for the deploy-code step's "what will be deployed" preview. */ +export interface DeployContext { + hostname?: string; + codeVersion?: string; + instanceName?: string; +} + +/** Read the active instance's deploy-relevant fields from dw.json. */ +export async function readDeployContext(workspaceRoot: string | undefined): Promise { + if (!workspaceRoot) return {}; + const dw = await readDwJson(workspaceRoot); + if (!dw) return {}; + const instances = flattenInstances(dw); + // Prefer the active instance; fall back to the first one. + const active = instances.find((i) => i.active === true) ?? instances[0]; + if (!active) return {}; + return { + hostname: active.hostname, + codeVersion: active['code-version'] ?? active.codeVersion, + instanceName: active.name, + }; +} + +/** Map a step id to the relevant detection bucket. */ +export function getDetectionForStep(stepId: string, summary: DetectionSummary): StepDetection | null { + switch (stepId) { + case 'configure-dw-json': + return summary.connection; + case 'setup-oauth': + return summary.oauth; + case 'explore-webdav': + return summary.webdav; + case 'setup-cartridges': + // Cartridges step also covers SCAPI; report whichever has more matches, + // preferring cartridges when tied. + return summary.cartridges.matchCount >= summary.scapi.matchCount ? summary.cartridges : summary.scapi; + default: + return null; + } +} diff --git a/packages/b2c-vs-extension/src/walkthrough/telemetry.ts b/packages/b2c-vs-extension/src/walkthrough/telemetry.ts new file mode 100644 index 000000000..4680ea51d --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/telemetry.ts @@ -0,0 +1,192 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as vscode from 'vscode'; + +/** + * Walkthrough telemetry and performance tracking. + * Note: This is a basic implementation. For production, consider using + * a proper telemetry service like Application Insights or VS Code's telemetry API. + */ + +interface WalkthroughMetrics { + commandExecutions: Map; + commandDurations: Map; + stepCompletions: Map; + errors: Array<{command: string; error: string; timestamp: Date}>; +} + +class WalkthroughTelemetry { + private metrics: WalkthroughMetrics = { + commandExecutions: new Map(), + commandDurations: new Map(), + stepCompletions: new Map(), + errors: [], + }; + + private log: vscode.OutputChannel; + + constructor(log: vscode.OutputChannel) { + this.log = log; + } + + /** + * Track command execution start time + */ + startCommand(commandId: string): () => void { + const startTime = Date.now(); + + // Increment execution count + const count = this.metrics.commandExecutions.get(commandId) || 0; + this.metrics.commandExecutions.set(commandId, count + 1); + + // Return a function to call when command completes + return () => { + const duration = Date.now() - startTime; + + // Store duration + const durations = this.metrics.commandDurations.get(commandId) || []; + durations.push(duration); + this.metrics.commandDurations.set(commandId, durations); + + this.log.appendLine(`[Telemetry] Command '${commandId}' completed in ${duration}ms`); + }; + } + + /** + * Track step completion + */ + trackStepCompletion(stepId: string): void { + this.metrics.stepCompletions.set(stepId, new Date()); + this.log.appendLine(`[Telemetry] Step '${stepId}' completed`); + } + + /** + * Track error + */ + trackError(commandId: string, error: Error | string): void { + const errorMessage = error instanceof Error ? error.message : error; + this.metrics.errors.push({ + command: commandId, + error: errorMessage, + timestamp: new Date(), + }); + this.log.appendLine(`[Telemetry] Error in '${commandId}': ${errorMessage}`); + } + + /** + * Get average duration for a command + */ + getAverageDuration(commandId: string): number | null { + const durations = this.metrics.commandDurations.get(commandId); + if (!durations || durations.length === 0) { + return null; + } + + const sum = durations.reduce((a, b) => a + b, 0); + return sum / durations.length; + } + + /** + * Get metrics summary + */ + getSummary(): string { + const lines: string[] = ['=== Walkthrough Telemetry Summary ===', '', 'Command Executions:']; + + for (const [command, count] of this.metrics.commandExecutions) { + const avgDuration = this.getAverageDuration(command); + const avgStr = avgDuration ? `avg: ${avgDuration.toFixed(2)}ms` : 'no timing data'; + lines.push(` ${command}: ${count} executions (${avgStr})`); + } + + lines.push('', 'Step Completions:'); + for (const [step, date] of this.metrics.stepCompletions) { + lines.push(` ${step}: ${date.toISOString()}`); + } + + if (this.metrics.errors.length > 0) { + lines.push('', 'Errors:'); + for (const error of this.metrics.errors) { + lines.push(` [${error.timestamp.toISOString()}] ${error.command}: ${error.error}`); + } + } + + return lines.join('\n'); + } + + /** + * Log summary to output channel + */ + logSummary(): void { + this.log.appendLine(this.getSummary()); + } + + /** + * Reset all metrics + */ + reset(): void { + this.metrics = { + commandExecutions: new Map(), + commandDurations: new Map(), + stepCompletions: new Map(), + errors: [], + }; + this.log.appendLine('[Telemetry] Metrics reset'); + } +} + +let telemetryInstance: WalkthroughTelemetry | null = null; + +/** + * Initialize telemetry + */ +export function initializeTelemetry(log: vscode.OutputChannel): WalkthroughTelemetry { + telemetryInstance = new WalkthroughTelemetry(log); + return telemetryInstance; +} + +/** + * Get telemetry instance + */ +export function getTelemetry(): WalkthroughTelemetry | null { + return telemetryInstance; +} + +/** + * Decorator for tracking command execution time + */ +export function trackCommand(commandId: string): MethodDecorator { + return function ( + // eslint-disable-next-line @typescript-eslint/no-explicit-any + target: any, + propertyKey: string | symbol, + descriptor: PropertyDescriptor, + ) { + const originalMethod = descriptor.value; + + // eslint-disable-next-line @typescript-eslint/no-explicit-any + descriptor.value = async function (...args: any[]) { + const telemetry = getTelemetry(); + if (!telemetry) { + return originalMethod.apply(this, args); + } + + const endTracking = telemetry.startCommand(commandId); + + try { + const result = await originalMethod.apply(this, args); + endTracking(); + return result; + } catch (error) { + telemetry.trackError(commandId, error as Error); + endTracking(); + throw error; + } + }; + + return descriptor; + }; +} diff --git a/packages/b2c-vs-extension/src/walkthrough/test/commands.test.ts b/packages/b2c-vs-extension/src/walkthrough/test/commands.test.ts new file mode 100644 index 000000000..b50f0c8cc --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/test/commands.test.ts @@ -0,0 +1,200 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as assert from 'assert'; +import * as vscode from 'vscode'; +import * as path from 'path'; +import * as fs from 'fs/promises'; + +suite('Walkthrough Commands Test Suite', () => { + let testWorkspaceUri: vscode.Uri; + let testDwJsonPath: string; + + suiteSetup(async () => { + // Get the test workspace folder + const workspaceFolders = vscode.workspace.workspaceFolders; + assert.ok(workspaceFolders && workspaceFolders.length > 0, 'Test workspace should be open'); + + testWorkspaceUri = workspaceFolders[0].uri; + testDwJsonPath = path.join(testWorkspaceUri.fsPath, 'dw.json'); + }); + + setup(async () => { + // Clean up any existing dw.json before each test + try { + await fs.unlink(testDwJsonPath); + } catch { + // File doesn't exist, that's fine + } + }); + + teardown(async () => { + // Clean up after each test + try { + await fs.unlink(testDwJsonPath); + } catch { + // File doesn't exist, that's fine + } + }); + + suite('b2c-dx.walkthrough.open', () => { + test('should open walkthrough without errors', async () => { + // Execute the command + await vscode.commands.executeCommand('b2c-dx.walkthrough.open'); + + // Give it a moment to execute + await new Promise((resolve) => setTimeout(resolve, 1000)); + + // If we got here without throwing, the command executed + assert.ok(true, 'Walkthrough open command executed'); + }); + + test('should be registered in command palette', async () => { + const commands = await vscode.commands.getCommands(); + assert.ok(commands.includes('b2c-dx.walkthrough.open'), 'Command should be registered'); + }); + }); + + suite('b2c-dx.walkthrough.createDwJson', () => { + test('should be registered in command palette', async () => { + const commands = await vscode.commands.getCommands(); + assert.ok(commands.includes('b2c-dx.walkthrough.createDwJson'), 'Command should be registered'); + }); + + // Note: Full integration testing of createDwJson requires user interaction + // (QuickPick dialogs), so we test the command registration here. + // Manual testing covers the full user interaction flow. + }); + + suite('dw.json file operations', () => { + test('should detect when dw.json exists', async () => { + // Create a test dw.json + const testContent = JSON.stringify( + { + hostname: 'test.demandware.net', + username: 'test', + password: 'test', + }, + null, + 2, + ); + + await fs.writeFile(testDwJsonPath, testContent, 'utf-8'); + + // Verify file exists + try { + await fs.access(testDwJsonPath); + assert.ok(true, 'dw.json file was created'); + } catch { + assert.fail('dw.json file should exist'); + } + + // Verify content + const content = await fs.readFile(testDwJsonPath, 'utf-8'); + const parsed = JSON.parse(content); + assert.strictEqual(parsed.hostname, 'test.demandware.net'); + }); + + test('should handle missing dw.json gracefully', async () => { + // Ensure file doesn't exist + try { + await fs.unlink(testDwJsonPath); + } catch { + // Already doesn't exist + } + + // Try to access + try { + await fs.access(testDwJsonPath); + assert.fail('dw.json should not exist'); + } catch { + assert.ok(true, 'Correctly detected missing dw.json'); + } + }); + }); + + suite('Walkthrough completion events', () => { + test('should complete Step 2 when dw.json exists', async () => { + // Create dw.json + const testContent = JSON.stringify( + { + hostname: 'test.demandware.net', + username: 'test', + password: 'test', + }, + null, + 2, + ); + + await fs.writeFile(testDwJsonPath, testContent, 'utf-8'); + + // Trigger workspace file change event + await vscode.commands.executeCommand('workbench.action.reloadWindow'); + + // Note: Actual completion tracking is handled by VS Code's walkthrough API + // This test verifies the file exists, which is the completion condition + const exists = await fs + .access(testDwJsonPath) + .then(() => true) + .catch(() => false); + + assert.ok(exists, 'dw.json exists, Step 2 should be completable'); + }); + }); + + suite('Error handling', () => { + test('should handle command execution errors gracefully', async () => { + try { + // Try to execute a non-existent command + await vscode.commands.executeCommand('b2c-dx.nonexistent.command'); + assert.fail('Should have thrown an error'); + } catch (error) { + assert.ok(error, 'Error should be thrown for non-existent command'); + } + }); + }); + + suite('Extension activation', () => { + test('should activate extension in test workspace', async () => { + const extension = vscode.extensions.getExtension('Salesforce.b2c-vs-extension'); + assert.ok(extension, 'Extension should be installed'); + + if (!extension.isActive) { + await extension.activate(); + } + + assert.ok(extension.isActive, 'Extension should be active'); + }); + + test('should have walkthrough commands after activation', async () => { + const extension = vscode.extensions.getExtension('Salesforce.b2c-vs-extension'); + assert.ok(extension, 'Extension should be installed'); + + if (!extension.isActive) { + await extension.activate(); + } + + const commands = await vscode.commands.getCommands(); + assert.ok(commands.includes('b2c-dx.walkthrough.open'), 'Walkthrough open command should be available'); + assert.ok(commands.includes('b2c-dx.walkthrough.createDwJson'), 'Create dw.json command should be available'); + assert.ok(commands.includes('b2c-dx.walkthrough.markAllDone'), 'Mark all done command should be available'); + assert.ok(commands.includes('b2c-dx.cli.verify'), 'CLI verify command should be available'); + }); + }); + + suite('Personas', () => { + test('should expose the four current personas', async () => { + // Lazy import to avoid a hard module load before activation. + const personas = await import('../personas.js'); + const ids = personas.listPersonas().map((p) => p.id); + assert.deepStrictEqual( + ids.sort(), + ['ai-augmented', 'api-integration', 'devops-release', 'storefront'], + 'Persona ids should match the documented set', + ); + }); + }); +}); diff --git a/packages/b2c-vs-extension/src/walkthrough/toolDetection.ts b/packages/b2c-vs-extension/src/walkthrough/toolDetection.ts new file mode 100644 index 000000000..1793eca6d --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/toolDetection.ts @@ -0,0 +1,282 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as cp from 'child_process'; + +export interface ToolStatus { + name: string; + installed: boolean; + version?: string; + label: string; +} + +export interface ToolDetectionResult { + node: ToolStatus; + npm: ToolStatus; + homebrew: ToolStatus; + npx: ToolStatus; + b2cCli: ToolStatus; + b2cCliLatest?: string; + b2cCliOutdated?: boolean; +} + +function execVersion(command: string, args: string[]): Promise { + return new Promise((resolve) => { + cp.execFile(command, args, {timeout: 5000}, (err, stdout) => { + if (err) { + resolve(undefined); + return; + } + const output = stdout.toString().trim(); + resolve(output || undefined); + }); + }); +} + +function extractVersion(raw: string | undefined): string | undefined { + if (!raw) return undefined; + const match = raw.match(/(\d+\.\d+\.\d+(?:[-+][\w.]+)?)/); + return match ? match[1] : raw; +} + +export function compareSemver(a: string, b: string): number { + const norm = (v: string) => + v + .split(/[-+]/)[0] + .split('.') + .map((n) => parseInt(n, 10) || 0); + const [aA, aB] = [norm(a), norm(b)]; + for (let i = 0; i < 3; i++) { + if ((aA[i] ?? 0) !== (aB[i] ?? 0)) return (aA[i] ?? 0) - (aB[i] ?? 0); + } + const aPre = a.includes('-'); + const bPre = b.includes('-'); + if (aPre !== bPre) return aPre ? -1 : 1; + return 0; +} + +export async function detectTools(latestCliVersion?: string): Promise { + const [nodeRaw, npmRaw, brewRaw, npxRaw, b2cRaw] = await Promise.all([ + execVersion('node', ['--version']), + execVersion('npm', ['--version']), + execVersion('brew', ['--version']), + execVersion('npx', ['--version']), + execVersion('b2c', ['--version']), + ]); + + const nodeVersion = extractVersion(nodeRaw); + const npmVersion = extractVersion(npmRaw); + const brewVersion = extractVersion(brewRaw); + const npxVersion = extractVersion(npxRaw); + const b2cVersion = extractVersion(b2cRaw); + + let b2cCliOutdated: boolean | undefined; + let b2cCliLatest: string | undefined; + if (b2cVersion && latestCliVersion) { + b2cCliOutdated = compareSemver(b2cVersion, latestCliVersion) < 0; + b2cCliLatest = latestCliVersion; + } + + return { + node: { + name: 'node', + installed: !!nodeVersion, + version: nodeVersion, + label: 'Node.js', + }, + npm: { + name: 'npm', + installed: !!npmVersion, + version: npmVersion, + label: 'npm', + }, + homebrew: { + name: 'homebrew', + installed: !!brewVersion, + version: brewVersion, + label: 'Homebrew', + }, + npx: { + name: 'npx', + installed: !!npxVersion, + version: npxVersion, + label: 'npx', + }, + b2cCli: { + name: 'b2c-cli', + installed: !!b2cVersion, + version: b2cVersion, + label: 'B2C CLI', + }, + b2cCliLatest: b2cCliLatest, + b2cCliOutdated: b2cCliOutdated, + }; +} + +function toolRowHtml(tool: ToolStatus, note?: string): string { + if (tool.installed) { + const extra = note ? `${note}` : ''; + return [ + `
    `, + ``, + `${tool.label}`, + `v${tool.version}`, + extra, + `
    `, + ].join(''); + } + const extra = note ? `${note}` : ''; + return [ + `
    `, + ``, + `${tool.label}`, + `not found`, + extra, + `
    `, + ].join(''); +} + +/** + * Generates styled HTML for the install-cli step. This bypasses the markdown + * renderer to allow colored status indicators and version badges. + */ +export function generateInstallCliHtml(result: ToolDetectionResult): string { + const parts: string[] = []; + + // Scoped styles for tool detection UI + parts.push(``); + + // Intro (title is already shown in the step header — skip h1 to avoid duplication) + parts.push( + `

    The B2C CLI (b2c) drives deploys, log tailing, sandbox management, and more from the terminal. The VS Code extension uses it under the hood for some commands.

    `, + ); + parts.push( + `

    Optional. You can use the extension's Cartridges, WebDAV, and Sandbox views without the CLI. Install it when you want to script the same operations from the terminal or CI.

    `, + ); + + // Prerequisites grid + parts.push(`

    Prerequisites

    `); + parts.push(`
    `); + parts.push(toolRowHtml(result.node, result.node.installed ? undefined : 'required, v22.0.0+')); + parts.push(toolRowHtml(result.npm, result.npm.installed ? 'for global install' : undefined)); + parts.push(toolRowHtml(result.npx, result.npx.installed ? 'for one-off runs' : undefined)); + parts.push(toolRowHtml(result.homebrew, result.homebrew.installed ? 'alt install method' : 'optional')); + parts.push(`
    `); + + // B2C CLI status + parts.push(`

    B2C CLI

    `); + + if (result.b2cCli.installed) { + const ver = result.b2cCli.version ?? 'unknown'; + if (result.b2cCliOutdated && result.b2cCliLatest) { + parts.push(`
    `); + parts.push(`Update available`); + parts.push( + `

    Installed: ${ver} → Latest: ${result.b2cCliLatest}

    `, + ); + parts.push(`

    Run the Update CLI action above to upgrade.

    `); + parts.push(`
    `); + } else { + parts.push(`
    `); + parts.push(`✔ Installed & up to date`); + parts.push(`

    ${ver}${result.b2cCliLatest ? ' (latest)' : ''}

    `); + parts.push( + `

    The CLI is on your PATH and ready to use. Move to the next step or run b2c --version in the terminal to confirm.

    `, + ); + parts.push(`
    `); + } + } else { + parts.push(`
    `); + parts.push(`✗ Not found on PATH`); + parts.push(`

    Install using one of the methods below, then click Re-check above.

    `); + parts.push(`
    `); + + parts.push(`

    Install

    `); + parts.push(`

    Pick whichever fits your toolchain:

    `); + parts.push(`
      `); + parts.push(`
    • npmnpm install -g @salesforce/b2c-cli
    • `); + parts.push( + `
    • Homebrewbrew install salesforcecommercecloud/tools/b2c-cli
    • `, + ); + parts.push(`
    • npx (no install)npx @salesforce/b2c-cli --help
    • `); + parts.push(`
    `); + parts.push(`

    After installing, click Re-check above to confirm detection.

    `); + } + + // What it unlocks + parts.push(`

    What it unlocks

    `); + parts.push(`
      `); + parts.push(`
    • b2c code:deploy — same flow the Cartridges view uses, scriptable from CI.
    • `); + parts.push(`
    • b2c sandbox:* — create/start/stop/delete sandboxes from the terminal.
    • `); + parts.push(`
    • b2c log:tail — stream instance logs.
    • `); + parts.push(`
    • b2c auth:* — non-interactive OAuth client login for pipelines.
    • `); + parts.push(`
    `); + + // Troubleshooting + parts.push(`

    Troubleshooting

    `); + parts.push(`
      `); + parts.push( + `
    • Command not found after npm install -g — your global npm prefix isn't on PATH. Run npm config get prefix and add <prefix>/bin to PATH.
    • `, + ); + parts.push( + `
    • EACCES on install — use a Node version manager (nvm, fnm, volta) instead of sudo npm. Avoid sudo.
    • `, + ); + parts.push( + `
    • Old version behaves oddly — run Update CLI (or npm install -g @salesforce/b2c-cli@latest) to upgrade.
    • `, + ); + parts.push(`
    `); + + parts.push( + `

    Full installation guide on the docs site

    `, + ); + + return parts.join('\n'); +} diff --git a/packages/b2c-vs-extension/src/walkthrough/validator.ts b/packages/b2c-vs-extension/src/walkthrough/validator.ts new file mode 100644 index 000000000..bac4dbe11 --- /dev/null +++ b/packages/b2c-vs-extension/src/walkthrough/validator.ts @@ -0,0 +1,348 @@ +/* + * Copyright (c) 2025, Salesforce, Inc. + * SPDX-License-Identifier: Apache-2 + * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0 + */ + +import * as vscode from 'vscode'; +import * as fs from 'fs/promises'; +import * as path from 'path'; + +/** + * Validation utilities for walkthrough configuration. + * Ensures package.json walkthrough configuration is correct. + */ + +interface ValidationResult { + valid: boolean; + errors: string[]; + warnings: string[]; + info: string[]; +} + +interface WalkthroughConfig { + id?: string; + title?: string; + description?: string; + steps?: StepConfig[]; + [key: string]: unknown; +} + +type ThemedImage = {light?: string; dark?: string; hc?: string; hcLight?: string}; + +interface StepConfig { + id?: string; + title?: string; + description?: string; + media?: { + markdown?: string; + image?: string | ThemedImage; + svg?: string; + altText?: string; + [key: string]: unknown; + }; + completionEvents?: string[]; + [key: string]: unknown; +} + +interface PackageJsonConfig { + contributes?: { + walkthroughs?: WalkthroughConfig[]; + commands?: Array<{id?: string; title?: string; [key: string]: unknown}>; + [key: string]: unknown; + }; + [key: string]: unknown; +} + +/** + * Validate walkthrough configuration in package.json + */ +export async function validateWalkthroughConfiguration(extensionPath: string): Promise { + const result: ValidationResult = { + valid: true, + errors: [], + warnings: [], + info: [], + }; + + try { + // Read package.json + const packageJsonPath = path.join(extensionPath, 'package.json'); + const packageJsonContent = await fs.readFile(packageJsonPath, 'utf-8'); + const packageJson = JSON.parse(packageJsonContent); + + // Check if walkthroughs exist + if (!packageJson.contributes?.walkthroughs) { + result.valid = false; + result.errors.push('No walkthroughs defined in package.json'); + return result; + } + + const walkthroughs = packageJson.contributes.walkthroughs; + + // Validate each walkthrough + for (const walkthrough of walkthroughs) { + await validateWalkthrough(walkthrough, extensionPath, result); + } + + // Validate commands exist + await validateCommands(packageJson, result); + } catch (error) { + result.valid = false; + const message = error instanceof Error ? error.message : String(error); + result.errors.push(`Failed to validate: ${message}`); + } + + return result; +} + +/** + * Validate individual walkthrough + */ +async function validateWalkthrough( + walkthrough: WalkthroughConfig, + extensionPath: string, + result: ValidationResult, +): Promise { + const walkthroughId = walkthrough.id || 'unknown'; + + // Check required fields + if (!walkthrough.id) { + result.errors.push('Walkthrough missing required field: id'); + result.valid = false; + } + + if (!walkthrough.title) { + result.errors.push(`Walkthrough "${walkthroughId}" missing required field: title`); + result.valid = false; + } + + if (!walkthrough.description) { + result.warnings.push(`Walkthrough "${walkthroughId}" missing description`); + } + + // Check steps + if (!walkthrough.steps || walkthrough.steps.length === 0) { + result.errors.push(`Walkthrough "${walkthroughId}" has no steps`); + result.valid = false; + return; + } + + result.info.push(`Walkthrough "${walkthroughId}" has ${walkthrough.steps.length} steps`); + + // Validate each step + for (let i = 0; i < walkthrough.steps.length; i++) { + const step = walkthrough.steps[i]; + await validateStep(step, i + 1, walkthroughId, extensionPath, result); + } +} + +/** + * Validate individual step + */ +async function validateStep( + step: StepConfig, + stepNumber: number, + walkthroughId: string, + extensionPath: string, + result: ValidationResult, +): Promise { + const stepId = step.id || `step-${stepNumber}`; + + // Check required fields + if (!step.id) { + result.errors.push(`Step ${stepNumber} in "${walkthroughId}" missing id`); + result.valid = false; + } + + if (!step.title) { + result.errors.push(`Step "${stepId}" missing title`); + result.valid = false; + } + + if (!step.description) { + result.warnings.push(`Step "${stepId}" missing description`); + } + + // Check media + if (!step.media) { + result.warnings.push(`Step "${stepId}" has no media (markdown or image)`); + } else { + // Validate media files exist + if (step.media.markdown) { + const mediaPath = path.join(extensionPath, step.media.markdown); + try { + await fs.access(mediaPath); + result.info.push(`✓ Step "${stepId}": markdown file exists`); + } catch { + result.errors.push(`Step "${stepId}": markdown file not found: ${step.media.markdown}`); + result.valid = false; + } + } + + if (step.media.image) { + const imagePaths = + typeof step.media.image === 'string' + ? [step.media.image] + : Object.values(step.media.image).filter((v): v is string => typeof v === 'string'); + for (const rel of imagePaths) { + const imagePath = path.join(extensionPath, rel); + try { + await fs.access(imagePath); + result.info.push(`✓ Step "${stepId}": image file exists (${rel})`); + } catch { + result.warnings.push(`Step "${stepId}": image file not found: ${rel}`); + } + } + if (!step.media.altText) { + result.warnings.push(`Step "${stepId}": image has no altText (accessibility issue)`); + } + } + + if (step.media.svg) { + const svgPath = path.join(extensionPath, step.media.svg); + try { + await fs.access(svgPath); + result.info.push(`✓ Step "${stepId}": svg file exists`); + if (!step.media.altText) { + result.warnings.push(`Step "${stepId}": svg has no altText (accessibility issue)`); + } + } catch { + result.errors.push(`Step "${stepId}": svg file not found: ${step.media.svg}`); + result.valid = false; + } + } + } + + // Validate completion events + if (step.completionEvents && step.completionEvents.length > 0) { + result.info.push(`Step "${stepId}" has ${step.completionEvents.length} completion event(s)`); + + for (const event of step.completionEvents) { + validateCompletionEvent(event, stepId, result); + } + } else { + result.info.push(`Step "${stepId}" has no completion events (manual completion)`); + } + + // Check description for command links + if (step.description) { + const commandLinks = step.description.match(/command:[\w.-]+/g) || []; + if (commandLinks.length > 0) { + result.info.push(`Step "${stepId}" has ${commandLinks.length} command link(s)`); + } + } +} + +/** + * Validate completion event syntax + */ +function validateCompletionEvent(event: string, stepId: string, result: ValidationResult): void { + const validPrefixes = ['onCommand:', 'onView:', 'onContext:', 'onLink:']; + const hasValidPrefix = validPrefixes.some((prefix) => event.startsWith(prefix)); + + if (!hasValidPrefix) { + result.warnings.push( + `Step "${stepId}": completion event "${event}" doesn't use recognized prefix (${validPrefixes.join(', ')})`, + ); + } + + // Check specific event types + if (event.startsWith('onCommand:')) { + const commandId = event.substring('onCommand:'.length); + result.info.push(`Step "${stepId}" completes on command: ${commandId}`); + } else if (event.startsWith('onView:')) { + const viewId = event.substring('onView:'.length); + result.info.push(`Step "${stepId}" completes on view open: ${viewId}`); + } else if (event.startsWith('onContext:')) { + const contextKey = event.substring('onContext:'.length); + result.info.push(`Step "${stepId}" completes on context: ${contextKey}`); + } +} + +/** + * Validate walkthrough commands are registered + */ +async function validateCommands(packageJson: PackageJsonConfig, result: ValidationResult): Promise { + const commands = packageJson.contributes?.commands || []; + const commandIds = commands.map((cmd) => cmd.id); + + const expectedCommands = [ + 'b2c-dx.walkthrough.open', + 'b2c-dx.walkthrough.createDwJson', + 'b2c-dx.walkthrough.markAllDone', + 'b2c-dx.cli.verify', + 'b2c-dx.cli.update', + 'b2c-dx.walkthrough.chooseCredentialStorage', + 'b2c-dx.walkthrough.inspectSetup', + 'b2c-dx.setup.connection', + 'b2c-dx.setup.oauth', + 'b2c-dx.setup.webdav', + 'b2c-dx.setup.scapi', + 'b2c-dx.setup.resetSession', + ]; + + for (const expectedCommand of expectedCommands) { + if (commandIds.includes(expectedCommand)) { + result.info.push(`✓ Command registered: ${expectedCommand}`); + } else { + result.errors.push(`Command not registered: ${expectedCommand}`); + result.valid = false; + } + } +} + +/** + * Format validation result for display + */ +export function formatValidationResult(result: ValidationResult): string { + const lines: string[] = ['=== Walkthrough Configuration Validation ===', '']; + + if (result.valid) { + lines.push('✅ Configuration is valid!'); + } else { + lines.push('❌ Configuration has errors'); + } + + lines.push(''); + + if (result.errors.length > 0) { + lines.push('Errors:'); + result.errors.forEach((error) => lines.push(` ❌ ${error}`)); + lines.push(''); + } + + if (result.warnings.length > 0) { + lines.push('Warnings:'); + result.warnings.forEach((warning) => lines.push(` ⚠️ ${warning}`)); + lines.push(''); + } + + if (result.info.length > 0) { + lines.push('Info:'); + result.info.forEach((info) => lines.push(` ℹ️ ${info}`)); + } + + return lines.join('\n'); +} + +/** + * VS Code command to validate walkthrough configuration + */ +export async function validateWalkthroughCommand(extensionPath: string, log: vscode.OutputChannel): Promise { + log.appendLine('Validating walkthrough configuration...'); + + const result = await validateWalkthroughConfiguration(extensionPath); + const report = formatValidationResult(result); + + log.appendLine(report); + log.show(); + + if (result.valid) { + vscode.window.showInformationMessage('✅ Walkthrough configuration is valid!'); + } else { + vscode.window.showErrorMessage( + `Walkthrough configuration has ${result.errors.length} error(s). Check Output > B2C DX for details.`, + ); + } +} diff --git a/packages/b2c-vs-extension/test-workspace/.gitignore b/packages/b2c-vs-extension/test-workspace/.gitignore new file mode 100644 index 000000000..e612aa018 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/.gitignore @@ -0,0 +1,17 @@ +# B2C Commerce credentials +dw.json + +# Node modules +node_modules/ + +# Build artifacts +dist/ +*.zip + +# IDE +.vscode/ +.idea/ + +# OS +.DS_Store +Thumbs.db diff --git a/packages/b2c-vs-extension/test-workspace/README.md b/packages/b2c-vs-extension/test-workspace/README.md new file mode 100644 index 000000000..23c07dc25 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/README.md @@ -0,0 +1,99 @@ +# B2C DX Extension Test Workspace + +This directory serves as a sample B2C Commerce project for testing the extension and walkthrough features. + +## Purpose + +Testing the B2C DX extension requires a workspace with: +- Proper cartridge structure (`.project` files) +- Configuration files (`dw.json`) +- Typical B2C Commerce project layout + +## Usage + +### Option 1: Use This Test Workspace + +```bash +# From the extension directory +cd packages/b2c-vs-extension + +# Open the test workspace in Extension Development Host +code test-workspace --extensionDevelopmentPath=$(pwd) +``` + +### Option 2: From VS Code + +1. Build the extension: `pnpm run build` +2. Press **F5** to launch Extension Development Host +3. In the new window: **File → Open Folder** +4. Navigate to: `packages/b2c-vs-extension/test-workspace` +5. Click **Open** + +### Option 3: Add to launch.json + +The `.vscode/launch.json` is already configured to open this workspace automatically. + +## What's Included + +``` +test-workspace/ +├── README.md (this file) +├── .gitignore (ignores dw.json) +├── cartridges/ (sample cartridges) +│ ├── app_storefront_base/ +│ │ ├── .project +│ │ └── cartridge/ +│ └── int_custom/ +│ ├── .project +│ └── cartridge/ +└── package.json (project metadata) +``` + +## Testing Scenarios + +### Test 1: Fresh Project (No dw.json) +1. Delete `dw.json` if it exists +2. Reload extension +3. Should trigger first-time welcome prompt +4. Click "Create dw.json Template" +5. Verify dw.json is created + +### Test 2: Existing Project (With dw.json) +1. Keep existing `dw.json` +2. Reload extension +3. Walkthrough Step 2 should auto-complete +4. Cartridges should be detected + +### Test 3: Cartridge Detection +1. Open **Cartridges** view +2. Should show 2 cartridges: + - app_storefront_base + - int_custom + +## Updating Configuration + +Edit `dw.json` with your actual B2C instance credentials: + +```json +{ + "hostname": "your-sandbox.demandware.net", + "username": "your-username", + "password": "your-password", + "version": "v1" +} +``` + +**Remember:** Never commit real credentials to Git! + +## Cleanup + +To reset the test workspace: + +```bash +# Remove generated files +rm dw.json +rm .gitignore + +# Or use the cleanup script +./cleanup.sh +``` diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/.project b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/.project new file mode 100644 index 000000000..0c543e3b1 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/.project @@ -0,0 +1,15 @@ + + + app_storefront_base + + + + + com.demandware.studio.core.beehiveElementBuilder + + + + + com.demandware.studio.core.beehiveNature + + diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/controllers/Home.js b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/controllers/Home.js new file mode 100644 index 000000000..9ed436510 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/controllers/Home.js @@ -0,0 +1,21 @@ +'use strict'; + +/** + * Home page controller + */ + +var server = require('server'); + +server.get('Show', function (req, res, next) { + var Site = require('dw/system/Site'); + var URLUtils = require('dw/web/URLUtils'); + + res.render('home/homepage', { + site: Site.current.name, + homeUrl: URLUtils.home().toString(), + }); + + next(); +}); + +module.exports = server.exports(); diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/scripts/helpers/productHelper.js b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/scripts/helpers/productHelper.js new file mode 100644 index 000000000..9790252d4 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/scripts/helpers/productHelper.js @@ -0,0 +1,22 @@ +'use strict'; + +/** + * Product helper functions + */ + +/** + * Get product availability + * @param {dw.catalog.Product} product - Product object + * @returns {Object} Availability object + */ +function getAvailability(product) { + return { + available: product.availabilityModel.availability > 0, + inStock: product.availabilityModel.inStock, + levels: product.availabilityModel.inventoryRecord.ATS.value, + }; +} + +module.exports = { + getAvailability: getAvailability, +}; diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/static/default/css/main.css b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/static/default/css/main.css new file mode 100644 index 000000000..a8237d884 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/app_storefront_base/cartridge/static/default/css/main.css @@ -0,0 +1,27 @@ +/* Main stylesheet for B2C storefront */ + +body { + font-family: Arial, sans-serif; + margin: 0; + padding: 0; + background-color: #f5f5f5; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 20px; +} + +header { + background-color: #333; + color: white; + padding: 1rem; +} + +.product-tile { + border: 1px solid #ddd; + padding: 15px; + margin: 10px; + background: white; +} diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/.project b/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/.project new file mode 100644 index 000000000..c1490eae8 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/.project @@ -0,0 +1,15 @@ + + + int_custom + + + + + com.demandware.studio.core.beehiveElementBuilder + + + + + com.demandware.studio.core.beehiveNature + + diff --git a/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/cartridge/scripts/integration/customService.js b/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/cartridge/scripts/integration/customService.js new file mode 100644 index 000000000..f50705dc1 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/cartridges/int_custom/cartridge/scripts/integration/customService.js @@ -0,0 +1,27 @@ +'use strict'; + +/** + * Custom integration service + */ + +var LocalServiceRegistry = require('dw/svc/LocalServiceRegistry'); + +/** + * Initialize custom service + * @returns {dw.svc.Service} Service instance + */ +function getService() { + return LocalServiceRegistry.createService('custom.http.service', { + createRequest: function (svc, params) { + svc.setRequestMethod('GET'); + return params; + }, + parseResponse: function (svc, httpClient) { + return JSON.parse(httpClient.text); + }, + }); +} + +module.exports = { + getService: getService, +}; diff --git a/packages/b2c-vs-extension/test-workspace/package.json b/packages/b2c-vs-extension/test-workspace/package.json new file mode 100644 index 000000000..907cd8e14 --- /dev/null +++ b/packages/b2c-vs-extension/test-workspace/package.json @@ -0,0 +1,12 @@ +{ + "name": "b2c-test-workspace", + "version": "1.0.0", + "description": "Test workspace for B2C DX VS Code Extension", + "private": true, + "scripts": { + "test": "echo \"Test workspace - no scripts needed\"" + }, + "keywords": ["b2c", "commerce", "test"], + "author": "Salesforce", + "license": "Apache-2.0" +} From 580200e41c45251e26e1a29bd825cc63266274ca Mon Sep 17 00:00:00 2001 From: CharithaT07 Date: Mon, 8 Jun 2026 19:16:52 +0530 Subject: [PATCH 05/13] @W-22653715 adding doc browser in vs extension --- .changeset/docs-browser-vs-extension.md | 10 + .github/workflows/ci-vs-extension.yml | 10 + docs/.vitepress/config.mts | 1 + docs/vscode-extension/docs-browser.md | 88 + packages/b2c-vs-extension/.gitattributes | 1 + packages/b2c-vs-extension/.vscodeignore | 1 + packages/b2c-vs-extension/README.md | 1 + packages/b2c-vs-extension/package.json | 75 +- .../resources/docs/bm-search.json | 202 + .../b2c-vs-extension/resources/docs/bm.json | 278 + .../resources/docs/isml-search.json | 266 + .../b2c-vs-extension/resources/docs/isml.json | 762 + .../resources/docs/manifest.json | 13 + .../resources/docs/script-api-search.json | 104374 +++++++ .../resources/docs/script-api.json | 217337 +++++++++++++++ .../scripts/build-docs-index/README.md | 53 + .../bm-topics/code-deployment.md | 43 + .../bm-topics/custom-attributes.md | 66 + .../build-docs-index/bm-topics/hooks.md | 45 + .../build-docs-index/bm-topics/jobs.md | 63 + .../build-docs-index/bm-topics/replication.md | 40 + .../bm-topics/scapi-shopper-roles.md | 46 + .../build-docs-index/bm-topics/services.md | 55 + .../bm-topics/site-preferences.md | 45 + .../scripts/build-docs-index/build-bm.mjs | 249 + .../scripts/build-docs-index/build-isml.mjs | 139 + .../build-docs-index/build-script-api.mjs | 541 + .../scripts/build-docs-index/isml-tags.json | 275 + .../scripts/build-docs-index/run.mjs | 165 + .../scripts/build-docs-index/schema.mjs | 147 + .../src/docs-browser/docs-entry-renderer.ts | 160 + .../src/docs-browser/docs-index.ts | 300 + .../src/docs-browser/docs-recents.ts | 52 + .../src/docs-browser/docs-search.ts | 116 + .../src/docs-browser/docs-tree-provider.ts | 262 + .../src/docs-browser/docs-webview.html | 479 + .../src/docs-browser/docs-webview.ts | 254 + .../src/docs-browser/index.ts | 251 + .../src/docs-browser/markdown.ts | 157 + .../src/docs-browser/symbol-resolver.ts | 70 + .../src/docs-browser/types.ts | 111 + packages/b2c-vs-extension/src/extension.ts | 5 + packages/b2c-vs-extension/src/isml/index.ts | 7 + packages/b2c-vs-extension/src/safety.ts | 1 + packages/b2c-vs-extension/src/telemetry.ts | 3 +- .../src/test/docs-browser.test.ts | 740 + pnpm-lock.yaml | 10 +- pnpm-workspace.yaml | 1 + 48 files changed, 328366 insertions(+), 4 deletions(-) create mode 100644 .changeset/docs-browser-vs-extension.md create mode 100644 docs/vscode-extension/docs-browser.md create mode 100644 packages/b2c-vs-extension/.gitattributes create mode 100644 packages/b2c-vs-extension/resources/docs/bm-search.json create mode 100644 packages/b2c-vs-extension/resources/docs/bm.json create mode 100644 packages/b2c-vs-extension/resources/docs/isml-search.json create mode 100644 packages/b2c-vs-extension/resources/docs/isml.json create mode 100644 packages/b2c-vs-extension/resources/docs/manifest.json create mode 100644 packages/b2c-vs-extension/resources/docs/script-api-search.json create mode 100644 packages/b2c-vs-extension/resources/docs/script-api.json create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/README.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/code-deployment.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/custom-attributes.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/hooks.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/jobs.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/replication.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/scapi-shopper-roles.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/services.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/bm-topics/site-preferences.md create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/build-bm.mjs create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/build-isml.mjs create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/build-script-api.mjs create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/isml-tags.json create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/run.mjs create mode 100644 packages/b2c-vs-extension/scripts/build-docs-index/schema.mjs create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-entry-renderer.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-index.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-recents.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-search.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-tree-provider.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-webview.html create mode 100644 packages/b2c-vs-extension/src/docs-browser/docs-webview.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/index.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/markdown.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/symbol-resolver.ts create mode 100644 packages/b2c-vs-extension/src/docs-browser/types.ts create mode 100644 packages/b2c-vs-extension/src/test/docs-browser.test.ts diff --git a/.changeset/docs-browser-vs-extension.md b/.changeset/docs-browser-vs-extension.md new file mode 100644 index 000000000..f0f96a6c9 --- /dev/null +++ b/.changeset/docs-browser-vs-extension.md @@ -0,0 +1,10 @@ +--- +'b2c-vs-extension': minor +--- + +Add Docs Browser: an offline-first, in-editor reference for SFCC Script API +(~8.6k entries from `@salesforce/b2c-script-types`), ISML tags, and curated +Business Manager topics. Search from the new **Docs** sidebar or panel, +right-click any `dw.*` symbol or ISML tag in the editor to **View B2C Docs**, +and revisit recently opened entries. Disable with +`b2c-dx.features.docsBrowser`. diff --git a/.github/workflows/ci-vs-extension.yml b/.github/workflows/ci-vs-extension.yml index c3f1acbd0..2e6e60385 100644 --- a/.github/workflows/ci-vs-extension.yml +++ b/.github/workflows/ci-vs-extension.yml @@ -73,6 +73,16 @@ jobs: - name: Build packages run: pnpm -r run build + - name: Verify docs index is up to date + working-directory: packages/b2c-vs-extension + run: | + pnpm run build:docs-index + if [[ -n "$(git status --porcelain resources/docs/)" ]]; then + echo "::error::Committed docs index is stale. Run 'pnpm --filter b2c-vs-extension run build:docs-index' and commit the result." + git --no-pager diff --stat resources/docs/ + exit 1 + fi + - name: Run VS Extension tests working-directory: packages/b2c-vs-extension run: xvfb-run -a pnpm run test diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 78eaa41e6..164c235d3 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -82,6 +82,7 @@ const guidesSidebar = [ {text: 'Overview', link: '/vscode-extension/'}, {text: 'Installation', link: '/vscode-extension/installation'}, {text: 'Configuration', link: '/vscode-extension/configuration'}, + {text: 'Docs Browser', link: '/vscode-extension/docs-browser'}, ], }, { diff --git a/docs/vscode-extension/docs-browser.md b/docs/vscode-extension/docs-browser.md new file mode 100644 index 000000000..c004bc211 --- /dev/null +++ b/docs/vscode-extension/docs-browser.md @@ -0,0 +1,88 @@ +--- +description: B2C DX Docs Browser — search SFCC Script API, ISML tags, and Business Manager topics from inside VS Code without losing flow. +--- + +# Docs Browser + +The Docs Browser is an in-editor reference for the **SFCC Script API**, **ISML +tags**, and curated **Business Manager** topics. It is offline-first — the +index ships with the extension, so it keeps working without network access. + +## Why + +You write cartridge code with `dw.*` calls, ISML tags, and references to BM +configuration all day. The Docs Browser lets you look any of them up without +switching to a browser, navigating the official documentation, and losing your +place. Pair it with the bundled [Script API +IntelliSense](./index#script-api-intellisense) and you have completion, +parameter info, and reference in one editor. + +## Getting started + +1. Open the **B2C-DX** activity bar. +2. Expand the **Docs** view. +3. Click an entry to open the themed reader panel beside your code. + +[![Docs Browser sidebar](./images/docs-browser-tree.png)](./images/docs-browser-tree.png) + +The reader panel shows the signature, parameters, return type, throws, examples, +and prose. Code blocks and tables follow your VS Code theme. + +## Searching + +- **Sidebar title bar** → click the **Search Docs** ($(search)) icon for a + ranked quick-pick across all sources. The picker is keyboard-only friendly: + type, arrow-keys, Enter. +- **Inside the panel** → use the search box at the top of the panel for the + same ranked search, with a result list that updates as you type. + +The picker boosts exact matches (`dw.order.BasketMgr`) over substring matches +(`getCurrent`) and treats dot/slash forms (`dw.order.BasketMgr` vs +`dw/order/BasketMgr`) as the same target. + +## Right-click → View B2C Docs + +Place the cursor on a `dw.*` symbol or an ISML tag and: + +- **Editor right-click → View B2C Docs** opens the matching entry directly. +- **Command Palette → B2C DX - Docs: View B2C Docs** does the same. +- **ISML hover** includes an **Open in B2C Docs Browser** link below the + syntax/tips. + +If the symbol can't be resolved exactly (e.g. a renamed or shortened qualifier +in hover output), the Docs Browser falls back to opening the search picker +prefilled with the best candidate so you're one keystroke away from the right +entry. + +## What is indexed + +| Source | Items | Source of truth | +| --- | --- | --- | +| SFCC Script API (`dw.*`) | ~8.6k entries — every class, interface, enum, method, property, constant. | `@salesforce/b2c-script-types` `.d.ts` JSDoc | +| ISML Tags | The standard ISML tag set with attribute tables and tips. | Curated dataset in the extension repo | +| Business Manager Topics | High-traffic Merchant Tools topics: Site Preferences, Code Deployment, Jobs, Service Framework, Hooks, Custom Attributes, Replication, SCAPI/OCAPI Shopper Roles. | Curated Markdown in the extension repo | + +The header shows the version of each index — **Script API v26.7.0**, the ISML +dataset version, and a content-derived hash for the Business Manager topics. + +## Recently viewed + +The Docs Browser remembers the last 10 entries you opened. They appear: + +- In the panel's empty state when no entry is selected. +- At the top of the search picker before you type a query. + +History is stored in VS Code global state — it survives restarts and follows +your VS Code profile across workspaces. + +## Settings + +| Setting | Default | What it does | +| --- | --- | --- | +| `b2c-dx.features.docsBrowser` | `true` | Enable or disable the Docs Browser entirely. Disabling hides the sidebar, commands, and editor menu entry. | + +## Offline behavior + +The index is bundled with the extension's VSIX. The Docs Browser performs no +network requests. After install you can keep using it on a plane, in air-gapped +environments, or while the documentation site is unreachable. diff --git a/packages/b2c-vs-extension/.gitattributes b/packages/b2c-vs-extension/.gitattributes new file mode 100644 index 000000000..3a42c65cf --- /dev/null +++ b/packages/b2c-vs-extension/.gitattributes @@ -0,0 +1 @@ +resources/docs/*.json linguist-generated=true diff --git a/packages/b2c-vs-extension/.vscodeignore b/packages/b2c-vs-extension/.vscodeignore index 5e57d6283..749306e3a 100644 --- a/packages/b2c-vs-extension/.vscodeignore +++ b/packages/b2c-vs-extension/.vscodeignore @@ -3,6 +3,7 @@ src/** !src/webview.html !src/api-browser/swagger-webview.html +!src/docs-browser/docs-webview.html !src/storefront-next-cartridge.html !src/scapi-explorer.html !src/ods-management.html diff --git a/packages/b2c-vs-extension/README.md b/packages/b2c-vs-extension/README.md index d91531cc4..8bdb839da 100644 --- a/packages/b2c-vs-extension/README.md +++ b/packages/b2c-vs-extension/README.md @@ -19,6 +19,7 @@ This README is the source of truth for repo-level developer info (build/watch, l - Page Designer Assistant webview (Storefront Next page generation). - B2C-DX Analytics — CIP/CCAC Query Builder, Tables Browser, curated reports, multi-realm support, saved-query library. - ISML language support — syntax highlighting, language configuration (comments, brackets, auto-close), snippets, automatic closing-tag insertion, and Emmet support for `.isml` files. +- Docs Browser — offline-first sidebar+panel for SFCC Script API, ISML tags, and curated Business Manager topics; right-click any `dw.*` symbol or ISML tag to jump to its docs. See the [docs site](https://salesforcecommercecloud.github.io/b2c-developer-tooling/vscode-extension/features) for the full tour. diff --git a/packages/b2c-vs-extension/package.json b/packages/b2c-vs-extension/package.json index c76b1fdca..11aaa2ddb 100644 --- a/packages/b2c-vs-extension/package.json +++ b/packages/b2c-vs-extension/package.json @@ -35,6 +35,7 @@ "onView:b2cApiBrowser", "onView:b2cSandboxExplorer", "onView:b2cCartridgeExplorer", + "onView:b2cDocsBrowser", "onDebugResolve:b2c-script", "workspaceContains:**/commerce-app.json" ], @@ -730,6 +731,11 @@ "type": "boolean", "default": true, "description": "Enable the B2C-DX Analytics (CIP) sidebar for browsing tables and running curated reports." + }, + "b2c-dx.features.docsBrowser": { + "type": "boolean", + "default": true, + "description": "Enable the in-editor Docs Browser for SFCC Script API, ISML, and Business Manager documentation." } } }, @@ -782,6 +788,12 @@ "name": "Cartridges", "icon": "media/b2c-icon.svg", "contextualTitle": "B2C-DX" + }, + { + "id": "b2cDocsBrowser", + "name": "Docs", + "icon": "media/b2c-icon.svg", + "contextualTitle": "B2C-DX" } ], "b2c-dx-analytics": [ @@ -832,6 +844,10 @@ { "view": "b2cCipAnalytics", "contents": "Explore Commerce Intelligence Platform (CIP) data — build SQL queries visually, browse tables, and run curated reports.\n\n[Open Query Builder](command:b2c-dx.cipAnalytics.queryBuilder)\n[Browse Tables](command:b2c-dx.cipAnalytics.browseTables)\n\nRequires OAuth credentials (clientId, clientSecret) in dw.json.\n\n[Refresh](command:b2c-dx.cipAnalytics.refresh)" + }, + { + "view": "b2cDocsBrowser", + "contents": "Docs index not built.\n\nRun `pnpm --filter b2c-vs-extension run build:docs-index` from the repo root, then refresh.\n\n[Refresh](command:b2c-dx.docs.refresh)" } ], "debuggers": [ @@ -1322,6 +1338,28 @@ "command": "b2c-dx.isml.showReferences", "title": "Show ISML References", "category": "B2C DX - ISML" + }, + { + "command": "b2c-dx.docs.search", + "title": "Search Docs", + "icon": "$(search)", + "category": "B2C DX - Docs" + }, + { + "command": "b2c-dx.docs.refresh", + "title": "Refresh", + "icon": "$(refresh)", + "category": "B2C DX - Docs" + }, + { + "command": "b2c-dx.docs.open", + "title": "Open Docs Entry", + "category": "B2C DX - Docs" + }, + { + "command": "b2c-dx.docs.viewSymbolDocs", + "title": "View B2C Docs", + "category": "B2C DX - Docs" } ], "menus": { @@ -1410,6 +1448,16 @@ "command": "b2c-dx.codeSync.activateCodeVersion", "when": "view == b2cCartridgeExplorer", "group": "1_versions" + }, + { + "command": "b2c-dx.docs.search", + "when": "view == b2cDocsBrowser", + "group": "navigation@0" + }, + { + "command": "b2c-dx.docs.refresh", + "when": "view == b2cDocsBrowser", + "group": "navigation@1" } ], "view/item/context": [ @@ -1601,6 +1649,13 @@ "when": "workspaceFolderCount > 0" } ], + "editor/context": [ + { + "command": "b2c-dx.docs.viewSymbolDocs", + "when": "config.b2c-dx.features.docsBrowser && (editorLangId == javascript || editorLangId == typescript || editorLangId == isml)", + "group": "navigation@9" + } + ], "explorer/context": [ { "command": "b2c-dx.webdav.download", @@ -1654,6 +1709,22 @@ "command": "b2c-dx.isml.showReferences", "when": "editorLangId == isml" }, + { + "command": "b2c-dx.docs.open", + "when": "false" + }, + { + "command": "b2c-dx.docs.search", + "when": "config.b2c-dx.features.docsBrowser" + }, + { + "command": "b2c-dx.docs.refresh", + "when": "config.b2c-dx.features.docsBrowser" + }, + { + "command": "b2c-dx.docs.viewSymbolDocs", + "when": "config.b2c-dx.features.docsBrowser && (editorLangId == javascript || editorLangId == typescript || editorLangId == isml)" + }, { "command": "b2c-dx.cipAnalytics.refresh", "when": "config.b2c-dx.features.cipAnalytics" @@ -1844,8 +1915,9 @@ "scripts": { "sync:xsd": "node scripts/sync-xsd.mjs", "build": "node scripts/esbuild-bundle.mjs", + "build:docs-index": "node scripts/build-docs-index/run.mjs", "watch": "node scripts/esbuild-bundle.mjs --watch", - "vscode:prepublish": "pnpm run typecheck:agent && pnpm --filter @salesforce/b2c-tooling-sdk run build && node scripts/esbuild-bundle.mjs", + "vscode:prepublish": "pnpm run typecheck:agent && pnpm --filter @salesforce/b2c-tooling-sdk run build && pnpm run build:docs-index && node scripts/esbuild-bundle.mjs", "package": "pnpm run build && pnpm exec vsce package --no-dependencies && node scripts/inject-script-types.mjs", "lint": "eslint", "lint:agent": "eslint --quiet", @@ -1875,6 +1947,7 @@ "eslint-plugin-header": "catalog:", "eslint-plugin-prettier": "catalog:", "prettier": "catalog:", + "ts-morph": "catalog:", "typescript": "catalog:", "typescript-eslint": "catalog:" } diff --git a/packages/b2c-vs-extension/resources/docs/bm-search.json b/packages/b2c-vs-extension/resources/docs/bm-search.json new file mode 100644 index 000000000..ce6146355 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/bm-search.json @@ -0,0 +1,202 @@ +[ + { + "id": "bm:category:api", + "kind": "topic", + "packagePath": "bm/api", + "qualifiedName": "bm.api", + "tags": [ + "api", + "api" + ], + "title": "Api" + }, + { + "id": "bm:category:configuration", + "kind": "topic", + "packagePath": "bm/configuration", + "qualifiedName": "bm.configuration", + "tags": [ + "configuration", + "configuration" + ], + "title": "Configuration" + }, + { + "id": "bm:category:data-model", + "kind": "topic", + "packagePath": "bm/data-model", + "qualifiedName": "bm.data-model", + "tags": [ + "data-model", + "data-model" + ], + "title": "Data Model" + }, + { + "id": "bm:category:deployment", + "kind": "topic", + "packagePath": "bm/deployment", + "qualifiedName": "bm.deployment", + "tags": [ + "deployment", + "deployment" + ], + "title": "Deployment" + }, + { + "id": "bm:category:integration", + "kind": "topic", + "packagePath": "bm/integration", + "qualifiedName": "bm.integration", + "tags": [ + "integration", + "integration" + ], + "title": "Integration" + }, + { + "id": "bm:category:scheduling", + "kind": "topic", + "packagePath": "bm/scheduling", + "qualifiedName": "bm.scheduling", + "tags": [ + "scheduling", + "scheduling" + ], + "title": "Scheduling" + }, + { + "id": "bm:code-deployment", + "kind": "topic", + "packagePath": "bm/deployment", + "parentId": "bm:category:deployment", + "qualifiedName": "bm.code-deployment", + "tags": [ + "code-deployment", + "code deployment", + "deployment", + "code", + "version", + "release" + ], + "title": "Code Deployment" + }, + { + "id": "bm:custom-attributes", + "kind": "topic", + "packagePath": "bm/data-model", + "parentId": "bm:category:data-model", + "qualifiedName": "bm.custom-attributes", + "tags": [ + "custom-attributes", + "custom attributes", + "data-model", + "custom", + "attribute", + "system-object", + "schema" + ], + "title": "Custom Attributes" + }, + { + "id": "bm:hooks", + "kind": "topic", + "packagePath": "bm/integration", + "parentId": "bm:category:integration", + "qualifiedName": "bm.hooks", + "tags": [ + "hooks", + "integration", + "hook", + "extension-point", + "ocapi", + "scapi", + "payment" + ], + "title": "Hooks" + }, + { + "id": "bm:jobs", + "kind": "topic", + "packagePath": "bm/scheduling", + "parentId": "bm:category:scheduling", + "qualifiedName": "bm.jobs", + "tags": [ + "jobs", + "scheduling", + "job", + "schedule", + "batch", + "import", + "export" + ], + "title": "Jobs" + }, + { + "id": "bm:replication", + "kind": "topic", + "packagePath": "bm/deployment", + "parentId": "bm:category:deployment", + "qualifiedName": "bm.replication", + "tags": [ + "replication", + "data replication", + "deployment", + "staging", + "production" + ], + "title": "Data Replication" + }, + { + "id": "bm:scapi-shopper-roles", + "kind": "topic", + "packagePath": "bm/api", + "parentId": "bm:category:api", + "qualifiedName": "bm.scapi-shopper-roles", + "tags": [ + "scapi-shopper-roles", + "scapi / ocapi shopper roles", + "api", + "scapi", + "ocapi", + "role", + "permission", + "oauth" + ], + "title": "SCAPI / OCAPI Shopper Roles" + }, + { + "id": "bm:services", + "kind": "topic", + "packagePath": "bm/integration", + "parentId": "bm:category:integration", + "qualifiedName": "bm.services", + "tags": [ + "services", + "service framework", + "integration", + "service", + "http", + "webservice", + "ftp", + "callout" + ], + "title": "Service Framework" + }, + { + "id": "bm:site-preferences", + "kind": "topic", + "packagePath": "bm/configuration", + "parentId": "bm:category:configuration", + "qualifiedName": "bm.site-preferences", + "tags": [ + "site-preferences", + "site preferences", + "configuration", + "preferences", + "site", + "custom" + ], + "title": "Site Preferences" + } +] diff --git a/packages/b2c-vs-extension/resources/docs/bm.json b/packages/b2c-vs-extension/resources/docs/bm.json new file mode 100644 index 000000000..91c117e17 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/bm.json @@ -0,0 +1,278 @@ +[ + { + "description": "1 topic", + "id": "bm:category:api", + "kind": "topic", + "packagePath": "bm/api", + "qualifiedName": "bm.api", + "source": "bm", + "tags": [ + "api", + "api" + ], + "title": "Api" + }, + { + "description": "1 topic", + "id": "bm:category:configuration", + "kind": "topic", + "packagePath": "bm/configuration", + "qualifiedName": "bm.configuration", + "source": "bm", + "tags": [ + "configuration", + "configuration" + ], + "title": "Configuration" + }, + { + "description": "1 topic", + "id": "bm:category:data-model", + "kind": "topic", + "packagePath": "bm/data-model", + "qualifiedName": "bm.data-model", + "source": "bm", + "tags": [ + "data-model", + "data-model" + ], + "title": "Data Model" + }, + { + "description": "2 topics", + "id": "bm:category:deployment", + "kind": "topic", + "packagePath": "bm/deployment", + "qualifiedName": "bm.deployment", + "source": "bm", + "tags": [ + "deployment", + "deployment" + ], + "title": "Deployment" + }, + { + "description": "2 topics", + "id": "bm:category:integration", + "kind": "topic", + "packagePath": "bm/integration", + "qualifiedName": "bm.integration", + "source": "bm", + "tags": [ + "integration", + "integration" + ], + "title": "Integration" + }, + { + "description": "1 topic", + "id": "bm:category:scheduling", + "kind": "topic", + "packagePath": "bm/scheduling", + "qualifiedName": "bm.scheduling", + "source": "bm", + "tags": [ + "scheduling", + "scheduling" + ], + "title": "Scheduling" + }, + { + "description": "Code on a B2C Commerce instance is grouped into **code versions**. Only one code version is active per instance; activating a different version is the release mechanism.", + "id": "bm:code-deployment", + "kind": "topic", + "packagePath": "bm/deployment", + "parentId": "bm:category:deployment", + "qualifiedName": "bm.code-deployment", + "sections": [ + { + "body": "Code on a B2C Commerce instance is grouped into **code versions**. Only one\ncode version is active per instance; activating a different version is the\nrelease mechanism.\n\n## Where to manage\n\n`Administration > Site Development > Code Deployment`\n\n## Typical flow\n\n1. Build cartridges locally or in CI.\n2. Upload to a new code version directory via WebDAV (`Cartridges//`).\n3. Activate the new code version once health checks pass.\n4. Keep the previous version available for fast rollback.\n\n## CLI shortcuts\n\nThe B2C CLI provides:\n\n```bash\nsf b2c code list-versions\nsf b2c code activate \nsf b2c code download \n```\n\nThe VS Code extension exposes the same actions in the Cartridges sidebar.\n\n## Tips\n\n- Name code versions like `version1_2026_05_01_a` so the active one sorts to\n the top of the list.\n- Keep at least 2 inactive code versions for safe rollback.\n- Code versions are **per-instance** — a sandbox, dev, staging, and production\n each have their own.\n- Activation is atomic on the storefront layer but not on the OCAPI layer —\n expect a few seconds of cache invalidation churn after activation.", + "heading": "Code Deployment" + } + ], + "source": "bm", + "tags": [ + "code-deployment", + "code deployment", + "deployment", + "code", + "version", + "release" + ], + "title": "Code Deployment" + }, + { + "description": "Every system object (Product, Customer, Order, Site, …) supports developer- defined custom attributes. They are the safe extension point for storing business-specific data.", + "id": "bm:custom-attributes", + "kind": "topic", + "packagePath": "bm/data-model", + "parentId": "bm:category:data-model", + "qualifiedName": "bm.custom-attributes", + "sections": [ + { + "body": "Every system object (Product, Customer, Order, Site, …) supports developer-\ndefined custom attributes. They are the safe extension point for storing\nbusiness-specific data.\n\n## Where to manage\n\n`Administration > Site Development > System Object Types > >\nAttribute Definitions`\n\n## Defining via metadata import\n\nProduction-grade workflow uses XML metadata files imported via Site Import:\n\n```xml\n\n \n \n Bundle Handling\n enum-of-string\n false\n false\n true\n 0\n \n \n Ship Together\n together\n \n \n Ship Separately\n separate\n \n \n \n \n\n```\n\n## Reading and writing from script\n\n```javascript\nvar product = ProductMgr.getProduct('SKU-123');\nvar handling = product.custom.bundleHandling;\n\nrequire('dw/system/Transaction').wrap(function () {\n product.custom.bundleHandling = 'separate';\n});\n```\n\nWrites must occur inside a `Transaction`.\n\n## Tips\n\n- Prefer **enum-of-string** with explicit values over free-text — limits churn\n and supports localization.\n- Check **searchable** and **system** flags carefully — they affect index\n behavior and BM visibility.\n- Custom attributes deploy via **site import**, the same as preferences and\n other metadata.", + "heading": "Custom Attributes" + } + ], + "source": "bm", + "tags": [ + "custom-attributes", + "custom attributes", + "data-model", + "custom", + "attribute", + "system-object", + "schema" + ], + "title": "Custom Attributes" + }, + { + "description": "Hooks are extension points that let cartridge scripts react to platform events or customize OCAPI/SCAPI behavior without modifying base controllers.", + "id": "bm:hooks", + "kind": "topic", + "packagePath": "bm/integration", + "parentId": "bm:category:integration", + "qualifiedName": "bm.hooks", + "sections": [ + { + "body": "Hooks are extension points that let cartridge scripts react to platform events\nor customize OCAPI/SCAPI behavior without modifying base controllers.\n\n## Declaring a hook\n\n```json\n// cartridge/package.json\n{ \"hooks\": \"./hooks.json\" }\n\n// cartridge/hooks.json\n{\n \"hooks\": [\n { \"name\": \"dw.order.calculate\", \"script\": \"./scripts/hooks/calculate\" },\n { \"name\": \"app.payment.processor.basic_credit.Authorize\", \"script\": \"./scripts/payment/basicCredit\" }\n ]\n}\n```\n\nThe `script` path is relative to `hooks.json`. The exported function is named\nto match the convention of the hook (often `function execute()` or\n`function modifyResponse()`).\n\n## Common hook namespaces\n\n- `dw.order.*` — basket calculation, validation, post-checkout side effects.\n- `dw.ocapi.shop.*` and `dw.scapi.shopper.*` — customize storefront APIs.\n- `dw.ocapi.data.*` — admin API customizations.\n- `app.payment.processor..*` — payment processor implementations.\n\n## Tips\n\n- Cartridge hook order follows the **cartridge path** — the first cartridge\n with a matching hook wins for `intercept` style hooks; `*.modify*` hooks\n chain in path order.\n- Hooks declared in cartridges that aren't on the active path silently do\n nothing — verify the cartridge path on the relevant site.\n- Avoid heavy work in `dw.order.calculate` — it runs on every basket\n modification.", + "heading": "Hooks" + } + ], + "source": "bm", + "tags": [ + "hooks", + "integration", + "hook", + "extension-point", + "ocapi", + "scapi", + "payment" + ], + "title": "Hooks" + }, + { + "description": "Jobs are scheduled or on-demand workflows composed of one or more steps. Use them for catalog imports, exports, integrations, and any background processing that is too long for a request handler.", + "id": "bm:jobs", + "kind": "topic", + "packagePath": "bm/scheduling", + "parentId": "bm:category:scheduling", + "qualifiedName": "bm.jobs", + "sections": [ + { + "body": "Jobs are scheduled or on-demand workflows composed of one or more steps. Use\nthem for catalog imports, exports, integrations, and any background processing\nthat is too long for a request handler.\n\n## Where to manage\n\n`Administration > Operations > Jobs`\n\n## Step types\n\n- **System steps** — built-in steps for common imports/exports\n (catalog, customer, order, content, inventory, price, stock).\n- **Custom steps** — JavaScript functions in your cartridge declared in\n `cartridge/steptypes.json`.\n\n## Defining a custom step\n\n```json\n// cartridge/steptypes.json\n{\n \"step-types\": {\n \"script-module-step\": [\n {\n \"@type-id\": \"custom.MyStep\",\n \"module\": \"*/cartridge/scripts/jobs/myStep\",\n \"function\": \"execute\",\n \"transactional\": \"false\",\n \"timeout-in-seconds\": \"3600\",\n \"parameters\": {\n \"parameter\": [\n {\"@name\": \"PreferenceID\", \"@type\": \"string\", \"@required\": \"true\"}\n ]\n }\n }\n ]\n }\n}\n```\n\n```javascript\n// cartridge/scripts/jobs/myStep.js\nexports.execute = function (parameters, stepExecution) {\n var Status = require('dw/system/Status');\n // ...\n return new Status(Status.OK);\n};\n```\n\n## Tips\n\n- Set `transactional` only when the step issues writes that must roll back as a\n unit — transactional steps consume a worker thread.\n- Use the `stepExecution.getJobExecution()` API to access shared job-level\n context across steps.\n- Schedule jobs **per site** when the work is site-scoped; **organization-level**\n for cross-site work like sandbox housekeeping.", + "heading": "Jobs" + } + ], + "source": "bm", + "tags": [ + "jobs", + "scheduling", + "job", + "schedule", + "batch", + "import", + "export" + ], + "title": "Jobs" + }, + { + "description": "Replication moves data from staging to production in a controlled, auditable way. It is the standard pattern for promoting catalogs, content, prices, inventory, custom attributes, and most metadata.", + "id": "bm:replication", + "kind": "topic", + "packagePath": "bm/deployment", + "parentId": "bm:category:deployment", + "qualifiedName": "bm.replication", + "sections": [ + { + "body": "Replication moves data from staging to production in a controlled,\nauditable way. It is the standard pattern for promoting catalogs, content,\nprices, inventory, custom attributes, and most metadata.\n\n## Where to manage\n\n`Merchant Tools > Site Development > Site Data Replication`\n\n## Replication types\n\n- **Site data replication** — site-scoped data (catalogs assignment, prices,\n promotions, content slots).\n- **Organization-level data replication** — shared data (system object\n definitions, jobs, services, global preferences).\n\n## Typical flow\n\n1. Stage the change on the staging instance.\n2. Create a replication group containing the affected data types.\n3. Run the replication group manually, or schedule it for a release window.\n4. Production picks up the changes once the data is replicated **and** the\n accompanying code version is activated.\n\n## Tips\n\n- **Code and data go together** — a feature that needs new custom attributes\n ships in two parts: code (via WebDAV/code activation) and data (via\n replication). Coordinate both in the same release.\n- The `Last Successful Replication` timestamp is the audit trail — capture it\n in your release notes.\n- Inventory and pricing have dedicated replication groups because of their\n high churn — replicate them on a faster cadence than the rest of the\n catalog.", + "heading": "Data Replication" + } + ], + "source": "bm", + "tags": [ + "replication", + "data replication", + "deployment", + "staging", + "production" + ], + "title": "Data Replication" + }, + { + "description": "Storefront-facing APIs (Shopper API, OCAPI Shop) require an Account Manager client with the right shopper roles in addition to OAuth credentials. Missing roles is the most common cause of `400 invalid_scope` and `403` errors.", + "id": "bm:scapi-shopper-roles", + "kind": "topic", + "packagePath": "bm/api", + "parentId": "bm:category:api", + "qualifiedName": "bm.scapi-shopper-roles", + "sections": [ + { + "body": "Storefront-facing APIs (Shopper API, OCAPI Shop) require an Account Manager\nclient with the right shopper roles in addition to OAuth credentials. Missing\nroles is the most common cause of `400 invalid_scope` and `403` errors.\n\n## Where to manage\n\n`Administration > Site Development > Open Commerce API Settings` (OCAPI)\n\n`Administration > Site Development > Shopper API Settings` (SCAPI, in newer\nrealms)\n\n## Common shopper roles\n\n- `sfcc.shopper-products` — product detail pages.\n- `sfcc.shopper-baskets` — basket and checkout.\n- `sfcc.shopper-orders` — post-checkout retrieval.\n- `sfcc.shopper-customers` — customer registration and login.\n- `sfcc.shopper-search` — product search and suggestions.\n- `sfcc.shopper-stores` — store locator endpoints.\n\n## Granting roles\n\nRoles are granted to an Account Manager **API Client** (not to a person). When\nadding a client:\n\n1. Create the client in Account Manager.\n2. Assign tenant access for the realm.\n3. Tick the shopper roles the storefront needs.\n4. Use the client's credentials in `dw.json` — the B2C CLI commands and the\n VS Code extension will use them for SLAS / SCAPI traffic.\n\n## Tips\n\n- The B2C CLI's `slas client list` command surfaces the exact scopes a token\n resolves to — useful when you suspect a missing role.\n- Errors that contain the literal string `invalid_scope` always trace back to\n this configuration.\n- Per-site OCAPI settings cache for ~10 minutes after edit. Use the **Reset\n cache** button when the change isn't picked up.", + "heading": "SCAPI / OCAPI Shopper Roles" + } + ], + "source": "bm", + "tags": [ + "scapi-shopper-roles", + "scapi / ocapi shopper roles", + "api", + "scapi", + "ocapi", + "role", + "permission", + "oauth" + ], + "title": "SCAPI / OCAPI Shopper Roles" + }, + { + "description": "The Service Framework wraps outbound calls (HTTP, SOAP, FTP, generic) so storefront and job code can rely on shared timeouts, circuit breakers, and profile-based monitoring.", + "id": "bm:services", + "kind": "topic", + "packagePath": "bm/integration", + "parentId": "bm:category:integration", + "qualifiedName": "bm.services", + "sections": [ + { + "body": "The Service Framework wraps outbound calls (HTTP, SOAP, FTP, generic) so\nstorefront and job code can rely on shared timeouts, circuit breakers, and\nprofile-based monitoring.\n\n## Where to manage\n\n- Service definitions: `Administration > Operations > Services`\n- Profiles, credentials, and circuit-breaker config: same screen, separate tabs.\n\n## Three building blocks\n\n1. **Profile** — timeout, circuit breaker, rate limit settings.\n2. **Credential** — endpoint URL plus optional username/password/cert.\n3. **Service** — bound to a profile and a credential, identified by a stable\n service ID.\n\n## Calling from script\n\n```javascript\nvar LocalServiceRegistry = require('dw/svc/LocalServiceRegistry');\n\nvar service = LocalServiceRegistry.createService('my.external.api', {\n createRequest: function (svc, body) {\n svc.setRequestMethod('POST');\n svc.addHeader('Content-Type', 'application/json');\n return JSON.stringify(body);\n },\n parseResponse: function (svc, client) {\n return JSON.parse(client.text);\n },\n filterLogMessage: function (message) {\n return message.replace(/\"password\":\"[^\"]+\"/g, '\"password\":\"***\"');\n }\n});\n\nvar result = service.call({foo: 'bar'});\nif (result.ok) {\n // result.object is whatever parseResponse returned\n}\n```\n\n## Tips\n\n- Always implement `filterLogMessage` to redact secrets from communication logs.\n- Watch the **circuit breaker** counters — flapping services indicate the\n remote endpoint is unhealthy and the breaker is protecting you.\n- Use `LocalServiceRegistry` (per-request) over `ServiceRegistry` (legacy\n global) for new code.", + "heading": "Service Framework" + } + ], + "source": "bm", + "tags": [ + "services", + "service framework", + "integration", + "service", + "http", + "webservice", + "ftp", + "callout" + ], + "title": "Service Framework" + }, + { + "description": "Site preferences are typed key-value pairs scoped to a single site. Use them for runtime configuration that should be editable by Merchants without a release.", + "id": "bm:site-preferences", + "kind": "topic", + "packagePath": "bm/configuration", + "parentId": "bm:category:configuration", + "qualifiedName": "bm.site-preferences", + "sections": [ + { + "body": "Site preferences are typed key-value pairs scoped to a single site. Use them\nfor runtime configuration that should be editable by Merchants without a\nrelease.\n\n## Where to manage\n\n`Merchant Tools > Site Preferences > Custom Preferences`\n\n## Custom preference groups\n\nCustom site preferences live under group definitions you create in\n`bm_custom_site_preferences`. Each group corresponds to an attribute group on\nthe `SitePreferences` system object.\n\nTo add a new group:\n\n1. `Administration > Site Development > System Object Types > SitePreferences`.\n2. Add a new attribute group with a meaningful identifier.\n3. Add typed attributes (string, boolean, int, double, datetime, enum-of-string,\n set-of-string, password, html, …).\n4. Set values per site under `Merchant Tools > Site Preferences`.\n\n## Reading from script\n\n```javascript\nvar Site = require('dw/system/Site');\nvar prefs = Site.getCurrent().getPreferences();\nvar customPrefs = prefs.getCustom();\nvar apiKey = customPrefs.myExternalServiceApiKey;\n```\n\n## Tips\n\n- Mark sensitive preferences as **password** so they are masked in BM.\n- Group preferences by feature, not by technical layer — Merchants navigate by\n business intent.\n- Preferences cache aggressively — use replication to roll out changes between\n staging and production.", + "heading": "Site Preferences" + } + ], + "source": "bm", + "tags": [ + "site-preferences", + "site preferences", + "configuration", + "preferences", + "site", + "custom" + ], + "title": "Site Preferences" + } +] diff --git a/packages/b2c-vs-extension/resources/docs/isml-search.json b/packages/b2c-vs-extension/resources/docs/isml-search.json new file mode 100644 index 000000000..778fed6b8 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/isml-search.json @@ -0,0 +1,266 @@ +[ + { + "id": "isml:isactivedatacontext", + "kind": "tag", + "qualifiedName": "isml.isactivedatacontext", + "tags": [ + "isactivedatacontext", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isanalyticsoff", + "kind": "tag", + "qualifiedName": "isml.isanalyticsoff", + "tags": [ + "isanalyticsoff", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isbreak", + "kind": "tag", + "qualifiedName": "isml.isbreak", + "tags": [ + "isbreak", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscache", + "kind": "tag", + "qualifiedName": "isml.iscache", + "tags": [ + "iscache", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscomment", + "kind": "tag", + "qualifiedName": "isml.iscomment", + "tags": [ + "iscomment", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscomponent", + "kind": "tag", + "qualifiedName": "isml.iscomponent", + "tags": [ + "iscomponent", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscontent", + "kind": "tag", + "qualifiedName": "isml.iscontent", + "tags": [ + "iscontent", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscontinue", + "kind": "tag", + "qualifiedName": "isml.iscontinue", + "tags": [ + "iscontinue", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iscookies", + "kind": "tag", + "qualifiedName": "isml.iscookies", + "tags": [ + "iscookies", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isdecorate", + "kind": "tag", + "qualifiedName": "isml.isdecorate", + "tags": [ + "isdecorate", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iselse", + "kind": "tag", + "qualifiedName": "isml.iselse", + "tags": [ + "iselse", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:iselseif", + "kind": "tag", + "qualifiedName": "isml.iselseif", + "tags": [ + "iselseif", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isif", + "kind": "tag", + "qualifiedName": "isml.isif", + "tags": [ + "isif", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isinclude", + "kind": "tag", + "qualifiedName": "isml.isinclude", + "tags": [ + "isinclude", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isloop", + "kind": "tag", + "qualifiedName": "isml.isloop", + "tags": [ + "isloop", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:ismodule", + "kind": "tag", + "qualifiedName": "isml.ismodule", + "tags": [ + "ismodule", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isnext", + "kind": "tag", + "qualifiedName": "isml.isnext", + "tags": [ + "isnext", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isobject", + "kind": "tag", + "qualifiedName": "isml.isobject", + "tags": [ + "isobject", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isprint", + "kind": "tag", + "qualifiedName": "isml.isprint", + "tags": [ + "isprint", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isredirect", + "kind": "tag", + "qualifiedName": "isml.isredirect", + "tags": [ + "isredirect", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isscript", + "kind": "tag", + "qualifiedName": "isml.isscript", + "tags": [ + "isscript", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isset", + "kind": "tag", + "qualifiedName": "isml.isset", + "tags": [ + "isset", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isslot", + "kind": "tag", + "qualifiedName": "isml.isslot", + "tags": [ + "isslot", + "", + "isml" + ], + "title": "" + }, + { + "id": "isml:isstatus", + "kind": "tag", + "qualifiedName": "isml.isstatus", + "tags": [ + "isstatus", + "", + "isml" + ], + "title": "" + } +] diff --git a/packages/b2c-vs-extension/resources/docs/isml.json b/packages/b2c-vs-extension/resources/docs/isml.json new file mode 100644 index 000000000..84cf4a876 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/isml.json @@ -0,0 +1,762 @@ +[ + { + "attributes": [ + { + "description": "Category ID to attribute the impression to.", + "name": "category", + "required": false + } + ], + "description": "Sets Active Data context for tracking.", + "id": "isml:isactivedatacontext", + "kind": "tag", + "qualifiedName": "isml.isactivedatacontext", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isactivedatacontext", + "", + "isml" + ], + "title": "" + }, + { + "description": "Suppresses Active Data tracking for the surrounding block.", + "id": "isml:isanalyticsoff", + "kind": "tag", + "qualifiedName": "isml.isanalyticsoff", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isanalyticsoff", + "", + "isml" + ], + "title": "" + }, + { + "description": "Exit the enclosing `` immediately.", + "id": "isml:isbreak", + "kind": "tag", + "qualifiedName": "isml.isbreak", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isbreak", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "`relative` (TTL) or `daily` (until midnight site time).", + "name": "type", + "required": true + }, + { + "description": "TTL hours (0-24).", + "name": "hour", + "required": false + }, + { + "description": "TTL minutes (0-59).", + "name": "minute", + "required": false + }, + { + "description": "`price_promotion` to vary by customer segment.", + "name": "varyby", + "required": false + }, + { + "description": "`on` to enable, `off` to disable for this template.", + "name": "status", + "required": false + } + ], + "description": "Configures page caching.", + "id": "isml:iscache", + "kind": "tag", + "qualifiedName": "isml.iscache", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- `` only takes effect on the top-level rendered template, not includes.\n- Disable with `` when serving personalized content.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "iscache", + "", + "isml" + ], + "title": "" + }, + { + "description": "ISML comment block — body is never rendered.", + "id": "isml:iscomment", + "kind": "tag", + "qualifiedName": "isml.iscomment", + "sections": [ + { + "body": "```isml\n\n note for developers\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "iscomment", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Component type identifier.", + "name": "type_id", + "required": true + } + ], + "description": "Renders a Page Designer component (legacy).", + "id": "isml:iscomponent", + "kind": "tag", + "qualifiedName": "isml.iscomponent", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Prefer the script-side `PageMgr.renderRegion(...)` API for new development.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "iscomponent", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "MIME type. Defaults to `text/html`.", + "name": "type", + "required": false + }, + { + "description": "Response charset. Defaults to `UTF-8`.", + "name": "charset", + "required": false + }, + { + "description": "When `true`, removes redundant whitespace from the response.", + "name": "compact", + "required": false + } + ], + "description": "Sets the response content type, charset, and compaction.", + "id": "isml:iscontent", + "kind": "tag", + "qualifiedName": "isml.iscontent", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "iscontent", + "", + "isml" + ], + "title": "" + }, + { + "description": "Skip to the next iteration of the enclosing ``.", + "id": "isml:iscontinue", + "kind": "tag", + "qualifiedName": "isml.iscontinue", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "iscontinue", + "", + "isml" + ], + "title": "" + }, + { + "description": "Renders configured cookie disclosures.", + "id": "isml:iscookies", + "kind": "tag", + "qualifiedName": "isml.iscookies", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "iscookies", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Cartridge-relative path of the decorator template.", + "name": "template", + "required": true + } + ], + "description": "Wraps current output in a decorator template.", + "id": "isml:isdecorate", + "kind": "tag", + "qualifiedName": "isml.isdecorate", + "sections": [ + { + "body": "```isml\n...\n```", + "heading": "Syntax" + }, + { + "body": "- The decorator template references the wrapped content via ``.\n- Avoid nesting decorators more than two levels deep — it complicates debugging.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isdecorate", + "", + "isml" + ], + "title": "" + }, + { + "description": "Fallback branch for an `` block.", + "id": "isml:iselse", + "kind": "tag", + "qualifiedName": "isml.iselse", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Self-closing only — never paired with ``.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "iselse", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "ISML expression evaluated when prior branches were false.", + "name": "condition", + "required": true + } + ], + "description": "Branch condition inside an `` block.", + "id": "isml:iselseif", + "kind": "tag", + "qualifiedName": "isml.iselseif", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Self-closing only — never paired with ``.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "iselseif", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "ISML expression. The body renders when truthy.", + "name": "condition", + "required": true + } + ], + "description": "Conditional block. Renders body when `condition` evaluates to true.", + "examples": [ + "\n \n\n

    ${Resource.msg('product.outofstock', 'product', null)}

    \n
    " + ], + "id": "isml:isif", + "kind": "tag", + "qualifiedName": "isml.isif", + "sections": [ + { + "body": "```isml\n...\n```", + "heading": "Syntax" + }, + { + "body": "- Use `` and `` for additional branches.\n- Conditions are evaluated server-side. Avoid heavy logic — move it into a script and pass a boolean via `pdict`.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isif", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Cartridge-relative template path. Mutually exclusive with `url`.", + "name": "template", + "required": false + }, + { + "description": "URL produced by `URLUtils.url(...)`. Mutually exclusive with `template`.", + "name": "url", + "required": false + }, + { + "description": "Set to `off` to suppress storefront toolkit injection (Active Data scripts).", + "name": "sf-toolkit", + "required": false + } + ], + "description": "Includes another ISML template by `template` or remote URL.", + "examples": [ + "", + "" + ], + "id": "isml:isinclude", + "kind": "tag", + "qualifiedName": "isml.isinclude", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Use `template` for local includes — this is the common case in cartridges.\n- `url` triggers a sub-request against the controller; reserve it for remote/personalized fragments.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isinclude", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Collection to iterate. Mutually exclusive with `iterator`.", + "name": "items", + "required": false + }, + { + "description": "Iterator instance. Mutually exclusive with `items`.", + "name": "iterator", + "required": false + }, + { + "description": "Variable name bound to each element when using `items`.", + "name": "var", + "required": false + }, + { + "description": "Variable name bound when using `iterator`.", + "name": "alias", + "required": false + }, + { + "description": "Optional status object exposing `index`, `count`, `first`, `last`, `odd`, `even`.", + "name": "status", + "required": false + }, + { + "description": "Zero-based index of the first element to render.", + "name": "begin", + "required": false + }, + { + "description": "Zero-based index of the last element to render (inclusive).", + "name": "end", + "required": false + }, + { + "description": "Number of elements to advance per iteration.", + "name": "step", + "required": false + } + ], + "description": "Iterates over a collection or iterator.", + "examples": [ + "\n
  • ${product.name}
  • \n
    " + ], + "id": "isml:isloop", + "kind": "tag", + "qualifiedName": "isml.isloop", + "sections": [ + { + "body": "```isml\n...\n```", + "heading": "Syntax" + }, + { + "body": "- Use `` to exit the loop early and `` to skip the rest of the body.\n- Prefer `iterator/alias` over `items/var` when iterating large collections — it avoids materializing the full list.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isloop", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Path to the module template within the cartridge.", + "name": "template", + "required": true + }, + { + "description": "Tag name developers will use to invoke the module.", + "name": "name", + "required": true + }, + { + "description": "Attribute name(s) the module accepts. Repeat the attribute for multiple.", + "name": "attribute", + "required": false + } + ], + "description": "Declares a custom ISML tag module.", + "id": "isml:ismodule", + "kind": "tag", + "qualifiedName": "isml.ismodule", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Place `` declarations in a shared template (often `modules.isml`) included by every page.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "ismodule", + "", + "isml" + ], + "title": "" + }, + { + "description": "Advance the enclosing iterator-mode `` to the next element.", + "id": "isml:isnext", + "kind": "tag", + "qualifiedName": "isml.isnext", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isnext", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Object reference, typically from `pdict`.", + "name": "object", + "required": true + }, + { + "description": "Predefined view name: `detail`, `recommendation`, `searchhit`, `none`.", + "name": "view", + "required": true + } + ], + "description": "Wraps markup so personalization tracking can identify the rendered object.", + "id": "isml:isobject", + "kind": "tag", + "qualifiedName": "isml.isobject", + "sections": [ + { + "body": "```isml\n...\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isobject", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "ISML expression to render.", + "name": "value", + "required": true + }, + { + "description": "One of `on`, `off`, `htmlcontent`, `htmlsinglequote`, `htmldoublequote`, `htmlunquote`, `jshtml`, `jsattr`, `jsblock`, `jssource`, `jsonvalue`, `uricomponent`, `uristrict`, `xmlcontent`, `xmlsinglequote`, `xmldoublequote`, `xmlcomment`.", + "name": "encoding", + "required": false + }, + { + "description": "Number/date format string (e.g. `#,##0.00`, `yyyy-MM-dd`).", + "name": "formatter", + "required": false + }, + { + "description": "Timezone reference: `SITE`, `INSTANCE`, or `UTC`. Only used with date formatters.", + "name": "timezone", + "required": false + } + ], + "description": "Prints a value with explicit encoding or formatter.", + "id": "isml:isprint", + "kind": "tag", + "qualifiedName": "isml.isprint", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + }, + { + "body": "- Always specify `encoding` when rendering user-supplied values to prevent XSS.\n- Use `encoding=\"off\"` only for values that are already HTML and trusted.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isprint", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Target URL — usually built with `URLUtils.url(...)`.", + "name": "location", + "required": true + }, + { + "description": "`true` for HTTP 301, `false` (default) for HTTP 302.", + "name": "permanent", + "required": false + } + ], + "description": "Redirects the response to another URL.", + "id": "isml:isredirect", + "kind": "tag", + "qualifiedName": "isml.isredirect", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isredirect", + "", + "isml" + ], + "title": "" + }, + { + "description": "Server-side script block in B2C Commerce script.", + "examples": [ + "\n var assets = require('*/cartridge/scripts/assets');\n assets.addCss('/css/global.css');\n assets.addJs('/js/main.js');\n" + ], + "id": "isml:isscript", + "kind": "tag", + "qualifiedName": "isml.isscript", + "sections": [ + { + "body": "```isml\n\n var helper = require('*/cartridge/scripts/util/foo');\n\n```", + "heading": "Syntax" + }, + { + "body": "- Use `` for `require(...)`, data lookups, and `res.render(...)` calls.\n- Prefer moving non-trivial logic into `cartridge/scripts/` modules — `` should stay short.", + "heading": "Tips" + } + ], + "source": "isml", + "tags": [ + "isscript", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Variable name.", + "name": "name", + "required": true + }, + { + "description": "ISML expression assigned to the variable.", + "name": "value", + "required": true + }, + { + "description": "One of `page` (default), `request`, or `session`.", + "name": "scope", + "required": false + } + ], + "description": "Assigns a variable in page, request, or session scope.", + "id": "isml:isset", + "kind": "tag", + "qualifiedName": "isml.isset", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isset", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Slot identifier matching the configuration in Business Manager.", + "name": "id", + "required": true + }, + { + "description": "Free-form description shown in Business Manager.", + "name": "description", + "required": false + }, + { + "description": "One of `global`, `category`, or `folder`.", + "name": "context", + "required": true + }, + { + "description": "Required when context is `category` or `folder` — usually `pdict.CurrentCategory` or `pdict.CurrentFolder`.", + "name": "context-object", + "required": false + } + ], + "description": "Renders a content slot configured in Business Manager.", + "id": "isml:isslot", + "kind": "tag", + "qualifiedName": "isml.isslot", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isslot", + "", + "isml" + ], + "title": "" + }, + { + "attributes": [ + { + "description": "Numeric HTTP status (200, 301, 302, 404, 500, …).", + "name": "value", + "required": true + } + ], + "description": "Sets the HTTP response status code.", + "id": "isml:isstatus", + "kind": "tag", + "qualifiedName": "isml.isstatus", + "sections": [ + { + "body": "```isml\n\n```", + "heading": "Syntax" + } + ], + "source": "isml", + "tags": [ + "isstatus", + "", + "isml" + ], + "title": "" + } +] diff --git a/packages/b2c-vs-extension/resources/docs/manifest.json b/packages/b2c-vs-extension/resources/docs/manifest.json new file mode 100644 index 000000000..6846a05b1 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/manifest.json @@ -0,0 +1,13 @@ +{ + "bmVersion": "f85458f", + "checksum": "ccfc1180274ed0118e6b66209d603ce19b6604050226ce4296aac4e5178da298", + "counts": { + "bm": 14, + "isml": 24, + "scriptApi": 8664 + }, + "generatedAt": "1970-01-01T00:00:00.000Z", + "ismlVersion": "1.0.0", + "schemaVersion": 1, + "scriptApiVersion": "26.7.0" +} diff --git a/packages/b2c-vs-extension/resources/docs/script-api-search.json b/packages/b2c-vs-extension/resources/docs/script-api-search.json new file mode 100644 index 000000000..fb7a606df --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/script-api-search.json @@ -0,0 +1,104374 @@ +[ + { + "id": "script-api:dw/alert", + "kind": "package", + "packagePath": "dw/alert", + "qualifiedName": "dw.alert", + "tags": [ + "dw/alert", + "dw.alert" + ], + "title": "dw.alert" + }, + { + "id": "script-api:dw/alert/Alert", + "kind": "class", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert", + "qualifiedName": "dw.alert.Alert", + "tags": [ + "alert", + "dw.alert.alert", + "dw/alert" + ], + "title": "Alert" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_ACTION", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_ACTION", + "tags": [ + "priority_action", + "alert.priority_action" + ], + "title": "Alert.PRIORITY_ACTION" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_ACTION", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_ACTION", + "tags": [ + "priority_action", + "alert.priority_action" + ], + "title": "Alert.PRIORITY_ACTION" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_INFO", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_INFO", + "tags": [ + "priority_info", + "alert.priority_info" + ], + "title": "Alert.PRIORITY_INFO" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_INFO", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_INFO", + "tags": [ + "priority_info", + "alert.priority_info" + ], + "title": "Alert.PRIORITY_INFO" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_WARN", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_WARN", + "tags": [ + "priority_warn", + "alert.priority_warn" + ], + "title": "Alert.PRIORITY_WARN" + }, + { + "id": "script-api:dw/alert/Alert#PRIORITY_WARN", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_WARN", + "tags": [ + "priority_warn", + "alert.priority_warn" + ], + "title": "Alert.PRIORITY_WARN" + }, + { + "id": "script-api:dw/alert/Alert#alertDescriptorID", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.alertDescriptorID", + "tags": [ + "alertdescriptorid", + "alert.alertdescriptorid" + ], + "title": "Alert.alertDescriptorID" + }, + { + "id": "script-api:dw/alert/Alert#contextObjectID", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.contextObjectID", + "tags": [ + "contextobjectid", + "alert.contextobjectid" + ], + "title": "Alert.contextObjectID" + }, + { + "id": "script-api:dw/alert/Alert#displayMessage", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.displayMessage", + "tags": [ + "displaymessage", + "alert.displaymessage" + ], + "title": "Alert.displayMessage" + }, + { + "id": "script-api:dw/alert/Alert#getAlertDescriptorID", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getAlertDescriptorID", + "tags": [ + "getalertdescriptorid", + "alert.getalertdescriptorid" + ], + "title": "Alert.getAlertDescriptorID" + }, + { + "id": "script-api:dw/alert/Alert#getContextObjectID", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getContextObjectID", + "tags": [ + "getcontextobjectid", + "alert.getcontextobjectid" + ], + "title": "Alert.getContextObjectID" + }, + { + "id": "script-api:dw/alert/Alert#getDisplayMessage", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getDisplayMessage", + "tags": [ + "getdisplaymessage", + "alert.getdisplaymessage" + ], + "title": "Alert.getDisplayMessage" + }, + { + "id": "script-api:dw/alert/Alert#getPriority", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getPriority", + "tags": [ + "getpriority", + "alert.getpriority" + ], + "title": "Alert.getPriority" + }, + { + "id": "script-api:dw/alert/Alert#getRemediationURL", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getRemediationURL", + "tags": [ + "getremediationurl", + "alert.getremediationurl" + ], + "title": "Alert.getRemediationURL" + }, + { + "id": "script-api:dw/alert/Alert#priority", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.priority", + "tags": [ + "priority", + "alert.priority" + ], + "title": "Alert.priority" + }, + { + "id": "script-api:dw/alert/Alert#remediationURL", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.remediationURL", + "tags": [ + "remediationurl", + "alert.remediationurl" + ], + "title": "Alert.remediationURL" + }, + { + "id": "script-api:dw/alert/Alerts", + "kind": "class", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert", + "qualifiedName": "dw.alert.Alerts", + "tags": [ + "alerts", + "dw.alert.alerts", + "dw/alert" + ], + "title": "Alerts" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "id": "script-api:dw/alert/Alerts#getAlerts", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlerts", + "tags": [ + "getalerts", + "alerts.getalerts" + ], + "title": "Alerts.getAlerts" + }, + { + "id": "script-api:dw/alert/Alerts#getAlerts", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlerts", + "tags": [ + "getalerts", + "alerts.getalerts" + ], + "title": "Alerts.getAlerts" + }, + { + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "id": "script-api:dw/campaign", + "kind": "package", + "packagePath": "dw/campaign", + "qualifiedName": "dw.campaign", + "tags": [ + "dw/campaign", + "dw.campaign" + ], + "title": "dw.campaign" + }, + { + "id": "script-api:dw/campaign/ABTest", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTest", + "tags": [ + "abtest", + "dw.campaign.abtest", + "dw/campaign" + ], + "title": "ABTest" + }, + { + "id": "script-api:dw/campaign/ABTest#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTest", + "qualifiedName": "dw.campaign.ABTest.ID", + "tags": [ + "id", + "abtest.id" + ], + "title": "ABTest.ID" + }, + { + "id": "script-api:dw/campaign/ABTest#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTest", + "qualifiedName": "dw.campaign.ABTest.getID", + "tags": [ + "getid", + "abtest.getid" + ], + "title": "ABTest.getID" + }, + { + "id": "script-api:dw/campaign/ABTestMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTestMgr", + "tags": [ + "abtestmgr", + "dw.campaign.abtestmgr", + "dw/campaign" + ], + "title": "ABTestMgr" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#assignedTestSegments", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.assignedTestSegments", + "tags": [ + "assignedtestsegments", + "abtestmgr.assignedtestsegments" + ], + "title": "ABTestMgr.assignedTestSegments" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#assignedTestSegments", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.assignedTestSegments", + "tags": [ + "assignedtestsegments", + "abtestmgr.assignedtestsegments" + ], + "title": "ABTestMgr.assignedTestSegments" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#getAssignedTestSegments", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.getAssignedTestSegments", + "tags": [ + "getassignedtestsegments", + "abtestmgr.getassignedtestsegments" + ], + "title": "ABTestMgr.getAssignedTestSegments" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#getAssignedTestSegments", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.getAssignedTestSegments", + "tags": [ + "getassignedtestsegments", + "abtestmgr.getassignedtestsegments" + ], + "title": "ABTestMgr.getAssignedTestSegments" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#isParticipant", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.isParticipant", + "tags": [ + "isparticipant", + "abtestmgr.isparticipant" + ], + "title": "ABTestMgr.isParticipant" + }, + { + "id": "script-api:dw/campaign/ABTestMgr#isParticipant", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.isParticipant", + "tags": [ + "isparticipant", + "abtestmgr.isparticipant" + ], + "title": "ABTestMgr.isParticipant" + }, + { + "id": "script-api:dw/campaign/ABTestSegment", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTestSegment", + "tags": [ + "abtestsegment", + "dw.campaign.abtestsegment", + "dw/campaign" + ], + "title": "ABTestSegment" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#ABTest", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.ABTest", + "tags": [ + "abtest", + "abtestsegment.abtest" + ], + "title": "ABTestSegment.ABTest" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.ID", + "tags": [ + "id", + "abtestsegment.id" + ], + "title": "ABTestSegment.ID" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#controlSegment", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.controlSegment", + "tags": [ + "controlsegment", + "abtestsegment.controlsegment" + ], + "title": "ABTestSegment.controlSegment" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#getABTest", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.getABTest", + "tags": [ + "getabtest", + "abtestsegment.getabtest" + ], + "title": "ABTestSegment.getABTest" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.getID", + "tags": [ + "getid", + "abtestsegment.getid" + ], + "title": "ABTestSegment.getID" + }, + { + "id": "script-api:dw/campaign/ABTestSegment#isControlSegment", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.isControlSegment", + "tags": [ + "iscontrolsegment", + "abtestsegment.iscontrolsegment" + ], + "title": "ABTestSegment.isControlSegment" + }, + { + "id": "script-api:dw/campaign/AmountDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.AmountDiscount", + "tags": [ + "amountdiscount", + "dw.campaign.amountdiscount", + "dw/campaign" + ], + "title": "AmountDiscount" + }, + { + "id": "script-api:dw/campaign/AmountDiscount#amount", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/AmountDiscount", + "qualifiedName": "dw.campaign.AmountDiscount.amount", + "tags": [ + "amount", + "amountdiscount.amount" + ], + "title": "AmountDiscount.amount" + }, + { + "id": "script-api:dw/campaign/AmountDiscount#getAmount", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/AmountDiscount", + "qualifiedName": "dw.campaign.AmountDiscount.getAmount", + "tags": [ + "getamount", + "amountdiscount.getamount" + ], + "title": "AmountDiscount.getAmount" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ApproachingDiscount", + "tags": [ + "approachingdiscount", + "dw.campaign.approachingdiscount", + "dw/campaign" + ], + "title": "ApproachingDiscount" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#conditionThreshold", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.conditionThreshold", + "tags": [ + "conditionthreshold", + "approachingdiscount.conditionthreshold" + ], + "title": "ApproachingDiscount.conditionThreshold" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#discount", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.discount", + "tags": [ + "discount", + "approachingdiscount.discount" + ], + "title": "ApproachingDiscount.discount" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#distanceFromConditionThreshold", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.distanceFromConditionThreshold", + "tags": [ + "distancefromconditionthreshold", + "approachingdiscount.distancefromconditionthreshold" + ], + "title": "ApproachingDiscount.distanceFromConditionThreshold" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#getConditionThreshold", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getConditionThreshold", + "tags": [ + "getconditionthreshold", + "approachingdiscount.getconditionthreshold" + ], + "title": "ApproachingDiscount.getConditionThreshold" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#getDiscount", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getDiscount", + "tags": [ + "getdiscount", + "approachingdiscount.getdiscount" + ], + "title": "ApproachingDiscount.getDiscount" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#getDistanceFromConditionThreshold", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getDistanceFromConditionThreshold", + "tags": [ + "getdistancefromconditionthreshold", + "approachingdiscount.getdistancefromconditionthreshold" + ], + "title": "ApproachingDiscount.getDistanceFromConditionThreshold" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#getMerchandiseTotal", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getMerchandiseTotal", + "tags": [ + "getmerchandisetotal", + "approachingdiscount.getmerchandisetotal" + ], + "title": "ApproachingDiscount.getMerchandiseTotal" + }, + { + "id": "script-api:dw/campaign/ApproachingDiscount#merchandiseTotal", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.merchandiseTotal", + "tags": [ + "merchandisetotal", + "approachingdiscount.merchandisetotal" + ], + "title": "ApproachingDiscount.merchandiseTotal" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.BonusChoiceDiscount", + "tags": [ + "bonuschoicediscount", + "dw.campaign.bonuschoicediscount", + "dw/campaign" + ], + "title": "BonusChoiceDiscount" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#bonusProducts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.bonusProducts", + "tags": [ + "bonusproducts", + "bonuschoicediscount.bonusproducts" + ], + "title": "BonusChoiceDiscount.bonusProducts" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#getBonusProductPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getBonusProductPrice", + "tags": [ + "getbonusproductprice", + "bonuschoicediscount.getbonusproductprice" + ], + "title": "BonusChoiceDiscount.getBonusProductPrice" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#getBonusProducts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getBonusProducts", + "tags": [ + "getbonusproducts", + "bonuschoicediscount.getbonusproducts" + ], + "title": "BonusChoiceDiscount.getBonusProducts" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#getMaxBonusItems", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getMaxBonusItems", + "tags": [ + "getmaxbonusitems", + "bonuschoicediscount.getmaxbonusitems" + ], + "title": "BonusChoiceDiscount.getMaxBonusItems" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#isRuleBased", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.isRuleBased", + "tags": [ + "isrulebased", + "bonuschoicediscount.isrulebased" + ], + "title": "BonusChoiceDiscount.isRuleBased" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#maxBonusItems", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.maxBonusItems", + "tags": [ + "maxbonusitems", + "bonuschoicediscount.maxbonusitems" + ], + "title": "BonusChoiceDiscount.maxBonusItems" + }, + { + "id": "script-api:dw/campaign/BonusChoiceDiscount#ruleBased", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.ruleBased", + "tags": [ + "rulebased", + "bonuschoicediscount.rulebased" + ], + "title": "BonusChoiceDiscount.ruleBased" + }, + { + "id": "script-api:dw/campaign/BonusDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.BonusDiscount", + "tags": [ + "bonusdiscount", + "dw.campaign.bonusdiscount", + "dw/campaign" + ], + "title": "BonusDiscount" + }, + { + "id": "script-api:dw/campaign/BonusDiscount#bonusProducts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusDiscount", + "qualifiedName": "dw.campaign.BonusDiscount.bonusProducts", + "tags": [ + "bonusproducts", + "bonusdiscount.bonusproducts" + ], + "title": "BonusDiscount.bonusProducts" + }, + { + "id": "script-api:dw/campaign/BonusDiscount#getBonusProducts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusDiscount", + "qualifiedName": "dw.campaign.BonusDiscount.getBonusProducts", + "tags": [ + "getbonusproducts", + "bonusdiscount.getbonusproducts" + ], + "title": "BonusDiscount.getBonusProducts" + }, + { + "id": "script-api:dw/campaign/Campaign", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Campaign", + "tags": [ + "campaign", + "dw.campaign.campaign", + "dw/campaign" + ], + "title": "Campaign" + }, + { + "id": "script-api:dw/campaign/Campaign#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.ID", + "tags": [ + "id", + "campaign.id" + ], + "title": "Campaign.ID" + }, + { + "id": "script-api:dw/campaign/Campaign#active", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.active", + "tags": [ + "active", + "campaign.active" + ], + "title": "Campaign.active" + }, + { + "id": "script-api:dw/campaign/Campaign#applicableInStore", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.applicableInStore", + "tags": [ + "applicableinstore", + "campaign.applicableinstore" + ], + "title": "Campaign.applicableInStore" + }, + { + "id": "script-api:dw/campaign/Campaign#applicableOnline", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.applicableOnline", + "tags": [ + "applicableonline", + "campaign.applicableonline" + ], + "title": "Campaign.applicableOnline" + }, + { + "id": "script-api:dw/campaign/Campaign#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.coupons", + "tags": [ + "coupons", + "campaign.coupons" + ], + "title": "Campaign.coupons" + }, + { + "id": "script-api:dw/campaign/Campaign#customerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.customerGroups", + "tags": [ + "customergroups", + "campaign.customergroups" + ], + "title": "Campaign.customerGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#description", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.description", + "tags": [ + "description", + "campaign.description" + ], + "title": "Campaign.description" + }, + { + "id": "script-api:dw/campaign/Campaign#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.enabled", + "tags": [ + "enabled", + "campaign.enabled" + ], + "title": "Campaign.enabled" + }, + { + "id": "script-api:dw/campaign/Campaign#endDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.endDate", + "tags": [ + "enddate", + "campaign.enddate" + ], + "title": "Campaign.endDate" + }, + { + "id": "script-api:dw/campaign/Campaign#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getCoupons", + "tags": [ + "getcoupons", + "campaign.getcoupons" + ], + "title": "Campaign.getCoupons" + }, + { + "id": "script-api:dw/campaign/Campaign#getCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getCustomerGroups", + "tags": [ + "getcustomergroups", + "campaign.getcustomergroups" + ], + "title": "Campaign.getCustomerGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#getDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getDescription", + "tags": [ + "getdescription", + "campaign.getdescription" + ], + "title": "Campaign.getDescription" + }, + { + "id": "script-api:dw/campaign/Campaign#getEndDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getEndDate", + "tags": [ + "getenddate", + "campaign.getenddate" + ], + "title": "Campaign.getEndDate" + }, + { + "id": "script-api:dw/campaign/Campaign#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getID", + "tags": [ + "getid", + "campaign.getid" + ], + "title": "Campaign.getID" + }, + { + "id": "script-api:dw/campaign/Campaign#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getPromotions", + "tags": [ + "getpromotions", + "campaign.getpromotions" + ], + "title": "Campaign.getPromotions" + }, + { + "id": "script-api:dw/campaign/Campaign#getSourceCodeGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getSourceCodeGroups", + "tags": [ + "getsourcecodegroups", + "campaign.getsourcecodegroups" + ], + "title": "Campaign.getSourceCodeGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#getStartDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStartDate", + "tags": [ + "getstartdate", + "campaign.getstartdate" + ], + "title": "Campaign.getStartDate" + }, + { + "id": "script-api:dw/campaign/Campaign#getStoreGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStoreGroups", + "tags": [ + "getstoregroups", + "campaign.getstoregroups" + ], + "title": "Campaign.getStoreGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#getStores", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStores", + "tags": [ + "getstores", + "campaign.getstores" + ], + "title": "Campaign.getStores" + }, + { + "id": "script-api:dw/campaign/Campaign#isActive", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isActive", + "tags": [ + "isactive", + "campaign.isactive" + ], + "title": "Campaign.isActive" + }, + { + "id": "script-api:dw/campaign/Campaign#isApplicableInStore", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isApplicableInStore", + "tags": [ + "isapplicableinstore", + "campaign.isapplicableinstore" + ], + "title": "Campaign.isApplicableInStore" + }, + { + "id": "script-api:dw/campaign/Campaign#isApplicableOnline", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isApplicableOnline", + "tags": [ + "isapplicableonline", + "campaign.isapplicableonline" + ], + "title": "Campaign.isApplicableOnline" + }, + { + "id": "script-api:dw/campaign/Campaign#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isEnabled", + "tags": [ + "isenabled", + "campaign.isenabled" + ], + "title": "Campaign.isEnabled" + }, + { + "id": "script-api:dw/campaign/Campaign#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.promotions", + "tags": [ + "promotions", + "campaign.promotions" + ], + "title": "Campaign.promotions" + }, + { + "id": "script-api:dw/campaign/Campaign#sourceCodeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.sourceCodeGroups", + "tags": [ + "sourcecodegroups", + "campaign.sourcecodegroups" + ], + "title": "Campaign.sourceCodeGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#startDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.startDate", + "tags": [ + "startdate", + "campaign.startdate" + ], + "title": "Campaign.startDate" + }, + { + "id": "script-api:dw/campaign/Campaign#storeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.storeGroups", + "tags": [ + "storegroups", + "campaign.storegroups" + ], + "title": "Campaign.storeGroups" + }, + { + "id": "script-api:dw/campaign/Campaign#stores", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.stores", + "tags": [ + "stores", + "campaign.stores" + ], + "title": "Campaign.stores" + }, + { + "id": "script-api:dw/campaign/CampaignMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CampaignMgr", + "tags": [ + "campaignmgr", + "dw.campaign.campaignmgr", + "dw/campaign" + ], + "title": "CampaignMgr" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applicablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applicablePromotions", + "tags": [ + "applicablepromotions", + "campaignmgr.applicablepromotions" + ], + "title": "CampaignMgr.applicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applicablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applicablePromotions", + "tags": [ + "applicablepromotions", + "campaignmgr.applicablepromotions" + ], + "title": "CampaignMgr.applicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyBonusPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyBonusPromotions", + "tags": [ + "applybonuspromotions", + "campaignmgr.applybonuspromotions" + ], + "title": "CampaignMgr.applyBonusPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyBonusPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyBonusPromotions", + "tags": [ + "applybonuspromotions", + "campaignmgr.applybonuspromotions" + ], + "title": "CampaignMgr.applyBonusPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyOrderPromotions", + "tags": [ + "applyorderpromotions", + "campaignmgr.applyorderpromotions" + ], + "title": "CampaignMgr.applyOrderPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyOrderPromotions", + "tags": [ + "applyorderpromotions", + "campaignmgr.applyorderpromotions" + ], + "title": "CampaignMgr.applyOrderPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyProductPromotions", + "tags": [ + "applyproductpromotions", + "campaignmgr.applyproductpromotions" + ], + "title": "CampaignMgr.applyProductPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyProductPromotions", + "tags": [ + "applyproductpromotions", + "campaignmgr.applyproductpromotions" + ], + "title": "CampaignMgr.applyProductPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyShippingPromotions", + "tags": [ + "applyshippingpromotions", + "campaignmgr.applyshippingpromotions" + ], + "title": "CampaignMgr.applyShippingPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#applyShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyShippingPromotions", + "tags": [ + "applyshippingpromotions", + "campaignmgr.applyshippingpromotions" + ], + "title": "CampaignMgr.applyShippingPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicableConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicableConditionalPromotions", + "tags": [ + "getapplicableconditionalpromotions", + "campaignmgr.getapplicableconditionalpromotions" + ], + "title": "CampaignMgr.getApplicableConditionalPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicableConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicableConditionalPromotions", + "tags": [ + "getapplicableconditionalpromotions", + "campaignmgr.getapplicableconditionalpromotions" + ], + "title": "CampaignMgr.getApplicableConditionalPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getCampaignByID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getCampaignByID", + "tags": [ + "getcampaignbyid", + "campaignmgr.getcampaignbyid" + ], + "title": "CampaignMgr.getCampaignByID" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getCampaignByID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getCampaignByID", + "tags": [ + "getcampaignbyid", + "campaignmgr.getcampaignbyid" + ], + "title": "CampaignMgr.getCampaignByID" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getConditionalPromotions", + "tags": [ + "getconditionalpromotions", + "campaignmgr.getconditionalpromotions" + ], + "title": "CampaignMgr.getConditionalPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getConditionalPromotions", + "tags": [ + "getconditionalpromotions", + "campaignmgr.getconditionalpromotions" + ], + "title": "CampaignMgr.getConditionalPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotion", + "tags": [ + "getpromotion", + "campaignmgr.getpromotion" + ], + "title": "CampaignMgr.getPromotion" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotion", + "tags": [ + "getpromotion", + "campaignmgr.getpromotion" + ], + "title": "CampaignMgr.getPromotion" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByCouponCode", + "tags": [ + "getpromotionbycouponcode", + "campaignmgr.getpromotionbycouponcode" + ], + "title": "CampaignMgr.getPromotionByCouponCode" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByCouponCode", + "tags": [ + "getpromotionbycouponcode", + "campaignmgr.getpromotionbycouponcode" + ], + "title": "CampaignMgr.getPromotionByCouponCode" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByID", + "tags": [ + "getpromotionbyid", + "campaignmgr.getpromotionbyid" + ], + "title": "CampaignMgr.getPromotionByID" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByID", + "tags": [ + "getpromotionbyid", + "campaignmgr.getpromotionbyid" + ], + "title": "CampaignMgr.getPromotionByID" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotions", + "tags": [ + "getpromotions", + "campaignmgr.getpromotions" + ], + "title": "CampaignMgr.getPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotions", + "tags": [ + "getpromotions", + "campaignmgr.getpromotions" + ], + "title": "CampaignMgr.getPromotions" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CampaignStatusCodes", + "tags": [ + "campaignstatuscodes", + "dw.campaign.campaignstatuscodes", + "dw/campaign" + ], + "title": "CampaignStatusCodes" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_APPLIED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_APPLIED", + "tags": [ + "coupon_already_applied", + "campaignstatuscodes.coupon_already_applied" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_APPLIED" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_APPLIED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_APPLIED", + "tags": [ + "coupon_already_applied", + "campaignstatuscodes.coupon_already_applied" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_APPLIED" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_REDEEMED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_REDEEMED", + "tags": [ + "coupon_already_redeemed", + "campaignstatuscodes.coupon_already_redeemed" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_REDEEMED" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_REDEEMED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_REDEEMED", + "tags": [ + "coupon_already_redeemed", + "campaignstatuscodes.coupon_already_redeemed" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_REDEEMED" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_NOT_REDEEMABLE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_NOT_REDEEMABLE", + "tags": [ + "coupon_not_redeemable", + "campaignstatuscodes.coupon_not_redeemable" + ], + "title": "CampaignStatusCodes.COUPON_NOT_REDEEMABLE" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_NOT_REDEEMABLE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_NOT_REDEEMABLE", + "tags": [ + "coupon_not_redeemable", + "campaignstatuscodes.coupon_not_redeemable" + ], + "title": "CampaignStatusCodes.COUPON_NOT_REDEEMABLE" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_UNKNOWN", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_UNKNOWN", + "tags": [ + "coupon_unknown", + "campaignstatuscodes.coupon_unknown" + ], + "title": "CampaignStatusCodes.COUPON_UNKNOWN" + }, + { + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_UNKNOWN", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_UNKNOWN", + "tags": [ + "coupon_unknown", + "campaignstatuscodes.coupon_unknown" + ], + "title": "CampaignStatusCodes.COUPON_UNKNOWN" + }, + { + "id": "script-api:dw/campaign/Coupon", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Coupon", + "tags": [ + "coupon", + "dw.campaign.coupon", + "dw/campaign" + ], + "title": "Coupon" + }, + { + "id": "script-api:dw/campaign/Coupon#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.ID", + "tags": [ + "id", + "coupon.id" + ], + "title": "Coupon.ID" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_MULTIPLE_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_MULTIPLE_CODES", + "tags": [ + "type_multiple_codes", + "coupon.type_multiple_codes" + ], + "title": "Coupon.TYPE_MULTIPLE_CODES" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_MULTIPLE_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_MULTIPLE_CODES", + "tags": [ + "type_multiple_codes", + "coupon.type_multiple_codes" + ], + "title": "Coupon.TYPE_MULTIPLE_CODES" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_SINGLE_CODE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SINGLE_CODE", + "tags": [ + "type_single_code", + "coupon.type_single_code" + ], + "title": "Coupon.TYPE_SINGLE_CODE" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_SINGLE_CODE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SINGLE_CODE", + "tags": [ + "type_single_code", + "coupon.type_single_code" + ], + "title": "Coupon.TYPE_SINGLE_CODE" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_SYSTEM_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SYSTEM_CODES", + "tags": [ + "type_system_codes", + "coupon.type_system_codes" + ], + "title": "Coupon.TYPE_SYSTEM_CODES" + }, + { + "id": "script-api:dw/campaign/Coupon#TYPE_SYSTEM_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SYSTEM_CODES", + "tags": [ + "type_system_codes", + "coupon.type_system_codes" + ], + "title": "Coupon.TYPE_SYSTEM_CODES" + }, + { + "id": "script-api:dw/campaign/Coupon#codePrefix", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.codePrefix", + "tags": [ + "codeprefix", + "coupon.codeprefix" + ], + "title": "Coupon.codePrefix" + }, + { + "id": "script-api:dw/campaign/Coupon#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.enabled", + "tags": [ + "enabled", + "coupon.enabled" + ], + "title": "Coupon.enabled" + }, + { + "id": "script-api:dw/campaign/Coupon#getCodePrefix", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getCodePrefix", + "tags": [ + "getcodeprefix", + "coupon.getcodeprefix" + ], + "title": "Coupon.getCodePrefix" + }, + { + "id": "script-api:dw/campaign/Coupon#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getID", + "tags": [ + "getid", + "coupon.getid" + ], + "title": "Coupon.getID" + }, + { + "id": "script-api:dw/campaign/Coupon#getNextCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getNextCouponCode", + "tags": [ + "getnextcouponcode", + "coupon.getnextcouponcode" + ], + "title": "Coupon.getNextCouponCode" + }, + { + "id": "script-api:dw/campaign/Coupon#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getPromotions", + "tags": [ + "getpromotions", + "coupon.getpromotions" + ], + "title": "Coupon.getPromotions" + }, + { + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerCode", + "tags": [ + "getredemptionlimitpercode", + "coupon.getredemptionlimitpercode" + ], + "title": "Coupon.getRedemptionLimitPerCode" + }, + { + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerCustomer", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerCustomer", + "tags": [ + "getredemptionlimitpercustomer", + "coupon.getredemptionlimitpercustomer" + ], + "title": "Coupon.getRedemptionLimitPerCustomer" + }, + { + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerTimeFrame", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerTimeFrame", + "tags": [ + "getredemptionlimitpertimeframe", + "coupon.getredemptionlimitpertimeframe" + ], + "title": "Coupon.getRedemptionLimitPerTimeFrame" + }, + { + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitTimeFrame", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitTimeFrame", + "tags": [ + "getredemptionlimittimeframe", + "coupon.getredemptionlimittimeframe" + ], + "title": "Coupon.getRedemptionLimitTimeFrame" + }, + { + "id": "script-api:dw/campaign/Coupon#getType", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getType", + "tags": [ + "gettype", + "coupon.gettype" + ], + "title": "Coupon.getType" + }, + { + "id": "script-api:dw/campaign/Coupon#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.isEnabled", + "tags": [ + "isenabled", + "coupon.isenabled" + ], + "title": "Coupon.isEnabled" + }, + { + "id": "script-api:dw/campaign/Coupon#nextCouponCode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.nextCouponCode", + "tags": [ + "nextcouponcode", + "coupon.nextcouponcode" + ], + "title": "Coupon.nextCouponCode" + }, + { + "id": "script-api:dw/campaign/Coupon#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.promotions", + "tags": [ + "promotions", + "coupon.promotions" + ], + "title": "Coupon.promotions" + }, + { + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerCode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerCode", + "tags": [ + "redemptionlimitpercode", + "coupon.redemptionlimitpercode" + ], + "title": "Coupon.redemptionLimitPerCode" + }, + { + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerCustomer", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerCustomer", + "tags": [ + "redemptionlimitpercustomer", + "coupon.redemptionlimitpercustomer" + ], + "title": "Coupon.redemptionLimitPerCustomer" + }, + { + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerTimeFrame", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerTimeFrame", + "tags": [ + "redemptionlimitpertimeframe", + "coupon.redemptionlimitpertimeframe" + ], + "title": "Coupon.redemptionLimitPerTimeFrame" + }, + { + "id": "script-api:dw/campaign/Coupon#redemptionLimitTimeFrame", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitTimeFrame", + "tags": [ + "redemptionlimittimeframe", + "coupon.redemptionlimittimeframe" + ], + "title": "Coupon.redemptionLimitTimeFrame" + }, + { + "id": "script-api:dw/campaign/Coupon#type", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.type", + "tags": [ + "type", + "coupon.type" + ], + "title": "Coupon.type" + }, + { + "id": "script-api:dw/campaign/CouponMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponMgr", + "tags": [ + "couponmgr", + "dw.campaign.couponmgr", + "dw/campaign" + ], + "title": "CouponMgr" + }, + { + "id": "script-api:dw/campaign/CouponMgr#MR_ERROR_INVALID_SITE_ID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.MR_ERROR_INVALID_SITE_ID", + "tags": [ + "mr_error_invalid_site_id", + "couponmgr.mr_error_invalid_site_id" + ], + "title": "CouponMgr.MR_ERROR_INVALID_SITE_ID" + }, + { + "id": "script-api:dw/campaign/CouponMgr#MR_ERROR_INVALID_SITE_ID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.MR_ERROR_INVALID_SITE_ID", + "tags": [ + "mr_error_invalid_site_id", + "couponmgr.mr_error_invalid_site_id" + ], + "title": "CouponMgr.MR_ERROR_INVALID_SITE_ID" + }, + { + "id": "script-api:dw/campaign/CouponMgr#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.coupons", + "tags": [ + "coupons", + "couponmgr.coupons" + ], + "title": "CouponMgr.coupons" + }, + { + "id": "script-api:dw/campaign/CouponMgr#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.coupons", + "tags": [ + "coupons", + "couponmgr.coupons" + ], + "title": "CouponMgr.coupons" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupon", + "tags": [ + "getcoupon", + "couponmgr.getcoupon" + ], + "title": "CouponMgr.getCoupon" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupon", + "tags": [ + "getcoupon", + "couponmgr.getcoupon" + ], + "title": "CouponMgr.getCoupon" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCouponByCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCouponByCode", + "tags": [ + "getcouponbycode", + "couponmgr.getcouponbycode" + ], + "title": "CouponMgr.getCouponByCode" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCouponByCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCouponByCode", + "tags": [ + "getcouponbycode", + "couponmgr.getcouponbycode" + ], + "title": "CouponMgr.getCouponByCode" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupons", + "tags": [ + "getcoupons", + "couponmgr.getcoupons" + ], + "title": "CouponMgr.getCoupons" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupons", + "tags": [ + "getcoupons", + "couponmgr.getcoupons" + ], + "title": "CouponMgr.getCoupons" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getRedemptions", + "tags": [ + "getredemptions", + "couponmgr.getredemptions" + ], + "title": "CouponMgr.getRedemptions" + }, + { + "id": "script-api:dw/campaign/CouponMgr#getRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getRedemptions", + "tags": [ + "getredemptions", + "couponmgr.getredemptions" + ], + "title": "CouponMgr.getRedemptions" + }, + { + "id": "script-api:dw/campaign/CouponMgr#maskRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.maskRedemptions", + "tags": [ + "maskredemptions", + "couponmgr.maskredemptions" + ], + "title": "CouponMgr.maskRedemptions" + }, + { + "id": "script-api:dw/campaign/CouponMgr#maskRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.maskRedemptions", + "tags": [ + "maskredemptions", + "couponmgr.maskredemptions" + ], + "title": "CouponMgr.maskRedemptions" + }, + { + "id": "script-api:dw/campaign/CouponRedemption", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponRedemption", + "tags": [ + "couponredemption", + "dw.campaign.couponredemption", + "dw/campaign" + ], + "title": "CouponRedemption" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#customerEmail", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.customerEmail", + "tags": [ + "customeremail", + "couponredemption.customeremail" + ], + "title": "CouponRedemption.customerEmail" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#getCustomerEmail", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getCustomerEmail", + "tags": [ + "getcustomeremail", + "couponredemption.getcustomeremail" + ], + "title": "CouponRedemption.getCustomerEmail" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#getOrderNo", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getOrderNo", + "tags": [ + "getorderno", + "couponredemption.getorderno" + ], + "title": "CouponRedemption.getOrderNo" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#getRedemptionDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getRedemptionDate", + "tags": [ + "getredemptiondate", + "couponredemption.getredemptiondate" + ], + "title": "CouponRedemption.getRedemptionDate" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#orderNo", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.orderNo", + "tags": [ + "orderno", + "couponredemption.orderno" + ], + "title": "CouponRedemption.orderNo" + }, + { + "id": "script-api:dw/campaign/CouponRedemption#redemptionDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.redemptionDate", + "tags": [ + "redemptiondate", + "couponredemption.redemptiondate" + ], + "title": "CouponRedemption.redemptionDate" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponStatusCodes", + "tags": [ + "couponstatuscodes", + "dw.campaign.couponstatuscodes", + "dw/campaign" + ], + "title": "CouponStatusCodes" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#APPLIED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.APPLIED", + "tags": [ + "applied", + "couponstatuscodes.applied" + ], + "title": "CouponStatusCodes.APPLIED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#APPLIED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.APPLIED", + "tags": [ + "applied", + "couponstatuscodes.applied" + ], + "title": "CouponStatusCodes.APPLIED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET", + "tags": [ + "coupon_already_in_basket", + "couponstatuscodes.coupon_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_ALREADY_IN_BASKET" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET", + "tags": [ + "coupon_already_in_basket", + "couponstatuscodes.coupon_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_ALREADY_IN_BASKET" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET", + "tags": [ + "coupon_code_already_in_basket", + "couponstatuscodes.coupon_code_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET", + "tags": [ + "coupon_code_already_in_basket", + "couponstatuscodes.coupon_code_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_REDEEMED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED", + "tags": [ + "coupon_code_already_redeemed", + "couponstatuscodes.coupon_code_already_redeemed" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_REDEEMED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED", + "tags": [ + "coupon_code_already_redeemed", + "couponstatuscodes.coupon_code_already_redeemed" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_UNKNOWN", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN", + "tags": [ + "coupon_code_unknown", + "couponstatuscodes.coupon_code_unknown" + ], + "title": "CouponStatusCodes.COUPON_CODE_UNKNOWN" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_UNKNOWN", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN", + "tags": [ + "coupon_code_unknown", + "couponstatuscodes.coupon_code_unknown" + ], + "title": "CouponStatusCodes.COUPON_CODE_UNKNOWN" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_DISABLED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_DISABLED", + "tags": [ + "coupon_disabled", + "couponstatuscodes.coupon_disabled" + ], + "title": "CouponStatusCodes.COUPON_DISABLED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_DISABLED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_DISABLED", + "tags": [ + "coupon_disabled", + "couponstatuscodes.coupon_disabled" + ], + "title": "CouponStatusCodes.COUPON_DISABLED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "customer_redemption_limit_exceeded", + "couponstatuscodes.customer_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "customer_redemption_limit_exceeded", + "couponstatuscodes.customer_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#NO_ACTIVE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION", + "tags": [ + "no_active_promotion", + "couponstatuscodes.no_active_promotion" + ], + "title": "CouponStatusCodes.NO_ACTIVE_PROMOTION" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#NO_ACTIVE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION", + "tags": [ + "no_active_promotion", + "couponstatuscodes.no_active_promotion" + ], + "title": "CouponStatusCodes.NO_ACTIVE_PROMOTION" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#NO_APPLICABLE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "tags": [ + "no_applicable_promotion", + "couponstatuscodes.no_applicable_promotion" + ], + "title": "CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#NO_APPLICABLE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "tags": [ + "no_applicable_promotion", + "couponstatuscodes.no_applicable_promotion" + ], + "title": "CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "redemption_limit_exceeded", + "couponstatuscodes.redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "redemption_limit_exceeded", + "couponstatuscodes.redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "timeframe_redemption_limit_exceeded", + "couponstatuscodes.timeframe_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/CouponStatusCodes#TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "tags": [ + "timeframe_redemption_limit_exceeded", + "couponstatuscodes.timeframe_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/campaign/Discount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Discount", + "tags": [ + "discount", + "dw.campaign.discount", + "dw/campaign" + ], + "title": "Discount" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_AMOUNT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_AMOUNT", + "tags": [ + "type_amount", + "discount.type_amount" + ], + "title": "Discount.TYPE_AMOUNT" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_AMOUNT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_AMOUNT", + "tags": [ + "type_amount", + "discount.type_amount" + ], + "title": "Discount.TYPE_AMOUNT" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_BONUS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS", + "tags": [ + "type_bonus", + "discount.type_bonus" + ], + "title": "Discount.TYPE_BONUS" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_BONUS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS", + "tags": [ + "type_bonus", + "discount.type_bonus" + ], + "title": "Discount.TYPE_BONUS" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_BONUS_CHOICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS_CHOICE", + "tags": [ + "type_bonus_choice", + "discount.type_bonus_choice" + ], + "title": "Discount.TYPE_BONUS_CHOICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_BONUS_CHOICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS_CHOICE", + "tags": [ + "type_bonus_choice", + "discount.type_bonus_choice" + ], + "title": "Discount.TYPE_BONUS_CHOICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE", + "tags": [ + "type_fixed_price", + "discount.type_fixed_price" + ], + "title": "Discount.TYPE_FIXED_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE", + "tags": [ + "type_fixed_price", + "discount.type_fixed_price" + ], + "title": "Discount.TYPE_FIXED_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE_SHIPPING", + "tags": [ + "type_fixed_price_shipping", + "discount.type_fixed_price_shipping" + ], + "title": "Discount.TYPE_FIXED_PRICE_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE_SHIPPING", + "tags": [ + "type_fixed_price_shipping", + "discount.type_fixed_price_shipping" + ], + "title": "Discount.TYPE_FIXED_PRICE_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FREE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE", + "tags": [ + "type_free", + "discount.type_free" + ], + "title": "Discount.TYPE_FREE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FREE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE", + "tags": [ + "type_free", + "discount.type_free" + ], + "title": "Discount.TYPE_FREE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FREE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE_SHIPPING", + "tags": [ + "type_free_shipping", + "discount.type_free_shipping" + ], + "title": "Discount.TYPE_FREE_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_FREE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE_SHIPPING", + "tags": [ + "type_free_shipping", + "discount.type_free_shipping" + ], + "title": "Discount.TYPE_FREE_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE", + "tags": [ + "type_percentage", + "discount.type_percentage" + ], + "title": "Discount.TYPE_PERCENTAGE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE", + "tags": [ + "type_percentage", + "discount.type_percentage" + ], + "title": "Discount.TYPE_PERCENTAGE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE_OFF_OPTIONS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE_OFF_OPTIONS", + "tags": [ + "type_percentage_off_options", + "discount.type_percentage_off_options" + ], + "title": "Discount.TYPE_PERCENTAGE_OFF_OPTIONS" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE_OFF_OPTIONS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE_OFF_OPTIONS", + "tags": [ + "type_percentage_off_options", + "discount.type_percentage_off_options" + ], + "title": "Discount.TYPE_PERCENTAGE_OFF_OPTIONS" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PRICEBOOK_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PRICEBOOK_PRICE", + "tags": [ + "type_pricebook_price", + "discount.type_pricebook_price" + ], + "title": "Discount.TYPE_PRICEBOOK_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_PRICEBOOK_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PRICEBOOK_PRICE", + "tags": [ + "type_pricebook_price", + "discount.type_pricebook_price" + ], + "title": "Discount.TYPE_PRICEBOOK_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_TOTAL_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_TOTAL_FIXED_PRICE", + "tags": [ + "type_total_fixed_price", + "discount.type_total_fixed_price" + ], + "title": "Discount.TYPE_TOTAL_FIXED_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#TYPE_TOTAL_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_TOTAL_FIXED_PRICE", + "tags": [ + "type_total_fixed_price", + "discount.type_total_fixed_price" + ], + "title": "Discount.TYPE_TOTAL_FIXED_PRICE" + }, + { + "id": "script-api:dw/campaign/Discount#getItemPromotionTiers", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getItemPromotionTiers", + "tags": [ + "getitempromotiontiers", + "discount.getitempromotiontiers" + ], + "title": "Discount.getItemPromotionTiers" + }, + { + "id": "script-api:dw/campaign/Discount#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getPromotion", + "tags": [ + "getpromotion", + "discount.getpromotion" + ], + "title": "Discount.getPromotion" + }, + { + "id": "script-api:dw/campaign/Discount#getPromotionTier", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getPromotionTier", + "tags": [ + "getpromotiontier", + "discount.getpromotiontier" + ], + "title": "Discount.getPromotionTier" + }, + { + "id": "script-api:dw/campaign/Discount#getQuantity", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getQuantity", + "tags": [ + "getquantity", + "discount.getquantity" + ], + "title": "Discount.getQuantity" + }, + { + "id": "script-api:dw/campaign/Discount#getType", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getType", + "tags": [ + "gettype", + "discount.gettype" + ], + "title": "Discount.getType" + }, + { + "id": "script-api:dw/campaign/Discount#itemPromotionTiers", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.itemPromotionTiers", + "tags": [ + "itempromotiontiers", + "discount.itempromotiontiers" + ], + "title": "Discount.itemPromotionTiers" + }, + { + "id": "script-api:dw/campaign/Discount#promotion", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.promotion", + "tags": [ + "promotion", + "discount.promotion" + ], + "title": "Discount.promotion" + }, + { + "id": "script-api:dw/campaign/Discount#promotionTier", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.promotionTier", + "tags": [ + "promotiontier", + "discount.promotiontier" + ], + "title": "Discount.promotionTier" + }, + { + "id": "script-api:dw/campaign/Discount#quantity", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.quantity", + "tags": [ + "quantity", + "discount.quantity" + ], + "title": "Discount.quantity" + }, + { + "id": "script-api:dw/campaign/Discount#type", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.type", + "tags": [ + "type", + "discount.type" + ], + "title": "Discount.type" + }, + { + "id": "script-api:dw/campaign/DiscountPlan", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.DiscountPlan", + "tags": [ + "discountplan", + "dw.campaign.discountplan", + "dw/campaign" + ], + "title": "DiscountPlan" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#approachingOrderDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.approachingOrderDiscounts", + "tags": [ + "approachingorderdiscounts", + "discountplan.approachingorderdiscounts" + ], + "title": "DiscountPlan.approachingOrderDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#bonusDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.bonusDiscounts", + "tags": [ + "bonusdiscounts", + "discountplan.bonusdiscounts" + ], + "title": "DiscountPlan.bonusDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getApproachingOrderDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingOrderDiscounts", + "tags": [ + "getapproachingorderdiscounts", + "discountplan.getapproachingorderdiscounts" + ], + "title": "DiscountPlan.getApproachingOrderDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getBonusDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getBonusDiscounts", + "tags": [ + "getbonusdiscounts", + "discountplan.getbonusdiscounts" + ], + "title": "DiscountPlan.getBonusDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getLineItemCtnr", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getLineItemCtnr", + "tags": [ + "getlineitemctnr", + "discountplan.getlineitemctnr" + ], + "title": "DiscountPlan.getLineItemCtnr" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getOrderDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getOrderDiscounts", + "tags": [ + "getorderdiscounts", + "discountplan.getorderdiscounts" + ], + "title": "DiscountPlan.getOrderDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getProductDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getProductDiscounts", + "tags": [ + "getproductdiscounts", + "discountplan.getproductdiscounts" + ], + "title": "DiscountPlan.getProductDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getProductShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getProductShippingDiscounts", + "tags": [ + "getproductshippingdiscounts", + "discountplan.getproductshippingdiscounts" + ], + "title": "DiscountPlan.getProductShippingDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#getShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getShippingDiscounts", + "tags": [ + "getshippingdiscounts", + "discountplan.getshippingdiscounts" + ], + "title": "DiscountPlan.getShippingDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#lineItemCtnr", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.lineItemCtnr", + "tags": [ + "lineitemctnr", + "discountplan.lineitemctnr" + ], + "title": "DiscountPlan.lineItemCtnr" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#orderDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.orderDiscounts", + "tags": [ + "orderdiscounts", + "discountplan.orderdiscounts" + ], + "title": "DiscountPlan.orderDiscounts" + }, + { + "id": "script-api:dw/campaign/DiscountPlan#removeDiscount", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.removeDiscount", + "tags": [ + "removediscount", + "discountplan.removediscount" + ], + "title": "DiscountPlan.removeDiscount" + }, + { + "id": "script-api:dw/campaign/FixedPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FixedPriceDiscount", + "tags": [ + "fixedpricediscount", + "dw.campaign.fixedpricediscount", + "dw/campaign" + ], + "title": "FixedPriceDiscount" + }, + { + "id": "script-api:dw/campaign/FixedPriceDiscount#fixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceDiscount", + "qualifiedName": "dw.campaign.FixedPriceDiscount.fixedPrice", + "tags": [ + "fixedprice", + "fixedpricediscount.fixedprice" + ], + "title": "FixedPriceDiscount.fixedPrice" + }, + { + "id": "script-api:dw/campaign/FixedPriceDiscount#getFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceDiscount", + "qualifiedName": "dw.campaign.FixedPriceDiscount.getFixedPrice", + "tags": [ + "getfixedprice", + "fixedpricediscount.getfixedprice" + ], + "title": "FixedPriceDiscount.getFixedPrice" + }, + { + "id": "script-api:dw/campaign/FixedPriceShippingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount", + "tags": [ + "fixedpriceshippingdiscount", + "dw.campaign.fixedpriceshippingdiscount", + "dw/campaign" + ], + "title": "FixedPriceShippingDiscount" + }, + { + "id": "script-api:dw/campaign/FixedPriceShippingDiscount#fixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceShippingDiscount", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount.fixedPrice", + "tags": [ + "fixedprice", + "fixedpriceshippingdiscount.fixedprice" + ], + "title": "FixedPriceShippingDiscount.fixedPrice" + }, + { + "id": "script-api:dw/campaign/FixedPriceShippingDiscount#getFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceShippingDiscount", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount.getFixedPrice", + "tags": [ + "getfixedprice", + "fixedpriceshippingdiscount.getfixedprice" + ], + "title": "FixedPriceShippingDiscount.getFixedPrice" + }, + { + "id": "script-api:dw/campaign/FreeDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FreeDiscount", + "tags": [ + "freediscount", + "dw.campaign.freediscount", + "dw/campaign" + ], + "title": "FreeDiscount" + }, + { + "id": "script-api:dw/campaign/FreeShippingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FreeShippingDiscount", + "tags": [ + "freeshippingdiscount", + "dw.campaign.freeshippingdiscount", + "dw/campaign" + ], + "title": "FreeShippingDiscount" + }, + { + "id": "script-api:dw/campaign/PercentageDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PercentageDiscount", + "tags": [ + "percentagediscount", + "dw.campaign.percentagediscount", + "dw/campaign" + ], + "title": "PercentageDiscount" + }, + { + "id": "script-api:dw/campaign/PercentageDiscount#getPercentage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageDiscount", + "qualifiedName": "dw.campaign.PercentageDiscount.getPercentage", + "tags": [ + "getpercentage", + "percentagediscount.getpercentage" + ], + "title": "PercentageDiscount.getPercentage" + }, + { + "id": "script-api:dw/campaign/PercentageDiscount#percentage", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageDiscount", + "qualifiedName": "dw.campaign.PercentageDiscount.percentage", + "tags": [ + "percentage", + "percentagediscount.percentage" + ], + "title": "PercentageDiscount.percentage" + }, + { + "id": "script-api:dw/campaign/PercentageOptionDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PercentageOptionDiscount", + "tags": [ + "percentageoptiondiscount", + "dw.campaign.percentageoptiondiscount", + "dw/campaign" + ], + "title": "PercentageOptionDiscount" + }, + { + "id": "script-api:dw/campaign/PercentageOptionDiscount#getPercentage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageOptionDiscount", + "qualifiedName": "dw.campaign.PercentageOptionDiscount.getPercentage", + "tags": [ + "getpercentage", + "percentageoptiondiscount.getpercentage" + ], + "title": "PercentageOptionDiscount.getPercentage" + }, + { + "id": "script-api:dw/campaign/PercentageOptionDiscount#percentage", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageOptionDiscount", + "qualifiedName": "dw.campaign.PercentageOptionDiscount.percentage", + "tags": [ + "percentage", + "percentageoptiondiscount.percentage" + ], + "title": "PercentageOptionDiscount.percentage" + }, + { + "id": "script-api:dw/campaign/PriceBookPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount", + "tags": [ + "pricebookpricediscount", + "dw.campaign.pricebookpricediscount", + "dw/campaign" + ], + "title": "PriceBookPriceDiscount" + }, + { + "id": "script-api:dw/campaign/PriceBookPriceDiscount#getPriceBookID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PriceBookPriceDiscount", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount.getPriceBookID", + "tags": [ + "getpricebookid", + "pricebookpricediscount.getpricebookid" + ], + "title": "PriceBookPriceDiscount.getPriceBookID" + }, + { + "id": "script-api:dw/campaign/PriceBookPriceDiscount#priceBookID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PriceBookPriceDiscount", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount.priceBookID", + "tags": [ + "pricebookid", + "pricebookpricediscount.pricebookid" + ], + "title": "PriceBookPriceDiscount.priceBookID" + }, + { + "id": "script-api:dw/campaign/Promotion", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Promotion", + "tags": [ + "promotion", + "dw.campaign.promotion", + "dw/campaign" + ], + "title": "Promotion" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_CLASS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_CLASS", + "tags": [ + "exclusivity_class", + "promotion.exclusivity_class" + ], + "title": "Promotion.EXCLUSIVITY_CLASS" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_CLASS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_CLASS", + "tags": [ + "exclusivity_class", + "promotion.exclusivity_class" + ], + "title": "Promotion.EXCLUSIVITY_CLASS" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_GLOBAL", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_GLOBAL", + "tags": [ + "exclusivity_global", + "promotion.exclusivity_global" + ], + "title": "Promotion.EXCLUSIVITY_GLOBAL" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_GLOBAL", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_GLOBAL", + "tags": [ + "exclusivity_global", + "promotion.exclusivity_global" + ], + "title": "Promotion.EXCLUSIVITY_GLOBAL" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_NO", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_NO", + "tags": [ + "exclusivity_no", + "promotion.exclusivity_no" + ], + "title": "Promotion.EXCLUSIVITY_NO" + }, + { + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_NO", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_NO", + "tags": [ + "exclusivity_no", + "promotion.exclusivity_no" + ], + "title": "Promotion.EXCLUSIVITY_NO" + }, + { + "id": "script-api:dw/campaign/Promotion#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.ID", + "tags": [ + "id", + "promotion.id" + ], + "title": "Promotion.ID" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_ORDER", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_ORDER", + "tags": [ + "promotion_class_order", + "promotion.promotion_class_order" + ], + "title": "Promotion.PROMOTION_CLASS_ORDER" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_ORDER", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_ORDER", + "tags": [ + "promotion_class_order", + "promotion.promotion_class_order" + ], + "title": "Promotion.PROMOTION_CLASS_ORDER" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_PRODUCT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_PRODUCT", + "tags": [ + "promotion_class_product", + "promotion.promotion_class_product" + ], + "title": "Promotion.PROMOTION_CLASS_PRODUCT" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_PRODUCT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_PRODUCT", + "tags": [ + "promotion_class_product", + "promotion.promotion_class_product" + ], + "title": "Promotion.PROMOTION_CLASS_PRODUCT" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_SHIPPING", + "tags": [ + "promotion_class_shipping", + "promotion.promotion_class_shipping" + ], + "title": "Promotion.PROMOTION_CLASS_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_SHIPPING", + "tags": [ + "promotion_class_shipping", + "promotion.promotion_class_shipping" + ], + "title": "Promotion.PROMOTION_CLASS_SHIPPING" + }, + { + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ALL", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ALL", + "tags": [ + "qualifier_match_mode_all", + "promotion.qualifier_match_mode_all" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ALL" + }, + { + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ALL", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ALL", + "tags": [ + "qualifier_match_mode_all", + "promotion.qualifier_match_mode_all" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ALL" + }, + { + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ANY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ANY", + "tags": [ + "qualifier_match_mode_any", + "promotion.qualifier_match_mode_any" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ANY" + }, + { + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ANY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ANY", + "tags": [ + "qualifier_match_mode_any", + "promotion.qualifier_match_mode_any" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ANY" + }, + { + "id": "script-api:dw/campaign/Promotion#active", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.active", + "tags": [ + "active", + "promotion.active" + ], + "title": "Promotion.active" + }, + { + "id": "script-api:dw/campaign/Promotion#basedOnCoupon", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCoupon", + "tags": [ + "basedoncoupon", + "promotion.basedoncoupon" + ], + "title": "Promotion.basedOnCoupon" + }, + { + "id": "script-api:dw/campaign/Promotion#basedOnCoupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCoupons", + "tags": [ + "basedoncoupons", + "promotion.basedoncoupons" + ], + "title": "Promotion.basedOnCoupons" + }, + { + "id": "script-api:dw/campaign/Promotion#basedOnCustomerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCustomerGroups", + "tags": [ + "basedoncustomergroups", + "promotion.basedoncustomergroups" + ], + "title": "Promotion.basedOnCustomerGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#basedOnSourceCodes", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnSourceCodes", + "tags": [ + "basedonsourcecodes", + "promotion.basedonsourcecodes" + ], + "title": "Promotion.basedOnSourceCodes" + }, + { + "id": "script-api:dw/campaign/Promotion#calloutMsg", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.calloutMsg", + "tags": [ + "calloutmsg", + "promotion.calloutmsg" + ], + "title": "Promotion.calloutMsg" + }, + { + "id": "script-api:dw/campaign/Promotion#campaign", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.campaign", + "tags": [ + "campaign", + "promotion.campaign" + ], + "title": "Promotion.campaign" + }, + { + "id": "script-api:dw/campaign/Promotion#combinablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.combinablePromotions", + "tags": [ + "combinablepromotions", + "promotion.combinablepromotions" + ], + "title": "Promotion.combinablePromotions" + }, + { + "id": "script-api:dw/campaign/Promotion#conditionalDescription", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.conditionalDescription", + "tags": [ + "conditionaldescription", + "promotion.conditionaldescription" + ], + "title": "Promotion.conditionalDescription" + }, + { + "id": "script-api:dw/campaign/Promotion#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.coupons", + "tags": [ + "coupons", + "promotion.coupons" + ], + "title": "Promotion.coupons" + }, + { + "id": "script-api:dw/campaign/Promotion#customerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.customerGroups", + "tags": [ + "customergroups", + "promotion.customergroups" + ], + "title": "Promotion.customerGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#description", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.description", + "tags": [ + "description", + "promotion.description" + ], + "title": "Promotion.description" + }, + { + "id": "script-api:dw/campaign/Promotion#details", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.details", + "tags": [ + "details", + "promotion.details" + ], + "title": "Promotion.details" + }, + { + "id": "script-api:dw/campaign/Promotion#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.enabled", + "tags": [ + "enabled", + "promotion.enabled" + ], + "title": "Promotion.enabled" + }, + { + "id": "script-api:dw/campaign/Promotion#endDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.endDate", + "tags": [ + "enddate", + "promotion.enddate" + ], + "title": "Promotion.endDate" + }, + { + "id": "script-api:dw/campaign/Promotion#exclusivity", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.exclusivity", + "tags": [ + "exclusivity", + "promotion.exclusivity" + ], + "title": "Promotion.exclusivity" + }, + { + "id": "script-api:dw/campaign/Promotion#getCalloutMsg", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCalloutMsg", + "tags": [ + "getcalloutmsg", + "promotion.getcalloutmsg" + ], + "title": "Promotion.getCalloutMsg" + }, + { + "id": "script-api:dw/campaign/Promotion#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCampaign", + "tags": [ + "getcampaign", + "promotion.getcampaign" + ], + "title": "Promotion.getCampaign" + }, + { + "id": "script-api:dw/campaign/Promotion#getCombinablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCombinablePromotions", + "tags": [ + "getcombinablepromotions", + "promotion.getcombinablepromotions" + ], + "title": "Promotion.getCombinablePromotions" + }, + { + "id": "script-api:dw/campaign/Promotion#getConditionalDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getConditionalDescription", + "tags": [ + "getconditionaldescription", + "promotion.getconditionaldescription" + ], + "title": "Promotion.getConditionalDescription" + }, + { + "id": "script-api:dw/campaign/Promotion#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCoupons", + "tags": [ + "getcoupons", + "promotion.getcoupons" + ], + "title": "Promotion.getCoupons" + }, + { + "id": "script-api:dw/campaign/Promotion#getCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCustomerGroups", + "tags": [ + "getcustomergroups", + "promotion.getcustomergroups" + ], + "title": "Promotion.getCustomerGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#getDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getDescription", + "tags": [ + "getdescription", + "promotion.getdescription" + ], + "title": "Promotion.getDescription" + }, + { + "id": "script-api:dw/campaign/Promotion#getDetails", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getDetails", + "tags": [ + "getdetails", + "promotion.getdetails" + ], + "title": "Promotion.getDetails" + }, + { + "id": "script-api:dw/campaign/Promotion#getEndDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getEndDate", + "tags": [ + "getenddate", + "promotion.getenddate" + ], + "title": "Promotion.getEndDate" + }, + { + "id": "script-api:dw/campaign/Promotion#getExclusivity", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getExclusivity", + "tags": [ + "getexclusivity", + "promotion.getexclusivity" + ], + "title": "Promotion.getExclusivity" + }, + { + "id": "script-api:dw/campaign/Promotion#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getID", + "tags": [ + "getid", + "promotion.getid" + ], + "title": "Promotion.getID" + }, + { + "id": "script-api:dw/campaign/Promotion#getImage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getImage", + "tags": [ + "getimage", + "promotion.getimage" + ], + "title": "Promotion.getImage" + }, + { + "id": "script-api:dw/campaign/Promotion#getLastModified", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getLastModified", + "tags": [ + "getlastmodified", + "promotion.getlastmodified" + ], + "title": "Promotion.getLastModified" + }, + { + "id": "script-api:dw/campaign/Promotion#getMutuallyExclusivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getMutuallyExclusivePromotions", + "tags": [ + "getmutuallyexclusivepromotions", + "promotion.getmutuallyexclusivepromotions" + ], + "title": "Promotion.getMutuallyExclusivePromotions" + }, + { + "id": "script-api:dw/campaign/Promotion#getName", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getName", + "tags": [ + "getname", + "promotion.getname" + ], + "title": "Promotion.getName" + }, + { + "id": "script-api:dw/campaign/Promotion#getPromotionClass", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionClass", + "tags": [ + "getpromotionclass", + "promotion.getpromotionclass" + ], + "title": "Promotion.getPromotionClass" + }, + { + "id": "script-api:dw/campaign/Promotion#getPromotionalPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionalPrice", + "tags": [ + "getpromotionalprice", + "promotion.getpromotionalprice" + ], + "title": "Promotion.getPromotionalPrice" + }, + { + "id": "script-api:dw/campaign/Promotion#getPromotionalPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionalPrice", + "tags": [ + "getpromotionalprice", + "promotion.getpromotionalprice" + ], + "title": "Promotion.getPromotionalPrice" + }, + { + "id": "script-api:dw/campaign/Promotion#getQualifierMatchMode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getQualifierMatchMode", + "tags": [ + "getqualifiermatchmode", + "promotion.getqualifiermatchmode" + ], + "title": "Promotion.getQualifierMatchMode" + }, + { + "id": "script-api:dw/campaign/Promotion#getRank", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getRank", + "tags": [ + "getrank", + "promotion.getrank" + ], + "title": "Promotion.getRank" + }, + { + "id": "script-api:dw/campaign/Promotion#getSourceCodeGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getSourceCodeGroups", + "tags": [ + "getsourcecodegroups", + "promotion.getsourcecodegroups" + ], + "title": "Promotion.getSourceCodeGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#getStartDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getStartDate", + "tags": [ + "getstartdate", + "promotion.getstartdate" + ], + "title": "Promotion.getStartDate" + }, + { + "id": "script-api:dw/campaign/Promotion#getTags", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getTags", + "tags": [ + "gettags", + "promotion.gettags" + ], + "title": "Promotion.getTags" + }, + { + "id": "script-api:dw/campaign/Promotion#image", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.image", + "tags": [ + "image", + "promotion.image" + ], + "title": "Promotion.image" + }, + { + "id": "script-api:dw/campaign/Promotion#isActive", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isActive", + "tags": [ + "isactive", + "promotion.isactive" + ], + "title": "Promotion.isActive" + }, + { + "id": "script-api:dw/campaign/Promotion#isBasedOnCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCoupon", + "tags": [ + "isbasedoncoupon", + "promotion.isbasedoncoupon" + ], + "title": "Promotion.isBasedOnCoupon" + }, + { + "id": "script-api:dw/campaign/Promotion#isBasedOnCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCoupons", + "tags": [ + "isbasedoncoupons", + "promotion.isbasedoncoupons" + ], + "title": "Promotion.isBasedOnCoupons" + }, + { + "id": "script-api:dw/campaign/Promotion#isBasedOnCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCustomerGroups", + "tags": [ + "isbasedoncustomergroups", + "promotion.isbasedoncustomergroups" + ], + "title": "Promotion.isBasedOnCustomerGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#isBasedOnSourceCodes", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnSourceCodes", + "tags": [ + "isbasedonsourcecodes", + "promotion.isbasedonsourcecodes" + ], + "title": "Promotion.isBasedOnSourceCodes" + }, + { + "id": "script-api:dw/campaign/Promotion#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isEnabled", + "tags": [ + "isenabled", + "promotion.isenabled" + ], + "title": "Promotion.isEnabled" + }, + { + "id": "script-api:dw/campaign/Promotion#isRefinable", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isRefinable", + "tags": [ + "isrefinable", + "promotion.isrefinable" + ], + "title": "Promotion.isRefinable" + }, + { + "id": "script-api:dw/campaign/Promotion#lastModified", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.lastModified", + "tags": [ + "lastmodified", + "promotion.lastmodified" + ], + "title": "Promotion.lastModified" + }, + { + "id": "script-api:dw/campaign/Promotion#mutuallyExclusivePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.mutuallyExclusivePromotions", + "tags": [ + "mutuallyexclusivepromotions", + "promotion.mutuallyexclusivepromotions" + ], + "title": "Promotion.mutuallyExclusivePromotions" + }, + { + "id": "script-api:dw/campaign/Promotion#name", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.name", + "tags": [ + "name", + "promotion.name" + ], + "title": "Promotion.name" + }, + { + "id": "script-api:dw/campaign/Promotion#promotionClass", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.promotionClass", + "tags": [ + "promotionclass", + "promotion.promotionclass" + ], + "title": "Promotion.promotionClass" + }, + { + "id": "script-api:dw/campaign/Promotion#qualifierMatchMode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.qualifierMatchMode", + "tags": [ + "qualifiermatchmode", + "promotion.qualifiermatchmode" + ], + "title": "Promotion.qualifierMatchMode" + }, + { + "id": "script-api:dw/campaign/Promotion#rank", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.rank", + "tags": [ + "rank", + "promotion.rank" + ], + "title": "Promotion.rank" + }, + { + "id": "script-api:dw/campaign/Promotion#refinable", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.refinable", + "tags": [ + "refinable", + "promotion.refinable" + ], + "title": "Promotion.refinable" + }, + { + "id": "script-api:dw/campaign/Promotion#sourceCodeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.sourceCodeGroups", + "tags": [ + "sourcecodegroups", + "promotion.sourcecodegroups" + ], + "title": "Promotion.sourceCodeGroups" + }, + { + "id": "script-api:dw/campaign/Promotion#startDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.startDate", + "tags": [ + "startdate", + "promotion.startdate" + ], + "title": "Promotion.startDate" + }, + { + "id": "script-api:dw/campaign/Promotion#tags", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.tags", + "tags": [ + "tags", + "promotion.tags" + ], + "title": "Promotion.tags" + }, + { + "id": "script-api:dw/campaign/PromotionMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PromotionMgr", + "tags": [ + "promotionmgr", + "dw.campaign.promotionmgr", + "dw/campaign" + ], + "title": "PromotionMgr" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#activeCustomerPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activeCustomerPromotions", + "tags": [ + "activecustomerpromotions", + "promotionmgr.activecustomerpromotions" + ], + "title": "PromotionMgr.activeCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#activeCustomerPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activeCustomerPromotions", + "tags": [ + "activecustomerpromotions", + "promotionmgr.activecustomerpromotions" + ], + "title": "PromotionMgr.activeCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#activePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activePromotions", + "tags": [ + "activepromotions", + "promotionmgr.activepromotions" + ], + "title": "PromotionMgr.activePromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#activePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activePromotions", + "tags": [ + "activepromotions", + "promotionmgr.activepromotions" + ], + "title": "PromotionMgr.activePromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#campaigns", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.campaigns", + "tags": [ + "campaigns", + "promotionmgr.campaigns" + ], + "title": "PromotionMgr.campaigns" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#campaigns", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.campaigns", + "tags": [ + "campaigns", + "promotionmgr.campaigns" + ], + "title": "PromotionMgr.campaigns" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotionsForCampaign", + "tags": [ + "getactivecustomerpromotionsforcampaign", + "promotionmgr.getactivecustomerpromotionsforcampaign" + ], + "title": "PromotionMgr.getActiveCustomerPromotionsForCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotionsForCampaign", + "tags": [ + "getactivecustomerpromotionsforcampaign", + "promotionmgr.getactivecustomerpromotionsforcampaign" + ], + "title": "PromotionMgr.getActiveCustomerPromotionsForCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotions", + "tags": [ + "getactivepromotions", + "promotionmgr.getactivepromotions" + ], + "title": "PromotionMgr.getActivePromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotions", + "tags": [ + "getactivepromotions", + "promotionmgr.getactivepromotions" + ], + "title": "PromotionMgr.getActivePromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotionsForCampaign", + "tags": [ + "getactivepromotionsforcampaign", + "promotionmgr.getactivepromotionsforcampaign" + ], + "title": "PromotionMgr.getActivePromotionsForCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotionsForCampaign", + "tags": [ + "getactivepromotionsforcampaign", + "promotionmgr.getactivepromotionsforcampaign" + ], + "title": "PromotionMgr.getActivePromotionsForCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaign", + "tags": [ + "getcampaign", + "promotionmgr.getcampaign" + ], + "title": "PromotionMgr.getCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaign", + "tags": [ + "getcampaign", + "promotionmgr.getcampaign" + ], + "title": "PromotionMgr.getCampaign" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getCampaigns", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaigns", + "tags": [ + "getcampaigns", + "promotionmgr.getcampaigns" + ], + "title": "PromotionMgr.getCampaigns" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getCampaigns", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaigns", + "tags": [ + "getcampaigns", + "promotionmgr.getcampaigns" + ], + "title": "PromotionMgr.getCampaigns" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotion", + "tags": [ + "getpromotion", + "promotionmgr.getpromotion" + ], + "title": "PromotionMgr.getPromotion" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotion", + "tags": [ + "getpromotion", + "promotionmgr.getpromotion" + ], + "title": "PromotionMgr.getPromotion" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotions", + "tags": [ + "getpromotions", + "promotionmgr.getpromotions" + ], + "title": "PromotionMgr.getPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotions", + "tags": [ + "getpromotions", + "promotionmgr.getpromotions" + ], + "title": "PromotionMgr.getPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingCustomerPromotions", + "tags": [ + "getupcomingcustomerpromotions", + "promotionmgr.getupcomingcustomerpromotions" + ], + "title": "PromotionMgr.getUpcomingCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingCustomerPromotions", + "tags": [ + "getupcomingcustomerpromotions", + "promotionmgr.getupcomingcustomerpromotions" + ], + "title": "PromotionMgr.getUpcomingCustomerPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingPromotions", + "tags": [ + "getupcomingpromotions", + "promotionmgr.getupcomingpromotions" + ], + "title": "PromotionMgr.getUpcomingPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingPromotions", + "tags": [ + "getupcomingpromotions", + "promotionmgr.getupcomingpromotions" + ], + "title": "PromotionMgr.getUpcomingPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.promotions", + "tags": [ + "promotions", + "promotionmgr.promotions" + ], + "title": "PromotionMgr.promotions" + }, + { + "id": "script-api:dw/campaign/PromotionMgr#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.promotions", + "tags": [ + "promotions", + "promotionmgr.promotions" + ], + "title": "PromotionMgr.promotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PromotionPlan", + "tags": [ + "promotionplan", + "dw.campaign.promotionplan", + "dw/campaign" + ], + "title": "PromotionPlan" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_EXCLUSIVITY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_EXCLUSIVITY", + "tags": [ + "sort_by_exclusivity", + "promotionplan.sort_by_exclusivity" + ], + "title": "PromotionPlan.SORT_BY_EXCLUSIVITY" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_EXCLUSIVITY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_EXCLUSIVITY", + "tags": [ + "sort_by_exclusivity", + "promotionplan.sort_by_exclusivity" + ], + "title": "PromotionPlan.SORT_BY_EXCLUSIVITY" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_START_DATE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_START_DATE", + "tags": [ + "sort_by_start_date", + "promotionplan.sort_by_start_date" + ], + "title": "PromotionPlan.SORT_BY_START_DATE" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_START_DATE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_START_DATE", + "tags": [ + "sort_by_start_date", + "promotionplan.sort_by_start_date" + ], + "title": "PromotionPlan.SORT_BY_START_DATE" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getOrderPromotions", + "tags": [ + "getorderpromotions", + "promotionplan.getorderpromotions" + ], + "title": "PromotionPlan.getOrderPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getPaymentCardPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPaymentCardPromotions", + "tags": [ + "getpaymentcardpromotions", + "promotionplan.getpaymentcardpromotions" + ], + "title": "PromotionPlan.getPaymentCardPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getPaymentMethodPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPaymentMethodPromotions", + "tags": [ + "getpaymentmethodpromotions", + "promotionplan.getpaymentmethodpromotions" + ], + "title": "PromotionPlan.getPaymentMethodPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotions", + "tags": [ + "getproductpromotions", + "promotionplan.getproductpromotions" + ], + "title": "PromotionPlan.getProductPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotions", + "tags": [ + "getproductpromotions", + "promotionplan.getproductpromotions" + ], + "title": "PromotionPlan.getProductPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotionsForDiscountedProduct", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotionsForDiscountedProduct", + "tags": [ + "getproductpromotionsfordiscountedproduct", + "promotionplan.getproductpromotionsfordiscountedproduct" + ], + "title": "PromotionPlan.getProductPromotionsForDiscountedProduct" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotionsForQualifyingProduct", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotionsForQualifyingProduct", + "tags": [ + "getproductpromotionsforqualifyingproduct", + "promotionplan.getproductpromotionsforqualifyingproduct" + ], + "title": "PromotionPlan.getProductPromotionsForQualifyingProduct" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getShippingPromotions", + "tags": [ + "getshippingpromotions", + "promotionplan.getshippingpromotions" + ], + "title": "PromotionPlan.getShippingPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#getShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getShippingPromotions", + "tags": [ + "getshippingpromotions", + "promotionplan.getshippingpromotions" + ], + "title": "PromotionPlan.getShippingPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#orderPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.orderPromotions", + "tags": [ + "orderpromotions", + "promotionplan.orderpromotions" + ], + "title": "PromotionPlan.orderPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#productPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.productPromotions", + "tags": [ + "productpromotions", + "promotionplan.productpromotions" + ], + "title": "PromotionPlan.productPromotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.promotions", + "tags": [ + "promotions", + "promotionplan.promotions" + ], + "title": "PromotionPlan.promotions" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#removePromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.removePromotion", + "tags": [ + "removepromotion", + "promotionplan.removepromotion" + ], + "title": "PromotionPlan.removePromotion" + }, + { + "id": "script-api:dw/campaign/PromotionPlan#shippingPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.shippingPromotions", + "tags": [ + "shippingpromotions", + "promotionplan.shippingpromotions" + ], + "title": "PromotionPlan.shippingPromotions" + }, + { + "id": "script-api:dw/campaign/SlotContent", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SlotContent", + "tags": [ + "slotcontent", + "dw.campaign.slotcontent", + "dw/campaign" + ], + "title": "SlotContent" + }, + { + "id": "script-api:dw/campaign/SlotContent#calloutMsg", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.calloutMsg", + "tags": [ + "calloutmsg", + "slotcontent.calloutmsg" + ], + "title": "SlotContent.calloutMsg" + }, + { + "id": "script-api:dw/campaign/SlotContent#content", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.content", + "tags": [ + "content", + "slotcontent.content" + ], + "title": "SlotContent.content" + }, + { + "id": "script-api:dw/campaign/SlotContent#custom", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.custom", + "tags": [ + "custom", + "slotcontent.custom" + ], + "title": "SlotContent.custom" + }, + { + "id": "script-api:dw/campaign/SlotContent#getCalloutMsg", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getCalloutMsg", + "tags": [ + "getcalloutmsg", + "slotcontent.getcalloutmsg" + ], + "title": "SlotContent.getCalloutMsg" + }, + { + "id": "script-api:dw/campaign/SlotContent#getContent", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getContent", + "tags": [ + "getcontent", + "slotcontent.getcontent" + ], + "title": "SlotContent.getContent" + }, + { + "id": "script-api:dw/campaign/SlotContent#getCustom", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getCustom", + "tags": [ + "getcustom", + "slotcontent.getcustom" + ], + "title": "SlotContent.getCustom" + }, + { + "id": "script-api:dw/campaign/SlotContent#getRecommenderName", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getRecommenderName", + "tags": [ + "getrecommendername", + "slotcontent.getrecommendername" + ], + "title": "SlotContent.getRecommenderName" + }, + { + "id": "script-api:dw/campaign/SlotContent#getSlotID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getSlotID", + "tags": [ + "getslotid", + "slotcontent.getslotid" + ], + "title": "SlotContent.getSlotID" + }, + { + "id": "script-api:dw/campaign/SlotContent#recommenderName", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.recommenderName", + "tags": [ + "recommendername", + "slotcontent.recommendername" + ], + "title": "SlotContent.recommenderName" + }, + { + "id": "script-api:dw/campaign/SlotContent#slotID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.slotID", + "tags": [ + "slotid", + "slotcontent.slotid" + ], + "title": "SlotContent.slotID" + }, + { + "id": "script-api:dw/campaign/SourceCodeGroup", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeGroup", + "tags": [ + "sourcecodegroup", + "dw.campaign.sourcecodegroup", + "dw/campaign" + ], + "title": "SourceCodeGroup" + }, + { + "id": "script-api:dw/campaign/SourceCodeGroup#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.ID", + "tags": [ + "id", + "sourcecodegroup.id" + ], + "title": "SourceCodeGroup.ID" + }, + { + "id": "script-api:dw/campaign/SourceCodeGroup#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.getID", + "tags": [ + "getid", + "sourcecodegroup.getid" + ], + "title": "SourceCodeGroup.getID" + }, + { + "id": "script-api:dw/campaign/SourceCodeGroup#getPriceBooks", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.getPriceBooks", + "tags": [ + "getpricebooks", + "sourcecodegroup.getpricebooks" + ], + "title": "SourceCodeGroup.getPriceBooks" + }, + { + "id": "script-api:dw/campaign/SourceCodeGroup#priceBooks", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.priceBooks", + "tags": [ + "pricebooks", + "sourcecodegroup.pricebooks" + ], + "title": "SourceCodeGroup.priceBooks" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeInfo", + "tags": [ + "sourcecodeinfo", + "dw.campaign.sourcecodeinfo", + "dw/campaign" + ], + "title": "SourceCodeInfo" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_ACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_ACTIVE", + "tags": [ + "status_active", + "sourcecodeinfo.status_active" + ], + "title": "SourceCodeInfo.STATUS_ACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_ACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_ACTIVE", + "tags": [ + "status_active", + "sourcecodeinfo.status_active" + ], + "title": "SourceCodeInfo.STATUS_ACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INACTIVE", + "tags": [ + "status_inactive", + "sourcecodeinfo.status_inactive" + ], + "title": "SourceCodeInfo.STATUS_INACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INACTIVE", + "tags": [ + "status_inactive", + "sourcecodeinfo.status_inactive" + ], + "title": "SourceCodeInfo.STATUS_INACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INVALID", + "tags": [ + "status_invalid", + "sourcecodeinfo.status_invalid" + ], + "title": "SourceCodeInfo.STATUS_INVALID" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INVALID", + "tags": [ + "status_invalid", + "sourcecodeinfo.status_invalid" + ], + "title": "SourceCodeInfo.STATUS_INVALID" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#code", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.code", + "tags": [ + "code", + "sourcecodeinfo.code" + ], + "title": "SourceCodeInfo.code" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#getCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getCode", + "tags": [ + "getcode", + "sourcecodeinfo.getcode" + ], + "title": "SourceCodeInfo.getCode" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#getGroup", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getGroup", + "tags": [ + "getgroup", + "sourcecodeinfo.getgroup" + ], + "title": "SourceCodeInfo.getGroup" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#getRedirect", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getRedirect", + "tags": [ + "getredirect", + "sourcecodeinfo.getredirect" + ], + "title": "SourceCodeInfo.getRedirect" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#getStatus", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getStatus", + "tags": [ + "getstatus", + "sourcecodeinfo.getstatus" + ], + "title": "SourceCodeInfo.getStatus" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#group", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.group", + "tags": [ + "group", + "sourcecodeinfo.group" + ], + "title": "SourceCodeInfo.group" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#redirect", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.redirect", + "tags": [ + "redirect", + "sourcecodeinfo.redirect" + ], + "title": "SourceCodeInfo.redirect" + }, + { + "id": "script-api:dw/campaign/SourceCodeInfo#status", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.status", + "tags": [ + "status", + "sourcecodeinfo.status" + ], + "title": "SourceCodeInfo.status" + }, + { + "id": "script-api:dw/campaign/SourceCodeStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes", + "tags": [ + "sourcecodestatuscodes", + "dw.campaign.sourcecodestatuscodes", + "dw/campaign" + ], + "title": "SourceCodeStatusCodes" + }, + { + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INACTIVE", + "tags": [ + "code_inactive", + "sourcecodestatuscodes.code_inactive" + ], + "title": "SourceCodeStatusCodes.CODE_INACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INACTIVE", + "tags": [ + "code_inactive", + "sourcecodestatuscodes.code_inactive" + ], + "title": "SourceCodeStatusCodes.CODE_INACTIVE" + }, + { + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INVALID", + "tags": [ + "code_invalid", + "sourcecodestatuscodes.code_invalid" + ], + "title": "SourceCodeStatusCodes.CODE_INVALID" + }, + { + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INVALID", + "tags": [ + "code_invalid", + "sourcecodestatuscodes.code_invalid" + ], + "title": "SourceCodeStatusCodes.CODE_INVALID" + }, + { + "id": "script-api:dw/campaign/TotalFixedPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount", + "tags": [ + "totalfixedpricediscount", + "dw.campaign.totalfixedpricediscount", + "dw/campaign" + ], + "title": "TotalFixedPriceDiscount" + }, + { + "id": "script-api:dw/campaign/TotalFixedPriceDiscount#getTotalFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/TotalFixedPriceDiscount", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount.getTotalFixedPrice", + "tags": [ + "gettotalfixedprice", + "totalfixedpricediscount.gettotalfixedprice" + ], + "title": "TotalFixedPriceDiscount.getTotalFixedPrice" + }, + { + "id": "script-api:dw/campaign/TotalFixedPriceDiscount#totalFixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/TotalFixedPriceDiscount", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount.totalFixedPrice", + "tags": [ + "totalfixedprice", + "totalfixedpricediscount.totalfixedprice" + ], + "title": "TotalFixedPriceDiscount.totalFixedPrice" + }, + { + "id": "script-api:dw/catalog", + "kind": "package", + "packagePath": "dw/catalog", + "qualifiedName": "dw.catalog", + "tags": [ + "dw/catalog", + "dw.catalog" + ], + "title": "dw.catalog" + }, + { + "id": "script-api:dw/catalog/Catalog", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Catalog", + "tags": [ + "catalog", + "dw.catalog.catalog", + "dw/catalog" + ], + "title": "Catalog" + }, + { + "id": "script-api:dw/catalog/Catalog#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.ID", + "tags": [ + "id", + "catalog.id" + ], + "title": "Catalog.ID" + }, + { + "id": "script-api:dw/catalog/Catalog#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.description", + "tags": [ + "description", + "catalog.description" + ], + "title": "Catalog.description" + }, + { + "id": "script-api:dw/catalog/Catalog#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.displayName", + "tags": [ + "displayname", + "catalog.displayname" + ], + "title": "Catalog.displayName" + }, + { + "id": "script-api:dw/catalog/Catalog#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getDescription", + "tags": [ + "getdescription", + "catalog.getdescription" + ], + "title": "Catalog.getDescription" + }, + { + "id": "script-api:dw/catalog/Catalog#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getDisplayName", + "tags": [ + "getdisplayname", + "catalog.getdisplayname" + ], + "title": "Catalog.getDisplayName" + }, + { + "id": "script-api:dw/catalog/Catalog#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getID", + "tags": [ + "getid", + "catalog.getid" + ], + "title": "Catalog.getID" + }, + { + "id": "script-api:dw/catalog/Catalog#getRoot", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getRoot", + "tags": [ + "getroot", + "catalog.getroot" + ], + "title": "Catalog.getRoot" + }, + { + "id": "script-api:dw/catalog/Catalog#root", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.root", + "tags": [ + "root", + "catalog.root" + ], + "title": "Catalog.root" + }, + { + "id": "script-api:dw/catalog/CatalogMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CatalogMgr", + "tags": [ + "catalogmgr", + "dw.catalog.catalogmgr", + "dw/catalog" + ], + "title": "CatalogMgr" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCatalog", + "tags": [ + "getcatalog", + "catalogmgr.getcatalog" + ], + "title": "CatalogMgr.getCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCatalog", + "tags": [ + "getcatalog", + "catalogmgr.getcatalog" + ], + "title": "CatalogMgr.getCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCategory", + "tags": [ + "getcategory", + "catalogmgr.getcategory" + ], + "title": "CatalogMgr.getCategory" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCategory", + "tags": [ + "getcategory", + "catalogmgr.getcategory" + ], + "title": "CatalogMgr.getCategory" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSiteCatalog", + "tags": [ + "getsitecatalog", + "catalogmgr.getsitecatalog" + ], + "title": "CatalogMgr.getSiteCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSiteCatalog", + "tags": [ + "getsitecatalog", + "catalogmgr.getsitecatalog" + ], + "title": "CatalogMgr.getSiteCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOption", + "tags": [ + "getsortingoption", + "catalogmgr.getsortingoption" + ], + "title": "CatalogMgr.getSortingOption" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOption", + "tags": [ + "getsortingoption", + "catalogmgr.getsortingoption" + ], + "title": "CatalogMgr.getSortingOption" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOptions", + "tags": [ + "getsortingoptions", + "catalogmgr.getsortingoptions" + ], + "title": "CatalogMgr.getSortingOptions" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOptions", + "tags": [ + "getsortingoptions", + "catalogmgr.getsortingoptions" + ], + "title": "CatalogMgr.getSortingOptions" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRule", + "tags": [ + "getsortingrule", + "catalogmgr.getsortingrule" + ], + "title": "CatalogMgr.getSortingRule" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRule", + "tags": [ + "getsortingrule", + "catalogmgr.getsortingrule" + ], + "title": "CatalogMgr.getSortingRule" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingRules", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRules", + "tags": [ + "getsortingrules", + "catalogmgr.getsortingrules" + ], + "title": "CatalogMgr.getSortingRules" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#getSortingRules", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRules", + "tags": [ + "getsortingrules", + "catalogmgr.getsortingrules" + ], + "title": "CatalogMgr.getSortingRules" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#siteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.siteCatalog", + "tags": [ + "sitecatalog", + "catalogmgr.sitecatalog" + ], + "title": "CatalogMgr.siteCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#siteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.siteCatalog", + "tags": [ + "sitecatalog", + "catalogmgr.sitecatalog" + ], + "title": "CatalogMgr.siteCatalog" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#sortingOptions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingOptions", + "tags": [ + "sortingoptions", + "catalogmgr.sortingoptions" + ], + "title": "CatalogMgr.sortingOptions" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#sortingOptions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingOptions", + "tags": [ + "sortingoptions", + "catalogmgr.sortingoptions" + ], + "title": "CatalogMgr.sortingOptions" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#sortingRules", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingRules", + "tags": [ + "sortingrules", + "catalogmgr.sortingrules" + ], + "title": "CatalogMgr.sortingRules" + }, + { + "id": "script-api:dw/catalog/CatalogMgr#sortingRules", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingRules", + "tags": [ + "sortingrules", + "catalogmgr.sortingrules" + ], + "title": "CatalogMgr.sortingRules" + }, + { + "id": "script-api:dw/catalog/Category", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Category", + "tags": [ + "category", + "dw.catalog.category", + "dw/catalog" + ], + "title": "Category" + }, + { + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_INDIVIDUAL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_INDIVIDUAL", + "tags": [ + "display_mode_individual", + "category.display_mode_individual" + ], + "title": "Category.DISPLAY_MODE_INDIVIDUAL" + }, + { + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_INDIVIDUAL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_INDIVIDUAL", + "tags": [ + "display_mode_individual", + "category.display_mode_individual" + ], + "title": "Category.DISPLAY_MODE_INDIVIDUAL" + }, + { + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_MERGED", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_MERGED", + "tags": [ + "display_mode_merged", + "category.display_mode_merged" + ], + "title": "Category.DISPLAY_MODE_MERGED" + }, + { + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_MERGED", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_MERGED", + "tags": [ + "display_mode_merged", + "category.display_mode_merged" + ], + "title": "Category.DISPLAY_MODE_MERGED" + }, + { + "id": "script-api:dw/catalog/Category#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.ID", + "tags": [ + "id", + "category.id" + ], + "title": "Category.ID" + }, + { + "id": "script-api:dw/catalog/Category#allRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.allRecommendations", + "tags": [ + "allrecommendations", + "category.allrecommendations" + ], + "title": "Category.allRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#categoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.categoryAssignments", + "tags": [ + "categoryassignments", + "category.categoryassignments" + ], + "title": "Category.categoryAssignments" + }, + { + "id": "script-api:dw/catalog/Category#defaultSortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.defaultSortingRule", + "tags": [ + "defaultsortingrule", + "category.defaultsortingrule" + ], + "title": "Category.defaultSortingRule" + }, + { + "id": "script-api:dw/catalog/Category#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.description", + "tags": [ + "description", + "category.description" + ], + "title": "Category.description" + }, + { + "id": "script-api:dw/catalog/Category#displayMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.displayMode", + "tags": [ + "displaymode", + "category.displaymode" + ], + "title": "Category.displayMode" + }, + { + "id": "script-api:dw/catalog/Category#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.displayName", + "tags": [ + "displayname", + "category.displayname" + ], + "title": "Category.displayName" + }, + { + "id": "script-api:dw/catalog/Category#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getAllRecommendations", + "tags": [ + "getallrecommendations", + "category.getallrecommendations" + ], + "title": "Category.getAllRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getAllRecommendations", + "tags": [ + "getallrecommendations", + "category.getallrecommendations" + ], + "title": "Category.getAllRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getCategoryAssignments", + "tags": [ + "getcategoryassignments", + "category.getcategoryassignments" + ], + "title": "Category.getCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Category#getDefaultSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDefaultSortingRule", + "tags": [ + "getdefaultsortingrule", + "category.getdefaultsortingrule" + ], + "title": "Category.getDefaultSortingRule" + }, + { + "id": "script-api:dw/catalog/Category#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDescription", + "tags": [ + "getdescription", + "category.getdescription" + ], + "title": "Category.getDescription" + }, + { + "id": "script-api:dw/catalog/Category#getDisplayMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDisplayMode", + "tags": [ + "getdisplaymode", + "category.getdisplaymode" + ], + "title": "Category.getDisplayMode" + }, + { + "id": "script-api:dw/catalog/Category#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDisplayName", + "tags": [ + "getdisplayname", + "category.getdisplayname" + ], + "title": "Category.getDisplayName" + }, + { + "id": "script-api:dw/catalog/Category#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getID", + "tags": [ + "getid", + "category.getid" + ], + "title": "Category.getID" + }, + { + "id": "script-api:dw/catalog/Category#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getImage", + "tags": [ + "getimage", + "category.getimage" + ], + "title": "Category.getImage" + }, + { + "id": "script-api:dw/catalog/Category#getIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getIncomingCategoryLinks", + "tags": [ + "getincomingcategorylinks", + "category.getincomingcategorylinks" + ], + "title": "Category.getIncomingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getIncomingCategoryLinks", + "tags": [ + "getincomingcategorylinks", + "category.getincomingcategorylinks" + ], + "title": "Category.getIncomingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineCategoryAssignments", + "tags": [ + "getonlinecategoryassignments", + "category.getonlinecategoryassignments" + ], + "title": "Category.getOnlineCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineFlag", + "tags": [ + "getonlineflag", + "category.getonlineflag" + ], + "title": "Category.getOnlineFlag" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineFrom", + "tags": [ + "getonlinefrom", + "category.getonlinefrom" + ], + "title": "Category.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineIncomingCategoryLinks", + "tags": [ + "getonlineincomingcategorylinks", + "category.getonlineincomingcategorylinks" + ], + "title": "Category.getOnlineIncomingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineOutgoingCategoryLinks", + "tags": [ + "getonlineoutgoingcategorylinks", + "category.getonlineoutgoingcategorylinks" + ], + "title": "Category.getOnlineOutgoingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineProducts", + "tags": [ + "getonlineproducts", + "category.getonlineproducts" + ], + "title": "Category.getOnlineProducts" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineSubCategories", + "tags": [ + "getonlinesubcategories", + "category.getonlinesubcategories" + ], + "title": "Category.getOnlineSubCategories" + }, + { + "id": "script-api:dw/catalog/Category#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineTo", + "tags": [ + "getonlineto", + "category.getonlineto" + ], + "title": "Category.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/Category#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOrderableRecommendations", + "tags": [ + "getorderablerecommendations", + "category.getorderablerecommendations" + ], + "title": "Category.getOrderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOrderableRecommendations", + "tags": [ + "getorderablerecommendations", + "category.getorderablerecommendations" + ], + "title": "Category.getOrderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOutgoingCategoryLinks", + "tags": [ + "getoutgoingcategorylinks", + "category.getoutgoingcategorylinks" + ], + "title": "Category.getOutgoingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOutgoingCategoryLinks", + "tags": [ + "getoutgoingcategorylinks", + "category.getoutgoingcategorylinks" + ], + "title": "Category.getOutgoingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageDescription", + "tags": [ + "getpagedescription", + "category.getpagedescription" + ], + "title": "Category.getPageDescription" + }, + { + "id": "script-api:dw/catalog/Category#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageKeywords", + "tags": [ + "getpagekeywords", + "category.getpagekeywords" + ], + "title": "Category.getPageKeywords" + }, + { + "id": "script-api:dw/catalog/Category#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageTitle", + "tags": [ + "getpagetitle", + "category.getpagetitle" + ], + "title": "Category.getPageTitle" + }, + { + "id": "script-api:dw/catalog/Category#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageURL", + "tags": [ + "getpageurl", + "category.getpageurl" + ], + "title": "Category.getPageURL" + }, + { + "id": "script-api:dw/catalog/Category#getParent", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getParent", + "tags": [ + "getparent", + "category.getparent" + ], + "title": "Category.getParent" + }, + { + "id": "script-api:dw/catalog/Category#getProductAttributeModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getProductAttributeModel", + "tags": [ + "getproductattributemodel", + "category.getproductattributemodel" + ], + "title": "Category.getProductAttributeModel" + }, + { + "id": "script-api:dw/catalog/Category#getProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getProducts", + "tags": [ + "getproducts", + "category.getproducts" + ], + "title": "Category.getProducts" + }, + { + "id": "script-api:dw/catalog/Category#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getRecommendations", + "tags": [ + "getrecommendations", + "category.getrecommendations" + ], + "title": "Category.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getRecommendations", + "tags": [ + "getrecommendations", + "category.getrecommendations" + ], + "title": "Category.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#getSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSearchPlacement", + "tags": [ + "getsearchplacement", + "category.getsearchplacement" + ], + "title": "Category.getSearchPlacement" + }, + { + "id": "script-api:dw/catalog/Category#getSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSearchRank", + "tags": [ + "getsearchrank", + "category.getsearchrank" + ], + "title": "Category.getSearchRank" + }, + { + "id": "script-api:dw/catalog/Category#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapChangeFrequency", + "tags": [ + "getsitemapchangefrequency", + "category.getsitemapchangefrequency" + ], + "title": "Category.getSiteMapChangeFrequency" + }, + { + "id": "script-api:dw/catalog/Category#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapIncluded", + "tags": [ + "getsitemapincluded", + "category.getsitemapincluded" + ], + "title": "Category.getSiteMapIncluded" + }, + { + "id": "script-api:dw/catalog/Category#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapPriority", + "tags": [ + "getsitemappriority", + "category.getsitemappriority" + ], + "title": "Category.getSiteMapPriority" + }, + { + "id": "script-api:dw/catalog/Category#getSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSubCategories", + "tags": [ + "getsubcategories", + "category.getsubcategories" + ], + "title": "Category.getSubCategories" + }, + { + "id": "script-api:dw/catalog/Category#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getTemplate", + "tags": [ + "gettemplate", + "category.gettemplate" + ], + "title": "Category.getTemplate" + }, + { + "id": "script-api:dw/catalog/Category#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getThumbnail", + "tags": [ + "getthumbnail", + "category.getthumbnail" + ], + "title": "Category.getThumbnail" + }, + { + "id": "script-api:dw/catalog/Category#hasOnlineProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.hasOnlineProducts", + "tags": [ + "hasonlineproducts", + "category.hasonlineproducts" + ], + "title": "Category.hasOnlineProducts" + }, + { + "id": "script-api:dw/catalog/Category#hasOnlineSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.hasOnlineSubCategories", + "tags": [ + "hasonlinesubcategories", + "category.hasonlinesubcategories" + ], + "title": "Category.hasOnlineSubCategories" + }, + { + "id": "script-api:dw/catalog/Category#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.image", + "tags": [ + "image", + "category.image" + ], + "title": "Category.image" + }, + { + "id": "script-api:dw/catalog/Category#incomingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.incomingCategoryLinks", + "tags": [ + "incomingcategorylinks", + "category.incomingcategorylinks" + ], + "title": "Category.incomingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#isDirectSubCategoryOf", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isDirectSubCategoryOf", + "tags": [ + "isdirectsubcategoryof", + "category.isdirectsubcategoryof" + ], + "title": "Category.isDirectSubCategoryOf" + }, + { + "id": "script-api:dw/catalog/Category#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isOnline", + "tags": [ + "isonline", + "category.isonline" + ], + "title": "Category.isOnline" + }, + { + "id": "script-api:dw/catalog/Category#isRoot", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isRoot", + "tags": [ + "isroot", + "category.isroot" + ], + "title": "Category.isRoot" + }, + { + "id": "script-api:dw/catalog/Category#isSubCategoryOf", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isSubCategoryOf", + "tags": [ + "issubcategoryof", + "category.issubcategoryof" + ], + "title": "Category.isSubCategoryOf" + }, + { + "id": "script-api:dw/catalog/Category#isTopLevel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isTopLevel", + "tags": [ + "istoplevel", + "category.istoplevel" + ], + "title": "Category.isTopLevel" + }, + { + "id": "script-api:dw/catalog/Category#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.online", + "tags": [ + "online", + "category.online" + ], + "title": "Category.online" + }, + { + "id": "script-api:dw/catalog/Category#onlineCategoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineCategoryAssignments", + "tags": [ + "onlinecategoryassignments", + "category.onlinecategoryassignments" + ], + "title": "Category.onlineCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Category#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineFlag", + "tags": [ + "onlineflag", + "category.onlineflag" + ], + "title": "Category.onlineFlag" + }, + { + "id": "script-api:dw/catalog/Category#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineFrom", + "tags": [ + "onlinefrom", + "category.onlinefrom" + ], + "title": "Category.onlineFrom" + }, + { + "id": "script-api:dw/catalog/Category#onlineIncomingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineIncomingCategoryLinks", + "tags": [ + "onlineincomingcategorylinks", + "category.onlineincomingcategorylinks" + ], + "title": "Category.onlineIncomingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#onlineOutgoingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineOutgoingCategoryLinks", + "tags": [ + "onlineoutgoingcategorylinks", + "category.onlineoutgoingcategorylinks" + ], + "title": "Category.onlineOutgoingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#onlineProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineProducts", + "tags": [ + "onlineproducts", + "category.onlineproducts" + ], + "title": "Category.onlineProducts" + }, + { + "id": "script-api:dw/catalog/Category#onlineSubCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineSubCategories", + "tags": [ + "onlinesubcategories", + "category.onlinesubcategories" + ], + "title": "Category.onlineSubCategories" + }, + { + "id": "script-api:dw/catalog/Category#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineTo", + "tags": [ + "onlineto", + "category.onlineto" + ], + "title": "Category.onlineTo" + }, + { + "id": "script-api:dw/catalog/Category#orderableRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.orderableRecommendations", + "tags": [ + "orderablerecommendations", + "category.orderablerecommendations" + ], + "title": "Category.orderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Category#outgoingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.outgoingCategoryLinks", + "tags": [ + "outgoingcategorylinks", + "category.outgoingcategorylinks" + ], + "title": "Category.outgoingCategoryLinks" + }, + { + "id": "script-api:dw/catalog/Category#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageDescription", + "tags": [ + "pagedescription", + "category.pagedescription" + ], + "title": "Category.pageDescription" + }, + { + "id": "script-api:dw/catalog/Category#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageKeywords", + "tags": [ + "pagekeywords", + "category.pagekeywords" + ], + "title": "Category.pageKeywords" + }, + { + "id": "script-api:dw/catalog/Category#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageTitle", + "tags": [ + "pagetitle", + "category.pagetitle" + ], + "title": "Category.pageTitle" + }, + { + "id": "script-api:dw/catalog/Category#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageURL", + "tags": [ + "pageurl", + "category.pageurl" + ], + "title": "Category.pageURL" + }, + { + "id": "script-api:dw/catalog/Category#parent", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.parent", + "tags": [ + "parent", + "category.parent" + ], + "title": "Category.parent" + }, + { + "id": "script-api:dw/catalog/Category#productAttributeModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.productAttributeModel", + "tags": [ + "productattributemodel", + "category.productattributemodel" + ], + "title": "Category.productAttributeModel" + }, + { + "id": "script-api:dw/catalog/Category#products", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.products", + "tags": [ + "products", + "category.products" + ], + "title": "Category.products" + }, + { + "id": "script-api:dw/catalog/Category#recommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.recommendations", + "tags": [ + "recommendations", + "category.recommendations" + ], + "title": "Category.recommendations" + }, + { + "id": "script-api:dw/catalog/Category#root", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.root", + "tags": [ + "root", + "category.root" + ], + "title": "Category.root" + }, + { + "id": "script-api:dw/catalog/Category#searchPlacement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.searchPlacement", + "tags": [ + "searchplacement", + "category.searchplacement" + ], + "title": "Category.searchPlacement" + }, + { + "id": "script-api:dw/catalog/Category#searchRank", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.searchRank", + "tags": [ + "searchrank", + "category.searchrank" + ], + "title": "Category.searchRank" + }, + { + "id": "script-api:dw/catalog/Category#setDisplayMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setDisplayMode", + "tags": [ + "setdisplaymode", + "category.setdisplaymode" + ], + "title": "Category.setDisplayMode" + }, + { + "id": "script-api:dw/catalog/Category#setSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setSearchPlacement", + "tags": [ + "setsearchplacement", + "category.setsearchplacement" + ], + "title": "Category.setSearchPlacement" + }, + { + "id": "script-api:dw/catalog/Category#setSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setSearchRank", + "tags": [ + "setsearchrank", + "category.setsearchrank" + ], + "title": "Category.setSearchRank" + }, + { + "id": "script-api:dw/catalog/Category#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapChangeFrequency", + "tags": [ + "sitemapchangefrequency", + "category.sitemapchangefrequency" + ], + "title": "Category.siteMapChangeFrequency" + }, + { + "id": "script-api:dw/catalog/Category#siteMapIncluded", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapIncluded", + "tags": [ + "sitemapincluded", + "category.sitemapincluded" + ], + "title": "Category.siteMapIncluded" + }, + { + "id": "script-api:dw/catalog/Category#siteMapPriority", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapPriority", + "tags": [ + "sitemappriority", + "category.sitemappriority" + ], + "title": "Category.siteMapPriority" + }, + { + "id": "script-api:dw/catalog/Category#subCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.subCategories", + "tags": [ + "subcategories", + "category.subcategories" + ], + "title": "Category.subCategories" + }, + { + "id": "script-api:dw/catalog/Category#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.template", + "tags": [ + "template", + "category.template" + ], + "title": "Category.template" + }, + { + "id": "script-api:dw/catalog/Category#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.thumbnail", + "tags": [ + "thumbnail", + "category.thumbnail" + ], + "title": "Category.thumbnail" + }, + { + "id": "script-api:dw/catalog/Category#topLevel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.topLevel", + "tags": [ + "toplevel", + "category.toplevel" + ], + "title": "Category.topLevel" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CategoryAssignment", + "tags": [ + "categoryassignment", + "dw.catalog.categoryassignment", + "dw/catalog" + ], + "title": "CategoryAssignment" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#calloutMsg", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.calloutMsg", + "tags": [ + "calloutmsg", + "categoryassignment.calloutmsg" + ], + "title": "CategoryAssignment.calloutMsg" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#category", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.category", + "tags": [ + "category", + "categoryassignment.category" + ], + "title": "CategoryAssignment.category" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getCalloutMsg", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getCalloutMsg", + "tags": [ + "getcalloutmsg", + "categoryassignment.getcalloutmsg" + ], + "title": "CategoryAssignment.getCalloutMsg" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getCategory", + "tags": [ + "getcategory", + "categoryassignment.getcategory" + ], + "title": "CategoryAssignment.getCategory" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getImage", + "tags": [ + "getimage", + "categoryassignment.getimage" + ], + "title": "CategoryAssignment.getImage" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getLongDescription", + "tags": [ + "getlongdescription", + "categoryassignment.getlongdescription" + ], + "title": "CategoryAssignment.getLongDescription" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getName", + "tags": [ + "getname", + "categoryassignment.getname" + ], + "title": "CategoryAssignment.getName" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getProduct", + "tags": [ + "getproduct", + "categoryassignment.getproduct" + ], + "title": "CategoryAssignment.getProduct" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getShortDescription", + "tags": [ + "getshortdescription", + "categoryassignment.getshortdescription" + ], + "title": "CategoryAssignment.getShortDescription" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.image", + "tags": [ + "image", + "categoryassignment.image" + ], + "title": "CategoryAssignment.image" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.longDescription", + "tags": [ + "longdescription", + "categoryassignment.longdescription" + ], + "title": "CategoryAssignment.longDescription" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.name", + "tags": [ + "name", + "categoryassignment.name" + ], + "title": "CategoryAssignment.name" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.product", + "tags": [ + "product", + "categoryassignment.product" + ], + "title": "CategoryAssignment.product" + }, + { + "id": "script-api:dw/catalog/CategoryAssignment#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.shortDescription", + "tags": [ + "shortdescription", + "categoryassignment.shortdescription" + ], + "title": "CategoryAssignment.shortDescription" + }, + { + "id": "script-api:dw/catalog/CategoryLink", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CategoryLink", + "tags": [ + "categorylink", + "dw.catalog.categorylink", + "dw/catalog" + ], + "title": "CategoryLink" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_ACCESSORY", + "tags": [ + "linktype_accessory", + "categorylink.linktype_accessory" + ], + "title": "CategoryLink.LINKTYPE_ACCESSORY" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_ACCESSORY", + "tags": [ + "linktype_accessory", + "categorylink.linktype_accessory" + ], + "title": "CategoryLink.LINKTYPE_ACCESSORY" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_CROSS_SELL", + "tags": [ + "linktype_cross_sell", + "categorylink.linktype_cross_sell" + ], + "title": "CategoryLink.LINKTYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_CROSS_SELL", + "tags": [ + "linktype_cross_sell", + "categorylink.linktype_cross_sell" + ], + "title": "CategoryLink.LINKTYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_OTHER", + "tags": [ + "linktype_other", + "categorylink.linktype_other" + ], + "title": "CategoryLink.LINKTYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_OTHER", + "tags": [ + "linktype_other", + "categorylink.linktype_other" + ], + "title": "CategoryLink.LINKTYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_SPARE_PART", + "tags": [ + "linktype_spare_part", + "categorylink.linktype_spare_part" + ], + "title": "CategoryLink.LINKTYPE_SPARE_PART" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_SPARE_PART", + "tags": [ + "linktype_spare_part", + "categorylink.linktype_spare_part" + ], + "title": "CategoryLink.LINKTYPE_SPARE_PART" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_UP_SELL", + "tags": [ + "linktype_up_sell", + "categorylink.linktype_up_sell" + ], + "title": "CategoryLink.LINKTYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_UP_SELL", + "tags": [ + "linktype_up_sell", + "categorylink.linktype_up_sell" + ], + "title": "CategoryLink.LINKTYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/CategoryLink#getSourceCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getSourceCategory", + "tags": [ + "getsourcecategory", + "categorylink.getsourcecategory" + ], + "title": "CategoryLink.getSourceCategory" + }, + { + "id": "script-api:dw/catalog/CategoryLink#getTargetCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getTargetCategory", + "tags": [ + "gettargetcategory", + "categorylink.gettargetcategory" + ], + "title": "CategoryLink.getTargetCategory" + }, + { + "id": "script-api:dw/catalog/CategoryLink#getTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getTypeCode", + "tags": [ + "gettypecode", + "categorylink.gettypecode" + ], + "title": "CategoryLink.getTypeCode" + }, + { + "id": "script-api:dw/catalog/CategoryLink#sourceCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.sourceCategory", + "tags": [ + "sourcecategory", + "categorylink.sourcecategory" + ], + "title": "CategoryLink.sourceCategory" + }, + { + "id": "script-api:dw/catalog/CategoryLink#targetCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.targetCategory", + "tags": [ + "targetcategory", + "categorylink.targetcategory" + ], + "title": "CategoryLink.targetCategory" + }, + { + "id": "script-api:dw/catalog/CategoryLink#typeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.typeCode", + "tags": [ + "typecode", + "categorylink.typecode" + ], + "title": "CategoryLink.typeCode" + }, + { + "id": "script-api:dw/catalog/PriceBook", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.PriceBook", + "tags": [ + "pricebook", + "dw.catalog.pricebook", + "dw/catalog" + ], + "title": "PriceBook" + }, + { + "id": "script-api:dw/catalog/PriceBook#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.ID", + "tags": [ + "id", + "pricebook.id" + ], + "title": "PriceBook.ID" + }, + { + "id": "script-api:dw/catalog/PriceBook#currencyCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.currencyCode", + "tags": [ + "currencycode", + "pricebook.currencycode" + ], + "title": "PriceBook.currencyCode" + }, + { + "id": "script-api:dw/catalog/PriceBook#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.description", + "tags": [ + "description", + "pricebook.description" + ], + "title": "PriceBook.description" + }, + { + "id": "script-api:dw/catalog/PriceBook#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.displayName", + "tags": [ + "displayname", + "pricebook.displayname" + ], + "title": "PriceBook.displayName" + }, + { + "id": "script-api:dw/catalog/PriceBook#getCurrencyCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getCurrencyCode", + "tags": [ + "getcurrencycode", + "pricebook.getcurrencycode" + ], + "title": "PriceBook.getCurrencyCode" + }, + { + "id": "script-api:dw/catalog/PriceBook#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getDescription", + "tags": [ + "getdescription", + "pricebook.getdescription" + ], + "title": "PriceBook.getDescription" + }, + { + "id": "script-api:dw/catalog/PriceBook#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getDisplayName", + "tags": [ + "getdisplayname", + "pricebook.getdisplayname" + ], + "title": "PriceBook.getDisplayName" + }, + { + "id": "script-api:dw/catalog/PriceBook#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getID", + "tags": [ + "getid", + "pricebook.getid" + ], + "title": "PriceBook.getID" + }, + { + "id": "script-api:dw/catalog/PriceBook#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineFlag", + "tags": [ + "getonlineflag", + "pricebook.getonlineflag" + ], + "title": "PriceBook.getOnlineFlag" + }, + { + "id": "script-api:dw/catalog/PriceBook#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineFrom", + "tags": [ + "getonlinefrom", + "pricebook.getonlinefrom" + ], + "title": "PriceBook.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/PriceBook#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineTo", + "tags": [ + "getonlineto", + "pricebook.getonlineto" + ], + "title": "PriceBook.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/PriceBook#getParentPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getParentPriceBook", + "tags": [ + "getparentpricebook", + "pricebook.getparentpricebook" + ], + "title": "PriceBook.getParentPriceBook" + }, + { + "id": "script-api:dw/catalog/PriceBook#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.isOnline", + "tags": [ + "isonline", + "pricebook.isonline" + ], + "title": "PriceBook.isOnline" + }, + { + "id": "script-api:dw/catalog/PriceBook#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.online", + "tags": [ + "online", + "pricebook.online" + ], + "title": "PriceBook.online" + }, + { + "id": "script-api:dw/catalog/PriceBook#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineFlag", + "tags": [ + "onlineflag", + "pricebook.onlineflag" + ], + "title": "PriceBook.onlineFlag" + }, + { + "id": "script-api:dw/catalog/PriceBook#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineFrom", + "tags": [ + "onlinefrom", + "pricebook.onlinefrom" + ], + "title": "PriceBook.onlineFrom" + }, + { + "id": "script-api:dw/catalog/PriceBook#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineTo", + "tags": [ + "onlineto", + "pricebook.onlineto" + ], + "title": "PriceBook.onlineTo" + }, + { + "id": "script-api:dw/catalog/PriceBook#parentPriceBook", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.parentPriceBook", + "tags": [ + "parentpricebook", + "pricebook.parentpricebook" + ], + "title": "PriceBook.parentPriceBook" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.PriceBookMgr", + "tags": [ + "pricebookmgr", + "dw.catalog.pricebookmgr", + "dw/catalog" + ], + "title": "PriceBookMgr" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#allPriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.allPriceBooks", + "tags": [ + "allpricebooks", + "pricebookmgr.allpricebooks" + ], + "title": "PriceBookMgr.allPriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#allPriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.allPriceBooks", + "tags": [ + "allpricebooks", + "pricebookmgr.allpricebooks" + ], + "title": "PriceBookMgr.allPriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#applicablePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.applicablePriceBooks", + "tags": [ + "applicablepricebooks", + "pricebookmgr.applicablepricebooks" + ], + "title": "PriceBookMgr.applicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#applicablePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.applicablePriceBooks", + "tags": [ + "applicablepricebooks", + "pricebookmgr.applicablepricebooks" + ], + "title": "PriceBookMgr.applicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#assignPriceBookToSite", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.assignPriceBookToSite", + "tags": [ + "assignpricebooktosite", + "pricebookmgr.assignpricebooktosite" + ], + "title": "PriceBookMgr.assignPriceBookToSite" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#assignPriceBookToSite", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.assignPriceBookToSite", + "tags": [ + "assignpricebooktosite", + "pricebookmgr.assignpricebooktosite" + ], + "title": "PriceBookMgr.assignPriceBookToSite" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getAllPriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getAllPriceBooks", + "tags": [ + "getallpricebooks", + "pricebookmgr.getallpricebooks" + ], + "title": "PriceBookMgr.getAllPriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getAllPriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getAllPriceBooks", + "tags": [ + "getallpricebooks", + "pricebookmgr.getallpricebooks" + ], + "title": "PriceBookMgr.getAllPriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getApplicablePriceBooks", + "tags": [ + "getapplicablepricebooks", + "pricebookmgr.getapplicablepricebooks" + ], + "title": "PriceBookMgr.getApplicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getApplicablePriceBooks", + "tags": [ + "getapplicablepricebooks", + "pricebookmgr.getapplicablepricebooks" + ], + "title": "PriceBookMgr.getApplicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getPriceBook", + "tags": [ + "getpricebook", + "pricebookmgr.getpricebook" + ], + "title": "PriceBookMgr.getPriceBook" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getPriceBook", + "tags": [ + "getpricebook", + "pricebookmgr.getpricebook" + ], + "title": "PriceBookMgr.getPriceBook" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getSitePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getSitePriceBooks", + "tags": [ + "getsitepricebooks", + "pricebookmgr.getsitepricebooks" + ], + "title": "PriceBookMgr.getSitePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#getSitePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getSitePriceBooks", + "tags": [ + "getsitepricebooks", + "pricebookmgr.getsitepricebooks" + ], + "title": "PriceBookMgr.getSitePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#setApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.setApplicablePriceBooks", + "tags": [ + "setapplicablepricebooks", + "pricebookmgr.setapplicablepricebooks" + ], + "title": "PriceBookMgr.setApplicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#setApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.setApplicablePriceBooks", + "tags": [ + "setapplicablepricebooks", + "pricebookmgr.setapplicablepricebooks" + ], + "title": "PriceBookMgr.setApplicablePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#sitePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.sitePriceBooks", + "tags": [ + "sitepricebooks", + "pricebookmgr.sitepricebooks" + ], + "title": "PriceBookMgr.sitePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#sitePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.sitePriceBooks", + "tags": [ + "sitepricebooks", + "pricebookmgr.sitepricebooks" + ], + "title": "PriceBookMgr.sitePriceBooks" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromAllSites", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromAllSites", + "tags": [ + "unassignpricebookfromallsites", + "pricebookmgr.unassignpricebookfromallsites" + ], + "title": "PriceBookMgr.unassignPriceBookFromAllSites" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromAllSites", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromAllSites", + "tags": [ + "unassignpricebookfromallsites", + "pricebookmgr.unassignpricebookfromallsites" + ], + "title": "PriceBookMgr.unassignPriceBookFromAllSites" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromSite", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromSite", + "tags": [ + "unassignpricebookfromsite", + "pricebookmgr.unassignpricebookfromsite" + ], + "title": "PriceBookMgr.unassignPriceBookFromSite" + }, + { + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromSite", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromSite", + "tags": [ + "unassignpricebookfromsite", + "pricebookmgr.unassignpricebookfromsite" + ], + "title": "PriceBookMgr.unassignPriceBookFromSite" + }, + { + "id": "script-api:dw/catalog/Product", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Product", + "tags": [ + "product", + "dw.catalog.product", + "dw/catalog" + ], + "title": "Product" + }, + { + "id": "script-api:dw/catalog/Product#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.EAN", + "tags": [ + "ean", + "product.ean" + ], + "title": "Product.EAN" + }, + { + "id": "script-api:dw/catalog/Product#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.ID", + "tags": [ + "id", + "product.id" + ], + "title": "Product.ID" + }, + { + "id": "script-api:dw/catalog/Product#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.UPC", + "tags": [ + "upc", + "product.upc" + ], + "title": "Product.UPC" + }, + { + "id": "script-api:dw/catalog/Product#activeData", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.activeData", + "tags": [ + "activedata", + "product.activedata" + ], + "title": "Product.activeData" + }, + { + "id": "script-api:dw/catalog/Product#allCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allCategories", + "tags": [ + "allcategories", + "product.allcategories" + ], + "title": "Product.allCategories" + }, + { + "id": "script-api:dw/catalog/Product#allCategoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allCategoryAssignments", + "tags": [ + "allcategoryassignments", + "product.allcategoryassignments" + ], + "title": "Product.allCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Product#allIncomingProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allIncomingProductLinks", + "tags": [ + "allincomingproductlinks", + "product.allincomingproductlinks" + ], + "title": "Product.allIncomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allProductLinks", + "tags": [ + "allproductlinks", + "product.allproductlinks" + ], + "title": "Product.allProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#assignedToCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.assignedToCategory", + "tags": [ + "assignedtocategory", + "product.assignedtocategory" + ], + "title": "Product.assignedToCategory" + }, + { + "id": "script-api:dw/catalog/Product#assignedToSiteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.assignedToSiteCatalog", + "tags": [ + "assignedtositecatalog", + "product.assignedtositecatalog" + ], + "title": "Product.assignedToSiteCatalog" + }, + { + "id": "script-api:dw/catalog/Product#attributeModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.attributeModel", + "tags": [ + "attributemodel", + "product.attributemodel" + ], + "title": "Product.attributeModel" + }, + { + "id": "script-api:dw/catalog/Product#availabilityModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.availabilityModel", + "tags": [ + "availabilitymodel", + "product.availabilitymodel" + ], + "title": "Product.availabilityModel" + }, + { + "id": "script-api:dw/catalog/Product#available", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.available", + "tags": [ + "available", + "product.available" + ], + "title": "Product.available" + }, + { + "id": "script-api:dw/catalog/Product#availableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.availableFlag", + "tags": [ + "availableflag", + "product.availableflag" + ], + "title": "Product.availableFlag" + }, + { + "id": "script-api:dw/catalog/Product#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.brand", + "tags": [ + "brand", + "product.brand" + ], + "title": "Product.brand" + }, + { + "id": "script-api:dw/catalog/Product#bundle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundle", + "tags": [ + "bundle", + "product.bundle" + ], + "title": "Product.bundle" + }, + { + "id": "script-api:dw/catalog/Product#bundled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundled", + "tags": [ + "bundled", + "product.bundled" + ], + "title": "Product.bundled" + }, + { + "id": "script-api:dw/catalog/Product#bundledProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundledProducts", + "tags": [ + "bundledproducts", + "product.bundledproducts" + ], + "title": "Product.bundledProducts" + }, + { + "id": "script-api:dw/catalog/Product#bundles", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundles", + "tags": [ + "bundles", + "product.bundles" + ], + "title": "Product.bundles" + }, + { + "id": "script-api:dw/catalog/Product#categories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categories", + "tags": [ + "categories", + "product.categories" + ], + "title": "Product.categories" + }, + { + "id": "script-api:dw/catalog/Product#categorized", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categorized", + "tags": [ + "categorized", + "product.categorized" + ], + "title": "Product.categorized" + }, + { + "id": "script-api:dw/catalog/Product#categoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categoryAssignments", + "tags": [ + "categoryassignments", + "product.categoryassignments" + ], + "title": "Product.categoryAssignments" + }, + { + "id": "script-api:dw/catalog/Product#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.classificationCategory", + "tags": [ + "classificationcategory", + "product.classificationcategory" + ], + "title": "Product.classificationCategory" + }, + { + "id": "script-api:dw/catalog/Product#facebookEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.facebookEnabled", + "tags": [ + "facebookenabled", + "product.facebookenabled" + ], + "title": "Product.facebookEnabled" + }, + { + "id": "script-api:dw/catalog/Product#getActiveData", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getActiveData", + "tags": [ + "getactivedata", + "product.getactivedata" + ], + "title": "Product.getActiveData" + }, + { + "id": "script-api:dw/catalog/Product#getAllCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllCategories", + "tags": [ + "getallcategories", + "product.getallcategories" + ], + "title": "Product.getAllCategories" + }, + { + "id": "script-api:dw/catalog/Product#getAllCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllCategoryAssignments", + "tags": [ + "getallcategoryassignments", + "product.getallcategoryassignments" + ], + "title": "Product.getAllCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Product#getAllIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllIncomingProductLinks", + "tags": [ + "getallincomingproductlinks", + "product.getallincomingproductlinks" + ], + "title": "Product.getAllIncomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getAllIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllIncomingProductLinks", + "tags": [ + "getallincomingproductlinks", + "product.getallincomingproductlinks" + ], + "title": "Product.getAllIncomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllProductLinks", + "tags": [ + "getallproductlinks", + "product.getallproductlinks" + ], + "title": "Product.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllProductLinks", + "tags": [ + "getallproductlinks", + "product.getallproductlinks" + ], + "title": "Product.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllRecommendations", + "tags": [ + "getallrecommendations", + "product.getallrecommendations" + ], + "title": "Product.getAllRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllRecommendations", + "tags": [ + "getallrecommendations", + "product.getallrecommendations" + ], + "title": "Product.getAllRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getAttributeModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAttributeModel", + "tags": [ + "getattributemodel", + "product.getattributemodel" + ], + "title": "Product.getAttributeModel" + }, + { + "id": "script-api:dw/catalog/Product#getAvailabilityModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailabilityModel", + "tags": [ + "getavailabilitymodel", + "product.getavailabilitymodel" + ], + "title": "Product.getAvailabilityModel" + }, + { + "id": "script-api:dw/catalog/Product#getAvailabilityModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailabilityModel", + "tags": [ + "getavailabilitymodel", + "product.getavailabilitymodel" + ], + "title": "Product.getAvailabilityModel" + }, + { + "id": "script-api:dw/catalog/Product#getAvailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailableFlag", + "tags": [ + "getavailableflag", + "product.getavailableflag" + ], + "title": "Product.getAvailableFlag" + }, + { + "id": "script-api:dw/catalog/Product#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBrand", + "tags": [ + "getbrand", + "product.getbrand" + ], + "title": "Product.getBrand" + }, + { + "id": "script-api:dw/catalog/Product#getBundledProductQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundledProductQuantity", + "tags": [ + "getbundledproductquantity", + "product.getbundledproductquantity" + ], + "title": "Product.getBundledProductQuantity" + }, + { + "id": "script-api:dw/catalog/Product#getBundledProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundledProducts", + "tags": [ + "getbundledproducts", + "product.getbundledproducts" + ], + "title": "Product.getBundledProducts" + }, + { + "id": "script-api:dw/catalog/Product#getBundles", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundles", + "tags": [ + "getbundles", + "product.getbundles" + ], + "title": "Product.getBundles" + }, + { + "id": "script-api:dw/catalog/Product#getCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategories", + "tags": [ + "getcategories", + "product.getcategories" + ], + "title": "Product.getCategories" + }, + { + "id": "script-api:dw/catalog/Product#getCategoryAssignment", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategoryAssignment", + "tags": [ + "getcategoryassignment", + "product.getcategoryassignment" + ], + "title": "Product.getCategoryAssignment" + }, + { + "id": "script-api:dw/catalog/Product#getCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategoryAssignments", + "tags": [ + "getcategoryassignments", + "product.getcategoryassignments" + ], + "title": "Product.getCategoryAssignments" + }, + { + "id": "script-api:dw/catalog/Product#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getClassificationCategory", + "tags": [ + "getclassificationcategory", + "product.getclassificationcategory" + ], + "title": "Product.getClassificationCategory" + }, + { + "id": "script-api:dw/catalog/Product#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getEAN", + "tags": [ + "getean", + "product.getean" + ], + "title": "Product.getEAN" + }, + { + "id": "script-api:dw/catalog/Product#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getID", + "tags": [ + "getid", + "product.getid" + ], + "title": "Product.getID" + }, + { + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "tags": [ + "getimage", + "product.getimage" + ], + "title": "Product.getImage" + }, + { + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "tags": [ + "getimage", + "product.getimage" + ], + "title": "Product.getImage" + }, + { + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "tags": [ + "getimage", + "product.getimage" + ], + "title": "Product.getImage" + }, + { + "id": "script-api:dw/catalog/Product#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImages", + "tags": [ + "getimages", + "product.getimages" + ], + "title": "Product.getImages" + }, + { + "id": "script-api:dw/catalog/Product#getIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getIncomingProductLinks", + "tags": [ + "getincomingproductlinks", + "product.getincomingproductlinks" + ], + "title": "Product.getIncomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getIncomingProductLinks", + "tags": [ + "getincomingproductlinks", + "product.getincomingproductlinks" + ], + "title": "Product.getIncomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getLongDescription", + "tags": [ + "getlongdescription", + "product.getlongdescription" + ], + "title": "Product.getLongDescription" + }, + { + "id": "script-api:dw/catalog/Product#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getManufacturerName", + "tags": [ + "getmanufacturername", + "product.getmanufacturername" + ], + "title": "Product.getManufacturerName" + }, + { + "id": "script-api:dw/catalog/Product#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getManufacturerSKU", + "tags": [ + "getmanufacturersku", + "product.getmanufacturersku" + ], + "title": "Product.getManufacturerSKU" + }, + { + "id": "script-api:dw/catalog/Product#getMinOrderQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getMinOrderQuantity", + "tags": [ + "getminorderquantity", + "product.getminorderquantity" + ], + "title": "Product.getMinOrderQuantity" + }, + { + "id": "script-api:dw/catalog/Product#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getName", + "tags": [ + "getname", + "product.getname" + ], + "title": "Product.getName" + }, + { + "id": "script-api:dw/catalog/Product#getOnlineCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineCategories", + "tags": [ + "getonlinecategories", + "product.getonlinecategories" + ], + "title": "Product.getOnlineCategories" + }, + { + "id": "script-api:dw/catalog/Product#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineFlag", + "tags": [ + "getonlineflag", + "product.getonlineflag" + ], + "title": "Product.getOnlineFlag" + }, + { + "id": "script-api:dw/catalog/Product#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineFrom", + "tags": [ + "getonlinefrom", + "product.getonlinefrom" + ], + "title": "Product.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/Product#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineTo", + "tags": [ + "getonlineto", + "product.getonlineto" + ], + "title": "Product.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/Product#getOptionModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOptionModel", + "tags": [ + "getoptionmodel", + "product.getoptionmodel" + ], + "title": "Product.getOptionModel" + }, + { + "id": "script-api:dw/catalog/Product#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOrderableRecommendations", + "tags": [ + "getorderablerecommendations", + "product.getorderablerecommendations" + ], + "title": "Product.getOrderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOrderableRecommendations", + "tags": [ + "getorderablerecommendations", + "product.getorderablerecommendations" + ], + "title": "Product.getOrderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageDescription", + "tags": [ + "getpagedescription", + "product.getpagedescription" + ], + "title": "Product.getPageDescription" + }, + { + "id": "script-api:dw/catalog/Product#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageKeywords", + "tags": [ + "getpagekeywords", + "product.getpagekeywords" + ], + "title": "Product.getPageKeywords" + }, + { + "id": "script-api:dw/catalog/Product#getPageMetaTag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageMetaTag", + "tags": [ + "getpagemetatag", + "product.getpagemetatag" + ], + "title": "Product.getPageMetaTag" + }, + { + "id": "script-api:dw/catalog/Product#getPageMetaTags", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageMetaTags", + "tags": [ + "getpagemetatags", + "product.getpagemetatags" + ], + "title": "Product.getPageMetaTags" + }, + { + "id": "script-api:dw/catalog/Product#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageTitle", + "tags": [ + "getpagetitle", + "product.getpagetitle" + ], + "title": "Product.getPageTitle" + }, + { + "id": "script-api:dw/catalog/Product#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageURL", + "tags": [ + "getpageurl", + "product.getpageurl" + ], + "title": "Product.getPageURL" + }, + { + "id": "script-api:dw/catalog/Product#getPriceModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPriceModel", + "tags": [ + "getpricemodel", + "product.getpricemodel" + ], + "title": "Product.getPriceModel" + }, + { + "id": "script-api:dw/catalog/Product#getPriceModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPriceModel", + "tags": [ + "getpricemodel", + "product.getpricemodel" + ], + "title": "Product.getPriceModel" + }, + { + "id": "script-api:dw/catalog/Product#getPrimaryCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPrimaryCategory", + "tags": [ + "getprimarycategory", + "product.getprimarycategory" + ], + "title": "Product.getPrimaryCategory" + }, + { + "id": "script-api:dw/catalog/Product#getPrimaryCategoryAssignment", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPrimaryCategoryAssignment", + "tags": [ + "getprimarycategoryassignment", + "product.getprimarycategoryassignment" + ], + "title": "Product.getPrimaryCategoryAssignment" + }, + { + "id": "script-api:dw/catalog/Product#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductLinks", + "tags": [ + "getproductlinks", + "product.getproductlinks" + ], + "title": "Product.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductLinks", + "tags": [ + "getproductlinks", + "product.getproductlinks" + ], + "title": "Product.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#getProductSetProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductSetProducts", + "tags": [ + "getproductsetproducts", + "product.getproductsetproducts" + ], + "title": "Product.getProductSetProducts" + }, + { + "id": "script-api:dw/catalog/Product#getProductSets", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductSets", + "tags": [ + "getproductsets", + "product.getproductsets" + ], + "title": "Product.getProductSets" + }, + { + "id": "script-api:dw/catalog/Product#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getRecommendations", + "tags": [ + "getrecommendations", + "product.getrecommendations" + ], + "title": "Product.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getRecommendations", + "tags": [ + "getrecommendations", + "product.getrecommendations" + ], + "title": "Product.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#getSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchPlacement", + "tags": [ + "getsearchplacement", + "product.getsearchplacement" + ], + "title": "Product.getSearchPlacement" + }, + { + "id": "script-api:dw/catalog/Product#getSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchRank", + "tags": [ + "getsearchrank", + "product.getsearchrank" + ], + "title": "Product.getSearchRank" + }, + { + "id": "script-api:dw/catalog/Product#getSearchableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchableFlag", + "tags": [ + "getsearchableflag", + "product.getsearchableflag" + ], + "title": "Product.getSearchableFlag" + }, + { + "id": "script-api:dw/catalog/Product#getSearchableIfUnavailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchableIfUnavailableFlag", + "tags": [ + "getsearchableifunavailableflag", + "product.getsearchableifunavailableflag" + ], + "title": "Product.getSearchableIfUnavailableFlag" + }, + { + "id": "script-api:dw/catalog/Product#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getShortDescription", + "tags": [ + "getshortdescription", + "product.getshortdescription" + ], + "title": "Product.getShortDescription" + }, + { + "id": "script-api:dw/catalog/Product#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapChangeFrequency", + "tags": [ + "getsitemapchangefrequency", + "product.getsitemapchangefrequency" + ], + "title": "Product.getSiteMapChangeFrequency" + }, + { + "id": "script-api:dw/catalog/Product#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapIncluded", + "tags": [ + "getsitemapincluded", + "product.getsitemapincluded" + ], + "title": "Product.getSiteMapIncluded" + }, + { + "id": "script-api:dw/catalog/Product#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapPriority", + "tags": [ + "getsitemappriority", + "product.getsitemappriority" + ], + "title": "Product.getSiteMapPriority" + }, + { + "id": "script-api:dw/catalog/Product#getStepQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStepQuantity", + "tags": [ + "getstepquantity", + "product.getstepquantity" + ], + "title": "Product.getStepQuantity" + }, + { + "id": "script-api:dw/catalog/Product#getStoreReceiptName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStoreReceiptName", + "tags": [ + "getstorereceiptname", + "product.getstorereceiptname" + ], + "title": "Product.getStoreReceiptName" + }, + { + "id": "script-api:dw/catalog/Product#getStoreTaxClass", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStoreTaxClass", + "tags": [ + "getstoretaxclass", + "product.getstoretaxclass" + ], + "title": "Product.getStoreTaxClass" + }, + { + "id": "script-api:dw/catalog/Product#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getTaxClassID", + "tags": [ + "gettaxclassid", + "product.gettaxclassid" + ], + "title": "Product.getTaxClassID" + }, + { + "id": "script-api:dw/catalog/Product#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getTemplate", + "tags": [ + "gettemplate", + "product.gettemplate" + ], + "title": "Product.getTemplate" + }, + { + "id": "script-api:dw/catalog/Product#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getThumbnail", + "tags": [ + "getthumbnail", + "product.getthumbnail" + ], + "title": "Product.getThumbnail" + }, + { + "id": "script-api:dw/catalog/Product#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUPC", + "tags": [ + "getupc", + "product.getupc" + ], + "title": "Product.getUPC" + }, + { + "id": "script-api:dw/catalog/Product#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUnit", + "tags": [ + "getunit", + "product.getunit" + ], + "title": "Product.getUnit" + }, + { + "id": "script-api:dw/catalog/Product#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUnitQuantity", + "tags": [ + "getunitquantity", + "product.getunitquantity" + ], + "title": "Product.getUnitQuantity" + }, + { + "id": "script-api:dw/catalog/Product#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariants", + "tags": [ + "getvariants", + "product.getvariants" + ], + "title": "Product.getVariants" + }, + { + "id": "script-api:dw/catalog/Product#getVariationGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariationGroups", + "tags": [ + "getvariationgroups", + "product.getvariationgroups" + ], + "title": "Product.getVariationGroups" + }, + { + "id": "script-api:dw/catalog/Product#getVariationModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariationModel", + "tags": [ + "getvariationmodel", + "product.getvariationmodel" + ], + "title": "Product.getVariationModel" + }, + { + "id": "script-api:dw/catalog/Product#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.image", + "tags": [ + "image", + "product.image" + ], + "title": "Product.image" + }, + { + "id": "script-api:dw/catalog/Product#includedInBundle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.includedInBundle", + "tags": [ + "includedinbundle", + "product.includedinbundle" + ], + "title": "Product.includedInBundle" + }, + { + "id": "script-api:dw/catalog/Product#incomingProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.incomingProductLinks", + "tags": [ + "incomingproductlinks", + "product.incomingproductlinks" + ], + "title": "Product.incomingProductLinks" + }, + { + "id": "script-api:dw/catalog/Product#isAssignedToCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAssignedToCategory", + "tags": [ + "isassignedtocategory", + "product.isassignedtocategory" + ], + "title": "Product.isAssignedToCategory" + }, + { + "id": "script-api:dw/catalog/Product#isAssignedToSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAssignedToSiteCatalog", + "tags": [ + "isassignedtositecatalog", + "product.isassignedtositecatalog" + ], + "title": "Product.isAssignedToSiteCatalog" + }, + { + "id": "script-api:dw/catalog/Product#isAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAvailable", + "tags": [ + "isavailable", + "product.isavailable" + ], + "title": "Product.isAvailable" + }, + { + "id": "script-api:dw/catalog/Product#isBundle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isBundle", + "tags": [ + "isbundle", + "product.isbundle" + ], + "title": "Product.isBundle" + }, + { + "id": "script-api:dw/catalog/Product#isBundled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isBundled", + "tags": [ + "isbundled", + "product.isbundled" + ], + "title": "Product.isBundled" + }, + { + "id": "script-api:dw/catalog/Product#isCategorized", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isCategorized", + "tags": [ + "iscategorized", + "product.iscategorized" + ], + "title": "Product.isCategorized" + }, + { + "id": "script-api:dw/catalog/Product#isFacebookEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isFacebookEnabled", + "tags": [ + "isfacebookenabled", + "product.isfacebookenabled" + ], + "title": "Product.isFacebookEnabled" + }, + { + "id": "script-api:dw/catalog/Product#isMaster", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isMaster", + "tags": [ + "ismaster", + "product.ismaster" + ], + "title": "Product.isMaster" + }, + { + "id": "script-api:dw/catalog/Product#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isOnline", + "tags": [ + "isonline", + "product.isonline" + ], + "title": "Product.isOnline" + }, + { + "id": "script-api:dw/catalog/Product#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isOptionProduct", + "tags": [ + "isoptionproduct", + "product.isoptionproduct" + ], + "title": "Product.isOptionProduct" + }, + { + "id": "script-api:dw/catalog/Product#isPinterestEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isPinterestEnabled", + "tags": [ + "ispinterestenabled", + "product.ispinterestenabled" + ], + "title": "Product.isPinterestEnabled" + }, + { + "id": "script-api:dw/catalog/Product#isProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProduct", + "tags": [ + "isproduct", + "product.isproduct" + ], + "title": "Product.isProduct" + }, + { + "id": "script-api:dw/catalog/Product#isProductSet", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProductSet", + "tags": [ + "isproductset", + "product.isproductset" + ], + "title": "Product.isProductSet" + }, + { + "id": "script-api:dw/catalog/Product#isProductSetProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProductSetProduct", + "tags": [ + "isproductsetproduct", + "product.isproductsetproduct" + ], + "title": "Product.isProductSetProduct" + }, + { + "id": "script-api:dw/catalog/Product#isRetailSet", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isRetailSet", + "tags": [ + "isretailset", + "product.isretailset" + ], + "title": "Product.isRetailSet" + }, + { + "id": "script-api:dw/catalog/Product#isSearchable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isSearchable", + "tags": [ + "issearchable", + "product.issearchable" + ], + "title": "Product.isSearchable" + }, + { + "id": "script-api:dw/catalog/Product#isSiteProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isSiteProduct", + "tags": [ + "issiteproduct", + "product.issiteproduct" + ], + "title": "Product.isSiteProduct" + }, + { + "id": "script-api:dw/catalog/Product#isVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isVariant", + "tags": [ + "isvariant", + "product.isvariant" + ], + "title": "Product.isVariant" + }, + { + "id": "script-api:dw/catalog/Product#isVariationGroup", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isVariationGroup", + "tags": [ + "isvariationgroup", + "product.isvariationgroup" + ], + "title": "Product.isVariationGroup" + }, + { + "id": "script-api:dw/catalog/Product#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.longDescription", + "tags": [ + "longdescription", + "product.longdescription" + ], + "title": "Product.longDescription" + }, + { + "id": "script-api:dw/catalog/Product#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.manufacturerName", + "tags": [ + "manufacturername", + "product.manufacturername" + ], + "title": "Product.manufacturerName" + }, + { + "id": "script-api:dw/catalog/Product#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.manufacturerSKU", + "tags": [ + "manufacturersku", + "product.manufacturersku" + ], + "title": "Product.manufacturerSKU" + }, + { + "id": "script-api:dw/catalog/Product#master", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.master", + "tags": [ + "master", + "product.master" + ], + "title": "Product.master" + }, + { + "id": "script-api:dw/catalog/Product#minOrderQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.minOrderQuantity", + "tags": [ + "minorderquantity", + "product.minorderquantity" + ], + "title": "Product.minOrderQuantity" + }, + { + "id": "script-api:dw/catalog/Product#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.name", + "tags": [ + "name", + "product.name" + ], + "title": "Product.name" + }, + { + "id": "script-api:dw/catalog/Product#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.online", + "tags": [ + "online", + "product.online" + ], + "title": "Product.online" + }, + { + "id": "script-api:dw/catalog/Product#onlineCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineCategories", + "tags": [ + "onlinecategories", + "product.onlinecategories" + ], + "title": "Product.onlineCategories" + }, + { + "id": "script-api:dw/catalog/Product#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineFlag", + "tags": [ + "onlineflag", + "product.onlineflag" + ], + "title": "Product.onlineFlag" + }, + { + "id": "script-api:dw/catalog/Product#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineFrom", + "tags": [ + "onlinefrom", + "product.onlinefrom" + ], + "title": "Product.onlineFrom" + }, + { + "id": "script-api:dw/catalog/Product#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineTo", + "tags": [ + "onlineto", + "product.onlineto" + ], + "title": "Product.onlineTo" + }, + { + "id": "script-api:dw/catalog/Product#optionModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.optionModel", + "tags": [ + "optionmodel", + "product.optionmodel" + ], + "title": "Product.optionModel" + }, + { + "id": "script-api:dw/catalog/Product#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.optionProduct", + "tags": [ + "optionproduct", + "product.optionproduct" + ], + "title": "Product.optionProduct" + }, + { + "id": "script-api:dw/catalog/Product#orderableRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.orderableRecommendations", + "tags": [ + "orderablerecommendations", + "product.orderablerecommendations" + ], + "title": "Product.orderableRecommendations" + }, + { + "id": "script-api:dw/catalog/Product#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageDescription", + "tags": [ + "pagedescription", + "product.pagedescription" + ], + "title": "Product.pageDescription" + }, + { + "id": "script-api:dw/catalog/Product#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageKeywords", + "tags": [ + "pagekeywords", + "product.pagekeywords" + ], + "title": "Product.pageKeywords" + }, + { + "id": "script-api:dw/catalog/Product#pageMetaTags", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageMetaTags", + "tags": [ + "pagemetatags", + "product.pagemetatags" + ], + "title": "Product.pageMetaTags" + }, + { + "id": "script-api:dw/catalog/Product#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageTitle", + "tags": [ + "pagetitle", + "product.pagetitle" + ], + "title": "Product.pageTitle" + }, + { + "id": "script-api:dw/catalog/Product#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageURL", + "tags": [ + "pageurl", + "product.pageurl" + ], + "title": "Product.pageURL" + }, + { + "id": "script-api:dw/catalog/Product#pinterestEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pinterestEnabled", + "tags": [ + "pinterestenabled", + "product.pinterestenabled" + ], + "title": "Product.pinterestEnabled" + }, + { + "id": "script-api:dw/catalog/Product#priceModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.priceModel", + "tags": [ + "pricemodel", + "product.pricemodel" + ], + "title": "Product.priceModel" + }, + { + "id": "script-api:dw/catalog/Product#primaryCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.primaryCategory", + "tags": [ + "primarycategory", + "product.primarycategory" + ], + "title": "Product.primaryCategory" + }, + { + "id": "script-api:dw/catalog/Product#primaryCategoryAssignment", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.primaryCategoryAssignment", + "tags": [ + "primarycategoryassignment", + "product.primarycategoryassignment" + ], + "title": "Product.primaryCategoryAssignment" + }, + { + "id": "script-api:dw/catalog/Product#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.product", + "tags": [ + "product", + "product.product" + ], + "title": "Product.product" + }, + { + "id": "script-api:dw/catalog/Product#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productLinks", + "tags": [ + "productlinks", + "product.productlinks" + ], + "title": "Product.productLinks" + }, + { + "id": "script-api:dw/catalog/Product#productSet", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSet", + "tags": [ + "productset", + "product.productset" + ], + "title": "Product.productSet" + }, + { + "id": "script-api:dw/catalog/Product#productSetProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSetProduct", + "tags": [ + "productsetproduct", + "product.productsetproduct" + ], + "title": "Product.productSetProduct" + }, + { + "id": "script-api:dw/catalog/Product#productSetProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSetProducts", + "tags": [ + "productsetproducts", + "product.productsetproducts" + ], + "title": "Product.productSetProducts" + }, + { + "id": "script-api:dw/catalog/Product#productSets", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSets", + "tags": [ + "productsets", + "product.productsets" + ], + "title": "Product.productSets" + }, + { + "id": "script-api:dw/catalog/Product#recommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.recommendations", + "tags": [ + "recommendations", + "product.recommendations" + ], + "title": "Product.recommendations" + }, + { + "id": "script-api:dw/catalog/Product#retailSet", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.retailSet", + "tags": [ + "retailset", + "product.retailset" + ], + "title": "Product.retailSet" + }, + { + "id": "script-api:dw/catalog/Product#searchPlacement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchPlacement", + "tags": [ + "searchplacement", + "product.searchplacement" + ], + "title": "Product.searchPlacement" + }, + { + "id": "script-api:dw/catalog/Product#searchRank", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchRank", + "tags": [ + "searchrank", + "product.searchrank" + ], + "title": "Product.searchRank" + }, + { + "id": "script-api:dw/catalog/Product#searchable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchable", + "tags": [ + "searchable", + "product.searchable" + ], + "title": "Product.searchable" + }, + { + "id": "script-api:dw/catalog/Product#searchableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchableFlag", + "tags": [ + "searchableflag", + "product.searchableflag" + ], + "title": "Product.searchableFlag" + }, + { + "id": "script-api:dw/catalog/Product#searchableIfUnavailableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchableIfUnavailableFlag", + "tags": [ + "searchableifunavailableflag", + "product.searchableifunavailableflag" + ], + "title": "Product.searchableIfUnavailableFlag" + }, + { + "id": "script-api:dw/catalog/Product#setAvailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setAvailableFlag", + "tags": [ + "setavailableflag", + "product.setavailableflag" + ], + "title": "Product.setAvailableFlag" + }, + { + "id": "script-api:dw/catalog/Product#setOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setOnlineFlag", + "tags": [ + "setonlineflag", + "product.setonlineflag" + ], + "title": "Product.setOnlineFlag" + }, + { + "id": "script-api:dw/catalog/Product#setSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchPlacement", + "tags": [ + "setsearchplacement", + "product.setsearchplacement" + ], + "title": "Product.setSearchPlacement" + }, + { + "id": "script-api:dw/catalog/Product#setSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchRank", + "tags": [ + "setsearchrank", + "product.setsearchrank" + ], + "title": "Product.setSearchRank" + }, + { + "id": "script-api:dw/catalog/Product#setSearchableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchableFlag", + "tags": [ + "setsearchableflag", + "product.setsearchableflag" + ], + "title": "Product.setSearchableFlag" + }, + { + "id": "script-api:dw/catalog/Product#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.shortDescription", + "tags": [ + "shortdescription", + "product.shortdescription" + ], + "title": "Product.shortDescription" + }, + { + "id": "script-api:dw/catalog/Product#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapChangeFrequency", + "tags": [ + "sitemapchangefrequency", + "product.sitemapchangefrequency" + ], + "title": "Product.siteMapChangeFrequency" + }, + { + "id": "script-api:dw/catalog/Product#siteMapIncluded", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapIncluded", + "tags": [ + "sitemapincluded", + "product.sitemapincluded" + ], + "title": "Product.siteMapIncluded" + }, + { + "id": "script-api:dw/catalog/Product#siteMapPriority", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapPriority", + "tags": [ + "sitemappriority", + "product.sitemappriority" + ], + "title": "Product.siteMapPriority" + }, + { + "id": "script-api:dw/catalog/Product#siteProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteProduct", + "tags": [ + "siteproduct", + "product.siteproduct" + ], + "title": "Product.siteProduct" + }, + { + "id": "script-api:dw/catalog/Product#stepQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.stepQuantity", + "tags": [ + "stepquantity", + "product.stepquantity" + ], + "title": "Product.stepQuantity" + }, + { + "id": "script-api:dw/catalog/Product#storeReceiptName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.storeReceiptName", + "tags": [ + "storereceiptname", + "product.storereceiptname" + ], + "title": "Product.storeReceiptName" + }, + { + "id": "script-api:dw/catalog/Product#storeTaxClass", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.storeTaxClass", + "tags": [ + "storetaxclass", + "product.storetaxclass" + ], + "title": "Product.storeTaxClass" + }, + { + "id": "script-api:dw/catalog/Product#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.taxClassID", + "tags": [ + "taxclassid", + "product.taxclassid" + ], + "title": "Product.taxClassID" + }, + { + "id": "script-api:dw/catalog/Product#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.template", + "tags": [ + "template", + "product.template" + ], + "title": "Product.template" + }, + { + "id": "script-api:dw/catalog/Product#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.thumbnail", + "tags": [ + "thumbnail", + "product.thumbnail" + ], + "title": "Product.thumbnail" + }, + { + "id": "script-api:dw/catalog/Product#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.unit", + "tags": [ + "unit", + "product.unit" + ], + "title": "Product.unit" + }, + { + "id": "script-api:dw/catalog/Product#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.unitQuantity", + "tags": [ + "unitquantity", + "product.unitquantity" + ], + "title": "Product.unitQuantity" + }, + { + "id": "script-api:dw/catalog/Product#variant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variant", + "tags": [ + "variant", + "product.variant" + ], + "title": "Product.variant" + }, + { + "id": "script-api:dw/catalog/Product#variants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variants", + "tags": [ + "variants", + "product.variants" + ], + "title": "Product.variants" + }, + { + "id": "script-api:dw/catalog/Product#variationGroup", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationGroup", + "tags": [ + "variationgroup", + "product.variationgroup" + ], + "title": "Product.variationGroup" + }, + { + "id": "script-api:dw/catalog/Product#variationGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationGroups", + "tags": [ + "variationgroups", + "product.variationgroups" + ], + "title": "Product.variationGroups" + }, + { + "id": "script-api:dw/catalog/Product#variationModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationModel", + "tags": [ + "variationmodel", + "product.variationmodel" + ], + "title": "Product.variationModel" + }, + { + "id": "script-api:dw/catalog/ProductActiveData", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductActiveData", + "tags": [ + "productactivedata", + "dw.catalog.productactivedata", + "dw/catalog" + ], + "title": "ProductActiveData" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#availableDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.availableDate", + "tags": [ + "availabledate", + "productactivedata.availabledate" + ], + "title": "ProductActiveData.availableDate" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentDay", + "tags": [ + "avggrossmarginpercentday", + "productactivedata.avggrossmarginpercentday" + ], + "title": "ProductActiveData.avgGrossMarginPercentDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentMonth", + "tags": [ + "avggrossmarginpercentmonth", + "productactivedata.avggrossmarginpercentmonth" + ], + "title": "ProductActiveData.avgGrossMarginPercentMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentWeek", + "tags": [ + "avggrossmarginpercentweek", + "productactivedata.avggrossmarginpercentweek" + ], + "title": "ProductActiveData.avgGrossMarginPercentWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentYear", + "tags": [ + "avggrossmarginpercentyear", + "productactivedata.avggrossmarginpercentyear" + ], + "title": "ProductActiveData.avgGrossMarginPercentYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueDay", + "tags": [ + "avggrossmarginvalueday", + "productactivedata.avggrossmarginvalueday" + ], + "title": "ProductActiveData.avgGrossMarginValueDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueMonth", + "tags": [ + "avggrossmarginvaluemonth", + "productactivedata.avggrossmarginvaluemonth" + ], + "title": "ProductActiveData.avgGrossMarginValueMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueWeek", + "tags": [ + "avggrossmarginvalueweek", + "productactivedata.avggrossmarginvalueweek" + ], + "title": "ProductActiveData.avgGrossMarginValueWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueYear", + "tags": [ + "avggrossmarginvalueyear", + "productactivedata.avggrossmarginvalueyear" + ], + "title": "ProductActiveData.avgGrossMarginValueYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceDay", + "tags": [ + "avgsalespriceday", + "productactivedata.avgsalespriceday" + ], + "title": "ProductActiveData.avgSalesPriceDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceMonth", + "tags": [ + "avgsalespricemonth", + "productactivedata.avgsalespricemonth" + ], + "title": "ProductActiveData.avgSalesPriceMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceWeek", + "tags": [ + "avgsalespriceweek", + "productactivedata.avgsalespriceweek" + ], + "title": "ProductActiveData.avgSalesPriceWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceYear", + "tags": [ + "avgsalespriceyear", + "productactivedata.avgsalespriceyear" + ], + "title": "ProductActiveData.avgSalesPriceYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#conversionDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionDay", + "tags": [ + "conversionday", + "productactivedata.conversionday" + ], + "title": "ProductActiveData.conversionDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#conversionMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionMonth", + "tags": [ + "conversionmonth", + "productactivedata.conversionmonth" + ], + "title": "ProductActiveData.conversionMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#conversionWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionWeek", + "tags": [ + "conversionweek", + "productactivedata.conversionweek" + ], + "title": "ProductActiveData.conversionWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#conversionYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionYear", + "tags": [ + "conversionyear", + "productactivedata.conversionyear" + ], + "title": "ProductActiveData.conversionYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#costPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.costPrice", + "tags": [ + "costprice", + "productactivedata.costprice" + ], + "title": "ProductActiveData.costPrice" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#daysAvailable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.daysAvailable", + "tags": [ + "daysavailable", + "productactivedata.daysavailable" + ], + "title": "ProductActiveData.daysAvailable" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvailableDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvailableDate", + "tags": [ + "getavailabledate", + "productactivedata.getavailabledate" + ], + "title": "ProductActiveData.getAvailableDate" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentDay", + "tags": [ + "getavggrossmarginpercentday", + "productactivedata.getavggrossmarginpercentday" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentMonth", + "tags": [ + "getavggrossmarginpercentmonth", + "productactivedata.getavggrossmarginpercentmonth" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentWeek", + "tags": [ + "getavggrossmarginpercentweek", + "productactivedata.getavggrossmarginpercentweek" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentYear", + "tags": [ + "getavggrossmarginpercentyear", + "productactivedata.getavggrossmarginpercentyear" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueDay", + "tags": [ + "getavggrossmarginvalueday", + "productactivedata.getavggrossmarginvalueday" + ], + "title": "ProductActiveData.getAvgGrossMarginValueDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueMonth", + "tags": [ + "getavggrossmarginvaluemonth", + "productactivedata.getavggrossmarginvaluemonth" + ], + "title": "ProductActiveData.getAvgGrossMarginValueMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueWeek", + "tags": [ + "getavggrossmarginvalueweek", + "productactivedata.getavggrossmarginvalueweek" + ], + "title": "ProductActiveData.getAvgGrossMarginValueWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueYear", + "tags": [ + "getavggrossmarginvalueyear", + "productactivedata.getavggrossmarginvalueyear" + ], + "title": "ProductActiveData.getAvgGrossMarginValueYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceDay", + "tags": [ + "getavgsalespriceday", + "productactivedata.getavgsalespriceday" + ], + "title": "ProductActiveData.getAvgSalesPriceDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceMonth", + "tags": [ + "getavgsalespricemonth", + "productactivedata.getavgsalespricemonth" + ], + "title": "ProductActiveData.getAvgSalesPriceMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceWeek", + "tags": [ + "getavgsalespriceweek", + "productactivedata.getavgsalespriceweek" + ], + "title": "ProductActiveData.getAvgSalesPriceWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceYear", + "tags": [ + "getavgsalespriceyear", + "productactivedata.getavgsalespriceyear" + ], + "title": "ProductActiveData.getAvgSalesPriceYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getConversionDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionDay", + "tags": [ + "getconversionday", + "productactivedata.getconversionday" + ], + "title": "ProductActiveData.getConversionDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getConversionMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionMonth", + "tags": [ + "getconversionmonth", + "productactivedata.getconversionmonth" + ], + "title": "ProductActiveData.getConversionMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getConversionWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionWeek", + "tags": [ + "getconversionweek", + "productactivedata.getconversionweek" + ], + "title": "ProductActiveData.getConversionWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getConversionYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionYear", + "tags": [ + "getconversionyear", + "productactivedata.getconversionyear" + ], + "title": "ProductActiveData.getConversionYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getCostPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getCostPrice", + "tags": [ + "getcostprice", + "productactivedata.getcostprice" + ], + "title": "ProductActiveData.getCostPrice" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getDaysAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getDaysAvailable", + "tags": [ + "getdaysavailable", + "productactivedata.getdaysavailable" + ], + "title": "ProductActiveData.getDaysAvailable" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsDay", + "tags": [ + "getimpressionsday", + "productactivedata.getimpressionsday" + ], + "title": "ProductActiveData.getImpressionsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsMonth", + "tags": [ + "getimpressionsmonth", + "productactivedata.getimpressionsmonth" + ], + "title": "ProductActiveData.getImpressionsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsWeek", + "tags": [ + "getimpressionsweek", + "productactivedata.getimpressionsweek" + ], + "title": "ProductActiveData.getImpressionsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsYear", + "tags": [ + "getimpressionsyear", + "productactivedata.getimpressionsyear" + ], + "title": "ProductActiveData.getImpressionsYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioDay", + "tags": [ + "getlooktobookratioday", + "productactivedata.getlooktobookratioday" + ], + "title": "ProductActiveData.getLookToBookRatioDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioMonth", + "tags": [ + "getlooktobookratiomonth", + "productactivedata.getlooktobookratiomonth" + ], + "title": "ProductActiveData.getLookToBookRatioMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioWeek", + "tags": [ + "getlooktobookratioweek", + "productactivedata.getlooktobookratioweek" + ], + "title": "ProductActiveData.getLookToBookRatioWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioYear", + "tags": [ + "getlooktobookratioyear", + "productactivedata.getlooktobookratioyear" + ], + "title": "ProductActiveData.getLookToBookRatioYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getOrdersDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersDay", + "tags": [ + "getordersday", + "productactivedata.getordersday" + ], + "title": "ProductActiveData.getOrdersDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getOrdersMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersMonth", + "tags": [ + "getordersmonth", + "productactivedata.getordersmonth" + ], + "title": "ProductActiveData.getOrdersMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getOrdersWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersWeek", + "tags": [ + "getordersweek", + "productactivedata.getordersweek" + ], + "title": "ProductActiveData.getOrdersWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getOrdersYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersYear", + "tags": [ + "getordersyear", + "productactivedata.getordersyear" + ], + "title": "ProductActiveData.getOrdersYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getReturnRate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getReturnRate", + "tags": [ + "getreturnrate", + "productactivedata.getreturnrate" + ], + "title": "ProductActiveData.getReturnRate" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getRevenueDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueDay", + "tags": [ + "getrevenueday", + "productactivedata.getrevenueday" + ], + "title": "ProductActiveData.getRevenueDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getRevenueMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueMonth", + "tags": [ + "getrevenuemonth", + "productactivedata.getrevenuemonth" + ], + "title": "ProductActiveData.getRevenueMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getRevenueWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueWeek", + "tags": [ + "getrevenueweek", + "productactivedata.getrevenueweek" + ], + "title": "ProductActiveData.getRevenueWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getRevenueYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueYear", + "tags": [ + "getrevenueyear", + "productactivedata.getrevenueyear" + ], + "title": "ProductActiveData.getRevenueYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityDay", + "tags": [ + "getsalesvelocityday", + "productactivedata.getsalesvelocityday" + ], + "title": "ProductActiveData.getSalesVelocityDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityMonth", + "tags": [ + "getsalesvelocitymonth", + "productactivedata.getsalesvelocitymonth" + ], + "title": "ProductActiveData.getSalesVelocityMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityWeek", + "tags": [ + "getsalesvelocityweek", + "productactivedata.getsalesvelocityweek" + ], + "title": "ProductActiveData.getSalesVelocityWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityYear", + "tags": [ + "getsalesvelocityyear", + "productactivedata.getsalesvelocityyear" + ], + "title": "ProductActiveData.getSalesVelocityYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getUnitsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsDay", + "tags": [ + "getunitsday", + "productactivedata.getunitsday" + ], + "title": "ProductActiveData.getUnitsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getUnitsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsMonth", + "tags": [ + "getunitsmonth", + "productactivedata.getunitsmonth" + ], + "title": "ProductActiveData.getUnitsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getUnitsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsWeek", + "tags": [ + "getunitsweek", + "productactivedata.getunitsweek" + ], + "title": "ProductActiveData.getUnitsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getUnitsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsYear", + "tags": [ + "getunitsyear", + "productactivedata.getunitsyear" + ], + "title": "ProductActiveData.getUnitsYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getViewsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsDay", + "tags": [ + "getviewsday", + "productactivedata.getviewsday" + ], + "title": "ProductActiveData.getViewsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getViewsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsMonth", + "tags": [ + "getviewsmonth", + "productactivedata.getviewsmonth" + ], + "title": "ProductActiveData.getViewsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getViewsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsWeek", + "tags": [ + "getviewsweek", + "productactivedata.getviewsweek" + ], + "title": "ProductActiveData.getViewsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#getViewsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsYear", + "tags": [ + "getviewsyear", + "productactivedata.getviewsyear" + ], + "title": "ProductActiveData.getViewsYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#impressionsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsDay", + "tags": [ + "impressionsday", + "productactivedata.impressionsday" + ], + "title": "ProductActiveData.impressionsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#impressionsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsMonth", + "tags": [ + "impressionsmonth", + "productactivedata.impressionsmonth" + ], + "title": "ProductActiveData.impressionsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#impressionsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsWeek", + "tags": [ + "impressionsweek", + "productactivedata.impressionsweek" + ], + "title": "ProductActiveData.impressionsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#impressionsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsYear", + "tags": [ + "impressionsyear", + "productactivedata.impressionsyear" + ], + "title": "ProductActiveData.impressionsYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioDay", + "tags": [ + "looktobookratioday", + "productactivedata.looktobookratioday" + ], + "title": "ProductActiveData.lookToBookRatioDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioMonth", + "tags": [ + "looktobookratiomonth", + "productactivedata.looktobookratiomonth" + ], + "title": "ProductActiveData.lookToBookRatioMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioWeek", + "tags": [ + "looktobookratioweek", + "productactivedata.looktobookratioweek" + ], + "title": "ProductActiveData.lookToBookRatioWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioYear", + "tags": [ + "looktobookratioyear", + "productactivedata.looktobookratioyear" + ], + "title": "ProductActiveData.lookToBookRatioYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#ordersDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersDay", + "tags": [ + "ordersday", + "productactivedata.ordersday" + ], + "title": "ProductActiveData.ordersDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#ordersMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersMonth", + "tags": [ + "ordersmonth", + "productactivedata.ordersmonth" + ], + "title": "ProductActiveData.ordersMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#ordersWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersWeek", + "tags": [ + "ordersweek", + "productactivedata.ordersweek" + ], + "title": "ProductActiveData.ordersWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#ordersYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersYear", + "tags": [ + "ordersyear", + "productactivedata.ordersyear" + ], + "title": "ProductActiveData.ordersYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#returnRate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.returnRate", + "tags": [ + "returnrate", + "productactivedata.returnrate" + ], + "title": "ProductActiveData.returnRate" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#revenueDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueDay", + "tags": [ + "revenueday", + "productactivedata.revenueday" + ], + "title": "ProductActiveData.revenueDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#revenueMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueMonth", + "tags": [ + "revenuemonth", + "productactivedata.revenuemonth" + ], + "title": "ProductActiveData.revenueMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#revenueWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueWeek", + "tags": [ + "revenueweek", + "productactivedata.revenueweek" + ], + "title": "ProductActiveData.revenueWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#revenueYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueYear", + "tags": [ + "revenueyear", + "productactivedata.revenueyear" + ], + "title": "ProductActiveData.revenueYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityDay", + "tags": [ + "salesvelocityday", + "productactivedata.salesvelocityday" + ], + "title": "ProductActiveData.salesVelocityDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityMonth", + "tags": [ + "salesvelocitymonth", + "productactivedata.salesvelocitymonth" + ], + "title": "ProductActiveData.salesVelocityMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityWeek", + "tags": [ + "salesvelocityweek", + "productactivedata.salesvelocityweek" + ], + "title": "ProductActiveData.salesVelocityWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityYear", + "tags": [ + "salesvelocityyear", + "productactivedata.salesvelocityyear" + ], + "title": "ProductActiveData.salesVelocityYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#unitsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsDay", + "tags": [ + "unitsday", + "productactivedata.unitsday" + ], + "title": "ProductActiveData.unitsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#unitsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsMonth", + "tags": [ + "unitsmonth", + "productactivedata.unitsmonth" + ], + "title": "ProductActiveData.unitsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#unitsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsWeek", + "tags": [ + "unitsweek", + "productactivedata.unitsweek" + ], + "title": "ProductActiveData.unitsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#unitsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsYear", + "tags": [ + "unitsyear", + "productactivedata.unitsyear" + ], + "title": "ProductActiveData.unitsYear" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#viewsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsDay", + "tags": [ + "viewsday", + "productactivedata.viewsday" + ], + "title": "ProductActiveData.viewsDay" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#viewsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsMonth", + "tags": [ + "viewsmonth", + "productactivedata.viewsmonth" + ], + "title": "ProductActiveData.viewsMonth" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#viewsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsWeek", + "tags": [ + "viewsweek", + "productactivedata.viewsweek" + ], + "title": "ProductActiveData.viewsWeek" + }, + { + "id": "script-api:dw/catalog/ProductActiveData#viewsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsYear", + "tags": [ + "viewsyear", + "productactivedata.viewsyear" + ], + "title": "ProductActiveData.viewsYear" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAttributeModel", + "tags": [ + "productattributemodel", + "dw.catalog.productattributemodel", + "dw/catalog" + ], + "title": "ProductAttributeModel" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#attributeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.attributeGroups", + "tags": [ + "attributegroups", + "productattributemodel.attributegroups" + ], + "title": "ProductAttributeModel.attributeGroups" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeDefinition", + "tags": [ + "getattributedefinition", + "productattributemodel.getattributedefinition" + ], + "title": "ProductAttributeModel.getAttributeDefinition" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeDefinitions", + "tags": [ + "getattributedefinitions", + "productattributemodel.getattributedefinitions" + ], + "title": "ProductAttributeModel.getAttributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeGroup", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeGroup", + "tags": [ + "getattributegroup", + "productattributemodel.getattributegroup" + ], + "title": "ProductAttributeModel.getAttributeGroup" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeGroups", + "tags": [ + "getattributegroups", + "productattributemodel.getattributegroups" + ], + "title": "ProductAttributeModel.getAttributeGroups" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getDisplayValue", + "tags": [ + "getdisplayvalue", + "productattributemodel.getdisplayvalue" + ], + "title": "ProductAttributeModel.getDisplayValue" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getOrderRequiredAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getOrderRequiredAttributeDefinitions", + "tags": [ + "getorderrequiredattributedefinitions", + "productattributemodel.getorderrequiredattributedefinitions" + ], + "title": "ProductAttributeModel.getOrderRequiredAttributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getValue", + "tags": [ + "getvalue", + "productattributemodel.getvalue" + ], + "title": "ProductAttributeModel.getValue" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getVisibleAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getVisibleAttributeDefinitions", + "tags": [ + "getvisibleattributedefinitions", + "productattributemodel.getvisibleattributedefinitions" + ], + "title": "ProductAttributeModel.getVisibleAttributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#getVisibleAttributeGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getVisibleAttributeGroups", + "tags": [ + "getvisibleattributegroups", + "productattributemodel.getvisibleattributegroups" + ], + "title": "ProductAttributeModel.getVisibleAttributeGroups" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#orderRequiredAttributeDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.orderRequiredAttributeDefinitions", + "tags": [ + "orderrequiredattributedefinitions", + "productattributemodel.orderrequiredattributedefinitions" + ], + "title": "ProductAttributeModel.orderRequiredAttributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductAttributeModel#visibleAttributeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.visibleAttributeGroups", + "tags": [ + "visibleattributegroups", + "productattributemodel.visibleattributegroups" + ], + "title": "ProductAttributeModel.visibleAttributeGroups" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels", + "tags": [ + "productavailabilitylevels", + "dw.catalog.productavailabilitylevels", + "dw/catalog" + ], + "title": "ProductAvailabilityLevels" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#backorder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.backorder", + "tags": [ + "backorder", + "productavailabilitylevels.backorder" + ], + "title": "ProductAvailabilityLevels.backorder" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#count", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.count", + "tags": [ + "count", + "productavailabilitylevels.count" + ], + "title": "ProductAvailabilityLevels.count" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getBackorder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getBackorder", + "tags": [ + "getbackorder", + "productavailabilitylevels.getbackorder" + ], + "title": "ProductAvailabilityLevels.getBackorder" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getCount", + "tags": [ + "getcount", + "productavailabilitylevels.getcount" + ], + "title": "ProductAvailabilityLevels.getCount" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getInStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getInStock", + "tags": [ + "getinstock", + "productavailabilitylevels.getinstock" + ], + "title": "ProductAvailabilityLevels.getInStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getNotAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getNotAvailable", + "tags": [ + "getnotavailable", + "productavailabilitylevels.getnotavailable" + ], + "title": "ProductAvailabilityLevels.getNotAvailable" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getPreorder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getPreorder", + "tags": [ + "getpreorder", + "productavailabilitylevels.getpreorder" + ], + "title": "ProductAvailabilityLevels.getPreorder" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#inStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.inStock", + "tags": [ + "instock", + "productavailabilitylevels.instock" + ], + "title": "ProductAvailabilityLevels.inStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#notAvailable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.notAvailable", + "tags": [ + "notavailable", + "productavailabilitylevels.notavailable" + ], + "title": "ProductAvailabilityLevels.notAvailable" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityLevels#preorder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.preorder", + "tags": [ + "preorder", + "productavailabilitylevels.preorder" + ], + "title": "ProductAvailabilityLevels.preorder" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAvailabilityModel", + "tags": [ + "productavailabilitymodel", + "dw.catalog.productavailabilitymodel", + "dw/catalog" + ], + "title": "ProductAvailabilityModel" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER", + "tags": [ + "availability_status_backorder", + "productavailabilitymodel.availability_status_backorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER", + "tags": [ + "availability_status_backorder", + "productavailabilitymodel.availability_status_backorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_IN_STOCK", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK", + "tags": [ + "availability_status_in_stock", + "productavailabilitymodel.availability_status_in_stock" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_IN_STOCK", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK", + "tags": [ + "availability_status_in_stock", + "productavailabilitymodel.availability_status_in_stock" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE", + "tags": [ + "availability_status_not_available", + "productavailabilitymodel.availability_status_not_available" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE", + "tags": [ + "availability_status_not_available", + "productavailabilitymodel.availability_status_not_available" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_PREORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER", + "tags": [ + "availability_status_preorder", + "productavailabilitymodel.availability_status_preorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_PREORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER", + "tags": [ + "availability_status_preorder", + "productavailabilitymodel.availability_status_preorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#SKUCoverage", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.SKUCoverage", + "tags": [ + "skucoverage", + "productavailabilitymodel.skucoverage" + ], + "title": "ProductAvailabilityModel.SKUCoverage" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#availability", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.availability", + "tags": [ + "availability", + "productavailabilitymodel.availability" + ], + "title": "ProductAvailabilityModel.availability" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#availabilityStatus", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.availabilityStatus", + "tags": [ + "availabilitystatus", + "productavailabilitymodel.availabilitystatus" + ], + "title": "ProductAvailabilityModel.availabilityStatus" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailability", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailability", + "tags": [ + "getavailability", + "productavailabilitymodel.getavailability" + ], + "title": "ProductAvailabilityModel.getAvailability" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailabilityLevels", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailabilityLevels", + "tags": [ + "getavailabilitylevels", + "productavailabilitymodel.getavailabilitylevels" + ], + "title": "ProductAvailabilityModel.getAvailabilityLevels" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailabilityStatus", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailabilityStatus", + "tags": [ + "getavailabilitystatus", + "productavailabilitymodel.getavailabilitystatus" + ], + "title": "ProductAvailabilityModel.getAvailabilityStatus" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getInventoryRecord", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getInventoryRecord", + "tags": [ + "getinventoryrecord", + "productavailabilitymodel.getinventoryrecord" + ], + "title": "ProductAvailabilityModel.getInventoryRecord" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getSKUCoverage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getSKUCoverage", + "tags": [ + "getskucoverage", + "productavailabilitymodel.getskucoverage" + ], + "title": "ProductAvailabilityModel.getSKUCoverage" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#getTimeToOutOfStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getTimeToOutOfStock", + "tags": [ + "gettimetooutofstock", + "productavailabilitymodel.gettimetooutofstock" + ], + "title": "ProductAvailabilityModel.getTimeToOutOfStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#inStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.inStock", + "tags": [ + "instock", + "productavailabilitymodel.instock" + ], + "title": "ProductAvailabilityModel.inStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#inventoryRecord", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.inventoryRecord", + "tags": [ + "inventoryrecord", + "productavailabilitymodel.inventoryrecord" + ], + "title": "ProductAvailabilityModel.inventoryRecord" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#isInStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isInStock", + "tags": [ + "isinstock", + "productavailabilitymodel.isinstock" + ], + "title": "ProductAvailabilityModel.isInStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#isInStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isInStock", + "tags": [ + "isinstock", + "productavailabilitymodel.isinstock" + ], + "title": "ProductAvailabilityModel.isInStock" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#isOrderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isOrderable", + "tags": [ + "isorderable", + "productavailabilitymodel.isorderable" + ], + "title": "ProductAvailabilityModel.isOrderable" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#isOrderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isOrderable", + "tags": [ + "isorderable", + "productavailabilitymodel.isorderable" + ], + "title": "ProductAvailabilityModel.isOrderable" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#orderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.orderable", + "tags": [ + "orderable", + "productavailabilitymodel.orderable" + ], + "title": "ProductAvailabilityModel.orderable" + }, + { + "id": "script-api:dw/catalog/ProductAvailabilityModel#timeToOutOfStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.timeToOutOfStock", + "tags": [ + "timetooutofstock", + "productavailabilitymodel.timetooutofstock" + ], + "title": "ProductAvailabilityModel.timeToOutOfStock" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryList", + "tags": [ + "productinventorylist", + "dw.catalog.productinventorylist", + "dw/catalog" + ], + "title": "ProductInventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.ID", + "tags": [ + "id", + "productinventorylist.id" + ], + "title": "ProductInventoryList.ID" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#defaultInStockFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.defaultInStockFlag", + "tags": [ + "defaultinstockflag", + "productinventorylist.defaultinstockflag" + ], + "title": "ProductInventoryList.defaultInStockFlag" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.description", + "tags": [ + "description", + "productinventorylist.description" + ], + "title": "ProductInventoryList.description" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#getDefaultInStockFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getDefaultInStockFlag", + "tags": [ + "getdefaultinstockflag", + "productinventorylist.getdefaultinstockflag" + ], + "title": "ProductInventoryList.getDefaultInStockFlag" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getDescription", + "tags": [ + "getdescription", + "productinventorylist.getdescription" + ], + "title": "ProductInventoryList.getDescription" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getID", + "tags": [ + "getid", + "productinventorylist.getid" + ], + "title": "ProductInventoryList.getID" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#getRecord", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getRecord", + "tags": [ + "getrecord", + "productinventorylist.getrecord" + ], + "title": "ProductInventoryList.getRecord" + }, + { + "id": "script-api:dw/catalog/ProductInventoryList#getRecord", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getRecord", + "tags": [ + "getrecord", + "productinventorylist.getrecord" + ], + "title": "ProductInventoryList.getRecord" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryMgr", + "tags": [ + "productinventorymgr", + "dw.catalog.productinventorymgr", + "dw/catalog" + ], + "title": "ProductInventoryMgr" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_B2C", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_B2C", + "tags": [ + "integrationmode_b2c", + "productinventorymgr.integrationmode_b2c" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_B2C" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_B2C", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_B2C", + "tags": [ + "integrationmode_b2c", + "productinventorymgr.integrationmode_b2c" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_B2C" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI", + "tags": [ + "integrationmode_oci", + "productinventorymgr.integrationmode_oci" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI", + "tags": [ + "integrationmode_oci", + "productinventorymgr.integrationmode_oci" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI_CACHE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE", + "tags": [ + "integrationmode_oci_cache", + "productinventorymgr.integrationmode_oci_cache" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI_CACHE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE", + "tags": [ + "integrationmode_oci_cache", + "productinventorymgr.integrationmode_oci_cache" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryIntegrationMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryIntegrationMode", + "tags": [ + "getinventoryintegrationmode", + "productinventorymgr.getinventoryintegrationmode" + ], + "title": "ProductInventoryMgr.getInventoryIntegrationMode" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryIntegrationMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryIntegrationMode", + "tags": [ + "getinventoryintegrationmode", + "productinventorymgr.getinventoryintegrationmode" + ], + "title": "ProductInventoryMgr.getInventoryIntegrationMode" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryIntegrationMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryIntegrationMode", + "tags": [ + "inventoryintegrationmode", + "productinventorymgr.inventoryintegrationmode" + ], + "title": "ProductInventoryMgr.inventoryIntegrationMode" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryIntegrationMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryIntegrationMode", + "tags": [ + "inventoryintegrationmode", + "productinventorymgr.inventoryintegrationmode" + ], + "title": "ProductInventoryMgr.inventoryIntegrationMode" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryList", + "tags": [ + "inventorylist", + "productinventorymgr.inventorylist" + ], + "title": "ProductInventoryMgr.inventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryList", + "tags": [ + "inventorylist", + "productinventorymgr.inventorylist" + ], + "title": "ProductInventoryMgr.inventoryList" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryRecord", + "tags": [ + "productinventoryrecord", + "dw.catalog.productinventoryrecord", + "dw/catalog" + ], + "title": "ProductInventoryRecord" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#ATS", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.ATS", + "tags": [ + "ats", + "productinventoryrecord.ats" + ], + "title": "ProductInventoryRecord.ATS" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#allocation", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.allocation", + "tags": [ + "allocation", + "productinventoryrecord.allocation" + ], + "title": "ProductInventoryRecord.allocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#allocationResetDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.allocationResetDate", + "tags": [ + "allocationresetdate", + "productinventoryrecord.allocationresetdate" + ], + "title": "ProductInventoryRecord.allocationResetDate" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#backorderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.backorderable", + "tags": [ + "backorderable", + "productinventoryrecord.backorderable" + ], + "title": "ProductInventoryRecord.backorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#describe", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.describe", + "tags": [ + "describe", + "productinventoryrecord.describe" + ], + "title": "ProductInventoryRecord.describe" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getATS", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getATS", + "tags": [ + "getats", + "productinventoryrecord.getats" + ], + "title": "ProductInventoryRecord.getATS" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getAllocation", + "tags": [ + "getallocation", + "productinventoryrecord.getallocation" + ], + "title": "ProductInventoryRecord.getAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getAllocationResetDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getAllocationResetDate", + "tags": [ + "getallocationresetdate", + "productinventoryrecord.getallocationresetdate" + ], + "title": "ProductInventoryRecord.getAllocationResetDate" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getInStockDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getInStockDate", + "tags": [ + "getinstockdate", + "productinventoryrecord.getinstockdate" + ], + "title": "ProductInventoryRecord.getInStockDate" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getOnHand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getOnHand", + "tags": [ + "getonhand", + "productinventoryrecord.getonhand" + ], + "title": "ProductInventoryRecord.getOnHand" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getOnOrder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getOnOrder", + "tags": [ + "getonorder", + "productinventoryrecord.getonorder" + ], + "title": "ProductInventoryRecord.getOnOrder" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getPreorderBackorderAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getPreorderBackorderAllocation", + "tags": [ + "getpreorderbackorderallocation", + "productinventoryrecord.getpreorderbackorderallocation" + ], + "title": "ProductInventoryRecord.getPreorderBackorderAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getReserved", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getReserved", + "tags": [ + "getreserved", + "productinventoryrecord.getreserved" + ], + "title": "ProductInventoryRecord.getReserved" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getStockLevel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getStockLevel", + "tags": [ + "getstocklevel", + "productinventoryrecord.getstocklevel" + ], + "title": "ProductInventoryRecord.getStockLevel" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#getTurnover", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getTurnover", + "tags": [ + "getturnover", + "productinventoryrecord.getturnover" + ], + "title": "ProductInventoryRecord.getTurnover" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#inStockDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.inStockDate", + "tags": [ + "instockdate", + "productinventoryrecord.instockdate" + ], + "title": "ProductInventoryRecord.inStockDate" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#isBackorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isBackorderable", + "tags": [ + "isbackorderable", + "productinventoryrecord.isbackorderable" + ], + "title": "ProductInventoryRecord.isBackorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#isPerpetual", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isPerpetual", + "tags": [ + "isperpetual", + "productinventoryrecord.isperpetual" + ], + "title": "ProductInventoryRecord.isPerpetual" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#isPreorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isPreorderable", + "tags": [ + "ispreorderable", + "productinventoryrecord.ispreorderable" + ], + "title": "ProductInventoryRecord.isPreorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#onHand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.onHand", + "tags": [ + "onhand", + "productinventoryrecord.onhand" + ], + "title": "ProductInventoryRecord.onHand" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#onOrder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.onOrder", + "tags": [ + "onorder", + "productinventoryrecord.onorder" + ], + "title": "ProductInventoryRecord.onOrder" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#perpetual", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.perpetual", + "tags": [ + "perpetual", + "productinventoryrecord.perpetual" + ], + "title": "ProductInventoryRecord.perpetual" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#preorderBackorderAllocation", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.preorderBackorderAllocation", + "tags": [ + "preorderbackorderallocation", + "productinventoryrecord.preorderbackorderallocation" + ], + "title": "ProductInventoryRecord.preorderBackorderAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#preorderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.preorderable", + "tags": [ + "preorderable", + "productinventoryrecord.preorderable" + ], + "title": "ProductInventoryRecord.preorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#reserved", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.reserved", + "tags": [ + "reserved", + "productinventoryrecord.reserved" + ], + "title": "ProductInventoryRecord.reserved" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setAllocation", + "tags": [ + "setallocation", + "productinventoryrecord.setallocation" + ], + "title": "ProductInventoryRecord.setAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setAllocation", + "tags": [ + "setallocation", + "productinventoryrecord.setallocation" + ], + "title": "ProductInventoryRecord.setAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setBackorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setBackorderable", + "tags": [ + "setbackorderable", + "productinventoryrecord.setbackorderable" + ], + "title": "ProductInventoryRecord.setBackorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setInStockDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setInStockDate", + "tags": [ + "setinstockdate", + "productinventoryrecord.setinstockdate" + ], + "title": "ProductInventoryRecord.setInStockDate" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setPerpetual", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPerpetual", + "tags": [ + "setperpetual", + "productinventoryrecord.setperpetual" + ], + "title": "ProductInventoryRecord.setPerpetual" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setPreorderBackorderAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPreorderBackorderAllocation", + "tags": [ + "setpreorderbackorderallocation", + "productinventoryrecord.setpreorderbackorderallocation" + ], + "title": "ProductInventoryRecord.setPreorderBackorderAllocation" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#setPreorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPreorderable", + "tags": [ + "setpreorderable", + "productinventoryrecord.setpreorderable" + ], + "title": "ProductInventoryRecord.setPreorderable" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#stockLevel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.stockLevel", + "tags": [ + "stocklevel", + "productinventoryrecord.stocklevel" + ], + "title": "ProductInventoryRecord.stockLevel" + }, + { + "id": "script-api:dw/catalog/ProductInventoryRecord#turnover", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.turnover", + "tags": [ + "turnover", + "productinventoryrecord.turnover" + ], + "title": "ProductInventoryRecord.turnover" + }, + { + "id": "script-api:dw/catalog/ProductLink", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductLink", + "tags": [ + "productlink", + "dw.catalog.productlink", + "dw/catalog" + ], + "title": "ProductLink" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ACCESSORY", + "tags": [ + "linktype_accessory", + "productlink.linktype_accessory" + ], + "title": "ProductLink.LINKTYPE_ACCESSORY" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ACCESSORY", + "tags": [ + "linktype_accessory", + "productlink.linktype_accessory" + ], + "title": "ProductLink.LINKTYPE_ACCESSORY" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ALT_ORDERUNIT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ALT_ORDERUNIT", + "tags": [ + "linktype_alt_orderunit", + "productlink.linktype_alt_orderunit" + ], + "title": "ProductLink.LINKTYPE_ALT_ORDERUNIT" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ALT_ORDERUNIT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ALT_ORDERUNIT", + "tags": [ + "linktype_alt_orderunit", + "productlink.linktype_alt_orderunit" + ], + "title": "ProductLink.LINKTYPE_ALT_ORDERUNIT" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_CROSS_SELL", + "tags": [ + "linktype_cross_sell", + "productlink.linktype_cross_sell" + ], + "title": "ProductLink.LINKTYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_CROSS_SELL", + "tags": [ + "linktype_cross_sell", + "productlink.linktype_cross_sell" + ], + "title": "ProductLink.LINKTYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_NEWER_VERSION", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_NEWER_VERSION", + "tags": [ + "linktype_newer_version", + "productlink.linktype_newer_version" + ], + "title": "ProductLink.LINKTYPE_NEWER_VERSION" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_NEWER_VERSION", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_NEWER_VERSION", + "tags": [ + "linktype_newer_version", + "productlink.linktype_newer_version" + ], + "title": "ProductLink.LINKTYPE_NEWER_VERSION" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_OTHER", + "tags": [ + "linktype_other", + "productlink.linktype_other" + ], + "title": "ProductLink.LINKTYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_OTHER", + "tags": [ + "linktype_other", + "productlink.linktype_other" + ], + "title": "ProductLink.LINKTYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_REPLACEMENT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_REPLACEMENT", + "tags": [ + "linktype_replacement", + "productlink.linktype_replacement" + ], + "title": "ProductLink.LINKTYPE_REPLACEMENT" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_REPLACEMENT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_REPLACEMENT", + "tags": [ + "linktype_replacement", + "productlink.linktype_replacement" + ], + "title": "ProductLink.LINKTYPE_REPLACEMENT" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_SPARE_PART", + "tags": [ + "linktype_spare_part", + "productlink.linktype_spare_part" + ], + "title": "ProductLink.LINKTYPE_SPARE_PART" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_SPARE_PART", + "tags": [ + "linktype_spare_part", + "productlink.linktype_spare_part" + ], + "title": "ProductLink.LINKTYPE_SPARE_PART" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_UP_SELL", + "tags": [ + "linktype_up_sell", + "productlink.linktype_up_sell" + ], + "title": "ProductLink.LINKTYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_UP_SELL", + "tags": [ + "linktype_up_sell", + "productlink.linktype_up_sell" + ], + "title": "ProductLink.LINKTYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/ProductLink#getSourceProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getSourceProduct", + "tags": [ + "getsourceproduct", + "productlink.getsourceproduct" + ], + "title": "ProductLink.getSourceProduct" + }, + { + "id": "script-api:dw/catalog/ProductLink#getTargetProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getTargetProduct", + "tags": [ + "gettargetproduct", + "productlink.gettargetproduct" + ], + "title": "ProductLink.getTargetProduct" + }, + { + "id": "script-api:dw/catalog/ProductLink#getTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getTypeCode", + "tags": [ + "gettypecode", + "productlink.gettypecode" + ], + "title": "ProductLink.getTypeCode" + }, + { + "id": "script-api:dw/catalog/ProductLink#sourceProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.sourceProduct", + "tags": [ + "sourceproduct", + "productlink.sourceproduct" + ], + "title": "ProductLink.sourceProduct" + }, + { + "id": "script-api:dw/catalog/ProductLink#targetProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.targetProduct", + "tags": [ + "targetproduct", + "productlink.targetproduct" + ], + "title": "ProductLink.targetProduct" + }, + { + "id": "script-api:dw/catalog/ProductLink#typeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.typeCode", + "tags": [ + "typecode", + "productlink.typecode" + ], + "title": "ProductLink.typeCode" + }, + { + "id": "script-api:dw/catalog/ProductMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductMgr", + "tags": [ + "productmgr", + "dw.catalog.productmgr", + "dw/catalog" + ], + "title": "ProductMgr" + }, + { + "id": "script-api:dw/catalog/ProductMgr#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.getProduct", + "tags": [ + "getproduct", + "productmgr.getproduct" + ], + "title": "ProductMgr.getProduct" + }, + { + "id": "script-api:dw/catalog/ProductMgr#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.getProduct", + "tags": [ + "getproduct", + "productmgr.getproduct" + ], + "title": "ProductMgr.getProduct" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProducts", + "tags": [ + "queryallsiteproducts", + "productmgr.queryallsiteproducts" + ], + "title": "ProductMgr.queryAllSiteProducts" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProducts", + "tags": [ + "queryallsiteproducts", + "productmgr.queryallsiteproducts" + ], + "title": "ProductMgr.queryAllSiteProducts" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProductsSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProductsSorted", + "tags": [ + "queryallsiteproductssorted", + "productmgr.queryallsiteproductssorted" + ], + "title": "ProductMgr.queryAllSiteProductsSorted" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProductsSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProductsSorted", + "tags": [ + "queryallsiteproductssorted", + "productmgr.queryallsiteproductssorted" + ], + "title": "ProductMgr.queryAllSiteProductsSorted" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalog", + "tags": [ + "queryproductsincatalog", + "productmgr.queryproductsincatalog" + ], + "title": "ProductMgr.queryProductsInCatalog" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalog", + "tags": [ + "queryproductsincatalog", + "productmgr.queryproductsincatalog" + ], + "title": "ProductMgr.queryProductsInCatalog" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalogSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalogSorted", + "tags": [ + "queryproductsincatalogsorted", + "productmgr.queryproductsincatalogsorted" + ], + "title": "ProductMgr.queryProductsInCatalogSorted" + }, + { + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalogSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalogSorted", + "tags": [ + "queryproductsincatalogsorted", + "productmgr.queryproductsincatalogsorted" + ], + "title": "ProductMgr.queryProductsInCatalogSorted" + }, + { + "id": "script-api:dw/catalog/ProductOption", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOption", + "tags": [ + "productoption", + "dw.catalog.productoption", + "dw/catalog" + ], + "title": "ProductOption" + }, + { + "id": "script-api:dw/catalog/ProductOption#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.ID", + "tags": [ + "id", + "productoption.id" + ], + "title": "ProductOption.ID" + }, + { + "id": "script-api:dw/catalog/ProductOption#defaultValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.defaultValue", + "tags": [ + "defaultvalue", + "productoption.defaultvalue" + ], + "title": "ProductOption.defaultValue" + }, + { + "id": "script-api:dw/catalog/ProductOption#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.description", + "tags": [ + "description", + "productoption.description" + ], + "title": "ProductOption.description" + }, + { + "id": "script-api:dw/catalog/ProductOption#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.displayName", + "tags": [ + "displayname", + "productoption.displayname" + ], + "title": "ProductOption.displayName" + }, + { + "id": "script-api:dw/catalog/ProductOption#getDefaultValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDefaultValue", + "tags": [ + "getdefaultvalue", + "productoption.getdefaultvalue" + ], + "title": "ProductOption.getDefaultValue" + }, + { + "id": "script-api:dw/catalog/ProductOption#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDescription", + "tags": [ + "getdescription", + "productoption.getdescription" + ], + "title": "ProductOption.getDescription" + }, + { + "id": "script-api:dw/catalog/ProductOption#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDisplayName", + "tags": [ + "getdisplayname", + "productoption.getdisplayname" + ], + "title": "ProductOption.getDisplayName" + }, + { + "id": "script-api:dw/catalog/ProductOption#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getHtmlName", + "tags": [ + "gethtmlname", + "productoption.gethtmlname" + ], + "title": "ProductOption.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductOption#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getHtmlName", + "tags": [ + "gethtmlname", + "productoption.gethtmlname" + ], + "title": "ProductOption.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductOption#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getID", + "tags": [ + "getid", + "productoption.getid" + ], + "title": "ProductOption.getID" + }, + { + "id": "script-api:dw/catalog/ProductOption#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getImage", + "tags": [ + "getimage", + "productoption.getimage" + ], + "title": "ProductOption.getImage" + }, + { + "id": "script-api:dw/catalog/ProductOption#getOptionValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getOptionValues", + "tags": [ + "getoptionvalues", + "productoption.getoptionvalues" + ], + "title": "ProductOption.getOptionValues" + }, + { + "id": "script-api:dw/catalog/ProductOption#htmlName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.htmlName", + "tags": [ + "htmlname", + "productoption.htmlname" + ], + "title": "ProductOption.htmlName" + }, + { + "id": "script-api:dw/catalog/ProductOption#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.image", + "tags": [ + "image", + "productoption.image" + ], + "title": "ProductOption.image" + }, + { + "id": "script-api:dw/catalog/ProductOption#optionValues", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.optionValues", + "tags": [ + "optionvalues", + "productoption.optionvalues" + ], + "title": "ProductOption.optionValues" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOptionModel", + "tags": [ + "productoptionmodel", + "dw.catalog.productoptionmodel", + "dw/catalog" + ], + "title": "ProductOptionModel" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOption", + "tags": [ + "getoption", + "productoptionmodel.getoption" + ], + "title": "ProductOptionModel.getOption" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptionValue", + "tags": [ + "getoptionvalue", + "productoptionmodel.getoptionvalue" + ], + "title": "ProductOptionModel.getOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getOptionValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptionValues", + "tags": [ + "getoptionvalues", + "productoptionmodel.getoptionvalues" + ], + "title": "ProductOptionModel.getOptionValues" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptions", + "tags": [ + "getoptions", + "productoptionmodel.getoptions" + ], + "title": "ProductOptionModel.getOptions" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getPrice", + "tags": [ + "getprice", + "productoptionmodel.getprice" + ], + "title": "ProductOptionModel.getPrice" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#getSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getSelectedOptionValue", + "tags": [ + "getselectedoptionvalue", + "productoptionmodel.getselectedoptionvalue" + ], + "title": "ProductOptionModel.getSelectedOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#isSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.isSelectedOptionValue", + "tags": [ + "isselectedoptionvalue", + "productoptionmodel.isselectedoptionvalue" + ], + "title": "ProductOptionModel.isSelectedOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#options", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.options", + "tags": [ + "options", + "productoptionmodel.options" + ], + "title": "ProductOptionModel.options" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#setSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.setSelectedOptionValue", + "tags": [ + "setselectedoptionvalue", + "productoptionmodel.setselectedoptionvalue" + ], + "title": "ProductOptionModel.setSelectedOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.url", + "tags": [ + "url", + "productoptionmodel.url" + ], + "title": "ProductOptionModel.url" + }, + { + "id": "script-api:dw/catalog/ProductOptionModel#urlSelectOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.urlSelectOptionValue", + "tags": [ + "urlselectoptionvalue", + "productoptionmodel.urlselectoptionvalue" + ], + "title": "ProductOptionModel.urlSelectOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOptionValue", + "tags": [ + "productoptionvalue", + "dw.catalog.productoptionvalue", + "dw/catalog" + ], + "title": "ProductOptionValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.ID", + "tags": [ + "id", + "productoptionvalue.id" + ], + "title": "ProductOptionValue.ID" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.description", + "tags": [ + "description", + "productoptionvalue.description" + ], + "title": "ProductOptionValue.description" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.displayValue", + "tags": [ + "displayvalue", + "productoptionvalue.displayvalue" + ], + "title": "ProductOptionValue.displayValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getDescription", + "tags": [ + "getdescription", + "productoptionvalue.getdescription" + ], + "title": "ProductOptionValue.getDescription" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getDisplayValue", + "tags": [ + "getdisplayvalue", + "productoptionvalue.getdisplayvalue" + ], + "title": "ProductOptionValue.getDisplayValue" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getID", + "tags": [ + "getid", + "productoptionvalue.getid" + ], + "title": "ProductOptionValue.getID" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#getProductIDModifier", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getProductIDModifier", + "tags": [ + "getproductidmodifier", + "productoptionvalue.getproductidmodifier" + ], + "title": "ProductOptionValue.getProductIDModifier" + }, + { + "id": "script-api:dw/catalog/ProductOptionValue#productIDModifier", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.productIDModifier", + "tags": [ + "productidmodifier", + "productoptionvalue.productidmodifier" + ], + "title": "ProductOptionValue.productIDModifier" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceInfo", + "tags": [ + "productpriceinfo", + "dw.catalog.productpriceinfo", + "dw/catalog" + ], + "title": "ProductPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getOnlineFrom", + "tags": [ + "getonlinefrom", + "productpriceinfo.getonlinefrom" + ], + "title": "ProductPriceInfo.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getOnlineTo", + "tags": [ + "getonlineto", + "productpriceinfo.getonlineto" + ], + "title": "ProductPriceInfo.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getPercentage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPercentage", + "tags": [ + "getpercentage", + "productpriceinfo.getpercentage" + ], + "title": "ProductPriceInfo.getPercentage" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPrice", + "tags": [ + "getprice", + "productpriceinfo.getprice" + ], + "title": "ProductPriceInfo.getPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPriceBook", + "tags": [ + "getpricebook", + "productpriceinfo.getpricebook" + ], + "title": "ProductPriceInfo.getPriceBook" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPriceInfo", + "tags": [ + "getpriceinfo", + "productpriceinfo.getpriceinfo" + ], + "title": "ProductPriceInfo.getPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.onlineFrom", + "tags": [ + "onlinefrom", + "productpriceinfo.onlinefrom" + ], + "title": "ProductPriceInfo.onlineFrom" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.onlineTo", + "tags": [ + "onlineto", + "productpriceinfo.onlineto" + ], + "title": "ProductPriceInfo.onlineTo" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#percentage", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.percentage", + "tags": [ + "percentage", + "productpriceinfo.percentage" + ], + "title": "ProductPriceInfo.percentage" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#price", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.price", + "tags": [ + "price", + "productpriceinfo.price" + ], + "title": "ProductPriceInfo.price" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#priceBook", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.priceBook", + "tags": [ + "pricebook", + "productpriceinfo.pricebook" + ], + "title": "ProductPriceInfo.priceBook" + }, + { + "id": "script-api:dw/catalog/ProductPriceInfo#priceInfo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.priceInfo", + "tags": [ + "priceinfo", + "productpriceinfo.priceinfo" + ], + "title": "ProductPriceInfo.priceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceModel", + "tags": [ + "productpricemodel", + "dw.catalog.productpricemodel", + "dw/catalog" + ], + "title": "ProductPriceModel" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#basePriceQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.basePriceQuantity", + "tags": [ + "basepricequantity", + "productpricemodel.basepricequantity" + ], + "title": "ProductPriceModel.basePriceQuantity" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getBasePriceQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getBasePriceQuantity", + "tags": [ + "getbasepricequantity", + "productpricemodel.getbasepricequantity" + ], + "title": "ProductPriceModel.getBasePriceQuantity" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPrice", + "tags": [ + "getmaxprice", + "productpricemodel.getmaxprice" + ], + "title": "ProductPriceModel.getMaxPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPriceBookPrice", + "tags": [ + "getmaxpricebookprice", + "productpricemodel.getmaxpricebookprice" + ], + "title": "ProductPriceModel.getMaxPriceBookPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPriceBookPricePerUnit", + "tags": [ + "getmaxpricebookpriceperunit", + "productpricemodel.getmaxpricebookpriceperunit" + ], + "title": "ProductPriceModel.getMaxPriceBookPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPricePerUnit", + "tags": [ + "getmaxpriceperunit", + "productpricemodel.getmaxpriceperunit" + ], + "title": "ProductPriceModel.getMaxPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMinPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPrice", + "tags": [ + "getminprice", + "productpricemodel.getminprice" + ], + "title": "ProductPriceModel.getMinPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMinPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPriceBookPrice", + "tags": [ + "getminpricebookprice", + "productpricemodel.getminpricebookprice" + ], + "title": "ProductPriceModel.getMinPriceBookPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMinPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPriceBookPricePerUnit", + "tags": [ + "getminpricebookpriceperunit", + "productpricemodel.getminpricebookpriceperunit" + ], + "title": "ProductPriceModel.getMinPriceBookPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getMinPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPricePerUnit", + "tags": [ + "getminpriceperunit", + "productpricemodel.getminpriceperunit" + ], + "title": "ProductPriceModel.getMinPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPrice", + "tags": [ + "getprice", + "productpricemodel.getprice" + ], + "title": "ProductPriceModel.getPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPrice", + "tags": [ + "getprice", + "productpricemodel.getprice" + ], + "title": "ProductPriceModel.getPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPrice", + "tags": [ + "getpricebookprice", + "productpricemodel.getpricebookprice" + ], + "title": "ProductPriceModel.getPriceBookPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPrice", + "tags": [ + "getpricebookprice", + "productpricemodel.getpricebookprice" + ], + "title": "ProductPriceModel.getPriceBookPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPriceInfo", + "tags": [ + "getpricebookpriceinfo", + "productpricemodel.getpricebookpriceinfo" + ], + "title": "ProductPriceModel.getPriceBookPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPriceInfo", + "tags": [ + "getpricebookpriceinfo", + "productpricemodel.getpricebookpriceinfo" + ], + "title": "ProductPriceModel.getPriceBookPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPricePerUnit", + "tags": [ + "getpricebookpriceperunit", + "productpricemodel.getpricebookpriceperunit" + ], + "title": "ProductPriceModel.getPriceBookPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPricePerUnit", + "tags": [ + "getpricebookpriceperunit", + "productpricemodel.getpricebookpriceperunit" + ], + "title": "ProductPriceModel.getPriceBookPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfo", + "tags": [ + "getpriceinfo", + "productpricemodel.getpriceinfo" + ], + "title": "ProductPriceModel.getPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfo", + "tags": [ + "getpriceinfo", + "productpricemodel.getpriceinfo" + ], + "title": "ProductPriceModel.getPriceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfos", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfos", + "tags": [ + "getpriceinfos", + "productpricemodel.getpriceinfos" + ], + "title": "ProductPriceModel.getPriceInfos" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePerUnit", + "tags": [ + "getpriceperunit", + "productpricemodel.getpriceperunit" + ], + "title": "ProductPriceModel.getPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePerUnit", + "tags": [ + "getpriceperunit", + "productpricemodel.getpriceperunit" + ], + "title": "ProductPriceModel.getPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPricePercentage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePercentage", + "tags": [ + "getpricepercentage", + "productpricemodel.getpricepercentage" + ], + "title": "ProductPriceModel.getPricePercentage" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#getPriceTable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceTable", + "tags": [ + "getpricetable", + "productpricemodel.getpricetable" + ], + "title": "ProductPriceModel.getPriceTable" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.isPriceRange", + "tags": [ + "ispricerange", + "productpricemodel.ispricerange" + ], + "title": "ProductPriceModel.isPriceRange" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.isPriceRange", + "tags": [ + "ispricerange", + "productpricemodel.ispricerange" + ], + "title": "ProductPriceModel.isPriceRange" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#maxPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.maxPrice", + "tags": [ + "maxprice", + "productpricemodel.maxprice" + ], + "title": "ProductPriceModel.maxPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#maxPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.maxPricePerUnit", + "tags": [ + "maxpriceperunit", + "productpricemodel.maxpriceperunit" + ], + "title": "ProductPriceModel.maxPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#minPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.minPrice", + "tags": [ + "minprice", + "productpricemodel.minprice" + ], + "title": "ProductPriceModel.minPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#minPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.minPricePerUnit", + "tags": [ + "minpriceperunit", + "productpricemodel.minpriceperunit" + ], + "title": "ProductPriceModel.minPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#price", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.price", + "tags": [ + "price", + "productpricemodel.price" + ], + "title": "ProductPriceModel.price" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#priceInfo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceInfo", + "tags": [ + "priceinfo", + "productpricemodel.priceinfo" + ], + "title": "ProductPriceModel.priceInfo" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#priceInfos", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceInfos", + "tags": [ + "priceinfos", + "productpricemodel.priceinfos" + ], + "title": "ProductPriceModel.priceInfos" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#pricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.pricePerUnit", + "tags": [ + "priceperunit", + "productpricemodel.priceperunit" + ], + "title": "ProductPriceModel.pricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#priceRange", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceRange", + "tags": [ + "pricerange", + "productpricemodel.pricerange" + ], + "title": "ProductPriceModel.priceRange" + }, + { + "id": "script-api:dw/catalog/ProductPriceModel#priceTable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceTable", + "tags": [ + "pricetable", + "productpricemodel.pricetable" + ], + "title": "ProductPriceModel.priceTable" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceTable", + "tags": [ + "productpricetable", + "dw.catalog.productpricetable", + "dw/catalog" + ], + "title": "ProductPriceTable" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#getNextQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getNextQuantity", + "tags": [ + "getnextquantity", + "productpricetable.getnextquantity" + ], + "title": "ProductPriceTable.getNextQuantity" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#getPercentage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPercentage", + "tags": [ + "getpercentage", + "productpricetable.getpercentage" + ], + "title": "ProductPriceTable.getPercentage" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPrice", + "tags": [ + "getprice", + "productpricetable.getprice" + ], + "title": "ProductPriceTable.getPrice" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPriceBook", + "tags": [ + "getpricebook", + "productpricetable.getpricebook" + ], + "title": "ProductPriceTable.getPriceBook" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#getQuantities", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getQuantities", + "tags": [ + "getquantities", + "productpricetable.getquantities" + ], + "title": "ProductPriceTable.getQuantities" + }, + { + "id": "script-api:dw/catalog/ProductPriceTable#quantities", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.quantities", + "tags": [ + "quantities", + "productpricetable.quantities" + ], + "title": "ProductPriceTable.quantities" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchHit", + "tags": [ + "productsearchhit", + "dw.catalog.productsearchhit", + "dw/catalog" + ], + "title": "ProductSearchHit" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_BUNDLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE", + "tags": [ + "hit_type_product_bundle", + "productsearchhit.hit_type_product_bundle" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_BUNDLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE", + "tags": [ + "hit_type_product_bundle", + "productsearchhit.hit_type_product_bundle" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_MASTER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER", + "tags": [ + "hit_type_product_master", + "productsearchhit.hit_type_product_master" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_MASTER" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_MASTER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER", + "tags": [ + "hit_type_product_master", + "productsearchhit.hit_type_product_master" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_MASTER" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_SET", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET", + "tags": [ + "hit_type_product_set", + "productsearchhit.hit_type_product_set" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_SET" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_SET", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET", + "tags": [ + "hit_type_product_set", + "productsearchhit.hit_type_product_set" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_SET" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SIMPLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE", + "tags": [ + "hit_type_simple", + "productsearchhit.hit_type_simple" + ], + "title": "ProductSearchHit.HIT_TYPE_SIMPLE" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SIMPLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE", + "tags": [ + "hit_type_simple", + "productsearchhit.hit_type_simple" + ], + "title": "ProductSearchHit.HIT_TYPE_SIMPLE" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SLICING_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP", + "tags": [ + "hit_type_slicing_group", + "productsearchhit.hit_type_slicing_group" + ], + "title": "ProductSearchHit.HIT_TYPE_SLICING_GROUP" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SLICING_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP", + "tags": [ + "hit_type_slicing_group", + "productsearchhit.hit_type_slicing_group" + ], + "title": "ProductSearchHit.HIT_TYPE_SLICING_GROUP" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_VARIATION_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "tags": [ + "hit_type_variation_group", + "productsearchhit.hit_type_variation_group" + ], + "title": "ProductSearchHit.HIT_TYPE_VARIATION_GROUP" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_VARIATION_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "tags": [ + "hit_type_variation_group", + "productsearchhit.hit_type_variation_group" + ], + "title": "ProductSearchHit.HIT_TYPE_VARIATION_GROUP" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#firstRepresentedProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.firstRepresentedProduct", + "tags": [ + "firstrepresentedproduct", + "productsearchhit.firstrepresentedproduct" + ], + "title": "ProductSearchHit.firstRepresentedProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#firstRepresentedProductID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.firstRepresentedProductID", + "tags": [ + "firstrepresentedproductid", + "productsearchhit.firstrepresentedproductid" + ], + "title": "ProductSearchHit.firstRepresentedProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getFirstRepresentedProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getFirstRepresentedProduct", + "tags": [ + "getfirstrepresentedproduct", + "productsearchhit.getfirstrepresentedproduct" + ], + "title": "ProductSearchHit.getFirstRepresentedProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getFirstRepresentedProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getFirstRepresentedProductID", + "tags": [ + "getfirstrepresentedproductid", + "productsearchhit.getfirstrepresentedproductid" + ], + "title": "ProductSearchHit.getFirstRepresentedProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getHitType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getHitType", + "tags": [ + "gethittype", + "productsearchhit.gethittype" + ], + "title": "ProductSearchHit.getHitType" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getLastRepresentedProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getLastRepresentedProduct", + "tags": [ + "getlastrepresentedproduct", + "productsearchhit.getlastrepresentedproduct" + ], + "title": "ProductSearchHit.getLastRepresentedProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getLastRepresentedProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getLastRepresentedProductID", + "tags": [ + "getlastrepresentedproductid", + "productsearchhit.getlastrepresentedproductid" + ], + "title": "ProductSearchHit.getLastRepresentedProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getMaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMaxPrice", + "tags": [ + "getmaxprice", + "productsearchhit.getmaxprice" + ], + "title": "ProductSearchHit.getMaxPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getMaxPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMaxPricePerUnit", + "tags": [ + "getmaxpriceperunit", + "productsearchhit.getmaxpriceperunit" + ], + "title": "ProductSearchHit.getMaxPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getMinPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMinPrice", + "tags": [ + "getminprice", + "productsearchhit.getminprice" + ], + "title": "ProductSearchHit.getMinPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getMinPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMinPricePerUnit", + "tags": [ + "getminpriceperunit", + "productsearchhit.getminpriceperunit" + ], + "title": "ProductSearchHit.getMinPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getProduct", + "tags": [ + "getproduct", + "productsearchhit.getproduct" + ], + "title": "ProductSearchHit.getProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getProductID", + "tags": [ + "getproductid", + "productsearchhit.getproductid" + ], + "title": "ProductSearchHit.getProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedProductIDs", + "tags": [ + "getrepresentedproductids", + "productsearchhit.getrepresentedproductids" + ], + "title": "ProductSearchHit.getRepresentedProductIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedProducts", + "tags": [ + "getrepresentedproducts", + "productsearchhit.getrepresentedproducts" + ], + "title": "ProductSearchHit.getRepresentedProducts" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedVariationValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedVariationValues", + "tags": [ + "getrepresentedvariationvalues", + "productsearchhit.getrepresentedvariationvalues" + ], + "title": "ProductSearchHit.getRepresentedVariationValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#hitType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.hitType", + "tags": [ + "hittype", + "productsearchhit.hittype" + ], + "title": "ProductSearchHit.hitType" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.isPriceRange", + "tags": [ + "ispricerange", + "productsearchhit.ispricerange" + ], + "title": "ProductSearchHit.isPriceRange" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#lastRepresentedProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.lastRepresentedProduct", + "tags": [ + "lastrepresentedproduct", + "productsearchhit.lastrepresentedproduct" + ], + "title": "ProductSearchHit.lastRepresentedProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#lastRepresentedProductID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.lastRepresentedProductID", + "tags": [ + "lastrepresentedproductid", + "productsearchhit.lastrepresentedproductid" + ], + "title": "ProductSearchHit.lastRepresentedProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#maxPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.maxPrice", + "tags": [ + "maxprice", + "productsearchhit.maxprice" + ], + "title": "ProductSearchHit.maxPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#maxPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.maxPricePerUnit", + "tags": [ + "maxpriceperunit", + "productsearchhit.maxpriceperunit" + ], + "title": "ProductSearchHit.maxPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#minPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.minPrice", + "tags": [ + "minprice", + "productsearchhit.minprice" + ], + "title": "ProductSearchHit.minPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#minPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.minPricePerUnit", + "tags": [ + "minpriceperunit", + "productsearchhit.minpriceperunit" + ], + "title": "ProductSearchHit.minPricePerUnit" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#priceRange", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.priceRange", + "tags": [ + "pricerange", + "productsearchhit.pricerange" + ], + "title": "ProductSearchHit.priceRange" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.product", + "tags": [ + "product", + "productsearchhit.product" + ], + "title": "ProductSearchHit.product" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#productID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.productID", + "tags": [ + "productid", + "productsearchhit.productid" + ], + "title": "ProductSearchHit.productID" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#representedProductIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.representedProductIDs", + "tags": [ + "representedproductids", + "productsearchhit.representedproductids" + ], + "title": "ProductSearchHit.representedProductIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchHit#representedProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.representedProducts", + "tags": [ + "representedproducts", + "productsearchhit.representedproducts" + ], + "title": "ProductSearchHit.representedProducts" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchModel", + "tags": [ + "productsearchmodel", + "dw.catalog.productsearchmodel", + "dw/catalog" + ], + "title": "ProductSearchModel" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#CATEGORYID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.CATEGORYID_PARAMETER", + "tags": [ + "categoryid_parameter", + "productsearchmodel.categoryid_parameter" + ], + "title": "ProductSearchModel.CATEGORYID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#CATEGORYID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.CATEGORYID_PARAMETER", + "tags": [ + "categoryid_parameter", + "productsearchmodel.categoryid_parameter" + ], + "title": "ProductSearchModel.CATEGORYID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#INVENTORY_LIST_IDS_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER", + "tags": [ + "inventory_list_ids_parameter", + "productsearchmodel.inventory_list_ids_parameter" + ], + "title": "ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#INVENTORY_LIST_IDS_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER", + "tags": [ + "inventory_list_ids_parameter", + "productsearchmodel.inventory_list_ids_parameter" + ], + "title": "ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_INVENTORY_LIST_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS", + "tags": [ + "maximum_inventory_list_ids", + "productsearchmodel.maximum_inventory_list_ids" + ], + "title": "ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_INVENTORY_LIST_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS", + "tags": [ + "maximum_inventory_list_ids", + "productsearchmodel.maximum_inventory_list_ids" + ], + "title": "ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_PRODUCT_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_PRODUCT_IDS", + "tags": [ + "maximum_product_ids", + "productsearchmodel.maximum_product_ids" + ], + "title": "ProductSearchModel.MAXIMUM_PRODUCT_IDS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_PRODUCT_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_PRODUCT_IDS", + "tags": [ + "maximum_product_ids", + "productsearchmodel.maximum_product_ids" + ], + "title": "ProductSearchModel.MAXIMUM_PRODUCT_IDS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "tags": [ + "maximum_store_inventory_filter_values", + "productsearchmodel.maximum_store_inventory_filter_values" + ], + "title": "ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "tags": [ + "maximum_store_inventory_filter_values", + "productsearchmodel.maximum_store_inventory_filter_values" + ], + "title": "ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MAX_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MAX_PARAMETER", + "tags": [ + "price_max_parameter", + "productsearchmodel.price_max_parameter" + ], + "title": "ProductSearchModel.PRICE_MAX_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MAX_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MAX_PARAMETER", + "tags": [ + "price_max_parameter", + "productsearchmodel.price_max_parameter" + ], + "title": "ProductSearchModel.PRICE_MAX_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MIN_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MIN_PARAMETER", + "tags": [ + "price_min_parameter", + "productsearchmodel.price_min_parameter" + ], + "title": "ProductSearchModel.PRICE_MIN_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MIN_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MIN_PARAMETER", + "tags": [ + "price_min_parameter", + "productsearchmodel.price_min_parameter" + ], + "title": "ProductSearchModel.PRICE_MIN_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRODUCTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRODUCTID_PARAMETER", + "tags": [ + "productid_parameter", + "productsearchmodel.productid_parameter" + ], + "title": "ProductSearchModel.PRODUCTID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PRODUCTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRODUCTID_PARAMETER", + "tags": [ + "productid_parameter", + "productsearchmodel.productid_parameter" + ], + "title": "ProductSearchModel.PRODUCTID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTIONID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTIONID_PARAMETER", + "tags": [ + "promotionid_parameter", + "productsearchmodel.promotionid_parameter" + ], + "title": "ProductSearchModel.PROMOTIONID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTIONID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTIONID_PARAMETER", + "tags": [ + "promotionid_parameter", + "productsearchmodel.promotionid_parameter" + ], + "title": "ProductSearchModel.PROMOTIONID_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_ALL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL", + "tags": [ + "promotion_product_type_all", + "productsearchmodel.promotion_product_type_all" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_ALL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL", + "tags": [ + "promotion_product_type_all", + "productsearchmodel.promotion_product_type_all" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_BONUS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS", + "tags": [ + "promotion_product_type_bonus", + "productsearchmodel.promotion_product_type_bonus" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_BONUS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS", + "tags": [ + "promotion_product_type_bonus", + "productsearchmodel.promotion_product_type_bonus" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "tags": [ + "promotion_product_type_discounted", + "productsearchmodel.promotion_product_type_discounted" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "tags": [ + "promotion_product_type_discounted", + "productsearchmodel.promotion_product_type_discounted" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER", + "tags": [ + "promotion_product_type_parameter", + "productsearchmodel.promotion_product_type_parameter" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER", + "tags": [ + "promotion_product_type_parameter", + "productsearchmodel.promotion_product_type_parameter" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_QUALIFYING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING", + "tags": [ + "promotion_product_type_qualifying", + "productsearchmodel.promotion_product_type_qualifying" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_QUALIFYING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING", + "tags": [ + "promotion_product_type_qualifying", + "productsearchmodel.promotion_product_type_qualifying" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_NAME_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX", + "tags": [ + "refine_name_parameter_prefix", + "productsearchmodel.refine_name_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_NAME_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX", + "tags": [ + "refine_name_parameter_prefix", + "productsearchmodel.refine_name_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_VALUE_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX", + "tags": [ + "refine_value_parameter_prefix", + "productsearchmodel.refine_value_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_VALUE_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX", + "tags": [ + "refine_value_parameter_prefix", + "productsearchmodel.refine_value_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_OPTION_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_OPTION_PARAMETER", + "tags": [ + "sorting_option_parameter", + "productsearchmodel.sorting_option_parameter" + ], + "title": "ProductSearchModel.SORTING_OPTION_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_OPTION_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_OPTION_PARAMETER", + "tags": [ + "sorting_option_parameter", + "productsearchmodel.sorting_option_parameter" + ], + "title": "ProductSearchModel.SORTING_OPTION_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_RULE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_RULE_PARAMETER", + "tags": [ + "sorting_rule_parameter", + "productsearchmodel.sorting_rule_parameter" + ], + "title": "ProductSearchModel.SORTING_RULE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_RULE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_RULE_PARAMETER", + "tags": [ + "sorting_rule_parameter", + "productsearchmodel.sorting_rule_parameter" + ], + "title": "ProductSearchModel.SORTING_RULE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORT_BY_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_BY_PARAMETER_PREFIX", + "tags": [ + "sort_by_parameter_prefix", + "productsearchmodel.sort_by_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_BY_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORT_BY_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_BY_PARAMETER_PREFIX", + "tags": [ + "sort_by_parameter_prefix", + "productsearchmodel.sort_by_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_BY_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORT_DIRECTION_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX", + "tags": [ + "sort_direction_parameter_prefix", + "productsearchmodel.sort_direction_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#SORT_DIRECTION_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX", + "tags": [ + "sort_direction_parameter_prefix", + "productsearchmodel.sort_direction_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#addHitTypeRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.addHitTypeRefinement", + "tags": [ + "addhittyperefinement", + "productsearchmodel.addhittyperefinement" + ], + "title": "ProductSearchModel.addHitTypeRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#category", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.category", + "tags": [ + "category", + "productsearchmodel.category" + ], + "title": "ProductSearchModel.category" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#categoryID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.categoryID", + "tags": [ + "categoryid", + "productsearchmodel.categoryid" + ], + "title": "ProductSearchModel.categoryID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#categorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.categorySearch", + "tags": [ + "categorysearch", + "productsearchmodel.categorysearch" + ], + "title": "ProductSearchModel.categorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#deepestCommonCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.deepestCommonCategory", + "tags": [ + "deepestcommoncategory", + "productsearchmodel.deepestcommoncategory" + ], + "title": "ProductSearchModel.deepestCommonCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#effectiveSortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.effectiveSortingRule", + "tags": [ + "effectivesortingrule", + "productsearchmodel.effectivesortingrule" + ], + "title": "ProductSearchModel.effectiveSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#excludeHitType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.excludeHitType", + "tags": [ + "excludehittype", + "productsearchmodel.excludehittype" + ], + "title": "ProductSearchModel.excludeHitType" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getCategory", + "tags": [ + "getcategory", + "productsearchmodel.getcategory" + ], + "title": "ProductSearchModel.getCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getCategoryID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getCategoryID", + "tags": [ + "getcategoryid", + "productsearchmodel.getcategoryid" + ], + "title": "ProductSearchModel.getCategoryID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getDeepestCommonCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getDeepestCommonCategory", + "tags": [ + "getdeepestcommoncategory", + "productsearchmodel.getdeepestcommoncategory" + ], + "title": "ProductSearchModel.getDeepestCommonCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getEffectiveSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getEffectiveSortingRule", + "tags": [ + "geteffectivesortingrule", + "productsearchmodel.geteffectivesortingrule" + ], + "title": "ProductSearchModel.getEffectiveSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getInventoryIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getInventoryIDs", + "tags": [ + "getinventoryids", + "productsearchmodel.getinventoryids" + ], + "title": "ProductSearchModel.getInventoryIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getOrderableProductsOnly", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getOrderableProductsOnly", + "tags": [ + "getorderableproductsonly", + "productsearchmodel.getorderableproductsonly" + ], + "title": "ProductSearchModel.getOrderableProductsOnly" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPageMetaTag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPageMetaTag", + "tags": [ + "getpagemetatag", + "productsearchmodel.getpagemetatag" + ], + "title": "ProductSearchModel.getPageMetaTag" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPageMetaTags", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPageMetaTags", + "tags": [ + "getpagemetatags", + "productsearchmodel.getpagemetatags" + ], + "title": "ProductSearchModel.getPageMetaTags" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPriceMax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPriceMax", + "tags": [ + "getpricemax", + "productsearchmodel.getpricemax" + ], + "title": "ProductSearchModel.getPriceMax" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPriceMin", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPriceMin", + "tags": [ + "getpricemin", + "productsearchmodel.getpricemin" + ], + "title": "ProductSearchModel.getPriceMin" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductID", + "tags": [ + "getproductid", + "productsearchmodel.getproductid" + ], + "title": "ProductSearchModel.getProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductIDs", + "tags": [ + "getproductids", + "productsearchmodel.getproductids" + ], + "title": "ProductSearchModel.getProductIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getProductSearchHit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductSearchHit", + "tags": [ + "getproductsearchhit", + "productsearchmodel.getproductsearchhit" + ], + "title": "ProductSearchModel.getProductSearchHit" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getProductSearchHits", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductSearchHits", + "tags": [ + "getproductsearchhits", + "productsearchmodel.getproductsearchhits" + ], + "title": "ProductSearchModel.getProductSearchHits" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProducts", + "tags": [ + "getproducts", + "productsearchmodel.getproducts" + ], + "title": "ProductSearchModel.getProducts" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionID", + "tags": [ + "getpromotionid", + "productsearchmodel.getpromotionid" + ], + "title": "ProductSearchModel.getPromotionID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionIDs", + "tags": [ + "getpromotionids", + "productsearchmodel.getpromotionids" + ], + "title": "ProductSearchModel.getPromotionIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionProductType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionProductType", + "tags": [ + "getpromotionproducttype", + "productsearchmodel.getpromotionproducttype" + ], + "title": "ProductSearchModel.getPromotionProductType" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getRefinementCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getRefinementCategory", + "tags": [ + "getrefinementcategory", + "productsearchmodel.getrefinementcategory" + ], + "title": "ProductSearchModel.getRefinementCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getRefinements", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getRefinements", + "tags": [ + "getrefinements", + "productsearchmodel.getrefinements" + ], + "title": "ProductSearchModel.getRefinements" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getSearchPhraseSuggestions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSearchPhraseSuggestions", + "tags": [ + "getsearchphrasesuggestions", + "productsearchmodel.getsearchphrasesuggestions" + ], + "title": "ProductSearchModel.getSearchPhraseSuggestions" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getSearchableImageUploadURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSearchableImageUploadURL", + "tags": [ + "getsearchableimageuploadurl", + "productsearchmodel.getsearchableimageuploadurl" + ], + "title": "ProductSearchModel.getSearchableImageUploadURL" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSortingRule", + "tags": [ + "getsortingrule", + "productsearchmodel.getsortingrule" + ], + "title": "ProductSearchModel.getSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getStoreInventoryFilter", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getStoreInventoryFilter", + "tags": [ + "getstoreinventoryfilter", + "productsearchmodel.getstoreinventoryfilter" + ], + "title": "ProductSearchModel.getStoreInventoryFilter" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getSuggestedSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSuggestedSearchPhrase", + "tags": [ + "getsuggestedsearchphrase", + "productsearchmodel.getsuggestedsearchphrase" + ], + "title": "ProductSearchModel.getSuggestedSearchPhrase" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#getSuggestedSearchPhrases", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSuggestedSearchPhrases", + "tags": [ + "getsuggestedsearchphrases", + "productsearchmodel.getsuggestedsearchphrases" + ], + "title": "ProductSearchModel.getSuggestedSearchPhrases" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#inventoryIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.inventoryIDs", + "tags": [ + "inventoryids", + "productsearchmodel.inventoryids" + ], + "title": "ProductSearchModel.inventoryIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isCategorySearch", + "tags": [ + "iscategorysearch", + "productsearchmodel.iscategorysearch" + ], + "title": "ProductSearchModel.isCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isPersonalizedSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isPersonalizedSort", + "tags": [ + "ispersonalizedsort", + "productsearchmodel.ispersonalizedsort" + ], + "title": "ProductSearchModel.isPersonalizedSort" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRecursiveCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRecursiveCategorySearch", + "tags": [ + "isrecursivecategorysearch", + "productsearchmodel.isrecursivecategorysearch" + ], + "title": "ProductSearchModel.isRecursiveCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByCategory", + "tags": [ + "isrefinedbycategory", + "productsearchmodel.isrefinedbycategory" + ], + "title": "ProductSearchModel.isRefinedByCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPrice", + "tags": [ + "isrefinedbyprice", + "productsearchmodel.isrefinedbyprice" + ], + "title": "ProductSearchModel.isRefinedByPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPriceRange", + "tags": [ + "isrefinedbypricerange", + "productsearchmodel.isrefinedbypricerange" + ], + "title": "ProductSearchModel.isRefinedByPriceRange" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPromotion", + "tags": [ + "isrefinedbypromotion", + "productsearchmodel.isrefinedbypromotion" + ], + "title": "ProductSearchModel.isRefinedByPromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPromotion", + "tags": [ + "isrefinedbypromotion", + "productsearchmodel.isrefinedbypromotion" + ], + "title": "ProductSearchModel.isRefinedByPromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedCategorySearch", + "tags": [ + "isrefinedcategorysearch", + "productsearchmodel.isrefinedcategorysearch" + ], + "title": "ProductSearchModel.isRefinedCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isTrackingEmptySearchesEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isTrackingEmptySearchesEnabled", + "tags": [ + "istrackingemptysearchesenabled", + "productsearchmodel.istrackingemptysearchesenabled" + ], + "title": "ProductSearchModel.isTrackingEmptySearchesEnabled" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#isVisualSearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isVisualSearch", + "tags": [ + "isvisualsearch", + "productsearchmodel.isvisualsearch" + ], + "title": "ProductSearchModel.isVisualSearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#orderableProductsOnly", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.orderableProductsOnly", + "tags": [ + "orderableproductsonly", + "productsearchmodel.orderableproductsonly" + ], + "title": "ProductSearchModel.orderableProductsOnly" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#pageMetaTags", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.pageMetaTags", + "tags": [ + "pagemetatags", + "productsearchmodel.pagemetatags" + ], + "title": "ProductSearchModel.pageMetaTags" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#personalizedSort", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.personalizedSort", + "tags": [ + "personalizedsort", + "productsearchmodel.personalizedsort" + ], + "title": "ProductSearchModel.personalizedSort" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#priceMax", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.priceMax", + "tags": [ + "pricemax", + "productsearchmodel.pricemax" + ], + "title": "ProductSearchModel.priceMax" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#priceMin", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.priceMin", + "tags": [ + "pricemin", + "productsearchmodel.pricemin" + ], + "title": "ProductSearchModel.priceMin" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#productID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productID", + "tags": [ + "productid", + "productsearchmodel.productid" + ], + "title": "ProductSearchModel.productID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#productIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productIDs", + "tags": [ + "productids", + "productsearchmodel.productids" + ], + "title": "ProductSearchModel.productIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#productSearchHits", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productSearchHits", + "tags": [ + "productsearchhits", + "productsearchmodel.productsearchhits" + ], + "title": "ProductSearchModel.productSearchHits" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#products", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.products", + "tags": [ + "products", + "productsearchmodel.products" + ], + "title": "ProductSearchModel.products" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#promotionID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionID", + "tags": [ + "promotionid", + "productsearchmodel.promotionid" + ], + "title": "ProductSearchModel.promotionID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#promotionIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionIDs", + "tags": [ + "promotionids", + "productsearchmodel.promotionids" + ], + "title": "ProductSearchModel.promotionIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#promotionProductType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionProductType", + "tags": [ + "promotionproducttype", + "productsearchmodel.promotionproducttype" + ], + "title": "ProductSearchModel.promotionProductType" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#recursiveCategorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.recursiveCategorySearch", + "tags": [ + "recursivecategorysearch", + "productsearchmodel.recursivecategorysearch" + ], + "title": "ProductSearchModel.recursiveCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinedByCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByCategory", + "tags": [ + "refinedbycategory", + "productsearchmodel.refinedbycategory" + ], + "title": "ProductSearchModel.refinedByCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinedByPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByPrice", + "tags": [ + "refinedbyprice", + "productsearchmodel.refinedbyprice" + ], + "title": "ProductSearchModel.refinedByPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinedByPromotion", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByPromotion", + "tags": [ + "refinedbypromotion", + "productsearchmodel.refinedbypromotion" + ], + "title": "ProductSearchModel.refinedByPromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinedCategorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedCategorySearch", + "tags": [ + "refinedcategorysearch", + "productsearchmodel.refinedcategorysearch" + ], + "title": "ProductSearchModel.refinedCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinementCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinementCategory", + "tags": [ + "refinementcategory", + "productsearchmodel.refinementcategory" + ], + "title": "ProductSearchModel.refinementCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#refinements", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinements", + "tags": [ + "refinements", + "productsearchmodel.refinements" + ], + "title": "ProductSearchModel.refinements" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#search", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.search", + "tags": [ + "search", + "productsearchmodel.search" + ], + "title": "ProductSearchModel.search" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#searchPhraseSuggestions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.searchPhraseSuggestions", + "tags": [ + "searchphrasesuggestions", + "productsearchmodel.searchphrasesuggestions" + ], + "title": "ProductSearchModel.searchPhraseSuggestions" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#searchableImageUploadURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.searchableImageUploadURL", + "tags": [ + "searchableimageuploadurl", + "productsearchmodel.searchableimageuploadurl" + ], + "title": "ProductSearchModel.searchableImageUploadURL" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setCategoryID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setCategoryID", + "tags": [ + "setcategoryid", + "productsearchmodel.setcategoryid" + ], + "title": "ProductSearchModel.setCategoryID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setEnableTrackingEmptySearches", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setEnableTrackingEmptySearches", + "tags": [ + "setenabletrackingemptysearches", + "productsearchmodel.setenabletrackingemptysearches" + ], + "title": "ProductSearchModel.setEnableTrackingEmptySearches" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setInventoryListIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setInventoryListIDs", + "tags": [ + "setinventorylistids", + "productsearchmodel.setinventorylistids" + ], + "title": "ProductSearchModel.setInventoryListIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setOrderableProductsOnly", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setOrderableProductsOnly", + "tags": [ + "setorderableproductsonly", + "productsearchmodel.setorderableproductsonly" + ], + "title": "ProductSearchModel.setOrderableProductsOnly" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setPriceMax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPriceMax", + "tags": [ + "setpricemax", + "productsearchmodel.setpricemax" + ], + "title": "ProductSearchModel.setPriceMax" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setPriceMin", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPriceMin", + "tags": [ + "setpricemin", + "productsearchmodel.setpricemin" + ], + "title": "ProductSearchModel.setPriceMin" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setProductID", + "tags": [ + "setproductid", + "productsearchmodel.setproductid" + ], + "title": "ProductSearchModel.setProductID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setProductIDs", + "tags": [ + "setproductids", + "productsearchmodel.setproductids" + ], + "title": "ProductSearchModel.setProductIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionID", + "tags": [ + "setpromotionid", + "productsearchmodel.setpromotionid" + ], + "title": "ProductSearchModel.setPromotionID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionIDs", + "tags": [ + "setpromotionids", + "productsearchmodel.setpromotionids" + ], + "title": "ProductSearchModel.setPromotionIDs" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionProductType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionProductType", + "tags": [ + "setpromotionproducttype", + "productsearchmodel.setpromotionproducttype" + ], + "title": "ProductSearchModel.setPromotionProductType" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setRecursiveCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setRecursiveCategorySearch", + "tags": [ + "setrecursivecategorysearch", + "productsearchmodel.setrecursivecategorysearch" + ], + "title": "ProductSearchModel.setRecursiveCategorySearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setRefinementCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setRefinementCategory", + "tags": [ + "setrefinementcategory", + "productsearchmodel.setrefinementcategory" + ], + "title": "ProductSearchModel.setRefinementCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setSearchableImageID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSearchableImageID", + "tags": [ + "setsearchableimageid", + "productsearchmodel.setsearchableimageid" + ], + "title": "ProductSearchModel.setSearchableImageID" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingCondition", + "tags": [ + "setsortingcondition", + "productsearchmodel.setsortingcondition" + ], + "title": "ProductSearchModel.setSortingCondition" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingOption", + "tags": [ + "setsortingoption", + "productsearchmodel.setsortingoption" + ], + "title": "ProductSearchModel.setSortingOption" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingRule", + "tags": [ + "setsortingrule", + "productsearchmodel.setsortingrule" + ], + "title": "ProductSearchModel.setSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#setStoreInventoryFilter", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setStoreInventoryFilter", + "tags": [ + "setstoreinventoryfilter", + "productsearchmodel.setstoreinventoryfilter" + ], + "title": "ProductSearchModel.setStoreInventoryFilter" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#sortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.sortingRule", + "tags": [ + "sortingrule", + "productsearchmodel.sortingrule" + ], + "title": "ProductSearchModel.sortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#storeInventoryFilter", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.storeInventoryFilter", + "tags": [ + "storeinventoryfilter", + "productsearchmodel.storeinventoryfilter" + ], + "title": "ProductSearchModel.storeInventoryFilter" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#suggestedSearchPhrase", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.suggestedSearchPhrase", + "tags": [ + "suggestedsearchphrase", + "productsearchmodel.suggestedsearchphrase" + ], + "title": "ProductSearchModel.suggestedSearchPhrase" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#suggestedSearchPhrases", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.suggestedSearchPhrases", + "tags": [ + "suggestedsearchphrases", + "productsearchmodel.suggestedsearchphrases" + ], + "title": "ProductSearchModel.suggestedSearchPhrases" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#trackingEmptySearchesEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.trackingEmptySearchesEnabled", + "tags": [ + "trackingemptysearchesenabled", + "productsearchmodel.trackingemptysearchesenabled" + ], + "title": "ProductSearchModel.trackingEmptySearchesEnabled" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefineCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefineCategory", + "tags": [ + "urlrefinecategory", + "productsearchmodel.urlrefinecategory" + ], + "title": "ProductSearchModel.urlRefineCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefineCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefineCategory", + "tags": [ + "urlrefinecategory", + "productsearchmodel.urlrefinecategory" + ], + "title": "ProductSearchModel.urlRefineCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePrice", + "tags": [ + "urlrefineprice", + "productsearchmodel.urlrefineprice" + ], + "title": "ProductSearchModel.urlRefinePrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePrice", + "tags": [ + "urlrefineprice", + "productsearchmodel.urlrefineprice" + ], + "title": "ProductSearchModel.urlRefinePrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePromotion", + "tags": [ + "urlrefinepromotion", + "productsearchmodel.urlrefinepromotion" + ], + "title": "ProductSearchModel.urlRefinePromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePromotion", + "tags": [ + "urlrefinepromotion", + "productsearchmodel.urlrefinepromotion" + ], + "title": "ProductSearchModel.urlRefinePromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxCategory", + "tags": [ + "urlrelaxcategory", + "productsearchmodel.urlrelaxcategory" + ], + "title": "ProductSearchModel.urlRelaxCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxCategory", + "tags": [ + "urlrelaxcategory", + "productsearchmodel.urlrelaxcategory" + ], + "title": "ProductSearchModel.urlRelaxCategory" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPrice", + "tags": [ + "urlrelaxprice", + "productsearchmodel.urlrelaxprice" + ], + "title": "ProductSearchModel.urlRelaxPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPrice", + "tags": [ + "urlrelaxprice", + "productsearchmodel.urlrelaxprice" + ], + "title": "ProductSearchModel.urlRelaxPrice" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPromotion", + "tags": [ + "urlrelaxpromotion", + "productsearchmodel.urlrelaxpromotion" + ], + "title": "ProductSearchModel.urlRelaxPromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPromotion", + "tags": [ + "urlrelaxpromotion", + "productsearchmodel.urlrelaxpromotion" + ], + "title": "ProductSearchModel.urlRelaxPromotion" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingOption", + "tags": [ + "urlsortingoption", + "productsearchmodel.urlsortingoption" + ], + "title": "ProductSearchModel.urlSortingOption" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingOption", + "tags": [ + "urlsortingoption", + "productsearchmodel.urlsortingoption" + ], + "title": "ProductSearchModel.urlSortingOption" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingRule", + "tags": [ + "urlsortingrule", + "productsearchmodel.urlsortingrule" + ], + "title": "ProductSearchModel.urlSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingRule", + "tags": [ + "urlsortingrule", + "productsearchmodel.urlsortingrule" + ], + "title": "ProductSearchModel.urlSortingRule" + }, + { + "id": "script-api:dw/catalog/ProductSearchModel#visualSearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.visualSearch", + "tags": [ + "visualsearch", + "productsearchmodel.visualsearch" + ], + "title": "ProductSearchModel.visualSearch" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition", + "tags": [ + "productsearchrefinementdefinition", + "dw.catalog.productsearchrefinementdefinition", + "dw/catalog" + ], + "title": "ProductSearchRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#categoryRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.categoryRefinement", + "tags": [ + "categoryrefinement", + "productsearchrefinementdefinition.categoryrefinement" + ], + "title": "ProductSearchRefinementDefinition.categoryRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isCategoryRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isCategoryRefinement", + "tags": [ + "iscategoryrefinement", + "productsearchrefinementdefinition.iscategoryrefinement" + ], + "title": "ProductSearchRefinementDefinition.isCategoryRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isPriceRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isPriceRefinement", + "tags": [ + "ispricerefinement", + "productsearchrefinementdefinition.ispricerefinement" + ], + "title": "ProductSearchRefinementDefinition.isPriceRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isPromotionRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isPromotionRefinement", + "tags": [ + "ispromotionrefinement", + "productsearchrefinementdefinition.ispromotionrefinement" + ], + "title": "ProductSearchRefinementDefinition.isPromotionRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#priceRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.priceRefinement", + "tags": [ + "pricerefinement", + "productsearchrefinementdefinition.pricerefinement" + ], + "title": "ProductSearchRefinementDefinition.priceRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#promotionRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.promotionRefinement", + "tags": [ + "promotionrefinement", + "productsearchrefinementdefinition.promotionrefinement" + ], + "title": "ProductSearchRefinementDefinition.promotionRefinement" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue", + "tags": [ + "productsearchrefinementvalue", + "dw.catalog.productsearchrefinementvalue", + "dw/catalog" + ], + "title": "ProductSearchRefinementValue" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementValue#getValueFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.getValueFrom", + "tags": [ + "getvaluefrom", + "productsearchrefinementvalue.getvaluefrom" + ], + "title": "ProductSearchRefinementValue.getValueFrom" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementValue#getValueTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.getValueTo", + "tags": [ + "getvalueto", + "productsearchrefinementvalue.getvalueto" + ], + "title": "ProductSearchRefinementValue.getValueTo" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementValue#valueFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.valueFrom", + "tags": [ + "valuefrom", + "productsearchrefinementvalue.valuefrom" + ], + "title": "ProductSearchRefinementValue.valueFrom" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinementValue#valueTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.valueTo", + "tags": [ + "valueto", + "productsearchrefinementvalue.valueto" + ], + "title": "ProductSearchRefinementValue.valueTo" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinements", + "tags": [ + "productsearchrefinements", + "dw.catalog.productsearchrefinements", + "dw/catalog" + ], + "title": "ProductSearchRefinements" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#categoryRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.categoryRefinementDefinition", + "tags": [ + "categoryrefinementdefinition", + "productsearchrefinements.categoryrefinementdefinition" + ], + "title": "ProductSearchRefinements.categoryRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getCategoryRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getCategoryRefinementDefinition", + "tags": [ + "getcategoryrefinementdefinition", + "productsearchrefinements.getcategoryrefinementdefinition" + ], + "title": "ProductSearchRefinements.getCategoryRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getNextLevelCategoryRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getNextLevelCategoryRefinementValues", + "tags": [ + "getnextlevelcategoryrefinementvalues", + "productsearchrefinements.getnextlevelcategoryrefinementvalues" + ], + "title": "ProductSearchRefinements.getNextLevelCategoryRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getPriceRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getPriceRefinementDefinition", + "tags": [ + "getpricerefinementdefinition", + "productsearchrefinements.getpricerefinementdefinition" + ], + "title": "ProductSearchRefinements.getPriceRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getPromotionRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getPromotionRefinementDefinition", + "tags": [ + "getpromotionrefinementdefinition", + "productsearchrefinements.getpromotionrefinementdefinition" + ], + "title": "ProductSearchRefinements.getPromotionRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValue", + "tags": [ + "getrefinementvalue", + "productsearchrefinements.getrefinementvalue" + ], + "title": "ProductSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValue", + "tags": [ + "getrefinementvalue", + "productsearchrefinements.getrefinementvalue" + ], + "title": "ProductSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValues", + "tags": [ + "getrefinementvalues", + "productsearchrefinements.getrefinementvalues" + ], + "title": "ProductSearchRefinements.getRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValues", + "tags": [ + "getrefinementvalues", + "productsearchrefinements.getrefinementvalues" + ], + "title": "ProductSearchRefinements.getRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#priceRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.priceRefinementDefinition", + "tags": [ + "pricerefinementdefinition", + "productsearchrefinements.pricerefinementdefinition" + ], + "title": "ProductSearchRefinements.priceRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#promotionRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.promotionRefinementDefinition", + "tags": [ + "promotionrefinementdefinition", + "productsearchrefinements.promotionrefinementdefinition" + ], + "title": "ProductSearchRefinements.promotionRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationAttribute", + "tags": [ + "productvariationattribute", + "dw.catalog.productvariationattribute", + "dw/catalog" + ], + "title": "ProductVariationAttribute" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.ID", + "tags": [ + "id", + "productvariationattribute.id" + ], + "title": "ProductVariationAttribute.ID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#attributeID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.attributeID", + "tags": [ + "attributeid", + "productvariationattribute.attributeid" + ], + "title": "ProductVariationAttribute.attributeID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.displayName", + "tags": [ + "displayname", + "productvariationattribute.displayname" + ], + "title": "ProductVariationAttribute.displayName" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#getAttributeID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getAttributeID", + "tags": [ + "getattributeid", + "productvariationattribute.getattributeid" + ], + "title": "ProductVariationAttribute.getAttributeID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getDisplayName", + "tags": [ + "getdisplayname", + "productvariationattribute.getdisplayname" + ], + "title": "ProductVariationAttribute.getDisplayName" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttribute#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getID", + "tags": [ + "getid", + "productvariationattribute.getid" + ], + "title": "ProductVariationAttribute.getID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue", + "tags": [ + "productvariationattributevalue", + "dw.catalog.productvariationattributevalue", + "dw/catalog" + ], + "title": "ProductVariationAttributeValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.ID", + "tags": [ + "id", + "productvariationattributevalue.id" + ], + "title": "ProductVariationAttributeValue.ID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.description", + "tags": [ + "description", + "productvariationattributevalue.description" + ], + "title": "ProductVariationAttributeValue.description" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.displayValue", + "tags": [ + "displayvalue", + "productvariationattributevalue.displayvalue" + ], + "title": "ProductVariationAttributeValue.displayValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#equals", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.equals", + "tags": [ + "equals", + "productvariationattributevalue.equals" + ], + "title": "ProductVariationAttributeValue.equals" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getDescription", + "tags": [ + "getdescription", + "productvariationattributevalue.getdescription" + ], + "title": "ProductVariationAttributeValue.getDescription" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getDisplayValue", + "tags": [ + "getdisplayvalue", + "productvariationattributevalue.getdisplayvalue" + ], + "title": "ProductVariationAttributeValue.getDisplayValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getID", + "tags": [ + "getid", + "productvariationattributevalue.getid" + ], + "title": "ProductVariationAttributeValue.getID" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImage", + "tags": [ + "getimage", + "productvariationattributevalue.getimage" + ], + "title": "ProductVariationAttributeValue.getImage" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImage", + "tags": [ + "getimage", + "productvariationattributevalue.getimage" + ], + "title": "ProductVariationAttributeValue.getImage" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImages", + "tags": [ + "getimages", + "productvariationattributevalue.getimages" + ], + "title": "ProductVariationAttributeValue.getImages" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getValue", + "tags": [ + "getvalue", + "productvariationattributevalue.getvalue" + ], + "title": "ProductVariationAttributeValue.getValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#hashCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.hashCode", + "tags": [ + "hashcode", + "productvariationattributevalue.hashcode" + ], + "title": "ProductVariationAttributeValue.hashCode" + }, + { + "id": "script-api:dw/catalog/ProductVariationAttributeValue#value", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.value", + "tags": [ + "value", + "productvariationattributevalue.value" + ], + "title": "ProductVariationAttributeValue.value" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationModel", + "tags": [ + "productvariationmodel", + "dw.catalog.productvariationmodel", + "dw/catalog" + ], + "title": "ProductVariationModel" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#attributeDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.attributeDefinitions", + "tags": [ + "attributedefinitions", + "productvariationmodel.attributedefinitions" + ], + "title": "ProductVariationModel.attributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#defaultVariant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.defaultVariant", + "tags": [ + "defaultvariant", + "productvariationmodel.defaultvariant" + ], + "title": "ProductVariationModel.defaultVariant" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getAllValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAllValues", + "tags": [ + "getallvalues", + "productvariationmodel.getallvalues" + ], + "title": "ProductVariationModel.getAllValues" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getAllValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAllValues", + "tags": [ + "getallvalues", + "productvariationmodel.getallvalues" + ], + "title": "ProductVariationModel.getAllValues" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAttributeDefinitions", + "tags": [ + "getattributedefinitions", + "productvariationmodel.getattributedefinitions" + ], + "title": "ProductVariationModel.getAttributeDefinitions" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getDefaultVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getDefaultVariant", + "tags": [ + "getdefaultvariant", + "productvariationmodel.getdefaultvariant" + ], + "title": "ProductVariationModel.getDefaultVariant" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getFilteredValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getFilteredValues", + "tags": [ + "getfilteredvalues", + "productvariationmodel.getfilteredvalues" + ], + "title": "ProductVariationModel.getFilteredValues" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getFilteredValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getFilteredValues", + "tags": [ + "getfilteredvalues", + "productvariationmodel.getfilteredvalues" + ], + "title": "ProductVariationModel.getFilteredValues" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImages", + "tags": [ + "getimages", + "productvariationmodel.getimages" + ], + "title": "ProductVariationModel.getImages" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getMaster", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getMaster", + "tags": [ + "getmaster", + "productvariationmodel.getmaster" + ], + "title": "ProductVariationModel.getMaster" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getProductVariationAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getProductVariationAttribute", + "tags": [ + "getproductvariationattribute", + "productvariationmodel.getproductvariationattribute" + ], + "title": "ProductVariationModel.getProductVariationAttribute" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getProductVariationAttributes", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getProductVariationAttributes", + "tags": [ + "getproductvariationattributes", + "productvariationmodel.getproductvariationattributes" + ], + "title": "ProductVariationModel.getProductVariationAttributes" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedValue", + "tags": [ + "getselectedvalue", + "productvariationmodel.getselectedvalue" + ], + "title": "ProductVariationModel.getSelectedValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedValue", + "tags": [ + "getselectedvalue", + "productvariationmodel.getselectedvalue" + ], + "title": "ProductVariationModel.getSelectedValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedVariant", + "tags": [ + "getselectedvariant", + "productvariationmodel.getselectedvariant" + ], + "title": "ProductVariationModel.getSelectedVariant" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedVariants", + "tags": [ + "getselectedvariants", + "productvariationmodel.getselectedvariants" + ], + "title": "ProductVariationModel.getSelectedVariants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariants", + "tags": [ + "getvariants", + "productvariationmodel.getvariants" + ], + "title": "ProductVariationModel.getVariants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariants", + "tags": [ + "getvariants", + "productvariationmodel.getvariants" + ], + "title": "ProductVariationModel.getVariants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getVariationGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariationGroups", + "tags": [ + "getvariationgroups", + "productvariationmodel.getvariationgroups" + ], + "title": "ProductVariationModel.getVariationGroups" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#getVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariationValue", + "tags": [ + "getvariationvalue", + "productvariationmodel.getvariationvalue" + ], + "title": "ProductVariationModel.getVariationValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#hasOrderableVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.hasOrderableVariants", + "tags": [ + "hasorderablevariants", + "productvariationmodel.hasorderablevariants" + ], + "title": "ProductVariationModel.hasOrderableVariants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#isSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.isSelectedAttributeValue", + "tags": [ + "isselectedattributevalue", + "productvariationmodel.isselectedattributevalue" + ], + "title": "ProductVariationModel.isSelectedAttributeValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#isSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.isSelectedAttributeValue", + "tags": [ + "isselectedattributevalue", + "productvariationmodel.isselectedattributevalue" + ], + "title": "ProductVariationModel.isSelectedAttributeValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#master", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.master", + "tags": [ + "master", + "productvariationmodel.master" + ], + "title": "ProductVariationModel.master" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#productVariationAttributes", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.productVariationAttributes", + "tags": [ + "productvariationattributes", + "productvariationmodel.productvariationattributes" + ], + "title": "ProductVariationModel.productVariationAttributes" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#selectedVariant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.selectedVariant", + "tags": [ + "selectedvariant", + "productvariationmodel.selectedvariant" + ], + "title": "ProductVariationModel.selectedVariant" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#selectedVariants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.selectedVariants", + "tags": [ + "selectedvariants", + "productvariationmodel.selectedvariants" + ], + "title": "ProductVariationModel.selectedVariants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#setSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.setSelectedAttributeValue", + "tags": [ + "setselectedattributevalue", + "productvariationmodel.setselectedattributevalue" + ], + "title": "ProductVariationModel.setSelectedAttributeValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.url", + "tags": [ + "url", + "productvariationmodel.url" + ], + "title": "ProductVariationModel.url" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#urlSelectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlSelectVariationValue", + "tags": [ + "urlselectvariationvalue", + "productvariationmodel.urlselectvariationvalue" + ], + "title": "ProductVariationModel.urlSelectVariationValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#urlSelectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlSelectVariationValue", + "tags": [ + "urlselectvariationvalue", + "productvariationmodel.urlselectvariationvalue" + ], + "title": "ProductVariationModel.urlSelectVariationValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#urlUnselectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlUnselectVariationValue", + "tags": [ + "urlunselectvariationvalue", + "productvariationmodel.urlunselectvariationvalue" + ], + "title": "ProductVariationModel.urlUnselectVariationValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#urlUnselectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlUnselectVariationValue", + "tags": [ + "urlunselectvariationvalue", + "productvariationmodel.urlunselectvariationvalue" + ], + "title": "ProductVariationModel.urlUnselectVariationValue" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#variants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.variants", + "tags": [ + "variants", + "productvariationmodel.variants" + ], + "title": "ProductVariationModel.variants" + }, + { + "id": "script-api:dw/catalog/ProductVariationModel#variationGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.variationGroups", + "tags": [ + "variationgroups", + "productvariationmodel.variationgroups" + ], + "title": "ProductVariationModel.variationGroups" + }, + { + "id": "script-api:dw/catalog/Recommendation", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Recommendation", + "tags": [ + "recommendation", + "dw.catalog.recommendation", + "dw/catalog" + ], + "title": "Recommendation" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_CROSS_SELL", + "tags": [ + "recommendation_type_cross_sell", + "recommendation.recommendation_type_cross_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_CROSS_SELL", + "tags": [ + "recommendation_type_cross_sell", + "recommendation.recommendation_type_cross_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_CROSS_SELL" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_OTHER", + "tags": [ + "recommendation_type_other", + "recommendation.recommendation_type_other" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_OTHER", + "tags": [ + "recommendation_type_other", + "recommendation.recommendation_type_other" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_OTHER" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_UP_SELL", + "tags": [ + "recommendation_type_up_sell", + "recommendation.recommendation_type_up_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_UP_SELL", + "tags": [ + "recommendation_type_up_sell", + "recommendation.recommendation_type_up_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_UP_SELL" + }, + { + "id": "script-api:dw/catalog/Recommendation#calloutMsg", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.calloutMsg", + "tags": [ + "calloutmsg", + "recommendation.calloutmsg" + ], + "title": "Recommendation.calloutMsg" + }, + { + "id": "script-api:dw/catalog/Recommendation#catalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.catalog", + "tags": [ + "catalog", + "recommendation.catalog" + ], + "title": "Recommendation.catalog" + }, + { + "id": "script-api:dw/catalog/Recommendation#getCalloutMsg", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getCalloutMsg", + "tags": [ + "getcalloutmsg", + "recommendation.getcalloutmsg" + ], + "title": "Recommendation.getCalloutMsg" + }, + { + "id": "script-api:dw/catalog/Recommendation#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getCatalog", + "tags": [ + "getcatalog", + "recommendation.getcatalog" + ], + "title": "Recommendation.getCatalog" + }, + { + "id": "script-api:dw/catalog/Recommendation#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getImage", + "tags": [ + "getimage", + "recommendation.getimage" + ], + "title": "Recommendation.getImage" + }, + { + "id": "script-api:dw/catalog/Recommendation#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getLongDescription", + "tags": [ + "getlongdescription", + "recommendation.getlongdescription" + ], + "title": "Recommendation.getLongDescription" + }, + { + "id": "script-api:dw/catalog/Recommendation#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getName", + "tags": [ + "getname", + "recommendation.getname" + ], + "title": "Recommendation.getName" + }, + { + "id": "script-api:dw/catalog/Recommendation#getRecommendationType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendationType", + "tags": [ + "getrecommendationtype", + "recommendation.getrecommendationtype" + ], + "title": "Recommendation.getRecommendationType" + }, + { + "id": "script-api:dw/catalog/Recommendation#getRecommendedItem", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendedItem", + "tags": [ + "getrecommendeditem", + "recommendation.getrecommendeditem" + ], + "title": "Recommendation.getRecommendedItem" + }, + { + "id": "script-api:dw/catalog/Recommendation#getRecommendedItemID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendedItemID", + "tags": [ + "getrecommendeditemid", + "recommendation.getrecommendeditemid" + ], + "title": "Recommendation.getRecommendedItemID" + }, + { + "id": "script-api:dw/catalog/Recommendation#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getShortDescription", + "tags": [ + "getshortdescription", + "recommendation.getshortdescription" + ], + "title": "Recommendation.getShortDescription" + }, + { + "id": "script-api:dw/catalog/Recommendation#getSourceItem", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getSourceItem", + "tags": [ + "getsourceitem", + "recommendation.getsourceitem" + ], + "title": "Recommendation.getSourceItem" + }, + { + "id": "script-api:dw/catalog/Recommendation#getSourceItemID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getSourceItemID", + "tags": [ + "getsourceitemid", + "recommendation.getsourceitemid" + ], + "title": "Recommendation.getSourceItemID" + }, + { + "id": "script-api:dw/catalog/Recommendation#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.image", + "tags": [ + "image", + "recommendation.image" + ], + "title": "Recommendation.image" + }, + { + "id": "script-api:dw/catalog/Recommendation#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.longDescription", + "tags": [ + "longdescription", + "recommendation.longdescription" + ], + "title": "Recommendation.longDescription" + }, + { + "id": "script-api:dw/catalog/Recommendation#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.name", + "tags": [ + "name", + "recommendation.name" + ], + "title": "Recommendation.name" + }, + { + "id": "script-api:dw/catalog/Recommendation#recommendationType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendationType", + "tags": [ + "recommendationtype", + "recommendation.recommendationtype" + ], + "title": "Recommendation.recommendationType" + }, + { + "id": "script-api:dw/catalog/Recommendation#recommendedItem", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendedItem", + "tags": [ + "recommendeditem", + "recommendation.recommendeditem" + ], + "title": "Recommendation.recommendedItem" + }, + { + "id": "script-api:dw/catalog/Recommendation#recommendedItemID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendedItemID", + "tags": [ + "recommendeditemid", + "recommendation.recommendeditemid" + ], + "title": "Recommendation.recommendedItemID" + }, + { + "id": "script-api:dw/catalog/Recommendation#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.shortDescription", + "tags": [ + "shortdescription", + "recommendation.shortdescription" + ], + "title": "Recommendation.shortDescription" + }, + { + "id": "script-api:dw/catalog/Recommendation#sourceItem", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.sourceItem", + "tags": [ + "sourceitem", + "recommendation.sourceitem" + ], + "title": "Recommendation.sourceItem" + }, + { + "id": "script-api:dw/catalog/Recommendation#sourceItemID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.sourceItemID", + "tags": [ + "sourceitemid", + "recommendation.sourceitemid" + ], + "title": "Recommendation.sourceItemID" + }, + { + "id": "script-api:dw/catalog/SearchModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchModel", + "tags": [ + "searchmodel", + "dw.catalog.searchmodel", + "dw/catalog" + ], + "title": "SearchModel" + }, + { + "id": "script-api:dw/catalog/SearchModel#SEARCH_PHRASE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SEARCH_PHRASE_PARAMETER", + "tags": [ + "search_phrase_parameter", + "searchmodel.search_phrase_parameter" + ], + "title": "SearchModel.SEARCH_PHRASE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/SearchModel#SEARCH_PHRASE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SEARCH_PHRASE_PARAMETER", + "tags": [ + "search_phrase_parameter", + "searchmodel.search_phrase_parameter" + ], + "title": "SearchModel.SEARCH_PHRASE_PARAMETER" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_ASCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_ASCENDING", + "tags": [ + "sort_direction_ascending", + "searchmodel.sort_direction_ascending" + ], + "title": "SearchModel.SORT_DIRECTION_ASCENDING" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_ASCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_ASCENDING", + "tags": [ + "sort_direction_ascending", + "searchmodel.sort_direction_ascending" + ], + "title": "SearchModel.SORT_DIRECTION_ASCENDING" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_DESCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_DESCENDING", + "tags": [ + "sort_direction_descending", + "searchmodel.sort_direction_descending" + ], + "title": "SearchModel.SORT_DIRECTION_DESCENDING" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_DESCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_DESCENDING", + "tags": [ + "sort_direction_descending", + "searchmodel.sort_direction_descending" + ], + "title": "SearchModel.SORT_DIRECTION_DESCENDING" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_NONE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_NONE", + "tags": [ + "sort_direction_none", + "searchmodel.sort_direction_none" + ], + "title": "SearchModel.SORT_DIRECTION_NONE" + }, + { + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_NONE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_NONE", + "tags": [ + "sort_direction_none", + "searchmodel.sort_direction_none" + ], + "title": "SearchModel.SORT_DIRECTION_NONE" + }, + { + "id": "script-api:dw/catalog/SearchModel#addRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.addRefinementValues", + "tags": [ + "addrefinementvalues", + "searchmodel.addrefinementvalues" + ], + "title": "SearchModel.addRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchModel#canRelax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.canRelax", + "tags": [ + "canrelax", + "searchmodel.canrelax" + ], + "title": "SearchModel.canRelax" + }, + { + "id": "script-api:dw/catalog/SearchModel#count", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.count", + "tags": [ + "count", + "searchmodel.count" + ], + "title": "SearchModel.count" + }, + { + "id": "script-api:dw/catalog/SearchModel#emptyQuery", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.emptyQuery", + "tags": [ + "emptyquery", + "searchmodel.emptyquery" + ], + "title": "SearchModel.emptyQuery" + }, + { + "id": "script-api:dw/catalog/SearchModel#getCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getCount", + "tags": [ + "getcount", + "searchmodel.getcount" + ], + "title": "SearchModel.getCount" + }, + { + "id": "script-api:dw/catalog/SearchModel#getRefinementMaxValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementMaxValue", + "tags": [ + "getrefinementmaxvalue", + "searchmodel.getrefinementmaxvalue" + ], + "title": "SearchModel.getRefinementMaxValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#getRefinementMinValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementMinValue", + "tags": [ + "getrefinementminvalue", + "searchmodel.getrefinementminvalue" + ], + "title": "SearchModel.getRefinementMinValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementValue", + "tags": [ + "getrefinementvalue", + "searchmodel.getrefinementvalue" + ], + "title": "SearchModel.getRefinementValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementValues", + "tags": [ + "getrefinementvalues", + "searchmodel.getrefinementvalues" + ], + "title": "SearchModel.getRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchModel#getSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchPhrase", + "tags": [ + "getsearchphrase", + "searchmodel.getsearchphrase" + ], + "title": "SearchModel.getSearchPhrase" + }, + { + "id": "script-api:dw/catalog/SearchModel#getSearchRedirect", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchRedirect", + "tags": [ + "getsearchredirect", + "searchmodel.getsearchredirect" + ], + "title": "SearchModel.getSearchRedirect" + }, + { + "id": "script-api:dw/catalog/SearchModel#getSearchRedirect", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchRedirect", + "tags": [ + "getsearchredirect", + "searchmodel.getsearchredirect" + ], + "title": "SearchModel.getSearchRedirect" + }, + { + "id": "script-api:dw/catalog/SearchModel#getSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSortingCondition", + "tags": [ + "getsortingcondition", + "searchmodel.getsortingcondition" + ], + "title": "SearchModel.getSortingCondition" + }, + { + "id": "script-api:dw/catalog/SearchModel#isEmptyQuery", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isEmptyQuery", + "tags": [ + "isemptyquery", + "searchmodel.isemptyquery" + ], + "title": "SearchModel.isEmptyQuery" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttribute", + "tags": [ + "isrefinedbyattribute", + "searchmodel.isrefinedbyattribute" + ], + "title": "SearchModel.isRefinedByAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttribute", + "tags": [ + "isrefinedbyattribute", + "searchmodel.isrefinedbyattribute" + ], + "title": "SearchModel.isRefinedByAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttributeValue", + "tags": [ + "isrefinedbyattributevalue", + "searchmodel.isrefinedbyattributevalue" + ], + "title": "SearchModel.isRefinedByAttributeValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinedSearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedSearch", + "tags": [ + "isrefinedsearch", + "searchmodel.isrefinedsearch" + ], + "title": "SearchModel.isRefinedSearch" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinementByValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinementByValueRange", + "tags": [ + "isrefinementbyvaluerange", + "searchmodel.isrefinementbyvaluerange" + ], + "title": "SearchModel.isRefinementByValueRange" + }, + { + "id": "script-api:dw/catalog/SearchModel#isRefinementByValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinementByValueRange", + "tags": [ + "isrefinementbyvaluerange", + "searchmodel.isrefinementbyvaluerange" + ], + "title": "SearchModel.isRefinementByValueRange" + }, + { + "id": "script-api:dw/catalog/SearchModel#refinedByAttribute", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.refinedByAttribute", + "tags": [ + "refinedbyattribute", + "searchmodel.refinedbyattribute" + ], + "title": "SearchModel.refinedByAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#refinedSearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.refinedSearch", + "tags": [ + "refinedsearch", + "searchmodel.refinedsearch" + ], + "title": "SearchModel.refinedSearch" + }, + { + "id": "script-api:dw/catalog/SearchModel#removeRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.removeRefinementValues", + "tags": [ + "removerefinementvalues", + "searchmodel.removerefinementvalues" + ], + "title": "SearchModel.removeRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchModel#search", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.search", + "tags": [ + "search", + "searchmodel.search" + ], + "title": "SearchModel.search" + }, + { + "id": "script-api:dw/catalog/SearchModel#searchPhrase", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.searchPhrase", + "tags": [ + "searchphrase", + "searchmodel.searchphrase" + ], + "title": "SearchModel.searchPhrase" + }, + { + "id": "script-api:dw/catalog/SearchModel#setRefinementValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setRefinementValueRange", + "tags": [ + "setrefinementvaluerange", + "searchmodel.setrefinementvaluerange" + ], + "title": "SearchModel.setRefinementValueRange" + }, + { + "id": "script-api:dw/catalog/SearchModel#setRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setRefinementValues", + "tags": [ + "setrefinementvalues", + "searchmodel.setrefinementvalues" + ], + "title": "SearchModel.setRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchModel#setSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setSearchPhrase", + "tags": [ + "setsearchphrase", + "searchmodel.setsearchphrase" + ], + "title": "SearchModel.setSearchPhrase" + }, + { + "id": "script-api:dw/catalog/SearchModel#setSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setSortingCondition", + "tags": [ + "setsortingcondition", + "searchmodel.setsortingcondition" + ], + "title": "SearchModel.setSortingCondition" + }, + { + "id": "script-api:dw/catalog/SearchModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.url", + "tags": [ + "url", + "searchmodel.url" + ], + "title": "SearchModel.url" + }, + { + "id": "script-api:dw/catalog/SearchModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.url", + "tags": [ + "url", + "searchmodel.url" + ], + "title": "SearchModel.url" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlDefaultSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlDefaultSort", + "tags": [ + "urldefaultsort", + "searchmodel.urldefaultsort" + ], + "title": "SearchModel.urlDefaultSort" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlDefaultSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlDefaultSort", + "tags": [ + "urldefaultsort", + "searchmodel.urldefaultsort" + ], + "title": "SearchModel.urlDefaultSort" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRefineAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttribute", + "tags": [ + "urlrefineattribute", + "searchmodel.urlrefineattribute" + ], + "title": "SearchModel.urlRefineAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRefineAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttribute", + "tags": [ + "urlrefineattribute", + "searchmodel.urlrefineattribute" + ], + "title": "SearchModel.urlRefineAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValue", + "tags": [ + "urlrefineattributevalue", + "searchmodel.urlrefineattributevalue" + ], + "title": "SearchModel.urlRefineAttributeValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValue", + "tags": [ + "urlrefineattributevalue", + "searchmodel.urlrefineattributevalue" + ], + "title": "SearchModel.urlRefineAttributeValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValueRange", + "tags": [ + "urlrefineattributevaluerange", + "searchmodel.urlrefineattributevaluerange" + ], + "title": "SearchModel.urlRefineAttributeValueRange" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttribute", + "tags": [ + "urlrelaxattribute", + "searchmodel.urlrelaxattribute" + ], + "title": "SearchModel.urlRelaxAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttribute", + "tags": [ + "urlrelaxattribute", + "searchmodel.urlrelaxattribute" + ], + "title": "SearchModel.urlRelaxAttribute" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttributeValue", + "tags": [ + "urlrelaxattributevalue", + "searchmodel.urlrelaxattributevalue" + ], + "title": "SearchModel.urlRelaxAttributeValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttributeValue", + "tags": [ + "urlrelaxattributevalue", + "searchmodel.urlrelaxattributevalue" + ], + "title": "SearchModel.urlRelaxAttributeValue" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlSort", + "tags": [ + "urlsort", + "searchmodel.urlsort" + ], + "title": "SearchModel.urlSort" + }, + { + "id": "script-api:dw/catalog/SearchModel#urlSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlSort", + "tags": [ + "urlsort", + "searchmodel.urlsort" + ], + "title": "SearchModel.urlSort" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinementDefinition", + "tags": [ + "searchrefinementdefinition", + "dw.catalog.searchrefinementdefinition", + "dw/catalog" + ], + "title": "SearchRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#attributeID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.attributeID", + "tags": [ + "attributeid", + "searchrefinementdefinition.attributeid" + ], + "title": "SearchRefinementDefinition.attributeID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#attributeRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.attributeRefinement", + "tags": [ + "attributerefinement", + "searchrefinementdefinition.attributerefinement" + ], + "title": "SearchRefinementDefinition.attributeRefinement" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#cutoffThreshold", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.cutoffThreshold", + "tags": [ + "cutoffthreshold", + "searchrefinementdefinition.cutoffthreshold" + ], + "title": "SearchRefinementDefinition.cutoffThreshold" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.displayName", + "tags": [ + "displayname", + "searchrefinementdefinition.displayname" + ], + "title": "SearchRefinementDefinition.displayName" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#getAttributeID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getAttributeID", + "tags": [ + "getattributeid", + "searchrefinementdefinition.getattributeid" + ], + "title": "SearchRefinementDefinition.getAttributeID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#getCutoffThreshold", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getCutoffThreshold", + "tags": [ + "getcutoffthreshold", + "searchrefinementdefinition.getcutoffthreshold" + ], + "title": "SearchRefinementDefinition.getCutoffThreshold" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getDisplayName", + "tags": [ + "getdisplayname", + "searchrefinementdefinition.getdisplayname" + ], + "title": "SearchRefinementDefinition.getDisplayName" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#getValueTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getValueTypeCode", + "tags": [ + "getvaluetypecode", + "searchrefinementdefinition.getvaluetypecode" + ], + "title": "SearchRefinementDefinition.getValueTypeCode" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#isAttributeRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.isAttributeRefinement", + "tags": [ + "isattributerefinement", + "searchrefinementdefinition.isattributerefinement" + ], + "title": "SearchRefinementDefinition.isAttributeRefinement" + }, + { + "id": "script-api:dw/catalog/SearchRefinementDefinition#valueTypeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.valueTypeCode", + "tags": [ + "valuetypecode", + "searchrefinementdefinition.valuetypecode" + ], + "title": "SearchRefinementDefinition.valueTypeCode" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinementValue", + "tags": [ + "searchrefinementvalue", + "dw.catalog.searchrefinementvalue", + "dw/catalog" + ], + "title": "SearchRefinementValue" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.ID", + "tags": [ + "id", + "searchrefinementvalue.id" + ], + "title": "SearchRefinementValue.ID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.description", + "tags": [ + "description", + "searchrefinementvalue.description" + ], + "title": "SearchRefinementValue.description" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.displayValue", + "tags": [ + "displayvalue", + "searchrefinementvalue.displayvalue" + ], + "title": "SearchRefinementValue.displayValue" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getDescription", + "tags": [ + "getdescription", + "searchrefinementvalue.getdescription" + ], + "title": "SearchRefinementValue.getDescription" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getDisplayValue", + "tags": [ + "getdisplayvalue", + "searchrefinementvalue.getdisplayvalue" + ], + "title": "SearchRefinementValue.getDisplayValue" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getHitCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getHitCount", + "tags": [ + "gethitcount", + "searchrefinementvalue.gethitcount" + ], + "title": "SearchRefinementValue.getHitCount" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getID", + "tags": [ + "getid", + "searchrefinementvalue.getid" + ], + "title": "SearchRefinementValue.getID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getPresentationID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getPresentationID", + "tags": [ + "getpresentationid", + "searchrefinementvalue.getpresentationid" + ], + "title": "SearchRefinementValue.getPresentationID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getValue", + "tags": [ + "getvalue", + "searchrefinementvalue.getvalue" + ], + "title": "SearchRefinementValue.getValue" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#hitCount", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.hitCount", + "tags": [ + "hitcount", + "searchrefinementvalue.hitcount" + ], + "title": "SearchRefinementValue.hitCount" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#presentationID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.presentationID", + "tags": [ + "presentationid", + "searchrefinementvalue.presentationid" + ], + "title": "SearchRefinementValue.presentationID" + }, + { + "id": "script-api:dw/catalog/SearchRefinementValue#value", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.value", + "tags": [ + "value", + "searchrefinementvalue.value" + ], + "title": "SearchRefinementValue.value" + }, + { + "id": "script-api:dw/catalog/SearchRefinements", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinements", + "tags": [ + "searchrefinements", + "dw.catalog.searchrefinements", + "dw/catalog" + ], + "title": "SearchRefinements" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#ASCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.ASCENDING", + "tags": [ + "ascending", + "searchrefinements.ascending" + ], + "title": "SearchRefinements.ASCENDING" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#ASCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.ASCENDING", + "tags": [ + "ascending", + "searchrefinements.ascending" + ], + "title": "SearchRefinements.ASCENDING" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#DESCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.DESCENDING", + "tags": [ + "descending", + "searchrefinements.descending" + ], + "title": "SearchRefinements.DESCENDING" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#DESCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.DESCENDING", + "tags": [ + "descending", + "searchrefinements.descending" + ], + "title": "SearchRefinements.DESCENDING" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_COUNT", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_COUNT", + "tags": [ + "sort_value_count", + "searchrefinements.sort_value_count" + ], + "title": "SearchRefinements.SORT_VALUE_COUNT" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_COUNT", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_COUNT", + "tags": [ + "sort_value_count", + "searchrefinements.sort_value_count" + ], + "title": "SearchRefinements.SORT_VALUE_COUNT" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_NAME", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_NAME", + "tags": [ + "sort_value_name", + "searchrefinements.sort_value_name" + ], + "title": "SearchRefinements.SORT_VALUE_NAME" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_NAME", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_NAME", + "tags": [ + "sort_value_name", + "searchrefinements.sort_value_name" + ], + "title": "SearchRefinements.SORT_VALUE_NAME" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#allRefinementDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.allRefinementDefinitions", + "tags": [ + "allrefinementdefinitions", + "searchrefinements.allrefinementdefinitions" + ], + "title": "SearchRefinements.allRefinementDefinitions" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementDefinitions", + "tags": [ + "getallrefinementdefinitions", + "searchrefinements.getallrefinementdefinitions" + ], + "title": "SearchRefinements.getAllRefinementDefinitions" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "searchrefinements.getallrefinementvalues" + ], + "title": "SearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "searchrefinements.getallrefinementvalues" + ], + "title": "SearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#getRefinementDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getRefinementDefinitions", + "tags": [ + "getrefinementdefinitions", + "searchrefinements.getrefinementdefinitions" + ], + "title": "SearchRefinements.getRefinementDefinitions" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getRefinementValues", + "tags": [ + "getrefinementvalues", + "searchrefinements.getrefinementvalues" + ], + "title": "SearchRefinements.getRefinementValues" + }, + { + "id": "script-api:dw/catalog/SearchRefinements#refinementDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.refinementDefinitions", + "tags": [ + "refinementdefinitions", + "searchrefinements.refinementdefinitions" + ], + "title": "SearchRefinements.refinementDefinitions" + }, + { + "id": "script-api:dw/catalog/SortingOption", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SortingOption", + "tags": [ + "sortingoption", + "dw.catalog.sortingoption", + "dw/catalog" + ], + "title": "SortingOption" + }, + { + "id": "script-api:dw/catalog/SortingOption#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.ID", + "tags": [ + "id", + "sortingoption.id" + ], + "title": "SortingOption.ID" + }, + { + "id": "script-api:dw/catalog/SortingOption#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.description", + "tags": [ + "description", + "sortingoption.description" + ], + "title": "SortingOption.description" + }, + { + "id": "script-api:dw/catalog/SortingOption#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.displayName", + "tags": [ + "displayname", + "sortingoption.displayname" + ], + "title": "SortingOption.displayName" + }, + { + "id": "script-api:dw/catalog/SortingOption#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getDescription", + "tags": [ + "getdescription", + "sortingoption.getdescription" + ], + "title": "SortingOption.getDescription" + }, + { + "id": "script-api:dw/catalog/SortingOption#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getDisplayName", + "tags": [ + "getdisplayname", + "sortingoption.getdisplayname" + ], + "title": "SortingOption.getDisplayName" + }, + { + "id": "script-api:dw/catalog/SortingOption#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getID", + "tags": [ + "getid", + "sortingoption.getid" + ], + "title": "SortingOption.getID" + }, + { + "id": "script-api:dw/catalog/SortingOption#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getSortingRule", + "tags": [ + "getsortingrule", + "sortingoption.getsortingrule" + ], + "title": "SortingOption.getSortingRule" + }, + { + "id": "script-api:dw/catalog/SortingOption#sortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.sortingRule", + "tags": [ + "sortingrule", + "sortingoption.sortingrule" + ], + "title": "SortingOption.sortingRule" + }, + { + "id": "script-api:dw/catalog/SortingRule", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SortingRule", + "tags": [ + "sortingrule", + "dw.catalog.sortingrule", + "dw/catalog" + ], + "title": "SortingRule" + }, + { + "id": "script-api:dw/catalog/SortingRule#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingRule", + "qualifiedName": "dw.catalog.SortingRule.ID", + "tags": [ + "id", + "sortingrule.id" + ], + "title": "SortingRule.ID" + }, + { + "id": "script-api:dw/catalog/SortingRule#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingRule", + "qualifiedName": "dw.catalog.SortingRule.getID", + "tags": [ + "getid", + "sortingrule.getid" + ], + "title": "SortingRule.getID" + }, + { + "id": "script-api:dw/catalog/Store", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Store", + "tags": [ + "store", + "dw.catalog.store", + "dw/catalog" + ], + "title": "Store" + }, + { + "id": "script-api:dw/catalog/Store#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.ID", + "tags": [ + "id", + "store.id" + ], + "title": "Store.ID" + }, + { + "id": "script-api:dw/catalog/Store#address1", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.address1", + "tags": [ + "address1", + "store.address1" + ], + "title": "Store.address1" + }, + { + "id": "script-api:dw/catalog/Store#address2", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.address2", + "tags": [ + "address2", + "store.address2" + ], + "title": "Store.address2" + }, + { + "id": "script-api:dw/catalog/Store#city", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.city", + "tags": [ + "city", + "store.city" + ], + "title": "Store.city" + }, + { + "id": "script-api:dw/catalog/Store#countryCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.countryCode", + "tags": [ + "countrycode", + "store.countrycode" + ], + "title": "Store.countryCode" + }, + { + "id": "script-api:dw/catalog/Store#demandwarePosEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.demandwarePosEnabled", + "tags": [ + "demandwareposenabled", + "store.demandwareposenabled" + ], + "title": "Store.demandwarePosEnabled" + }, + { + "id": "script-api:dw/catalog/Store#email", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.email", + "tags": [ + "email", + "store.email" + ], + "title": "Store.email" + }, + { + "id": "script-api:dw/catalog/Store#fax", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.fax", + "tags": [ + "fax", + "store.fax" + ], + "title": "Store.fax" + }, + { + "id": "script-api:dw/catalog/Store#getAddress1", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getAddress1", + "tags": [ + "getaddress1", + "store.getaddress1" + ], + "title": "Store.getAddress1" + }, + { + "id": "script-api:dw/catalog/Store#getAddress2", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getAddress2", + "tags": [ + "getaddress2", + "store.getaddress2" + ], + "title": "Store.getAddress2" + }, + { + "id": "script-api:dw/catalog/Store#getCity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getCity", + "tags": [ + "getcity", + "store.getcity" + ], + "title": "Store.getCity" + }, + { + "id": "script-api:dw/catalog/Store#getCountryCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getCountryCode", + "tags": [ + "getcountrycode", + "store.getcountrycode" + ], + "title": "Store.getCountryCode" + }, + { + "id": "script-api:dw/catalog/Store#getEmail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getEmail", + "tags": [ + "getemail", + "store.getemail" + ], + "title": "Store.getEmail" + }, + { + "id": "script-api:dw/catalog/Store#getFax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getFax", + "tags": [ + "getfax", + "store.getfax" + ], + "title": "Store.getFax" + }, + { + "id": "script-api:dw/catalog/Store#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getID", + "tags": [ + "getid", + "store.getid" + ], + "title": "Store.getID" + }, + { + "id": "script-api:dw/catalog/Store#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getImage", + "tags": [ + "getimage", + "store.getimage" + ], + "title": "Store.getImage" + }, + { + "id": "script-api:dw/catalog/Store#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getInventoryList", + "tags": [ + "getinventorylist", + "store.getinventorylist" + ], + "title": "Store.getInventoryList" + }, + { + "id": "script-api:dw/catalog/Store#getInventoryListID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getInventoryListID", + "tags": [ + "getinventorylistid", + "store.getinventorylistid" + ], + "title": "Store.getInventoryListID" + }, + { + "id": "script-api:dw/catalog/Store#getLatitude", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getLatitude", + "tags": [ + "getlatitude", + "store.getlatitude" + ], + "title": "Store.getLatitude" + }, + { + "id": "script-api:dw/catalog/Store#getLongitude", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getLongitude", + "tags": [ + "getlongitude", + "store.getlongitude" + ], + "title": "Store.getLongitude" + }, + { + "id": "script-api:dw/catalog/Store#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getName", + "tags": [ + "getname", + "store.getname" + ], + "title": "Store.getName" + }, + { + "id": "script-api:dw/catalog/Store#getPhone", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getPhone", + "tags": [ + "getphone", + "store.getphone" + ], + "title": "Store.getPhone" + }, + { + "id": "script-api:dw/catalog/Store#getPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getPostalCode", + "tags": [ + "getpostalcode", + "store.getpostalcode" + ], + "title": "Store.getPostalCode" + }, + { + "id": "script-api:dw/catalog/Store#getStateCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStateCode", + "tags": [ + "getstatecode", + "store.getstatecode" + ], + "title": "Store.getStateCode" + }, + { + "id": "script-api:dw/catalog/Store#getStoreEvents", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreEvents", + "tags": [ + "getstoreevents", + "store.getstoreevents" + ], + "title": "Store.getStoreEvents" + }, + { + "id": "script-api:dw/catalog/Store#getStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreGroups", + "tags": [ + "getstoregroups", + "store.getstoregroups" + ], + "title": "Store.getStoreGroups" + }, + { + "id": "script-api:dw/catalog/Store#getStoreHours", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreHours", + "tags": [ + "getstorehours", + "store.getstorehours" + ], + "title": "Store.getStoreHours" + }, + { + "id": "script-api:dw/catalog/Store#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.image", + "tags": [ + "image", + "store.image" + ], + "title": "Store.image" + }, + { + "id": "script-api:dw/catalog/Store#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.inventoryList", + "tags": [ + "inventorylist", + "store.inventorylist" + ], + "title": "Store.inventoryList" + }, + { + "id": "script-api:dw/catalog/Store#inventoryListID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.inventoryListID", + "tags": [ + "inventorylistid", + "store.inventorylistid" + ], + "title": "Store.inventoryListID" + }, + { + "id": "script-api:dw/catalog/Store#isDemandwarePosEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isDemandwarePosEnabled", + "tags": [ + "isdemandwareposenabled", + "store.isdemandwareposenabled" + ], + "title": "Store.isDemandwarePosEnabled" + }, + { + "id": "script-api:dw/catalog/Store#isPosEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isPosEnabled", + "tags": [ + "isposenabled", + "store.isposenabled" + ], + "title": "Store.isPosEnabled" + }, + { + "id": "script-api:dw/catalog/Store#isStoreLocatorEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isStoreLocatorEnabled", + "tags": [ + "isstorelocatorenabled", + "store.isstorelocatorenabled" + ], + "title": "Store.isStoreLocatorEnabled" + }, + { + "id": "script-api:dw/catalog/Store#latitude", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.latitude", + "tags": [ + "latitude", + "store.latitude" + ], + "title": "Store.latitude" + }, + { + "id": "script-api:dw/catalog/Store#longitude", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.longitude", + "tags": [ + "longitude", + "store.longitude" + ], + "title": "Store.longitude" + }, + { + "id": "script-api:dw/catalog/Store#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.name", + "tags": [ + "name", + "store.name" + ], + "title": "Store.name" + }, + { + "id": "script-api:dw/catalog/Store#phone", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.phone", + "tags": [ + "phone", + "store.phone" + ], + "title": "Store.phone" + }, + { + "id": "script-api:dw/catalog/Store#posEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.posEnabled", + "tags": [ + "posenabled", + "store.posenabled" + ], + "title": "Store.posEnabled" + }, + { + "id": "script-api:dw/catalog/Store#postalCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.postalCode", + "tags": [ + "postalcode", + "store.postalcode" + ], + "title": "Store.postalCode" + }, + { + "id": "script-api:dw/catalog/Store#stateCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.stateCode", + "tags": [ + "statecode", + "store.statecode" + ], + "title": "Store.stateCode" + }, + { + "id": "script-api:dw/catalog/Store#storeEvents", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeEvents", + "tags": [ + "storeevents", + "store.storeevents" + ], + "title": "Store.storeEvents" + }, + { + "id": "script-api:dw/catalog/Store#storeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeGroups", + "tags": [ + "storegroups", + "store.storegroups" + ], + "title": "Store.storeGroups" + }, + { + "id": "script-api:dw/catalog/Store#storeHours", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeHours", + "tags": [ + "storehours", + "store.storehours" + ], + "title": "Store.storeHours" + }, + { + "id": "script-api:dw/catalog/Store#storeLocatorEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeLocatorEnabled", + "tags": [ + "storelocatorenabled", + "store.storelocatorenabled" + ], + "title": "Store.storeLocatorEnabled" + }, + { + "id": "script-api:dw/catalog/StoreGroup", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreGroup", + "tags": [ + "storegroup", + "dw.catalog.storegroup", + "dw/catalog" + ], + "title": "StoreGroup" + }, + { + "id": "script-api:dw/catalog/StoreGroup#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.ID", + "tags": [ + "id", + "storegroup.id" + ], + "title": "StoreGroup.ID" + }, + { + "id": "script-api:dw/catalog/StoreGroup#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getID", + "tags": [ + "getid", + "storegroup.getid" + ], + "title": "StoreGroup.getID" + }, + { + "id": "script-api:dw/catalog/StoreGroup#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getName", + "tags": [ + "getname", + "storegroup.getname" + ], + "title": "StoreGroup.getName" + }, + { + "id": "script-api:dw/catalog/StoreGroup#getStores", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getStores", + "tags": [ + "getstores", + "storegroup.getstores" + ], + "title": "StoreGroup.getStores" + }, + { + "id": "script-api:dw/catalog/StoreGroup#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.name", + "tags": [ + "name", + "storegroup.name" + ], + "title": "StoreGroup.name" + }, + { + "id": "script-api:dw/catalog/StoreGroup#stores", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.stores", + "tags": [ + "stores", + "storegroup.stores" + ], + "title": "StoreGroup.stores" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilter", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreInventoryFilter", + "tags": [ + "storeinventoryfilter", + "dw.catalog.storeinventoryfilter", + "dw/catalog" + ], + "title": "StoreInventoryFilter" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilter#getSemanticURLParameter", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.getSemanticURLParameter", + "tags": [ + "getsemanticurlparameter", + "storeinventoryfilter.getsemanticurlparameter" + ], + "title": "StoreInventoryFilter.getSemanticURLParameter" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilter#getStoreInventoryFilterValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.getStoreInventoryFilterValues", + "tags": [ + "getstoreinventoryfiltervalues", + "storeinventoryfilter.getstoreinventoryfiltervalues" + ], + "title": "StoreInventoryFilter.getStoreInventoryFilterValues" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilter#semanticURLParameter", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.semanticURLParameter", + "tags": [ + "semanticurlparameter", + "storeinventoryfilter.semanticurlparameter" + ], + "title": "StoreInventoryFilter.semanticURLParameter" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilter#storeInventoryFilterValues", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.storeInventoryFilterValues", + "tags": [ + "storeinventoryfiltervalues", + "storeinventoryfilter.storeinventoryfiltervalues" + ], + "title": "StoreInventoryFilter.storeInventoryFilterValues" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilterValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue", + "tags": [ + "storeinventoryfiltervalue", + "dw.catalog.storeinventoryfiltervalue", + "dw/catalog" + ], + "title": "StoreInventoryFilterValue" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilterValue#getInventoryListID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.getInventoryListID", + "tags": [ + "getinventorylistid", + "storeinventoryfiltervalue.getinventorylistid" + ], + "title": "StoreInventoryFilterValue.getInventoryListID" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilterValue#getSemanticInventoryID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.getSemanticInventoryID", + "tags": [ + "getsemanticinventoryid", + "storeinventoryfiltervalue.getsemanticinventoryid" + ], + "title": "StoreInventoryFilterValue.getSemanticInventoryID" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilterValue#inventoryListID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.inventoryListID", + "tags": [ + "inventorylistid", + "storeinventoryfiltervalue.inventorylistid" + ], + "title": "StoreInventoryFilterValue.inventoryListID" + }, + { + "id": "script-api:dw/catalog/StoreInventoryFilterValue#semanticInventoryID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.semanticInventoryID", + "tags": [ + "semanticinventoryid", + "storeinventoryfiltervalue.semanticinventoryid" + ], + "title": "StoreInventoryFilterValue.semanticInventoryID" + }, + { + "id": "script-api:dw/catalog/StoreMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreMgr", + "tags": [ + "storemgr", + "dw.catalog.storemgr", + "dw/catalog" + ], + "title": "StoreMgr" + }, + { + "id": "script-api:dw/catalog/StoreMgr#allStoreGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.allStoreGroups", + "tags": [ + "allstoregroups", + "storemgr.allstoregroups" + ], + "title": "StoreMgr.allStoreGroups" + }, + { + "id": "script-api:dw/catalog/StoreMgr#allStoreGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.allStoreGroups", + "tags": [ + "allstoregroups", + "storemgr.allstoregroups" + ], + "title": "StoreMgr.allStoreGroups" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getAllStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getAllStoreGroups", + "tags": [ + "getallstoregroups", + "storemgr.getallstoregroups" + ], + "title": "StoreMgr.getAllStoreGroups" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getAllStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getAllStoreGroups", + "tags": [ + "getallstoregroups", + "storemgr.getallstoregroups" + ], + "title": "StoreMgr.getAllStoreGroups" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStore", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStore", + "tags": [ + "getstore", + "storemgr.getstore" + ], + "title": "StoreMgr.getStore" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStore", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStore", + "tags": [ + "getstore", + "storemgr.getstore" + ], + "title": "StoreMgr.getStore" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStoreGroup", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreGroup", + "tags": [ + "getstoregroup", + "storemgr.getstoregroup" + ], + "title": "StoreMgr.getStoreGroup" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStoreGroup", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreGroup", + "tags": [ + "getstoregroup", + "storemgr.getstoregroup" + ], + "title": "StoreMgr.getStoreGroup" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStoreIDFromSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreIDFromSession", + "tags": [ + "getstoreidfromsession", + "storemgr.getstoreidfromsession" + ], + "title": "StoreMgr.getStoreIDFromSession" + }, + { + "id": "script-api:dw/catalog/StoreMgr#getStoreIDFromSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreIDFromSession", + "tags": [ + "getstoreidfromsession", + "storemgr.getstoreidfromsession" + ], + "title": "StoreMgr.getStoreIDFromSession" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "id": "script-api:dw/catalog/StoreMgr#setStoreIDToSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.setStoreIDToSession", + "tags": [ + "setstoreidtosession", + "storemgr.setstoreidtosession" + ], + "title": "StoreMgr.setStoreIDToSession" + }, + { + "id": "script-api:dw/catalog/StoreMgr#setStoreIDToSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.setStoreIDToSession", + "tags": [ + "setstoreidtosession", + "storemgr.setstoreidtosession" + ], + "title": "StoreMgr.setStoreIDToSession" + }, + { + "id": "script-api:dw/catalog/StoreMgr#storeIDFromSession", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.storeIDFromSession", + "tags": [ + "storeidfromsession", + "storemgr.storeidfromsession" + ], + "title": "StoreMgr.storeIDFromSession" + }, + { + "id": "script-api:dw/catalog/StoreMgr#storeIDFromSession", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.storeIDFromSession", + "tags": [ + "storeidfromsession", + "storemgr.storeidfromsession" + ], + "title": "StoreMgr.storeIDFromSession" + }, + { + "id": "script-api:dw/catalog/Variant", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Variant", + "tags": [ + "variant", + "dw.catalog.variant", + "dw/catalog" + ], + "title": "Variant" + }, + { + "id": "script-api:dw/catalog/Variant#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.EAN", + "tags": [ + "ean", + "variant.ean" + ], + "title": "Variant.EAN" + }, + { + "id": "script-api:dw/catalog/Variant#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.UPC", + "tags": [ + "upc", + "variant.upc" + ], + "title": "Variant.UPC" + }, + { + "id": "script-api:dw/catalog/Variant#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.allProductLinks", + "tags": [ + "allproductlinks", + "variant.allproductlinks" + ], + "title": "Variant.allProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.brand", + "tags": [ + "brand", + "variant.brand" + ], + "title": "Variant.brand" + }, + { + "id": "script-api:dw/catalog/Variant#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.classificationCategory", + "tags": [ + "classificationcategory", + "variant.classificationcategory" + ], + "title": "Variant.classificationCategory" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getBrand", + "tags": [ + "getbrand", + "variant.getbrand" + ], + "title": "Variant.getBrand" + }, + { + "id": "script-api:dw/catalog/Variant#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getClassificationCategory", + "tags": [ + "getclassificationcategory", + "variant.getclassificationcategory" + ], + "title": "Variant.getClassificationCategory" + }, + { + "id": "script-api:dw/catalog/Variant#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getEAN", + "tags": [ + "getean", + "variant.getean" + ], + "title": "Variant.getEAN" + }, + { + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "id": "script-api:dw/catalog/Variant#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getLongDescription", + "tags": [ + "getlongdescription", + "variant.getlongdescription" + ], + "title": "Variant.getLongDescription" + }, + { + "id": "script-api:dw/catalog/Variant#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getManufacturerName", + "tags": [ + "getmanufacturername", + "variant.getmanufacturername" + ], + "title": "Variant.getManufacturerName" + }, + { + "id": "script-api:dw/catalog/Variant#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getManufacturerSKU", + "tags": [ + "getmanufacturersku", + "variant.getmanufacturersku" + ], + "title": "Variant.getManufacturerSKU" + }, + { + "id": "script-api:dw/catalog/Variant#getMasterProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getMasterProduct", + "tags": [ + "getmasterproduct", + "variant.getmasterproduct" + ], + "title": "Variant.getMasterProduct" + }, + { + "id": "script-api:dw/catalog/Variant#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getName", + "tags": [ + "getname", + "variant.getname" + ], + "title": "Variant.getName" + }, + { + "id": "script-api:dw/catalog/Variant#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getOnlineFrom", + "tags": [ + "getonlinefrom", + "variant.getonlinefrom" + ], + "title": "Variant.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/Variant#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getOnlineTo", + "tags": [ + "getonlineto", + "variant.getonlineto" + ], + "title": "Variant.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/Variant#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageDescription", + "tags": [ + "getpagedescription", + "variant.getpagedescription" + ], + "title": "Variant.getPageDescription" + }, + { + "id": "script-api:dw/catalog/Variant#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageKeywords", + "tags": [ + "getpagekeywords", + "variant.getpagekeywords" + ], + "title": "Variant.getPageKeywords" + }, + { + "id": "script-api:dw/catalog/Variant#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageTitle", + "tags": [ + "getpagetitle", + "variant.getpagetitle" + ], + "title": "Variant.getPageTitle" + }, + { + "id": "script-api:dw/catalog/Variant#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageURL", + "tags": [ + "getpageurl", + "variant.getpageurl" + ], + "title": "Variant.getPageURL" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getRecommendations", + "tags": [ + "getrecommendations", + "variant.getrecommendations" + ], + "title": "Variant.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Variant#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getRecommendations", + "tags": [ + "getrecommendations", + "variant.getrecommendations" + ], + "title": "Variant.getRecommendations" + }, + { + "id": "script-api:dw/catalog/Variant#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getShortDescription", + "tags": [ + "getshortdescription", + "variant.getshortdescription" + ], + "title": "Variant.getShortDescription" + }, + { + "id": "script-api:dw/catalog/Variant#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getTaxClassID", + "tags": [ + "gettaxclassid", + "variant.gettaxclassid" + ], + "title": "Variant.getTaxClassID" + }, + { + "id": "script-api:dw/catalog/Variant#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getTemplate", + "tags": [ + "gettemplate", + "variant.gettemplate" + ], + "title": "Variant.getTemplate" + }, + { + "id": "script-api:dw/catalog/Variant#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getThumbnail", + "tags": [ + "getthumbnail", + "variant.getthumbnail" + ], + "title": "Variant.getThumbnail" + }, + { + "id": "script-api:dw/catalog/Variant#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUPC", + "tags": [ + "getupc", + "variant.getupc" + ], + "title": "Variant.getUPC" + }, + { + "id": "script-api:dw/catalog/Variant#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUnit", + "tags": [ + "getunit", + "variant.getunit" + ], + "title": "Variant.getUnit" + }, + { + "id": "script-api:dw/catalog/Variant#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUnitQuantity", + "tags": [ + "getunitquantity", + "variant.getunitquantity" + ], + "title": "Variant.getUnitQuantity" + }, + { + "id": "script-api:dw/catalog/Variant#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.image", + "tags": [ + "image", + "variant.image" + ], + "title": "Variant.image" + }, + { + "id": "script-api:dw/catalog/Variant#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.isOptionProduct", + "tags": [ + "isoptionproduct", + "variant.isoptionproduct" + ], + "title": "Variant.isOptionProduct" + }, + { + "id": "script-api:dw/catalog/Variant#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.longDescription", + "tags": [ + "longdescription", + "variant.longdescription" + ], + "title": "Variant.longDescription" + }, + { + "id": "script-api:dw/catalog/Variant#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.manufacturerName", + "tags": [ + "manufacturername", + "variant.manufacturername" + ], + "title": "Variant.manufacturerName" + }, + { + "id": "script-api:dw/catalog/Variant#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.manufacturerSKU", + "tags": [ + "manufacturersku", + "variant.manufacturersku" + ], + "title": "Variant.manufacturerSKU" + }, + { + "id": "script-api:dw/catalog/Variant#masterProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.masterProduct", + "tags": [ + "masterproduct", + "variant.masterproduct" + ], + "title": "Variant.masterProduct" + }, + { + "id": "script-api:dw/catalog/Variant#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.name", + "tags": [ + "name", + "variant.name" + ], + "title": "Variant.name" + }, + { + "id": "script-api:dw/catalog/Variant#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.onlineFrom", + "tags": [ + "onlinefrom", + "variant.onlinefrom" + ], + "title": "Variant.onlineFrom" + }, + { + "id": "script-api:dw/catalog/Variant#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.onlineTo", + "tags": [ + "onlineto", + "variant.onlineto" + ], + "title": "Variant.onlineTo" + }, + { + "id": "script-api:dw/catalog/Variant#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.optionProduct", + "tags": [ + "optionproduct", + "variant.optionproduct" + ], + "title": "Variant.optionProduct" + }, + { + "id": "script-api:dw/catalog/Variant#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageDescription", + "tags": [ + "pagedescription", + "variant.pagedescription" + ], + "title": "Variant.pageDescription" + }, + { + "id": "script-api:dw/catalog/Variant#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageKeywords", + "tags": [ + "pagekeywords", + "variant.pagekeywords" + ], + "title": "Variant.pageKeywords" + }, + { + "id": "script-api:dw/catalog/Variant#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageTitle", + "tags": [ + "pagetitle", + "variant.pagetitle" + ], + "title": "Variant.pageTitle" + }, + { + "id": "script-api:dw/catalog/Variant#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageURL", + "tags": [ + "pageurl", + "variant.pageurl" + ], + "title": "Variant.pageURL" + }, + { + "id": "script-api:dw/catalog/Variant#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.productLinks", + "tags": [ + "productlinks", + "variant.productlinks" + ], + "title": "Variant.productLinks" + }, + { + "id": "script-api:dw/catalog/Variant#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.shortDescription", + "tags": [ + "shortdescription", + "variant.shortdescription" + ], + "title": "Variant.shortDescription" + }, + { + "id": "script-api:dw/catalog/Variant#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.taxClassID", + "tags": [ + "taxclassid", + "variant.taxclassid" + ], + "title": "Variant.taxClassID" + }, + { + "id": "script-api:dw/catalog/Variant#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.template", + "tags": [ + "template", + "variant.template" + ], + "title": "Variant.template" + }, + { + "id": "script-api:dw/catalog/Variant#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.thumbnail", + "tags": [ + "thumbnail", + "variant.thumbnail" + ], + "title": "Variant.thumbnail" + }, + { + "id": "script-api:dw/catalog/Variant#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.unit", + "tags": [ + "unit", + "variant.unit" + ], + "title": "Variant.unit" + }, + { + "id": "script-api:dw/catalog/Variant#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.unitQuantity", + "tags": [ + "unitquantity", + "variant.unitquantity" + ], + "title": "Variant.unitQuantity" + }, + { + "id": "script-api:dw/catalog/VariationGroup", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.VariationGroup", + "tags": [ + "variationgroup", + "dw.catalog.variationgroup", + "dw/catalog" + ], + "title": "VariationGroup" + }, + { + "id": "script-api:dw/catalog/VariationGroup#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.EAN", + "tags": [ + "ean", + "variationgroup.ean" + ], + "title": "VariationGroup.EAN" + }, + { + "id": "script-api:dw/catalog/VariationGroup#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.UPC", + "tags": [ + "upc", + "variationgroup.upc" + ], + "title": "VariationGroup.UPC" + }, + { + "id": "script-api:dw/catalog/VariationGroup#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.allProductLinks", + "tags": [ + "allproductlinks", + "variationgroup.allproductlinks" + ], + "title": "VariationGroup.allProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.brand", + "tags": [ + "brand", + "variationgroup.brand" + ], + "title": "VariationGroup.brand" + }, + { + "id": "script-api:dw/catalog/VariationGroup#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.classificationCategory", + "tags": [ + "classificationcategory", + "variationgroup.classificationcategory" + ], + "title": "VariationGroup.classificationCategory" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getBrand", + "tags": [ + "getbrand", + "variationgroup.getbrand" + ], + "title": "VariationGroup.getBrand" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getClassificationCategory", + "tags": [ + "getclassificationcategory", + "variationgroup.getclassificationcategory" + ], + "title": "VariationGroup.getClassificationCategory" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getEAN", + "tags": [ + "getean", + "variationgroup.getean" + ], + "title": "VariationGroup.getEAN" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getLongDescription", + "tags": [ + "getlongdescription", + "variationgroup.getlongdescription" + ], + "title": "VariationGroup.getLongDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getManufacturerName", + "tags": [ + "getmanufacturername", + "variationgroup.getmanufacturername" + ], + "title": "VariationGroup.getManufacturerName" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getManufacturerSKU", + "tags": [ + "getmanufacturersku", + "variationgroup.getmanufacturersku" + ], + "title": "VariationGroup.getManufacturerSKU" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getMasterProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getMasterProduct", + "tags": [ + "getmasterproduct", + "variationgroup.getmasterproduct" + ], + "title": "VariationGroup.getMasterProduct" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getName", + "tags": [ + "getname", + "variationgroup.getname" + ], + "title": "VariationGroup.getName" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getOnlineFrom", + "tags": [ + "getonlinefrom", + "variationgroup.getonlinefrom" + ], + "title": "VariationGroup.getOnlineFrom" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getOnlineTo", + "tags": [ + "getonlineto", + "variationgroup.getonlineto" + ], + "title": "VariationGroup.getOnlineTo" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageDescription", + "tags": [ + "getpagedescription", + "variationgroup.getpagedescription" + ], + "title": "VariationGroup.getPageDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageKeywords", + "tags": [ + "getpagekeywords", + "variationgroup.getpagekeywords" + ], + "title": "VariationGroup.getPageKeywords" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageTitle", + "tags": [ + "getpagetitle", + "variationgroup.getpagetitle" + ], + "title": "VariationGroup.getPageTitle" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageURL", + "tags": [ + "getpageurl", + "variationgroup.getpageurl" + ], + "title": "VariationGroup.getPageURL" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getRecommendations", + "tags": [ + "getrecommendations", + "variationgroup.getrecommendations" + ], + "title": "VariationGroup.getRecommendations" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getRecommendations", + "tags": [ + "getrecommendations", + "variationgroup.getrecommendations" + ], + "title": "VariationGroup.getRecommendations" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getShortDescription", + "tags": [ + "getshortdescription", + "variationgroup.getshortdescription" + ], + "title": "VariationGroup.getShortDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getTaxClassID", + "tags": [ + "gettaxclassid", + "variationgroup.gettaxclassid" + ], + "title": "VariationGroup.getTaxClassID" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getTemplate", + "tags": [ + "gettemplate", + "variationgroup.gettemplate" + ], + "title": "VariationGroup.getTemplate" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getThumbnail", + "tags": [ + "getthumbnail", + "variationgroup.getthumbnail" + ], + "title": "VariationGroup.getThumbnail" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUPC", + "tags": [ + "getupc", + "variationgroup.getupc" + ], + "title": "VariationGroup.getUPC" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUnit", + "tags": [ + "getunit", + "variationgroup.getunit" + ], + "title": "VariationGroup.getUnit" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUnitQuantity", + "tags": [ + "getunitquantity", + "variationgroup.getunitquantity" + ], + "title": "VariationGroup.getUnitQuantity" + }, + { + "id": "script-api:dw/catalog/VariationGroup#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.image", + "tags": [ + "image", + "variationgroup.image" + ], + "title": "VariationGroup.image" + }, + { + "id": "script-api:dw/catalog/VariationGroup#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.isOptionProduct", + "tags": [ + "isoptionproduct", + "variationgroup.isoptionproduct" + ], + "title": "VariationGroup.isOptionProduct" + }, + { + "id": "script-api:dw/catalog/VariationGroup#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.longDescription", + "tags": [ + "longdescription", + "variationgroup.longdescription" + ], + "title": "VariationGroup.longDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.manufacturerName", + "tags": [ + "manufacturername", + "variationgroup.manufacturername" + ], + "title": "VariationGroup.manufacturerName" + }, + { + "id": "script-api:dw/catalog/VariationGroup#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.manufacturerSKU", + "tags": [ + "manufacturersku", + "variationgroup.manufacturersku" + ], + "title": "VariationGroup.manufacturerSKU" + }, + { + "id": "script-api:dw/catalog/VariationGroup#masterProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.masterProduct", + "tags": [ + "masterproduct", + "variationgroup.masterproduct" + ], + "title": "VariationGroup.masterProduct" + }, + { + "id": "script-api:dw/catalog/VariationGroup#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.name", + "tags": [ + "name", + "variationgroup.name" + ], + "title": "VariationGroup.name" + }, + { + "id": "script-api:dw/catalog/VariationGroup#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.onlineFrom", + "tags": [ + "onlinefrom", + "variationgroup.onlinefrom" + ], + "title": "VariationGroup.onlineFrom" + }, + { + "id": "script-api:dw/catalog/VariationGroup#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.onlineTo", + "tags": [ + "onlineto", + "variationgroup.onlineto" + ], + "title": "VariationGroup.onlineTo" + }, + { + "id": "script-api:dw/catalog/VariationGroup#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.optionProduct", + "tags": [ + "optionproduct", + "variationgroup.optionproduct" + ], + "title": "VariationGroup.optionProduct" + }, + { + "id": "script-api:dw/catalog/VariationGroup#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageDescription", + "tags": [ + "pagedescription", + "variationgroup.pagedescription" + ], + "title": "VariationGroup.pageDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageKeywords", + "tags": [ + "pagekeywords", + "variationgroup.pagekeywords" + ], + "title": "VariationGroup.pageKeywords" + }, + { + "id": "script-api:dw/catalog/VariationGroup#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageTitle", + "tags": [ + "pagetitle", + "variationgroup.pagetitle" + ], + "title": "VariationGroup.pageTitle" + }, + { + "id": "script-api:dw/catalog/VariationGroup#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageURL", + "tags": [ + "pageurl", + "variationgroup.pageurl" + ], + "title": "VariationGroup.pageURL" + }, + { + "id": "script-api:dw/catalog/VariationGroup#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.productLinks", + "tags": [ + "productlinks", + "variationgroup.productlinks" + ], + "title": "VariationGroup.productLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.shortDescription", + "tags": [ + "shortdescription", + "variationgroup.shortdescription" + ], + "title": "VariationGroup.shortDescription" + }, + { + "id": "script-api:dw/catalog/VariationGroup#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.taxClassID", + "tags": [ + "taxclassid", + "variationgroup.taxclassid" + ], + "title": "VariationGroup.taxClassID" + }, + { + "id": "script-api:dw/catalog/VariationGroup#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.template", + "tags": [ + "template", + "variationgroup.template" + ], + "title": "VariationGroup.template" + }, + { + "id": "script-api:dw/catalog/VariationGroup#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.thumbnail", + "tags": [ + "thumbnail", + "variationgroup.thumbnail" + ], + "title": "VariationGroup.thumbnail" + }, + { + "id": "script-api:dw/catalog/VariationGroup#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.unit", + "tags": [ + "unit", + "variationgroup.unit" + ], + "title": "VariationGroup.unit" + }, + { + "id": "script-api:dw/catalog/VariationGroup#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.unitQuantity", + "tags": [ + "unitquantity", + "variationgroup.unitquantity" + ], + "title": "VariationGroup.unitQuantity" + }, + { + "id": "script-api:dw/content", + "kind": "package", + "packagePath": "dw/content", + "qualifiedName": "dw.content", + "tags": [ + "dw/content", + "dw.content" + ], + "title": "dw.content" + }, + { + "id": "script-api:dw/content/Content", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Content", + "tags": [ + "content", + "dw.content.content", + "dw/content" + ], + "title": "Content" + }, + { + "id": "script-api:dw/content/Content#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.ID", + "tags": [ + "id", + "content.id" + ], + "title": "Content.ID" + }, + { + "id": "script-api:dw/content/Content#classificationFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.classificationFolder", + "tags": [ + "classificationfolder", + "content.classificationfolder" + ], + "title": "Content.classificationFolder" + }, + { + "id": "script-api:dw/content/Content#description", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.description", + "tags": [ + "description", + "content.description" + ], + "title": "Content.description" + }, + { + "id": "script-api:dw/content/Content#folders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.folders", + "tags": [ + "folders", + "content.folders" + ], + "title": "Content.folders" + }, + { + "id": "script-api:dw/content/Content#getClassificationFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getClassificationFolder", + "tags": [ + "getclassificationfolder", + "content.getclassificationfolder" + ], + "title": "Content.getClassificationFolder" + }, + { + "id": "script-api:dw/content/Content#getDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getDescription", + "tags": [ + "getdescription", + "content.getdescription" + ], + "title": "Content.getDescription" + }, + { + "id": "script-api:dw/content/Content#getFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getFolders", + "tags": [ + "getfolders", + "content.getfolders" + ], + "title": "Content.getFolders" + }, + { + "id": "script-api:dw/content/Content#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getID", + "tags": [ + "getid", + "content.getid" + ], + "title": "Content.getID" + }, + { + "id": "script-api:dw/content/Content#getName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getName", + "tags": [ + "getname", + "content.getname" + ], + "title": "Content.getName" + }, + { + "id": "script-api:dw/content/Content#getOnlineFlag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getOnlineFlag", + "tags": [ + "getonlineflag", + "content.getonlineflag" + ], + "title": "Content.getOnlineFlag" + }, + { + "id": "script-api:dw/content/Content#getPageDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageDescription", + "tags": [ + "getpagedescription", + "content.getpagedescription" + ], + "title": "Content.getPageDescription" + }, + { + "id": "script-api:dw/content/Content#getPageKeywords", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageKeywords", + "tags": [ + "getpagekeywords", + "content.getpagekeywords" + ], + "title": "Content.getPageKeywords" + }, + { + "id": "script-api:dw/content/Content#getPageMetaTag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageMetaTag", + "tags": [ + "getpagemetatag", + "content.getpagemetatag" + ], + "title": "Content.getPageMetaTag" + }, + { + "id": "script-api:dw/content/Content#getPageMetaTags", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageMetaTags", + "tags": [ + "getpagemetatags", + "content.getpagemetatags" + ], + "title": "Content.getPageMetaTags" + }, + { + "id": "script-api:dw/content/Content#getPageTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageTitle", + "tags": [ + "getpagetitle", + "content.getpagetitle" + ], + "title": "Content.getPageTitle" + }, + { + "id": "script-api:dw/content/Content#getPageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageURL", + "tags": [ + "getpageurl", + "content.getpageurl" + ], + "title": "Content.getPageURL" + }, + { + "id": "script-api:dw/content/Content#getSearchableFlag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSearchableFlag", + "tags": [ + "getsearchableflag", + "content.getsearchableflag" + ], + "title": "Content.getSearchableFlag" + }, + { + "id": "script-api:dw/content/Content#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapChangeFrequency", + "tags": [ + "getsitemapchangefrequency", + "content.getsitemapchangefrequency" + ], + "title": "Content.getSiteMapChangeFrequency" + }, + { + "id": "script-api:dw/content/Content#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapIncluded", + "tags": [ + "getsitemapincluded", + "content.getsitemapincluded" + ], + "title": "Content.getSiteMapIncluded" + }, + { + "id": "script-api:dw/content/Content#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapPriority", + "tags": [ + "getsitemappriority", + "content.getsitemappriority" + ], + "title": "Content.getSiteMapPriority" + }, + { + "id": "script-api:dw/content/Content#getTemplate", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getTemplate", + "tags": [ + "gettemplate", + "content.gettemplate" + ], + "title": "Content.getTemplate" + }, + { + "id": "script-api:dw/content/Content#isOnline", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isOnline", + "tags": [ + "isonline", + "content.isonline" + ], + "title": "Content.isOnline" + }, + { + "id": "script-api:dw/content/Content#isPage", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isPage", + "tags": [ + "ispage", + "content.ispage" + ], + "title": "Content.isPage" + }, + { + "id": "script-api:dw/content/Content#isSearchable", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isSearchable", + "tags": [ + "issearchable", + "content.issearchable" + ], + "title": "Content.isSearchable" + }, + { + "id": "script-api:dw/content/Content#name", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.name", + "tags": [ + "name", + "content.name" + ], + "title": "Content.name" + }, + { + "id": "script-api:dw/content/Content#online", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.online", + "tags": [ + "online", + "content.online" + ], + "title": "Content.online" + }, + { + "id": "script-api:dw/content/Content#onlineFlag", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.onlineFlag", + "tags": [ + "onlineflag", + "content.onlineflag" + ], + "title": "Content.onlineFlag" + }, + { + "id": "script-api:dw/content/Content#page", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.page", + "tags": [ + "page", + "content.page" + ], + "title": "Content.page" + }, + { + "id": "script-api:dw/content/Content#pageDescription", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageDescription", + "tags": [ + "pagedescription", + "content.pagedescription" + ], + "title": "Content.pageDescription" + }, + { + "id": "script-api:dw/content/Content#pageKeywords", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageKeywords", + "tags": [ + "pagekeywords", + "content.pagekeywords" + ], + "title": "Content.pageKeywords" + }, + { + "id": "script-api:dw/content/Content#pageMetaTags", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageMetaTags", + "tags": [ + "pagemetatags", + "content.pagemetatags" + ], + "title": "Content.pageMetaTags" + }, + { + "id": "script-api:dw/content/Content#pageTitle", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageTitle", + "tags": [ + "pagetitle", + "content.pagetitle" + ], + "title": "Content.pageTitle" + }, + { + "id": "script-api:dw/content/Content#pageURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageURL", + "tags": [ + "pageurl", + "content.pageurl" + ], + "title": "Content.pageURL" + }, + { + "id": "script-api:dw/content/Content#searchable", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.searchable", + "tags": [ + "searchable", + "content.searchable" + ], + "title": "Content.searchable" + }, + { + "id": "script-api:dw/content/Content#searchableFlag", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.searchableFlag", + "tags": [ + "searchableflag", + "content.searchableflag" + ], + "title": "Content.searchableFlag" + }, + { + "id": "script-api:dw/content/Content#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapChangeFrequency", + "tags": [ + "sitemapchangefrequency", + "content.sitemapchangefrequency" + ], + "title": "Content.siteMapChangeFrequency" + }, + { + "id": "script-api:dw/content/Content#siteMapIncluded", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapIncluded", + "tags": [ + "sitemapincluded", + "content.sitemapincluded" + ], + "title": "Content.siteMapIncluded" + }, + { + "id": "script-api:dw/content/Content#siteMapPriority", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapPriority", + "tags": [ + "sitemappriority", + "content.sitemappriority" + ], + "title": "Content.siteMapPriority" + }, + { + "id": "script-api:dw/content/Content#template", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.template", + "tags": [ + "template", + "content.template" + ], + "title": "Content.template" + }, + { + "id": "script-api:dw/content/Content#toPage", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.toPage", + "tags": [ + "topage", + "content.topage" + ], + "title": "Content.toPage" + }, + { + "id": "script-api:dw/content/ContentMgr", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentMgr", + "tags": [ + "contentmgr", + "dw.content.contentmgr", + "dw/content" + ], + "title": "ContentMgr" + }, + { + "id": "script-api:dw/content/ContentMgr#PRIVATE_LIBRARY", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.PRIVATE_LIBRARY", + "tags": [ + "private_library", + "contentmgr.private_library" + ], + "title": "ContentMgr.PRIVATE_LIBRARY" + }, + { + "id": "script-api:dw/content/ContentMgr#PRIVATE_LIBRARY", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.PRIVATE_LIBRARY", + "tags": [ + "private_library", + "contentmgr.private_library" + ], + "title": "ContentMgr.PRIVATE_LIBRARY" + }, + { + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "id": "script-api:dw/content/ContentMgr#getLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getLibrary", + "tags": [ + "getlibrary", + "contentmgr.getlibrary" + ], + "title": "ContentMgr.getLibrary" + }, + { + "id": "script-api:dw/content/ContentMgr#getLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getLibrary", + "tags": [ + "getlibrary", + "contentmgr.getlibrary" + ], + "title": "ContentMgr.getLibrary" + }, + { + "id": "script-api:dw/content/ContentMgr#getSiteLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getSiteLibrary", + "tags": [ + "getsitelibrary", + "contentmgr.getsitelibrary" + ], + "title": "ContentMgr.getSiteLibrary" + }, + { + "id": "script-api:dw/content/ContentMgr#getSiteLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getSiteLibrary", + "tags": [ + "getsitelibrary", + "contentmgr.getsitelibrary" + ], + "title": "ContentMgr.getSiteLibrary" + }, + { + "id": "script-api:dw/content/ContentMgr#siteLibrary", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.siteLibrary", + "tags": [ + "sitelibrary", + "contentmgr.sitelibrary" + ], + "title": "ContentMgr.siteLibrary" + }, + { + "id": "script-api:dw/content/ContentMgr#siteLibrary", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.siteLibrary", + "tags": [ + "sitelibrary", + "contentmgr.sitelibrary" + ], + "title": "ContentMgr.siteLibrary" + }, + { + "id": "script-api:dw/content/ContentSearchModel", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchModel", + "tags": [ + "contentsearchmodel", + "dw.content.contentsearchmodel", + "dw/content" + ], + "title": "ContentSearchModel" + }, + { + "id": "script-api:dw/content/ContentSearchModel#CONTENTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.CONTENTID_PARAMETER", + "tags": [ + "contentid_parameter", + "contentsearchmodel.contentid_parameter" + ], + "title": "ContentSearchModel.CONTENTID_PARAMETER" + }, + { + "id": "script-api:dw/content/ContentSearchModel#CONTENTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.CONTENTID_PARAMETER", + "tags": [ + "contentid_parameter", + "contentsearchmodel.contentid_parameter" + ], + "title": "ContentSearchModel.CONTENTID_PARAMETER" + }, + { + "id": "script-api:dw/content/ContentSearchModel#FOLDERID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.FOLDERID_PARAMETER", + "tags": [ + "folderid_parameter", + "contentsearchmodel.folderid_parameter" + ], + "title": "ContentSearchModel.FOLDERID_PARAMETER" + }, + { + "id": "script-api:dw/content/ContentSearchModel#FOLDERID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.FOLDERID_PARAMETER", + "tags": [ + "folderid_parameter", + "contentsearchmodel.folderid_parameter" + ], + "title": "ContentSearchModel.FOLDERID_PARAMETER" + }, + { + "id": "script-api:dw/content/ContentSearchModel#content", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.content", + "tags": [ + "content", + "contentsearchmodel.content" + ], + "title": "ContentSearchModel.content" + }, + { + "id": "script-api:dw/content/ContentSearchModel#contentID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.contentID", + "tags": [ + "contentid", + "contentsearchmodel.contentid" + ], + "title": "ContentSearchModel.contentID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#deepestCommonFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.deepestCommonFolder", + "tags": [ + "deepestcommonfolder", + "contentsearchmodel.deepestcommonfolder" + ], + "title": "ContentSearchModel.deepestCommonFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#filteredByFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.filteredByFolder", + "tags": [ + "filteredbyfolder", + "contentsearchmodel.filteredbyfolder" + ], + "title": "ContentSearchModel.filteredByFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#folder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folder", + "tags": [ + "folder", + "contentsearchmodel.folder" + ], + "title": "ContentSearchModel.folder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#folderID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folderID", + "tags": [ + "folderid", + "contentsearchmodel.folderid" + ], + "title": "ContentSearchModel.folderID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#folderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folderSearch", + "tags": [ + "foldersearch", + "contentsearchmodel.foldersearch" + ], + "title": "ContentSearchModel.folderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getContent", + "tags": [ + "getcontent", + "contentsearchmodel.getcontent" + ], + "title": "ContentSearchModel.getContent" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getContentID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getContentID", + "tags": [ + "getcontentid", + "contentsearchmodel.getcontentid" + ], + "title": "ContentSearchModel.getContentID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getDeepestCommonFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getDeepestCommonFolder", + "tags": [ + "getdeepestcommonfolder", + "contentsearchmodel.getdeepestcommonfolder" + ], + "title": "ContentSearchModel.getDeepestCommonFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getFolder", + "tags": [ + "getfolder", + "contentsearchmodel.getfolder" + ], + "title": "ContentSearchModel.getFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getFolderID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getFolderID", + "tags": [ + "getfolderid", + "contentsearchmodel.getfolderid" + ], + "title": "ContentSearchModel.getFolderID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getPageMetaTag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getPageMetaTag", + "tags": [ + "getpagemetatag", + "contentsearchmodel.getpagemetatag" + ], + "title": "ContentSearchModel.getPageMetaTag" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getPageMetaTags", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getPageMetaTags", + "tags": [ + "getpagemetatags", + "contentsearchmodel.getpagemetatags" + ], + "title": "ContentSearchModel.getPageMetaTags" + }, + { + "id": "script-api:dw/content/ContentSearchModel#getRefinements", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getRefinements", + "tags": [ + "getrefinements", + "contentsearchmodel.getrefinements" + ], + "title": "ContentSearchModel.getRefinements" + }, + { + "id": "script-api:dw/content/ContentSearchModel#isFilteredByFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isFilteredByFolder", + "tags": [ + "isfilteredbyfolder", + "contentsearchmodel.isfilteredbyfolder" + ], + "title": "ContentSearchModel.isFilteredByFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#isFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isFolderSearch", + "tags": [ + "isfoldersearch", + "contentsearchmodel.isfoldersearch" + ], + "title": "ContentSearchModel.isFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#isRecursiveFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRecursiveFolderSearch", + "tags": [ + "isrecursivefoldersearch", + "contentsearchmodel.isrecursivefoldersearch" + ], + "title": "ContentSearchModel.isRecursiveFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#isRefinedByFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRefinedByFolder", + "tags": [ + "isrefinedbyfolder", + "contentsearchmodel.isrefinedbyfolder" + ], + "title": "ContentSearchModel.isRefinedByFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#isRefinedFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRefinedFolderSearch", + "tags": [ + "isrefinedfoldersearch", + "contentsearchmodel.isrefinedfoldersearch" + ], + "title": "ContentSearchModel.isRefinedFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#pageMetaTags", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.pageMetaTags", + "tags": [ + "pagemetatags", + "contentsearchmodel.pagemetatags" + ], + "title": "ContentSearchModel.pageMetaTags" + }, + { + "id": "script-api:dw/content/ContentSearchModel#recursiveFolderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.recursiveFolderSearch", + "tags": [ + "recursivefoldersearch", + "contentsearchmodel.recursivefoldersearch" + ], + "title": "ContentSearchModel.recursiveFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#refinedByFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinedByFolder", + "tags": [ + "refinedbyfolder", + "contentsearchmodel.refinedbyfolder" + ], + "title": "ContentSearchModel.refinedByFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#refinedFolderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinedFolderSearch", + "tags": [ + "refinedfoldersearch", + "contentsearchmodel.refinedfoldersearch" + ], + "title": "ContentSearchModel.refinedFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#refinements", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinements", + "tags": [ + "refinements", + "contentsearchmodel.refinements" + ], + "title": "ContentSearchModel.refinements" + }, + { + "id": "script-api:dw/content/ContentSearchModel#search", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.search", + "tags": [ + "search", + "contentsearchmodel.search" + ], + "title": "ContentSearchModel.search" + }, + { + "id": "script-api:dw/content/ContentSearchModel#setContentID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setContentID", + "tags": [ + "setcontentid", + "contentsearchmodel.setcontentid" + ], + "title": "ContentSearchModel.setContentID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#setFilteredByFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setFilteredByFolder", + "tags": [ + "setfilteredbyfolder", + "contentsearchmodel.setfilteredbyfolder" + ], + "title": "ContentSearchModel.setFilteredByFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#setFolderID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setFolderID", + "tags": [ + "setfolderid", + "contentsearchmodel.setfolderid" + ], + "title": "ContentSearchModel.setFolderID" + }, + { + "id": "script-api:dw/content/ContentSearchModel#setRecursiveFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setRecursiveFolderSearch", + "tags": [ + "setrecursivefoldersearch", + "contentsearchmodel.setrecursivefoldersearch" + ], + "title": "ContentSearchModel.setRecursiveFolderSearch" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlRefineFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRefineFolder", + "tags": [ + "urlrefinefolder", + "contentsearchmodel.urlrefinefolder" + ], + "title": "ContentSearchModel.urlRefineFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlRefineFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRefineFolder", + "tags": [ + "urlrefinefolder", + "contentsearchmodel.urlrefinefolder" + ], + "title": "ContentSearchModel.urlRefineFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlRelaxFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRelaxFolder", + "tags": [ + "urlrelaxfolder", + "contentsearchmodel.urlrelaxfolder" + ], + "title": "ContentSearchModel.urlRelaxFolder" + }, + { + "id": "script-api:dw/content/ContentSearchModel#urlRelaxFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRelaxFolder", + "tags": [ + "urlrelaxfolder", + "contentsearchmodel.urlrelaxfolder" + ], + "title": "ContentSearchModel.urlRelaxFolder" + }, + { + "id": "script-api:dw/content/ContentSearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition", + "tags": [ + "contentsearchrefinementdefinition", + "dw.content.contentsearchrefinementdefinition", + "dw/content" + ], + "title": "ContentSearchRefinementDefinition" + }, + { + "id": "script-api:dw/content/ContentSearchRefinementDefinition#folderRefinement", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinementDefinition", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition.folderRefinement", + "tags": [ + "folderrefinement", + "contentsearchrefinementdefinition.folderrefinement" + ], + "title": "ContentSearchRefinementDefinition.folderRefinement" + }, + { + "id": "script-api:dw/content/ContentSearchRefinementDefinition#isFolderRefinement", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinementDefinition", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition.isFolderRefinement", + "tags": [ + "isfolderrefinement", + "contentsearchrefinementdefinition.isfolderrefinement" + ], + "title": "ContentSearchRefinementDefinition.isFolderRefinement" + }, + { + "id": "script-api:dw/content/ContentSearchRefinementValue", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinementValue", + "tags": [ + "contentsearchrefinementvalue", + "dw.content.contentsearchrefinementvalue", + "dw/content" + ], + "title": "ContentSearchRefinementValue" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinements", + "tags": [ + "contentsearchrefinements", + "dw.content.contentsearchrefinements", + "dw/content" + ], + "title": "ContentSearchRefinements" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#folderRefinementDefinition", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.folderRefinementDefinition", + "tags": [ + "folderrefinementdefinition", + "contentsearchrefinements.folderrefinementdefinition" + ], + "title": "ContentSearchRefinements.folderRefinementDefinition" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getFolderHits", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getFolderHits", + "tags": [ + "getfolderhits", + "contentsearchrefinements.getfolderhits" + ], + "title": "ContentSearchRefinements.getFolderHits" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getFolderRefinementDefinition", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getFolderRefinementDefinition", + "tags": [ + "getfolderrefinementdefinition", + "contentsearchrefinements.getfolderrefinementdefinition" + ], + "title": "ContentSearchRefinements.getFolderRefinementDefinition" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getMatchingFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getMatchingFolders", + "tags": [ + "getmatchingfolders", + "contentsearchrefinements.getmatchingfolders" + ], + "title": "ContentSearchRefinements.getMatchingFolders" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getNextLevelFolderRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getNextLevelFolderRefinementValues", + "tags": [ + "getnextlevelfolderrefinementvalues", + "contentsearchrefinements.getnextlevelfolderrefinementvalues" + ], + "title": "ContentSearchRefinements.getNextLevelFolderRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValue", + "tags": [ + "getrefinementvalue", + "contentsearchrefinements.getrefinementvalue" + ], + "title": "ContentSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValue", + "tags": [ + "getrefinementvalue", + "contentsearchrefinements.getrefinementvalue" + ], + "title": "ContentSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValues", + "tags": [ + "getrefinementvalues", + "contentsearchrefinements.getrefinementvalues" + ], + "title": "ContentSearchRefinements.getRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValues", + "tags": [ + "getrefinementvalues", + "contentsearchrefinements.getrefinementvalues" + ], + "title": "ContentSearchRefinements.getRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#matchingFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.matchingFolders", + "tags": [ + "matchingfolders", + "contentsearchrefinements.matchingfolders" + ], + "title": "ContentSearchRefinements.matchingFolders" + }, + { + "id": "script-api:dw/content/Folder", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Folder", + "tags": [ + "folder", + "dw.content.folder", + "dw/content" + ], + "title": "Folder" + }, + { + "id": "script-api:dw/content/Folder#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.ID", + "tags": [ + "id", + "folder.id" + ], + "title": "Folder.ID" + }, + { + "id": "script-api:dw/content/Folder#content", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.content", + "tags": [ + "content", + "folder.content" + ], + "title": "Folder.content" + }, + { + "id": "script-api:dw/content/Folder#description", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.description", + "tags": [ + "description", + "folder.description" + ], + "title": "Folder.description" + }, + { + "id": "script-api:dw/content/Folder#displayName", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.displayName", + "tags": [ + "displayname", + "folder.displayname" + ], + "title": "Folder.displayName" + }, + { + "id": "script-api:dw/content/Folder#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getContent", + "tags": [ + "getcontent", + "folder.getcontent" + ], + "title": "Folder.getContent" + }, + { + "id": "script-api:dw/content/Folder#getDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getDescription", + "tags": [ + "getdescription", + "folder.getdescription" + ], + "title": "Folder.getDescription" + }, + { + "id": "script-api:dw/content/Folder#getDisplayName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getDisplayName", + "tags": [ + "getdisplayname", + "folder.getdisplayname" + ], + "title": "Folder.getDisplayName" + }, + { + "id": "script-api:dw/content/Folder#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getID", + "tags": [ + "getid", + "folder.getid" + ], + "title": "Folder.getID" + }, + { + "id": "script-api:dw/content/Folder#getOnlineContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getOnlineContent", + "tags": [ + "getonlinecontent", + "folder.getonlinecontent" + ], + "title": "Folder.getOnlineContent" + }, + { + "id": "script-api:dw/content/Folder#getOnlineSubFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getOnlineSubFolders", + "tags": [ + "getonlinesubfolders", + "folder.getonlinesubfolders" + ], + "title": "Folder.getOnlineSubFolders" + }, + { + "id": "script-api:dw/content/Folder#getPageDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageDescription", + "tags": [ + "getpagedescription", + "folder.getpagedescription" + ], + "title": "Folder.getPageDescription" + }, + { + "id": "script-api:dw/content/Folder#getPageKeywords", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageKeywords", + "tags": [ + "getpagekeywords", + "folder.getpagekeywords" + ], + "title": "Folder.getPageKeywords" + }, + { + "id": "script-api:dw/content/Folder#getPageTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageTitle", + "tags": [ + "getpagetitle", + "folder.getpagetitle" + ], + "title": "Folder.getPageTitle" + }, + { + "id": "script-api:dw/content/Folder#getPageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageURL", + "tags": [ + "getpageurl", + "folder.getpageurl" + ], + "title": "Folder.getPageURL" + }, + { + "id": "script-api:dw/content/Folder#getParent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getParent", + "tags": [ + "getparent", + "folder.getparent" + ], + "title": "Folder.getParent" + }, + { + "id": "script-api:dw/content/Folder#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapChangeFrequency", + "tags": [ + "getsitemapchangefrequency", + "folder.getsitemapchangefrequency" + ], + "title": "Folder.getSiteMapChangeFrequency" + }, + { + "id": "script-api:dw/content/Folder#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapIncluded", + "tags": [ + "getsitemapincluded", + "folder.getsitemapincluded" + ], + "title": "Folder.getSiteMapIncluded" + }, + { + "id": "script-api:dw/content/Folder#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapPriority", + "tags": [ + "getsitemappriority", + "folder.getsitemappriority" + ], + "title": "Folder.getSiteMapPriority" + }, + { + "id": "script-api:dw/content/Folder#getSubFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSubFolders", + "tags": [ + "getsubfolders", + "folder.getsubfolders" + ], + "title": "Folder.getSubFolders" + }, + { + "id": "script-api:dw/content/Folder#getTemplate", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getTemplate", + "tags": [ + "gettemplate", + "folder.gettemplate" + ], + "title": "Folder.getTemplate" + }, + { + "id": "script-api:dw/content/Folder#isOnline", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.isOnline", + "tags": [ + "isonline", + "folder.isonline" + ], + "title": "Folder.isOnline" + }, + { + "id": "script-api:dw/content/Folder#isRoot", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.isRoot", + "tags": [ + "isroot", + "folder.isroot" + ], + "title": "Folder.isRoot" + }, + { + "id": "script-api:dw/content/Folder#online", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.online", + "tags": [ + "online", + "folder.online" + ], + "title": "Folder.online" + }, + { + "id": "script-api:dw/content/Folder#onlineContent", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.onlineContent", + "tags": [ + "onlinecontent", + "folder.onlinecontent" + ], + "title": "Folder.onlineContent" + }, + { + "id": "script-api:dw/content/Folder#onlineSubFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.onlineSubFolders", + "tags": [ + "onlinesubfolders", + "folder.onlinesubfolders" + ], + "title": "Folder.onlineSubFolders" + }, + { + "id": "script-api:dw/content/Folder#pageDescription", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageDescription", + "tags": [ + "pagedescription", + "folder.pagedescription" + ], + "title": "Folder.pageDescription" + }, + { + "id": "script-api:dw/content/Folder#pageKeywords", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageKeywords", + "tags": [ + "pagekeywords", + "folder.pagekeywords" + ], + "title": "Folder.pageKeywords" + }, + { + "id": "script-api:dw/content/Folder#pageTitle", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageTitle", + "tags": [ + "pagetitle", + "folder.pagetitle" + ], + "title": "Folder.pageTitle" + }, + { + "id": "script-api:dw/content/Folder#pageURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageURL", + "tags": [ + "pageurl", + "folder.pageurl" + ], + "title": "Folder.pageURL" + }, + { + "id": "script-api:dw/content/Folder#parent", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.parent", + "tags": [ + "parent", + "folder.parent" + ], + "title": "Folder.parent" + }, + { + "id": "script-api:dw/content/Folder#root", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.root", + "tags": [ + "root", + "folder.root" + ], + "title": "Folder.root" + }, + { + "id": "script-api:dw/content/Folder#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapChangeFrequency", + "tags": [ + "sitemapchangefrequency", + "folder.sitemapchangefrequency" + ], + "title": "Folder.siteMapChangeFrequency" + }, + { + "id": "script-api:dw/content/Folder#siteMapIncluded", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapIncluded", + "tags": [ + "sitemapincluded", + "folder.sitemapincluded" + ], + "title": "Folder.siteMapIncluded" + }, + { + "id": "script-api:dw/content/Folder#siteMapPriority", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapPriority", + "tags": [ + "sitemappriority", + "folder.sitemappriority" + ], + "title": "Folder.siteMapPriority" + }, + { + "id": "script-api:dw/content/Folder#subFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.subFolders", + "tags": [ + "subfolders", + "folder.subfolders" + ], + "title": "Folder.subFolders" + }, + { + "id": "script-api:dw/content/Folder#template", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.template", + "tags": [ + "template", + "folder.template" + ], + "title": "Folder.template" + }, + { + "id": "script-api:dw/content/Library", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Library", + "tags": [ + "library", + "dw.content.library", + "dw/content" + ], + "title": "Library" + }, + { + "id": "script-api:dw/content/Library#CMSChannelID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.CMSChannelID", + "tags": [ + "cmschannelid", + "library.cmschannelid" + ], + "title": "Library.CMSChannelID" + }, + { + "id": "script-api:dw/content/Library#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.ID", + "tags": [ + "id", + "library.id" + ], + "title": "Library.ID" + }, + { + "id": "script-api:dw/content/Library#displayName", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.displayName", + "tags": [ + "displayname", + "library.displayname" + ], + "title": "Library.displayName" + }, + { + "id": "script-api:dw/content/Library#getCMSChannelID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getCMSChannelID", + "tags": [ + "getcmschannelid", + "library.getcmschannelid" + ], + "title": "Library.getCMSChannelID" + }, + { + "id": "script-api:dw/content/Library#getDisplayName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getDisplayName", + "tags": [ + "getdisplayname", + "library.getdisplayname" + ], + "title": "Library.getDisplayName" + }, + { + "id": "script-api:dw/content/Library#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getID", + "tags": [ + "getid", + "library.getid" + ], + "title": "Library.getID" + }, + { + "id": "script-api:dw/content/Library#getRoot", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getRoot", + "tags": [ + "getroot", + "library.getroot" + ], + "title": "Library.getRoot" + }, + { + "id": "script-api:dw/content/Library#root", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.root", + "tags": [ + "root", + "library.root" + ], + "title": "Library.root" + }, + { + "id": "script-api:dw/content/MarkupText", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.MarkupText", + "tags": [ + "markuptext", + "dw.content.markuptext", + "dw/content" + ], + "title": "MarkupText" + }, + { + "id": "script-api:dw/content/MarkupText#getMarkup", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.getMarkup", + "tags": [ + "getmarkup", + "markuptext.getmarkup" + ], + "title": "MarkupText.getMarkup" + }, + { + "id": "script-api:dw/content/MarkupText#getSource", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.getSource", + "tags": [ + "getsource", + "markuptext.getsource" + ], + "title": "MarkupText.getSource" + }, + { + "id": "script-api:dw/content/MarkupText#markup", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.markup", + "tags": [ + "markup", + "markuptext.markup" + ], + "title": "MarkupText.markup" + }, + { + "id": "script-api:dw/content/MarkupText#source", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.source", + "tags": [ + "source", + "markuptext.source" + ], + "title": "MarkupText.source" + }, + { + "id": "script-api:dw/content/MarkupText#toString", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.toString", + "tags": [ + "tostring", + "markuptext.tostring" + ], + "title": "MarkupText.toString" + }, + { + "id": "script-api:dw/content/MediaFile", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.MediaFile", + "tags": [ + "mediafile", + "dw.content.mediafile", + "dw/content" + ], + "title": "MediaFile" + }, + { + "id": "script-api:dw/content/MediaFile#URL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.URL", + "tags": [ + "url", + "mediafile.url" + ], + "title": "MediaFile.URL" + }, + { + "id": "script-api:dw/content/MediaFile#absURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.absURL", + "tags": [ + "absurl", + "mediafile.absurl" + ], + "title": "MediaFile.absURL" + }, + { + "id": "script-api:dw/content/MediaFile#alt", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.alt", + "tags": [ + "alt", + "mediafile.alt" + ], + "title": "MediaFile.alt" + }, + { + "id": "script-api:dw/content/MediaFile#getAbsImageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAbsImageURL", + "tags": [ + "getabsimageurl", + "mediafile.getabsimageurl" + ], + "title": "MediaFile.getAbsImageURL" + }, + { + "id": "script-api:dw/content/MediaFile#getAbsURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAbsURL", + "tags": [ + "getabsurl", + "mediafile.getabsurl" + ], + "title": "MediaFile.getAbsURL" + }, + { + "id": "script-api:dw/content/MediaFile#getAlt", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAlt", + "tags": [ + "getalt", + "mediafile.getalt" + ], + "title": "MediaFile.getAlt" + }, + { + "id": "script-api:dw/content/MediaFile#getHttpImageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpImageURL", + "tags": [ + "gethttpimageurl", + "mediafile.gethttpimageurl" + ], + "title": "MediaFile.getHttpImageURL" + }, + { + "id": "script-api:dw/content/MediaFile#getHttpURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpURL", + "tags": [ + "gethttpurl", + "mediafile.gethttpurl" + ], + "title": "MediaFile.getHttpURL" + }, + { + "id": "script-api:dw/content/MediaFile#getHttpsImageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpsImageURL", + "tags": [ + "gethttpsimageurl", + "mediafile.gethttpsimageurl" + ], + "title": "MediaFile.getHttpsImageURL" + }, + { + "id": "script-api:dw/content/MediaFile#getHttpsURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpsURL", + "tags": [ + "gethttpsurl", + "mediafile.gethttpsurl" + ], + "title": "MediaFile.getHttpsURL" + }, + { + "id": "script-api:dw/content/MediaFile#getImageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getImageURL", + "tags": [ + "getimageurl", + "mediafile.getimageurl" + ], + "title": "MediaFile.getImageURL" + }, + { + "id": "script-api:dw/content/MediaFile#getTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getTitle", + "tags": [ + "gettitle", + "mediafile.gettitle" + ], + "title": "MediaFile.getTitle" + }, + { + "id": "script-api:dw/content/MediaFile#getURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getURL", + "tags": [ + "geturl", + "mediafile.geturl" + ], + "title": "MediaFile.getURL" + }, + { + "id": "script-api:dw/content/MediaFile#getUrl", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getUrl", + "tags": [ + "geturl", + "mediafile.geturl" + ], + "title": "MediaFile.getUrl" + }, + { + "id": "script-api:dw/content/MediaFile#getViewType", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getViewType", + "tags": [ + "getviewtype", + "mediafile.getviewtype" + ], + "title": "MediaFile.getViewType" + }, + { + "id": "script-api:dw/content/MediaFile#httpURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.httpURL", + "tags": [ + "httpurl", + "mediafile.httpurl" + ], + "title": "MediaFile.httpURL" + }, + { + "id": "script-api:dw/content/MediaFile#httpsURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.httpsURL", + "tags": [ + "httpsurl", + "mediafile.httpsurl" + ], + "title": "MediaFile.httpsURL" + }, + { + "id": "script-api:dw/content/MediaFile#title", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.title", + "tags": [ + "title", + "mediafile.title" + ], + "title": "MediaFile.title" + }, + { + "id": "script-api:dw/content/MediaFile#url", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.url", + "tags": [ + "url", + "mediafile.url" + ], + "title": "MediaFile.url" + }, + { + "id": "script-api:dw/content/MediaFile#viewType", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.viewType", + "tags": [ + "viewtype", + "mediafile.viewtype" + ], + "title": "MediaFile.viewType" + }, + { + "id": "script-api:dw/crypto", + "kind": "package", + "packagePath": "dw/crypto", + "qualifiedName": "dw.crypto", + "tags": [ + "dw/crypto", + "dw.crypto" + ], + "title": "dw.crypto" + }, + { + "id": "script-api:dw/crypto/CertificateRef", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.CertificateRef", + "tags": [ + "certificateref", + "dw.crypto.certificateref", + "dw/crypto" + ], + "title": "CertificateRef" + }, + { + "id": "script-api:dw/crypto/CertificateRef#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateRef", + "qualifiedName": "dw.crypto.CertificateRef.toString", + "tags": [ + "tostring", + "certificateref.tostring" + ], + "title": "CertificateRef.toString" + }, + { + "id": "script-api:dw/crypto/CertificateUtils", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.CertificateUtils", + "tags": [ + "certificateutils", + "dw.crypto.certificateutils", + "dw/crypto" + ], + "title": "CertificateUtils" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "title": "CertificateUtils.getCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "title": "CertificateUtils.getCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "title": "CertificateUtils.getCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "title": "CertificateUtils.getCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedCertificate", + "tags": [ + "getencodedcertificate", + "certificateutils.getencodedcertificate" + ], + "title": "CertificateUtils.getEncodedCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedCertificate", + "tags": [ + "getencodedcertificate", + "certificateutils.getencodedcertificate" + ], + "title": "CertificateUtils.getEncodedCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedPublicKey", + "tags": [ + "getencodedpublickey", + "certificateutils.getencodedpublickey" + ], + "title": "CertificateUtils.getEncodedPublicKey" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#getEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedPublicKey", + "tags": [ + "getencodedpublickey", + "certificateutils.getencodedpublickey" + ], + "title": "CertificateUtils.getEncodedPublicKey" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedCertificate", + "tags": [ + "parseencodedcertificate", + "certificateutils.parseencodedcertificate" + ], + "title": "CertificateUtils.parseEncodedCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedCertificate", + "tags": [ + "parseencodedcertificate", + "certificateutils.parseencodedcertificate" + ], + "title": "CertificateUtils.parseEncodedCertificate" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedPublicKey", + "tags": [ + "parseencodedpublickey", + "certificateutils.parseencodedpublickey" + ], + "title": "CertificateUtils.parseEncodedPublicKey" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedPublicKey", + "tags": [ + "parseencodedpublickey", + "certificateutils.parseencodedpublickey" + ], + "title": "CertificateUtils.parseEncodedPublicKey" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parsePublicKeyFromJWK", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parsePublicKeyFromJWK", + "tags": [ + "parsepublickeyfromjwk", + "certificateutils.parsepublickeyfromjwk" + ], + "title": "CertificateUtils.parsePublicKeyFromJWK" + }, + { + "id": "script-api:dw/crypto/CertificateUtils#parsePublicKeyFromJWK", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parsePublicKeyFromJWK", + "tags": [ + "parsepublickeyfromjwk", + "certificateutils.parsepublickeyfromjwk" + ], + "title": "CertificateUtils.parsePublicKeyFromJWK" + }, + { + "id": "script-api:dw/crypto/Cipher", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Cipher", + "tags": [ + "cipher", + "dw.crypto.cipher", + "dw/crypto" + ], + "title": "Cipher" + }, + { + "id": "script-api:dw/crypto/Cipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.CHAR_ENCODING", + "tags": [ + "char_encoding", + "cipher.char_encoding" + ], + "title": "Cipher.CHAR_ENCODING" + }, + { + "id": "script-api:dw/crypto/Cipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.CHAR_ENCODING", + "tags": [ + "char_encoding", + "cipher.char_encoding" + ], + "title": "Cipher.CHAR_ENCODING" + }, + { + "id": "script-api:dw/crypto/Cipher#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.decrypt", + "tags": [ + "decrypt", + "cipher.decrypt" + ], + "title": "Cipher.decrypt" + }, + { + "id": "script-api:dw/crypto/Cipher#decryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.decryptBytes", + "tags": [ + "decryptbytes", + "cipher.decryptbytes" + ], + "title": "Cipher.decryptBytes" + }, + { + "id": "script-api:dw/crypto/Cipher#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.encrypt", + "tags": [ + "encrypt", + "cipher.encrypt" + ], + "title": "Cipher.encrypt" + }, + { + "id": "script-api:dw/crypto/Cipher#encryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.encryptBytes", + "tags": [ + "encryptbytes", + "cipher.encryptbytes" + ], + "title": "Cipher.encryptBytes" + }, + { + "id": "script-api:dw/crypto/Encoding", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Encoding", + "tags": [ + "encoding", + "dw.crypto.encoding", + "dw/crypto" + ], + "title": "Encoding" + }, + { + "id": "script-api:dw/crypto/Encoding#fromBase64", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromBase64", + "tags": [ + "frombase64", + "encoding.frombase64" + ], + "title": "Encoding.fromBase64" + }, + { + "id": "script-api:dw/crypto/Encoding#fromBase64", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromBase64", + "tags": [ + "frombase64", + "encoding.frombase64" + ], + "title": "Encoding.fromBase64" + }, + { + "id": "script-api:dw/crypto/Encoding#fromHex", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromHex", + "tags": [ + "fromhex", + "encoding.fromhex" + ], + "title": "Encoding.fromHex" + }, + { + "id": "script-api:dw/crypto/Encoding#fromHex", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromHex", + "tags": [ + "fromhex", + "encoding.fromhex" + ], + "title": "Encoding.fromHex" + }, + { + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "id": "script-api:dw/crypto/Encoding#toBase64", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64", + "tags": [ + "tobase64", + "encoding.tobase64" + ], + "title": "Encoding.toBase64" + }, + { + "id": "script-api:dw/crypto/Encoding#toBase64", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64", + "tags": [ + "tobase64", + "encoding.tobase64" + ], + "title": "Encoding.toBase64" + }, + { + "id": "script-api:dw/crypto/Encoding#toBase64URL", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64URL", + "tags": [ + "tobase64url", + "encoding.tobase64url" + ], + "title": "Encoding.toBase64URL" + }, + { + "id": "script-api:dw/crypto/Encoding#toBase64URL", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64URL", + "tags": [ + "tobase64url", + "encoding.tobase64url" + ], + "title": "Encoding.toBase64URL" + }, + { + "id": "script-api:dw/crypto/Encoding#toHex", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toHex", + "tags": [ + "tohex", + "encoding.tohex" + ], + "title": "Encoding.toHex" + }, + { + "id": "script-api:dw/crypto/Encoding#toHex", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toHex", + "tags": [ + "tohex", + "encoding.tohex" + ], + "title": "Encoding.toHex" + }, + { + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "id": "script-api:dw/crypto/JWE", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWE", + "tags": [ + "jwe", + "dw.crypto.jwe", + "dw/crypto" + ], + "title": "JWE" + }, + { + "id": "script-api:dw/crypto/JWE#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.algorithm", + "tags": [ + "algorithm", + "jwe.algorithm" + ], + "title": "JWE.algorithm" + }, + { + "id": "script-api:dw/crypto/JWE#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.decrypt", + "tags": [ + "decrypt", + "jwe.decrypt" + ], + "title": "JWE.decrypt" + }, + { + "id": "script-api:dw/crypto/JWE#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.encrypt", + "tags": [ + "encrypt", + "jwe.encrypt" + ], + "title": "JWE.encrypt" + }, + { + "id": "script-api:dw/crypto/JWE#encryptionMethod", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.encryptionMethod", + "tags": [ + "encryptionmethod", + "jwe.encryptionmethod" + ], + "title": "JWE.encryptionMethod" + }, + { + "id": "script-api:dw/crypto/JWE#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getAlgorithm", + "tags": [ + "getalgorithm", + "jwe.getalgorithm" + ], + "title": "JWE.getAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWE#getEncryptionMethod", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getEncryptionMethod", + "tags": [ + "getencryptionmethod", + "jwe.getencryptionmethod" + ], + "title": "JWE.getEncryptionMethod" + }, + { + "id": "script-api:dw/crypto/JWE#getHeaderMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getHeaderMap", + "tags": [ + "getheadermap", + "jwe.getheadermap" + ], + "title": "JWE.getHeaderMap" + }, + { + "id": "script-api:dw/crypto/JWE#getKeyID", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getKeyID", + "tags": [ + "getkeyid", + "jwe.getkeyid" + ], + "title": "JWE.getKeyID" + }, + { + "id": "script-api:dw/crypto/JWE#getPayload", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getPayload", + "tags": [ + "getpayload", + "jwe.getpayload" + ], + "title": "JWE.getPayload" + }, + { + "id": "script-api:dw/crypto/JWE#headerMap", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.headerMap", + "tags": [ + "headermap", + "jwe.headermap" + ], + "title": "JWE.headerMap" + }, + { + "id": "script-api:dw/crypto/JWE#keyID", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.keyID", + "tags": [ + "keyid", + "jwe.keyid" + ], + "title": "JWE.keyID" + }, + { + "id": "script-api:dw/crypto/JWE#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.parse", + "tags": [ + "parse", + "jwe.parse" + ], + "title": "JWE.parse" + }, + { + "id": "script-api:dw/crypto/JWE#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.parse", + "tags": [ + "parse", + "jwe.parse" + ], + "title": "JWE.parse" + }, + { + "id": "script-api:dw/crypto/JWE#payload", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.payload", + "tags": [ + "payload", + "jwe.payload" + ], + "title": "JWE.payload" + }, + { + "id": "script-api:dw/crypto/JWE#serialize", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.serialize", + "tags": [ + "serialize", + "jwe.serialize" + ], + "title": "JWE.serialize" + }, + { + "id": "script-api:dw/crypto/JWEHeader", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWEHeader", + "tags": [ + "jweheader", + "dw.crypto.jweheader", + "dw/crypto" + ], + "title": "JWEHeader" + }, + { + "id": "script-api:dw/crypto/JWEHeader#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.algorithm", + "tags": [ + "algorithm", + "jweheader.algorithm" + ], + "title": "JWEHeader.algorithm" + }, + { + "id": "script-api:dw/crypto/JWEHeader#encryptionAlgorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.encryptionAlgorithm", + "tags": [ + "encryptionalgorithm", + "jweheader.encryptionalgorithm" + ], + "title": "JWEHeader.encryptionAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWEHeader#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.getAlgorithm", + "tags": [ + "getalgorithm", + "jweheader.getalgorithm" + ], + "title": "JWEHeader.getAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWEHeader#getEncryptionAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.getEncryptionAlgorithm", + "tags": [ + "getencryptionalgorithm", + "jweheader.getencryptionalgorithm" + ], + "title": "JWEHeader.getEncryptionAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parse", + "tags": [ + "parse", + "jweheader.parse" + ], + "title": "JWEHeader.parse" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parse", + "tags": [ + "parse", + "jweheader.parse" + ], + "title": "JWEHeader.parse" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseEncoded", + "tags": [ + "parseencoded", + "jweheader.parseencoded" + ], + "title": "JWEHeader.parseEncoded" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseEncoded", + "tags": [ + "parseencoded", + "jweheader.parseencoded" + ], + "title": "JWEHeader.parseEncoded" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseJSON", + "tags": [ + "parsejson", + "jweheader.parsejson" + ], + "title": "JWEHeader.parseJSON" + }, + { + "id": "script-api:dw/crypto/JWEHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseJSON", + "tags": [ + "parsejson", + "jweheader.parsejson" + ], + "title": "JWEHeader.parseJSON" + }, + { + "id": "script-api:dw/crypto/JWEHeader#toMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.toMap", + "tags": [ + "tomap", + "jweheader.tomap" + ], + "title": "JWEHeader.toMap" + }, + { + "id": "script-api:dw/crypto/JWEHeader#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.toString", + "tags": [ + "tostring", + "jweheader.tostring" + ], + "title": "JWEHeader.toString" + }, + { + "id": "script-api:dw/crypto/JWS", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWS", + "tags": [ + "jws", + "dw.crypto.jws", + "dw/crypto" + ], + "title": "JWS" + }, + { + "id": "script-api:dw/crypto/JWS#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.algorithm", + "tags": [ + "algorithm", + "jws.algorithm" + ], + "title": "JWS.algorithm" + }, + { + "id": "script-api:dw/crypto/JWS#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getAlgorithm", + "tags": [ + "getalgorithm", + "jws.getalgorithm" + ], + "title": "JWS.getAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWS#getHeader", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getHeader", + "tags": [ + "getheader", + "jws.getheader" + ], + "title": "JWS.getHeader" + }, + { + "id": "script-api:dw/crypto/JWS#getHeaderMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getHeaderMap", + "tags": [ + "getheadermap", + "jws.getheadermap" + ], + "title": "JWS.getHeaderMap" + }, + { + "id": "script-api:dw/crypto/JWS#getPayload", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getPayload", + "tags": [ + "getpayload", + "jws.getpayload" + ], + "title": "JWS.getPayload" + }, + { + "id": "script-api:dw/crypto/JWS#header", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.header", + "tags": [ + "header", + "jws.header" + ], + "title": "JWS.header" + }, + { + "id": "script-api:dw/crypto/JWS#headerMap", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.headerMap", + "tags": [ + "headermap", + "jws.headermap" + ], + "title": "JWS.headerMap" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "id": "script-api:dw/crypto/JWS#payload", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.payload", + "tags": [ + "payload", + "jws.payload" + ], + "title": "JWS.payload" + }, + { + "id": "script-api:dw/crypto/JWS#serialize", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.serialize", + "tags": [ + "serialize", + "jws.serialize" + ], + "title": "JWS.serialize" + }, + { + "id": "script-api:dw/crypto/JWS#sign", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.sign", + "tags": [ + "sign", + "jws.sign" + ], + "title": "JWS.sign" + }, + { + "id": "script-api:dw/crypto/JWS#verify", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.verify", + "tags": [ + "verify", + "jws.verify" + ], + "title": "JWS.verify" + }, + { + "id": "script-api:dw/crypto/JWSHeader", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWSHeader", + "tags": [ + "jwsheader", + "dw.crypto.jwsheader", + "dw/crypto" + ], + "title": "JWSHeader" + }, + { + "id": "script-api:dw/crypto/JWSHeader#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.algorithm", + "tags": [ + "algorithm", + "jwsheader.algorithm" + ], + "title": "JWSHeader.algorithm" + }, + { + "id": "script-api:dw/crypto/JWSHeader#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.getAlgorithm", + "tags": [ + "getalgorithm", + "jwsheader.getalgorithm" + ], + "title": "JWSHeader.getAlgorithm" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parse", + "tags": [ + "parse", + "jwsheader.parse" + ], + "title": "JWSHeader.parse" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parse", + "tags": [ + "parse", + "jwsheader.parse" + ], + "title": "JWSHeader.parse" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseEncoded", + "tags": [ + "parseencoded", + "jwsheader.parseencoded" + ], + "title": "JWSHeader.parseEncoded" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseEncoded", + "tags": [ + "parseencoded", + "jwsheader.parseencoded" + ], + "title": "JWSHeader.parseEncoded" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseJSON", + "tags": [ + "parsejson", + "jwsheader.parsejson" + ], + "title": "JWSHeader.parseJSON" + }, + { + "id": "script-api:dw/crypto/JWSHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseJSON", + "tags": [ + "parsejson", + "jwsheader.parsejson" + ], + "title": "JWSHeader.parseJSON" + }, + { + "id": "script-api:dw/crypto/JWSHeader#toMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.toMap", + "tags": [ + "tomap", + "jwsheader.tomap" + ], + "title": "JWSHeader.toMap" + }, + { + "id": "script-api:dw/crypto/JWSHeader#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.toString", + "tags": [ + "tostring", + "jwsheader.tostring" + ], + "title": "JWSHeader.toString" + }, + { + "id": "script-api:dw/crypto/KeyRef", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.KeyRef", + "tags": [ + "keyref", + "dw.crypto.keyref", + "dw/crypto" + ], + "title": "KeyRef" + }, + { + "id": "script-api:dw/crypto/KeyRef#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/KeyRef", + "qualifiedName": "dw.crypto.KeyRef.toString", + "tags": [ + "tostring", + "keyref.tostring" + ], + "title": "KeyRef.toString" + }, + { + "id": "script-api:dw/crypto/Mac", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Mac", + "tags": [ + "mac", + "dw.crypto.mac", + "dw/crypto" + ], + "title": "Mac" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_MD5", + "tags": [ + "hmac_md5", + "mac.hmac_md5" + ], + "title": "Mac.HMAC_MD5" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_MD5", + "tags": [ + "hmac_md5", + "mac.hmac_md5" + ], + "title": "Mac.HMAC_MD5" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_1", + "tags": [ + "hmac_sha_1", + "mac.hmac_sha_1" + ], + "title": "Mac.HMAC_SHA_1" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_1", + "tags": [ + "hmac_sha_1", + "mac.hmac_sha_1" + ], + "title": "Mac.HMAC_SHA_1" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_256", + "tags": [ + "hmac_sha_256", + "mac.hmac_sha_256" + ], + "title": "Mac.HMAC_SHA_256" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_256", + "tags": [ + "hmac_sha_256", + "mac.hmac_sha_256" + ], + "title": "Mac.HMAC_SHA_256" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_384", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_384", + "tags": [ + "hmac_sha_384", + "mac.hmac_sha_384" + ], + "title": "Mac.HMAC_SHA_384" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_384", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_384", + "tags": [ + "hmac_sha_384", + "mac.hmac_sha_384" + ], + "title": "Mac.HMAC_SHA_384" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_512", + "tags": [ + "hmac_sha_512", + "mac.hmac_sha_512" + ], + "title": "Mac.HMAC_SHA_512" + }, + { + "id": "script-api:dw/crypto/Mac#HMAC_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_512", + "tags": [ + "hmac_sha_512", + "mac.hmac_sha_512" + ], + "title": "Mac.HMAC_SHA_512" + }, + { + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "tags": [ + "digest", + "mac.digest" + ], + "title": "Mac.digest" + }, + { + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "tags": [ + "digest", + "mac.digest" + ], + "title": "Mac.digest" + }, + { + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "tags": [ + "digest", + "mac.digest" + ], + "title": "Mac.digest" + }, + { + "id": "script-api:dw/crypto/MessageDigest", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.MessageDigest", + "tags": [ + "messagedigest", + "dw.crypto.messagedigest", + "dw/crypto" + ], + "title": "MessageDigest" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD2", + "tags": [ + "digest_md2", + "messagedigest.digest_md2" + ], + "title": "MessageDigest.DIGEST_MD2" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD2", + "tags": [ + "digest_md2", + "messagedigest.digest_md2" + ], + "title": "MessageDigest.DIGEST_MD2" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD5", + "tags": [ + "digest_md5", + "messagedigest.digest_md5" + ], + "title": "MessageDigest.DIGEST_MD5" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD5", + "tags": [ + "digest_md5", + "messagedigest.digest_md5" + ], + "title": "MessageDigest.DIGEST_MD5" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA", + "tags": [ + "digest_sha", + "messagedigest.digest_sha" + ], + "title": "MessageDigest.DIGEST_SHA" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA", + "tags": [ + "digest_sha", + "messagedigest.digest_sha" + ], + "title": "MessageDigest.DIGEST_SHA" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_1", + "tags": [ + "digest_sha_1", + "messagedigest.digest_sha_1" + ], + "title": "MessageDigest.DIGEST_SHA_1" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_1", + "tags": [ + "digest_sha_1", + "messagedigest.digest_sha_1" + ], + "title": "MessageDigest.DIGEST_SHA_1" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_256", + "tags": [ + "digest_sha_256", + "messagedigest.digest_sha_256" + ], + "title": "MessageDigest.DIGEST_SHA_256" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_256", + "tags": [ + "digest_sha_256", + "messagedigest.digest_sha_256" + ], + "title": "MessageDigest.DIGEST_SHA_256" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_512", + "tags": [ + "digest_sha_512", + "messagedigest.digest_sha_512" + ], + "title": "MessageDigest.DIGEST_SHA_512" + }, + { + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_512", + "tags": [ + "digest_sha_512", + "messagedigest.digest_sha_512" + ], + "title": "MessageDigest.DIGEST_SHA_512" + }, + { + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/MessageDigest#digestBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digestBytes", + "tags": [ + "digestbytes", + "messagedigest.digestbytes" + ], + "title": "MessageDigest.digestBytes" + }, + { + "id": "script-api:dw/crypto/MessageDigest#updateBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.updateBytes", + "tags": [ + "updatebytes", + "messagedigest.updatebytes" + ], + "title": "MessageDigest.updateBytes" + }, + { + "id": "script-api:dw/crypto/SecureRandom", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.SecureRandom", + "tags": [ + "securerandom", + "dw.crypto.securerandom", + "dw/crypto" + ], + "title": "SecureRandom" + }, + { + "id": "script-api:dw/crypto/SecureRandom#generateSeed", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.generateSeed", + "tags": [ + "generateseed", + "securerandom.generateseed" + ], + "title": "SecureRandom.generateSeed" + }, + { + "id": "script-api:dw/crypto/SecureRandom#nextBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextBytes", + "tags": [ + "nextbytes", + "securerandom.nextbytes" + ], + "title": "SecureRandom.nextBytes" + }, + { + "id": "script-api:dw/crypto/SecureRandom#nextInt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextInt", + "tags": [ + "nextint", + "securerandom.nextint" + ], + "title": "SecureRandom.nextInt" + }, + { + "id": "script-api:dw/crypto/SecureRandom#nextInt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextInt", + "tags": [ + "nextint", + "securerandom.nextint" + ], + "title": "SecureRandom.nextInt" + }, + { + "id": "script-api:dw/crypto/SecureRandom#nextNumber", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextNumber", + "tags": [ + "nextnumber", + "securerandom.nextnumber" + ], + "title": "SecureRandom.nextNumber" + }, + { + "id": "script-api:dw/crypto/SecureRandom#setSeed", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.setSeed", + "tags": [ + "setseed", + "securerandom.setseed" + ], + "title": "SecureRandom.setSeed" + }, + { + "id": "script-api:dw/crypto/Signature", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Signature", + "tags": [ + "signature", + "dw.crypto.signature", + "dw/crypto" + ], + "title": "Signature" + }, + { + "id": "script-api:dw/crypto/Signature#SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "tags": [ + "supported_digest_algorithms_as_array", + "signature.supported_digest_algorithms_as_array" + ], + "title": "Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY" + }, + { + "id": "script-api:dw/crypto/Signature#SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "tags": [ + "supported_digest_algorithms_as_array", + "signature.supported_digest_algorithms_as_array" + ], + "title": "Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY" + }, + { + "id": "script-api:dw/crypto/Signature#isDigestAlgorithmSupported", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.isDigestAlgorithmSupported", + "tags": [ + "isdigestalgorithmsupported", + "signature.isdigestalgorithmsupported" + ], + "title": "Signature.isDigestAlgorithmSupported" + }, + { + "id": "script-api:dw/crypto/Signature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.sign", + "tags": [ + "sign", + "signature.sign" + ], + "title": "Signature.sign" + }, + { + "id": "script-api:dw/crypto/Signature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.sign", + "tags": [ + "sign", + "signature.sign" + ], + "title": "Signature.sign" + }, + { + "id": "script-api:dw/crypto/Signature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.signBytes", + "tags": [ + "signbytes", + "signature.signbytes" + ], + "title": "Signature.signBytes" + }, + { + "id": "script-api:dw/crypto/Signature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.signBytes", + "tags": [ + "signbytes", + "signature.signbytes" + ], + "title": "Signature.signBytes" + }, + { + "id": "script-api:dw/crypto/Signature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifyBytesSignature", + "tags": [ + "verifybytessignature", + "signature.verifybytessignature" + ], + "title": "Signature.verifyBytesSignature" + }, + { + "id": "script-api:dw/crypto/Signature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifyBytesSignature", + "tags": [ + "verifybytessignature", + "signature.verifybytessignature" + ], + "title": "Signature.verifyBytesSignature" + }, + { + "id": "script-api:dw/crypto/Signature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifySignature", + "tags": [ + "verifysignature", + "signature.verifysignature" + ], + "title": "Signature.verifySignature" + }, + { + "id": "script-api:dw/crypto/Signature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifySignature", + "tags": [ + "verifysignature", + "signature.verifysignature" + ], + "title": "Signature.verifySignature" + }, + { + "id": "script-api:dw/crypto/WeakCipher", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakCipher", + "tags": [ + "weakcipher", + "dw.crypto.weakcipher", + "dw/crypto" + ], + "title": "WeakCipher" + }, + { + "id": "script-api:dw/crypto/WeakCipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.CHAR_ENCODING", + "tags": [ + "char_encoding", + "weakcipher.char_encoding" + ], + "title": "WeakCipher.CHAR_ENCODING" + }, + { + "id": "script-api:dw/crypto/WeakCipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.CHAR_ENCODING", + "tags": [ + "char_encoding", + "weakcipher.char_encoding" + ], + "title": "WeakCipher.CHAR_ENCODING" + }, + { + "id": "script-api:dw/crypto/WeakCipher#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.decrypt", + "tags": [ + "decrypt", + "weakcipher.decrypt" + ], + "title": "WeakCipher.decrypt" + }, + { + "id": "script-api:dw/crypto/WeakCipher#decryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.decryptBytes", + "tags": [ + "decryptbytes", + "weakcipher.decryptbytes" + ], + "title": "WeakCipher.decryptBytes" + }, + { + "id": "script-api:dw/crypto/WeakCipher#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.encrypt", + "tags": [ + "encrypt", + "weakcipher.encrypt" + ], + "title": "WeakCipher.encrypt" + }, + { + "id": "script-api:dw/crypto/WeakCipher#encryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.encryptBytes", + "tags": [ + "encryptbytes", + "weakcipher.encryptbytes" + ], + "title": "WeakCipher.encryptBytes" + }, + { + "id": "script-api:dw/crypto/WeakMac", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakMac", + "tags": [ + "weakmac", + "dw.crypto.weakmac", + "dw/crypto" + ], + "title": "WeakMac" + }, + { + "id": "script-api:dw/crypto/WeakMac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_MD5", + "tags": [ + "hmac_md5", + "weakmac.hmac_md5" + ], + "title": "WeakMac.HMAC_MD5" + }, + { + "id": "script-api:dw/crypto/WeakMac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_MD5", + "tags": [ + "hmac_md5", + "weakmac.hmac_md5" + ], + "title": "WeakMac.HMAC_MD5" + }, + { + "id": "script-api:dw/crypto/WeakMac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_SHA_1", + "tags": [ + "hmac_sha_1", + "weakmac.hmac_sha_1" + ], + "title": "WeakMac.HMAC_SHA_1" + }, + { + "id": "script-api:dw/crypto/WeakMac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_SHA_1", + "tags": [ + "hmac_sha_1", + "weakmac.hmac_sha_1" + ], + "title": "WeakMac.HMAC_SHA_1" + }, + { + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "tags": [ + "digest", + "weakmac.digest" + ], + "title": "WeakMac.digest" + }, + { + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "tags": [ + "digest", + "weakmac.digest" + ], + "title": "WeakMac.digest" + }, + { + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "tags": [ + "digest", + "weakmac.digest" + ], + "title": "WeakMac.digest" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakMessageDigest", + "tags": [ + "weakmessagedigest", + "dw.crypto.weakmessagedigest", + "dw/crypto" + ], + "title": "WeakMessageDigest" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD2", + "tags": [ + "digest_md2", + "weakmessagedigest.digest_md2" + ], + "title": "WeakMessageDigest.DIGEST_MD2" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD2", + "tags": [ + "digest_md2", + "weakmessagedigest.digest_md2" + ], + "title": "WeakMessageDigest.DIGEST_MD2" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD5", + "tags": [ + "digest_md5", + "weakmessagedigest.digest_md5" + ], + "title": "WeakMessageDigest.DIGEST_MD5" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD5", + "tags": [ + "digest_md5", + "weakmessagedigest.digest_md5" + ], + "title": "WeakMessageDigest.DIGEST_MD5" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA", + "tags": [ + "digest_sha", + "weakmessagedigest.digest_sha" + ], + "title": "WeakMessageDigest.DIGEST_SHA" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA", + "tags": [ + "digest_sha", + "weakmessagedigest.digest_sha" + ], + "title": "WeakMessageDigest.DIGEST_SHA" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA_1", + "tags": [ + "digest_sha_1", + "weakmessagedigest.digest_sha_1" + ], + "title": "WeakMessageDigest.DIGEST_SHA_1" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA_1", + "tags": [ + "digest_sha_1", + "weakmessagedigest.digest_sha_1" + ], + "title": "WeakMessageDigest.DIGEST_SHA_1" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#digestBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digestBytes", + "tags": [ + "digestbytes", + "weakmessagedigest.digestbytes" + ], + "title": "WeakMessageDigest.digestBytes" + }, + { + "id": "script-api:dw/crypto/WeakMessageDigest#updateBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.updateBytes", + "tags": [ + "updatebytes", + "weakmessagedigest.updatebytes" + ], + "title": "WeakMessageDigest.updateBytes" + }, + { + "id": "script-api:dw/crypto/WeakSignature", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakSignature", + "tags": [ + "weaksignature", + "dw.crypto.weaksignature", + "dw/crypto" + ], + "title": "WeakSignature" + }, + { + "id": "script-api:dw/crypto/WeakSignature#isDigestAlgorithmSupported", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.isDigestAlgorithmSupported", + "tags": [ + "isdigestalgorithmsupported", + "weaksignature.isdigestalgorithmsupported" + ], + "title": "WeakSignature.isDigestAlgorithmSupported" + }, + { + "id": "script-api:dw/crypto/WeakSignature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.sign", + "tags": [ + "sign", + "weaksignature.sign" + ], + "title": "WeakSignature.sign" + }, + { + "id": "script-api:dw/crypto/WeakSignature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.sign", + "tags": [ + "sign", + "weaksignature.sign" + ], + "title": "WeakSignature.sign" + }, + { + "id": "script-api:dw/crypto/WeakSignature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.signBytes", + "tags": [ + "signbytes", + "weaksignature.signbytes" + ], + "title": "WeakSignature.signBytes" + }, + { + "id": "script-api:dw/crypto/WeakSignature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.signBytes", + "tags": [ + "signbytes", + "weaksignature.signbytes" + ], + "title": "WeakSignature.signBytes" + }, + { + "id": "script-api:dw/crypto/WeakSignature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifyBytesSignature", + "tags": [ + "verifybytessignature", + "weaksignature.verifybytessignature" + ], + "title": "WeakSignature.verifyBytesSignature" + }, + { + "id": "script-api:dw/crypto/WeakSignature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifyBytesSignature", + "tags": [ + "verifybytessignature", + "weaksignature.verifybytessignature" + ], + "title": "WeakSignature.verifyBytesSignature" + }, + { + "id": "script-api:dw/crypto/WeakSignature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifySignature", + "tags": [ + "verifysignature", + "weaksignature.verifysignature" + ], + "title": "WeakSignature.verifySignature" + }, + { + "id": "script-api:dw/crypto/WeakSignature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifySignature", + "tags": [ + "verifysignature", + "weaksignature.verifysignature" + ], + "title": "WeakSignature.verifySignature" + }, + { + "id": "script-api:dw/crypto/X509Certificate", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.X509Certificate", + "tags": [ + "x509certificate", + "dw.crypto.x509certificate", + "dw/crypto" + ], + "title": "X509Certificate" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getIssuerDN", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getIssuerDN", + "tags": [ + "getissuerdn", + "x509certificate.getissuerdn" + ], + "title": "X509Certificate.getIssuerDN" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getNotAfter", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getNotAfter", + "tags": [ + "getnotafter", + "x509certificate.getnotafter" + ], + "title": "X509Certificate.getNotAfter" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getNotBefore", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getNotBefore", + "tags": [ + "getnotbefore", + "x509certificate.getnotbefore" + ], + "title": "X509Certificate.getNotBefore" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getSerialNumber", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSerialNumber", + "tags": [ + "getserialnumber", + "x509certificate.getserialnumber" + ], + "title": "X509Certificate.getSerialNumber" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getSigAlgName", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSigAlgName", + "tags": [ + "getsigalgname", + "x509certificate.getsigalgname" + ], + "title": "X509Certificate.getSigAlgName" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getSubjectDN", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSubjectDN", + "tags": [ + "getsubjectdn", + "x509certificate.getsubjectdn" + ], + "title": "X509Certificate.getSubjectDN" + }, + { + "id": "script-api:dw/crypto/X509Certificate#getVersion", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getVersion", + "tags": [ + "getversion", + "x509certificate.getversion" + ], + "title": "X509Certificate.getVersion" + }, + { + "id": "script-api:dw/crypto/X509Certificate#issuerDN", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.issuerDN", + "tags": [ + "issuerdn", + "x509certificate.issuerdn" + ], + "title": "X509Certificate.issuerDN" + }, + { + "id": "script-api:dw/crypto/X509Certificate#notAfter", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.notAfter", + "tags": [ + "notafter", + "x509certificate.notafter" + ], + "title": "X509Certificate.notAfter" + }, + { + "id": "script-api:dw/crypto/X509Certificate#notBefore", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.notBefore", + "tags": [ + "notbefore", + "x509certificate.notbefore" + ], + "title": "X509Certificate.notBefore" + }, + { + "id": "script-api:dw/crypto/X509Certificate#serialNumber", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.serialNumber", + "tags": [ + "serialnumber", + "x509certificate.serialnumber" + ], + "title": "X509Certificate.serialNumber" + }, + { + "id": "script-api:dw/crypto/X509Certificate#sigAlgName", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.sigAlgName", + "tags": [ + "sigalgname", + "x509certificate.sigalgname" + ], + "title": "X509Certificate.sigAlgName" + }, + { + "id": "script-api:dw/crypto/X509Certificate#subjectDN", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.subjectDN", + "tags": [ + "subjectdn", + "x509certificate.subjectdn" + ], + "title": "X509Certificate.subjectDN" + }, + { + "id": "script-api:dw/crypto/X509Certificate#version", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.version", + "tags": [ + "version", + "x509certificate.version" + ], + "title": "X509Certificate.version" + }, + { + "id": "script-api:dw/customer", + "kind": "package", + "packagePath": "dw/customer", + "qualifiedName": "dw.customer", + "tags": [ + "dw/customer", + "dw.customer" + ], + "title": "dw.customer" + }, + { + "id": "script-api:dw/customer/AddressBook", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AddressBook", + "tags": [ + "addressbook", + "dw.customer.addressbook", + "dw/customer" + ], + "title": "AddressBook" + }, + { + "id": "script-api:dw/customer/AddressBook#addresses", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.addresses", + "tags": [ + "addresses", + "addressbook.addresses" + ], + "title": "AddressBook.addresses" + }, + { + "id": "script-api:dw/customer/AddressBook#createAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.createAddress", + "tags": [ + "createaddress", + "addressbook.createaddress" + ], + "title": "AddressBook.createAddress" + }, + { + "id": "script-api:dw/customer/AddressBook#getAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getAddress", + "tags": [ + "getaddress", + "addressbook.getaddress" + ], + "title": "AddressBook.getAddress" + }, + { + "id": "script-api:dw/customer/AddressBook#getAddresses", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getAddresses", + "tags": [ + "getaddresses", + "addressbook.getaddresses" + ], + "title": "AddressBook.getAddresses" + }, + { + "id": "script-api:dw/customer/AddressBook#getPreferredAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getPreferredAddress", + "tags": [ + "getpreferredaddress", + "addressbook.getpreferredaddress" + ], + "title": "AddressBook.getPreferredAddress" + }, + { + "id": "script-api:dw/customer/AddressBook#preferredAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.preferredAddress", + "tags": [ + "preferredaddress", + "addressbook.preferredaddress" + ], + "title": "AddressBook.preferredAddress" + }, + { + "id": "script-api:dw/customer/AddressBook#removeAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.removeAddress", + "tags": [ + "removeaddress", + "addressbook.removeaddress" + ], + "title": "AddressBook.removeAddress" + }, + { + "id": "script-api:dw/customer/AddressBook#setPreferredAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.setPreferredAddress", + "tags": [ + "setpreferredaddress", + "addressbook.setpreferredaddress" + ], + "title": "AddressBook.setPreferredAddress" + }, + { + "id": "script-api:dw/customer/AgentUserMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AgentUserMgr", + "tags": [ + "agentusermgr", + "dw.customer.agentusermgr", + "dw/customer" + ], + "title": "AgentUserMgr" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#loginAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginAgentUser", + "tags": [ + "loginagentuser", + "agentusermgr.loginagentuser" + ], + "title": "AgentUserMgr.loginAgentUser" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#loginAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginAgentUser", + "tags": [ + "loginagentuser", + "agentusermgr.loginagentuser" + ], + "title": "AgentUserMgr.loginAgentUser" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#loginOnBehalfOfCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginOnBehalfOfCustomer", + "tags": [ + "loginonbehalfofcustomer", + "agentusermgr.loginonbehalfofcustomer" + ], + "title": "AgentUserMgr.loginOnBehalfOfCustomer" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#loginOnBehalfOfCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginOnBehalfOfCustomer", + "tags": [ + "loginonbehalfofcustomer", + "agentusermgr.loginonbehalfofcustomer" + ], + "title": "AgentUserMgr.loginOnBehalfOfCustomer" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#logoutAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.logoutAgentUser", + "tags": [ + "logoutagentuser", + "agentusermgr.logoutagentuser" + ], + "title": "AgentUserMgr.logoutAgentUser" + }, + { + "id": "script-api:dw/customer/AgentUserMgr#logoutAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.logoutAgentUser", + "tags": [ + "logoutagentuser", + "agentusermgr.logoutagentuser" + ], + "title": "AgentUserMgr.logoutAgentUser" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AgentUserStatusCodes", + "tags": [ + "agentuserstatuscodes", + "dw.customer.agentuserstatuscodes", + "dw/customer" + ], + "title": "AgentUserStatusCodes" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE", + "tags": [ + "agent_user_not_available", + "agentuserstatuscodes.agent_user_not_available" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE", + "tags": [ + "agent_user_not_available", + "agentuserstatuscodes.agent_user_not_available" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_LOGGED_IN", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN", + "tags": [ + "agent_user_not_logged_in", + "agentuserstatuscodes.agent_user_not_logged_in" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_LOGGED_IN", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN", + "tags": [ + "agent_user_not_logged_in", + "agentuserstatuscodes.agent_user_not_logged_in" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CREDENTIALS_INVALID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CREDENTIALS_INVALID", + "tags": [ + "credentials_invalid", + "agentuserstatuscodes.credentials_invalid" + ], + "title": "AgentUserStatusCodes.CREDENTIALS_INVALID" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CREDENTIALS_INVALID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CREDENTIALS_INVALID", + "tags": [ + "credentials_invalid", + "agentuserstatuscodes.credentials_invalid" + ], + "title": "AgentUserStatusCodes.CREDENTIALS_INVALID" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_DISABLED", + "tags": [ + "customer_disabled", + "agentuserstatuscodes.customer_disabled" + ], + "title": "AgentUserStatusCodes.CUSTOMER_DISABLED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_DISABLED", + "tags": [ + "customer_disabled", + "agentuserstatuscodes.customer_disabled" + ], + "title": "AgentUserStatusCodes.CUSTOMER_DISABLED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_UNREGISTERED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_UNREGISTERED", + "tags": [ + "customer_unregistered", + "agentuserstatuscodes.customer_unregistered" + ], + "title": "AgentUserStatusCodes.CUSTOMER_UNREGISTERED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_UNREGISTERED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_UNREGISTERED", + "tags": [ + "customer_unregistered", + "agentuserstatuscodes.customer_unregistered" + ], + "title": "AgentUserStatusCodes.CUSTOMER_UNREGISTERED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#INSECURE_CONNECTION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSECURE_CONNECTION", + "tags": [ + "insecure_connection", + "agentuserstatuscodes.insecure_connection" + ], + "title": "AgentUserStatusCodes.INSECURE_CONNECTION" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#INSECURE_CONNECTION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSECURE_CONNECTION", + "tags": [ + "insecure_connection", + "agentuserstatuscodes.insecure_connection" + ], + "title": "AgentUserStatusCodes.INSECURE_CONNECTION" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#INSUFFICIENT_PERMISSION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSUFFICIENT_PERMISSION", + "tags": [ + "insufficient_permission", + "agentuserstatuscodes.insufficient_permission" + ], + "title": "AgentUserStatusCodes.INSUFFICIENT_PERMISSION" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#INSUFFICIENT_PERMISSION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSUFFICIENT_PERMISSION", + "tags": [ + "insufficient_permission", + "agentuserstatuscodes.insufficient_permission" + ], + "title": "AgentUserStatusCodes.INSUFFICIENT_PERMISSION" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#LOGIN_SUCCESSFUL", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.LOGIN_SUCCESSFUL", + "tags": [ + "login_successful", + "agentuserstatuscodes.login_successful" + ], + "title": "AgentUserStatusCodes.LOGIN_SUCCESSFUL" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#LOGIN_SUCCESSFUL", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.LOGIN_SUCCESSFUL", + "tags": [ + "login_successful", + "agentuserstatuscodes.login_successful" + ], + "title": "AgentUserStatusCodes.LOGIN_SUCCESSFUL" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#NO_STOREFRONT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.NO_STOREFRONT", + "tags": [ + "no_storefront", + "agentuserstatuscodes.no_storefront" + ], + "title": "AgentUserStatusCodes.NO_STOREFRONT" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#NO_STOREFRONT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.NO_STOREFRONT", + "tags": [ + "no_storefront", + "agentuserstatuscodes.no_storefront" + ], + "title": "AgentUserStatusCodes.NO_STOREFRONT" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#PASSWORD_EXPIRED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.PASSWORD_EXPIRED", + "tags": [ + "password_expired", + "agentuserstatuscodes.password_expired" + ], + "title": "AgentUserStatusCodes.PASSWORD_EXPIRED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#PASSWORD_EXPIRED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.PASSWORD_EXPIRED", + "tags": [ + "password_expired", + "agentuserstatuscodes.password_expired" + ], + "title": "AgentUserStatusCodes.PASSWORD_EXPIRED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_DISABLED", + "tags": [ + "user_disabled", + "agentuserstatuscodes.user_disabled" + ], + "title": "AgentUserStatusCodes.USER_DISABLED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_DISABLED", + "tags": [ + "user_disabled", + "agentuserstatuscodes.user_disabled" + ], + "title": "AgentUserStatusCodes.USER_DISABLED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_LOCKED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_LOCKED", + "tags": [ + "user_locked", + "agentuserstatuscodes.user_locked" + ], + "title": "AgentUserStatusCodes.USER_LOCKED" + }, + { + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_LOCKED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_LOCKED", + "tags": [ + "user_locked", + "agentuserstatuscodes.user_locked" + ], + "title": "AgentUserStatusCodes.USER_LOCKED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AuthenticationStatus", + "tags": [ + "authenticationstatus", + "dw.customer.authenticationstatus", + "dw/customer" + ], + "title": "AuthenticationStatus" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#AUTH_OK", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.AUTH_OK", + "tags": [ + "auth_ok", + "authenticationstatus.auth_ok" + ], + "title": "AuthenticationStatus.AUTH_OK" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#AUTH_OK", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.AUTH_OK", + "tags": [ + "auth_ok", + "authenticationstatus.auth_ok" + ], + "title": "AuthenticationStatus.AUTH_OK" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_DISABLED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_DISABLED", + "tags": [ + "error_customer_disabled", + "authenticationstatus.error_customer_disabled" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_DISABLED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_DISABLED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_DISABLED", + "tags": [ + "error_customer_disabled", + "authenticationstatus.error_customer_disabled" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_DISABLED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_LOCKED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_LOCKED", + "tags": [ + "error_customer_locked", + "authenticationstatus.error_customer_locked" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_LOCKED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_LOCKED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_LOCKED", + "tags": [ + "error_customer_locked", + "authenticationstatus.error_customer_locked" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_LOCKED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND", + "tags": [ + "error_customer_not_found", + "authenticationstatus.error_customer_not_found" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND", + "tags": [ + "error_customer_not_found", + "authenticationstatus.error_customer_not_found" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_EXPIRED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_EXPIRED", + "tags": [ + "error_password_expired", + "authenticationstatus.error_password_expired" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_EXPIRED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_EXPIRED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_EXPIRED", + "tags": [ + "error_password_expired", + "authenticationstatus.error_password_expired" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_EXPIRED" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_MISMATCH", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_MISMATCH", + "tags": [ + "error_password_mismatch", + "authenticationstatus.error_password_mismatch" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_MISMATCH" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_MISMATCH", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_MISMATCH", + "tags": [ + "error_password_mismatch", + "authenticationstatus.error_password_mismatch" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_MISMATCH" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_UNKNOWN", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_UNKNOWN", + "tags": [ + "error_unknown", + "authenticationstatus.error_unknown" + ], + "title": "AuthenticationStatus.ERROR_UNKNOWN" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_UNKNOWN", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_UNKNOWN", + "tags": [ + "error_unknown", + "authenticationstatus.error_unknown" + ], + "title": "AuthenticationStatus.ERROR_UNKNOWN" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#authenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.authenticated", + "tags": [ + "authenticated", + "authenticationstatus.authenticated" + ], + "title": "AuthenticationStatus.authenticated" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.customer", + "tags": [ + "customer", + "authenticationstatus.customer" + ], + "title": "AuthenticationStatus.customer" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.getCustomer", + "tags": [ + "getcustomer", + "authenticationstatus.getcustomer" + ], + "title": "AuthenticationStatus.getCustomer" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#getStatus", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.getStatus", + "tags": [ + "getstatus", + "authenticationstatus.getstatus" + ], + "title": "AuthenticationStatus.getStatus" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#isAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.isAuthenticated", + "tags": [ + "isauthenticated", + "authenticationstatus.isauthenticated" + ], + "title": "AuthenticationStatus.isAuthenticated" + }, + { + "id": "script-api:dw/customer/AuthenticationStatus#status", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.status", + "tags": [ + "status", + "authenticationstatus.status" + ], + "title": "AuthenticationStatus.status" + }, + { + "id": "script-api:dw/customer/Credentials", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Credentials", + "tags": [ + "credentials", + "dw.customer.credentials", + "dw/customer" + ], + "title": "Credentials" + }, + { + "id": "script-api:dw/customer/Credentials#authenticationProviderID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.authenticationProviderID", + "tags": [ + "authenticationproviderid", + "credentials.authenticationproviderid" + ], + "title": "Credentials.authenticationProviderID" + }, + { + "id": "script-api:dw/customer/Credentials#createResetPasswordToken", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.createResetPasswordToken", + "tags": [ + "createresetpasswordtoken", + "credentials.createresetpasswordtoken" + ], + "title": "Credentials.createResetPasswordToken" + }, + { + "id": "script-api:dw/customer/Credentials#enabled", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.enabled", + "tags": [ + "enabled", + "credentials.enabled" + ], + "title": "Credentials.enabled" + }, + { + "id": "script-api:dw/customer/Credentials#enabledFlag", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.enabledFlag", + "tags": [ + "enabledflag", + "credentials.enabledflag" + ], + "title": "Credentials.enabledFlag" + }, + { + "id": "script-api:dw/customer/Credentials#externalID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.externalID", + "tags": [ + "externalid", + "credentials.externalid" + ], + "title": "Credentials.externalID" + }, + { + "id": "script-api:dw/customer/Credentials#getAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getAuthenticationProviderID", + "tags": [ + "getauthenticationproviderid", + "credentials.getauthenticationproviderid" + ], + "title": "Credentials.getAuthenticationProviderID" + }, + { + "id": "script-api:dw/customer/Credentials#getEnabledFlag", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getEnabledFlag", + "tags": [ + "getenabledflag", + "credentials.getenabledflag" + ], + "title": "Credentials.getEnabledFlag" + }, + { + "id": "script-api:dw/customer/Credentials#getExternalID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getExternalID", + "tags": [ + "getexternalid", + "credentials.getexternalid" + ], + "title": "Credentials.getExternalID" + }, + { + "id": "script-api:dw/customer/Credentials#getLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getLogin", + "tags": [ + "getlogin", + "credentials.getlogin" + ], + "title": "Credentials.getLogin" + }, + { + "id": "script-api:dw/customer/Credentials#getPasswordAnswer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getPasswordAnswer", + "tags": [ + "getpasswordanswer", + "credentials.getpasswordanswer" + ], + "title": "Credentials.getPasswordAnswer" + }, + { + "id": "script-api:dw/customer/Credentials#getPasswordQuestion", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getPasswordQuestion", + "tags": [ + "getpasswordquestion", + "credentials.getpasswordquestion" + ], + "title": "Credentials.getPasswordQuestion" + }, + { + "id": "script-api:dw/customer/Credentials#getRemainingLoginAttempts", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getRemainingLoginAttempts", + "tags": [ + "getremainingloginattempts", + "credentials.getremainingloginattempts" + ], + "title": "Credentials.getRemainingLoginAttempts" + }, + { + "id": "script-api:dw/customer/Credentials#isEnabled", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isEnabled", + "tags": [ + "isenabled", + "credentials.isenabled" + ], + "title": "Credentials.isEnabled" + }, + { + "id": "script-api:dw/customer/Credentials#isLocked", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isLocked", + "tags": [ + "islocked", + "credentials.islocked" + ], + "title": "Credentials.isLocked" + }, + { + "id": "script-api:dw/customer/Credentials#isPasswordSet", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isPasswordSet", + "tags": [ + "ispasswordset", + "credentials.ispasswordset" + ], + "title": "Credentials.isPasswordSet" + }, + { + "id": "script-api:dw/customer/Credentials#locked", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.locked", + "tags": [ + "locked", + "credentials.locked" + ], + "title": "Credentials.locked" + }, + { + "id": "script-api:dw/customer/Credentials#login", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.login", + "tags": [ + "login", + "credentials.login" + ], + "title": "Credentials.login" + }, + { + "id": "script-api:dw/customer/Credentials#passwordAnswer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordAnswer", + "tags": [ + "passwordanswer", + "credentials.passwordanswer" + ], + "title": "Credentials.passwordAnswer" + }, + { + "id": "script-api:dw/customer/Credentials#passwordQuestion", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordQuestion", + "tags": [ + "passwordquestion", + "credentials.passwordquestion" + ], + "title": "Credentials.passwordQuestion" + }, + { + "id": "script-api:dw/customer/Credentials#passwordSet", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordSet", + "tags": [ + "passwordset", + "credentials.passwordset" + ], + "title": "Credentials.passwordSet" + }, + { + "id": "script-api:dw/customer/Credentials#remainingLoginAttempts", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.remainingLoginAttempts", + "tags": [ + "remainingloginattempts", + "credentials.remainingloginattempts" + ], + "title": "Credentials.remainingLoginAttempts" + }, + { + "id": "script-api:dw/customer/Credentials#setAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setAuthenticationProviderID", + "tags": [ + "setauthenticationproviderid", + "credentials.setauthenticationproviderid" + ], + "title": "Credentials.setAuthenticationProviderID" + }, + { + "id": "script-api:dw/customer/Credentials#setEnabledFlag", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setEnabledFlag", + "tags": [ + "setenabledflag", + "credentials.setenabledflag" + ], + "title": "Credentials.setEnabledFlag" + }, + { + "id": "script-api:dw/customer/Credentials#setExternalID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setExternalID", + "tags": [ + "setexternalid", + "credentials.setexternalid" + ], + "title": "Credentials.setExternalID" + }, + { + "id": "script-api:dw/customer/Credentials#setLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setLogin", + "tags": [ + "setlogin", + "credentials.setlogin" + ], + "title": "Credentials.setLogin" + }, + { + "id": "script-api:dw/customer/Credentials#setLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setLogin", + "tags": [ + "setlogin", + "credentials.setlogin" + ], + "title": "Credentials.setLogin" + }, + { + "id": "script-api:dw/customer/Credentials#setPassword", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPassword", + "tags": [ + "setpassword", + "credentials.setpassword" + ], + "title": "Credentials.setPassword" + }, + { + "id": "script-api:dw/customer/Credentials#setPasswordAnswer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordAnswer", + "tags": [ + "setpasswordanswer", + "credentials.setpasswordanswer" + ], + "title": "Credentials.setPasswordAnswer" + }, + { + "id": "script-api:dw/customer/Credentials#setPasswordQuestion", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordQuestion", + "tags": [ + "setpasswordquestion", + "credentials.setpasswordquestion" + ], + "title": "Credentials.setPasswordQuestion" + }, + { + "id": "script-api:dw/customer/Credentials#setPasswordWithToken", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordWithToken", + "tags": [ + "setpasswordwithtoken", + "credentials.setpasswordwithtoken" + ], + "title": "Credentials.setPasswordWithToken" + }, + { + "id": "script-api:dw/customer/Customer", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Customer", + "tags": [ + "customer", + "dw.customer.customer", + "dw/customer" + ], + "title": "Customer" + }, + { + "id": "script-api:dw/customer/Customer#CDPData", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.CDPData", + "tags": [ + "cdpdata", + "customer.cdpdata" + ], + "title": "Customer.CDPData" + }, + { + "id": "script-api:dw/customer/Customer#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.ID", + "tags": [ + "id", + "customer.id" + ], + "title": "Customer.ID" + }, + { + "id": "script-api:dw/customer/Customer#activeData", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.activeData", + "tags": [ + "activedata", + "customer.activedata" + ], + "title": "Customer.activeData" + }, + { + "id": "script-api:dw/customer/Customer#addressBook", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.addressBook", + "tags": [ + "addressbook", + "customer.addressbook" + ], + "title": "Customer.addressBook" + }, + { + "id": "script-api:dw/customer/Customer#anonymous", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.anonymous", + "tags": [ + "anonymous", + "customer.anonymous" + ], + "title": "Customer.anonymous" + }, + { + "id": "script-api:dw/customer/Customer#authenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.authenticated", + "tags": [ + "authenticated", + "customer.authenticated" + ], + "title": "Customer.authenticated" + }, + { + "id": "script-api:dw/customer/Customer#createExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.createExternalProfile", + "tags": [ + "createexternalprofile", + "customer.createexternalprofile" + ], + "title": "Customer.createExternalProfile" + }, + { + "id": "script-api:dw/customer/Customer#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.customerGroups", + "tags": [ + "customergroups", + "customer.customergroups" + ], + "title": "Customer.customerGroups" + }, + { + "id": "script-api:dw/customer/Customer#externalProfiles", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.externalProfiles", + "tags": [ + "externalprofiles", + "customer.externalprofiles" + ], + "title": "Customer.externalProfiles" + }, + { + "id": "script-api:dw/customer/Customer#externallyAuthenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.externallyAuthenticated", + "tags": [ + "externallyauthenticated", + "customer.externallyauthenticated" + ], + "title": "Customer.externallyAuthenticated" + }, + { + "id": "script-api:dw/customer/Customer#getActiveData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getActiveData", + "tags": [ + "getactivedata", + "customer.getactivedata" + ], + "title": "Customer.getActiveData" + }, + { + "id": "script-api:dw/customer/Customer#getAddressBook", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getAddressBook", + "tags": [ + "getaddressbook", + "customer.getaddressbook" + ], + "title": "Customer.getAddressBook" + }, + { + "id": "script-api:dw/customer/Customer#getCDPData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getCDPData", + "tags": [ + "getcdpdata", + "customer.getcdpdata" + ], + "title": "Customer.getCDPData" + }, + { + "id": "script-api:dw/customer/Customer#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getCustomerGroups", + "tags": [ + "getcustomergroups", + "customer.getcustomergroups" + ], + "title": "Customer.getCustomerGroups" + }, + { + "id": "script-api:dw/customer/Customer#getExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getExternalProfile", + "tags": [ + "getexternalprofile", + "customer.getexternalprofile" + ], + "title": "Customer.getExternalProfile" + }, + { + "id": "script-api:dw/customer/Customer#getExternalProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getExternalProfiles", + "tags": [ + "getexternalprofiles", + "customer.getexternalprofiles" + ], + "title": "Customer.getExternalProfiles" + }, + { + "id": "script-api:dw/customer/Customer#getGlobalPartyID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getGlobalPartyID", + "tags": [ + "getglobalpartyid", + "customer.getglobalpartyid" + ], + "title": "Customer.getGlobalPartyID" + }, + { + "id": "script-api:dw/customer/Customer#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getID", + "tags": [ + "getid", + "customer.getid" + ], + "title": "Customer.getID" + }, + { + "id": "script-api:dw/customer/Customer#getNote", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getNote", + "tags": [ + "getnote", + "customer.getnote" + ], + "title": "Customer.getNote" + }, + { + "id": "script-api:dw/customer/Customer#getOrderHistory", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getOrderHistory", + "tags": [ + "getorderhistory", + "customer.getorderhistory" + ], + "title": "Customer.getOrderHistory" + }, + { + "id": "script-api:dw/customer/Customer#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getProductLists", + "tags": [ + "getproductlists", + "customer.getproductlists" + ], + "title": "Customer.getProductLists" + }, + { + "id": "script-api:dw/customer/Customer#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getProfile", + "tags": [ + "getprofile", + "customer.getprofile" + ], + "title": "Customer.getProfile" + }, + { + "id": "script-api:dw/customer/Customer#globalPartyID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.globalPartyID", + "tags": [ + "globalpartyid", + "customer.globalpartyid" + ], + "title": "Customer.globalPartyID" + }, + { + "id": "script-api:dw/customer/Customer#isAnonymous", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isAnonymous", + "tags": [ + "isanonymous", + "customer.isanonymous" + ], + "title": "Customer.isAnonymous" + }, + { + "id": "script-api:dw/customer/Customer#isAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isAuthenticated", + "tags": [ + "isauthenticated", + "customer.isauthenticated" + ], + "title": "Customer.isAuthenticated" + }, + { + "id": "script-api:dw/customer/Customer#isExternallyAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isExternallyAuthenticated", + "tags": [ + "isexternallyauthenticated", + "customer.isexternallyauthenticated" + ], + "title": "Customer.isExternallyAuthenticated" + }, + { + "id": "script-api:dw/customer/Customer#isMemberOfAnyCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfAnyCustomerGroup", + "tags": [ + "ismemberofanycustomergroup", + "customer.ismemberofanycustomergroup" + ], + "title": "Customer.isMemberOfAnyCustomerGroup" + }, + { + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroup", + "tags": [ + "ismemberofcustomergroup", + "customer.ismemberofcustomergroup" + ], + "title": "Customer.isMemberOfCustomerGroup" + }, + { + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroup", + "tags": [ + "ismemberofcustomergroup", + "customer.ismemberofcustomergroup" + ], + "title": "Customer.isMemberOfCustomerGroup" + }, + { + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroups", + "tags": [ + "ismemberofcustomergroups", + "customer.ismemberofcustomergroups" + ], + "title": "Customer.isMemberOfCustomerGroups" + }, + { + "id": "script-api:dw/customer/Customer#isRegistered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isRegistered", + "tags": [ + "isregistered", + "customer.isregistered" + ], + "title": "Customer.isRegistered" + }, + { + "id": "script-api:dw/customer/Customer#note", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.note", + "tags": [ + "note", + "customer.note" + ], + "title": "Customer.note" + }, + { + "id": "script-api:dw/customer/Customer#orderHistory", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.orderHistory", + "tags": [ + "orderhistory", + "customer.orderhistory" + ], + "title": "Customer.orderHistory" + }, + { + "id": "script-api:dw/customer/Customer#profile", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.profile", + "tags": [ + "profile", + "customer.profile" + ], + "title": "Customer.profile" + }, + { + "id": "script-api:dw/customer/Customer#registered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.registered", + "tags": [ + "registered", + "customer.registered" + ], + "title": "Customer.registered" + }, + { + "id": "script-api:dw/customer/Customer#removeExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.removeExternalProfile", + "tags": [ + "removeexternalprofile", + "customer.removeexternalprofile" + ], + "title": "Customer.removeExternalProfile" + }, + { + "id": "script-api:dw/customer/Customer#setNote", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.setNote", + "tags": [ + "setnote", + "customer.setnote" + ], + "title": "Customer.setNote" + }, + { + "id": "script-api:dw/customer/CustomerActiveData", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerActiveData", + "tags": [ + "customeractivedata", + "dw.customer.customeractivedata", + "dw/customer" + ], + "title": "CustomerActiveData" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#avgOrderValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.avgOrderValue", + "tags": [ + "avgordervalue", + "customeractivedata.avgordervalue" + ], + "title": "CustomerActiveData.avgOrderValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#discountValueWithCoupon", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.discountValueWithCoupon", + "tags": [ + "discountvaluewithcoupon", + "customeractivedata.discountvaluewithcoupon" + ], + "title": "CustomerActiveData.discountValueWithCoupon" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#discountValueWithoutCoupon", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.discountValueWithoutCoupon", + "tags": [ + "discountvaluewithoutcoupon", + "customeractivedata.discountvaluewithoutcoupon" + ], + "title": "CustomerActiveData.discountValueWithoutCoupon" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getAvgOrderValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getAvgOrderValue", + "tags": [ + "getavgordervalue", + "customeractivedata.getavgordervalue" + ], + "title": "CustomerActiveData.getAvgOrderValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getDiscountValueWithCoupon", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getDiscountValueWithCoupon", + "tags": [ + "getdiscountvaluewithcoupon", + "customeractivedata.getdiscountvaluewithcoupon" + ], + "title": "CustomerActiveData.getDiscountValueWithCoupon" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getDiscountValueWithoutCoupon", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getDiscountValueWithoutCoupon", + "tags": [ + "getdiscountvaluewithoutcoupon", + "customeractivedata.getdiscountvaluewithoutcoupon" + ], + "title": "CustomerActiveData.getDiscountValueWithoutCoupon" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getGiftOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getGiftOrders", + "tags": [ + "getgiftorders", + "customeractivedata.getgiftorders" + ], + "title": "CustomerActiveData.getGiftOrders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getGiftUnits", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getGiftUnits", + "tags": [ + "getgiftunits", + "customeractivedata.getgiftunits" + ], + "title": "CustomerActiveData.getGiftUnits" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getLastOrderDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getLastOrderDate", + "tags": [ + "getlastorderdate", + "customeractivedata.getlastorderdate" + ], + "title": "CustomerActiveData.getLastOrderDate" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getOrderValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrderValue", + "tags": [ + "getordervalue", + "customeractivedata.getordervalue" + ], + "title": "CustomerActiveData.getOrderValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getOrderValueMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrderValueMonth", + "tags": [ + "getordervaluemonth", + "customeractivedata.getordervaluemonth" + ], + "title": "CustomerActiveData.getOrderValueMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrders", + "tags": [ + "getorders", + "customeractivedata.getorders" + ], + "title": "CustomerActiveData.getOrders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getProductMastersOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductMastersOrdered", + "tags": [ + "getproductmastersordered", + "customeractivedata.getproductmastersordered" + ], + "title": "CustomerActiveData.getProductMastersOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getProductsAbandonedMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsAbandonedMonth", + "tags": [ + "getproductsabandonedmonth", + "customeractivedata.getproductsabandonedmonth" + ], + "title": "CustomerActiveData.getProductsAbandonedMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getProductsOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsOrdered", + "tags": [ + "getproductsordered", + "customeractivedata.getproductsordered" + ], + "title": "CustomerActiveData.getProductsOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getProductsViewedMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsViewedMonth", + "tags": [ + "getproductsviewedmonth", + "customeractivedata.getproductsviewedmonth" + ], + "title": "CustomerActiveData.getProductsViewedMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getReturnValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getReturnValue", + "tags": [ + "getreturnvalue", + "customeractivedata.getreturnvalue" + ], + "title": "CustomerActiveData.getReturnValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getReturns", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getReturns", + "tags": [ + "getreturns", + "customeractivedata.getreturns" + ], + "title": "CustomerActiveData.getReturns" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getSourceCodeOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getSourceCodeOrders", + "tags": [ + "getsourcecodeorders", + "customeractivedata.getsourcecodeorders" + ], + "title": "CustomerActiveData.getSourceCodeOrders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getTopCategoriesOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getTopCategoriesOrdered", + "tags": [ + "gettopcategoriesordered", + "customeractivedata.gettopcategoriesordered" + ], + "title": "CustomerActiveData.getTopCategoriesOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getVisitsMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsMonth", + "tags": [ + "getvisitsmonth", + "customeractivedata.getvisitsmonth" + ], + "title": "CustomerActiveData.getVisitsMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getVisitsWeek", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsWeek", + "tags": [ + "getvisitsweek", + "customeractivedata.getvisitsweek" + ], + "title": "CustomerActiveData.getVisitsWeek" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#getVisitsYear", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsYear", + "tags": [ + "getvisitsyear", + "customeractivedata.getvisitsyear" + ], + "title": "CustomerActiveData.getVisitsYear" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#giftOrders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.giftOrders", + "tags": [ + "giftorders", + "customeractivedata.giftorders" + ], + "title": "CustomerActiveData.giftOrders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#giftUnits", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.giftUnits", + "tags": [ + "giftunits", + "customeractivedata.giftunits" + ], + "title": "CustomerActiveData.giftUnits" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#lastOrderDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.lastOrderDate", + "tags": [ + "lastorderdate", + "customeractivedata.lastorderdate" + ], + "title": "CustomerActiveData.lastOrderDate" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#orderValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orderValue", + "tags": [ + "ordervalue", + "customeractivedata.ordervalue" + ], + "title": "CustomerActiveData.orderValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#orderValueMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orderValueMonth", + "tags": [ + "ordervaluemonth", + "customeractivedata.ordervaluemonth" + ], + "title": "CustomerActiveData.orderValueMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#orders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orders", + "tags": [ + "orders", + "customeractivedata.orders" + ], + "title": "CustomerActiveData.orders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#productMastersOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productMastersOrdered", + "tags": [ + "productmastersordered", + "customeractivedata.productmastersordered" + ], + "title": "CustomerActiveData.productMastersOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#productsAbandonedMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsAbandonedMonth", + "tags": [ + "productsabandonedmonth", + "customeractivedata.productsabandonedmonth" + ], + "title": "CustomerActiveData.productsAbandonedMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#productsOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsOrdered", + "tags": [ + "productsordered", + "customeractivedata.productsordered" + ], + "title": "CustomerActiveData.productsOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#productsViewedMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsViewedMonth", + "tags": [ + "productsviewedmonth", + "customeractivedata.productsviewedmonth" + ], + "title": "CustomerActiveData.productsViewedMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#returnValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.returnValue", + "tags": [ + "returnvalue", + "customeractivedata.returnvalue" + ], + "title": "CustomerActiveData.returnValue" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#returns", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.returns", + "tags": [ + "returns", + "customeractivedata.returns" + ], + "title": "CustomerActiveData.returns" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#sourceCodeOrders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.sourceCodeOrders", + "tags": [ + "sourcecodeorders", + "customeractivedata.sourcecodeorders" + ], + "title": "CustomerActiveData.sourceCodeOrders" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#topCategoriesOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.topCategoriesOrdered", + "tags": [ + "topcategoriesordered", + "customeractivedata.topcategoriesordered" + ], + "title": "CustomerActiveData.topCategoriesOrdered" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#visitsMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsMonth", + "tags": [ + "visitsmonth", + "customeractivedata.visitsmonth" + ], + "title": "CustomerActiveData.visitsMonth" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#visitsWeek", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsWeek", + "tags": [ + "visitsweek", + "customeractivedata.visitsweek" + ], + "title": "CustomerActiveData.visitsWeek" + }, + { + "id": "script-api:dw/customer/CustomerActiveData#visitsYear", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsYear", + "tags": [ + "visitsyear", + "customeractivedata.visitsyear" + ], + "title": "CustomerActiveData.visitsYear" + }, + { + "id": "script-api:dw/customer/CustomerAddress", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerAddress", + "tags": [ + "customeraddress", + "dw.customer.customeraddress", + "dw/customer" + ], + "title": "CustomerAddress" + }, + { + "id": "script-api:dw/customer/CustomerAddress#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.ID", + "tags": [ + "id", + "customeraddress.id" + ], + "title": "CustomerAddress.ID" + }, + { + "id": "script-api:dw/customer/CustomerAddress#address1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.address1", + "tags": [ + "address1", + "customeraddress.address1" + ], + "title": "CustomerAddress.address1" + }, + { + "id": "script-api:dw/customer/CustomerAddress#address2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.address2", + "tags": [ + "address2", + "customeraddress.address2" + ], + "title": "CustomerAddress.address2" + }, + { + "id": "script-api:dw/customer/CustomerAddress#city", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.city", + "tags": [ + "city", + "customeraddress.city" + ], + "title": "CustomerAddress.city" + }, + { + "id": "script-api:dw/customer/CustomerAddress#companyName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.companyName", + "tags": [ + "companyname", + "customeraddress.companyname" + ], + "title": "CustomerAddress.companyName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#countryCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.countryCode", + "tags": [ + "countrycode", + "customeraddress.countrycode" + ], + "title": "CustomerAddress.countryCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.firstName", + "tags": [ + "firstname", + "customeraddress.firstname" + ], + "title": "CustomerAddress.firstName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#fullName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.fullName", + "tags": [ + "fullname", + "customeraddress.fullname" + ], + "title": "CustomerAddress.fullName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getAddress1", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getAddress1", + "tags": [ + "getaddress1", + "customeraddress.getaddress1" + ], + "title": "CustomerAddress.getAddress1" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getAddress2", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getAddress2", + "tags": [ + "getaddress2", + "customeraddress.getaddress2" + ], + "title": "CustomerAddress.getAddress2" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCity", + "tags": [ + "getcity", + "customeraddress.getcity" + ], + "title": "CustomerAddress.getCity" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCompanyName", + "tags": [ + "getcompanyname", + "customeraddress.getcompanyname" + ], + "title": "CustomerAddress.getCompanyName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCountryCode", + "tags": [ + "getcountrycode", + "customeraddress.getcountrycode" + ], + "title": "CustomerAddress.getCountryCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getFirstName", + "tags": [ + "getfirstname", + "customeraddress.getfirstname" + ], + "title": "CustomerAddress.getFirstName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getFullName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getFullName", + "tags": [ + "getfullname", + "customeraddress.getfullname" + ], + "title": "CustomerAddress.getFullName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getID", + "tags": [ + "getid", + "customeraddress.getid" + ], + "title": "CustomerAddress.getID" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getJobTitle", + "tags": [ + "getjobtitle", + "customeraddress.getjobtitle" + ], + "title": "CustomerAddress.getJobTitle" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getLastName", + "tags": [ + "getlastname", + "customeraddress.getlastname" + ], + "title": "CustomerAddress.getLastName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getPhone", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPhone", + "tags": [ + "getphone", + "customeraddress.getphone" + ], + "title": "CustomerAddress.getPhone" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getPostBox", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPostBox", + "tags": [ + "getpostbox", + "customeraddress.getpostbox" + ], + "title": "CustomerAddress.getPostBox" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPostalCode", + "tags": [ + "getpostalcode", + "customeraddress.getpostalcode" + ], + "title": "CustomerAddress.getPostalCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSalutation", + "tags": [ + "getsalutation", + "customeraddress.getsalutation" + ], + "title": "CustomerAddress.getSalutation" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSecondName", + "tags": [ + "getsecondname", + "customeraddress.getsecondname" + ], + "title": "CustomerAddress.getSecondName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getStateCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getStateCode", + "tags": [ + "getstatecode", + "customeraddress.getstatecode" + ], + "title": "CustomerAddress.getStateCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSuffix", + "tags": [ + "getsuffix", + "customeraddress.getsuffix" + ], + "title": "CustomerAddress.getSuffix" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getSuite", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSuite", + "tags": [ + "getsuite", + "customeraddress.getsuite" + ], + "title": "CustomerAddress.getSuite" + }, + { + "id": "script-api:dw/customer/CustomerAddress#getTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getTitle", + "tags": [ + "gettitle", + "customeraddress.gettitle" + ], + "title": "CustomerAddress.getTitle" + }, + { + "id": "script-api:dw/customer/CustomerAddress#isEquivalentAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.isEquivalentAddress", + "tags": [ + "isequivalentaddress", + "customeraddress.isequivalentaddress" + ], + "title": "CustomerAddress.isEquivalentAddress" + }, + { + "id": "script-api:dw/customer/CustomerAddress#jobTitle", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.jobTitle", + "tags": [ + "jobtitle", + "customeraddress.jobtitle" + ], + "title": "CustomerAddress.jobTitle" + }, + { + "id": "script-api:dw/customer/CustomerAddress#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.lastName", + "tags": [ + "lastname", + "customeraddress.lastname" + ], + "title": "CustomerAddress.lastName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#phone", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.phone", + "tags": [ + "phone", + "customeraddress.phone" + ], + "title": "CustomerAddress.phone" + }, + { + "id": "script-api:dw/customer/CustomerAddress#postBox", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.postBox", + "tags": [ + "postbox", + "customeraddress.postbox" + ], + "title": "CustomerAddress.postBox" + }, + { + "id": "script-api:dw/customer/CustomerAddress#postalCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.postalCode", + "tags": [ + "postalcode", + "customeraddress.postalcode" + ], + "title": "CustomerAddress.postalCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#salutation", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.salutation", + "tags": [ + "salutation", + "customeraddress.salutation" + ], + "title": "CustomerAddress.salutation" + }, + { + "id": "script-api:dw/customer/CustomerAddress#secondName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.secondName", + "tags": [ + "secondname", + "customeraddress.secondname" + ], + "title": "CustomerAddress.secondName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setAddress1", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setAddress1", + "tags": [ + "setaddress1", + "customeraddress.setaddress1" + ], + "title": "CustomerAddress.setAddress1" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setAddress2", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setAddress2", + "tags": [ + "setaddress2", + "customeraddress.setaddress2" + ], + "title": "CustomerAddress.setAddress2" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCity", + "tags": [ + "setcity", + "customeraddress.setcity" + ], + "title": "CustomerAddress.setCity" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCompanyName", + "tags": [ + "setcompanyname", + "customeraddress.setcompanyname" + ], + "title": "CustomerAddress.setCompanyName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setCountryCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCountryCode", + "tags": [ + "setcountrycode", + "customeraddress.setcountrycode" + ], + "title": "CustomerAddress.setCountryCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setFirstName", + "tags": [ + "setfirstname", + "customeraddress.setfirstname" + ], + "title": "CustomerAddress.setFirstName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setID", + "tags": [ + "setid", + "customeraddress.setid" + ], + "title": "CustomerAddress.setID" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setJobTitle", + "tags": [ + "setjobtitle", + "customeraddress.setjobtitle" + ], + "title": "CustomerAddress.setJobTitle" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setLastName", + "tags": [ + "setlastname", + "customeraddress.setlastname" + ], + "title": "CustomerAddress.setLastName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setPhone", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPhone", + "tags": [ + "setphone", + "customeraddress.setphone" + ], + "title": "CustomerAddress.setPhone" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setPostBox", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPostBox", + "tags": [ + "setpostbox", + "customeraddress.setpostbox" + ], + "title": "CustomerAddress.setPostBox" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setPostalCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPostalCode", + "tags": [ + "setpostalcode", + "customeraddress.setpostalcode" + ], + "title": "CustomerAddress.setPostalCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setSaluation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSaluation", + "tags": [ + "setsaluation", + "customeraddress.setsaluation" + ], + "title": "CustomerAddress.setSaluation" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSalutation", + "tags": [ + "setsalutation", + "customeraddress.setsalutation" + ], + "title": "CustomerAddress.setSalutation" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSecondName", + "tags": [ + "setsecondname", + "customeraddress.setsecondname" + ], + "title": "CustomerAddress.setSecondName" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setStateCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setStateCode", + "tags": [ + "setstatecode", + "customeraddress.setstatecode" + ], + "title": "CustomerAddress.setStateCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSuffix", + "tags": [ + "setsuffix", + "customeraddress.setsuffix" + ], + "title": "CustomerAddress.setSuffix" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setSuite", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSuite", + "tags": [ + "setsuite", + "customeraddress.setsuite" + ], + "title": "CustomerAddress.setSuite" + }, + { + "id": "script-api:dw/customer/CustomerAddress#setTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setTitle", + "tags": [ + "settitle", + "customeraddress.settitle" + ], + "title": "CustomerAddress.setTitle" + }, + { + "id": "script-api:dw/customer/CustomerAddress#stateCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.stateCode", + "tags": [ + "statecode", + "customeraddress.statecode" + ], + "title": "CustomerAddress.stateCode" + }, + { + "id": "script-api:dw/customer/CustomerAddress#suffix", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.suffix", + "tags": [ + "suffix", + "customeraddress.suffix" + ], + "title": "CustomerAddress.suffix" + }, + { + "id": "script-api:dw/customer/CustomerAddress#suite", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.suite", + "tags": [ + "suite", + "customeraddress.suite" + ], + "title": "CustomerAddress.suite" + }, + { + "id": "script-api:dw/customer/CustomerAddress#title", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.title", + "tags": [ + "title", + "customeraddress.title" + ], + "title": "CustomerAddress.title" + }, + { + "id": "script-api:dw/customer/CustomerCDPData", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerCDPData", + "tags": [ + "customercdpdata", + "dw.customer.customercdpdata", + "dw/customer" + ], + "title": "CustomerCDPData" + }, + { + "id": "script-api:dw/customer/CustomerCDPData#empty", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.empty", + "tags": [ + "empty", + "customercdpdata.empty" + ], + "title": "CustomerCDPData.empty" + }, + { + "id": "script-api:dw/customer/CustomerCDPData#getSegments", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.getSegments", + "tags": [ + "getsegments", + "customercdpdata.getsegments" + ], + "title": "CustomerCDPData.getSegments" + }, + { + "id": "script-api:dw/customer/CustomerCDPData#isEmpty", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.isEmpty", + "tags": [ + "isempty", + "customercdpdata.isempty" + ], + "title": "CustomerCDPData.isEmpty" + }, + { + "id": "script-api:dw/customer/CustomerCDPData#segments", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.segments", + "tags": [ + "segments", + "customercdpdata.segments" + ], + "title": "CustomerCDPData.segments" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerContextMgr", + "tags": [ + "customercontextmgr", + "dw.customer.customercontextmgr", + "dw/customer" + ], + "title": "CustomerContextMgr" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#effectiveTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.effectiveTime", + "tags": [ + "effectivetime", + "customercontextmgr.effectivetime" + ], + "title": "CustomerContextMgr.effectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#effectiveTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.effectiveTime", + "tags": [ + "effectivetime", + "customercontextmgr.effectivetime" + ], + "title": "CustomerContextMgr.effectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#getEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.getEffectiveTime", + "tags": [ + "geteffectivetime", + "customercontextmgr.geteffectivetime" + ], + "title": "CustomerContextMgr.getEffectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#getEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.getEffectiveTime", + "tags": [ + "geteffectivetime", + "customercontextmgr.geteffectivetime" + ], + "title": "CustomerContextMgr.getEffectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#setEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.setEffectiveTime", + "tags": [ + "seteffectivetime", + "customercontextmgr.seteffectivetime" + ], + "title": "CustomerContextMgr.setEffectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerContextMgr#setEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.setEffectiveTime", + "tags": [ + "seteffectivetime", + "customercontextmgr.seteffectivetime" + ], + "title": "CustomerContextMgr.setEffectiveTime" + }, + { + "id": "script-api:dw/customer/CustomerGroup", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerGroup", + "tags": [ + "customergroup", + "dw.customer.customergroup", + "dw/customer" + ], + "title": "CustomerGroup" + }, + { + "id": "script-api:dw/customer/CustomerGroup#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.ID", + "tags": [ + "id", + "customergroup.id" + ], + "title": "CustomerGroup.ID" + }, + { + "id": "script-api:dw/customer/CustomerGroup#assignCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.assignCustomer", + "tags": [ + "assigncustomer", + "customergroup.assigncustomer" + ], + "title": "CustomerGroup.assignCustomer" + }, + { + "id": "script-api:dw/customer/CustomerGroup#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.description", + "tags": [ + "description", + "customergroup.description" + ], + "title": "CustomerGroup.description" + }, + { + "id": "script-api:dw/customer/CustomerGroup#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.getDescription", + "tags": [ + "getdescription", + "customergroup.getdescription" + ], + "title": "CustomerGroup.getDescription" + }, + { + "id": "script-api:dw/customer/CustomerGroup#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.getID", + "tags": [ + "getid", + "customergroup.getid" + ], + "title": "CustomerGroup.getID" + }, + { + "id": "script-api:dw/customer/CustomerGroup#isRuleBased", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.isRuleBased", + "tags": [ + "isrulebased", + "customergroup.isrulebased" + ], + "title": "CustomerGroup.isRuleBased" + }, + { + "id": "script-api:dw/customer/CustomerGroup#ruleBased", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.ruleBased", + "tags": [ + "rulebased", + "customergroup.rulebased" + ], + "title": "CustomerGroup.ruleBased" + }, + { + "id": "script-api:dw/customer/CustomerGroup#unassignCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.unassignCustomer", + "tags": [ + "unassigncustomer", + "customergroup.unassigncustomer" + ], + "title": "CustomerGroup.unassignCustomer" + }, + { + "id": "script-api:dw/customer/CustomerList", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerList", + "tags": [ + "customerlist", + "dw.customer.customerlist", + "dw/customer" + ], + "title": "CustomerList" + }, + { + "id": "script-api:dw/customer/CustomerList#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.ID", + "tags": [ + "id", + "customerlist.id" + ], + "title": "CustomerList.ID" + }, + { + "id": "script-api:dw/customer/CustomerList#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.description", + "tags": [ + "description", + "customerlist.description" + ], + "title": "CustomerList.description" + }, + { + "id": "script-api:dw/customer/CustomerList#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.getDescription", + "tags": [ + "getdescription", + "customerlist.getdescription" + ], + "title": "CustomerList.getDescription" + }, + { + "id": "script-api:dw/customer/CustomerList#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.getID", + "tags": [ + "getid", + "customerlist.getid" + ], + "title": "CustomerList.getID" + }, + { + "id": "script-api:dw/customer/CustomerMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerMgr", + "tags": [ + "customermgr", + "dw.customer.customermgr", + "dw/customer" + ], + "title": "CustomerMgr" + }, + { + "id": "script-api:dw/customer/CustomerMgr#authenticateCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.authenticateCustomer", + "tags": [ + "authenticatecustomer", + "customermgr.authenticatecustomer" + ], + "title": "CustomerMgr.authenticateCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#authenticateCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.authenticateCustomer", + "tags": [ + "authenticatecustomer", + "customermgr.authenticatecustomer" + ], + "title": "CustomerMgr.authenticateCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createExternallyAuthenticatedCustomer", + "tags": [ + "createexternallyauthenticatedcustomer", + "customermgr.createexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.createExternallyAuthenticatedCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#createExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createExternallyAuthenticatedCustomer", + "tags": [ + "createexternallyauthenticatedcustomer", + "customermgr.createexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.createExternallyAuthenticatedCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.customerGroups", + "tags": [ + "customergroups", + "customermgr.customergroups" + ], + "title": "CustomerMgr.customerGroups" + }, + { + "id": "script-api:dw/customer/CustomerMgr#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.customerGroups", + "tags": [ + "customergroups", + "customermgr.customergroups" + ], + "title": "CustomerMgr.customerGroups" + }, + { + "id": "script-api:dw/customer/CustomerMgr#describeProfileType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.describeProfileType", + "tags": [ + "describeprofiletype", + "customermgr.describeprofiletype" + ], + "title": "CustomerMgr.describeProfileType" + }, + { + "id": "script-api:dw/customer/CustomerMgr#describeProfileType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.describeProfileType", + "tags": [ + "describeprofiletype", + "customermgr.describeprofiletype" + ], + "title": "CustomerMgr.describeProfileType" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByCustomerNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByCustomerNumber", + "tags": [ + "getcustomerbycustomernumber", + "customermgr.getcustomerbycustomernumber" + ], + "title": "CustomerMgr.getCustomerByCustomerNumber" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByCustomerNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByCustomerNumber", + "tags": [ + "getcustomerbycustomernumber", + "customermgr.getcustomerbycustomernumber" + ], + "title": "CustomerMgr.getCustomerByCustomerNumber" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByLogin", + "tags": [ + "getcustomerbylogin", + "customermgr.getcustomerbylogin" + ], + "title": "CustomerMgr.getCustomerByLogin" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByLogin", + "tags": [ + "getcustomerbylogin", + "customermgr.getcustomerbylogin" + ], + "title": "CustomerMgr.getCustomerByLogin" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByToken", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByToken", + "tags": [ + "getcustomerbytoken", + "customermgr.getcustomerbytoken" + ], + "title": "CustomerMgr.getCustomerByToken" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerByToken", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByToken", + "tags": [ + "getcustomerbytoken", + "customermgr.getcustomerbytoken" + ], + "title": "CustomerMgr.getCustomerByToken" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroup", + "tags": [ + "getcustomergroup", + "customermgr.getcustomergroup" + ], + "title": "CustomerMgr.getCustomerGroup" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroup", + "tags": [ + "getcustomergroup", + "customermgr.getcustomergroup" + ], + "title": "CustomerMgr.getCustomerGroup" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroups", + "tags": [ + "getcustomergroups", + "customermgr.getcustomergroups" + ], + "title": "CustomerMgr.getCustomerGroups" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroups", + "tags": [ + "getcustomergroups", + "customermgr.getcustomergroups" + ], + "title": "CustomerMgr.getCustomerGroups" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerList", + "tags": [ + "getcustomerlist", + "customermgr.getcustomerlist" + ], + "title": "CustomerMgr.getCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerList", + "tags": [ + "getcustomerlist", + "customermgr.getcustomerlist" + ], + "title": "CustomerMgr.getCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getExternallyAuthenticatedCustomerProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getExternallyAuthenticatedCustomerProfile", + "tags": [ + "getexternallyauthenticatedcustomerprofile", + "customermgr.getexternallyauthenticatedcustomerprofile" + ], + "title": "CustomerMgr.getExternallyAuthenticatedCustomerProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getExternallyAuthenticatedCustomerProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getExternallyAuthenticatedCustomerProfile", + "tags": [ + "getexternallyauthenticatedcustomerprofile", + "customermgr.getexternallyauthenticatedcustomerprofile" + ], + "title": "CustomerMgr.getExternallyAuthenticatedCustomerProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getPasswordConstraints", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getPasswordConstraints", + "tags": [ + "getpasswordconstraints", + "customermgr.getpasswordconstraints" + ], + "title": "CustomerMgr.getPasswordConstraints" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getPasswordConstraints", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getPasswordConstraints", + "tags": [ + "getpasswordconstraints", + "customermgr.getpasswordconstraints" + ], + "title": "CustomerMgr.getPasswordConstraints" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getProfile", + "tags": [ + "getprofile", + "customermgr.getprofile" + ], + "title": "CustomerMgr.getProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getProfile", + "tags": [ + "getprofile", + "customermgr.getprofile" + ], + "title": "CustomerMgr.getProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getRegisteredCustomerCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getRegisteredCustomerCount", + "tags": [ + "getregisteredcustomercount", + "customermgr.getregisteredcustomercount" + ], + "title": "CustomerMgr.getRegisteredCustomerCount" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getRegisteredCustomerCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getRegisteredCustomerCount", + "tags": [ + "getregisteredcustomercount", + "customermgr.getregisteredcustomercount" + ], + "title": "CustomerMgr.getRegisteredCustomerCount" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getSiteCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getSiteCustomerList", + "tags": [ + "getsitecustomerlist", + "customermgr.getsitecustomerlist" + ], + "title": "CustomerMgr.getSiteCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerMgr#getSiteCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getSiteCustomerList", + "tags": [ + "getsitecustomerlist", + "customermgr.getsitecustomerlist" + ], + "title": "CustomerMgr.getSiteCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerMgr#isAcceptablePassword", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isAcceptablePassword", + "tags": [ + "isacceptablepassword", + "customermgr.isacceptablepassword" + ], + "title": "CustomerMgr.isAcceptablePassword" + }, + { + "id": "script-api:dw/customer/CustomerMgr#isAcceptablePassword", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isAcceptablePassword", + "tags": [ + "isacceptablepassword", + "customermgr.isacceptablepassword" + ], + "title": "CustomerMgr.isAcceptablePassword" + }, + { + "id": "script-api:dw/customer/CustomerMgr#isPasswordExpired", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isPasswordExpired", + "tags": [ + "ispasswordexpired", + "customermgr.ispasswordexpired" + ], + "title": "CustomerMgr.isPasswordExpired" + }, + { + "id": "script-api:dw/customer/CustomerMgr#isPasswordExpired", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isPasswordExpired", + "tags": [ + "ispasswordexpired", + "customermgr.ispasswordexpired" + ], + "title": "CustomerMgr.isPasswordExpired" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginExternallyAuthenticatedCustomer", + "tags": [ + "loginexternallyauthenticatedcustomer", + "customermgr.loginexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.loginExternallyAuthenticatedCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#loginExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginExternallyAuthenticatedCustomer", + "tags": [ + "loginexternallyauthenticatedcustomer", + "customermgr.loginexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.loginExternallyAuthenticatedCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#logoutCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.logoutCustomer", + "tags": [ + "logoutcustomer", + "customermgr.logoutcustomer" + ], + "title": "CustomerMgr.logoutCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#logoutCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.logoutCustomer", + "tags": [ + "logoutcustomer", + "customermgr.logoutcustomer" + ], + "title": "CustomerMgr.logoutCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#passwordConstraints", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.passwordConstraints", + "tags": [ + "passwordconstraints", + "customermgr.passwordconstraints" + ], + "title": "CustomerMgr.passwordConstraints" + }, + { + "id": "script-api:dw/customer/CustomerMgr#passwordConstraints", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.passwordConstraints", + "tags": [ + "passwordconstraints", + "customermgr.passwordconstraints" + ], + "title": "CustomerMgr.passwordConstraints" + }, + { + "id": "script-api:dw/customer/CustomerMgr#processProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.processProfiles", + "tags": [ + "processprofiles", + "customermgr.processprofiles" + ], + "title": "CustomerMgr.processProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#processProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.processProfiles", + "tags": [ + "processprofiles", + "customermgr.processprofiles" + ], + "title": "CustomerMgr.processProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfile", + "tags": [ + "queryprofile", + "customermgr.queryprofile" + ], + "title": "CustomerMgr.queryProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfile", + "tags": [ + "queryprofile", + "customermgr.queryprofile" + ], + "title": "CustomerMgr.queryProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#registeredCustomerCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.registeredCustomerCount", + "tags": [ + "registeredcustomercount", + "customermgr.registeredcustomercount" + ], + "title": "CustomerMgr.registeredCustomerCount" + }, + { + "id": "script-api:dw/customer/CustomerMgr#registeredCustomerCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.registeredCustomerCount", + "tags": [ + "registeredcustomercount", + "customermgr.registeredcustomercount" + ], + "title": "CustomerMgr.registeredCustomerCount" + }, + { + "id": "script-api:dw/customer/CustomerMgr#removeCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomer", + "tags": [ + "removecustomer", + "customermgr.removecustomer" + ], + "title": "CustomerMgr.removeCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#removeCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomer", + "tags": [ + "removecustomer", + "customermgr.removecustomer" + ], + "title": "CustomerMgr.removeCustomer" + }, + { + "id": "script-api:dw/customer/CustomerMgr#removeCustomerTrackingData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomerTrackingData", + "tags": [ + "removecustomertrackingdata", + "customermgr.removecustomertrackingdata" + ], + "title": "CustomerMgr.removeCustomerTrackingData" + }, + { + "id": "script-api:dw/customer/CustomerMgr#removeCustomerTrackingData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomerTrackingData", + "tags": [ + "removecustomertrackingdata", + "customermgr.removecustomertrackingdata" + ], + "title": "CustomerMgr.removeCustomerTrackingData" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfile", + "tags": [ + "searchprofile", + "customermgr.searchprofile" + ], + "title": "CustomerMgr.searchProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfile", + "tags": [ + "searchprofile", + "customermgr.searchprofile" + ], + "title": "CustomerMgr.searchProfile" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "id": "script-api:dw/customer/CustomerMgr#siteCustomerList", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.siteCustomerList", + "tags": [ + "sitecustomerlist", + "customermgr.sitecustomerlist" + ], + "title": "CustomerMgr.siteCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerMgr#siteCustomerList", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.siteCustomerList", + "tags": [ + "sitecustomerlist", + "customermgr.sitecustomerlist" + ], + "title": "CustomerMgr.siteCustomerList" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerPasswordConstraints", + "tags": [ + "customerpasswordconstraints", + "dw.customer.customerpasswordconstraints", + "dw/customer" + ], + "title": "CustomerPasswordConstraints" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceLetters", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceLetters", + "tags": [ + "forceletters", + "customerpasswordconstraints.forceletters" + ], + "title": "CustomerPasswordConstraints.forceLetters" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceLetters", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceLetters", + "tags": [ + "forceletters", + "customerpasswordconstraints.forceletters" + ], + "title": "CustomerPasswordConstraints.forceLetters" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceMixedCase", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceMixedCase", + "tags": [ + "forcemixedcase", + "customerpasswordconstraints.forcemixedcase" + ], + "title": "CustomerPasswordConstraints.forceMixedCase" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceMixedCase", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceMixedCase", + "tags": [ + "forcemixedcase", + "customerpasswordconstraints.forcemixedcase" + ], + "title": "CustomerPasswordConstraints.forceMixedCase" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceNumbers", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceNumbers", + "tags": [ + "forcenumbers", + "customerpasswordconstraints.forcenumbers" + ], + "title": "CustomerPasswordConstraints.forceNumbers" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceNumbers", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceNumbers", + "tags": [ + "forcenumbers", + "customerpasswordconstraints.forcenumbers" + ], + "title": "CustomerPasswordConstraints.forceNumbers" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinLength", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinLength", + "tags": [ + "getminlength", + "customerpasswordconstraints.getminlength" + ], + "title": "CustomerPasswordConstraints.getMinLength" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinLength", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinLength", + "tags": [ + "getminlength", + "customerpasswordconstraints.getminlength" + ], + "title": "CustomerPasswordConstraints.getMinLength" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinSpecialChars", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinSpecialChars", + "tags": [ + "getminspecialchars", + "customerpasswordconstraints.getminspecialchars" + ], + "title": "CustomerPasswordConstraints.getMinSpecialChars" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinSpecialChars", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinSpecialChars", + "tags": [ + "getminspecialchars", + "customerpasswordconstraints.getminspecialchars" + ], + "title": "CustomerPasswordConstraints.getMinSpecialChars" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceLetters", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceLetters", + "tags": [ + "isforceletters", + "customerpasswordconstraints.isforceletters" + ], + "title": "CustomerPasswordConstraints.isForceLetters" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceLetters", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceLetters", + "tags": [ + "isforceletters", + "customerpasswordconstraints.isforceletters" + ], + "title": "CustomerPasswordConstraints.isForceLetters" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceMixedCase", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceMixedCase", + "tags": [ + "isforcemixedcase", + "customerpasswordconstraints.isforcemixedcase" + ], + "title": "CustomerPasswordConstraints.isForceMixedCase" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceMixedCase", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceMixedCase", + "tags": [ + "isforcemixedcase", + "customerpasswordconstraints.isforcemixedcase" + ], + "title": "CustomerPasswordConstraints.isForceMixedCase" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceNumbers", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceNumbers", + "tags": [ + "isforcenumbers", + "customerpasswordconstraints.isforcenumbers" + ], + "title": "CustomerPasswordConstraints.isForceNumbers" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceNumbers", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceNumbers", + "tags": [ + "isforcenumbers", + "customerpasswordconstraints.isforcenumbers" + ], + "title": "CustomerPasswordConstraints.isForceNumbers" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#minLength", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minLength", + "tags": [ + "minlength", + "customerpasswordconstraints.minlength" + ], + "title": "CustomerPasswordConstraints.minLength" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#minLength", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minLength", + "tags": [ + "minlength", + "customerpasswordconstraints.minlength" + ], + "title": "CustomerPasswordConstraints.minLength" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#minSpecialChars", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minSpecialChars", + "tags": [ + "minspecialchars", + "customerpasswordconstraints.minspecialchars" + ], + "title": "CustomerPasswordConstraints.minSpecialChars" + }, + { + "id": "script-api:dw/customer/CustomerPasswordConstraints#minSpecialChars", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minSpecialChars", + "tags": [ + "minspecialchars", + "customerpasswordconstraints.minspecialchars" + ], + "title": "CustomerPasswordConstraints.minSpecialChars" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerPaymentInstrument", + "tags": [ + "customerpaymentinstrument", + "dw.customer.customerpaymentinstrument", + "dw/customer" + ], + "title": "CustomerPaymentInstrument" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.bankAccountDriversLicense", + "tags": [ + "bankaccountdriverslicense", + "customerpaymentinstrument.bankaccountdriverslicense" + ], + "title": "CustomerPaymentInstrument.bankAccountDriversLicense" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.bankAccountNumber", + "tags": [ + "bankaccountnumber", + "customerpaymentinstrument.bankaccountnumber" + ], + "title": "CustomerPaymentInstrument.bankAccountNumber" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.creditCardNumber", + "tags": [ + "creditcardnumber", + "customerpaymentinstrument.creditcardnumber" + ], + "title": "CustomerPaymentInstrument.creditCardNumber" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getBankAccountDriversLicense", + "tags": [ + "getbankaccountdriverslicense", + "customerpaymentinstrument.getbankaccountdriverslicense" + ], + "title": "CustomerPaymentInstrument.getBankAccountDriversLicense" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getBankAccountNumber", + "tags": [ + "getbankaccountnumber", + "customerpaymentinstrument.getbankaccountnumber" + ], + "title": "CustomerPaymentInstrument.getBankAccountNumber" + }, + { + "id": "script-api:dw/customer/CustomerPaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getCreditCardNumber", + "tags": [ + "getcreditcardnumber", + "customerpaymentinstrument.getcreditcardnumber" + ], + "title": "CustomerPaymentInstrument.getCreditCardNumber" + }, + { + "id": "script-api:dw/customer/CustomerStatusCodes", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerStatusCodes", + "tags": [ + "customerstatuscodes", + "dw.customer.customerstatuscodes", + "dw/customer" + ], + "title": "CustomerStatusCodes" + }, + { + "id": "script-api:dw/customer/CustomerStatusCodes#CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerStatusCodes", + "qualifiedName": "dw.customer.CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "tags": [ + "customer_address_referenced_by_product_list", + "customerstatuscodes.customer_address_referenced_by_product_list" + ], + "title": "CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST" + }, + { + "id": "script-api:dw/customer/CustomerStatusCodes#CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerStatusCodes", + "qualifiedName": "dw.customer.CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "tags": [ + "customer_address_referenced_by_product_list", + "customerstatuscodes.customer_address_referenced_by_product_list" + ], + "title": "CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST" + }, + { + "id": "script-api:dw/customer/EncryptedObject", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.EncryptedObject", + "tags": [ + "encryptedobject", + "dw.customer.encryptedobject", + "dw/customer" + ], + "title": "EncryptedObject" + }, + { + "id": "script-api:dw/customer/ExternalProfile", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ExternalProfile", + "tags": [ + "externalprofile", + "dw.customer.externalprofile", + "dw/customer" + ], + "title": "ExternalProfile" + }, + { + "id": "script-api:dw/customer/ExternalProfile#authenticationProviderID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.authenticationProviderID", + "tags": [ + "authenticationproviderid", + "externalprofile.authenticationproviderid" + ], + "title": "ExternalProfile.authenticationProviderID" + }, + { + "id": "script-api:dw/customer/ExternalProfile#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.customer", + "tags": [ + "customer", + "externalprofile.customer" + ], + "title": "ExternalProfile.customer" + }, + { + "id": "script-api:dw/customer/ExternalProfile#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.email", + "tags": [ + "email", + "externalprofile.email" + ], + "title": "ExternalProfile.email" + }, + { + "id": "script-api:dw/customer/ExternalProfile#externalID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.externalID", + "tags": [ + "externalid", + "externalprofile.externalid" + ], + "title": "ExternalProfile.externalID" + }, + { + "id": "script-api:dw/customer/ExternalProfile#getAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getAuthenticationProviderID", + "tags": [ + "getauthenticationproviderid", + "externalprofile.getauthenticationproviderid" + ], + "title": "ExternalProfile.getAuthenticationProviderID" + }, + { + "id": "script-api:dw/customer/ExternalProfile#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getCustomer", + "tags": [ + "getcustomer", + "externalprofile.getcustomer" + ], + "title": "ExternalProfile.getCustomer" + }, + { + "id": "script-api:dw/customer/ExternalProfile#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getEmail", + "tags": [ + "getemail", + "externalprofile.getemail" + ], + "title": "ExternalProfile.getEmail" + }, + { + "id": "script-api:dw/customer/ExternalProfile#getExternalID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getExternalID", + "tags": [ + "getexternalid", + "externalprofile.getexternalid" + ], + "title": "ExternalProfile.getExternalID" + }, + { + "id": "script-api:dw/customer/ExternalProfile#getLastLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getLastLoginTime", + "tags": [ + "getlastlogintime", + "externalprofile.getlastlogintime" + ], + "title": "ExternalProfile.getLastLoginTime" + }, + { + "id": "script-api:dw/customer/ExternalProfile#lastLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.lastLoginTime", + "tags": [ + "lastlogintime", + "externalprofile.lastlogintime" + ], + "title": "ExternalProfile.lastLoginTime" + }, + { + "id": "script-api:dw/customer/ExternalProfile#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.setEmail", + "tags": [ + "setemail", + "externalprofile.setemail" + ], + "title": "ExternalProfile.setEmail" + }, + { + "id": "script-api:dw/customer/OrderHistory", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.OrderHistory", + "tags": [ + "orderhistory", + "dw.customer.orderhistory", + "dw/customer" + ], + "title": "OrderHistory" + }, + { + "id": "script-api:dw/customer/OrderHistory#getOrderCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrderCount", + "tags": [ + "getordercount", + "orderhistory.getordercount" + ], + "title": "OrderHistory.getOrderCount" + }, + { + "id": "script-api:dw/customer/OrderHistory#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrders", + "tags": [ + "getorders", + "orderhistory.getorders" + ], + "title": "OrderHistory.getOrders" + }, + { + "id": "script-api:dw/customer/OrderHistory#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrders", + "tags": [ + "getorders", + "orderhistory.getorders" + ], + "title": "OrderHistory.getOrders" + }, + { + "id": "script-api:dw/customer/OrderHistory#orderCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.orderCount", + "tags": [ + "ordercount", + "orderhistory.ordercount" + ], + "title": "OrderHistory.orderCount" + }, + { + "id": "script-api:dw/customer/OrderHistory#orders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.orders", + "tags": [ + "orders", + "orderhistory.orders" + ], + "title": "OrderHistory.orders" + }, + { + "id": "script-api:dw/customer/ProductList", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductList", + "tags": [ + "productlist", + "dw.customer.productlist", + "dw/customer" + ], + "title": "ProductList" + }, + { + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_EXPORTED", + "tags": [ + "export_status_exported", + "productlist.export_status_exported" + ], + "title": "ProductList.EXPORT_STATUS_EXPORTED" + }, + { + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_EXPORTED", + "tags": [ + "export_status_exported", + "productlist.export_status_exported" + ], + "title": "ProductList.EXPORT_STATUS_EXPORTED" + }, + { + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_NOTEXPORTED", + "tags": [ + "export_status_notexported", + "productlist.export_status_notexported" + ], + "title": "ProductList.EXPORT_STATUS_NOTEXPORTED" + }, + { + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_NOTEXPORTED", + "tags": [ + "export_status_notexported", + "productlist.export_status_notexported" + ], + "title": "ProductList.EXPORT_STATUS_NOTEXPORTED" + }, + { + "id": "script-api:dw/customer/ProductList#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.ID", + "tags": [ + "id", + "productlist.id" + ], + "title": "ProductList.ID" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_1", + "tags": [ + "type_custom_1", + "productlist.type_custom_1" + ], + "title": "ProductList.TYPE_CUSTOM_1" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_1", + "tags": [ + "type_custom_1", + "productlist.type_custom_1" + ], + "title": "ProductList.TYPE_CUSTOM_1" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_2", + "tags": [ + "type_custom_2", + "productlist.type_custom_2" + ], + "title": "ProductList.TYPE_CUSTOM_2" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_2", + "tags": [ + "type_custom_2", + "productlist.type_custom_2" + ], + "title": "ProductList.TYPE_CUSTOM_2" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_3", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_3", + "tags": [ + "type_custom_3", + "productlist.type_custom_3" + ], + "title": "ProductList.TYPE_CUSTOM_3" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_3", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_3", + "tags": [ + "type_custom_3", + "productlist.type_custom_3" + ], + "title": "ProductList.TYPE_CUSTOM_3" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_GIFT_REGISTRY", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_GIFT_REGISTRY", + "tags": [ + "type_gift_registry", + "productlist.type_gift_registry" + ], + "title": "ProductList.TYPE_GIFT_REGISTRY" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_GIFT_REGISTRY", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_GIFT_REGISTRY", + "tags": [ + "type_gift_registry", + "productlist.type_gift_registry" + ], + "title": "ProductList.TYPE_GIFT_REGISTRY" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_SHOPPING_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_SHOPPING_LIST", + "tags": [ + "type_shopping_list", + "productlist.type_shopping_list" + ], + "title": "ProductList.TYPE_SHOPPING_LIST" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_SHOPPING_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_SHOPPING_LIST", + "tags": [ + "type_shopping_list", + "productlist.type_shopping_list" + ], + "title": "ProductList.TYPE_SHOPPING_LIST" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_WISH_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_WISH_LIST", + "tags": [ + "type_wish_list", + "productlist.type_wish_list" + ], + "title": "ProductList.TYPE_WISH_LIST" + }, + { + "id": "script-api:dw/customer/ProductList#TYPE_WISH_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_WISH_LIST", + "tags": [ + "type_wish_list", + "productlist.type_wish_list" + ], + "title": "ProductList.TYPE_WISH_LIST" + }, + { + "id": "script-api:dw/customer/ProductList#anonymous", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.anonymous", + "tags": [ + "anonymous", + "productlist.anonymous" + ], + "title": "ProductList.anonymous" + }, + { + "id": "script-api:dw/customer/ProductList#coRegistrant", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.coRegistrant", + "tags": [ + "coregistrant", + "productlist.coregistrant" + ], + "title": "ProductList.coRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#createCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createCoRegistrant", + "tags": [ + "createcoregistrant", + "productlist.createcoregistrant" + ], + "title": "ProductList.createCoRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#createGiftCertificateItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createGiftCertificateItem", + "tags": [ + "creategiftcertificateitem", + "productlist.creategiftcertificateitem" + ], + "title": "ProductList.createGiftCertificateItem" + }, + { + "id": "script-api:dw/customer/ProductList#createProductItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createProductItem", + "tags": [ + "createproductitem", + "productlist.createproductitem" + ], + "title": "ProductList.createProductItem" + }, + { + "id": "script-api:dw/customer/ProductList#createRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createRegistrant", + "tags": [ + "createregistrant", + "productlist.createregistrant" + ], + "title": "ProductList.createRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#currentShippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.currentShippingAddress", + "tags": [ + "currentshippingaddress", + "productlist.currentshippingaddress" + ], + "title": "ProductList.currentShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.description", + "tags": [ + "description", + "productlist.description" + ], + "title": "ProductList.description" + }, + { + "id": "script-api:dw/customer/ProductList#eventCity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventCity", + "tags": [ + "eventcity", + "productlist.eventcity" + ], + "title": "ProductList.eventCity" + }, + { + "id": "script-api:dw/customer/ProductList#eventCountry", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventCountry", + "tags": [ + "eventcountry", + "productlist.eventcountry" + ], + "title": "ProductList.eventCountry" + }, + { + "id": "script-api:dw/customer/ProductList#eventDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventDate", + "tags": [ + "eventdate", + "productlist.eventdate" + ], + "title": "ProductList.eventDate" + }, + { + "id": "script-api:dw/customer/ProductList#eventState", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventState", + "tags": [ + "eventstate", + "productlist.eventstate" + ], + "title": "ProductList.eventState" + }, + { + "id": "script-api:dw/customer/ProductList#eventType", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventType", + "tags": [ + "eventtype", + "productlist.eventtype" + ], + "title": "ProductList.eventType" + }, + { + "id": "script-api:dw/customer/ProductList#exportStatus", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.exportStatus", + "tags": [ + "exportstatus", + "productlist.exportstatus" + ], + "title": "ProductList.exportStatus" + }, + { + "id": "script-api:dw/customer/ProductList#getCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getCoRegistrant", + "tags": [ + "getcoregistrant", + "productlist.getcoregistrant" + ], + "title": "ProductList.getCoRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#getCurrentShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getCurrentShippingAddress", + "tags": [ + "getcurrentshippingaddress", + "productlist.getcurrentshippingaddress" + ], + "title": "ProductList.getCurrentShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getDescription", + "tags": [ + "getdescription", + "productlist.getdescription" + ], + "title": "ProductList.getDescription" + }, + { + "id": "script-api:dw/customer/ProductList#getEventCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventCity", + "tags": [ + "geteventcity", + "productlist.geteventcity" + ], + "title": "ProductList.getEventCity" + }, + { + "id": "script-api:dw/customer/ProductList#getEventCountry", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventCountry", + "tags": [ + "geteventcountry", + "productlist.geteventcountry" + ], + "title": "ProductList.getEventCountry" + }, + { + "id": "script-api:dw/customer/ProductList#getEventDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventDate", + "tags": [ + "geteventdate", + "productlist.geteventdate" + ], + "title": "ProductList.getEventDate" + }, + { + "id": "script-api:dw/customer/ProductList#getEventState", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventState", + "tags": [ + "geteventstate", + "productlist.geteventstate" + ], + "title": "ProductList.getEventState" + }, + { + "id": "script-api:dw/customer/ProductList#getEventType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventType", + "tags": [ + "geteventtype", + "productlist.geteventtype" + ], + "title": "ProductList.getEventType" + }, + { + "id": "script-api:dw/customer/ProductList#getExportStatus", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getExportStatus", + "tags": [ + "getexportstatus", + "productlist.getexportstatus" + ], + "title": "ProductList.getExportStatus" + }, + { + "id": "script-api:dw/customer/ProductList#getGiftCertificateItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getGiftCertificateItem", + "tags": [ + "getgiftcertificateitem", + "productlist.getgiftcertificateitem" + ], + "title": "ProductList.getGiftCertificateItem" + }, + { + "id": "script-api:dw/customer/ProductList#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getID", + "tags": [ + "getid", + "productlist.getid" + ], + "title": "ProductList.getID" + }, + { + "id": "script-api:dw/customer/ProductList#getItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getItem", + "tags": [ + "getitem", + "productlist.getitem" + ], + "title": "ProductList.getItem" + }, + { + "id": "script-api:dw/customer/ProductList#getItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getItems", + "tags": [ + "getitems", + "productlist.getitems" + ], + "title": "ProductList.getItems" + }, + { + "id": "script-api:dw/customer/ProductList#getLastExportTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getLastExportTime", + "tags": [ + "getlastexporttime", + "productlist.getlastexporttime" + ], + "title": "ProductList.getLastExportTime" + }, + { + "id": "script-api:dw/customer/ProductList#getName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getName", + "tags": [ + "getname", + "productlist.getname" + ], + "title": "ProductList.getName" + }, + { + "id": "script-api:dw/customer/ProductList#getOwner", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getOwner", + "tags": [ + "getowner", + "productlist.getowner" + ], + "title": "ProductList.getOwner" + }, + { + "id": "script-api:dw/customer/ProductList#getPostEventShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPostEventShippingAddress", + "tags": [ + "getposteventshippingaddress", + "productlist.getposteventshippingaddress" + ], + "title": "ProductList.getPostEventShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#getProductItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getProductItems", + "tags": [ + "getproductitems", + "productlist.getproductitems" + ], + "title": "ProductList.getProductItems" + }, + { + "id": "script-api:dw/customer/ProductList#getPublicItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPublicItems", + "tags": [ + "getpublicitems", + "productlist.getpublicitems" + ], + "title": "ProductList.getPublicItems" + }, + { + "id": "script-api:dw/customer/ProductList#getPurchases", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPurchases", + "tags": [ + "getpurchases", + "productlist.getpurchases" + ], + "title": "ProductList.getPurchases" + }, + { + "id": "script-api:dw/customer/ProductList#getRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getRegistrant", + "tags": [ + "getregistrant", + "productlist.getregistrant" + ], + "title": "ProductList.getRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#getShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getShippingAddress", + "tags": [ + "getshippingaddress", + "productlist.getshippingaddress" + ], + "title": "ProductList.getShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#getType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getType", + "tags": [ + "gettype", + "productlist.gettype" + ], + "title": "ProductList.getType" + }, + { + "id": "script-api:dw/customer/ProductList#giftCertificateItem", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.giftCertificateItem", + "tags": [ + "giftcertificateitem", + "productlist.giftcertificateitem" + ], + "title": "ProductList.giftCertificateItem" + }, + { + "id": "script-api:dw/customer/ProductList#isAnonymous", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.isAnonymous", + "tags": [ + "isanonymous", + "productlist.isanonymous" + ], + "title": "ProductList.isAnonymous" + }, + { + "id": "script-api:dw/customer/ProductList#isPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.isPublic", + "tags": [ + "ispublic", + "productlist.ispublic" + ], + "title": "ProductList.isPublic" + }, + { + "id": "script-api:dw/customer/ProductList#items", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.items", + "tags": [ + "items", + "productlist.items" + ], + "title": "ProductList.items" + }, + { + "id": "script-api:dw/customer/ProductList#lastExportTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.lastExportTime", + "tags": [ + "lastexporttime", + "productlist.lastexporttime" + ], + "title": "ProductList.lastExportTime" + }, + { + "id": "script-api:dw/customer/ProductList#name", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.name", + "tags": [ + "name", + "productlist.name" + ], + "title": "ProductList.name" + }, + { + "id": "script-api:dw/customer/ProductList#owner", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.owner", + "tags": [ + "owner", + "productlist.owner" + ], + "title": "ProductList.owner" + }, + { + "id": "script-api:dw/customer/ProductList#postEventShippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.postEventShippingAddress", + "tags": [ + "posteventshippingaddress", + "productlist.posteventshippingaddress" + ], + "title": "ProductList.postEventShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#productItems", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.productItems", + "tags": [ + "productitems", + "productlist.productitems" + ], + "title": "ProductList.productItems" + }, + { + "id": "script-api:dw/customer/ProductList#public", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.public", + "tags": [ + "public", + "productlist.public" + ], + "title": "ProductList.public" + }, + { + "id": "script-api:dw/customer/ProductList#publicItems", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.publicItems", + "tags": [ + "publicitems", + "productlist.publicitems" + ], + "title": "ProductList.publicItems" + }, + { + "id": "script-api:dw/customer/ProductList#purchases", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.purchases", + "tags": [ + "purchases", + "productlist.purchases" + ], + "title": "ProductList.purchases" + }, + { + "id": "script-api:dw/customer/ProductList#registrant", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.registrant", + "tags": [ + "registrant", + "productlist.registrant" + ], + "title": "ProductList.registrant" + }, + { + "id": "script-api:dw/customer/ProductList#removeCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeCoRegistrant", + "tags": [ + "removecoregistrant", + "productlist.removecoregistrant" + ], + "title": "ProductList.removeCoRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#removeItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeItem", + "tags": [ + "removeitem", + "productlist.removeitem" + ], + "title": "ProductList.removeItem" + }, + { + "id": "script-api:dw/customer/ProductList#removeRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeRegistrant", + "tags": [ + "removeregistrant", + "productlist.removeregistrant" + ], + "title": "ProductList.removeRegistrant" + }, + { + "id": "script-api:dw/customer/ProductList#setDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setDescription", + "tags": [ + "setdescription", + "productlist.setdescription" + ], + "title": "ProductList.setDescription" + }, + { + "id": "script-api:dw/customer/ProductList#setEventCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventCity", + "tags": [ + "seteventcity", + "productlist.seteventcity" + ], + "title": "ProductList.setEventCity" + }, + { + "id": "script-api:dw/customer/ProductList#setEventCountry", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventCountry", + "tags": [ + "seteventcountry", + "productlist.seteventcountry" + ], + "title": "ProductList.setEventCountry" + }, + { + "id": "script-api:dw/customer/ProductList#setEventDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventDate", + "tags": [ + "seteventdate", + "productlist.seteventdate" + ], + "title": "ProductList.setEventDate" + }, + { + "id": "script-api:dw/customer/ProductList#setEventState", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventState", + "tags": [ + "seteventstate", + "productlist.seteventstate" + ], + "title": "ProductList.setEventState" + }, + { + "id": "script-api:dw/customer/ProductList#setEventType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventType", + "tags": [ + "seteventtype", + "productlist.seteventtype" + ], + "title": "ProductList.setEventType" + }, + { + "id": "script-api:dw/customer/ProductList#setName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setName", + "tags": [ + "setname", + "productlist.setname" + ], + "title": "ProductList.setName" + }, + { + "id": "script-api:dw/customer/ProductList#setPostEventShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setPostEventShippingAddress", + "tags": [ + "setposteventshippingaddress", + "productlist.setposteventshippingaddress" + ], + "title": "ProductList.setPostEventShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#setPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setPublic", + "tags": [ + "setpublic", + "productlist.setpublic" + ], + "title": "ProductList.setPublic" + }, + { + "id": "script-api:dw/customer/ProductList#setShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setShippingAddress", + "tags": [ + "setshippingaddress", + "productlist.setshippingaddress" + ], + "title": "ProductList.setShippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#shippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.shippingAddress", + "tags": [ + "shippingaddress", + "productlist.shippingaddress" + ], + "title": "ProductList.shippingAddress" + }, + { + "id": "script-api:dw/customer/ProductList#type", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.type", + "tags": [ + "type", + "productlist.type" + ], + "title": "ProductList.type" + }, + { + "id": "script-api:dw/customer/ProductListItem", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListItem", + "tags": [ + "productlistitem", + "dw.customer.productlistitem", + "dw/customer" + ], + "title": "ProductListItem" + }, + { + "id": "script-api:dw/customer/ProductListItem#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.ID", + "tags": [ + "id", + "productlistitem.id" + ], + "title": "ProductListItem.ID" + }, + { + "id": "script-api:dw/customer/ProductListItem#TYPE_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_GIFT_CERTIFICATE", + "tags": [ + "type_gift_certificate", + "productlistitem.type_gift_certificate" + ], + "title": "ProductListItem.TYPE_GIFT_CERTIFICATE" + }, + { + "id": "script-api:dw/customer/ProductListItem#TYPE_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_GIFT_CERTIFICATE", + "tags": [ + "type_gift_certificate", + "productlistitem.type_gift_certificate" + ], + "title": "ProductListItem.TYPE_GIFT_CERTIFICATE" + }, + { + "id": "script-api:dw/customer/ProductListItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_PRODUCT", + "tags": [ + "type_product", + "productlistitem.type_product" + ], + "title": "ProductListItem.TYPE_PRODUCT" + }, + { + "id": "script-api:dw/customer/ProductListItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_PRODUCT", + "tags": [ + "type_product", + "productlistitem.type_product" + ], + "title": "ProductListItem.TYPE_PRODUCT" + }, + { + "id": "script-api:dw/customer/ProductListItem#createPurchase", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.createPurchase", + "tags": [ + "createpurchase", + "productlistitem.createpurchase" + ], + "title": "ProductListItem.createPurchase" + }, + { + "id": "script-api:dw/customer/ProductListItem#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getID", + "tags": [ + "getid", + "productlistitem.getid" + ], + "title": "ProductListItem.getID" + }, + { + "id": "script-api:dw/customer/ProductListItem#getList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getList", + "tags": [ + "getlist", + "productlistitem.getlist" + ], + "title": "ProductListItem.getList" + }, + { + "id": "script-api:dw/customer/ProductListItem#getPriority", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPriority", + "tags": [ + "getpriority", + "productlistitem.getpriority" + ], + "title": "ProductListItem.getPriority" + }, + { + "id": "script-api:dw/customer/ProductListItem#getProduct", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProduct", + "tags": [ + "getproduct", + "productlistitem.getproduct" + ], + "title": "ProductListItem.getProduct" + }, + { + "id": "script-api:dw/customer/ProductListItem#getProductID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProductID", + "tags": [ + "getproductid", + "productlistitem.getproductid" + ], + "title": "ProductListItem.getProductID" + }, + { + "id": "script-api:dw/customer/ProductListItem#getProductOptionModel", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProductOptionModel", + "tags": [ + "getproductoptionmodel", + "productlistitem.getproductoptionmodel" + ], + "title": "ProductListItem.getProductOptionModel" + }, + { + "id": "script-api:dw/customer/ProductListItem#getPurchasedQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchasedQuantity", + "tags": [ + "getpurchasedquantity", + "productlistitem.getpurchasedquantity" + ], + "title": "ProductListItem.getPurchasedQuantity" + }, + { + "id": "script-api:dw/customer/ProductListItem#getPurchasedQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchasedQuantityValue", + "tags": [ + "getpurchasedquantityvalue", + "productlistitem.getpurchasedquantityvalue" + ], + "title": "ProductListItem.getPurchasedQuantityValue" + }, + { + "id": "script-api:dw/customer/ProductListItem#getPurchases", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchases", + "tags": [ + "getpurchases", + "productlistitem.getpurchases" + ], + "title": "ProductListItem.getPurchases" + }, + { + "id": "script-api:dw/customer/ProductListItem#getQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getQuantity", + "tags": [ + "getquantity", + "productlistitem.getquantity" + ], + "title": "ProductListItem.getQuantity" + }, + { + "id": "script-api:dw/customer/ProductListItem#getQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getQuantityValue", + "tags": [ + "getquantityvalue", + "productlistitem.getquantityvalue" + ], + "title": "ProductListItem.getQuantityValue" + }, + { + "id": "script-api:dw/customer/ProductListItem#getType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getType", + "tags": [ + "gettype", + "productlistitem.gettype" + ], + "title": "ProductListItem.getType" + }, + { + "id": "script-api:dw/customer/ProductListItem#isPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.isPublic", + "tags": [ + "ispublic", + "productlistitem.ispublic" + ], + "title": "ProductListItem.isPublic" + }, + { + "id": "script-api:dw/customer/ProductListItem#list", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.list", + "tags": [ + "list", + "productlistitem.list" + ], + "title": "ProductListItem.list" + }, + { + "id": "script-api:dw/customer/ProductListItem#priority", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.priority", + "tags": [ + "priority", + "productlistitem.priority" + ], + "title": "ProductListItem.priority" + }, + { + "id": "script-api:dw/customer/ProductListItem#product", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.product", + "tags": [ + "product", + "productlistitem.product" + ], + "title": "ProductListItem.product" + }, + { + "id": "script-api:dw/customer/ProductListItem#productID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.productID", + "tags": [ + "productid", + "productlistitem.productid" + ], + "title": "ProductListItem.productID" + }, + { + "id": "script-api:dw/customer/ProductListItem#productOptionModel", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.productOptionModel", + "tags": [ + "productoptionmodel", + "productlistitem.productoptionmodel" + ], + "title": "ProductListItem.productOptionModel" + }, + { + "id": "script-api:dw/customer/ProductListItem#public", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.public", + "tags": [ + "public", + "productlistitem.public" + ], + "title": "ProductListItem.public" + }, + { + "id": "script-api:dw/customer/ProductListItem#purchasedQuantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchasedQuantity", + "tags": [ + "purchasedquantity", + "productlistitem.purchasedquantity" + ], + "title": "ProductListItem.purchasedQuantity" + }, + { + "id": "script-api:dw/customer/ProductListItem#purchasedQuantityValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchasedQuantityValue", + "tags": [ + "purchasedquantityvalue", + "productlistitem.purchasedquantityvalue" + ], + "title": "ProductListItem.purchasedQuantityValue" + }, + { + "id": "script-api:dw/customer/ProductListItem#purchases", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchases", + "tags": [ + "purchases", + "productlistitem.purchases" + ], + "title": "ProductListItem.purchases" + }, + { + "id": "script-api:dw/customer/ProductListItem#quantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.quantity", + "tags": [ + "quantity", + "productlistitem.quantity" + ], + "title": "ProductListItem.quantity" + }, + { + "id": "script-api:dw/customer/ProductListItem#quantityValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.quantityValue", + "tags": [ + "quantityvalue", + "productlistitem.quantityvalue" + ], + "title": "ProductListItem.quantityValue" + }, + { + "id": "script-api:dw/customer/ProductListItem#setPriority", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setPriority", + "tags": [ + "setpriority", + "productlistitem.setpriority" + ], + "title": "ProductListItem.setPriority" + }, + { + "id": "script-api:dw/customer/ProductListItem#setProduct", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setProduct", + "tags": [ + "setproduct", + "productlistitem.setproduct" + ], + "title": "ProductListItem.setProduct" + }, + { + "id": "script-api:dw/customer/ProductListItem#setProductOptionModel", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setProductOptionModel", + "tags": [ + "setproductoptionmodel", + "productlistitem.setproductoptionmodel" + ], + "title": "ProductListItem.setProductOptionModel" + }, + { + "id": "script-api:dw/customer/ProductListItem#setPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setPublic", + "tags": [ + "setpublic", + "productlistitem.setpublic" + ], + "title": "ProductListItem.setPublic" + }, + { + "id": "script-api:dw/customer/ProductListItem#setQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setQuantity", + "tags": [ + "setquantity", + "productlistitem.setquantity" + ], + "title": "ProductListItem.setQuantity" + }, + { + "id": "script-api:dw/customer/ProductListItem#setQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setQuantityValue", + "tags": [ + "setquantityvalue", + "productlistitem.setquantityvalue" + ], + "title": "ProductListItem.setQuantityValue" + }, + { + "id": "script-api:dw/customer/ProductListItem#type", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.type", + "tags": [ + "type", + "productlistitem.type" + ], + "title": "ProductListItem.type" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListItemPurchase", + "tags": [ + "productlistitempurchase", + "dw.customer.productlistitempurchase", + "dw/customer" + ], + "title": "ProductListItemPurchase" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#getItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getItem", + "tags": [ + "getitem", + "productlistitempurchase.getitem" + ], + "title": "ProductListItemPurchase.getItem" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#getOrderNo", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getOrderNo", + "tags": [ + "getorderno", + "productlistitempurchase.getorderno" + ], + "title": "ProductListItemPurchase.getOrderNo" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#getPurchaseDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getPurchaseDate", + "tags": [ + "getpurchasedate", + "productlistitempurchase.getpurchasedate" + ], + "title": "ProductListItemPurchase.getPurchaseDate" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#getPurchaserName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getPurchaserName", + "tags": [ + "getpurchasername", + "productlistitempurchase.getpurchasername" + ], + "title": "ProductListItemPurchase.getPurchaserName" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#getQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getQuantity", + "tags": [ + "getquantity", + "productlistitempurchase.getquantity" + ], + "title": "ProductListItemPurchase.getQuantity" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#item", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.item", + "tags": [ + "item", + "productlistitempurchase.item" + ], + "title": "ProductListItemPurchase.item" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#orderNo", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.orderNo", + "tags": [ + "orderno", + "productlistitempurchase.orderno" + ], + "title": "ProductListItemPurchase.orderNo" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#purchaseDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.purchaseDate", + "tags": [ + "purchasedate", + "productlistitempurchase.purchasedate" + ], + "title": "ProductListItemPurchase.purchaseDate" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#purchaserName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.purchaserName", + "tags": [ + "purchasername", + "productlistitempurchase.purchasername" + ], + "title": "ProductListItemPurchase.purchaserName" + }, + { + "id": "script-api:dw/customer/ProductListItemPurchase#quantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.quantity", + "tags": [ + "quantity", + "productlistitempurchase.quantity" + ], + "title": "ProductListItemPurchase.quantity" + }, + { + "id": "script-api:dw/customer/ProductListMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListMgr", + "tags": [ + "productlistmgr", + "dw.customer.productlistmgr", + "dw/customer" + ], + "title": "ProductListMgr" + }, + { + "id": "script-api:dw/customer/ProductListMgr#createProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.createProductList", + "tags": [ + "createproductlist", + "productlistmgr.createproductlist" + ], + "title": "ProductListMgr.createProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#createProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.createProductList", + "tags": [ + "createproductlist", + "productlistmgr.createproductlist" + ], + "title": "ProductListMgr.createProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "id": "script-api:dw/customer/ProductListMgr#removeProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.removeProductList", + "tags": [ + "removeproductlist", + "productlistmgr.removeproductlist" + ], + "title": "ProductListMgr.removeProductList" + }, + { + "id": "script-api:dw/customer/ProductListMgr#removeProductList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.removeProductList", + "tags": [ + "removeproductlist", + "productlistmgr.removeproductlist" + ], + "title": "ProductListMgr.removeProductList" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListRegistrant", + "tags": [ + "productlistregistrant", + "dw.customer.productlistregistrant", + "dw/customer" + ], + "title": "ProductListRegistrant" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.email", + "tags": [ + "email", + "productlistregistrant.email" + ], + "title": "ProductListRegistrant.email" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.firstName", + "tags": [ + "firstname", + "productlistregistrant.firstname" + ], + "title": "ProductListRegistrant.firstName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getEmail", + "tags": [ + "getemail", + "productlistregistrant.getemail" + ], + "title": "ProductListRegistrant.getEmail" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getFirstName", + "tags": [ + "getfirstname", + "productlistregistrant.getfirstname" + ], + "title": "ProductListRegistrant.getFirstName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getLastName", + "tags": [ + "getlastname", + "productlistregistrant.getlastname" + ], + "title": "ProductListRegistrant.getLastName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#getRole", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getRole", + "tags": [ + "getrole", + "productlistregistrant.getrole" + ], + "title": "ProductListRegistrant.getRole" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.lastName", + "tags": [ + "lastname", + "productlistregistrant.lastname" + ], + "title": "ProductListRegistrant.lastName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#role", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.role", + "tags": [ + "role", + "productlistregistrant.role" + ], + "title": "ProductListRegistrant.role" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setEmail", + "tags": [ + "setemail", + "productlistregistrant.setemail" + ], + "title": "ProductListRegistrant.setEmail" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setFirstName", + "tags": [ + "setfirstname", + "productlistregistrant.setfirstname" + ], + "title": "ProductListRegistrant.setFirstName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setLastName", + "tags": [ + "setlastname", + "productlistregistrant.setlastname" + ], + "title": "ProductListRegistrant.setLastName" + }, + { + "id": "script-api:dw/customer/ProductListRegistrant#setRole", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setRole", + "tags": [ + "setrole", + "productlistregistrant.setrole" + ], + "title": "ProductListRegistrant.setRole" + }, + { + "id": "script-api:dw/customer/Profile", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Profile", + "tags": [ + "profile", + "dw.customer.profile", + "dw/customer" + ], + "title": "Profile" + }, + { + "id": "script-api:dw/customer/Profile#addressBook", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.addressBook", + "tags": [ + "addressbook", + "profile.addressbook" + ], + "title": "Profile.addressBook" + }, + { + "id": "script-api:dw/customer/Profile#birthday", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.birthday", + "tags": [ + "birthday", + "profile.birthday" + ], + "title": "Profile.birthday" + }, + { + "id": "script-api:dw/customer/Profile#companyName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.companyName", + "tags": [ + "companyname", + "profile.companyname" + ], + "title": "Profile.companyName" + }, + { + "id": "script-api:dw/customer/Profile#credentials", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.credentials", + "tags": [ + "credentials", + "profile.credentials" + ], + "title": "Profile.credentials" + }, + { + "id": "script-api:dw/customer/Profile#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.customer", + "tags": [ + "customer", + "profile.customer" + ], + "title": "Profile.customer" + }, + { + "id": "script-api:dw/customer/Profile#customerNo", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.customerNo", + "tags": [ + "customerno", + "profile.customerno" + ], + "title": "Profile.customerNo" + }, + { + "id": "script-api:dw/customer/Profile#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.email", + "tags": [ + "email", + "profile.email" + ], + "title": "Profile.email" + }, + { + "id": "script-api:dw/customer/Profile#emailVerified", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.emailVerified", + "tags": [ + "emailverified", + "profile.emailverified" + ], + "title": "Profile.emailVerified" + }, + { + "id": "script-api:dw/customer/Profile#fax", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.fax", + "tags": [ + "fax", + "profile.fax" + ], + "title": "Profile.fax" + }, + { + "id": "script-api:dw/customer/Profile#female", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.female", + "tags": [ + "female", + "profile.female" + ], + "title": "Profile.female" + }, + { + "id": "script-api:dw/customer/Profile#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.firstName", + "tags": [ + "firstname", + "profile.firstname" + ], + "title": "Profile.firstName" + }, + { + "id": "script-api:dw/customer/Profile#gender", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.gender", + "tags": [ + "gender", + "profile.gender" + ], + "title": "Profile.gender" + }, + { + "id": "script-api:dw/customer/Profile#getAddressBook", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getAddressBook", + "tags": [ + "getaddressbook", + "profile.getaddressbook" + ], + "title": "Profile.getAddressBook" + }, + { + "id": "script-api:dw/customer/Profile#getBirthday", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getBirthday", + "tags": [ + "getbirthday", + "profile.getbirthday" + ], + "title": "Profile.getBirthday" + }, + { + "id": "script-api:dw/customer/Profile#getCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCompanyName", + "tags": [ + "getcompanyname", + "profile.getcompanyname" + ], + "title": "Profile.getCompanyName" + }, + { + "id": "script-api:dw/customer/Profile#getCredentials", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCredentials", + "tags": [ + "getcredentials", + "profile.getcredentials" + ], + "title": "Profile.getCredentials" + }, + { + "id": "script-api:dw/customer/Profile#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCustomer", + "tags": [ + "getcustomer", + "profile.getcustomer" + ], + "title": "Profile.getCustomer" + }, + { + "id": "script-api:dw/customer/Profile#getCustomerNo", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCustomerNo", + "tags": [ + "getcustomerno", + "profile.getcustomerno" + ], + "title": "Profile.getCustomerNo" + }, + { + "id": "script-api:dw/customer/Profile#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getEmail", + "tags": [ + "getemail", + "profile.getemail" + ], + "title": "Profile.getEmail" + }, + { + "id": "script-api:dw/customer/Profile#getFax", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getFax", + "tags": [ + "getfax", + "profile.getfax" + ], + "title": "Profile.getFax" + }, + { + "id": "script-api:dw/customer/Profile#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getFirstName", + "tags": [ + "getfirstname", + "profile.getfirstname" + ], + "title": "Profile.getFirstName" + }, + { + "id": "script-api:dw/customer/Profile#getGender", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getGender", + "tags": [ + "getgender", + "profile.getgender" + ], + "title": "Profile.getGender" + }, + { + "id": "script-api:dw/customer/Profile#getJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getJobTitle", + "tags": [ + "getjobtitle", + "profile.getjobtitle" + ], + "title": "Profile.getJobTitle" + }, + { + "id": "script-api:dw/customer/Profile#getLastLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastLoginTime", + "tags": [ + "getlastlogintime", + "profile.getlastlogintime" + ], + "title": "Profile.getLastLoginTime" + }, + { + "id": "script-api:dw/customer/Profile#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastName", + "tags": [ + "getlastname", + "profile.getlastname" + ], + "title": "Profile.getLastName" + }, + { + "id": "script-api:dw/customer/Profile#getLastVisitTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastVisitTime", + "tags": [ + "getlastvisittime", + "profile.getlastvisittime" + ], + "title": "Profile.getLastVisitTime" + }, + { + "id": "script-api:dw/customer/Profile#getNextBirthday", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getNextBirthday", + "tags": [ + "getnextbirthday", + "profile.getnextbirthday" + ], + "title": "Profile.getNextBirthday" + }, + { + "id": "script-api:dw/customer/Profile#getPhoneBusiness", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneBusiness", + "tags": [ + "getphonebusiness", + "profile.getphonebusiness" + ], + "title": "Profile.getPhoneBusiness" + }, + { + "id": "script-api:dw/customer/Profile#getPhoneHome", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneHome", + "tags": [ + "getphonehome", + "profile.getphonehome" + ], + "title": "Profile.getPhoneHome" + }, + { + "id": "script-api:dw/customer/Profile#getPhoneMobile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneMobile", + "tags": [ + "getphonemobile", + "profile.getphonemobile" + ], + "title": "Profile.getPhoneMobile" + }, + { + "id": "script-api:dw/customer/Profile#getPreferredLocale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreferredLocale", + "tags": [ + "getpreferredlocale", + "profile.getpreferredlocale" + ], + "title": "Profile.getPreferredLocale" + }, + { + "id": "script-api:dw/customer/Profile#getPreviousLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreviousLoginTime", + "tags": [ + "getpreviouslogintime", + "profile.getpreviouslogintime" + ], + "title": "Profile.getPreviousLoginTime" + }, + { + "id": "script-api:dw/customer/Profile#getPreviousVisitTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreviousVisitTime", + "tags": [ + "getpreviousvisittime", + "profile.getpreviousvisittime" + ], + "title": "Profile.getPreviousVisitTime" + }, + { + "id": "script-api:dw/customer/Profile#getSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSalutation", + "tags": [ + "getsalutation", + "profile.getsalutation" + ], + "title": "Profile.getSalutation" + }, + { + "id": "script-api:dw/customer/Profile#getSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSecondName", + "tags": [ + "getsecondname", + "profile.getsecondname" + ], + "title": "Profile.getSecondName" + }, + { + "id": "script-api:dw/customer/Profile#getSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSuffix", + "tags": [ + "getsuffix", + "profile.getsuffix" + ], + "title": "Profile.getSuffix" + }, + { + "id": "script-api:dw/customer/Profile#getTaxID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxID", + "tags": [ + "gettaxid", + "profile.gettaxid" + ], + "title": "Profile.getTaxID" + }, + { + "id": "script-api:dw/customer/Profile#getTaxIDMasked", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxIDMasked", + "tags": [ + "gettaxidmasked", + "profile.gettaxidmasked" + ], + "title": "Profile.getTaxIDMasked" + }, + { + "id": "script-api:dw/customer/Profile#getTaxIDType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxIDType", + "tags": [ + "gettaxidtype", + "profile.gettaxidtype" + ], + "title": "Profile.getTaxIDType" + }, + { + "id": "script-api:dw/customer/Profile#getTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTitle", + "tags": [ + "gettitle", + "profile.gettitle" + ], + "title": "Profile.getTitle" + }, + { + "id": "script-api:dw/customer/Profile#getWallet", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getWallet", + "tags": [ + "getwallet", + "profile.getwallet" + ], + "title": "Profile.getWallet" + }, + { + "id": "script-api:dw/customer/Profile#isEmailVerified", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isEmailVerified", + "tags": [ + "isemailverified", + "profile.isemailverified" + ], + "title": "Profile.isEmailVerified" + }, + { + "id": "script-api:dw/customer/Profile#isFemale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isFemale", + "tags": [ + "isfemale", + "profile.isfemale" + ], + "title": "Profile.isFemale" + }, + { + "id": "script-api:dw/customer/Profile#isMale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isMale", + "tags": [ + "ismale", + "profile.ismale" + ], + "title": "Profile.isMale" + }, + { + "id": "script-api:dw/customer/Profile#jobTitle", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.jobTitle", + "tags": [ + "jobtitle", + "profile.jobtitle" + ], + "title": "Profile.jobTitle" + }, + { + "id": "script-api:dw/customer/Profile#lastLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastLoginTime", + "tags": [ + "lastlogintime", + "profile.lastlogintime" + ], + "title": "Profile.lastLoginTime" + }, + { + "id": "script-api:dw/customer/Profile#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastName", + "tags": [ + "lastname", + "profile.lastname" + ], + "title": "Profile.lastName" + }, + { + "id": "script-api:dw/customer/Profile#lastVisitTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastVisitTime", + "tags": [ + "lastvisittime", + "profile.lastvisittime" + ], + "title": "Profile.lastVisitTime" + }, + { + "id": "script-api:dw/customer/Profile#male", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.male", + "tags": [ + "male", + "profile.male" + ], + "title": "Profile.male" + }, + { + "id": "script-api:dw/customer/Profile#nextBirthday", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.nextBirthday", + "tags": [ + "nextbirthday", + "profile.nextbirthday" + ], + "title": "Profile.nextBirthday" + }, + { + "id": "script-api:dw/customer/Profile#phoneBusiness", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneBusiness", + "tags": [ + "phonebusiness", + "profile.phonebusiness" + ], + "title": "Profile.phoneBusiness" + }, + { + "id": "script-api:dw/customer/Profile#phoneHome", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneHome", + "tags": [ + "phonehome", + "profile.phonehome" + ], + "title": "Profile.phoneHome" + }, + { + "id": "script-api:dw/customer/Profile#phoneMobile", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneMobile", + "tags": [ + "phonemobile", + "profile.phonemobile" + ], + "title": "Profile.phoneMobile" + }, + { + "id": "script-api:dw/customer/Profile#preferredLocale", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.preferredLocale", + "tags": [ + "preferredlocale", + "profile.preferredlocale" + ], + "title": "Profile.preferredLocale" + }, + { + "id": "script-api:dw/customer/Profile#previousLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.previousLoginTime", + "tags": [ + "previouslogintime", + "profile.previouslogintime" + ], + "title": "Profile.previousLoginTime" + }, + { + "id": "script-api:dw/customer/Profile#previousVisitTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.previousVisitTime", + "tags": [ + "previousvisittime", + "profile.previousvisittime" + ], + "title": "Profile.previousVisitTime" + }, + { + "id": "script-api:dw/customer/Profile#salutation", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.salutation", + "tags": [ + "salutation", + "profile.salutation" + ], + "title": "Profile.salutation" + }, + { + "id": "script-api:dw/customer/Profile#secondName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.secondName", + "tags": [ + "secondname", + "profile.secondname" + ], + "title": "Profile.secondName" + }, + { + "id": "script-api:dw/customer/Profile#setBirthday", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setBirthday", + "tags": [ + "setbirthday", + "profile.setbirthday" + ], + "title": "Profile.setBirthday" + }, + { + "id": "script-api:dw/customer/Profile#setCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setCompanyName", + "tags": [ + "setcompanyname", + "profile.setcompanyname" + ], + "title": "Profile.setCompanyName" + }, + { + "id": "script-api:dw/customer/Profile#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setEmail", + "tags": [ + "setemail", + "profile.setemail" + ], + "title": "Profile.setEmail" + }, + { + "id": "script-api:dw/customer/Profile#setFax", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setFax", + "tags": [ + "setfax", + "profile.setfax" + ], + "title": "Profile.setFax" + }, + { + "id": "script-api:dw/customer/Profile#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setFirstName", + "tags": [ + "setfirstname", + "profile.setfirstname" + ], + "title": "Profile.setFirstName" + }, + { + "id": "script-api:dw/customer/Profile#setGender", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setGender", + "tags": [ + "setgender", + "profile.setgender" + ], + "title": "Profile.setGender" + }, + { + "id": "script-api:dw/customer/Profile#setJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setJobTitle", + "tags": [ + "setjobtitle", + "profile.setjobtitle" + ], + "title": "Profile.setJobTitle" + }, + { + "id": "script-api:dw/customer/Profile#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setLastName", + "tags": [ + "setlastname", + "profile.setlastname" + ], + "title": "Profile.setLastName" + }, + { + "id": "script-api:dw/customer/Profile#setPhoneBusiness", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneBusiness", + "tags": [ + "setphonebusiness", + "profile.setphonebusiness" + ], + "title": "Profile.setPhoneBusiness" + }, + { + "id": "script-api:dw/customer/Profile#setPhoneHome", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneHome", + "tags": [ + "setphonehome", + "profile.setphonehome" + ], + "title": "Profile.setPhoneHome" + }, + { + "id": "script-api:dw/customer/Profile#setPhoneMobile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneMobile", + "tags": [ + "setphonemobile", + "profile.setphonemobile" + ], + "title": "Profile.setPhoneMobile" + }, + { + "id": "script-api:dw/customer/Profile#setPreferredLocale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPreferredLocale", + "tags": [ + "setpreferredlocale", + "profile.setpreferredlocale" + ], + "title": "Profile.setPreferredLocale" + }, + { + "id": "script-api:dw/customer/Profile#setSaluation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSaluation", + "tags": [ + "setsaluation", + "profile.setsaluation" + ], + "title": "Profile.setSaluation" + }, + { + "id": "script-api:dw/customer/Profile#setSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSalutation", + "tags": [ + "setsalutation", + "profile.setsalutation" + ], + "title": "Profile.setSalutation" + }, + { + "id": "script-api:dw/customer/Profile#setSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSecondName", + "tags": [ + "setsecondname", + "profile.setsecondname" + ], + "title": "Profile.setSecondName" + }, + { + "id": "script-api:dw/customer/Profile#setSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSuffix", + "tags": [ + "setsuffix", + "profile.setsuffix" + ], + "title": "Profile.setSuffix" + }, + { + "id": "script-api:dw/customer/Profile#setTaxID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTaxID", + "tags": [ + "settaxid", + "profile.settaxid" + ], + "title": "Profile.setTaxID" + }, + { + "id": "script-api:dw/customer/Profile#setTaxIDType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTaxIDType", + "tags": [ + "settaxidtype", + "profile.settaxidtype" + ], + "title": "Profile.setTaxIDType" + }, + { + "id": "script-api:dw/customer/Profile#setTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTitle", + "tags": [ + "settitle", + "profile.settitle" + ], + "title": "Profile.setTitle" + }, + { + "id": "script-api:dw/customer/Profile#suffix", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.suffix", + "tags": [ + "suffix", + "profile.suffix" + ], + "title": "Profile.suffix" + }, + { + "id": "script-api:dw/customer/Profile#taxID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxID", + "tags": [ + "taxid", + "profile.taxid" + ], + "title": "Profile.taxID" + }, + { + "id": "script-api:dw/customer/Profile#taxIDMasked", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxIDMasked", + "tags": [ + "taxidmasked", + "profile.taxidmasked" + ], + "title": "Profile.taxIDMasked" + }, + { + "id": "script-api:dw/customer/Profile#taxIDType", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxIDType", + "tags": [ + "taxidtype", + "profile.taxidtype" + ], + "title": "Profile.taxIDType" + }, + { + "id": "script-api:dw/customer/Profile#title", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.title", + "tags": [ + "title", + "profile.title" + ], + "title": "Profile.title" + }, + { + "id": "script-api:dw/customer/Profile#wallet", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.wallet", + "tags": [ + "wallet", + "profile.wallet" + ], + "title": "Profile.wallet" + }, + { + "id": "script-api:dw/customer/Wallet", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Wallet", + "tags": [ + "wallet", + "dw.customer.wallet", + "dw/customer" + ], + "title": "Wallet" + }, + { + "id": "script-api:dw/customer/Wallet#createPaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.createPaymentInstrument", + "tags": [ + "createpaymentinstrument", + "wallet.createpaymentinstrument" + ], + "title": "Wallet.createPaymentInstrument" + }, + { + "id": "script-api:dw/customer/Wallet#defaultPaymentInstrument", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.defaultPaymentInstrument", + "tags": [ + "defaultpaymentinstrument", + "wallet.defaultpaymentinstrument" + ], + "title": "Wallet.defaultPaymentInstrument" + }, + { + "id": "script-api:dw/customer/Wallet#getDefaultPaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getDefaultPaymentInstrument", + "tags": [ + "getdefaultpaymentinstrument", + "wallet.getdefaultpaymentinstrument" + ], + "title": "Wallet.getDefaultPaymentInstrument" + }, + { + "id": "script-api:dw/customer/Wallet#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getPaymentInstruments", + "tags": [ + "getpaymentinstruments", + "wallet.getpaymentinstruments" + ], + "title": "Wallet.getPaymentInstruments" + }, + { + "id": "script-api:dw/customer/Wallet#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getPaymentInstruments", + "tags": [ + "getpaymentinstruments", + "wallet.getpaymentinstruments" + ], + "title": "Wallet.getPaymentInstruments" + }, + { + "id": "script-api:dw/customer/Wallet#paymentInstruments", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.paymentInstruments", + "tags": [ + "paymentinstruments", + "wallet.paymentinstruments" + ], + "title": "Wallet.paymentInstruments" + }, + { + "id": "script-api:dw/customer/Wallet#removePaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.removePaymentInstrument", + "tags": [ + "removepaymentinstrument", + "wallet.removepaymentinstrument" + ], + "title": "Wallet.removePaymentInstrument" + }, + { + "id": "script-api:dw/customer/consent", + "kind": "package", + "packagePath": "dw/customer/consent", + "qualifiedName": "dw.customer.consent", + "tags": [ + "dw/customer/consent", + "dw.customer.consent" + ], + "title": "dw.customer.consent" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry", + "tags": [ + "consentstatusentry", + "dw.customer.consent.consentstatusentry", + "dw/customer/consent" + ], + "title": "ConsentStatusEntry" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#channel", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.channel", + "tags": [ + "channel", + "consentstatusentry.channel" + ], + "title": "ConsentStatusEntry.channel" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#contactPointValue", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.contactPointValue", + "tags": [ + "contactpointvalue", + "consentstatusentry.contactpointvalue" + ], + "title": "ConsentStatusEntry.contactPointValue" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getChannel", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getChannel", + "tags": [ + "getchannel", + "consentstatusentry.getchannel" + ], + "title": "ConsentStatusEntry.getChannel" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getContactPointValue", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getContactPointValue", + "tags": [ + "getcontactpointvalue", + "consentstatusentry.getcontactpointvalue" + ], + "title": "ConsentStatusEntry.getContactPointValue" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getStatus", + "tags": [ + "getstatus", + "consentstatusentry.getstatus" + ], + "title": "ConsentStatusEntry.getStatus" + }, + { + "id": "script-api:dw/customer/consent/ConsentStatusEntry#status", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.status", + "tags": [ + "status", + "consentstatusentry.status" + ], + "title": "ConsentStatusEntry.status" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription", + "tags": [ + "marketingconsentsubscription", + "dw.customer.consent.marketingconsentsubscription", + "dw/customer/consent" + ], + "title": "MarketingConsentSubscription" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#channels", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.channels", + "tags": [ + "channels", + "marketingconsentsubscription.channels" + ], + "title": "MarketingConsentSubscription.channels" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentRequired", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentRequired", + "tags": [ + "consentrequired", + "marketingconsentsubscription.consentrequired" + ], + "title": "MarketingConsentSubscription.consentRequired" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentStatus", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentStatus", + "tags": [ + "consentstatus", + "marketingconsentsubscription.consentstatus" + ], + "title": "MarketingConsentSubscription.consentStatus" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentType", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentType", + "tags": [ + "consenttype", + "marketingconsentsubscription.consenttype" + ], + "title": "MarketingConsentSubscription.consentType" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#defaultStatus", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.defaultStatus", + "tags": [ + "defaultstatus", + "marketingconsentsubscription.defaultstatus" + ], + "title": "MarketingConsentSubscription.defaultStatus" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getChannels", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getChannels", + "tags": [ + "getchannels", + "marketingconsentsubscription.getchannels" + ], + "title": "MarketingConsentSubscription.getChannels" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentRequired", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentRequired", + "tags": [ + "getconsentrequired", + "marketingconsentsubscription.getconsentrequired" + ], + "title": "MarketingConsentSubscription.getConsentRequired" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentStatus", + "tags": [ + "getconsentstatus", + "marketingconsentsubscription.getconsentstatus" + ], + "title": "MarketingConsentSubscription.getConsentStatus" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentType", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentType", + "tags": [ + "getconsenttype", + "marketingconsentsubscription.getconsenttype" + ], + "title": "MarketingConsentSubscription.getConsentType" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getDefaultStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getDefaultStatus", + "tags": [ + "getdefaultstatus", + "marketingconsentsubscription.getdefaultstatus" + ], + "title": "MarketingConsentSubscription.getDefaultStatus" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getSubscriptionId", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getSubscriptionId", + "tags": [ + "getsubscriptionid", + "marketingconsentsubscription.getsubscriptionid" + ], + "title": "MarketingConsentSubscription.getSubscriptionId" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getSubtitle", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getSubtitle", + "tags": [ + "getsubtitle", + "marketingconsentsubscription.getsubtitle" + ], + "title": "MarketingConsentSubscription.getSubtitle" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getTags", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getTags", + "tags": [ + "gettags", + "marketingconsentsubscription.gettags" + ], + "title": "MarketingConsentSubscription.getTags" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getTitle", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getTitle", + "tags": [ + "gettitle", + "marketingconsentsubscription.gettitle" + ], + "title": "MarketingConsentSubscription.getTitle" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#subscriptionId", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.subscriptionId", + "tags": [ + "subscriptionid", + "marketingconsentsubscription.subscriptionid" + ], + "title": "MarketingConsentSubscription.subscriptionId" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#subtitle", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.subtitle", + "tags": [ + "subtitle", + "marketingconsentsubscription.subtitle" + ], + "title": "MarketingConsentSubscription.subtitle" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#tags", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.tags", + "tags": [ + "tags", + "marketingconsentsubscription.tags" + ], + "title": "MarketingConsentSubscription.tags" + }, + { + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#title", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.title", + "tags": [ + "title", + "marketingconsentsubscription.title" + ], + "title": "MarketingConsentSubscription.title" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes", + "tags": [ + "shopperconsenterrorcodes", + "dw.customer.consent.shopperconsenterrorcodes", + "dw/customer/consent" + ], + "title": "ShopperConsentErrorCodes" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#CUSTOMER_NOT_AUTHENTICATED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED", + "tags": [ + "customer_not_authenticated", + "shopperconsenterrorcodes.customer_not_authenticated" + ], + "title": "ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#CUSTOMER_NOT_AUTHENTICATED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED", + "tags": [ + "customer_not_authenticated", + "shopperconsenterrorcodes.customer_not_authenticated" + ], + "title": "ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.FEATURE_DISABLED", + "tags": [ + "feature_disabled", + "shopperconsenterrorcodes.feature_disabled" + ], + "title": "ShopperConsentErrorCodes.FEATURE_DISABLED" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.FEATURE_DISABLED", + "tags": [ + "feature_disabled", + "shopperconsenterrorcodes.feature_disabled" + ], + "title": "ShopperConsentErrorCodes.FEATURE_DISABLED" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.INTERNAL_ERROR", + "tags": [ + "internal_error", + "shopperconsenterrorcodes.internal_error" + ], + "title": "ShopperConsentErrorCodes.INTERNAL_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.INTERNAL_ERROR", + "tags": [ + "internal_error", + "shopperconsenterrorcodes.internal_error" + ], + "title": "ShopperConsentErrorCodes.INTERNAL_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#RETRIEVAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.RETRIEVAL_ERROR", + "tags": [ + "retrieval_error", + "shopperconsenterrorcodes.retrieval_error" + ], + "title": "ShopperConsentErrorCodes.RETRIEVAL_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#RETRIEVAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.RETRIEVAL_ERROR", + "tags": [ + "retrieval_error", + "shopperconsenterrorcodes.retrieval_error" + ], + "title": "ShopperConsentErrorCodes.RETRIEVAL_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#UPDATE_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.UPDATE_ERROR", + "tags": [ + "update_error", + "shopperconsenterrorcodes.update_error" + ], + "title": "ShopperConsentErrorCodes.UPDATE_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#UPDATE_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.UPDATE_ERROR", + "tags": [ + "update_error", + "shopperconsenterrorcodes.update_error" + ], + "title": "ShopperConsentErrorCodes.UPDATE_ERROR" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentException", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentException", + "tags": [ + "shopperconsentexception", + "dw.customer.consent.shopperconsentexception", + "dw/customer/consent" + ], + "title": "ShopperConsentException" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentException#errorCode", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentException", + "qualifiedName": "dw.customer.consent.ShopperConsentException.errorCode", + "tags": [ + "errorcode", + "shopperconsentexception.errorcode" + ], + "title": "ShopperConsentException.errorCode" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentException#getErrorCode", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentException", + "qualifiedName": "dw.customer.consent.ShopperConsentException.getErrorCode", + "tags": [ + "geterrorcode", + "shopperconsentexception.geterrorcode" + ], + "title": "ShopperConsentException.getErrorCode" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr", + "tags": [ + "shopperconsentmgr", + "dw.customer.consent.shopperconsentmgr", + "dw/customer/consent" + ], + "title": "ShopperConsentMgr" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#subscriptions", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.subscriptions", + "tags": [ + "subscriptions", + "shopperconsentmgr.subscriptions" + ], + "title": "ShopperConsentMgr.subscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#subscriptions", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.subscriptions", + "tags": [ + "subscriptions", + "shopperconsentmgr.subscriptions" + ], + "title": "ShopperConsentMgr.subscriptions" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#updateSubscription", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.updateSubscription", + "tags": [ + "updatesubscription", + "shopperconsentmgr.updatesubscription" + ], + "title": "ShopperConsentMgr.updateSubscription" + }, + { + "id": "script-api:dw/customer/consent/ShopperConsentMgr#updateSubscription", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.updateSubscription", + "tags": [ + "updatesubscription", + "shopperconsentmgr.updatesubscription" + ], + "title": "ShopperConsentMgr.updateSubscription" + }, + { + "id": "script-api:dw/customer/oauth", + "kind": "package", + "packagePath": "dw/customer/oauth", + "qualifiedName": "dw.customer.oauth", + "tags": [ + "dw/customer/oauth", + "dw.customer.oauth" + ], + "title": "dw.customer.oauth" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse", + "tags": [ + "oauthaccesstokenresponse", + "dw.customer.oauth.oauthaccesstokenresponse", + "dw/customer/oauth" + ], + "title": "OAuthAccessTokenResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#IDToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.IDToken", + "tags": [ + "idtoken", + "oauthaccesstokenresponse.idtoken" + ], + "title": "OAuthAccessTokenResponse.IDToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#accessToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.accessToken", + "tags": [ + "accesstoken", + "oauthaccesstokenresponse.accesstoken" + ], + "title": "OAuthAccessTokenResponse.accessToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#accessTokenExpiry", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.accessTokenExpiry", + "tags": [ + "accesstokenexpiry", + "oauthaccesstokenresponse.accesstokenexpiry" + ], + "title": "OAuthAccessTokenResponse.accessTokenExpiry" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#errorStatus", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.errorStatus", + "tags": [ + "errorstatus", + "oauthaccesstokenresponse.errorstatus" + ], + "title": "OAuthAccessTokenResponse.errorStatus" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#extraTokens", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.extraTokens", + "tags": [ + "extratokens", + "oauthaccesstokenresponse.extratokens" + ], + "title": "OAuthAccessTokenResponse.extraTokens" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getAccessToken", + "tags": [ + "getaccesstoken", + "oauthaccesstokenresponse.getaccesstoken" + ], + "title": "OAuthAccessTokenResponse.getAccessToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getAccessTokenExpiry", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getAccessTokenExpiry", + "tags": [ + "getaccesstokenexpiry", + "oauthaccesstokenresponse.getaccesstokenexpiry" + ], + "title": "OAuthAccessTokenResponse.getAccessTokenExpiry" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getErrorStatus", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getErrorStatus", + "tags": [ + "geterrorstatus", + "oauthaccesstokenresponse.geterrorstatus" + ], + "title": "OAuthAccessTokenResponse.getErrorStatus" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getExtraTokens", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getExtraTokens", + "tags": [ + "getextratokens", + "oauthaccesstokenresponse.getextratokens" + ], + "title": "OAuthAccessTokenResponse.getExtraTokens" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getIDToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getIDToken", + "tags": [ + "getidtoken", + "oauthaccesstokenresponse.getidtoken" + ], + "title": "OAuthAccessTokenResponse.getIDToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getOauthProviderId", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getOauthProviderId", + "tags": [ + "getoauthproviderid", + "oauthaccesstokenresponse.getoauthproviderid" + ], + "title": "OAuthAccessTokenResponse.getOauthProviderId" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getRefreshToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getRefreshToken", + "tags": [ + "getrefreshtoken", + "oauthaccesstokenresponse.getrefreshtoken" + ], + "title": "OAuthAccessTokenResponse.getRefreshToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#oauthProviderId", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.oauthProviderId", + "tags": [ + "oauthproviderid", + "oauthaccesstokenresponse.oauthproviderid" + ], + "title": "OAuthAccessTokenResponse.oauthProviderId" + }, + { + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#refreshToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.refreshToken", + "tags": [ + "refreshtoken", + "oauthaccesstokenresponse.refreshtoken" + ], + "title": "OAuthAccessTokenResponse.refreshToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse", + "tags": [ + "oauthfinalizedresponse", + "dw.customer.oauth.oauthfinalizedresponse", + "dw/customer/oauth" + ], + "title": "OAuthFinalizedResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#accessTokenResponse", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.accessTokenResponse", + "tags": [ + "accesstokenresponse", + "oauthfinalizedresponse.accesstokenresponse" + ], + "title": "OAuthFinalizedResponse.accessTokenResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#getAccessTokenResponse", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.getAccessTokenResponse", + "tags": [ + "getaccesstokenresponse", + "oauthfinalizedresponse.getaccesstokenresponse" + ], + "title": "OAuthFinalizedResponse.getAccessTokenResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#getUserInfoResponse", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.getUserInfoResponse", + "tags": [ + "getuserinforesponse", + "oauthfinalizedresponse.getuserinforesponse" + ], + "title": "OAuthFinalizedResponse.getUserInfoResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#userInfoResponse", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.userInfoResponse", + "tags": [ + "userinforesponse", + "oauthfinalizedresponse.userinforesponse" + ], + "title": "OAuthFinalizedResponse.userInfoResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr", + "tags": [ + "oauthloginflowmgr", + "dw.customer.oauth.oauthloginflowmgr", + "dw/customer/oauth" + ], + "title": "OAuthLoginFlowMgr" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#finalizeOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin", + "tags": [ + "finalizeoauthlogin", + "oauthloginflowmgr.finalizeoauthlogin" + ], + "title": "OAuthLoginFlowMgr.finalizeOAuthLogin" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#finalizeOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin", + "tags": [ + "finalizeoauthlogin", + "oauthloginflowmgr.finalizeoauthlogin" + ], + "title": "OAuthLoginFlowMgr.finalizeOAuthLogin" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#initiateOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.initiateOAuthLogin", + "tags": [ + "initiateoauthlogin", + "oauthloginflowmgr.initiateoauthlogin" + ], + "title": "OAuthLoginFlowMgr.initiateOAuthLogin" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#initiateOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.initiateOAuthLogin", + "tags": [ + "initiateoauthlogin", + "oauthloginflowmgr.initiateoauthlogin" + ], + "title": "OAuthLoginFlowMgr.initiateOAuthLogin" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainAccessToken", + "tags": [ + "obtainaccesstoken", + "oauthloginflowmgr.obtainaccesstoken" + ], + "title": "OAuthLoginFlowMgr.obtainAccessToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainAccessToken", + "tags": [ + "obtainaccesstoken", + "oauthloginflowmgr.obtainaccesstoken" + ], + "title": "OAuthLoginFlowMgr.obtainAccessToken" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainUserInfo", + "tags": [ + "obtainuserinfo", + "oauthloginflowmgr.obtainuserinfo" + ], + "title": "OAuthLoginFlowMgr.obtainUserInfo" + }, + { + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainUserInfo", + "tags": [ + "obtainuserinfo", + "oauthloginflowmgr.obtainuserinfo" + ], + "title": "OAuthLoginFlowMgr.obtainUserInfo" + }, + { + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse", + "tags": [ + "oauthuserinforesponse", + "dw.customer.oauth.oauthuserinforesponse", + "dw/customer/oauth" + ], + "title": "OAuthUserInfoResponse" + }, + { + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#errorStatus", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.errorStatus", + "tags": [ + "errorstatus", + "oauthuserinforesponse.errorstatus" + ], + "title": "OAuthUserInfoResponse.errorStatus" + }, + { + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#getErrorStatus", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.getErrorStatus", + "tags": [ + "geterrorstatus", + "oauthuserinforesponse.geterrorstatus" + ], + "title": "OAuthUserInfoResponse.getErrorStatus" + }, + { + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#getUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.getUserInfo", + "tags": [ + "getuserinfo", + "oauthuserinforesponse.getuserinfo" + ], + "title": "OAuthUserInfoResponse.getUserInfo" + }, + { + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#userInfo", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.userInfo", + "tags": [ + "userinfo", + "oauthuserinforesponse.userinfo" + ], + "title": "OAuthUserInfoResponse.userInfo" + }, + { + "id": "script-api:dw/customer/shoppercontext", + "kind": "package", + "packagePath": "dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext", + "tags": [ + "dw/customer/shoppercontext", + "dw.customer.shoppercontext" + ], + "title": "dw.customer.shoppercontext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext", + "tags": [ + "shoppercontext", + "dw.customer.shoppercontext.shoppercontext", + "dw/customer/shoppercontext" + ], + "title": "ShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#assignmentQualifiers", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.assignmentQualifiers", + "tags": [ + "assignmentqualifiers", + "shoppercontext.assignmentqualifiers" + ], + "title": "ShopperContext.assignmentQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#clientIP", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.clientIP", + "tags": [ + "clientip", + "shoppercontext.clientip" + ], + "title": "ShopperContext.clientIP" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#couponCodes", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.couponCodes", + "tags": [ + "couponcodes", + "shoppercontext.couponcodes" + ], + "title": "ShopperContext.couponCodes" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#customQualifiers", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.customQualifiers", + "tags": [ + "customqualifiers", + "shoppercontext.customqualifiers" + ], + "title": "ShopperContext.customQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#customerGroupIDs", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.customerGroupIDs", + "tags": [ + "customergroupids", + "shoppercontext.customergroupids" + ], + "title": "ShopperContext.customerGroupIDs" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#effectiveDateTime", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.effectiveDateTime", + "tags": [ + "effectivedatetime", + "shoppercontext.effectivedatetime" + ], + "title": "ShopperContext.effectiveDateTime" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.geolocation", + "tags": [ + "geolocation", + "shoppercontext.geolocation" + ], + "title": "ShopperContext.geolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getAssignmentQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getAssignmentQualifiers", + "tags": [ + "getassignmentqualifiers", + "shoppercontext.getassignmentqualifiers" + ], + "title": "ShopperContext.getAssignmentQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getClientIP", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getClientIP", + "tags": [ + "getclientip", + "shoppercontext.getclientip" + ], + "title": "ShopperContext.getClientIP" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCouponCodes", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCouponCodes", + "tags": [ + "getcouponcodes", + "shoppercontext.getcouponcodes" + ], + "title": "ShopperContext.getCouponCodes" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCustomQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCustomQualifiers", + "tags": [ + "getcustomqualifiers", + "shoppercontext.getcustomqualifiers" + ], + "title": "ShopperContext.getCustomQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCustomerGroupIDs", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCustomerGroupIDs", + "tags": [ + "getcustomergroupids", + "shoppercontext.getcustomergroupids" + ], + "title": "ShopperContext.getCustomerGroupIDs" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getEffectiveDateTime", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getEffectiveDateTime", + "tags": [ + "geteffectivedatetime", + "shoppercontext.geteffectivedatetime" + ], + "title": "ShopperContext.getEffectiveDateTime" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getGeolocation", + "tags": [ + "getgeolocation", + "shoppercontext.getgeolocation" + ], + "title": "ShopperContext.getGeolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getSourceCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getSourceCode", + "tags": [ + "getsourcecode", + "shoppercontext.getsourcecode" + ], + "title": "ShopperContext.getSourceCode" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setAssignmentQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setAssignmentQualifiers", + "tags": [ + "setassignmentqualifiers", + "shoppercontext.setassignmentqualifiers" + ], + "title": "ShopperContext.setAssignmentQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setClientIP", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setClientIP", + "tags": [ + "setclientip", + "shoppercontext.setclientip" + ], + "title": "ShopperContext.setClientIP" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCouponCodes", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCouponCodes", + "tags": [ + "setcouponcodes", + "shoppercontext.setcouponcodes" + ], + "title": "ShopperContext.setCouponCodes" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCustomQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCustomQualifiers", + "tags": [ + "setcustomqualifiers", + "shoppercontext.setcustomqualifiers" + ], + "title": "ShopperContext.setCustomQualifiers" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCustomerGroupIDs", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCustomerGroupIDs", + "tags": [ + "setcustomergroupids", + "shoppercontext.setcustomergroupids" + ], + "title": "ShopperContext.setCustomerGroupIDs" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setEffectiveDateTime", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setEffectiveDateTime", + "tags": [ + "seteffectivedatetime", + "shoppercontext.seteffectivedatetime" + ], + "title": "ShopperContext.setEffectiveDateTime" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setGeolocation", + "tags": [ + "setgeolocation", + "shoppercontext.setgeolocation" + ], + "title": "ShopperContext.setGeolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setSourceCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setSourceCode", + "tags": [ + "setsourcecode", + "shoppercontext.setsourcecode" + ], + "title": "ShopperContext.setSourceCode" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContext#sourceCode", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.sourceCode", + "tags": [ + "sourcecode", + "shoppercontext.sourcecode" + ], + "title": "ShopperContext.sourceCode" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes", + "tags": [ + "shoppercontexterrorcodes", + "dw.customer.shoppercontext.shoppercontexterrorcodes", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextErrorCodes" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "tags": [ + "assignment_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.assignment_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "tags": [ + "assignment_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.assignment_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#COUPON_CODES_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED", + "tags": [ + "coupon_codes_limit_exceeded", + "shoppercontexterrorcodes.coupon_codes_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#COUPON_CODES_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED", + "tags": [ + "coupon_codes_limit_exceeded", + "shoppercontexterrorcodes.coupon_codes_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "tags": [ + "custom_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.custom_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "tags": [ + "custom_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.custom_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED", + "tags": [ + "feature_disabled", + "shoppercontexterrorcodes.feature_disabled" + ], + "title": "ShopperContextErrorCodes.FEATURE_DISABLED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED", + "tags": [ + "feature_disabled", + "shoppercontexterrorcodes.feature_disabled" + ], + "title": "ShopperContextErrorCodes.FEATURE_DISABLED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR", + "tags": [ + "internal_error", + "shoppercontexterrorcodes.internal_error" + ], + "title": "ShopperContextErrorCodes.INTERNAL_ERROR" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR", + "tags": [ + "internal_error", + "shoppercontexterrorcodes.internal_error" + ], + "title": "ShopperContextErrorCodes.INTERNAL_ERROR" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_ARGUMENT", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT", + "tags": [ + "invalid_argument", + "shoppercontexterrorcodes.invalid_argument" + ], + "title": "ShopperContextErrorCodes.INVALID_ARGUMENT" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_ARGUMENT", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT", + "tags": [ + "invalid_argument", + "shoppercontexterrorcodes.invalid_argument" + ], + "title": "ShopperContextErrorCodes.INVALID_ARGUMENT" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_REQUEST_TYPE", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE", + "tags": [ + "invalid_request_type", + "shoppercontexterrorcodes.invalid_request_type" + ], + "title": "ShopperContextErrorCodes.INVALID_REQUEST_TYPE" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_REQUEST_TYPE", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE", + "tags": [ + "invalid_request_type", + "shoppercontexterrorcodes.invalid_request_type" + ], + "title": "ShopperContextErrorCodes.INVALID_REQUEST_TYPE" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#QUOTA_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED", + "tags": [ + "quota_limit_exceeded", + "shoppercontexterrorcodes.quota_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#QUOTA_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED", + "tags": [ + "quota_limit_exceeded", + "shoppercontexterrorcodes.quota_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextException", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException", + "tags": [ + "shoppercontextexception", + "dw.customer.shoppercontext.shoppercontextexception", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextException" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextException#errorCode", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextException", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException.errorCode", + "tags": [ + "errorcode", + "shoppercontextexception.errorcode" + ], + "title": "ShopperContextException.errorCode" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextException#getErrorCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextException", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException.getErrorCode", + "tags": [ + "geterrorcode", + "shoppercontextexception.geterrorcode" + ], + "title": "ShopperContextException.getErrorCode" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr", + "tags": [ + "shoppercontextmgr", + "dw.customer.shoppercontext.shoppercontextmgr", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextMgr" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.geolocation", + "tags": [ + "geolocation", + "shoppercontextmgr.geolocation" + ], + "title": "ShopperContextMgr.geolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.geolocation", + "tags": [ + "geolocation", + "shoppercontextmgr.geolocation" + ], + "title": "ShopperContextMgr.geolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getGeolocation", + "tags": [ + "getgeolocation", + "shoppercontextmgr.getgeolocation" + ], + "title": "ShopperContextMgr.getGeolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getGeolocation", + "tags": [ + "getgeolocation", + "shoppercontextmgr.getgeolocation" + ], + "title": "ShopperContextMgr.getGeolocation" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getShopperContext", + "tags": [ + "getshoppercontext", + "shoppercontextmgr.getshoppercontext" + ], + "title": "ShopperContextMgr.getShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getShopperContext", + "tags": [ + "getshoppercontext", + "shoppercontextmgr.getshoppercontext" + ], + "title": "ShopperContextMgr.getShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#removeShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext", + "tags": [ + "removeshoppercontext", + "shoppercontextmgr.removeshoppercontext" + ], + "title": "ShopperContextMgr.removeShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#removeShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext", + "tags": [ + "removeshoppercontext", + "shoppercontextmgr.removeshoppercontext" + ], + "title": "ShopperContextMgr.removeShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#setShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.setShopperContext", + "tags": [ + "setshoppercontext", + "shoppercontextmgr.setshoppercontext" + ], + "title": "ShopperContextMgr.setShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#setShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.setShopperContext", + "tags": [ + "setshoppercontext", + "shoppercontextmgr.setshoppercontext" + ], + "title": "ShopperContextMgr.setShopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#shopperContext", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.shopperContext", + "tags": [ + "shoppercontext", + "shoppercontextmgr.shoppercontext" + ], + "title": "ShopperContextMgr.shopperContext" + }, + { + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#shopperContext", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.shopperContext", + "tags": [ + "shoppercontext", + "shoppercontextmgr.shoppercontext" + ], + "title": "ShopperContextMgr.shopperContext" + }, + { + "id": "script-api:dw/experience", + "kind": "package", + "packagePath": "dw/experience", + "qualifiedName": "dw.experience", + "tags": [ + "dw/experience", + "dw.experience" + ], + "title": "dw.experience" + }, + { + "id": "script-api:dw/experience/AspectAttributeValidationException", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.AspectAttributeValidationException", + "tags": [ + "aspectattributevalidationexception", + "dw.experience.aspectattributevalidationexception", + "dw/experience" + ], + "title": "AspectAttributeValidationException" + }, + { + "id": "script-api:dw/experience/Component", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Component", + "tags": [ + "component", + "dw.experience.component", + "dw/experience" + ], + "title": "Component" + }, + { + "id": "script-api:dw/experience/Component#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.ID", + "tags": [ + "id", + "component.id" + ], + "title": "Component.ID" + }, + { + "id": "script-api:dw/experience/Component#getAttribute", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getAttribute", + "tags": [ + "getattribute", + "component.getattribute" + ], + "title": "Component.getAttribute" + }, + { + "id": "script-api:dw/experience/Component#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getID", + "tags": [ + "getid", + "component.getid" + ], + "title": "Component.getID" + }, + { + "id": "script-api:dw/experience/Component#getName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getName", + "tags": [ + "getname", + "component.getname" + ], + "title": "Component.getName" + }, + { + "id": "script-api:dw/experience/Component#getRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getRegion", + "tags": [ + "getregion", + "component.getregion" + ], + "title": "Component.getRegion" + }, + { + "id": "script-api:dw/experience/Component#getTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getTypeID", + "tags": [ + "gettypeid", + "component.gettypeid" + ], + "title": "Component.getTypeID" + }, + { + "id": "script-api:dw/experience/Component#name", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.name", + "tags": [ + "name", + "component.name" + ], + "title": "Component.name" + }, + { + "id": "script-api:dw/experience/Component#typeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.typeID", + "tags": [ + "typeid", + "component.typeid" + ], + "title": "Component.typeID" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.ComponentRenderSettings", + "tags": [ + "componentrendersettings", + "dw.experience.componentrendersettings", + "dw/experience" + ], + "title": "ComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#attributes", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.attributes", + "tags": [ + "attributes", + "componentrendersettings.attributes" + ], + "title": "ComponentRenderSettings.attributes" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#getAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.getAttributes", + "tags": [ + "getattributes", + "componentrendersettings.getattributes" + ], + "title": "ComponentRenderSettings.getAttributes" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#getTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.getTagName", + "tags": [ + "gettagname", + "componentrendersettings.gettagname" + ], + "title": "ComponentRenderSettings.getTagName" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#setAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.setAttributes", + "tags": [ + "setattributes", + "componentrendersettings.setattributes" + ], + "title": "ComponentRenderSettings.setAttributes" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#setTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.setTagName", + "tags": [ + "settagname", + "componentrendersettings.settagname" + ], + "title": "ComponentRenderSettings.setTagName" + }, + { + "id": "script-api:dw/experience/ComponentRenderSettings#tagName", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.tagName", + "tags": [ + "tagname", + "componentrendersettings.tagname" + ], + "title": "ComponentRenderSettings.tagName" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.ComponentScriptContext", + "tags": [ + "componentscriptcontext", + "dw.experience.componentscriptcontext", + "dw/experience" + ], + "title": "ComponentScriptContext" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#component", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.component", + "tags": [ + "component", + "componentscriptcontext.component" + ], + "title": "ComponentScriptContext.component" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#componentRenderSettings", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.componentRenderSettings", + "tags": [ + "componentrendersettings", + "componentscriptcontext.componentrendersettings" + ], + "title": "ComponentScriptContext.componentRenderSettings" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#content", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.content", + "tags": [ + "content", + "componentscriptcontext.content" + ], + "title": "ComponentScriptContext.content" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#getComponent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getComponent", + "tags": [ + "getcomponent", + "componentscriptcontext.getcomponent" + ], + "title": "ComponentScriptContext.getComponent" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#getComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getComponentRenderSettings", + "tags": [ + "getcomponentrendersettings", + "componentscriptcontext.getcomponentrendersettings" + ], + "title": "ComponentScriptContext.getComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/ComponentScriptContext#getContent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getContent", + "tags": [ + "getcontent", + "componentscriptcontext.getcontent" + ], + "title": "ComponentScriptContext.getContent" + }, + { + "id": "script-api:dw/experience/CustomEditor", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.CustomEditor", + "tags": [ + "customeditor", + "dw.experience.customeditor", + "dw/experience" + ], + "title": "CustomEditor" + }, + { + "id": "script-api:dw/experience/CustomEditor#configuration", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.configuration", + "tags": [ + "configuration", + "customeditor.configuration" + ], + "title": "CustomEditor.configuration" + }, + { + "id": "script-api:dw/experience/CustomEditor#dependencies", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.dependencies", + "tags": [ + "dependencies", + "customeditor.dependencies" + ], + "title": "CustomEditor.dependencies" + }, + { + "id": "script-api:dw/experience/CustomEditor#getConfiguration", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getConfiguration", + "tags": [ + "getconfiguration", + "customeditor.getconfiguration" + ], + "title": "CustomEditor.getConfiguration" + }, + { + "id": "script-api:dw/experience/CustomEditor#getDependencies", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getDependencies", + "tags": [ + "getdependencies", + "customeditor.getdependencies" + ], + "title": "CustomEditor.getDependencies" + }, + { + "id": "script-api:dw/experience/CustomEditor#getResources", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getResources", + "tags": [ + "getresources", + "customeditor.getresources" + ], + "title": "CustomEditor.getResources" + }, + { + "id": "script-api:dw/experience/CustomEditor#resources", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.resources", + "tags": [ + "resources", + "customeditor.resources" + ], + "title": "CustomEditor.resources" + }, + { + "id": "script-api:dw/experience/CustomEditorResources", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.CustomEditorResources", + "tags": [ + "customeditorresources", + "dw.experience.customeditorresources", + "dw/experience" + ], + "title": "CustomEditorResources" + }, + { + "id": "script-api:dw/experience/CustomEditorResources#getScripts", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.getScripts", + "tags": [ + "getscripts", + "customeditorresources.getscripts" + ], + "title": "CustomEditorResources.getScripts" + }, + { + "id": "script-api:dw/experience/CustomEditorResources#getStyles", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.getStyles", + "tags": [ + "getstyles", + "customeditorresources.getstyles" + ], + "title": "CustomEditorResources.getStyles" + }, + { + "id": "script-api:dw/experience/CustomEditorResources#scripts", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.scripts", + "tags": [ + "scripts", + "customeditorresources.scripts" + ], + "title": "CustomEditorResources.scripts" + }, + { + "id": "script-api:dw/experience/CustomEditorResources#styles", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.styles", + "tags": [ + "styles", + "customeditorresources.styles" + ], + "title": "CustomEditorResources.styles" + }, + { + "id": "script-api:dw/experience/Page", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Page", + "tags": [ + "page", + "dw.experience.page", + "dw/experience" + ], + "title": "Page" + }, + { + "id": "script-api:dw/experience/Page#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.ID", + "tags": [ + "id", + "page.id" + ], + "title": "Page.ID" + }, + { + "id": "script-api:dw/experience/Page#aspectTypeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.aspectTypeID", + "tags": [ + "aspecttypeid", + "page.aspecttypeid" + ], + "title": "Page.aspectTypeID" + }, + { + "id": "script-api:dw/experience/Page#classificationFolder", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.classificationFolder", + "tags": [ + "classificationfolder", + "page.classificationfolder" + ], + "title": "Page.classificationFolder" + }, + { + "id": "script-api:dw/experience/Page#description", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.description", + "tags": [ + "description", + "page.description" + ], + "title": "Page.description" + }, + { + "id": "script-api:dw/experience/Page#folders", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.folders", + "tags": [ + "folders", + "page.folders" + ], + "title": "Page.folders" + }, + { + "id": "script-api:dw/experience/Page#getAspectTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getAspectTypeID", + "tags": [ + "getaspecttypeid", + "page.getaspecttypeid" + ], + "title": "Page.getAspectTypeID" + }, + { + "id": "script-api:dw/experience/Page#getAttribute", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getAttribute", + "tags": [ + "getattribute", + "page.getattribute" + ], + "title": "Page.getAttribute" + }, + { + "id": "script-api:dw/experience/Page#getClassificationFolder", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getClassificationFolder", + "tags": [ + "getclassificationfolder", + "page.getclassificationfolder" + ], + "title": "Page.getClassificationFolder" + }, + { + "id": "script-api:dw/experience/Page#getDescription", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getDescription", + "tags": [ + "getdescription", + "page.getdescription" + ], + "title": "Page.getDescription" + }, + { + "id": "script-api:dw/experience/Page#getFolders", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getFolders", + "tags": [ + "getfolders", + "page.getfolders" + ], + "title": "Page.getFolders" + }, + { + "id": "script-api:dw/experience/Page#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getID", + "tags": [ + "getid", + "page.getid" + ], + "title": "Page.getID" + }, + { + "id": "script-api:dw/experience/Page#getName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getName", + "tags": [ + "getname", + "page.getname" + ], + "title": "Page.getName" + }, + { + "id": "script-api:dw/experience/Page#getPageDescription", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageDescription", + "tags": [ + "getpagedescription", + "page.getpagedescription" + ], + "title": "Page.getPageDescription" + }, + { + "id": "script-api:dw/experience/Page#getPageKeywords", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageKeywords", + "tags": [ + "getpagekeywords", + "page.getpagekeywords" + ], + "title": "Page.getPageKeywords" + }, + { + "id": "script-api:dw/experience/Page#getPageTitle", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageTitle", + "tags": [ + "getpagetitle", + "page.getpagetitle" + ], + "title": "Page.getPageTitle" + }, + { + "id": "script-api:dw/experience/Page#getRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getRegion", + "tags": [ + "getregion", + "page.getregion" + ], + "title": "Page.getRegion" + }, + { + "id": "script-api:dw/experience/Page#getSearchWords", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getSearchWords", + "tags": [ + "getsearchwords", + "page.getsearchwords" + ], + "title": "Page.getSearchWords" + }, + { + "id": "script-api:dw/experience/Page#getTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getTypeID", + "tags": [ + "gettypeid", + "page.gettypeid" + ], + "title": "Page.getTypeID" + }, + { + "id": "script-api:dw/experience/Page#hasVisibilityRules", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.hasVisibilityRules", + "tags": [ + "hasvisibilityrules", + "page.hasvisibilityrules" + ], + "title": "Page.hasVisibilityRules" + }, + { + "id": "script-api:dw/experience/Page#isVisible", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.isVisible", + "tags": [ + "isvisible", + "page.isvisible" + ], + "title": "Page.isVisible" + }, + { + "id": "script-api:dw/experience/Page#name", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.name", + "tags": [ + "name", + "page.name" + ], + "title": "Page.name" + }, + { + "id": "script-api:dw/experience/Page#pageDescription", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageDescription", + "tags": [ + "pagedescription", + "page.pagedescription" + ], + "title": "Page.pageDescription" + }, + { + "id": "script-api:dw/experience/Page#pageKeywords", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageKeywords", + "tags": [ + "pagekeywords", + "page.pagekeywords" + ], + "title": "Page.pageKeywords" + }, + { + "id": "script-api:dw/experience/Page#pageTitle", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageTitle", + "tags": [ + "pagetitle", + "page.pagetitle" + ], + "title": "Page.pageTitle" + }, + { + "id": "script-api:dw/experience/Page#searchWords", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.searchWords", + "tags": [ + "searchwords", + "page.searchwords" + ], + "title": "Page.searchWords" + }, + { + "id": "script-api:dw/experience/Page#typeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.typeID", + "tags": [ + "typeid", + "page.typeid" + ], + "title": "Page.typeID" + }, + { + "id": "script-api:dw/experience/Page#visible", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.visible", + "tags": [ + "visible", + "page.visible" + ], + "title": "Page.visible" + }, + { + "id": "script-api:dw/experience/PageMgr", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.PageMgr", + "tags": [ + "pagemgr", + "dw.experience.pagemgr", + "dw/experience" + ], + "title": "PageMgr" + }, + { + "id": "script-api:dw/experience/PageMgr#getCustomEditor", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getCustomEditor", + "tags": [ + "getcustomeditor", + "pagemgr.getcustomeditor" + ], + "title": "PageMgr.getCustomEditor" + }, + { + "id": "script-api:dw/experience/PageMgr#getCustomEditor", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getCustomEditor", + "tags": [ + "getcustomeditor", + "pagemgr.getcustomeditor" + ], + "title": "PageMgr.getCustomEditor" + }, + { + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "id": "script-api:dw/experience/PageMgr#getPageByCategory", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByCategory", + "tags": [ + "getpagebycategory", + "pagemgr.getpagebycategory" + ], + "title": "PageMgr.getPageByCategory" + }, + { + "id": "script-api:dw/experience/PageMgr#getPageByCategory", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByCategory", + "tags": [ + "getpagebycategory", + "pagemgr.getpagebycategory" + ], + "title": "PageMgr.getPageByCategory" + }, + { + "id": "script-api:dw/experience/PageMgr#getPageByProduct", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByProduct", + "tags": [ + "getpagebyproduct", + "pagemgr.getpagebyproduct" + ], + "title": "PageMgr.getPageByProduct" + }, + { + "id": "script-api:dw/experience/PageMgr#getPageByProduct", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByProduct", + "tags": [ + "getpagebyproduct", + "pagemgr.getpagebyproduct" + ], + "title": "PageMgr.getPageByProduct" + }, + { + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "id": "script-api:dw/experience/PageScriptContext", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.PageScriptContext", + "tags": [ + "pagescriptcontext", + "dw.experience.pagescriptcontext", + "dw/experience" + ], + "title": "PageScriptContext" + }, + { + "id": "script-api:dw/experience/PageScriptContext#content", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.content", + "tags": [ + "content", + "pagescriptcontext.content" + ], + "title": "PageScriptContext.content" + }, + { + "id": "script-api:dw/experience/PageScriptContext#getContent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getContent", + "tags": [ + "getcontent", + "pagescriptcontext.getcontent" + ], + "title": "PageScriptContext.getContent" + }, + { + "id": "script-api:dw/experience/PageScriptContext#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getPage", + "tags": [ + "getpage", + "pagescriptcontext.getpage" + ], + "title": "PageScriptContext.getPage" + }, + { + "id": "script-api:dw/experience/PageScriptContext#getRenderParameters", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getRenderParameters", + "tags": [ + "getrenderparameters", + "pagescriptcontext.getrenderparameters" + ], + "title": "PageScriptContext.getRenderParameters" + }, + { + "id": "script-api:dw/experience/PageScriptContext#getRuntimeParameters", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getRuntimeParameters", + "tags": [ + "getruntimeparameters", + "pagescriptcontext.getruntimeparameters" + ], + "title": "PageScriptContext.getRuntimeParameters" + }, + { + "id": "script-api:dw/experience/PageScriptContext#page", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.page", + "tags": [ + "page", + "pagescriptcontext.page" + ], + "title": "PageScriptContext.page" + }, + { + "id": "script-api:dw/experience/PageScriptContext#renderParameters", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.renderParameters", + "tags": [ + "renderparameters", + "pagescriptcontext.renderparameters" + ], + "title": "PageScriptContext.renderParameters" + }, + { + "id": "script-api:dw/experience/PageScriptContext#runtimeParameters", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.runtimeParameters", + "tags": [ + "runtimeparameters", + "pagescriptcontext.runtimeparameters" + ], + "title": "PageScriptContext.runtimeParameters" + }, + { + "id": "script-api:dw/experience/Region", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Region", + "tags": [ + "region", + "dw.experience.region", + "dw/experience" + ], + "title": "Region" + }, + { + "id": "script-api:dw/experience/Region#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.ID", + "tags": [ + "id", + "region.id" + ], + "title": "Region.ID" + }, + { + "id": "script-api:dw/experience/Region#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getID", + "tags": [ + "getid", + "region.getid" + ], + "title": "Region.getID" + }, + { + "id": "script-api:dw/experience/Region#getSize", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getSize", + "tags": [ + "getsize", + "region.getsize" + ], + "title": "Region.getSize" + }, + { + "id": "script-api:dw/experience/Region#getVisibleComponents", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getVisibleComponents", + "tags": [ + "getvisiblecomponents", + "region.getvisiblecomponents" + ], + "title": "Region.getVisibleComponents" + }, + { + "id": "script-api:dw/experience/Region#size", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.size", + "tags": [ + "size", + "region.size" + ], + "title": "Region.size" + }, + { + "id": "script-api:dw/experience/Region#visibleComponents", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.visibleComponents", + "tags": [ + "visiblecomponents", + "region.visiblecomponents" + ], + "title": "Region.visibleComponents" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.RegionRenderSettings", + "tags": [ + "regionrendersettings", + "dw.experience.regionrendersettings", + "dw/experience" + ], + "title": "RegionRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#attributes", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.attributes", + "tags": [ + "attributes", + "regionrendersettings.attributes" + ], + "title": "RegionRenderSettings.attributes" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#defaultComponentRenderSettings", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.defaultComponentRenderSettings", + "tags": [ + "defaultcomponentrendersettings", + "regionrendersettings.defaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.defaultComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#getAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getAttributes", + "tags": [ + "getattributes", + "regionrendersettings.getattributes" + ], + "title": "RegionRenderSettings.getAttributes" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#getComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getComponentRenderSettings", + "tags": [ + "getcomponentrendersettings", + "regionrendersettings.getcomponentrendersettings" + ], + "title": "RegionRenderSettings.getComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#getDefaultComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getDefaultComponentRenderSettings", + "tags": [ + "getdefaultcomponentrendersettings", + "regionrendersettings.getdefaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.getDefaultComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#getTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getTagName", + "tags": [ + "gettagname", + "regionrendersettings.gettagname" + ], + "title": "RegionRenderSettings.getTagName" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#setAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setAttributes", + "tags": [ + "setattributes", + "regionrendersettings.setattributes" + ], + "title": "RegionRenderSettings.setAttributes" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#setComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setComponentRenderSettings", + "tags": [ + "setcomponentrendersettings", + "regionrendersettings.setcomponentrendersettings" + ], + "title": "RegionRenderSettings.setComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#setDefaultComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setDefaultComponentRenderSettings", + "tags": [ + "setdefaultcomponentrendersettings", + "regionrendersettings.setdefaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.setDefaultComponentRenderSettings" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#setTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setTagName", + "tags": [ + "settagname", + "regionrendersettings.settagname" + ], + "title": "RegionRenderSettings.setTagName" + }, + { + "id": "script-api:dw/experience/RegionRenderSettings#tagName", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.tagName", + "tags": [ + "tagname", + "regionrendersettings.tagname" + ], + "title": "RegionRenderSettings.tagName" + }, + { + "id": "script-api:dw/experience/cms", + "kind": "package", + "packagePath": "dw/experience/cms", + "qualifiedName": "dw.experience.cms", + "tags": [ + "dw/experience/cms", + "dw.experience.cms" + ], + "title": "dw.experience.cms" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord", + "kind": "class", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms", + "qualifiedName": "dw.experience.cms.CMSRecord", + "tags": [ + "cmsrecord", + "dw.experience.cms.cmsrecord", + "dw/experience/cms" + ], + "title": "CMSRecord" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#ID", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.ID", + "tags": [ + "id", + "cmsrecord.id" + ], + "title": "CMSRecord.ID" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#attributes", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.attributes", + "tags": [ + "attributes", + "cmsrecord.attributes" + ], + "title": "CMSRecord.attributes" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#getAttributes", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getAttributes", + "tags": [ + "getattributes", + "cmsrecord.getattributes" + ], + "title": "CMSRecord.getAttributes" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#getID", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getID", + "tags": [ + "getid", + "cmsrecord.getid" + ], + "title": "CMSRecord.getID" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#getType", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getType", + "tags": [ + "gettype", + "cmsrecord.gettype" + ], + "title": "CMSRecord.getType" + }, + { + "id": "script-api:dw/experience/cms/CMSRecord#type", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.type", + "tags": [ + "type", + "cmsrecord.type" + ], + "title": "CMSRecord.type" + }, + { + "id": "script-api:dw/experience/image", + "kind": "package", + "packagePath": "dw/experience/image", + "qualifiedName": "dw.experience.image", + "tags": [ + "dw/experience/image", + "dw.experience.image" + ], + "title": "dw.experience.image" + }, + { + "id": "script-api:dw/experience/image/FocalPoint", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.FocalPoint", + "tags": [ + "focalpoint", + "dw.experience.image.focalpoint", + "dw/experience/image" + ], + "title": "FocalPoint" + }, + { + "id": "script-api:dw/experience/image/FocalPoint#getX", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.getX", + "tags": [ + "getx", + "focalpoint.getx" + ], + "title": "FocalPoint.getX" + }, + { + "id": "script-api:dw/experience/image/FocalPoint#getY", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.getY", + "tags": [ + "gety", + "focalpoint.gety" + ], + "title": "FocalPoint.getY" + }, + { + "id": "script-api:dw/experience/image/FocalPoint#x", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.x", + "tags": [ + "x", + "focalpoint.x" + ], + "title": "FocalPoint.x" + }, + { + "id": "script-api:dw/experience/image/FocalPoint#y", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.y", + "tags": [ + "y", + "focalpoint.y" + ], + "title": "FocalPoint.y" + }, + { + "id": "script-api:dw/experience/image/Image", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.Image", + "tags": [ + "image", + "dw.experience.image.image", + "dw/experience/image" + ], + "title": "Image" + }, + { + "id": "script-api:dw/experience/image/Image#file", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.file", + "tags": [ + "file", + "image.file" + ], + "title": "Image.file" + }, + { + "id": "script-api:dw/experience/image/Image#focalPoint", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.focalPoint", + "tags": [ + "focalpoint", + "image.focalpoint" + ], + "title": "Image.focalPoint" + }, + { + "id": "script-api:dw/experience/image/Image#getFile", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getFile", + "tags": [ + "getfile", + "image.getfile" + ], + "title": "Image.getFile" + }, + { + "id": "script-api:dw/experience/image/Image#getFocalPoint", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getFocalPoint", + "tags": [ + "getfocalpoint", + "image.getfocalpoint" + ], + "title": "Image.getFocalPoint" + }, + { + "id": "script-api:dw/experience/image/Image#getMetaData", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getMetaData", + "tags": [ + "getmetadata", + "image.getmetadata" + ], + "title": "Image.getMetaData" + }, + { + "id": "script-api:dw/experience/image/Image#metaData", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.metaData", + "tags": [ + "metadata", + "image.metadata" + ], + "title": "Image.metaData" + }, + { + "id": "script-api:dw/experience/image/ImageMetaData", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.ImageMetaData", + "tags": [ + "imagemetadata", + "dw.experience.image.imagemetadata", + "dw/experience/image" + ], + "title": "ImageMetaData" + }, + { + "id": "script-api:dw/experience/image/ImageMetaData#getHeight", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.getHeight", + "tags": [ + "getheight", + "imagemetadata.getheight" + ], + "title": "ImageMetaData.getHeight" + }, + { + "id": "script-api:dw/experience/image/ImageMetaData#getWidth", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.getWidth", + "tags": [ + "getwidth", + "imagemetadata.getwidth" + ], + "title": "ImageMetaData.getWidth" + }, + { + "id": "script-api:dw/experience/image/ImageMetaData#height", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.height", + "tags": [ + "height", + "imagemetadata.height" + ], + "title": "ImageMetaData.height" + }, + { + "id": "script-api:dw/experience/image/ImageMetaData#width", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.width", + "tags": [ + "width", + "imagemetadata.width" + ], + "title": "ImageMetaData.width" + }, + { + "id": "script-api:dw/extensions/applepay", + "kind": "package", + "packagePath": "dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay", + "tags": [ + "dw/extensions/applepay", + "dw.extensions.applepay" + ], + "title": "dw.extensions.applepay" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult", + "kind": "class", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult", + "tags": [ + "applepayhookresult", + "dw.extensions.applepay.applepayhookresult", + "dw/extensions/applepay" + ], + "title": "ApplePayHookResult" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_BILLING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_BILLING_ADDRESS", + "tags": [ + "reason_billing_address", + "applepayhookresult.reason_billing_address" + ], + "title": "ApplePayHookResult.REASON_BILLING_ADDRESS" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_BILLING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_BILLING_ADDRESS", + "tags": [ + "reason_billing_address", + "applepayhookresult.reason_billing_address" + ], + "title": "ApplePayHookResult.REASON_BILLING_ADDRESS" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_FAILURE", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_FAILURE", + "tags": [ + "reason_failure", + "applepayhookresult.reason_failure" + ], + "title": "ApplePayHookResult.REASON_FAILURE" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_FAILURE", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_FAILURE", + "tags": [ + "reason_failure", + "applepayhookresult.reason_failure" + ], + "title": "ApplePayHookResult.REASON_FAILURE" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_INCORRECT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_INCORRECT", + "tags": [ + "reason_pin_incorrect", + "applepayhookresult.reason_pin_incorrect" + ], + "title": "ApplePayHookResult.REASON_PIN_INCORRECT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_INCORRECT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_INCORRECT", + "tags": [ + "reason_pin_incorrect", + "applepayhookresult.reason_pin_incorrect" + ], + "title": "ApplePayHookResult.REASON_PIN_INCORRECT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_LOCKOUT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_LOCKOUT", + "tags": [ + "reason_pin_lockout", + "applepayhookresult.reason_pin_lockout" + ], + "title": "ApplePayHookResult.REASON_PIN_LOCKOUT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_LOCKOUT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_LOCKOUT", + "tags": [ + "reason_pin_lockout", + "applepayhookresult.reason_pin_lockout" + ], + "title": "ApplePayHookResult.REASON_PIN_LOCKOUT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_REQUIRED", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_REQUIRED", + "tags": [ + "reason_pin_required", + "applepayhookresult.reason_pin_required" + ], + "title": "ApplePayHookResult.REASON_PIN_REQUIRED" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_REQUIRED", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_REQUIRED", + "tags": [ + "reason_pin_required", + "applepayhookresult.reason_pin_required" + ], + "title": "ApplePayHookResult.REASON_PIN_REQUIRED" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_ADDRESS", + "tags": [ + "reason_shipping_address", + "applepayhookresult.reason_shipping_address" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_ADDRESS" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_ADDRESS", + "tags": [ + "reason_shipping_address", + "applepayhookresult.reason_shipping_address" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_ADDRESS" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_CONTACT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_CONTACT", + "tags": [ + "reason_shipping_contact", + "applepayhookresult.reason_shipping_contact" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_CONTACT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_CONTACT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_CONTACT", + "tags": [ + "reason_shipping_contact", + "applepayhookresult.reason_shipping_contact" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_CONTACT" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#STATUS_REASON_DETAIL_KEY", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.STATUS_REASON_DETAIL_KEY", + "tags": [ + "status_reason_detail_key", + "applepayhookresult.status_reason_detail_key" + ], + "title": "ApplePayHookResult.STATUS_REASON_DETAIL_KEY" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#STATUS_REASON_DETAIL_KEY", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.STATUS_REASON_DETAIL_KEY", + "tags": [ + "status_reason_detail_key", + "applepayhookresult.status_reason_detail_key" + ], + "title": "ApplePayHookResult.STATUS_REASON_DETAIL_KEY" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#eventDetail", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.eventDetail", + "tags": [ + "eventdetail", + "applepayhookresult.eventdetail" + ], + "title": "ApplePayHookResult.eventDetail" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#eventName", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.eventName", + "tags": [ + "eventname", + "applepayhookresult.eventname" + ], + "title": "ApplePayHookResult.eventName" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getEventDetail", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getEventDetail", + "tags": [ + "geteventdetail", + "applepayhookresult.geteventdetail" + ], + "title": "ApplePayHookResult.getEventDetail" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getEventName", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getEventName", + "tags": [ + "geteventname", + "applepayhookresult.geteventname" + ], + "title": "ApplePayHookResult.getEventName" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getRedirect", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getRedirect", + "tags": [ + "getredirect", + "applepayhookresult.getredirect" + ], + "title": "ApplePayHookResult.getRedirect" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getStatus", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getStatus", + "tags": [ + "getstatus", + "applepayhookresult.getstatus" + ], + "title": "ApplePayHookResult.getStatus" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#redirect", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.redirect", + "tags": [ + "redirect", + "applepayhookresult.redirect" + ], + "title": "ApplePayHookResult.redirect" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.setEvent", + "tags": [ + "setevent", + "applepayhookresult.setevent" + ], + "title": "ApplePayHookResult.setEvent" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.setEvent", + "tags": [ + "setevent", + "applepayhookresult.setevent" + ], + "title": "ApplePayHookResult.setEvent" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#status", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.status", + "tags": [ + "status", + "applepayhookresult.status" + ], + "title": "ApplePayHookResult.status" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks", + "kind": "interface", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks", + "tags": [ + "applepayhooks", + "dw.extensions.applepay.applepayhooks", + "dw/extensions/applepay" + ], + "title": "ApplePayHooks" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#authorizeOrderPayment", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.authorizeOrderPayment", + "tags": [ + "authorizeorderpayment", + "applepayhooks.authorizeorderpayment" + ], + "title": "ApplePayHooks.authorizeOrderPayment" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#cancel", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.cancel", + "tags": [ + "cancel", + "applepayhooks.cancel" + ], + "title": "ApplePayHooks.cancel" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#createOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.createOrder", + "tags": [ + "createorder", + "applepayhooks.createorder" + ], + "title": "ApplePayHooks.createOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointCancel", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointCancel", + "tags": [ + "extensionpointcancel", + "applepayhooks.extensionpointcancel" + ], + "title": "ApplePayHooks.extensionPointCancel" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointGetRequest", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointGetRequest", + "tags": [ + "extensionpointgetrequest", + "applepayhooks.extensionpointgetrequest" + ], + "title": "ApplePayHooks.extensionPointGetRequest" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedAuthorizeOrderPayment", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedAuthorizeOrderPayment", + "tags": [ + "extensionpointpaymentauthorizedauthorizeorderpayment", + "applepayhooks.extensionpointpaymentauthorizedauthorizeorderpayment" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedAuthorizeOrderPayment" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedCreateOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedCreateOrder", + "tags": [ + "extensionpointpaymentauthorizedcreateorder", + "applepayhooks.extensionpointpaymentauthorizedcreateorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedCreateOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedFailOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedFailOrder", + "tags": [ + "extensionpointpaymentauthorizedfailorder", + "applepayhooks.extensionpointpaymentauthorizedfailorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedFailOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedPlaceOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedPlaceOrder", + "tags": [ + "extensionpointpaymentauthorizedplaceorder", + "applepayhooks.extensionpointpaymentauthorizedplaceorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedPlaceOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentMethodSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentMethodSelected", + "tags": [ + "extensionpointpaymentmethodselected", + "applepayhooks.extensionpointpaymentmethodselected" + ], + "title": "ApplePayHooks.extensionPointPaymentMethodSelected" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPrepareBasket", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPrepareBasket", + "tags": [ + "extensionpointpreparebasket", + "applepayhooks.extensionpointpreparebasket" + ], + "title": "ApplePayHooks.extensionPointPrepareBasket" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointShippingContactSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointShippingContactSelected", + "tags": [ + "extensionpointshippingcontactselected", + "applepayhooks.extensionpointshippingcontactselected" + ], + "title": "ApplePayHooks.extensionPointShippingContactSelected" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointShippingMethodSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointShippingMethodSelected", + "tags": [ + "extensionpointshippingmethodselected", + "applepayhooks.extensionpointshippingmethodselected" + ], + "title": "ApplePayHooks.extensionPointShippingMethodSelected" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#failOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.failOrder", + "tags": [ + "failorder", + "applepayhooks.failorder" + ], + "title": "ApplePayHooks.failOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#getRequest", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.getRequest", + "tags": [ + "getrequest", + "applepayhooks.getrequest" + ], + "title": "ApplePayHooks.getRequest" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#paymentMethodSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.paymentMethodSelected", + "tags": [ + "paymentmethodselected", + "applepayhooks.paymentmethodselected" + ], + "title": "ApplePayHooks.paymentMethodSelected" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#placeOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.placeOrder", + "tags": [ + "placeorder", + "applepayhooks.placeorder" + ], + "title": "ApplePayHooks.placeOrder" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#prepareBasket", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.prepareBasket", + "tags": [ + "preparebasket", + "applepayhooks.preparebasket" + ], + "title": "ApplePayHooks.prepareBasket" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#shippingContactSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.shippingContactSelected", + "tags": [ + "shippingcontactselected", + "applepayhooks.shippingcontactselected" + ], + "title": "ApplePayHooks.shippingContactSelected" + }, + { + "id": "script-api:dw/extensions/applepay/ApplePayHooks#shippingMethodSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.shippingMethodSelected", + "tags": [ + "shippingmethodselected", + "applepayhooks.shippingmethodselected" + ], + "title": "ApplePayHooks.shippingMethodSelected" + }, + { + "id": "script-api:dw/extensions/facebook", + "kind": "package", + "packagePath": "dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook", + "tags": [ + "dw/extensions/facebook", + "dw.extensions.facebook" + ], + "title": "dw.extensions.facebook" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "kind": "interface", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks", + "tags": [ + "facebookfeedhooks", + "dw.extensions.facebook.facebookfeedhooks", + "dw/extensions/facebook" + ], + "title": "FacebookFeedHooks" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks#extensionPointTransformProduct", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks.extensionPointTransformProduct", + "tags": [ + "extensionpointtransformproduct", + "facebookfeedhooks.extensionpointtransformproduct" + ], + "title": "FacebookFeedHooks.extensionPointTransformProduct" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks#transformProduct", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks.transformProduct", + "tags": [ + "transformproduct", + "facebookfeedhooks.transformproduct" + ], + "title": "FacebookFeedHooks.transformProduct" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct", + "kind": "class", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook.FacebookProduct", + "tags": [ + "facebookproduct", + "dw.extensions.facebook.facebookproduct", + "dw/extensions/facebook" + ], + "title": "FacebookProduct" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_ADULT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT", + "tags": [ + "age_group_adult", + "facebookproduct.age_group_adult" + ], + "title": "FacebookProduct.AGE_GROUP_ADULT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_ADULT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT", + "tags": [ + "age_group_adult", + "facebookproduct.age_group_adult" + ], + "title": "FacebookProduct.AGE_GROUP_ADULT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_INFANT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT", + "tags": [ + "age_group_infant", + "facebookproduct.age_group_infant" + ], + "title": "FacebookProduct.AGE_GROUP_INFANT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_INFANT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT", + "tags": [ + "age_group_infant", + "facebookproduct.age_group_infant" + ], + "title": "FacebookProduct.AGE_GROUP_INFANT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_KIDS", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS", + "tags": [ + "age_group_kids", + "facebookproduct.age_group_kids" + ], + "title": "FacebookProduct.AGE_GROUP_KIDS" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_KIDS", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS", + "tags": [ + "age_group_kids", + "facebookproduct.age_group_kids" + ], + "title": "FacebookProduct.AGE_GROUP_KIDS" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_NEWBORN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN", + "tags": [ + "age_group_newborn", + "facebookproduct.age_group_newborn" + ], + "title": "FacebookProduct.AGE_GROUP_NEWBORN" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_NEWBORN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN", + "tags": [ + "age_group_newborn", + "facebookproduct.age_group_newborn" + ], + "title": "FacebookProduct.AGE_GROUP_NEWBORN" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_TODDLER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER", + "tags": [ + "age_group_toddler", + "facebookproduct.age_group_toddler" + ], + "title": "FacebookProduct.AGE_GROUP_TODDLER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_TODDLER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER", + "tags": [ + "age_group_toddler", + "facebookproduct.age_group_toddler" + ], + "title": "FacebookProduct.AGE_GROUP_TODDLER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_AVAILABLE_FOR_ORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER", + "tags": [ + "availability_available_for_order", + "facebookproduct.availability_available_for_order" + ], + "title": "FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_AVAILABLE_FOR_ORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER", + "tags": [ + "availability_available_for_order", + "facebookproduct.availability_available_for_order" + ], + "title": "FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK", + "tags": [ + "availability_in_stock", + "facebookproduct.availability_in_stock" + ], + "title": "FacebookProduct.AVAILABILITY_IN_STOCK" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK", + "tags": [ + "availability_in_stock", + "facebookproduct.availability_in_stock" + ], + "title": "FacebookProduct.AVAILABILITY_IN_STOCK" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK", + "tags": [ + "availability_out_of_stock", + "facebookproduct.availability_out_of_stock" + ], + "title": "FacebookProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK", + "tags": [ + "availability_out_of_stock", + "facebookproduct.availability_out_of_stock" + ], + "title": "FacebookProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "tags": [ + "availability_preorder", + "facebookproduct.availability_preorder" + ], + "title": "FacebookProduct.AVAILABILITY_PREORDER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "tags": [ + "availability_preorder", + "facebookproduct.availability_preorder" + ], + "title": "FacebookProduct.AVAILABILITY_PREORDER" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_NEW", + "tags": [ + "condition_new", + "facebookproduct.condition_new" + ], + "title": "FacebookProduct.CONDITION_NEW" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_NEW", + "tags": [ + "condition_new", + "facebookproduct.condition_new" + ], + "title": "FacebookProduct.CONDITION_NEW" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED", + "tags": [ + "condition_refurbished", + "facebookproduct.condition_refurbished" + ], + "title": "FacebookProduct.CONDITION_REFURBISHED" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED", + "tags": [ + "condition_refurbished", + "facebookproduct.condition_refurbished" + ], + "title": "FacebookProduct.CONDITION_REFURBISHED" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_USED", + "tags": [ + "condition_used", + "facebookproduct.condition_used" + ], + "title": "FacebookProduct.CONDITION_USED" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_USED", + "tags": [ + "condition_used", + "facebookproduct.condition_used" + ], + "title": "FacebookProduct.CONDITION_USED" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_FEMALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_FEMALE", + "tags": [ + "gender_female", + "facebookproduct.gender_female" + ], + "title": "FacebookProduct.GENDER_FEMALE" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_FEMALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_FEMALE", + "tags": [ + "gender_female", + "facebookproduct.gender_female" + ], + "title": "FacebookProduct.GENDER_FEMALE" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_MALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_MALE", + "tags": [ + "gender_male", + "facebookproduct.gender_male" + ], + "title": "FacebookProduct.GENDER_MALE" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_MALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_MALE", + "tags": [ + "gender_male", + "facebookproduct.gender_male" + ], + "title": "FacebookProduct.GENDER_MALE" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_UNISEX", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_UNISEX", + "tags": [ + "gender_unisex", + "facebookproduct.gender_unisex" + ], + "title": "FacebookProduct.GENDER_UNISEX" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_UNISEX", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_UNISEX", + "tags": [ + "gender_unisex", + "facebookproduct.gender_unisex" + ], + "title": "FacebookProduct.GENDER_UNISEX" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#ID", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.ID", + "tags": [ + "id", + "facebookproduct.id" + ], + "title": "FacebookProduct.ID" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_CM", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_CM", + "tags": [ + "shipping_size_unit_cm", + "facebookproduct.shipping_size_unit_cm" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_CM" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_CM", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_CM", + "tags": [ + "shipping_size_unit_cm", + "facebookproduct.shipping_size_unit_cm" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_CM" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_FT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_FT", + "tags": [ + "shipping_size_unit_ft", + "facebookproduct.shipping_size_unit_ft" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_FT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_FT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_FT", + "tags": [ + "shipping_size_unit_ft", + "facebookproduct.shipping_size_unit_ft" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_FT" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_IN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_IN", + "tags": [ + "shipping_size_unit_in", + "facebookproduct.shipping_size_unit_in" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_IN" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_IN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_IN", + "tags": [ + "shipping_size_unit_in", + "facebookproduct.shipping_size_unit_in" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_IN" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_M", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_M", + "tags": [ + "shipping_size_unit_m", + "facebookproduct.shipping_size_unit_m" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_M" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_M", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_M", + "tags": [ + "shipping_size_unit_m", + "facebookproduct.shipping_size_unit_m" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_M" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_G", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G", + "tags": [ + "shipping_weight_unit_g", + "facebookproduct.shipping_weight_unit_g" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_G" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_G", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G", + "tags": [ + "shipping_weight_unit_g", + "facebookproduct.shipping_weight_unit_g" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_G" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_KG", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG", + "tags": [ + "shipping_weight_unit_kg", + "facebookproduct.shipping_weight_unit_kg" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_KG" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_KG", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG", + "tags": [ + "shipping_weight_unit_kg", + "facebookproduct.shipping_weight_unit_kg" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_KG" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_LB", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB", + "tags": [ + "shipping_weight_unit_lb", + "facebookproduct.shipping_weight_unit_lb" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_LB" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_LB", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB", + "tags": [ + "shipping_weight_unit_lb", + "facebookproduct.shipping_weight_unit_lb" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_LB" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_OZ", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ", + "tags": [ + "shipping_weight_unit_oz", + "facebookproduct.shipping_weight_unit_oz" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_OZ", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ", + "tags": [ + "shipping_weight_unit_oz", + "facebookproduct.shipping_weight_unit_oz" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#ageGroup", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.ageGroup", + "tags": [ + "agegroup", + "facebookproduct.agegroup" + ], + "title": "FacebookProduct.ageGroup" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#availability", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.availability", + "tags": [ + "availability", + "facebookproduct.availability" + ], + "title": "FacebookProduct.availability" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#brand", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.brand", + "tags": [ + "brand", + "facebookproduct.brand" + ], + "title": "FacebookProduct.brand" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#color", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.color", + "tags": [ + "color", + "facebookproduct.color" + ], + "title": "FacebookProduct.color" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#condition", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.condition", + "tags": [ + "condition", + "facebookproduct.condition" + ], + "title": "FacebookProduct.condition" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel0", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel0", + "tags": [ + "customlabel0", + "facebookproduct.customlabel0" + ], + "title": "FacebookProduct.customLabel0" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel1", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel1", + "tags": [ + "customlabel1", + "facebookproduct.customlabel1" + ], + "title": "FacebookProduct.customLabel1" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel2", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel2", + "tags": [ + "customlabel2", + "facebookproduct.customlabel2" + ], + "title": "FacebookProduct.customLabel2" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel3", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel3", + "tags": [ + "customlabel3", + "facebookproduct.customlabel3" + ], + "title": "FacebookProduct.customLabel3" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel4", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel4", + "tags": [ + "customlabel4", + "facebookproduct.customlabel4" + ], + "title": "FacebookProduct.customLabel4" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#description", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.description", + "tags": [ + "description", + "facebookproduct.description" + ], + "title": "FacebookProduct.description" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#expirationDate", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.expirationDate", + "tags": [ + "expirationdate", + "facebookproduct.expirationdate" + ], + "title": "FacebookProduct.expirationDate" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#gender", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.gender", + "tags": [ + "gender", + "facebookproduct.gender" + ], + "title": "FacebookProduct.gender" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getAgeGroup", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getAgeGroup", + "tags": [ + "getagegroup", + "facebookproduct.getagegroup" + ], + "title": "FacebookProduct.getAgeGroup" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getAvailability", + "tags": [ + "getavailability", + "facebookproduct.getavailability" + ], + "title": "FacebookProduct.getAvailability" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getBrand", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getBrand", + "tags": [ + "getbrand", + "facebookproduct.getbrand" + ], + "title": "FacebookProduct.getBrand" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getColor", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getColor", + "tags": [ + "getcolor", + "facebookproduct.getcolor" + ], + "title": "FacebookProduct.getColor" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCondition", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCondition", + "tags": [ + "getcondition", + "facebookproduct.getcondition" + ], + "title": "FacebookProduct.getCondition" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel0", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel0", + "tags": [ + "getcustomlabel0", + "facebookproduct.getcustomlabel0" + ], + "title": "FacebookProduct.getCustomLabel0" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel1", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel1", + "tags": [ + "getcustomlabel1", + "facebookproduct.getcustomlabel1" + ], + "title": "FacebookProduct.getCustomLabel1" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel2", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel2", + "tags": [ + "getcustomlabel2", + "facebookproduct.getcustomlabel2" + ], + "title": "FacebookProduct.getCustomLabel2" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel3", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel3", + "tags": [ + "getcustomlabel3", + "facebookproduct.getcustomlabel3" + ], + "title": "FacebookProduct.getCustomLabel3" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel4", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel4", + "tags": [ + "getcustomlabel4", + "facebookproduct.getcustomlabel4" + ], + "title": "FacebookProduct.getCustomLabel4" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getDescription", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getDescription", + "tags": [ + "getdescription", + "facebookproduct.getdescription" + ], + "title": "FacebookProduct.getDescription" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getExpirationDate", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getExpirationDate", + "tags": [ + "getexpirationdate", + "facebookproduct.getexpirationdate" + ], + "title": "FacebookProduct.getExpirationDate" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGender", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGender", + "tags": [ + "getgender", + "facebookproduct.getgender" + ], + "title": "FacebookProduct.getGender" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGoogleProductCategory", + "tags": [ + "getgoogleproductcategory", + "facebookproduct.getgoogleproductcategory" + ], + "title": "FacebookProduct.getGoogleProductCategory" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGtin", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGtin", + "tags": [ + "getgtin", + "facebookproduct.getgtin" + ], + "title": "FacebookProduct.getGtin" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getID", + "tags": [ + "getid", + "facebookproduct.getid" + ], + "title": "FacebookProduct.getID" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getImageLinks", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getImageLinks", + "tags": [ + "getimagelinks", + "facebookproduct.getimagelinks" + ], + "title": "FacebookProduct.getImageLinks" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getItemGroupID", + "tags": [ + "getitemgroupid", + "facebookproduct.getitemgroupid" + ], + "title": "FacebookProduct.getItemGroupID" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getLink", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getLink", + "tags": [ + "getlink", + "facebookproduct.getlink" + ], + "title": "FacebookProduct.getLink" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getMaterial", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getMaterial", + "tags": [ + "getmaterial", + "facebookproduct.getmaterial" + ], + "title": "FacebookProduct.getMaterial" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getMpn", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getMpn", + "tags": [ + "getmpn", + "facebookproduct.getmpn" + ], + "title": "FacebookProduct.getMpn" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getPattern", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getPattern", + "tags": [ + "getpattern", + "facebookproduct.getpattern" + ], + "title": "FacebookProduct.getPattern" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getPrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getPrice", + "tags": [ + "getprice", + "facebookproduct.getprice" + ], + "title": "FacebookProduct.getPrice" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getProductType", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getProductType", + "tags": [ + "getproducttype", + "facebookproduct.getproducttype" + ], + "title": "FacebookProduct.getProductType" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePrice", + "tags": [ + "getsaleprice", + "facebookproduct.getsaleprice" + ], + "title": "FacebookProduct.getSalePrice" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePriceEffectiveDateEnd", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePriceEffectiveDateEnd", + "tags": [ + "getsalepriceeffectivedateend", + "facebookproduct.getsalepriceeffectivedateend" + ], + "title": "FacebookProduct.getSalePriceEffectiveDateEnd" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePriceEffectiveDateStart", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePriceEffectiveDateStart", + "tags": [ + "getsalepriceeffectivedatestart", + "facebookproduct.getsalepriceeffectivedatestart" + ], + "title": "FacebookProduct.getSalePriceEffectiveDateStart" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingHeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingHeight", + "tags": [ + "getshippingheight", + "facebookproduct.getshippingheight" + ], + "title": "FacebookProduct.getShippingHeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingLength", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingLength", + "tags": [ + "getshippinglength", + "facebookproduct.getshippinglength" + ], + "title": "FacebookProduct.getShippingLength" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingSizeUnit", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingSizeUnit", + "tags": [ + "getshippingsizeunit", + "facebookproduct.getshippingsizeunit" + ], + "title": "FacebookProduct.getShippingSizeUnit" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingWeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingWeight", + "tags": [ + "getshippingweight", + "facebookproduct.getshippingweight" + ], + "title": "FacebookProduct.getShippingWeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingWidth", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingWidth", + "tags": [ + "getshippingwidth", + "facebookproduct.getshippingwidth" + ], + "title": "FacebookProduct.getShippingWidth" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSize", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSize", + "tags": [ + "getsize", + "facebookproduct.getsize" + ], + "title": "FacebookProduct.getSize" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#getTitle", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getTitle", + "tags": [ + "gettitle", + "facebookproduct.gettitle" + ], + "title": "FacebookProduct.getTitle" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#googleProductCategory", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.googleProductCategory", + "tags": [ + "googleproductcategory", + "facebookproduct.googleproductcategory" + ], + "title": "FacebookProduct.googleProductCategory" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#gtin", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.gtin", + "tags": [ + "gtin", + "facebookproduct.gtin" + ], + "title": "FacebookProduct.gtin" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#imageLinks", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.imageLinks", + "tags": [ + "imagelinks", + "facebookproduct.imagelinks" + ], + "title": "FacebookProduct.imageLinks" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#itemGroupID", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.itemGroupID", + "tags": [ + "itemgroupid", + "facebookproduct.itemgroupid" + ], + "title": "FacebookProduct.itemGroupID" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#link", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.link", + "tags": [ + "link", + "facebookproduct.link" + ], + "title": "FacebookProduct.link" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#material", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.material", + "tags": [ + "material", + "facebookproduct.material" + ], + "title": "FacebookProduct.material" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#mpn", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.mpn", + "tags": [ + "mpn", + "facebookproduct.mpn" + ], + "title": "FacebookProduct.mpn" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#pattern", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.pattern", + "tags": [ + "pattern", + "facebookproduct.pattern" + ], + "title": "FacebookProduct.pattern" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#price", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.price", + "tags": [ + "price", + "facebookproduct.price" + ], + "title": "FacebookProduct.price" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#productType", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.productType", + "tags": [ + "producttype", + "facebookproduct.producttype" + ], + "title": "FacebookProduct.productType" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePrice", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePrice", + "tags": [ + "saleprice", + "facebookproduct.saleprice" + ], + "title": "FacebookProduct.salePrice" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePriceEffectiveDateEnd", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePriceEffectiveDateEnd", + "tags": [ + "salepriceeffectivedateend", + "facebookproduct.salepriceeffectivedateend" + ], + "title": "FacebookProduct.salePriceEffectiveDateEnd" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePriceEffectiveDateStart", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePriceEffectiveDateStart", + "tags": [ + "salepriceeffectivedatestart", + "facebookproduct.salepriceeffectivedatestart" + ], + "title": "FacebookProduct.salePriceEffectiveDateStart" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setAgeGroup", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setAgeGroup", + "tags": [ + "setagegroup", + "facebookproduct.setagegroup" + ], + "title": "FacebookProduct.setAgeGroup" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setAvailability", + "tags": [ + "setavailability", + "facebookproduct.setavailability" + ], + "title": "FacebookProduct.setAvailability" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setBrand", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setBrand", + "tags": [ + "setbrand", + "facebookproduct.setbrand" + ], + "title": "FacebookProduct.setBrand" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setColor", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setColor", + "tags": [ + "setcolor", + "facebookproduct.setcolor" + ], + "title": "FacebookProduct.setColor" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCondition", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCondition", + "tags": [ + "setcondition", + "facebookproduct.setcondition" + ], + "title": "FacebookProduct.setCondition" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel0", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel0", + "tags": [ + "setcustomlabel0", + "facebookproduct.setcustomlabel0" + ], + "title": "FacebookProduct.setCustomLabel0" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel1", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel1", + "tags": [ + "setcustomlabel1", + "facebookproduct.setcustomlabel1" + ], + "title": "FacebookProduct.setCustomLabel1" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel2", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel2", + "tags": [ + "setcustomlabel2", + "facebookproduct.setcustomlabel2" + ], + "title": "FacebookProduct.setCustomLabel2" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel3", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel3", + "tags": [ + "setcustomlabel3", + "facebookproduct.setcustomlabel3" + ], + "title": "FacebookProduct.setCustomLabel3" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel4", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel4", + "tags": [ + "setcustomlabel4", + "facebookproduct.setcustomlabel4" + ], + "title": "FacebookProduct.setCustomLabel4" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setDescription", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setDescription", + "tags": [ + "setdescription", + "facebookproduct.setdescription" + ], + "title": "FacebookProduct.setDescription" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setExpirationDate", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setExpirationDate", + "tags": [ + "setexpirationdate", + "facebookproduct.setexpirationdate" + ], + "title": "FacebookProduct.setExpirationDate" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGender", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGender", + "tags": [ + "setgender", + "facebookproduct.setgender" + ], + "title": "FacebookProduct.setGender" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGoogleProductCategory", + "tags": [ + "setgoogleproductcategory", + "facebookproduct.setgoogleproductcategory" + ], + "title": "FacebookProduct.setGoogleProductCategory" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGtin", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGtin", + "tags": [ + "setgtin", + "facebookproduct.setgtin" + ], + "title": "FacebookProduct.setGtin" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setImageLinks", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setImageLinks", + "tags": [ + "setimagelinks", + "facebookproduct.setimagelinks" + ], + "title": "FacebookProduct.setImageLinks" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setItemGroupID", + "tags": [ + "setitemgroupid", + "facebookproduct.setitemgroupid" + ], + "title": "FacebookProduct.setItemGroupID" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setLink", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setLink", + "tags": [ + "setlink", + "facebookproduct.setlink" + ], + "title": "FacebookProduct.setLink" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setMaterial", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setMaterial", + "tags": [ + "setmaterial", + "facebookproduct.setmaterial" + ], + "title": "FacebookProduct.setMaterial" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setMpn", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setMpn", + "tags": [ + "setmpn", + "facebookproduct.setmpn" + ], + "title": "FacebookProduct.setMpn" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setPattern", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setPattern", + "tags": [ + "setpattern", + "facebookproduct.setpattern" + ], + "title": "FacebookProduct.setPattern" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setPrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setPrice", + "tags": [ + "setprice", + "facebookproduct.setprice" + ], + "title": "FacebookProduct.setPrice" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setProductType", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setProductType", + "tags": [ + "setproducttype", + "facebookproduct.setproducttype" + ], + "title": "FacebookProduct.setProductType" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePrice", + "tags": [ + "setsaleprice", + "facebookproduct.setsaleprice" + ], + "title": "FacebookProduct.setSalePrice" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePriceEffectiveDateEnd", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePriceEffectiveDateEnd", + "tags": [ + "setsalepriceeffectivedateend", + "facebookproduct.setsalepriceeffectivedateend" + ], + "title": "FacebookProduct.setSalePriceEffectiveDateEnd" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePriceEffectiveDateStart", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePriceEffectiveDateStart", + "tags": [ + "setsalepriceeffectivedatestart", + "facebookproduct.setsalepriceeffectivedatestart" + ], + "title": "FacebookProduct.setSalePriceEffectiveDateStart" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingHeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingHeight", + "tags": [ + "setshippingheight", + "facebookproduct.setshippingheight" + ], + "title": "FacebookProduct.setShippingHeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingLength", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingLength", + "tags": [ + "setshippinglength", + "facebookproduct.setshippinglength" + ], + "title": "FacebookProduct.setShippingLength" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingSizeUnit", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingSizeUnit", + "tags": [ + "setshippingsizeunit", + "facebookproduct.setshippingsizeunit" + ], + "title": "FacebookProduct.setShippingSizeUnit" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingWeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingWeight", + "tags": [ + "setshippingweight", + "facebookproduct.setshippingweight" + ], + "title": "FacebookProduct.setShippingWeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingWidth", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingWidth", + "tags": [ + "setshippingwidth", + "facebookproduct.setshippingwidth" + ], + "title": "FacebookProduct.setShippingWidth" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSize", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSize", + "tags": [ + "setsize", + "facebookproduct.setsize" + ], + "title": "FacebookProduct.setSize" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#setTitle", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setTitle", + "tags": [ + "settitle", + "facebookproduct.settitle" + ], + "title": "FacebookProduct.setTitle" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingHeight", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingHeight", + "tags": [ + "shippingheight", + "facebookproduct.shippingheight" + ], + "title": "FacebookProduct.shippingHeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingLength", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingLength", + "tags": [ + "shippinglength", + "facebookproduct.shippinglength" + ], + "title": "FacebookProduct.shippingLength" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingSizeUnit", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingSizeUnit", + "tags": [ + "shippingsizeunit", + "facebookproduct.shippingsizeunit" + ], + "title": "FacebookProduct.shippingSizeUnit" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingWeight", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingWeight", + "tags": [ + "shippingweight", + "facebookproduct.shippingweight" + ], + "title": "FacebookProduct.shippingWeight" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingWidth", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingWidth", + "tags": [ + "shippingwidth", + "facebookproduct.shippingwidth" + ], + "title": "FacebookProduct.shippingWidth" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#size", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.size", + "tags": [ + "size", + "facebookproduct.size" + ], + "title": "FacebookProduct.size" + }, + { + "id": "script-api:dw/extensions/facebook/FacebookProduct#title", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.title", + "tags": [ + "title", + "facebookproduct.title" + ], + "title": "FacebookProduct.title" + }, + { + "id": "script-api:dw/extensions/paymentapi", + "kind": "package", + "packagePath": "dw/extensions/paymentapi", + "qualifiedName": "dw.extensions.paymentapi", + "tags": [ + "dw/extensions/paymentapi", + "dw.extensions.paymentapi" + ], + "title": "dw.extensions.paymentapi" + }, + { + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "kind": "interface", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks", + "tags": [ + "paymentapihooks", + "dw.extensions.paymentapi.paymentapihooks", + "dw/extensions/paymentapi" + ], + "title": "PaymentApiHooks" + }, + { + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#afterAuthorization", + "kind": "method", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.afterAuthorization", + "tags": [ + "afterauthorization", + "paymentapihooks.afterauthorization" + ], + "title": "PaymentApiHooks.afterAuthorization" + }, + { + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#beforeAuthorization", + "kind": "method", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.beforeAuthorization", + "tags": [ + "beforeauthorization", + "paymentapihooks.beforeauthorization" + ], + "title": "PaymentApiHooks.beforeAuthorization" + }, + { + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#extensionPointAfterAuthorization", + "kind": "property", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.extensionPointAfterAuthorization", + "tags": [ + "extensionpointafterauthorization", + "paymentapihooks.extensionpointafterauthorization" + ], + "title": "PaymentApiHooks.extensionPointAfterAuthorization" + }, + { + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#extensionPointBeforeAuthorization", + "kind": "property", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.extensionPointBeforeAuthorization", + "tags": [ + "extensionpointbeforeauthorization", + "paymentapihooks.extensionpointbeforeauthorization" + ], + "title": "PaymentApiHooks.extensionPointBeforeAuthorization" + }, + { + "id": "script-api:dw/extensions/paymentrequest", + "kind": "package", + "packagePath": "dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest", + "tags": [ + "dw/extensions/paymentrequest", + "dw.extensions.paymentrequest" + ], + "title": "dw.extensions.paymentrequest" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "kind": "class", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult", + "tags": [ + "paymentrequesthookresult", + "dw.extensions.paymentrequest.paymentrequesthookresult", + "dw/extensions/paymentrequest" + ], + "title": "PaymentRequestHookResult" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#eventDetail", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.eventDetail", + "tags": [ + "eventdetail", + "paymentrequesthookresult.eventdetail" + ], + "title": "PaymentRequestHookResult.eventDetail" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#eventName", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.eventName", + "tags": [ + "eventname", + "paymentrequesthookresult.eventname" + ], + "title": "PaymentRequestHookResult.eventName" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getEventDetail", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getEventDetail", + "tags": [ + "geteventdetail", + "paymentrequesthookresult.geteventdetail" + ], + "title": "PaymentRequestHookResult.getEventDetail" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getEventName", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getEventName", + "tags": [ + "geteventname", + "paymentrequesthookresult.geteventname" + ], + "title": "PaymentRequestHookResult.getEventName" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getRedirect", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getRedirect", + "tags": [ + "getredirect", + "paymentrequesthookresult.getredirect" + ], + "title": "PaymentRequestHookResult.getRedirect" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getStatus", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getStatus", + "tags": [ + "getstatus", + "paymentrequesthookresult.getstatus" + ], + "title": "PaymentRequestHookResult.getStatus" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#redirect", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.redirect", + "tags": [ + "redirect", + "paymentrequesthookresult.redirect" + ], + "title": "PaymentRequestHookResult.redirect" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.setEvent", + "tags": [ + "setevent", + "paymentrequesthookresult.setevent" + ], + "title": "PaymentRequestHookResult.setEvent" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.setEvent", + "tags": [ + "setevent", + "paymentrequesthookresult.setevent" + ], + "title": "PaymentRequestHookResult.setEvent" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#status", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.status", + "tags": [ + "status", + "paymentrequesthookresult.status" + ], + "title": "PaymentRequestHookResult.status" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "kind": "interface", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks", + "tags": [ + "paymentrequesthooks", + "dw.extensions.paymentrequest.paymentrequesthooks", + "dw/extensions/paymentrequest" + ], + "title": "PaymentRequestHooks" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#abort", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.abort", + "tags": [ + "abort", + "paymentrequesthooks.abort" + ], + "title": "PaymentRequestHooks.abort" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#authorizeOrderPayment", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.authorizeOrderPayment", + "tags": [ + "authorizeorderpayment", + "paymentrequesthooks.authorizeorderpayment" + ], + "title": "PaymentRequestHooks.authorizeOrderPayment" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointAbort", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointAbort", + "tags": [ + "extensionpointabort", + "paymentrequesthooks.extensionpointabort" + ], + "title": "PaymentRequestHooks.extensionPointAbort" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointGetPaymentRequest", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointGetPaymentRequest", + "tags": [ + "extensionpointgetpaymentrequest", + "paymentrequesthooks.extensionpointgetpaymentrequest" + ], + "title": "PaymentRequestHooks.extensionPointGetPaymentRequest" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointPaymentAcceptedAuthorizeOrderPayment", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointPaymentAcceptedAuthorizeOrderPayment", + "tags": [ + "extensionpointpaymentacceptedauthorizeorderpayment", + "paymentrequesthooks.extensionpointpaymentacceptedauthorizeorderpayment" + ], + "title": "PaymentRequestHooks.extensionPointPaymentAcceptedAuthorizeOrderPayment" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointPaymentAcceptedPlaceOrder", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointPaymentAcceptedPlaceOrder", + "tags": [ + "extensionpointpaymentacceptedplaceorder", + "paymentrequesthooks.extensionpointpaymentacceptedplaceorder" + ], + "title": "PaymentRequestHooks.extensionPointPaymentAcceptedPlaceOrder" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointShippingAddressChange", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointShippingAddressChange", + "tags": [ + "extensionpointshippingaddresschange", + "paymentrequesthooks.extensionpointshippingaddresschange" + ], + "title": "PaymentRequestHooks.extensionPointShippingAddressChange" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointShippingOptionChange", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointShippingOptionChange", + "tags": [ + "extensionpointshippingoptionchange", + "paymentrequesthooks.extensionpointshippingoptionchange" + ], + "title": "PaymentRequestHooks.extensionPointShippingOptionChange" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#getPaymentRequest", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.getPaymentRequest", + "tags": [ + "getpaymentrequest", + "paymentrequesthooks.getpaymentrequest" + ], + "title": "PaymentRequestHooks.getPaymentRequest" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#placeOrder", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.placeOrder", + "tags": [ + "placeorder", + "paymentrequesthooks.placeorder" + ], + "title": "PaymentRequestHooks.placeOrder" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#shippingAddressChange", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.shippingAddressChange", + "tags": [ + "shippingaddresschange", + "paymentrequesthooks.shippingaddresschange" + ], + "title": "PaymentRequestHooks.shippingAddressChange" + }, + { + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#shippingOptionChange", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.shippingOptionChange", + "tags": [ + "shippingoptionchange", + "paymentrequesthooks.shippingoptionchange" + ], + "title": "PaymentRequestHooks.shippingOptionChange" + }, + { + "id": "script-api:dw/extensions/payments", + "kind": "package", + "packagePath": "dw/extensions/payments", + "qualifiedName": "dw.extensions.payments", + "tags": [ + "dw/extensions/payments", + "dw.extensions.payments" + ], + "title": "dw.extensions.payments" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent", + "tags": [ + "salesforceadyenpaymentintent", + "dw.extensions.payments.salesforceadyenpaymentintent", + "dw/extensions/payments" + ], + "title": "SalesforceAdyenPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.ID", + "tags": [ + "id", + "salesforceadyenpaymentintent.id" + ], + "title": "SalesforceAdyenPaymentIntent.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#action", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.action", + "tags": [ + "action", + "salesforceadyenpaymentintent.action" + ], + "title": "SalesforceAdyenPaymentIntent.action" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getAction", + "tags": [ + "getaction", + "salesforceadyenpaymentintent.getaction" + ], + "title": "SalesforceAdyenPaymentIntent.getAction" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getID", + "tags": [ + "getid", + "salesforceadyenpaymentintent.getid" + ], + "title": "SalesforceAdyenPaymentIntent.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforceadyenpaymentintent.getpaymentinstrument" + ], + "title": "SalesforceAdyenPaymentIntent.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforceadyenpaymentintent.getpaymentinstrument" + ], + "title": "SalesforceAdyenPaymentIntent.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getResultCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getResultCode", + "tags": [ + "getresultcode", + "salesforceadyenpaymentintent.getresultcode" + ], + "title": "SalesforceAdyenPaymentIntent.getResultCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#hasAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.hasAction", + "tags": [ + "hasaction", + "salesforceadyenpaymentintent.hasaction" + ], + "title": "SalesforceAdyenPaymentIntent.hasAction" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#resultCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.resultCode", + "tags": [ + "resultcode", + "salesforceadyenpaymentintent.resultcode" + ], + "title": "SalesforceAdyenPaymentIntent.resultCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod", + "tags": [ + "salesforceadyensavedpaymentmethod", + "dw.extensions.payments.salesforceadyensavedpaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforceAdyenSavedPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.ID", + "tags": [ + "id", + "salesforceadyensavedpaymentmethod.id" + ], + "title": "SalesforceAdyenSavedPaymentMethod.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT", + "tags": [ + "type_bancontact", + "salesforceadyensavedpaymentmethod.type_bancontact" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT", + "tags": [ + "type_bancontact", + "salesforceadyensavedpaymentmethod.type_bancontact" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_CARD", + "tags": [ + "type_card", + "salesforceadyensavedpaymentmethod.type_card" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_CARD", + "tags": [ + "type_card", + "salesforceadyensavedpaymentmethod.type_card" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL", + "tags": [ + "type_ideal", + "salesforceadyensavedpaymentmethod.type_ideal" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL", + "tags": [ + "type_ideal", + "salesforceadyensavedpaymentmethod.type_ideal" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT", + "tags": [ + "type_sepa_debit", + "salesforceadyensavedpaymentmethod.type_sepa_debit" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT", + "tags": [ + "type_sepa_debit", + "salesforceadyensavedpaymentmethod.type_sepa_debit" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.brand", + "tags": [ + "brand", + "salesforceadyensavedpaymentmethod.brand" + ], + "title": "SalesforceAdyenSavedPaymentMethod.brand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#expiryMonth", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.expiryMonth", + "tags": [ + "expirymonth", + "salesforceadyensavedpaymentmethod.expirymonth" + ], + "title": "SalesforceAdyenSavedPaymentMethod.expiryMonth" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#expiryYear", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.expiryYear", + "tags": [ + "expiryyear", + "salesforceadyensavedpaymentmethod.expiryyear" + ], + "title": "SalesforceAdyenSavedPaymentMethod.expiryYear" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getBrand", + "tags": [ + "getbrand", + "salesforceadyensavedpaymentmethod.getbrand" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getBrand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getExpiryMonth", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getExpiryMonth", + "tags": [ + "getexpirymonth", + "salesforceadyensavedpaymentmethod.getexpirymonth" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getExpiryMonth" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getExpiryYear", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getExpiryYear", + "tags": [ + "getexpiryyear", + "salesforceadyensavedpaymentmethod.getexpiryyear" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getExpiryYear" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getHolderName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getHolderName", + "tags": [ + "getholdername", + "salesforceadyensavedpaymentmethod.getholdername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getHolderName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getID", + "tags": [ + "getid", + "salesforceadyensavedpaymentmethod.getid" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getLast4", + "tags": [ + "getlast4", + "salesforceadyensavedpaymentmethod.getlast4" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getLast4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getOwnerName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getOwnerName", + "tags": [ + "getownername", + "salesforceadyensavedpaymentmethod.getownername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getOwnerName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getType", + "tags": [ + "gettype", + "salesforceadyensavedpaymentmethod.gettype" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#holderName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.holderName", + "tags": [ + "holdername", + "salesforceadyensavedpaymentmethod.holdername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.holderName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.last4", + "tags": [ + "last4", + "salesforceadyensavedpaymentmethod.last4" + ], + "title": "SalesforceAdyenSavedPaymentMethod.last4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#ownerName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.ownerName", + "tags": [ + "ownername", + "salesforceadyensavedpaymentmethod.ownername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.ownerName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.type", + "tags": [ + "type", + "salesforceadyensavedpaymentmethod.type" + ], + "title": "SalesforceAdyenSavedPaymentMethod.type" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails", + "tags": [ + "salesforcebancontactpaymentdetails", + "dw.extensions.payments.salesforcebancontactpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceBancontactPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#bankName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.bankName", + "tags": [ + "bankname", + "salesforcebancontactpaymentdetails.bankname" + ], + "title": "SalesforceBancontactPaymentDetails.bankName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#getBankName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.getBankName", + "tags": [ + "getbankname", + "salesforcebancontactpaymentdetails.getbankname" + ], + "title": "SalesforceBancontactPaymentDetails.getBankName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.getLast4", + "tags": [ + "getlast4", + "salesforcebancontactpaymentdetails.getlast4" + ], + "title": "SalesforceBancontactPaymentDetails.getLast4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.last4", + "tags": [ + "last4", + "salesforcebancontactpaymentdetails.last4" + ], + "title": "SalesforceBancontactPaymentDetails.last4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails", + "tags": [ + "salesforcecardpaymentdetails", + "dw.extensions.payments.salesforcecardpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceCardPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.brand", + "tags": [ + "brand", + "salesforcecardpaymentdetails.brand" + ], + "title": "SalesforceCardPaymentDetails.brand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getBrand", + "tags": [ + "getbrand", + "salesforcecardpaymentdetails.getbrand" + ], + "title": "SalesforceCardPaymentDetails.getBrand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getLast4", + "tags": [ + "getlast4", + "salesforcecardpaymentdetails.getlast4" + ], + "title": "SalesforceCardPaymentDetails.getLast4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getWalletType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getWalletType", + "tags": [ + "getwallettype", + "salesforcecardpaymentdetails.getwallettype" + ], + "title": "SalesforceCardPaymentDetails.getWalletType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.last4", + "tags": [ + "last4", + "salesforcecardpaymentdetails.last4" + ], + "title": "SalesforceCardPaymentDetails.last4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#walletType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.walletType", + "tags": [ + "wallettype", + "salesforcecardpaymentdetails.wallettype" + ], + "title": "SalesforceCardPaymentDetails.walletType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails", + "tags": [ + "salesforceepspaymentdetails", + "dw.extensions.payments.salesforceepspaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceEpsPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails.bank", + "tags": [ + "bank", + "salesforceepspaymentdetails.bank" + ], + "title": "SalesforceEpsPaymentDetails.bank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails.getBank", + "tags": [ + "getbank", + "salesforceepspaymentdetails.getbank" + ], + "title": "SalesforceEpsPaymentDetails.getBank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails", + "tags": [ + "salesforceidealpaymentdetails", + "dw.extensions.payments.salesforceidealpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceIdealPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails.bank", + "tags": [ + "bank", + "salesforceidealpaymentdetails.bank" + ], + "title": "SalesforceIdealPaymentDetails.bank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails.getBank", + "tags": [ + "getbank", + "salesforceidealpaymentdetails.getbank" + ], + "title": "SalesforceIdealPaymentDetails.getBank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails", + "tags": [ + "salesforceklarnapaymentdetails", + "dw.extensions.payments.salesforceklarnapaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceKlarnaPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails#getPaymentMethodCategory", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails.getPaymentMethodCategory", + "tags": [ + "getpaymentmethodcategory", + "salesforceklarnapaymentdetails.getpaymentmethodcategory" + ], + "title": "SalesforceKlarnaPaymentDetails.getPaymentMethodCategory" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails#paymentMethodCategory", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails.paymentMethodCategory", + "tags": [ + "paymentmethodcategory", + "salesforceklarnapaymentdetails.paymentmethodcategory" + ], + "title": "SalesforceKlarnaPaymentDetails.paymentMethodCategory" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder", + "tags": [ + "salesforcepaypalorder", + "dw.extensions.payments.salesforcepaypalorder", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.ID", + "tags": [ + "id", + "salesforcepaypalorder.id" + ], + "title": "SalesforcePayPalOrder.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_AUTHORIZE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_AUTHORIZE", + "tags": [ + "intent_authorize", + "salesforcepaypalorder.intent_authorize" + ], + "title": "SalesforcePayPalOrder.INTENT_AUTHORIZE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_AUTHORIZE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_AUTHORIZE", + "tags": [ + "intent_authorize", + "salesforcepaypalorder.intent_authorize" + ], + "title": "SalesforcePayPalOrder.INTENT_AUTHORIZE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_CAPTURE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_CAPTURE", + "tags": [ + "intent_capture", + "salesforcepaypalorder.intent_capture" + ], + "title": "SalesforcePayPalOrder.INTENT_CAPTURE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_CAPTURE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_CAPTURE", + "tags": [ + "intent_capture", + "salesforcepaypalorder.intent_capture" + ], + "title": "SalesforcePayPalOrder.INTENT_CAPTURE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_PAYPAL", + "tags": [ + "type_paypal", + "salesforcepaypalorder.type_paypal" + ], + "title": "SalesforcePayPalOrder.TYPE_PAYPAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_PAYPAL", + "tags": [ + "type_paypal", + "salesforcepaypalorder.type_paypal" + ], + "title": "SalesforcePayPalOrder.TYPE_PAYPAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_VENMO", + "tags": [ + "type_venmo", + "salesforcepaypalorder.type_venmo" + ], + "title": "SalesforcePayPalOrder.TYPE_VENMO" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_VENMO", + "tags": [ + "type_venmo", + "salesforcepaypalorder.type_venmo" + ], + "title": "SalesforcePayPalOrder.TYPE_VENMO" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#amount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.amount", + "tags": [ + "amount", + "salesforcepaypalorder.amount" + ], + "title": "SalesforcePayPalOrder.amount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#authorizationID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.authorizationID", + "tags": [ + "authorizationid", + "salesforcepaypalorder.authorizationid" + ], + "title": "SalesforcePayPalOrder.authorizationID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.captureID", + "tags": [ + "captureid", + "salesforcepaypalorder.captureid" + ], + "title": "SalesforcePayPalOrder.captureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#completed", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.completed", + "tags": [ + "completed", + "salesforcepaypalorder.completed" + ], + "title": "SalesforcePayPalOrder.completed" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getAmount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getAmount", + "tags": [ + "getamount", + "salesforcepaypalorder.getamount" + ], + "title": "SalesforcePayPalOrder.getAmount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getAuthorizationID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getAuthorizationID", + "tags": [ + "getauthorizationid", + "salesforcepaypalorder.getauthorizationid" + ], + "title": "SalesforcePayPalOrder.getAuthorizationID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getCaptureID", + "tags": [ + "getcaptureid", + "salesforcepaypalorder.getcaptureid" + ], + "title": "SalesforcePayPalOrder.getCaptureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getID", + "tags": [ + "getid", + "salesforcepaypalorder.getid" + ], + "title": "SalesforcePayPalOrder.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPayer", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPayer", + "tags": [ + "getpayer", + "salesforcepaypalorder.getpayer" + ], + "title": "SalesforcePayPalOrder.getPayer" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentDetails", + "tags": [ + "getpaymentdetails", + "salesforcepaypalorder.getpaymentdetails" + ], + "title": "SalesforcePayPalOrder.getPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforcepaypalorder.getpaymentinstrument" + ], + "title": "SalesforcePayPalOrder.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforcepaypalorder.getpaymentinstrument" + ], + "title": "SalesforcePayPalOrder.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getShipping", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getShipping", + "tags": [ + "getshipping", + "salesforcepaypalorder.getshipping" + ], + "title": "SalesforcePayPalOrder.getShipping" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#isCompleted", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.isCompleted", + "tags": [ + "iscompleted", + "salesforcepaypalorder.iscompleted" + ], + "title": "SalesforcePayPalOrder.isCompleted" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#payer", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.payer", + "tags": [ + "payer", + "salesforcepaypalorder.payer" + ], + "title": "SalesforcePayPalOrder.payer" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#shipping", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.shipping", + "tags": [ + "shipping", + "salesforcepaypalorder.shipping" + ], + "title": "SalesforcePayPalOrder.shipping" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress", + "tags": [ + "salesforcepaypalorderaddress", + "dw.extensions.payments.salesforcepaypalorderaddress", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrderAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#addressLine1", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.addressLine1", + "tags": [ + "addressline1", + "salesforcepaypalorderaddress.addressline1" + ], + "title": "SalesforcePayPalOrderAddress.addressLine1" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#addressLine2", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.addressLine2", + "tags": [ + "addressline2", + "salesforcepaypalorderaddress.addressline2" + ], + "title": "SalesforcePayPalOrderAddress.addressLine2" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#adminArea1", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.adminArea1", + "tags": [ + "adminarea1", + "salesforcepaypalorderaddress.adminarea1" + ], + "title": "SalesforcePayPalOrderAddress.adminArea1" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#adminArea2", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.adminArea2", + "tags": [ + "adminarea2", + "salesforcepaypalorderaddress.adminarea2" + ], + "title": "SalesforcePayPalOrderAddress.adminArea2" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#countryCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.countryCode", + "tags": [ + "countrycode", + "salesforcepaypalorderaddress.countrycode" + ], + "title": "SalesforcePayPalOrderAddress.countryCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#fullName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.fullName", + "tags": [ + "fullname", + "salesforcepaypalorderaddress.fullname" + ], + "title": "SalesforcePayPalOrderAddress.fullName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAddressLine1", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAddressLine1", + "tags": [ + "getaddressline1", + "salesforcepaypalorderaddress.getaddressline1" + ], + "title": "SalesforcePayPalOrderAddress.getAddressLine1" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAddressLine2", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAddressLine2", + "tags": [ + "getaddressline2", + "salesforcepaypalorderaddress.getaddressline2" + ], + "title": "SalesforcePayPalOrderAddress.getAddressLine2" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAdminArea1", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAdminArea1", + "tags": [ + "getadminarea1", + "salesforcepaypalorderaddress.getadminarea1" + ], + "title": "SalesforcePayPalOrderAddress.getAdminArea1" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAdminArea2", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAdminArea2", + "tags": [ + "getadminarea2", + "salesforcepaypalorderaddress.getadminarea2" + ], + "title": "SalesforcePayPalOrderAddress.getAdminArea2" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getCountryCode", + "tags": [ + "getcountrycode", + "salesforcepaypalorderaddress.getcountrycode" + ], + "title": "SalesforcePayPalOrderAddress.getCountryCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getFullName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getFullName", + "tags": [ + "getfullname", + "salesforcepaypalorderaddress.getfullname" + ], + "title": "SalesforcePayPalOrderAddress.getFullName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getPostalCode", + "tags": [ + "getpostalcode", + "salesforcepaypalorderaddress.getpostalcode" + ], + "title": "SalesforcePayPalOrderAddress.getPostalCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#postalCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.postalCode", + "tags": [ + "postalcode", + "salesforcepaypalorderaddress.postalcode" + ], + "title": "SalesforcePayPalOrderAddress.postalCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer", + "tags": [ + "salesforcepaypalorderpayer", + "dw.extensions.payments.salesforcepaypalorderpayer", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrderPayer" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#emailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.emailAddress", + "tags": [ + "emailaddress", + "salesforcepaypalorderpayer.emailaddress" + ], + "title": "SalesforcePayPalOrderPayer.emailAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getEmailAddress", + "tags": [ + "getemailaddress", + "salesforcepaypalorderpayer.getemailaddress" + ], + "title": "SalesforcePayPalOrderPayer.getEmailAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getGivenName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getGivenName", + "tags": [ + "getgivenname", + "salesforcepaypalorderpayer.getgivenname" + ], + "title": "SalesforcePayPalOrderPayer.getGivenName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getPhone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getPhone", + "tags": [ + "getphone", + "salesforcepaypalorderpayer.getphone" + ], + "title": "SalesforcePayPalOrderPayer.getPhone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getSurname", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getSurname", + "tags": [ + "getsurname", + "salesforcepaypalorderpayer.getsurname" + ], + "title": "SalesforcePayPalOrderPayer.getSurname" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#givenName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.givenName", + "tags": [ + "givenname", + "salesforcepaypalorderpayer.givenname" + ], + "title": "SalesforcePayPalOrderPayer.givenName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#phone", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.phone", + "tags": [ + "phone", + "salesforcepaypalorderpayer.phone" + ], + "title": "SalesforcePayPalOrderPayer.phone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#surname", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.surname", + "tags": [ + "surname", + "salesforcepaypalorderpayer.surname" + ], + "title": "SalesforcePayPalOrderPayer.surname" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails", + "tags": [ + "salesforcepaypalpaymentdetails", + "dw.extensions.payments.salesforcepaypalpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.captureID", + "tags": [ + "captureid", + "salesforcepaypalpaymentdetails.captureid" + ], + "title": "SalesforcePayPalPaymentDetails.captureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.getCaptureID", + "tags": [ + "getcaptureid", + "salesforcepaypalpaymentdetails.getcaptureid" + ], + "title": "SalesforcePayPalPaymentDetails.getCaptureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#getPayerEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.getPayerEmailAddress", + "tags": [ + "getpayeremailaddress", + "salesforcepaypalpaymentdetails.getpayeremailaddress" + ], + "title": "SalesforcePayPalPaymentDetails.getPayerEmailAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#payerEmailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.payerEmailAddress", + "tags": [ + "payeremailaddress", + "salesforcepaypalpaymentdetails.payeremailaddress" + ], + "title": "SalesforcePayPalPaymentDetails.payerEmailAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails", + "tags": [ + "salesforcepaymentdetails", + "dw.extensions.payments.salesforcepaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails.getType", + "tags": [ + "gettype", + "salesforcepaymentdetails.gettype" + ], + "title": "SalesforcePaymentDetails.getType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails.type", + "tags": [ + "type", + "salesforcepaymentdetails.type" + ], + "title": "SalesforcePaymentDetails.type" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent", + "tags": [ + "salesforcepaymentintent", + "dw.extensions.payments.salesforcepaymentintent", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.ID", + "tags": [ + "id", + "salesforcepaymentintent.id" + ], + "title": "SalesforcePaymentIntent.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_OFF_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION", + "tags": [ + "setup_future_usage_off_session", + "salesforcepaymentintent.setup_future_usage_off_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_OFF_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION", + "tags": [ + "setup_future_usage_off_session", + "salesforcepaymentintent.setup_future_usage_off_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_ON_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION", + "tags": [ + "setup_future_usage_on_session", + "salesforcepaymentintent.setup_future_usage_on_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_ON_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION", + "tags": [ + "setup_future_usage_on_session", + "salesforcepaymentintent.setup_future_usage_on_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#amount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.amount", + "tags": [ + "amount", + "salesforcepaymentintent.amount" + ], + "title": "SalesforcePaymentIntent.amount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#cancelable", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.cancelable", + "tags": [ + "cancelable", + "salesforcepaymentintent.cancelable" + ], + "title": "SalesforcePaymentIntent.cancelable" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#clientSecret", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.clientSecret", + "tags": [ + "clientsecret", + "salesforcepaymentintent.clientsecret" + ], + "title": "SalesforcePaymentIntent.clientSecret" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#confirmed", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.confirmed", + "tags": [ + "confirmed", + "salesforcepaymentintent.confirmed" + ], + "title": "SalesforcePaymentIntent.confirmed" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getAmount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getAmount", + "tags": [ + "getamount", + "salesforcepaymentintent.getamount" + ], + "title": "SalesforcePaymentIntent.getAmount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getClientSecret", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getClientSecret", + "tags": [ + "getclientsecret", + "salesforcepaymentintent.getclientsecret" + ], + "title": "SalesforcePaymentIntent.getClientSecret" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getID", + "tags": [ + "getid", + "salesforcepaymentintent.getid" + ], + "title": "SalesforcePaymentIntent.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforcepaymentintent.getpaymentinstrument" + ], + "title": "SalesforcePaymentIntent.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "salesforcepaymentintent.getpaymentinstrument" + ], + "title": "SalesforcePaymentIntent.getPaymentInstrument" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentMethod", + "tags": [ + "getpaymentmethod", + "salesforcepaymentintent.getpaymentmethod" + ], + "title": "SalesforcePaymentIntent.getPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getSetupFutureUsage", + "tags": [ + "getsetupfutureusage", + "salesforcepaymentintent.getsetupfutureusage" + ], + "title": "SalesforcePaymentIntent.getSetupFutureUsage" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isCancelable", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isCancelable", + "tags": [ + "iscancelable", + "salesforcepaymentintent.iscancelable" + ], + "title": "SalesforcePaymentIntent.isCancelable" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isConfirmed", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isConfirmed", + "tags": [ + "isconfirmed", + "salesforcepaymentintent.isconfirmed" + ], + "title": "SalesforcePaymentIntent.isConfirmed" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isRefundable", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isRefundable", + "tags": [ + "isrefundable", + "salesforcepaymentintent.isrefundable" + ], + "title": "SalesforcePaymentIntent.isRefundable" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#paymentMethod", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.paymentMethod", + "tags": [ + "paymentmethod", + "salesforcepaymentintent.paymentmethod" + ], + "title": "SalesforcePaymentIntent.paymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#refundable", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.refundable", + "tags": [ + "refundable", + "salesforcepaymentintent.refundable" + ], + "title": "SalesforcePaymentIntent.refundable" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#setupFutureUsage", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.setupFutureUsage", + "tags": [ + "setupfutureusage", + "salesforcepaymentintent.setupfutureusage" + ], + "title": "SalesforcePaymentIntent.setupFutureUsage" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod", + "tags": [ + "salesforcepaymentmethod", + "dw.extensions.payments.salesforcepaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.ID", + "tags": [ + "id", + "salesforcepaymentmethod.id" + ], + "title": "SalesforcePaymentMethod.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY", + "tags": [ + "type_afterpay_clearpay", + "salesforcepaymentmethod.type_afterpay_clearpay" + ], + "title": "SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY", + "tags": [ + "type_afterpay_clearpay", + "salesforcepaymentmethod.type_afterpay_clearpay" + ], + "title": "SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_BANCONTACT", + "tags": [ + "type_bancontact", + "salesforcepaymentmethod.type_bancontact" + ], + "title": "SalesforcePaymentMethod.TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_BANCONTACT", + "tags": [ + "type_bancontact", + "salesforcepaymentmethod.type_bancontact" + ], + "title": "SalesforcePaymentMethod.TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_CARD", + "tags": [ + "type_card", + "salesforcepaymentmethod.type_card" + ], + "title": "SalesforcePaymentMethod.TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_CARD", + "tags": [ + "type_card", + "salesforcepaymentmethod.type_card" + ], + "title": "SalesforcePaymentMethod.TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_EPS", + "tags": [ + "type_eps", + "salesforcepaymentmethod.type_eps" + ], + "title": "SalesforcePaymentMethod.TYPE_EPS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_EPS", + "tags": [ + "type_eps", + "salesforcepaymentmethod.type_eps" + ], + "title": "SalesforcePaymentMethod.TYPE_EPS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_IDEAL", + "tags": [ + "type_ideal", + "salesforcepaymentmethod.type_ideal" + ], + "title": "SalesforcePaymentMethod.TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_IDEAL", + "tags": [ + "type_ideal", + "salesforcepaymentmethod.type_ideal" + ], + "title": "SalesforcePaymentMethod.TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_KLARNA", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_KLARNA", + "tags": [ + "type_klarna", + "salesforcepaymentmethod.type_klarna" + ], + "title": "SalesforcePaymentMethod.TYPE_KLARNA" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_KLARNA", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_KLARNA", + "tags": [ + "type_klarna", + "salesforcepaymentmethod.type_klarna" + ], + "title": "SalesforcePaymentMethod.TYPE_KLARNA" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_SEPA_DEBIT", + "tags": [ + "type_sepa_debit", + "salesforcepaymentmethod.type_sepa_debit" + ], + "title": "SalesforcePaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_SEPA_DEBIT", + "tags": [ + "type_sepa_debit", + "salesforcepaymentmethod.type_sepa_debit" + ], + "title": "SalesforcePaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bank", + "tags": [ + "bank", + "salesforcepaymentmethod.bank" + ], + "title": "SalesforcePaymentMethod.bank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bankCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bankCode", + "tags": [ + "bankcode", + "salesforcepaymentmethod.bankcode" + ], + "title": "SalesforcePaymentMethod.bankCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bankName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bankName", + "tags": [ + "bankname", + "salesforcepaymentmethod.bankname" + ], + "title": "SalesforcePaymentMethod.bankName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#branchCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.branchCode", + "tags": [ + "branchcode", + "salesforcepaymentmethod.branchcode" + ], + "title": "SalesforcePaymentMethod.branchCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.brand", + "tags": [ + "brand", + "salesforcepaymentmethod.brand" + ], + "title": "SalesforcePaymentMethod.brand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#country", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.country", + "tags": [ + "country", + "salesforcepaymentmethod.country" + ], + "title": "SalesforcePaymentMethod.country" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBank", + "tags": [ + "getbank", + "salesforcepaymentmethod.getbank" + ], + "title": "SalesforcePaymentMethod.getBank" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBankCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBankCode", + "tags": [ + "getbankcode", + "salesforcepaymentmethod.getbankcode" + ], + "title": "SalesforcePaymentMethod.getBankCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBankName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBankName", + "tags": [ + "getbankname", + "salesforcepaymentmethod.getbankname" + ], + "title": "SalesforcePaymentMethod.getBankName" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBranchCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBranchCode", + "tags": [ + "getbranchcode", + "salesforcepaymentmethod.getbranchcode" + ], + "title": "SalesforcePaymentMethod.getBranchCode" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBrand", + "tags": [ + "getbrand", + "salesforcepaymentmethod.getbrand" + ], + "title": "SalesforcePaymentMethod.getBrand" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getCountry", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getCountry", + "tags": [ + "getcountry", + "salesforcepaymentmethod.getcountry" + ], + "title": "SalesforcePaymentMethod.getCountry" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getID", + "tags": [ + "getid", + "salesforcepaymentmethod.getid" + ], + "title": "SalesforcePaymentMethod.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getLast4", + "tags": [ + "getlast4", + "salesforcepaymentmethod.getlast4" + ], + "title": "SalesforcePaymentMethod.getLast4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getPaymentDetails", + "tags": [ + "getpaymentdetails", + "salesforcepaymentmethod.getpaymentdetails" + ], + "title": "SalesforcePaymentMethod.getPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getPaymentMethodCategory", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getPaymentMethodCategory", + "tags": [ + "getpaymentmethodcategory", + "salesforcepaymentmethod.getpaymentmethodcategory" + ], + "title": "SalesforcePaymentMethod.getPaymentMethodCategory" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getType", + "tags": [ + "gettype", + "salesforcepaymentmethod.gettype" + ], + "title": "SalesforcePaymentMethod.getType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.last4", + "tags": [ + "last4", + "salesforcepaymentmethod.last4" + ], + "title": "SalesforcePaymentMethod.last4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#paymentMethodCategory", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.paymentMethodCategory", + "tags": [ + "paymentmethodcategory", + "salesforcepaymentmethod.paymentmethodcategory" + ], + "title": "SalesforcePaymentMethod.paymentMethodCategory" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.type", + "tags": [ + "type", + "salesforcepaymentmethod.type" + ], + "title": "SalesforcePaymentMethod.type" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest", + "tags": [ + "salesforcepaymentrequest", + "dw.extensions.payments.salesforcepaymentrequest", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentRequest" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "tags": [ + "element_afterpay_clearpay_message", + "salesforcepaymentrequest.element_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "tags": [ + "element_afterpay_clearpay_message", + "salesforcepaymentrequest.element_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_CVC", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_CVC", + "tags": [ + "element_card_cvc", + "salesforcepaymentrequest.element_card_cvc" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_CVC" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_CVC", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_CVC", + "tags": [ + "element_card_cvc", + "salesforcepaymentrequest.element_card_cvc" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_CVC" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_EXPIRY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY", + "tags": [ + "element_card_expiry", + "salesforcepaymentrequest.element_card_expiry" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_EXPIRY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY", + "tags": [ + "element_card_expiry", + "salesforcepaymentrequest.element_card_expiry" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_NUMBER", + "tags": [ + "element_card_number", + "salesforcepaymentrequest.element_card_number" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_NUMBER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_NUMBER", + "tags": [ + "element_card_number", + "salesforcepaymentrequest.element_card_number" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_NUMBER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_EPS_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_EPS_BANK", + "tags": [ + "element_eps_bank", + "salesforcepaymentrequest.element_eps_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_EPS_BANK" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_EPS_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_EPS_BANK", + "tags": [ + "element_eps_bank", + "salesforcepaymentrequest.element_eps_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_EPS_BANK" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IBAN", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IBAN", + "tags": [ + "element_iban", + "salesforcepaymentrequest.element_iban" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IBAN" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IBAN", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IBAN", + "tags": [ + "element_iban", + "salesforcepaymentrequest.element_iban" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IBAN" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IDEAL_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IDEAL_BANK", + "tags": [ + "element_ideal_bank", + "salesforcepaymentrequest.element_ideal_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IDEAL_BANK" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IDEAL_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IDEAL_BANK", + "tags": [ + "element_ideal_bank", + "salesforcepaymentrequest.element_ideal_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IDEAL_BANK" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_PAYMENT_REQUEST_BUTTON", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON", + "tags": [ + "element_payment_request_button", + "salesforcepaymentrequest.element_payment_request_button" + ], + "title": "SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_PAYMENT_REQUEST_BUTTON", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON", + "tags": [ + "element_payment_request_button", + "salesforcepaymentrequest.element_payment_request_button" + ], + "title": "SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "tags": [ + "element_type_afterpay_clearpay", + "salesforcepaymentrequest.element_type_afterpay_clearpay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "tags": [ + "element_type_afterpay_clearpay", + "salesforcepaymentrequest.element_type_afterpay_clearpay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "tags": [ + "element_type_afterpay_clearpay_message", + "salesforcepaymentrequest.element_type_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "tags": [ + "element_type_afterpay_clearpay_message", + "salesforcepaymentrequest.element_type_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_APPLEPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY", + "tags": [ + "element_type_applepay", + "salesforcepaymentrequest.element_type_applepay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_APPLEPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY", + "tags": [ + "element_type_applepay", + "salesforcepaymentrequest.element_type_applepay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT", + "tags": [ + "element_type_bancontact", + "salesforcepaymentrequest.element_type_bancontact" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT", + "tags": [ + "element_type_bancontact", + "salesforcepaymentrequest.element_type_bancontact" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_CARD", + "tags": [ + "element_type_card", + "salesforcepaymentrequest.element_type_card" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_CARD", + "tags": [ + "element_type_card", + "salesforcepaymentrequest.element_type_card" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_CARD" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_EPS", + "tags": [ + "element_type_eps", + "salesforcepaymentrequest.element_type_eps" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_EPS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_EPS", + "tags": [ + "element_type_eps", + "salesforcepaymentrequest.element_type_eps" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_EPS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL", + "tags": [ + "element_type_ideal", + "salesforcepaymentrequest.element_type_ideal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL", + "tags": [ + "element_type_ideal", + "salesforcepaymentrequest.element_type_ideal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYMENTREQUEST", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST", + "tags": [ + "element_type_paymentrequest", + "salesforcepaymentrequest.element_type_paymentrequest" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYMENTREQUEST", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST", + "tags": [ + "element_type_paymentrequest", + "salesforcepaymentrequest.element_type_paymentrequest" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL", + "tags": [ + "element_type_paypal", + "salesforcepaymentrequest.element_type_paypal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL", + "tags": [ + "element_type_paypal", + "salesforcepaymentrequest.element_type_paypal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS", + "tags": [ + "element_type_paypal_express", + "salesforcepaymentrequest.element_type_paypal_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS", + "tags": [ + "element_type_paypal_express", + "salesforcepaymentrequest.element_type_paypal_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE", + "tags": [ + "element_type_paypal_message", + "salesforcepaymentrequest.element_type_paypal_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE", + "tags": [ + "element_type_paypal_message", + "salesforcepaymentrequest.element_type_paypal_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT", + "tags": [ + "element_type_sepa_debit", + "salesforcepaymentrequest.element_type_sepa_debit" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT", + "tags": [ + "element_type_sepa_debit", + "salesforcepaymentrequest.element_type_sepa_debit" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO", + "tags": [ + "element_type_venmo", + "salesforcepaymentrequest.element_type_venmo" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO", + "tags": [ + "element_type_venmo", + "salesforcepaymentrequest.element_type_venmo" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS", + "tags": [ + "element_type_venmo_express", + "salesforcepaymentrequest.element_type_venmo_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS", + "tags": [ + "element_type_venmo_express", + "salesforcepaymentrequest.element_type_venmo_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ID", + "tags": [ + "id", + "salesforcepaymentrequest.id" + ], + "title": "SalesforcePaymentRequest.ID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "tags": [ + "paypal_shipping_preference_get_from_file", + "salesforcepaymentrequest.paypal_shipping_preference_get_from_file" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "tags": [ + "paypal_shipping_preference_get_from_file", + "salesforcepaymentrequest.paypal_shipping_preference_get_from_file" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "tags": [ + "paypal_shipping_preference_no_shipping", + "salesforcepaymentrequest.paypal_shipping_preference_no_shipping" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "tags": [ + "paypal_shipping_preference_no_shipping", + "salesforcepaymentrequest.paypal_shipping_preference_no_shipping" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "tags": [ + "paypal_shipping_preference_set_provided_address", + "salesforcepaymentrequest.paypal_shipping_preference_set_provided_address" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "tags": [ + "paypal_shipping_preference_set_provided_address", + "salesforcepaymentrequest.paypal_shipping_preference_set_provided_address" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_CONTINUE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE", + "tags": [ + "paypal_user_action_continue", + "salesforcepaymentrequest.paypal_user_action_continue" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_CONTINUE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE", + "tags": [ + "paypal_user_action_continue", + "salesforcepaymentrequest.paypal_user_action_continue" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_PAY_NOW", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW", + "tags": [ + "paypal_user_action_pay_now", + "salesforcepaymentrequest.paypal_user_action_pay_now" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_PAY_NOW", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW", + "tags": [ + "paypal_user_action_pay_now", + "salesforcepaymentrequest.paypal_user_action_pay_now" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#addExclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.addExclude", + "tags": [ + "addexclude", + "salesforcepaymentrequest.addexclude" + ], + "title": "SalesforcePaymentRequest.addExclude" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#addInclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.addInclude", + "tags": [ + "addinclude", + "salesforcepaymentrequest.addinclude" + ], + "title": "SalesforcePaymentRequest.addInclude" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#basketData", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.basketData", + "tags": [ + "basketdata", + "salesforcepaymentrequest.basketdata" + ], + "title": "SalesforcePaymentRequest.basketData" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#billingDetails", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.billingDetails", + "tags": [ + "billingdetails", + "salesforcepaymentrequest.billingdetails" + ], + "title": "SalesforcePaymentRequest.billingDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#calculatePaymentRequestOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.calculatePaymentRequestOptions", + "tags": [ + "calculatepaymentrequestoptions", + "salesforcepaymentrequest.calculatepaymentrequestoptions" + ], + "title": "SalesforcePaymentRequest.calculatePaymentRequestOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#calculatePaymentRequestOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.calculatePaymentRequestOptions", + "tags": [ + "calculatepaymentrequestoptions", + "salesforcepaymentrequest.calculatepaymentrequestoptions" + ], + "title": "SalesforcePaymentRequest.calculatePaymentRequestOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#cardCaptureAutomatic", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.cardCaptureAutomatic", + "tags": [ + "cardcaptureautomatic", + "salesforcepaymentrequest.cardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.cardCaptureAutomatic" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#exclude", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.exclude", + "tags": [ + "exclude", + "salesforcepaymentrequest.exclude" + ], + "title": "SalesforcePaymentRequest.exclude" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#format", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.format", + "tags": [ + "format", + "salesforcepaymentrequest.format" + ], + "title": "SalesforcePaymentRequest.format" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#format", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.format", + "tags": [ + "format", + "salesforcepaymentrequest.format" + ], + "title": "SalesforcePaymentRequest.format" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getBasketData", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getBasketData", + "tags": [ + "getbasketdata", + "salesforcepaymentrequest.getbasketdata" + ], + "title": "SalesforcePaymentRequest.getBasketData" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getBillingDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getBillingDetails", + "tags": [ + "getbillingdetails", + "salesforcepaymentrequest.getbillingdetails" + ], + "title": "SalesforcePaymentRequest.getBillingDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getCardCaptureAutomatic", + "tags": [ + "getcardcaptureautomatic", + "salesforcepaymentrequest.getcardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.getCardCaptureAutomatic" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getExclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getExclude", + "tags": [ + "getexclude", + "salesforcepaymentrequest.getexclude" + ], + "title": "SalesforcePaymentRequest.getExclude" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getID", + "tags": [ + "getid", + "salesforcepaymentrequest.getid" + ], + "title": "SalesforcePaymentRequest.getID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getInclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getInclude", + "tags": [ + "getinclude", + "salesforcepaymentrequest.getinclude" + ], + "title": "SalesforcePaymentRequest.getInclude" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getSelector", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getSelector", + "tags": [ + "getselector", + "salesforcepaymentrequest.getselector" + ], + "title": "SalesforcePaymentRequest.getSelector" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getSetupFutureUsage", + "tags": [ + "getsetupfutureusage", + "salesforcepaymentrequest.getsetupfutureusage" + ], + "title": "SalesforcePaymentRequest.getSetupFutureUsage" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getStatementDescriptor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getStatementDescriptor", + "tags": [ + "getstatementdescriptor", + "salesforcepaymentrequest.getstatementdescriptor" + ], + "title": "SalesforcePaymentRequest.getStatementDescriptor" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#include", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.include", + "tags": [ + "include", + "salesforcepaymentrequest.include" + ], + "title": "SalesforcePaymentRequest.include" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#selector", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.selector", + "tags": [ + "selector", + "salesforcepaymentrequest.selector" + ], + "title": "SalesforcePaymentRequest.selector" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setBasketData", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setBasketData", + "tags": [ + "setbasketdata", + "salesforcepaymentrequest.setbasketdata" + ], + "title": "SalesforcePaymentRequest.setBasketData" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setBillingDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setBillingDetails", + "tags": [ + "setbillingdetails", + "salesforcepaymentrequest.setbillingdetails" + ], + "title": "SalesforcePaymentRequest.setBillingDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setCardCaptureAutomatic", + "tags": [ + "setcardcaptureautomatic", + "salesforcepaymentrequest.setcardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.setCardCaptureAutomatic" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setOptions", + "tags": [ + "setoptions", + "salesforcepaymentrequest.setoptions" + ], + "title": "SalesforcePaymentRequest.setOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalButtonsOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalButtonsOptions", + "tags": [ + "setpaypalbuttonsoptions", + "salesforcepaymentrequest.setpaypalbuttonsoptions" + ], + "title": "SalesforcePaymentRequest.setPayPalButtonsOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalShippingPreference", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalShippingPreference", + "tags": [ + "setpaypalshippingpreference", + "salesforcepaymentrequest.setpaypalshippingpreference" + ], + "title": "SalesforcePaymentRequest.setPayPalShippingPreference" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalUserAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalUserAction", + "tags": [ + "setpaypaluseraction", + "salesforcepaymentrequest.setpaypaluseraction" + ], + "title": "SalesforcePaymentRequest.setPayPalUserAction" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setReturnController", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setReturnController", + "tags": [ + "setreturncontroller", + "salesforcepaymentrequest.setreturncontroller" + ], + "title": "SalesforcePaymentRequest.setReturnController" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setSavePaymentMethodEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setSavePaymentMethodEnabled", + "tags": [ + "setsavepaymentmethodenabled", + "salesforcepaymentrequest.setsavepaymentmethodenabled" + ], + "title": "SalesforcePaymentRequest.setSavePaymentMethodEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setSetupFutureUsage", + "tags": [ + "setsetupfutureusage", + "salesforcepaymentrequest.setsetupfutureusage" + ], + "title": "SalesforcePaymentRequest.setSetupFutureUsage" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStatementDescriptor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStatementDescriptor", + "tags": [ + "setstatementdescriptor", + "salesforcepaymentrequest.setstatementdescriptor" + ], + "title": "SalesforcePaymentRequest.setStatementDescriptor" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStripeCreateElementOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStripeCreateElementOptions", + "tags": [ + "setstripecreateelementoptions", + "salesforcepaymentrequest.setstripecreateelementoptions" + ], + "title": "SalesforcePaymentRequest.setStripeCreateElementOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStripeElementsOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStripeElementsOptions", + "tags": [ + "setstripeelementsoptions", + "salesforcepaymentrequest.setstripeelementsoptions" + ], + "title": "SalesforcePaymentRequest.setStripeElementsOptions" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setupFutureUsage", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setupFutureUsage", + "tags": [ + "setupfutureusage", + "salesforcepaymentrequest.setupfutureusage" + ], + "title": "SalesforcePaymentRequest.setupFutureUsage" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#statementDescriptor", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.statementDescriptor", + "tags": [ + "statementdescriptor", + "salesforcepaymentrequest.statementdescriptor" + ], + "title": "SalesforcePaymentRequest.statementDescriptor" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "kind": "interface", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks", + "tags": [ + "salesforcepaymentshooks", + "dw.extensions.payments.salesforcepaymentshooks", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsHooks" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#adyenFailureNotification", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.adyenFailureNotification", + "tags": [ + "adyenfailurenotification", + "salesforcepaymentshooks.adyenfailurenotification" + ], + "title": "SalesforcePaymentsHooks.adyenFailureNotification" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#adyenNotification", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.adyenNotification", + "tags": [ + "adyennotification", + "salesforcepaymentshooks.adyennotification" + ], + "title": "SalesforcePaymentsHooks.adyenNotification" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#asyncPaymentSucceeded", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.asyncPaymentSucceeded", + "tags": [ + "asyncpaymentsucceeded", + "salesforcepaymentshooks.asyncpaymentsucceeded" + ], + "title": "SalesforcePaymentsHooks.asyncPaymentSucceeded" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAdyenFailureNotification", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAdyenFailureNotification", + "tags": [ + "extensionpointadyenfailurenotification", + "salesforcepaymentshooks.extensionpointadyenfailurenotification" + ], + "title": "SalesforcePaymentsHooks.extensionPointAdyenFailureNotification" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAdyenNotification", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAdyenNotification", + "tags": [ + "extensionpointadyennotification", + "salesforcepaymentshooks.extensionpointadyennotification" + ], + "title": "SalesforcePaymentsHooks.extensionPointAdyenNotification" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAsyncPaymentSucceeded", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAsyncPaymentSucceeded", + "tags": [ + "extensionpointasyncpaymentsucceeded", + "salesforcepaymentshooks.extensionpointasyncpaymentsucceeded" + ], + "title": "SalesforcePaymentsHooks.extensionPointAsyncPaymentSucceeded" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointSendOrderConfirmationEmail", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointSendOrderConfirmationEmail", + "tags": [ + "extensionpointsendorderconfirmationemail", + "salesforcepaymentshooks.extensionpointsendorderconfirmationemail" + ], + "title": "SalesforcePaymentsHooks.extensionPointSendOrderConfirmationEmail" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointStripePaymentEvent", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointStripePaymentEvent", + "tags": [ + "extensionpointstripepaymentevent", + "salesforcepaymentshooks.extensionpointstripepaymentevent" + ], + "title": "SalesforcePaymentsHooks.extensionPointStripePaymentEvent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#sendOrderConfirmationEmail", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.sendOrderConfirmationEmail", + "tags": [ + "sendorderconfirmationemail", + "salesforcepaymentshooks.sendorderconfirmationemail" + ], + "title": "SalesforcePaymentsHooks.sendOrderConfirmationEmail" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#stripePaymentEvent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.stripePaymentEvent", + "tags": [ + "stripepaymentevent", + "salesforcepaymentshooks.stripepaymentevent" + ], + "title": "SalesforcePaymentsHooks.stripePaymentEvent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount", + "tags": [ + "salesforcepaymentsmerchantaccount", + "dw.extensions.payments.salesforcepaymentsmerchantaccount", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMerchantAccount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#accountId", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.accountId", + "tags": [ + "accountid", + "salesforcepaymentsmerchantaccount.accountid" + ], + "title": "SalesforcePaymentsMerchantAccount.accountId" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#accountType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.accountType", + "tags": [ + "accounttype", + "salesforcepaymentsmerchantaccount.accounttype" + ], + "title": "SalesforcePaymentsMerchantAccount.accountType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#config", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.config", + "tags": [ + "config", + "salesforcepaymentsmerchantaccount.config" + ], + "title": "SalesforcePaymentsMerchantAccount.config" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getAccountId", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getAccountId", + "tags": [ + "getaccountid", + "salesforcepaymentsmerchantaccount.getaccountid" + ], + "title": "SalesforcePaymentsMerchantAccount.getAccountId" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getAccountType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getAccountType", + "tags": [ + "getaccounttype", + "salesforcepaymentsmerchantaccount.getaccounttype" + ], + "title": "SalesforcePaymentsMerchantAccount.getAccountType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getConfig", + "tags": [ + "getconfig", + "salesforcepaymentsmerchantaccount.getconfig" + ], + "title": "SalesforcePaymentsMerchantAccount.getConfig" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getVendor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getVendor", + "tags": [ + "getvendor", + "salesforcepaymentsmerchantaccount.getvendor" + ], + "title": "SalesforcePaymentsMerchantAccount.getVendor" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#isLive", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.isLive", + "tags": [ + "islive", + "salesforcepaymentsmerchantaccount.islive" + ], + "title": "SalesforcePaymentsMerchantAccount.isLive" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#live", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.live", + "tags": [ + "live", + "salesforcepaymentsmerchantaccount.live" + ], + "title": "SalesforcePaymentsMerchantAccount.live" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#vendor", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.vendor", + "tags": [ + "vendor", + "salesforcepaymentsmerchantaccount.vendor" + ], + "title": "SalesforcePaymentsMerchantAccount.vendor" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod", + "tags": [ + "salesforcepaymentsmerchantaccountpaymentmethod", + "dw.extensions.payments.salesforcepaymentsmerchantaccountpaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getMerchantAccount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getMerchantAccount", + "tags": [ + "getmerchantaccount", + "salesforcepaymentsmerchantaccountpaymentmethod.getmerchantaccount" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getMerchantAccount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getPaymentMethodType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentMethodType", + "tags": [ + "getpaymentmethodtype", + "salesforcepaymentsmerchantaccountpaymentmethod.getpaymentmethodtype" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentMethodType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getPaymentModes", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentModes", + "tags": [ + "getpaymentmodes", + "salesforcepaymentsmerchantaccountpaymentmethod.getpaymentmodes" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentModes" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#merchantAccount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.merchantAccount", + "tags": [ + "merchantaccount", + "salesforcepaymentsmerchantaccountpaymentmethod.merchantaccount" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.merchantAccount" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#paymentMethodType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.paymentMethodType", + "tags": [ + "paymentmethodtype", + "salesforcepaymentsmerchantaccountpaymentmethod.paymentmethodtype" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.paymentMethodType" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#paymentModes", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.paymentModes", + "tags": [ + "paymentmodes", + "salesforcepaymentsmerchantaccountpaymentmethod.paymentmodes" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.paymentModes" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr", + "tags": [ + "salesforcepaymentsmgr", + "dw.extensions.payments.salesforcepaymentsmgr", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMgr" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_ABANDONED", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED", + "tags": [ + "cancellation_reason_abandoned", + "salesforcepaymentsmgr.cancellation_reason_abandoned" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_ABANDONED", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED", + "tags": [ + "cancellation_reason_abandoned", + "salesforcepaymentsmgr.cancellation_reason_abandoned" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE", + "tags": [ + "cancellation_reason_duplicate", + "salesforcepaymentsmgr.cancellation_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE", + "tags": [ + "cancellation_reason_duplicate", + "salesforcepaymentsmgr.cancellation_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT", + "tags": [ + "cancellation_reason_fraudulent", + "salesforcepaymentsmgr.cancellation_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT", + "tags": [ + "cancellation_reason_fraudulent", + "salesforcepaymentsmgr.cancellation_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "tags": [ + "cancellation_reason_requested_by_customer", + "salesforcepaymentsmgr.cancellation_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "tags": [ + "cancellation_reason_requested_by_customer", + "salesforcepaymentsmgr.cancellation_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE", + "tags": [ + "refund_reason_duplicate", + "salesforcepaymentsmgr.refund_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE", + "tags": [ + "refund_reason_duplicate", + "salesforcepaymentsmgr.refund_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT", + "tags": [ + "refund_reason_fraudulent", + "salesforcepaymentsmgr.refund_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT", + "tags": [ + "refund_reason_fraudulent", + "salesforcepaymentsmgr.refund_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER", + "tags": [ + "refund_reason_requested_by_customer", + "salesforcepaymentsmgr.refund_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER", + "tags": [ + "refund_reason_requested_by_customer", + "salesforcepaymentsmgr.refund_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#attachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.attachPaymentMethod", + "tags": [ + "attachpaymentmethod", + "salesforcepaymentsmgr.attachpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.attachPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#attachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.attachPaymentMethod", + "tags": [ + "attachpaymentmethod", + "salesforcepaymentsmgr.attachpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.attachPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#authorizePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.authorizePayPalOrder", + "tags": [ + "authorizepaypalorder", + "salesforcepaymentsmgr.authorizepaypalorder" + ], + "title": "SalesforcePaymentsMgr.authorizePayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#authorizePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.authorizePayPalOrder", + "tags": [ + "authorizepaypalorder", + "salesforcepaymentsmgr.authorizepaypalorder" + ], + "title": "SalesforcePaymentsMgr.authorizePayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#cancelPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.cancelPaymentIntent", + "tags": [ + "cancelpaymentintent", + "salesforcepaymentsmgr.cancelpaymentintent" + ], + "title": "SalesforcePaymentsMgr.cancelPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#cancelPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.cancelPaymentIntent", + "tags": [ + "cancelpaymentintent", + "salesforcepaymentsmgr.cancelpaymentintent" + ], + "title": "SalesforcePaymentsMgr.cancelPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#captureAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.captureAdyenPayment", + "tags": [ + "captureadyenpayment", + "salesforcepaymentsmgr.captureadyenpayment" + ], + "title": "SalesforcePaymentsMgr.captureAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#captureAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.captureAdyenPayment", + "tags": [ + "captureadyenpayment", + "salesforcepaymentsmgr.captureadyenpayment" + ], + "title": "SalesforcePaymentsMgr.captureAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePayPalOrder", + "tags": [ + "capturepaypalorder", + "salesforcepaymentsmgr.capturepaypalorder" + ], + "title": "SalesforcePaymentsMgr.capturePayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePayPalOrder", + "tags": [ + "capturepaypalorder", + "salesforcepaymentsmgr.capturepaypalorder" + ], + "title": "SalesforcePaymentsMgr.capturePayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePaymentIntent", + "tags": [ + "capturepaymentintent", + "salesforcepaymentsmgr.capturepaymentintent" + ], + "title": "SalesforcePaymentsMgr.capturePaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePaymentIntent", + "tags": [ + "capturepaymentintent", + "salesforcepaymentsmgr.capturepaymentintent" + ], + "title": "SalesforcePaymentsMgr.capturePaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#confirmPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.confirmPaymentIntent", + "tags": [ + "confirmpaymentintent", + "salesforcepaymentsmgr.confirmpaymentintent" + ], + "title": "SalesforcePaymentsMgr.confirmPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#confirmPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.confirmPaymentIntent", + "tags": [ + "confirmpaymentintent", + "salesforcepaymentsmgr.confirmpaymentintent" + ], + "title": "SalesforcePaymentsMgr.confirmPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createAdyenPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createAdyenPaymentIntent", + "tags": [ + "createadyenpaymentintent", + "salesforcepaymentsmgr.createadyenpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createAdyenPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createAdyenPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createAdyenPaymentIntent", + "tags": [ + "createadyenpaymentintent", + "salesforcepaymentsmgr.createadyenpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createAdyenPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPayPalOrder", + "tags": [ + "createpaypalorder", + "salesforcepaymentsmgr.createpaypalorder" + ], + "title": "SalesforcePaymentsMgr.createPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPayPalOrder", + "tags": [ + "createpaypalorder", + "salesforcepaymentsmgr.createpaypalorder" + ], + "title": "SalesforcePaymentsMgr.createPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPaymentIntent", + "tags": [ + "createpaymentintent", + "salesforcepaymentsmgr.createpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPaymentIntent", + "tags": [ + "createpaymentintent", + "salesforcepaymentsmgr.createpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#detachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.detachPaymentMethod", + "tags": [ + "detachpaymentmethod", + "salesforcepaymentsmgr.detachpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.detachPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#detachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.detachPaymentMethod", + "tags": [ + "detachpaymentmethod", + "salesforcepaymentsmgr.detachpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.detachPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAdyenSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAdyenSavedPaymentMethods", + "tags": [ + "getadyensavedpaymentmethods", + "salesforcepaymentsmgr.getadyensavedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getAdyenSavedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAdyenSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAdyenSavedPaymentMethods", + "tags": [ + "getadyensavedpaymentmethods", + "salesforcepaymentsmgr.getadyensavedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getAdyenSavedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAttachedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAttachedPaymentMethods", + "tags": [ + "getattachedpaymentmethods", + "salesforcepaymentsmgr.getattachedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getAttachedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAttachedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAttachedPaymentMethods", + "tags": [ + "getattachedpaymentmethods", + "salesforcepaymentsmgr.getattachedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getAttachedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getOffSessionPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getOffSessionPaymentMethods", + "tags": [ + "getoffsessionpaymentmethods", + "salesforcepaymentsmgr.getoffsessionpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getOffSessionPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getOffSessionPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getOffSessionPaymentMethods", + "tags": [ + "getoffsessionpaymentmethods", + "salesforcepaymentsmgr.getoffsessionpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getOffSessionPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentDetails", + "tags": [ + "getpaymentdetails", + "salesforcepaymentsmgr.getpaymentdetails" + ], + "title": "SalesforcePaymentsMgr.getPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentDetails", + "tags": [ + "getpaymentdetails", + "salesforcepaymentsmgr.getpaymentdetails" + ], + "title": "SalesforcePaymentsMgr.getPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsSiteConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsSiteConfig", + "tags": [ + "getpaymentssiteconfig", + "salesforcepaymentsmgr.getpaymentssiteconfig" + ], + "title": "SalesforcePaymentsMgr.getPaymentsSiteConfig" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsSiteConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsSiteConfig", + "tags": [ + "getpaymentssiteconfig", + "salesforcepaymentsmgr.getpaymentssiteconfig" + ], + "title": "SalesforcePaymentsMgr.getPaymentsSiteConfig" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsZone", + "tags": [ + "getpaymentszone", + "salesforcepaymentsmgr.getpaymentszone" + ], + "title": "SalesforcePaymentsMgr.getPaymentsZone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsZone", + "tags": [ + "getpaymentszone", + "salesforcepaymentsmgr.getpaymentszone" + ], + "title": "SalesforcePaymentsMgr.getPaymentsZone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getSavedPaymentMethods", + "tags": [ + "getsavedpaymentmethods", + "salesforcepaymentsmgr.getsavedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getSavedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getSavedPaymentMethods", + "tags": [ + "getsavedpaymentmethods", + "salesforcepaymentsmgr.getsavedpaymentmethods" + ], + "title": "SalesforcePaymentsMgr.getSavedPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#handleAdyenAdditionalDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.handleAdyenAdditionalDetails", + "tags": [ + "handleadyenadditionaldetails", + "salesforcepaymentsmgr.handleadyenadditionaldetails" + ], + "title": "SalesforcePaymentsMgr.handleAdyenAdditionalDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#handleAdyenAdditionalDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.handleAdyenAdditionalDetails", + "tags": [ + "handleadyenadditionaldetails", + "salesforcepaymentsmgr.handleadyenadditionaldetails" + ], + "title": "SalesforcePaymentsMgr.handleAdyenAdditionalDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#onCustomerRegistered", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.onCustomerRegistered", + "tags": [ + "oncustomerregistered", + "salesforcepaymentsmgr.oncustomerregistered" + ], + "title": "SalesforcePaymentsMgr.onCustomerRegistered" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#onCustomerRegistered", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.onCustomerRegistered", + "tags": [ + "oncustomerregistered", + "salesforcepaymentsmgr.oncustomerregistered" + ], + "title": "SalesforcePaymentsMgr.onCustomerRegistered" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#paymentsSiteConfig", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.paymentsSiteConfig", + "tags": [ + "paymentssiteconfig", + "salesforcepaymentsmgr.paymentssiteconfig" + ], + "title": "SalesforcePaymentsMgr.paymentsSiteConfig" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#paymentsSiteConfig", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.paymentsSiteConfig", + "tags": [ + "paymentssiteconfig", + "salesforcepaymentsmgr.paymentssiteconfig" + ], + "title": "SalesforcePaymentsMgr.paymentsSiteConfig" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundAdyenPayment", + "tags": [ + "refundadyenpayment", + "salesforcepaymentsmgr.refundadyenpayment" + ], + "title": "SalesforcePaymentsMgr.refundAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundAdyenPayment", + "tags": [ + "refundadyenpayment", + "salesforcepaymentsmgr.refundadyenpayment" + ], + "title": "SalesforcePaymentsMgr.refundAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPayPalOrderCapture", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPayPalOrderCapture", + "tags": [ + "refundpaypalordercapture", + "salesforcepaymentsmgr.refundpaypalordercapture" + ], + "title": "SalesforcePaymentsMgr.refundPayPalOrderCapture" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPayPalOrderCapture", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPayPalOrderCapture", + "tags": [ + "refundpaypalordercapture", + "salesforcepaymentsmgr.refundpaypalordercapture" + ], + "title": "SalesforcePaymentsMgr.refundPayPalOrderCapture" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPaymentIntent", + "tags": [ + "refundpaymentintent", + "salesforcepaymentsmgr.refundpaymentintent" + ], + "title": "SalesforcePaymentsMgr.refundPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPaymentIntent", + "tags": [ + "refundpaymentintent", + "salesforcepaymentsmgr.refundpaymentintent" + ], + "title": "SalesforcePaymentsMgr.refundPaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeAdyenSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod", + "tags": [ + "removeadyensavedpaymentmethod", + "salesforcepaymentsmgr.removeadyensavedpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeAdyenSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod", + "tags": [ + "removeadyensavedpaymentmethod", + "salesforcepaymentsmgr.removeadyensavedpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeSavedPaymentMethod", + "tags": [ + "removesavedpaymentmethod", + "salesforcepaymentsmgr.removesavedpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.removeSavedPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeSavedPaymentMethod", + "tags": [ + "removesavedpaymentmethod", + "salesforcepaymentsmgr.removesavedpaymentmethod" + ], + "title": "SalesforcePaymentsMgr.removeSavedPaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#resolvePaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.resolvePaymentsZone", + "tags": [ + "resolvepaymentszone", + "salesforcepaymentsmgr.resolvepaymentszone" + ], + "title": "SalesforcePaymentsMgr.resolvePaymentsZone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#resolvePaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.resolvePaymentsZone", + "tags": [ + "resolvepaymentszone", + "salesforcepaymentsmgr.resolvepaymentszone" + ], + "title": "SalesforcePaymentsMgr.resolvePaymentsZone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#reverseAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.reverseAdyenPayment", + "tags": [ + "reverseadyenpayment", + "salesforcepaymentsmgr.reverseadyenpayment" + ], + "title": "SalesforcePaymentsMgr.reverseAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#reverseAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.reverseAdyenPayment", + "tags": [ + "reverseadyenpayment", + "salesforcepaymentsmgr.reverseadyenpayment" + ], + "title": "SalesforcePaymentsMgr.reverseAdyenPayment" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#savePaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.savePaymentMethod", + "tags": [ + "savepaymentmethod", + "salesforcepaymentsmgr.savepaymentmethod" + ], + "title": "SalesforcePaymentsMgr.savePaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#savePaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.savePaymentMethod", + "tags": [ + "savepaymentmethod", + "salesforcepaymentsmgr.savepaymentmethod" + ], + "title": "SalesforcePaymentsMgr.savePaymentMethod" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#setPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.setPaymentDetails", + "tags": [ + "setpaymentdetails", + "salesforcepaymentsmgr.setpaymentdetails" + ], + "title": "SalesforcePaymentsMgr.setPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#setPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.setPaymentDetails", + "tags": [ + "setpaymentdetails", + "salesforcepaymentsmgr.setpaymentdetails" + ], + "title": "SalesforcePaymentsMgr.setPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#updatePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.updatePaymentIntent", + "tags": [ + "updatepaymentintent", + "salesforcepaymentsmgr.updatepaymentintent" + ], + "title": "SalesforcePaymentsMgr.updatePaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#updatePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.updatePaymentIntent", + "tags": [ + "updatepaymentintent", + "salesforcepaymentsmgr.updatepaymentintent" + ], + "title": "SalesforcePaymentsMgr.updatePaymentIntent" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#voidPayPalOrderAuthorization", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.voidPayPalOrderAuthorization", + "tags": [ + "voidpaypalorderauthorization", + "salesforcepaymentsmgr.voidpaypalorderauthorization" + ], + "title": "SalesforcePaymentsMgr.voidPayPalOrderAuthorization" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#voidPayPalOrderAuthorization", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.voidPayPalOrderAuthorization", + "tags": [ + "voidpaypalorderauthorization", + "salesforcepaymentsmgr.voidpaypalorderauthorization" + ], + "title": "SalesforcePaymentsMgr.voidPayPalOrderAuthorization" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration", + "tags": [ + "salesforcepaymentssiteconfiguration", + "dw.extensions.payments.salesforcepaymentssiteconfiguration", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsSiteConfiguration" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#cardCaptureAutomatic", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.cardCaptureAutomatic", + "tags": [ + "cardcaptureautomatic", + "salesforcepaymentssiteconfiguration.cardcaptureautomatic" + ], + "title": "SalesforcePaymentsSiteConfiguration.cardCaptureAutomatic" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressCheckoutEnabled", + "tags": [ + "expresscheckoutenabled", + "salesforcepaymentssiteconfiguration.expresscheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnCartEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnCartEnabled", + "tags": [ + "expressoncartenabled", + "salesforcepaymentssiteconfiguration.expressoncartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnCartEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnCheckoutEnabled", + "tags": [ + "expressoncheckoutenabled", + "salesforcepaymentssiteconfiguration.expressoncheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnMiniCartEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnMiniCartEnabled", + "tags": [ + "expressonminicartenabled", + "salesforcepaymentssiteconfiguration.expressonminicartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnMiniCartEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnPdpEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnPdpEnabled", + "tags": [ + "expressonpdpenabled", + "salesforcepaymentssiteconfiguration.expressonpdpenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnPdpEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#futureUsageOffSession", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.futureUsageOffSession", + "tags": [ + "futureusageoffsession", + "salesforcepaymentssiteconfiguration.futureusageoffsession" + ], + "title": "SalesforcePaymentsSiteConfiguration.futureUsageOffSession" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isCardCaptureAutomatic", + "tags": [ + "iscardcaptureautomatic", + "salesforcepaymentssiteconfiguration.iscardcaptureautomatic" + ], + "title": "SalesforcePaymentsSiteConfiguration.isCardCaptureAutomatic" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressCheckoutEnabled", + "tags": [ + "isexpresscheckoutenabled", + "salesforcepaymentssiteconfiguration.isexpresscheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnCartEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnCartEnabled", + "tags": [ + "isexpressoncartenabled", + "salesforcepaymentssiteconfiguration.isexpressoncartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnCartEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnCheckoutEnabled", + "tags": [ + "isexpressoncheckoutenabled", + "salesforcepaymentssiteconfiguration.isexpressoncheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnMiniCartEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnMiniCartEnabled", + "tags": [ + "isexpressonminicartenabled", + "salesforcepaymentssiteconfiguration.isexpressonminicartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnMiniCartEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnPdpEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnPdpEnabled", + "tags": [ + "isexpressonpdpenabled", + "salesforcepaymentssiteconfiguration.isexpressonpdpenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnPdpEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isFutureUsageOffSession", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isFutureUsageOffSession", + "tags": [ + "isfutureusageoffsession", + "salesforcepaymentssiteconfiguration.isfutureusageoffsession" + ], + "title": "SalesforcePaymentsSiteConfiguration.isFutureUsageOffSession" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isMultiStepCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isMultiStepCheckoutEnabled", + "tags": [ + "ismultistepcheckoutenabled", + "salesforcepaymentssiteconfiguration.ismultistepcheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isMultiStepCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#multiStepCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.multiStepCheckoutEnabled", + "tags": [ + "multistepcheckoutenabled", + "salesforcepaymentssiteconfiguration.multistepcheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.multiStepCheckoutEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone", + "tags": [ + "salesforcepaymentszone", + "dw.extensions.payments.salesforcepaymentszone", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsZone" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#afterpayClearpayEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.afterpayClearpayEnabled", + "tags": [ + "afterpayclearpayenabled", + "salesforcepaymentszone.afterpayclearpayenabled" + ], + "title": "SalesforcePaymentsZone.afterpayClearpayEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#applePayEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.applePayEnabled", + "tags": [ + "applepayenabled", + "salesforcepaymentszone.applepayenabled" + ], + "title": "SalesforcePaymentsZone.applePayEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#bancontactEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.bancontactEnabled", + "tags": [ + "bancontactenabled", + "salesforcepaymentszone.bancontactenabled" + ], + "title": "SalesforcePaymentsZone.bancontactEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#bancontactMobileEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.bancontactMobileEnabled", + "tags": [ + "bancontactmobileenabled", + "salesforcepaymentszone.bancontactmobileenabled" + ], + "title": "SalesforcePaymentsZone.bancontactMobileEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#cardEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.cardEnabled", + "tags": [ + "cardenabled", + "salesforcepaymentszone.cardenabled" + ], + "title": "SalesforcePaymentsZone.cardEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#epsEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.epsEnabled", + "tags": [ + "epsenabled", + "salesforcepaymentszone.epsenabled" + ], + "title": "SalesforcePaymentsZone.epsEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#getPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.getPaymentMethods", + "tags": [ + "getpaymentmethods", + "salesforcepaymentszone.getpaymentmethods" + ], + "title": "SalesforcePaymentsZone.getPaymentMethods" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#getZoneId", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.getZoneId", + "tags": [ + "getzoneid", + "salesforcepaymentszone.getzoneid" + ], + "title": "SalesforcePaymentsZone.getZoneId" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#idealEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.idealEnabled", + "tags": [ + "idealenabled", + "salesforcepaymentszone.idealenabled" + ], + "title": "SalesforcePaymentsZone.idealEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isAfterpayClearpayEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isAfterpayClearpayEnabled", + "tags": [ + "isafterpayclearpayenabled", + "salesforcepaymentszone.isafterpayclearpayenabled" + ], + "title": "SalesforcePaymentsZone.isAfterpayClearpayEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isApplePayEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isApplePayEnabled", + "tags": [ + "isapplepayenabled", + "salesforcepaymentszone.isapplepayenabled" + ], + "title": "SalesforcePaymentsZone.isApplePayEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isBancontactEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isBancontactEnabled", + "tags": [ + "isbancontactenabled", + "salesforcepaymentszone.isbancontactenabled" + ], + "title": "SalesforcePaymentsZone.isBancontactEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isBancontactMobileEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isBancontactMobileEnabled", + "tags": [ + "isbancontactmobileenabled", + "salesforcepaymentszone.isbancontactmobileenabled" + ], + "title": "SalesforcePaymentsZone.isBancontactMobileEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isCardEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isCardEnabled", + "tags": [ + "iscardenabled", + "salesforcepaymentszone.iscardenabled" + ], + "title": "SalesforcePaymentsZone.isCardEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isEpsEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isEpsEnabled", + "tags": [ + "isepsenabled", + "salesforcepaymentszone.isepsenabled" + ], + "title": "SalesforcePaymentsZone.isEpsEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isIdealEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isIdealEnabled", + "tags": [ + "isidealenabled", + "salesforcepaymentszone.isidealenabled" + ], + "title": "SalesforcePaymentsZone.isIdealEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaEnabled", + "tags": [ + "isklarnaenabled", + "salesforcepaymentszone.isklarnaenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaPayInInstallmentsEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaPayInInstallmentsEnabled", + "tags": [ + "isklarnapayininstallmentsenabled", + "salesforcepaymentszone.isklarnapayininstallmentsenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaPayInInstallmentsEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaPayNowEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaPayNowEnabled", + "tags": [ + "isklarnapaynowenabled", + "salesforcepaymentszone.isklarnapaynowenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaPayNowEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPayPalEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPayPalEnabled", + "tags": [ + "ispaypalenabled", + "salesforcepaymentszone.ispaypalenabled" + ], + "title": "SalesforcePaymentsZone.isPayPalEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPayPalExpressEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPayPalExpressEnabled", + "tags": [ + "ispaypalexpressenabled", + "salesforcepaymentszone.ispaypalexpressenabled" + ], + "title": "SalesforcePaymentsZone.isPayPalExpressEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPaymentRequestEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPaymentRequestEnabled", + "tags": [ + "ispaymentrequestenabled", + "salesforcepaymentszone.ispaymentrequestenabled" + ], + "title": "SalesforcePaymentsZone.isPaymentRequestEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isSepaDebitEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isSepaDebitEnabled", + "tags": [ + "issepadebitenabled", + "salesforcepaymentszone.issepadebitenabled" + ], + "title": "SalesforcePaymentsZone.isSepaDebitEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isVenmoEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isVenmoEnabled", + "tags": [ + "isvenmoenabled", + "salesforcepaymentszone.isvenmoenabled" + ], + "title": "SalesforcePaymentsZone.isVenmoEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isVenmoExpressEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isVenmoExpressEnabled", + "tags": [ + "isvenmoexpressenabled", + "salesforcepaymentszone.isvenmoexpressenabled" + ], + "title": "SalesforcePaymentsZone.isVenmoExpressEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaEnabled", + "tags": [ + "klarnaenabled", + "salesforcepaymentszone.klarnaenabled" + ], + "title": "SalesforcePaymentsZone.klarnaEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaPayInInstallmentsEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaPayInInstallmentsEnabled", + "tags": [ + "klarnapayininstallmentsenabled", + "salesforcepaymentszone.klarnapayininstallmentsenabled" + ], + "title": "SalesforcePaymentsZone.klarnaPayInInstallmentsEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaPayNowEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaPayNowEnabled", + "tags": [ + "klarnapaynowenabled", + "salesforcepaymentszone.klarnapaynowenabled" + ], + "title": "SalesforcePaymentsZone.klarnaPayNowEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#payPalEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.payPalEnabled", + "tags": [ + "paypalenabled", + "salesforcepaymentszone.paypalenabled" + ], + "title": "SalesforcePaymentsZone.payPalEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#payPalExpressEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.payPalExpressEnabled", + "tags": [ + "paypalexpressenabled", + "salesforcepaymentszone.paypalexpressenabled" + ], + "title": "SalesforcePaymentsZone.payPalExpressEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#paymentRequestEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.paymentRequestEnabled", + "tags": [ + "paymentrequestenabled", + "salesforcepaymentszone.paymentrequestenabled" + ], + "title": "SalesforcePaymentsZone.paymentRequestEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#sepaDebitEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.sepaDebitEnabled", + "tags": [ + "sepadebitenabled", + "salesforcepaymentszone.sepadebitenabled" + ], + "title": "SalesforcePaymentsZone.sepaDebitEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#venmoEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.venmoEnabled", + "tags": [ + "venmoenabled", + "salesforcepaymentszone.venmoenabled" + ], + "title": "SalesforcePaymentsZone.venmoEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#venmoExpressEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.venmoExpressEnabled", + "tags": [ + "venmoexpressenabled", + "salesforcepaymentszone.venmoexpressenabled" + ], + "title": "SalesforcePaymentsZone.venmoExpressEnabled" + }, + { + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#zoneId", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.zoneId", + "tags": [ + "zoneid", + "salesforcepaymentszone.zoneid" + ], + "title": "SalesforcePaymentsZone.zoneId" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails", + "tags": [ + "salesforcesepadebitpaymentdetails", + "dw.extensions.payments.salesforcesepadebitpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceSepaDebitPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails.getLast4", + "tags": [ + "getlast4", + "salesforcesepadebitpaymentdetails.getlast4" + ], + "title": "SalesforceSepaDebitPaymentDetails.getLast4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails.last4", + "tags": [ + "last4", + "salesforcesepadebitpaymentdetails.last4" + ], + "title": "SalesforceSepaDebitPaymentDetails.last4" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails", + "tags": [ + "salesforcevenmopaymentdetails", + "dw.extensions.payments.salesforcevenmopaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceVenmoPaymentDetails" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.captureID", + "tags": [ + "captureid", + "salesforcevenmopaymentdetails.captureid" + ], + "title": "SalesforceVenmoPaymentDetails.captureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.getCaptureID", + "tags": [ + "getcaptureid", + "salesforcevenmopaymentdetails.getcaptureid" + ], + "title": "SalesforceVenmoPaymentDetails.getCaptureID" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#getPayerEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.getPayerEmailAddress", + "tags": [ + "getpayeremailaddress", + "salesforcevenmopaymentdetails.getpayeremailaddress" + ], + "title": "SalesforceVenmoPaymentDetails.getPayerEmailAddress" + }, + { + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#payerEmailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.payerEmailAddress", + "tags": [ + "payeremailaddress", + "salesforcevenmopaymentdetails.payeremailaddress" + ], + "title": "SalesforceVenmoPaymentDetails.payerEmailAddress" + }, + { + "id": "script-api:dw/extensions/pinterest", + "kind": "package", + "packagePath": "dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest", + "tags": [ + "dw/extensions/pinterest", + "dw.extensions.pinterest" + ], + "title": "dw.extensions.pinterest" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability", + "tags": [ + "pinterestavailability", + "dw.extensions.pinterest.pinterestavailability", + "dw/extensions/pinterest" + ], + "title": "PinterestAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#ID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.ID", + "tags": [ + "id", + "pinterestavailability.id" + ], + "title": "PinterestAvailability.ID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#availability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.availability", + "tags": [ + "availability", + "pinterestavailability.availability" + ], + "title": "PinterestAvailability.availability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.getAvailability", + "tags": [ + "getavailability", + "pinterestavailability.getavailability" + ], + "title": "PinterestAvailability.getAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#getID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.getID", + "tags": [ + "getid", + "pinterestavailability.getid" + ], + "title": "PinterestAvailability.getID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.setAvailability", + "tags": [ + "setavailability", + "pinterestavailability.setavailability" + ], + "title": "PinterestAvailability.setAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "kind": "interface", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks", + "tags": [ + "pinterestfeedhooks", + "dw.extensions.pinterest.pinterestfeedhooks", + "dw/extensions/pinterest" + ], + "title": "PinterestFeedHooks" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#extensionPointTransformAvailability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.extensionPointTransformAvailability", + "tags": [ + "extensionpointtransformavailability", + "pinterestfeedhooks.extensionpointtransformavailability" + ], + "title": "PinterestFeedHooks.extensionPointTransformAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#extensionPointTransformProduct", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.extensionPointTransformProduct", + "tags": [ + "extensionpointtransformproduct", + "pinterestfeedhooks.extensionpointtransformproduct" + ], + "title": "PinterestFeedHooks.extensionPointTransformProduct" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#transformAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.transformAvailability", + "tags": [ + "transformavailability", + "pinterestfeedhooks.transformavailability" + ], + "title": "PinterestFeedHooks.transformAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#transformProduct", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.transformProduct", + "tags": [ + "transformproduct", + "pinterestfeedhooks.transformproduct" + ], + "title": "PinterestFeedHooks.transformProduct" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder", + "tags": [ + "pinterestorder", + "dw.extensions.pinterest.pinterestorder", + "dw/extensions/pinterest" + ], + "title": "PinterestOrder" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID", + "tags": [ + "payment_status_not_paid", + "pinterestorder.payment_status_not_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_NOT_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID", + "tags": [ + "payment_status_not_paid", + "pinterestorder.payment_status_not_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_NOT_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID", + "tags": [ + "payment_status_paid", + "pinterestorder.payment_status_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID", + "tags": [ + "payment_status_paid", + "pinterestorder.payment_status_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PART_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID", + "tags": [ + "payment_status_part_paid", + "pinterestorder.payment_status_part_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PART_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PART_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID", + "tags": [ + "payment_status_part_paid", + "pinterestorder.payment_status_part_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PART_PAID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER", + "tags": [ + "status_backorder", + "pinterestorder.status_backorder" + ], + "title": "PinterestOrder.STATUS_BACKORDER" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER", + "tags": [ + "status_backorder", + "pinterestorder.status_backorder" + ], + "title": "PinterestOrder.STATUS_BACKORDER" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "pinterestorder.status_cancelled" + ], + "title": "PinterestOrder.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "pinterestorder.status_cancelled" + ], + "title": "PinterestOrder.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_DELIVERED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED", + "tags": [ + "status_delivered", + "pinterestorder.status_delivered" + ], + "title": "PinterestOrder.STATUS_DELIVERED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_DELIVERED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED", + "tags": [ + "status_delivered", + "pinterestorder.status_delivered" + ], + "title": "PinterestOrder.STATUS_DELIVERED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_IN_PROGRESS", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS", + "tags": [ + "status_in_progress", + "pinterestorder.status_in_progress" + ], + "title": "PinterestOrder.STATUS_IN_PROGRESS" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_IN_PROGRESS", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS", + "tags": [ + "status_in_progress", + "pinterestorder.status_in_progress" + ], + "title": "PinterestOrder.STATUS_IN_PROGRESS" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_NEW", + "tags": [ + "status_new", + "pinterestorder.status_new" + ], + "title": "PinterestOrder.STATUS_NEW" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_NEW", + "tags": [ + "status_new", + "pinterestorder.status_new" + ], + "title": "PinterestOrder.STATUS_NEW" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED", + "tags": [ + "status_returned", + "pinterestorder.status_returned" + ], + "title": "PinterestOrder.STATUS_RETURNED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED", + "tags": [ + "status_returned", + "pinterestorder.status_returned" + ], + "title": "PinterestOrder.STATUS_RETURNED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "pinterestorder.status_shipped" + ], + "title": "PinterestOrder.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "pinterestorder.status_shipped" + ], + "title": "PinterestOrder.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getItemId", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getItemId", + "tags": [ + "getitemid", + "pinterestorder.getitemid" + ], + "title": "PinterestOrder.getItemId" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getOrderNo", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getOrderNo", + "tags": [ + "getorderno", + "pinterestorder.getorderno" + ], + "title": "PinterestOrder.getOrderNo" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getPaymentStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getPaymentStatus", + "tags": [ + "getpaymentstatus", + "pinterestorder.getpaymentstatus" + ], + "title": "PinterestOrder.getPaymentStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getStatus", + "tags": [ + "getstatus", + "pinterestorder.getstatus" + ], + "title": "PinterestOrder.getStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#itemId", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.itemId", + "tags": [ + "itemid", + "pinterestorder.itemid" + ], + "title": "PinterestOrder.itemId" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#orderNo", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.orderNo", + "tags": [ + "orderno", + "pinterestorder.orderno" + ], + "title": "PinterestOrder.orderNo" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#paymentStatus", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.paymentStatus", + "tags": [ + "paymentstatus", + "pinterestorder.paymentstatus" + ], + "title": "PinterestOrder.paymentStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setItemId", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setItemId", + "tags": [ + "setitemid", + "pinterestorder.setitemid" + ], + "title": "PinterestOrder.setItemId" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setPaymentStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setPaymentStatus", + "tags": [ + "setpaymentstatus", + "pinterestorder.setpaymentstatus" + ], + "title": "PinterestOrder.setPaymentStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setStatus", + "tags": [ + "setstatus", + "pinterestorder.setstatus" + ], + "title": "PinterestOrder.setStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrder#status", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.status", + "tags": [ + "status", + "pinterestorder.status" + ], + "title": "PinterestOrder.status" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "kind": "interface", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks", + "tags": [ + "pinterestorderhooks", + "dw.extensions.pinterest.pinterestorderhooks", + "dw/extensions/pinterest" + ], + "title": "PinterestOrderHooks" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks#extensionPointGetStatus", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks.extensionPointGetStatus", + "tags": [ + "extensionpointgetstatus", + "pinterestorderhooks.extensionpointgetstatus" + ], + "title": "PinterestOrderHooks.extensionPointGetStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks#getStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks.getStatus", + "tags": [ + "getstatus", + "pinterestorderhooks.getstatus" + ], + "title": "PinterestOrderHooks.getStatus" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct", + "tags": [ + "pinterestproduct", + "dw.extensions.pinterest.pinterestproduct", + "dw/extensions/pinterest" + ], + "title": "PinterestProduct" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK", + "tags": [ + "availability_in_stock", + "pinterestproduct.availability_in_stock" + ], + "title": "PinterestProduct.AVAILABILITY_IN_STOCK" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK", + "tags": [ + "availability_in_stock", + "pinterestproduct.availability_in_stock" + ], + "title": "PinterestProduct.AVAILABILITY_IN_STOCK" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK", + "tags": [ + "availability_out_of_stock", + "pinterestproduct.availability_out_of_stock" + ], + "title": "PinterestProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK", + "tags": [ + "availability_out_of_stock", + "pinterestproduct.availability_out_of_stock" + ], + "title": "PinterestProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_PREORDER", + "tags": [ + "availability_preorder", + "pinterestproduct.availability_preorder" + ], + "title": "PinterestProduct.AVAILABILITY_PREORDER" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_PREORDER", + "tags": [ + "availability_preorder", + "pinterestproduct.availability_preorder" + ], + "title": "PinterestProduct.AVAILABILITY_PREORDER" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_NEW", + "tags": [ + "condition_new", + "pinterestproduct.condition_new" + ], + "title": "PinterestProduct.CONDITION_NEW" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_NEW", + "tags": [ + "condition_new", + "pinterestproduct.condition_new" + ], + "title": "PinterestProduct.CONDITION_NEW" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED", + "tags": [ + "condition_refurbished", + "pinterestproduct.condition_refurbished" + ], + "title": "PinterestProduct.CONDITION_REFURBISHED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED", + "tags": [ + "condition_refurbished", + "pinterestproduct.condition_refurbished" + ], + "title": "PinterestProduct.CONDITION_REFURBISHED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_USED", + "tags": [ + "condition_used", + "pinterestproduct.condition_used" + ], + "title": "PinterestProduct.CONDITION_USED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_USED", + "tags": [ + "condition_used", + "pinterestproduct.condition_used" + ], + "title": "PinterestProduct.CONDITION_USED" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#ID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.ID", + "tags": [ + "id", + "pinterestproduct.id" + ], + "title": "PinterestProduct.ID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#availability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.availability", + "tags": [ + "availability", + "pinterestproduct.availability" + ], + "title": "PinterestProduct.availability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#brand", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.brand", + "tags": [ + "brand", + "pinterestproduct.brand" + ], + "title": "PinterestProduct.brand" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#color", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.color", + "tags": [ + "color", + "pinterestproduct.color" + ], + "title": "PinterestProduct.color" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#colorHex", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.colorHex", + "tags": [ + "colorhex", + "pinterestproduct.colorhex" + ], + "title": "PinterestProduct.colorHex" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#colorImage", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.colorImage", + "tags": [ + "colorimage", + "pinterestproduct.colorimage" + ], + "title": "PinterestProduct.colorImage" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#condition", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.condition", + "tags": [ + "condition", + "pinterestproduct.condition" + ], + "title": "PinterestProduct.condition" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#description", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.description", + "tags": [ + "description", + "pinterestproduct.description" + ], + "title": "PinterestProduct.description" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getAvailability", + "tags": [ + "getavailability", + "pinterestproduct.getavailability" + ], + "title": "PinterestProduct.getAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getBrand", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getBrand", + "tags": [ + "getbrand", + "pinterestproduct.getbrand" + ], + "title": "PinterestProduct.getBrand" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColor", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColor", + "tags": [ + "getcolor", + "pinterestproduct.getcolor" + ], + "title": "PinterestProduct.getColor" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColorHex", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColorHex", + "tags": [ + "getcolorhex", + "pinterestproduct.getcolorhex" + ], + "title": "PinterestProduct.getColorHex" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColorImage", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColorImage", + "tags": [ + "getcolorimage", + "pinterestproduct.getcolorimage" + ], + "title": "PinterestProduct.getColorImage" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getCondition", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getCondition", + "tags": [ + "getcondition", + "pinterestproduct.getcondition" + ], + "title": "PinterestProduct.getCondition" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getDescription", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getDescription", + "tags": [ + "getdescription", + "pinterestproduct.getdescription" + ], + "title": "PinterestProduct.getDescription" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getGoogleProductCategory", + "tags": [ + "getgoogleproductcategory", + "pinterestproduct.getgoogleproductcategory" + ], + "title": "PinterestProduct.getGoogleProductCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getGtin", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getGtin", + "tags": [ + "getgtin", + "pinterestproduct.getgtin" + ], + "title": "PinterestProduct.getGtin" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getID", + "tags": [ + "getid", + "pinterestproduct.getid" + ], + "title": "PinterestProduct.getID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getImageLinks", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getImageLinks", + "tags": [ + "getimagelinks", + "pinterestproduct.getimagelinks" + ], + "title": "PinterestProduct.getImageLinks" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getItemGroupID", + "tags": [ + "getitemgroupid", + "pinterestproduct.getitemgroupid" + ], + "title": "PinterestProduct.getItemGroupID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getItemGroupLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getItemGroupLink", + "tags": [ + "getitemgrouplink", + "pinterestproduct.getitemgrouplink" + ], + "title": "PinterestProduct.getItemGroupLink" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getLink", + "tags": [ + "getlink", + "pinterestproduct.getlink" + ], + "title": "PinterestProduct.getLink" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getMaxPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getMaxPrice", + "tags": [ + "getmaxprice", + "pinterestproduct.getmaxprice" + ], + "title": "PinterestProduct.getMaxPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getMinPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getMinPrice", + "tags": [ + "getminprice", + "pinterestproduct.getminprice" + ], + "title": "PinterestProduct.getMinPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getPrice", + "tags": [ + "getprice", + "pinterestproduct.getprice" + ], + "title": "PinterestProduct.getPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getProductCategory", + "tags": [ + "getproductcategory", + "pinterestproduct.getproductcategory" + ], + "title": "PinterestProduct.getProductCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getReturnPolicy", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getReturnPolicy", + "tags": [ + "getreturnpolicy", + "pinterestproduct.getreturnpolicy" + ], + "title": "PinterestProduct.getReturnPolicy" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getSize", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getSize", + "tags": [ + "getsize", + "pinterestproduct.getsize" + ], + "title": "PinterestProduct.getSize" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getTitle", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getTitle", + "tags": [ + "gettitle", + "pinterestproduct.gettitle" + ], + "title": "PinterestProduct.getTitle" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#googleProductCategory", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.googleProductCategory", + "tags": [ + "googleproductcategory", + "pinterestproduct.googleproductcategory" + ], + "title": "PinterestProduct.googleProductCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#gtin", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.gtin", + "tags": [ + "gtin", + "pinterestproduct.gtin" + ], + "title": "PinterestProduct.gtin" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#imageLinks", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.imageLinks", + "tags": [ + "imagelinks", + "pinterestproduct.imagelinks" + ], + "title": "PinterestProduct.imageLinks" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#itemGroupID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.itemGroupID", + "tags": [ + "itemgroupid", + "pinterestproduct.itemgroupid" + ], + "title": "PinterestProduct.itemGroupID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#itemGroupLink", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.itemGroupLink", + "tags": [ + "itemgrouplink", + "pinterestproduct.itemgrouplink" + ], + "title": "PinterestProduct.itemGroupLink" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#link", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.link", + "tags": [ + "link", + "pinterestproduct.link" + ], + "title": "PinterestProduct.link" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#maxPrice", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.maxPrice", + "tags": [ + "maxprice", + "pinterestproduct.maxprice" + ], + "title": "PinterestProduct.maxPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#minPrice", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.minPrice", + "tags": [ + "minprice", + "pinterestproduct.minprice" + ], + "title": "PinterestProduct.minPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#price", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.price", + "tags": [ + "price", + "pinterestproduct.price" + ], + "title": "PinterestProduct.price" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#productCategory", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.productCategory", + "tags": [ + "productcategory", + "pinterestproduct.productcategory" + ], + "title": "PinterestProduct.productCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#returnPolicy", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.returnPolicy", + "tags": [ + "returnpolicy", + "pinterestproduct.returnpolicy" + ], + "title": "PinterestProduct.returnPolicy" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setAvailability", + "tags": [ + "setavailability", + "pinterestproduct.setavailability" + ], + "title": "PinterestProduct.setAvailability" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setBrand", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setBrand", + "tags": [ + "setbrand", + "pinterestproduct.setbrand" + ], + "title": "PinterestProduct.setBrand" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColor", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColor", + "tags": [ + "setcolor", + "pinterestproduct.setcolor" + ], + "title": "PinterestProduct.setColor" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColorHex", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColorHex", + "tags": [ + "setcolorhex", + "pinterestproduct.setcolorhex" + ], + "title": "PinterestProduct.setColorHex" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColorImage", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColorImage", + "tags": [ + "setcolorimage", + "pinterestproduct.setcolorimage" + ], + "title": "PinterestProduct.setColorImage" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setCondition", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setCondition", + "tags": [ + "setcondition", + "pinterestproduct.setcondition" + ], + "title": "PinterestProduct.setCondition" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setDescription", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setDescription", + "tags": [ + "setdescription", + "pinterestproduct.setdescription" + ], + "title": "PinterestProduct.setDescription" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setGoogleProductCategory", + "tags": [ + "setgoogleproductcategory", + "pinterestproduct.setgoogleproductcategory" + ], + "title": "PinterestProduct.setGoogleProductCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setGtin", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setGtin", + "tags": [ + "setgtin", + "pinterestproduct.setgtin" + ], + "title": "PinterestProduct.setGtin" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setImageLinks", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setImageLinks", + "tags": [ + "setimagelinks", + "pinterestproduct.setimagelinks" + ], + "title": "PinterestProduct.setImageLinks" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setItemGroupID", + "tags": [ + "setitemgroupid", + "pinterestproduct.setitemgroupid" + ], + "title": "PinterestProduct.setItemGroupID" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setItemGroupLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setItemGroupLink", + "tags": [ + "setitemgrouplink", + "pinterestproduct.setitemgrouplink" + ], + "title": "PinterestProduct.setItemGroupLink" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setLink", + "tags": [ + "setlink", + "pinterestproduct.setlink" + ], + "title": "PinterestProduct.setLink" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setMaxPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setMaxPrice", + "tags": [ + "setmaxprice", + "pinterestproduct.setmaxprice" + ], + "title": "PinterestProduct.setMaxPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setMinPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setMinPrice", + "tags": [ + "setminprice", + "pinterestproduct.setminprice" + ], + "title": "PinterestProduct.setMinPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setPrice", + "tags": [ + "setprice", + "pinterestproduct.setprice" + ], + "title": "PinterestProduct.setPrice" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setProductCategory", + "tags": [ + "setproductcategory", + "pinterestproduct.setproductcategory" + ], + "title": "PinterestProduct.setProductCategory" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setReturnPolicy", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setReturnPolicy", + "tags": [ + "setreturnpolicy", + "pinterestproduct.setreturnpolicy" + ], + "title": "PinterestProduct.setReturnPolicy" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setSize", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setSize", + "tags": [ + "setsize", + "pinterestproduct.setsize" + ], + "title": "PinterestProduct.setSize" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setTitle", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setTitle", + "tags": [ + "settitle", + "pinterestproduct.settitle" + ], + "title": "PinterestProduct.setTitle" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#size", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.size", + "tags": [ + "size", + "pinterestproduct.size" + ], + "title": "PinterestProduct.size" + }, + { + "id": "script-api:dw/extensions/pinterest/PinterestProduct#title", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.title", + "tags": [ + "title", + "pinterestproduct.title" + ], + "title": "PinterestProduct.title" + }, + { + "id": "script-api:dw/io", + "kind": "package", + "packagePath": "dw/io", + "qualifiedName": "dw.io", + "tags": [ + "dw/io", + "dw.io" + ], + "title": "dw.io" + }, + { + "id": "script-api:dw/io/CSVStreamReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.CSVStreamReader", + "tags": [ + "csvstreamreader", + "dw.io.csvstreamreader", + "dw/io" + ], + "title": "CSVStreamReader" + }, + { + "id": "script-api:dw/io/CSVStreamReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.close", + "tags": [ + "close", + "csvstreamreader.close" + ], + "title": "CSVStreamReader.close" + }, + { + "id": "script-api:dw/io/CSVStreamReader#readAll", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.readAll", + "tags": [ + "readall", + "csvstreamreader.readall" + ], + "title": "CSVStreamReader.readAll" + }, + { + "id": "script-api:dw/io/CSVStreamReader#readNext", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.readNext", + "tags": [ + "readnext", + "csvstreamreader.readnext" + ], + "title": "CSVStreamReader.readNext" + }, + { + "id": "script-api:dw/io/CSVStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.CSVStreamWriter", + "tags": [ + "csvstreamwriter", + "dw.io.csvstreamwriter", + "dw/io" + ], + "title": "CSVStreamWriter" + }, + { + "id": "script-api:dw/io/CSVStreamWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamWriter", + "qualifiedName": "dw.io.CSVStreamWriter.close", + "tags": [ + "close", + "csvstreamwriter.close" + ], + "title": "CSVStreamWriter.close" + }, + { + "id": "script-api:dw/io/CSVStreamWriter#writeNext", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamWriter", + "qualifiedName": "dw.io.CSVStreamWriter.writeNext", + "tags": [ + "writenext", + "csvstreamwriter.writenext" + ], + "title": "CSVStreamWriter.writeNext" + }, + { + "id": "script-api:dw/io/File", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.File", + "tags": [ + "file", + "dw.io.file", + "dw/io" + ], + "title": "File" + }, + { + "id": "script-api:dw/io/File#CATALOGS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CATALOGS", + "tags": [ + "catalogs", + "file.catalogs" + ], + "title": "File.CATALOGS" + }, + { + "id": "script-api:dw/io/File#CATALOGS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CATALOGS", + "tags": [ + "catalogs", + "file.catalogs" + ], + "title": "File.CATALOGS" + }, + { + "id": "script-api:dw/io/File#CUSTOMERPI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMERPI", + "tags": [ + "customerpi", + "file.customerpi" + ], + "title": "File.CUSTOMERPI" + }, + { + "id": "script-api:dw/io/File#CUSTOMERPI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMERPI", + "tags": [ + "customerpi", + "file.customerpi" + ], + "title": "File.CUSTOMERPI" + }, + { + "id": "script-api:dw/io/File#CUSTOMER_SNAPSHOTS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMER_SNAPSHOTS", + "tags": [ + "customer_snapshots", + "file.customer_snapshots" + ], + "title": "File.CUSTOMER_SNAPSHOTS" + }, + { + "id": "script-api:dw/io/File#CUSTOMER_SNAPSHOTS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMER_SNAPSHOTS", + "tags": [ + "customer_snapshots", + "file.customer_snapshots" + ], + "title": "File.CUSTOMER_SNAPSHOTS" + }, + { + "id": "script-api:dw/io/File#DYNAMIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.DYNAMIC", + "tags": [ + "dynamic", + "file.dynamic" + ], + "title": "File.DYNAMIC" + }, + { + "id": "script-api:dw/io/File#DYNAMIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.DYNAMIC", + "tags": [ + "dynamic", + "file.dynamic" + ], + "title": "File.DYNAMIC" + }, + { + "id": "script-api:dw/io/File#IMPEX", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.IMPEX", + "tags": [ + "impex", + "file.impex" + ], + "title": "File.IMPEX" + }, + { + "id": "script-api:dw/io/File#IMPEX", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.IMPEX", + "tags": [ + "impex", + "file.impex" + ], + "title": "File.IMPEX" + }, + { + "id": "script-api:dw/io/File#LIBRARIES", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.LIBRARIES", + "tags": [ + "libraries", + "file.libraries" + ], + "title": "File.LIBRARIES" + }, + { + "id": "script-api:dw/io/File#LIBRARIES", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.LIBRARIES", + "tags": [ + "libraries", + "file.libraries" + ], + "title": "File.LIBRARIES" + }, + { + "id": "script-api:dw/io/File#REALMDATA", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.REALMDATA", + "tags": [ + "realmdata", + "file.realmdata" + ], + "title": "File.REALMDATA" + }, + { + "id": "script-api:dw/io/File#REALMDATA", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.REALMDATA", + "tags": [ + "realmdata", + "file.realmdata" + ], + "title": "File.REALMDATA" + }, + { + "id": "script-api:dw/io/File#SEPARATOR", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.SEPARATOR", + "tags": [ + "separator", + "file.separator" + ], + "title": "File.SEPARATOR" + }, + { + "id": "script-api:dw/io/File#SEPARATOR", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.SEPARATOR", + "tags": [ + "separator", + "file.separator" + ], + "title": "File.SEPARATOR" + }, + { + "id": "script-api:dw/io/File#STATIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.STATIC", + "tags": [ + "static", + "file.static" + ], + "title": "File.STATIC" + }, + { + "id": "script-api:dw/io/File#STATIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.STATIC", + "tags": [ + "static", + "file.static" + ], + "title": "File.STATIC" + }, + { + "id": "script-api:dw/io/File#TEMP", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.TEMP", + "tags": [ + "temp", + "file.temp" + ], + "title": "File.TEMP" + }, + { + "id": "script-api:dw/io/File#TEMP", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.TEMP", + "tags": [ + "temp", + "file.temp" + ], + "title": "File.TEMP" + }, + { + "id": "script-api:dw/io/File#copyTo", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.copyTo", + "tags": [ + "copyto", + "file.copyto" + ], + "title": "File.copyTo" + }, + { + "id": "script-api:dw/io/File#createNewFile", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.createNewFile", + "tags": [ + "createnewfile", + "file.createnewfile" + ], + "title": "File.createNewFile" + }, + { + "id": "script-api:dw/io/File#directory", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.directory", + "tags": [ + "directory", + "file.directory" + ], + "title": "File.directory" + }, + { + "id": "script-api:dw/io/File#exists", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.exists", + "tags": [ + "exists", + "file.exists" + ], + "title": "File.exists" + }, + { + "id": "script-api:dw/io/File#file", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.file", + "tags": [ + "file", + "file.file" + ], + "title": "File.file" + }, + { + "id": "script-api:dw/io/File#fullPath", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.fullPath", + "tags": [ + "fullpath", + "file.fullpath" + ], + "title": "File.fullPath" + }, + { + "id": "script-api:dw/io/File#getFullPath", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getFullPath", + "tags": [ + "getfullpath", + "file.getfullpath" + ], + "title": "File.getFullPath" + }, + { + "id": "script-api:dw/io/File#getName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getName", + "tags": [ + "getname", + "file.getname" + ], + "title": "File.getName" + }, + { + "id": "script-api:dw/io/File#getPath", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getPath", + "tags": [ + "getpath", + "file.getpath" + ], + "title": "File.getPath" + }, + { + "id": "script-api:dw/io/File#getRootDirectory", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectory", + "tags": [ + "getrootdirectory", + "file.getrootdirectory" + ], + "title": "File.getRootDirectory" + }, + { + "id": "script-api:dw/io/File#getRootDirectory", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectory", + "tags": [ + "getrootdirectory", + "file.getrootdirectory" + ], + "title": "File.getRootDirectory" + }, + { + "id": "script-api:dw/io/File#getRootDirectoryType", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectoryType", + "tags": [ + "getrootdirectorytype", + "file.getrootdirectorytype" + ], + "title": "File.getRootDirectoryType" + }, + { + "id": "script-api:dw/io/File#gunzip", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.gunzip", + "tags": [ + "gunzip", + "file.gunzip" + ], + "title": "File.gunzip" + }, + { + "id": "script-api:dw/io/File#gzip", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.gzip", + "tags": [ + "gzip", + "file.gzip" + ], + "title": "File.gzip" + }, + { + "id": "script-api:dw/io/File#isDirectory", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.isDirectory", + "tags": [ + "isdirectory", + "file.isdirectory" + ], + "title": "File.isDirectory" + }, + { + "id": "script-api:dw/io/File#isFile", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.isFile", + "tags": [ + "isfile", + "file.isfile" + ], + "title": "File.isFile" + }, + { + "id": "script-api:dw/io/File#lastModified", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.lastModified", + "tags": [ + "lastmodified", + "file.lastmodified" + ], + "title": "File.lastModified" + }, + { + "id": "script-api:dw/io/File#length", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.length", + "tags": [ + "length", + "file.length" + ], + "title": "File.length" + }, + { + "id": "script-api:dw/io/File#list", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.list", + "tags": [ + "list", + "file.list" + ], + "title": "File.list" + }, + { + "id": "script-api:dw/io/File#listFiles", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.listFiles", + "tags": [ + "listfiles", + "file.listfiles" + ], + "title": "File.listFiles" + }, + { + "id": "script-api:dw/io/File#listFiles", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.listFiles", + "tags": [ + "listfiles", + "file.listfiles" + ], + "title": "File.listFiles" + }, + { + "id": "script-api:dw/io/File#md5", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.md5", + "tags": [ + "md5", + "file.md5" + ], + "title": "File.md5" + }, + { + "id": "script-api:dw/io/File#mkdir", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.mkdir", + "tags": [ + "mkdir", + "file.mkdir" + ], + "title": "File.mkdir" + }, + { + "id": "script-api:dw/io/File#mkdirs", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.mkdirs", + "tags": [ + "mkdirs", + "file.mkdirs" + ], + "title": "File.mkdirs" + }, + { + "id": "script-api:dw/io/File#name", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.name", + "tags": [ + "name", + "file.name" + ], + "title": "File.name" + }, + { + "id": "script-api:dw/io/File#path", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.path", + "tags": [ + "path", + "file.path" + ], + "title": "File.path" + }, + { + "id": "script-api:dw/io/File#remove", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.remove", + "tags": [ + "remove", + "file.remove" + ], + "title": "File.remove" + }, + { + "id": "script-api:dw/io/File#renameTo", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.renameTo", + "tags": [ + "renameto", + "file.renameto" + ], + "title": "File.renameTo" + }, + { + "id": "script-api:dw/io/File#rootDirectoryType", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.rootDirectoryType", + "tags": [ + "rootdirectorytype", + "file.rootdirectorytype" + ], + "title": "File.rootDirectoryType" + }, + { + "id": "script-api:dw/io/File#unzip", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.unzip", + "tags": [ + "unzip", + "file.unzip" + ], + "title": "File.unzip" + }, + { + "id": "script-api:dw/io/File#zip", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.zip", + "tags": [ + "zip", + "file.zip" + ], + "title": "File.zip" + }, + { + "id": "script-api:dw/io/FileReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.FileReader", + "tags": [ + "filereader", + "dw.io.filereader", + "dw/io" + ], + "title": "FileReader" + }, + { + "id": "script-api:dw/io/FileReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileReader", + "qualifiedName": "dw.io.FileReader.close", + "tags": [ + "close", + "filereader.close" + ], + "title": "FileReader.close" + }, + { + "id": "script-api:dw/io/FileWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.FileWriter", + "tags": [ + "filewriter", + "dw.io.filewriter", + "dw/io" + ], + "title": "FileWriter" + }, + { + "id": "script-api:dw/io/FileWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.close", + "tags": [ + "close", + "filewriter.close" + ], + "title": "FileWriter.close" + }, + { + "id": "script-api:dw/io/FileWriter#getLineSeparator", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.getLineSeparator", + "tags": [ + "getlineseparator", + "filewriter.getlineseparator" + ], + "title": "FileWriter.getLineSeparator" + }, + { + "id": "script-api:dw/io/FileWriter#lineSeparator", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.lineSeparator", + "tags": [ + "lineseparator", + "filewriter.lineseparator" + ], + "title": "FileWriter.lineSeparator" + }, + { + "id": "script-api:dw/io/FileWriter#setLineSeparator", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.setLineSeparator", + "tags": [ + "setlineseparator", + "filewriter.setlineseparator" + ], + "title": "FileWriter.setLineSeparator" + }, + { + "id": "script-api:dw/io/FileWriter#writeLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.writeLine", + "tags": [ + "writeline", + "filewriter.writeline" + ], + "title": "FileWriter.writeLine" + }, + { + "id": "script-api:dw/io/InputStream", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.InputStream", + "tags": [ + "inputstream", + "dw.io.inputstream", + "dw/io" + ], + "title": "InputStream" + }, + { + "id": "script-api:dw/io/InputStream#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/InputStream", + "qualifiedName": "dw.io.InputStream.close", + "tags": [ + "close", + "inputstream.close" + ], + "title": "InputStream.close" + }, + { + "id": "script-api:dw/io/OutputStream", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.OutputStream", + "tags": [ + "outputstream", + "dw.io.outputstream", + "dw/io" + ], + "title": "OutputStream" + }, + { + "id": "script-api:dw/io/OutputStream#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/OutputStream", + "qualifiedName": "dw.io.OutputStream.close", + "tags": [ + "close", + "outputstream.close" + ], + "title": "OutputStream.close" + }, + { + "id": "script-api:dw/io/PrintWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.PrintWriter", + "tags": [ + "printwriter", + "dw.io.printwriter", + "dw/io" + ], + "title": "PrintWriter" + }, + { + "id": "script-api:dw/io/PrintWriter#print", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.print", + "tags": [ + "print", + "printwriter.print" + ], + "title": "PrintWriter.print" + }, + { + "id": "script-api:dw/io/PrintWriter#println", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.println", + "tags": [ + "println", + "printwriter.println" + ], + "title": "PrintWriter.println" + }, + { + "id": "script-api:dw/io/PrintWriter#println", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.println", + "tags": [ + "println", + "printwriter.println" + ], + "title": "PrintWriter.println" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.RandomAccessFileReader", + "tags": [ + "randomaccessfilereader", + "dw.io.randomaccessfilereader", + "dw/io" + ], + "title": "RandomAccessFileReader" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#MAX_READ_BYTES", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.MAX_READ_BYTES", + "tags": [ + "max_read_bytes", + "randomaccessfilereader.max_read_bytes" + ], + "title": "RandomAccessFileReader.MAX_READ_BYTES" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#MAX_READ_BYTES", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.MAX_READ_BYTES", + "tags": [ + "max_read_bytes", + "randomaccessfilereader.max_read_bytes" + ], + "title": "RandomAccessFileReader.MAX_READ_BYTES" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.close", + "tags": [ + "close", + "randomaccessfilereader.close" + ], + "title": "RandomAccessFileReader.close" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#getPosition", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.getPosition", + "tags": [ + "getposition", + "randomaccessfilereader.getposition" + ], + "title": "RandomAccessFileReader.getPosition" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#length", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.length", + "tags": [ + "length", + "randomaccessfilereader.length" + ], + "title": "RandomAccessFileReader.length" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#position", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.position", + "tags": [ + "position", + "randomaccessfilereader.position" + ], + "title": "RandomAccessFileReader.position" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#readByte", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.readByte", + "tags": [ + "readbyte", + "randomaccessfilereader.readbyte" + ], + "title": "RandomAccessFileReader.readByte" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#readBytes", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.readBytes", + "tags": [ + "readbytes", + "randomaccessfilereader.readbytes" + ], + "title": "RandomAccessFileReader.readBytes" + }, + { + "id": "script-api:dw/io/RandomAccessFileReader#setPosition", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.setPosition", + "tags": [ + "setposition", + "randomaccessfilereader.setposition" + ], + "title": "RandomAccessFileReader.setPosition" + }, + { + "id": "script-api:dw/io/Reader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.Reader", + "tags": [ + "reader", + "dw.io.reader", + "dw/io" + ], + "title": "Reader" + }, + { + "id": "script-api:dw/io/Reader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.close", + "tags": [ + "close", + "reader.close" + ], + "title": "Reader.close" + }, + { + "id": "script-api:dw/io/Reader#getLines", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.getLines", + "tags": [ + "getlines", + "reader.getlines" + ], + "title": "Reader.getLines" + }, + { + "id": "script-api:dw/io/Reader#getString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.getString", + "tags": [ + "getstring", + "reader.getstring" + ], + "title": "Reader.getString" + }, + { + "id": "script-api:dw/io/Reader#lines", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.lines", + "tags": [ + "lines", + "reader.lines" + ], + "title": "Reader.lines" + }, + { + "id": "script-api:dw/io/Reader#read", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.read", + "tags": [ + "read", + "reader.read" + ], + "title": "Reader.read" + }, + { + "id": "script-api:dw/io/Reader#read", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.read", + "tags": [ + "read", + "reader.read" + ], + "title": "Reader.read" + }, + { + "id": "script-api:dw/io/Reader#readLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readLine", + "tags": [ + "readline", + "reader.readline" + ], + "title": "Reader.readLine" + }, + { + "id": "script-api:dw/io/Reader#readLines", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readLines", + "tags": [ + "readlines", + "reader.readlines" + ], + "title": "Reader.readLines" + }, + { + "id": "script-api:dw/io/Reader#readN", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readN", + "tags": [ + "readn", + "reader.readn" + ], + "title": "Reader.readN" + }, + { + "id": "script-api:dw/io/Reader#readString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readString", + "tags": [ + "readstring", + "reader.readstring" + ], + "title": "Reader.readString" + }, + { + "id": "script-api:dw/io/Reader#ready", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.ready", + "tags": [ + "ready", + "reader.ready" + ], + "title": "Reader.ready" + }, + { + "id": "script-api:dw/io/Reader#skip", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.skip", + "tags": [ + "skip", + "reader.skip" + ], + "title": "Reader.skip" + }, + { + "id": "script-api:dw/io/Reader#string", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.string", + "tags": [ + "string", + "reader.string" + ], + "title": "Reader.string" + }, + { + "id": "script-api:dw/io/StringWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.StringWriter", + "tags": [ + "stringwriter", + "dw.io.stringwriter", + "dw/io" + ], + "title": "StringWriter" + }, + { + "id": "script-api:dw/io/StringWriter#toString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.toString", + "tags": [ + "tostring", + "stringwriter.tostring" + ], + "title": "StringWriter.toString" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "id": "script-api:dw/io/Writer", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.Writer", + "tags": [ + "writer", + "dw.io.writer", + "dw/io" + ], + "title": "Writer" + }, + { + "id": "script-api:dw/io/Writer#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.close", + "tags": [ + "close", + "writer.close" + ], + "title": "Writer.close" + }, + { + "id": "script-api:dw/io/Writer#flush", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.flush", + "tags": [ + "flush", + "writer.flush" + ], + "title": "Writer.flush" + }, + { + "id": "script-api:dw/io/Writer#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.write", + "tags": [ + "write", + "writer.write" + ], + "title": "Writer.write" + }, + { + "id": "script-api:dw/io/Writer#write", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.write", + "tags": [ + "write", + "writer.write" + ], + "title": "Writer.write" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLIndentingStreamWriter", + "tags": [ + "xmlindentingstreamwriter", + "dw.io.xmlindentingstreamwriter", + "dw/io" + ], + "title": "XMLIndentingStreamWriter" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#getIndent", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.getIndent", + "tags": [ + "getindent", + "xmlindentingstreamwriter.getindent" + ], + "title": "XMLIndentingStreamWriter.getIndent" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#getNewLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.getNewLine", + "tags": [ + "getnewline", + "xmlindentingstreamwriter.getnewline" + ], + "title": "XMLIndentingStreamWriter.getNewLine" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#indent", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.indent", + "tags": [ + "indent", + "xmlindentingstreamwriter.indent" + ], + "title": "XMLIndentingStreamWriter.indent" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#newLine", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.newLine", + "tags": [ + "newline", + "xmlindentingstreamwriter.newline" + ], + "title": "XMLIndentingStreamWriter.newLine" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#setIndent", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.setIndent", + "tags": [ + "setindent", + "xmlindentingstreamwriter.setindent" + ], + "title": "XMLIndentingStreamWriter.setIndent" + }, + { + "id": "script-api:dw/io/XMLIndentingStreamWriter#setNewLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.setNewLine", + "tags": [ + "setnewline", + "xmlindentingstreamwriter.setnewline" + ], + "title": "XMLIndentingStreamWriter.setNewLine" + }, + { + "id": "script-api:dw/io/XMLStreamConstants", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamConstants", + "tags": [ + "xmlstreamconstants", + "dw.io.xmlstreamconstants", + "dw/io" + ], + "title": "XMLStreamConstants" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ATTRIBUTE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ATTRIBUTE", + "tags": [ + "attribute", + "xmlstreamconstants.attribute" + ], + "title": "XMLStreamConstants.ATTRIBUTE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ATTRIBUTE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ATTRIBUTE", + "tags": [ + "attribute", + "xmlstreamconstants.attribute" + ], + "title": "XMLStreamConstants.ATTRIBUTE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#CDATA", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CDATA", + "tags": [ + "cdata", + "xmlstreamconstants.cdata" + ], + "title": "XMLStreamConstants.CDATA" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#CDATA", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CDATA", + "tags": [ + "cdata", + "xmlstreamconstants.cdata" + ], + "title": "XMLStreamConstants.CDATA" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#CHARACTERS", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CHARACTERS", + "tags": [ + "characters", + "xmlstreamconstants.characters" + ], + "title": "XMLStreamConstants.CHARACTERS" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#CHARACTERS", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CHARACTERS", + "tags": [ + "characters", + "xmlstreamconstants.characters" + ], + "title": "XMLStreamConstants.CHARACTERS" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#COMMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.COMMENT", + "tags": [ + "comment", + "xmlstreamconstants.comment" + ], + "title": "XMLStreamConstants.COMMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#COMMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.COMMENT", + "tags": [ + "comment", + "xmlstreamconstants.comment" + ], + "title": "XMLStreamConstants.COMMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#DTD", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.DTD", + "tags": [ + "dtd", + "xmlstreamconstants.dtd" + ], + "title": "XMLStreamConstants.DTD" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#DTD", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.DTD", + "tags": [ + "dtd", + "xmlstreamconstants.dtd" + ], + "title": "XMLStreamConstants.DTD" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#END_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_DOCUMENT", + "tags": [ + "end_document", + "xmlstreamconstants.end_document" + ], + "title": "XMLStreamConstants.END_DOCUMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#END_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_DOCUMENT", + "tags": [ + "end_document", + "xmlstreamconstants.end_document" + ], + "title": "XMLStreamConstants.END_DOCUMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#END_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_ELEMENT", + "tags": [ + "end_element", + "xmlstreamconstants.end_element" + ], + "title": "XMLStreamConstants.END_ELEMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#END_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_ELEMENT", + "tags": [ + "end_element", + "xmlstreamconstants.end_element" + ], + "title": "XMLStreamConstants.END_ELEMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_DECLARATION", + "tags": [ + "entity_declaration", + "xmlstreamconstants.entity_declaration" + ], + "title": "XMLStreamConstants.ENTITY_DECLARATION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_DECLARATION", + "tags": [ + "entity_declaration", + "xmlstreamconstants.entity_declaration" + ], + "title": "XMLStreamConstants.ENTITY_DECLARATION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_REFERENCE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_REFERENCE", + "tags": [ + "entity_reference", + "xmlstreamconstants.entity_reference" + ], + "title": "XMLStreamConstants.ENTITY_REFERENCE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_REFERENCE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_REFERENCE", + "tags": [ + "entity_reference", + "xmlstreamconstants.entity_reference" + ], + "title": "XMLStreamConstants.ENTITY_REFERENCE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#NAMESPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NAMESPACE", + "tags": [ + "namespace", + "xmlstreamconstants.namespace" + ], + "title": "XMLStreamConstants.NAMESPACE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#NAMESPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NAMESPACE", + "tags": [ + "namespace", + "xmlstreamconstants.namespace" + ], + "title": "XMLStreamConstants.NAMESPACE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#NOTATION_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NOTATION_DECLARATION", + "tags": [ + "notation_declaration", + "xmlstreamconstants.notation_declaration" + ], + "title": "XMLStreamConstants.NOTATION_DECLARATION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#NOTATION_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NOTATION_DECLARATION", + "tags": [ + "notation_declaration", + "xmlstreamconstants.notation_declaration" + ], + "title": "XMLStreamConstants.NOTATION_DECLARATION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#PROCESSING_INSTRUCTION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.PROCESSING_INSTRUCTION", + "tags": [ + "processing_instruction", + "xmlstreamconstants.processing_instruction" + ], + "title": "XMLStreamConstants.PROCESSING_INSTRUCTION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#PROCESSING_INSTRUCTION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.PROCESSING_INSTRUCTION", + "tags": [ + "processing_instruction", + "xmlstreamconstants.processing_instruction" + ], + "title": "XMLStreamConstants.PROCESSING_INSTRUCTION" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#SPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.SPACE", + "tags": [ + "space", + "xmlstreamconstants.space" + ], + "title": "XMLStreamConstants.SPACE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#SPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.SPACE", + "tags": [ + "space", + "xmlstreamconstants.space" + ], + "title": "XMLStreamConstants.SPACE" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#START_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_DOCUMENT", + "tags": [ + "start_document", + "xmlstreamconstants.start_document" + ], + "title": "XMLStreamConstants.START_DOCUMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#START_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_DOCUMENT", + "tags": [ + "start_document", + "xmlstreamconstants.start_document" + ], + "title": "XMLStreamConstants.START_DOCUMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#START_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_ELEMENT", + "tags": [ + "start_element", + "xmlstreamconstants.start_element" + ], + "title": "XMLStreamConstants.START_ELEMENT" + }, + { + "id": "script-api:dw/io/XMLStreamConstants#START_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_ELEMENT", + "tags": [ + "start_element", + "xmlstreamconstants.start_element" + ], + "title": "XMLStreamConstants.START_ELEMENT" + }, + { + "id": "script-api:dw/io/XMLStreamReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamReader", + "tags": [ + "xmlstreamreader", + "dw.io.xmlstreamreader", + "dw/io" + ], + "title": "XMLStreamReader" + }, + { + "id": "script-api:dw/io/XMLStreamReader#PIData", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.PIData", + "tags": [ + "pidata", + "xmlstreamreader.pidata" + ], + "title": "XMLStreamReader.PIData" + }, + { + "id": "script-api:dw/io/XMLStreamReader#PITarget", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.PITarget", + "tags": [ + "pitarget", + "xmlstreamreader.pitarget" + ], + "title": "XMLStreamReader.PITarget" + }, + { + "id": "script-api:dw/io/XMLStreamReader#XMLObject", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.XMLObject", + "tags": [ + "xmlobject", + "xmlstreamreader.xmlobject" + ], + "title": "XMLStreamReader.XMLObject" + }, + { + "id": "script-api:dw/io/XMLStreamReader#attributeCount", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.attributeCount", + "tags": [ + "attributecount", + "xmlstreamreader.attributecount" + ], + "title": "XMLStreamReader.attributeCount" + }, + { + "id": "script-api:dw/io/XMLStreamReader#characterEncodingScheme", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.characterEncodingScheme", + "tags": [ + "characterencodingscheme", + "xmlstreamreader.characterencodingscheme" + ], + "title": "XMLStreamReader.characterEncodingScheme" + }, + { + "id": "script-api:dw/io/XMLStreamReader#characters", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.characters", + "tags": [ + "characters", + "xmlstreamreader.characters" + ], + "title": "XMLStreamReader.characters" + }, + { + "id": "script-api:dw/io/XMLStreamReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.close", + "tags": [ + "close", + "xmlstreamreader.close" + ], + "title": "XMLStreamReader.close" + }, + { + "id": "script-api:dw/io/XMLStreamReader#columnNumber", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.columnNumber", + "tags": [ + "columnnumber", + "xmlstreamreader.columnnumber" + ], + "title": "XMLStreamReader.columnNumber" + }, + { + "id": "script-api:dw/io/XMLStreamReader#elementText", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.elementText", + "tags": [ + "elementtext", + "xmlstreamreader.elementtext" + ], + "title": "XMLStreamReader.elementText" + }, + { + "id": "script-api:dw/io/XMLStreamReader#encoding", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.encoding", + "tags": [ + "encoding", + "xmlstreamreader.encoding" + ], + "title": "XMLStreamReader.encoding" + }, + { + "id": "script-api:dw/io/XMLStreamReader#endElement", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.endElement", + "tags": [ + "endelement", + "xmlstreamreader.endelement" + ], + "title": "XMLStreamReader.endElement" + }, + { + "id": "script-api:dw/io/XMLStreamReader#eventType", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.eventType", + "tags": [ + "eventtype", + "xmlstreamreader.eventtype" + ], + "title": "XMLStreamReader.eventType" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeCount", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeCount", + "tags": [ + "getattributecount", + "xmlstreamreader.getattributecount" + ], + "title": "XMLStreamReader.getAttributeCount" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeLocalName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeLocalName", + "tags": [ + "getattributelocalname", + "xmlstreamreader.getattributelocalname" + ], + "title": "XMLStreamReader.getAttributeLocalName" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeNamespace", + "tags": [ + "getattributenamespace", + "xmlstreamreader.getattributenamespace" + ], + "title": "XMLStreamReader.getAttributeNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributePrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributePrefix", + "tags": [ + "getattributeprefix", + "xmlstreamreader.getattributeprefix" + ], + "title": "XMLStreamReader.getAttributePrefix" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeType", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeType", + "tags": [ + "getattributetype", + "xmlstreamreader.getattributetype" + ], + "title": "XMLStreamReader.getAttributeType" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeValue", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeValue", + "tags": [ + "getattributevalue", + "xmlstreamreader.getattributevalue" + ], + "title": "XMLStreamReader.getAttributeValue" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getAttributeValue", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeValue", + "tags": [ + "getattributevalue", + "xmlstreamreader.getattributevalue" + ], + "title": "XMLStreamReader.getAttributeValue" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getCharacterEncodingScheme", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getCharacterEncodingScheme", + "tags": [ + "getcharacterencodingscheme", + "xmlstreamreader.getcharacterencodingscheme" + ], + "title": "XMLStreamReader.getCharacterEncodingScheme" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getColumnNumber", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getColumnNumber", + "tags": [ + "getcolumnnumber", + "xmlstreamreader.getcolumnnumber" + ], + "title": "XMLStreamReader.getColumnNumber" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getElementText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getElementText", + "tags": [ + "getelementtext", + "xmlstreamreader.getelementtext" + ], + "title": "XMLStreamReader.getElementText" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getEncoding", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getEncoding", + "tags": [ + "getencoding", + "xmlstreamreader.getencoding" + ], + "title": "XMLStreamReader.getEncoding" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getEventType", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getEventType", + "tags": [ + "geteventtype", + "xmlstreamreader.geteventtype" + ], + "title": "XMLStreamReader.getEventType" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getLineNumber", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getLineNumber", + "tags": [ + "getlinenumber", + "xmlstreamreader.getlinenumber" + ], + "title": "XMLStreamReader.getLineNumber" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getLocalName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getLocalName", + "tags": [ + "getlocalname", + "xmlstreamreader.getlocalname" + ], + "title": "XMLStreamReader.getLocalName" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getNamespaceCount", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceCount", + "tags": [ + "getnamespacecount", + "xmlstreamreader.getnamespacecount" + ], + "title": "XMLStreamReader.getNamespaceCount" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getNamespacePrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespacePrefix", + "tags": [ + "getnamespaceprefix", + "xmlstreamreader.getnamespaceprefix" + ], + "title": "XMLStreamReader.getNamespacePrefix" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getPIData", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPIData", + "tags": [ + "getpidata", + "xmlstreamreader.getpidata" + ], + "title": "XMLStreamReader.getPIData" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getPITarget", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPITarget", + "tags": [ + "getpitarget", + "xmlstreamreader.getpitarget" + ], + "title": "XMLStreamReader.getPITarget" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getPrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPrefix", + "tags": [ + "getprefix", + "xmlstreamreader.getprefix" + ], + "title": "XMLStreamReader.getPrefix" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getText", + "tags": [ + "gettext", + "xmlstreamreader.gettext" + ], + "title": "XMLStreamReader.getText" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getTextLength", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getTextLength", + "tags": [ + "gettextlength", + "xmlstreamreader.gettextlength" + ], + "title": "XMLStreamReader.getTextLength" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getTextStart", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getTextStart", + "tags": [ + "gettextstart", + "xmlstreamreader.gettextstart" + ], + "title": "XMLStreamReader.getTextStart" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getVersion", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getVersion", + "tags": [ + "getversion", + "xmlstreamreader.getversion" + ], + "title": "XMLStreamReader.getVersion" + }, + { + "id": "script-api:dw/io/XMLStreamReader#getXMLObject", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getXMLObject", + "tags": [ + "getxmlobject", + "xmlstreamreader.getxmlobject" + ], + "title": "XMLStreamReader.getXMLObject" + }, + { + "id": "script-api:dw/io/XMLStreamReader#hasName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasName", + "tags": [ + "hasname", + "xmlstreamreader.hasname" + ], + "title": "XMLStreamReader.hasName" + }, + { + "id": "script-api:dw/io/XMLStreamReader#hasNext", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasNext", + "tags": [ + "hasnext", + "xmlstreamreader.hasnext" + ], + "title": "XMLStreamReader.hasNext" + }, + { + "id": "script-api:dw/io/XMLStreamReader#hasText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasText", + "tags": [ + "hastext", + "xmlstreamreader.hastext" + ], + "title": "XMLStreamReader.hasText" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isAttributeSpecified", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isAttributeSpecified", + "tags": [ + "isattributespecified", + "xmlstreamreader.isattributespecified" + ], + "title": "XMLStreamReader.isAttributeSpecified" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isCharacters", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isCharacters", + "tags": [ + "ischaracters", + "xmlstreamreader.ischaracters" + ], + "title": "XMLStreamReader.isCharacters" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isEndElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isEndElement", + "tags": [ + "isendelement", + "xmlstreamreader.isendelement" + ], + "title": "XMLStreamReader.isEndElement" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isStandalone", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isStandalone", + "tags": [ + "isstandalone", + "xmlstreamreader.isstandalone" + ], + "title": "XMLStreamReader.isStandalone" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isStartElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isStartElement", + "tags": [ + "isstartelement", + "xmlstreamreader.isstartelement" + ], + "title": "XMLStreamReader.isStartElement" + }, + { + "id": "script-api:dw/io/XMLStreamReader#isWhiteSpace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isWhiteSpace", + "tags": [ + "iswhitespace", + "xmlstreamreader.iswhitespace" + ], + "title": "XMLStreamReader.isWhiteSpace" + }, + { + "id": "script-api:dw/io/XMLStreamReader#lineNumber", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.lineNumber", + "tags": [ + "linenumber", + "xmlstreamreader.linenumber" + ], + "title": "XMLStreamReader.lineNumber" + }, + { + "id": "script-api:dw/io/XMLStreamReader#localName", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.localName", + "tags": [ + "localname", + "xmlstreamreader.localname" + ], + "title": "XMLStreamReader.localName" + }, + { + "id": "script-api:dw/io/XMLStreamReader#namespaceCount", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.namespaceCount", + "tags": [ + "namespacecount", + "xmlstreamreader.namespacecount" + ], + "title": "XMLStreamReader.namespaceCount" + }, + { + "id": "script-api:dw/io/XMLStreamReader#namespaceURI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.namespaceURI", + "tags": [ + "namespaceuri", + "xmlstreamreader.namespaceuri" + ], + "title": "XMLStreamReader.namespaceURI" + }, + { + "id": "script-api:dw/io/XMLStreamReader#next", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.next", + "tags": [ + "next", + "xmlstreamreader.next" + ], + "title": "XMLStreamReader.next" + }, + { + "id": "script-api:dw/io/XMLStreamReader#nextTag", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.nextTag", + "tags": [ + "nexttag", + "xmlstreamreader.nexttag" + ], + "title": "XMLStreamReader.nextTag" + }, + { + "id": "script-api:dw/io/XMLStreamReader#prefix", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.prefix", + "tags": [ + "prefix", + "xmlstreamreader.prefix" + ], + "title": "XMLStreamReader.prefix" + }, + { + "id": "script-api:dw/io/XMLStreamReader#readElementText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.readElementText", + "tags": [ + "readelementtext", + "xmlstreamreader.readelementtext" + ], + "title": "XMLStreamReader.readElementText" + }, + { + "id": "script-api:dw/io/XMLStreamReader#readXMLObject", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.readXMLObject", + "tags": [ + "readxmlobject", + "xmlstreamreader.readxmlobject" + ], + "title": "XMLStreamReader.readXMLObject" + }, + { + "id": "script-api:dw/io/XMLStreamReader#require", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.require", + "tags": [ + "require", + "xmlstreamreader.require" + ], + "title": "XMLStreamReader.require" + }, + { + "id": "script-api:dw/io/XMLStreamReader#standalone", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.standalone", + "tags": [ + "standalone", + "xmlstreamreader.standalone" + ], + "title": "XMLStreamReader.standalone" + }, + { + "id": "script-api:dw/io/XMLStreamReader#standaloneSet", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.standaloneSet", + "tags": [ + "standaloneset", + "xmlstreamreader.standaloneset" + ], + "title": "XMLStreamReader.standaloneSet" + }, + { + "id": "script-api:dw/io/XMLStreamReader#startElement", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.startElement", + "tags": [ + "startelement", + "xmlstreamreader.startelement" + ], + "title": "XMLStreamReader.startElement" + }, + { + "id": "script-api:dw/io/XMLStreamReader#text", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.text", + "tags": [ + "text", + "xmlstreamreader.text" + ], + "title": "XMLStreamReader.text" + }, + { + "id": "script-api:dw/io/XMLStreamReader#textLength", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.textLength", + "tags": [ + "textlength", + "xmlstreamreader.textlength" + ], + "title": "XMLStreamReader.textLength" + }, + { + "id": "script-api:dw/io/XMLStreamReader#textStart", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.textStart", + "tags": [ + "textstart", + "xmlstreamreader.textstart" + ], + "title": "XMLStreamReader.textStart" + }, + { + "id": "script-api:dw/io/XMLStreamReader#version", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.version", + "tags": [ + "version", + "xmlstreamreader.version" + ], + "title": "XMLStreamReader.version" + }, + { + "id": "script-api:dw/io/XMLStreamReader#whiteSpace", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.whiteSpace", + "tags": [ + "whitespace", + "xmlstreamreader.whitespace" + ], + "title": "XMLStreamReader.whiteSpace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamWriter", + "tags": [ + "xmlstreamwriter", + "dw.io.xmlstreamwriter", + "dw/io" + ], + "title": "XMLStreamWriter" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.close", + "tags": [ + "close", + "xmlstreamwriter.close" + ], + "title": "XMLStreamWriter.close" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#defaultNamespace", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.defaultNamespace", + "tags": [ + "defaultnamespace", + "xmlstreamwriter.defaultnamespace" + ], + "title": "XMLStreamWriter.defaultNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#flush", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.flush", + "tags": [ + "flush", + "xmlstreamwriter.flush" + ], + "title": "XMLStreamWriter.flush" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#getDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.getDefaultNamespace", + "tags": [ + "getdefaultnamespace", + "xmlstreamwriter.getdefaultnamespace" + ], + "title": "XMLStreamWriter.getDefaultNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#getPrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.getPrefix", + "tags": [ + "getprefix", + "xmlstreamwriter.getprefix" + ], + "title": "XMLStreamWriter.getPrefix" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#setDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.setDefaultNamespace", + "tags": [ + "setdefaultnamespace", + "xmlstreamwriter.setdefaultnamespace" + ], + "title": "XMLStreamWriter.setDefaultNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#setPrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.setPrefix", + "tags": [ + "setprefix", + "xmlstreamwriter.setprefix" + ], + "title": "XMLStreamWriter.setPrefix" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeCData", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeCData", + "tags": [ + "writecdata", + "xmlstreamwriter.writecdata" + ], + "title": "XMLStreamWriter.writeCData" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeCharacters", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeCharacters", + "tags": [ + "writecharacters", + "xmlstreamwriter.writecharacters" + ], + "title": "XMLStreamWriter.writeCharacters" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeComment", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeComment", + "tags": [ + "writecomment", + "xmlstreamwriter.writecomment" + ], + "title": "XMLStreamWriter.writeComment" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeDTD", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeDTD", + "tags": [ + "writedtd", + "xmlstreamwriter.writedtd" + ], + "title": "XMLStreamWriter.writeDTD" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeDefaultNamespace", + "tags": [ + "writedefaultnamespace", + "xmlstreamwriter.writedefaultnamespace" + ], + "title": "XMLStreamWriter.writeDefaultNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEndDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEndDocument", + "tags": [ + "writeenddocument", + "xmlstreamwriter.writeenddocument" + ], + "title": "XMLStreamWriter.writeEndDocument" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEndElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEndElement", + "tags": [ + "writeendelement", + "xmlstreamwriter.writeendelement" + ], + "title": "XMLStreamWriter.writeEndElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeEntityRef", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEntityRef", + "tags": [ + "writeentityref", + "xmlstreamwriter.writeentityref" + ], + "title": "XMLStreamWriter.writeEntityRef" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeNamespace", + "tags": [ + "writenamespace", + "xmlstreamwriter.writenamespace" + ], + "title": "XMLStreamWriter.writeNamespace" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeProcessingInstruction", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeProcessingInstruction", + "tags": [ + "writeprocessinginstruction", + "xmlstreamwriter.writeprocessinginstruction" + ], + "title": "XMLStreamWriter.writeProcessingInstruction" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeProcessingInstruction", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeProcessingInstruction", + "tags": [ + "writeprocessinginstruction", + "xmlstreamwriter.writeprocessinginstruction" + ], + "title": "XMLStreamWriter.writeProcessingInstruction" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeRaw", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeRaw", + "tags": [ + "writeraw", + "xmlstreamwriter.writeraw" + ], + "title": "XMLStreamWriter.writeRaw" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "id": "script-api:dw/job", + "kind": "package", + "packagePath": "dw/job", + "qualifiedName": "dw.job", + "tags": [ + "dw/job", + "dw.job" + ], + "title": "dw.job" + }, + { + "id": "script-api:dw/job/JobExecution", + "kind": "class", + "packagePath": "dw/job", + "parentId": "script-api:dw/job", + "qualifiedName": "dw.job.JobExecution", + "tags": [ + "jobexecution", + "dw.job.jobexecution", + "dw/job" + ], + "title": "JobExecution" + }, + { + "id": "script-api:dw/job/JobExecution#ID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.ID", + "tags": [ + "id", + "jobexecution.id" + ], + "title": "JobExecution.ID" + }, + { + "id": "script-api:dw/job/JobExecution#context", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.context", + "tags": [ + "context", + "jobexecution.context" + ], + "title": "JobExecution.context" + }, + { + "id": "script-api:dw/job/JobExecution#getContext", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getContext", + "tags": [ + "getcontext", + "jobexecution.getcontext" + ], + "title": "JobExecution.getContext" + }, + { + "id": "script-api:dw/job/JobExecution#getID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getID", + "tags": [ + "getid", + "jobexecution.getid" + ], + "title": "JobExecution.getID" + }, + { + "id": "script-api:dw/job/JobExecution#getJobID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getJobID", + "tags": [ + "getjobid", + "jobexecution.getjobid" + ], + "title": "JobExecution.getJobID" + }, + { + "id": "script-api:dw/job/JobExecution#jobID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.jobID", + "tags": [ + "jobid", + "jobexecution.jobid" + ], + "title": "JobExecution.jobID" + }, + { + "id": "script-api:dw/job/JobStepExecution", + "kind": "class", + "packagePath": "dw/job", + "parentId": "script-api:dw/job", + "qualifiedName": "dw.job.JobStepExecution", + "tags": [ + "jobstepexecution", + "dw.job.jobstepexecution", + "dw/job" + ], + "title": "JobStepExecution" + }, + { + "id": "script-api:dw/job/JobStepExecution#ID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.ID", + "tags": [ + "id", + "jobstepexecution.id" + ], + "title": "JobStepExecution.ID" + }, + { + "id": "script-api:dw/job/JobStepExecution#getID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getID", + "tags": [ + "getid", + "jobstepexecution.getid" + ], + "title": "JobStepExecution.getID" + }, + { + "id": "script-api:dw/job/JobStepExecution#getJobExecution", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getJobExecution", + "tags": [ + "getjobexecution", + "jobstepexecution.getjobexecution" + ], + "title": "JobStepExecution.getJobExecution" + }, + { + "id": "script-api:dw/job/JobStepExecution#getParameterValue", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getParameterValue", + "tags": [ + "getparametervalue", + "jobstepexecution.getparametervalue" + ], + "title": "JobStepExecution.getParameterValue" + }, + { + "id": "script-api:dw/job/JobStepExecution#getStepID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getStepID", + "tags": [ + "getstepid", + "jobstepexecution.getstepid" + ], + "title": "JobStepExecution.getStepID" + }, + { + "id": "script-api:dw/job/JobStepExecution#getStepTypeID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getStepTypeID", + "tags": [ + "getsteptypeid", + "jobstepexecution.getsteptypeid" + ], + "title": "JobStepExecution.getStepTypeID" + }, + { + "id": "script-api:dw/job/JobStepExecution#jobExecution", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.jobExecution", + "tags": [ + "jobexecution", + "jobstepexecution.jobexecution" + ], + "title": "JobStepExecution.jobExecution" + }, + { + "id": "script-api:dw/job/JobStepExecution#stepID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.stepID", + "tags": [ + "stepid", + "jobstepexecution.stepid" + ], + "title": "JobStepExecution.stepID" + }, + { + "id": "script-api:dw/job/JobStepExecution#stepTypeID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.stepTypeID", + "tags": [ + "steptypeid", + "jobstepexecution.steptypeid" + ], + "title": "JobStepExecution.stepTypeID" + }, + { + "id": "script-api:dw/net", + "kind": "package", + "packagePath": "dw/net", + "qualifiedName": "dw.net", + "tags": [ + "dw/net", + "dw.net" + ], + "title": "dw.net" + }, + { + "id": "script-api:dw/net/FTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.FTPClient", + "tags": [ + "ftpclient", + "dw.net.ftpclient", + "dw/net" + ], + "title": "FTPClient" + }, + { + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "ftpclient.default_get_file_size" + ], + "title": "FTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "ftpclient.default_get_file_size" + ], + "title": "FTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_STRING_SIZE", + "tags": [ + "default_get_string_size", + "ftpclient.default_get_string_size" + ], + "title": "FTPClient.DEFAULT_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_STRING_SIZE", + "tags": [ + "default_get_string_size", + "ftpclient.default_get_string_size" + ], + "title": "FTPClient.DEFAULT_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "ftpclient.max_get_file_size" + ], + "title": "FTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "ftpclient.max_get_file_size" + ], + "title": "FTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "ftpclient.max_get_string_size" + ], + "title": "FTPClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "ftpclient.max_get_string_size" + ], + "title": "FTPClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/FTPClient#cd", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.cd", + "tags": [ + "cd", + "ftpclient.cd" + ], + "title": "FTPClient.cd" + }, + { + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "id": "script-api:dw/net/FTPClient#connected", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connected", + "tags": [ + "connected", + "ftpclient.connected" + ], + "title": "FTPClient.connected" + }, + { + "id": "script-api:dw/net/FTPClient#del", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.del", + "tags": [ + "del", + "ftpclient.del" + ], + "title": "FTPClient.del" + }, + { + "id": "script-api:dw/net/FTPClient#disconnect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.disconnect", + "tags": [ + "disconnect", + "ftpclient.disconnect" + ], + "title": "FTPClient.disconnect" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "id": "script-api:dw/net/FTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getBinary", + "tags": [ + "getbinary", + "ftpclient.getbinary" + ], + "title": "FTPClient.getBinary" + }, + { + "id": "script-api:dw/net/FTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getBinary", + "tags": [ + "getbinary", + "ftpclient.getbinary" + ], + "title": "FTPClient.getBinary" + }, + { + "id": "script-api:dw/net/FTPClient#getConnected", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getConnected", + "tags": [ + "getconnected", + "ftpclient.getconnected" + ], + "title": "FTPClient.getConnected" + }, + { + "id": "script-api:dw/net/FTPClient#getReplyCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getReplyCode", + "tags": [ + "getreplycode", + "ftpclient.getreplycode" + ], + "title": "FTPClient.getReplyCode" + }, + { + "id": "script-api:dw/net/FTPClient#getReplyMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getReplyMessage", + "tags": [ + "getreplymessage", + "ftpclient.getreplymessage" + ], + "title": "FTPClient.getReplyMessage" + }, + { + "id": "script-api:dw/net/FTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getTimeout", + "tags": [ + "gettimeout", + "ftpclient.gettimeout" + ], + "title": "FTPClient.getTimeout" + }, + { + "id": "script-api:dw/net/FTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.list", + "tags": [ + "list", + "ftpclient.list" + ], + "title": "FTPClient.list" + }, + { + "id": "script-api:dw/net/FTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.list", + "tags": [ + "list", + "ftpclient.list" + ], + "title": "FTPClient.list" + }, + { + "id": "script-api:dw/net/FTPClient#mkdir", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.mkdir", + "tags": [ + "mkdir", + "ftpclient.mkdir" + ], + "title": "FTPClient.mkdir" + }, + { + "id": "script-api:dw/net/FTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.put", + "tags": [ + "put", + "ftpclient.put" + ], + "title": "FTPClient.put" + }, + { + "id": "script-api:dw/net/FTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.put", + "tags": [ + "put", + "ftpclient.put" + ], + "title": "FTPClient.put" + }, + { + "id": "script-api:dw/net/FTPClient#putBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.putBinary", + "tags": [ + "putbinary", + "ftpclient.putbinary" + ], + "title": "FTPClient.putBinary" + }, + { + "id": "script-api:dw/net/FTPClient#removeDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.removeDirectory", + "tags": [ + "removedirectory", + "ftpclient.removedirectory" + ], + "title": "FTPClient.removeDirectory" + }, + { + "id": "script-api:dw/net/FTPClient#rename", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.rename", + "tags": [ + "rename", + "ftpclient.rename" + ], + "title": "FTPClient.rename" + }, + { + "id": "script-api:dw/net/FTPClient#replyCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.replyCode", + "tags": [ + "replycode", + "ftpclient.replycode" + ], + "title": "FTPClient.replyCode" + }, + { + "id": "script-api:dw/net/FTPClient#replyMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.replyMessage", + "tags": [ + "replymessage", + "ftpclient.replymessage" + ], + "title": "FTPClient.replyMessage" + }, + { + "id": "script-api:dw/net/FTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.setTimeout", + "tags": [ + "settimeout", + "ftpclient.settimeout" + ], + "title": "FTPClient.setTimeout" + }, + { + "id": "script-api:dw/net/FTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.timeout", + "tags": [ + "timeout", + "ftpclient.timeout" + ], + "title": "FTPClient.timeout" + }, + { + "id": "script-api:dw/net/FTPFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.FTPFileInfo", + "tags": [ + "ftpfileinfo", + "dw.net.ftpfileinfo", + "dw/net" + ], + "title": "FTPFileInfo" + }, + { + "id": "script-api:dw/net/FTPFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.directory", + "tags": [ + "directory", + "ftpfileinfo.directory" + ], + "title": "FTPFileInfo.directory" + }, + { + "id": "script-api:dw/net/FTPFileInfo#getDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getDirectory", + "tags": [ + "getdirectory", + "ftpfileinfo.getdirectory" + ], + "title": "FTPFileInfo.getDirectory" + }, + { + "id": "script-api:dw/net/FTPFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getName", + "tags": [ + "getname", + "ftpfileinfo.getname" + ], + "title": "FTPFileInfo.getName" + }, + { + "id": "script-api:dw/net/FTPFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getSize", + "tags": [ + "getsize", + "ftpfileinfo.getsize" + ], + "title": "FTPFileInfo.getSize" + }, + { + "id": "script-api:dw/net/FTPFileInfo#getTimestamp", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getTimestamp", + "tags": [ + "gettimestamp", + "ftpfileinfo.gettimestamp" + ], + "title": "FTPFileInfo.getTimestamp" + }, + { + "id": "script-api:dw/net/FTPFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.name", + "tags": [ + "name", + "ftpfileinfo.name" + ], + "title": "FTPFileInfo.name" + }, + { + "id": "script-api:dw/net/FTPFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.size", + "tags": [ + "size", + "ftpfileinfo.size" + ], + "title": "FTPFileInfo.size" + }, + { + "id": "script-api:dw/net/FTPFileInfo#timestamp", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.timestamp", + "tags": [ + "timestamp", + "ftpfileinfo.timestamp" + ], + "title": "FTPFileInfo.timestamp" + }, + { + "id": "script-api:dw/net/HTTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPClient", + "tags": [ + "httpclient", + "dw.net.httpclient", + "dw/net" + ], + "title": "HTTPClient" + }, + { + "id": "script-api:dw/net/HTTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "httpclient.default_get_file_size" + ], + "title": "HTTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "httpclient.default_get_file_size" + ], + "title": "HTTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "httpclient.max_get_file_size" + ], + "title": "HTTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "httpclient.max_get_file_size" + ], + "title": "HTTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#MAX_GET_MEM_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_MEM_SIZE", + "tags": [ + "max_get_mem_size", + "httpclient.max_get_mem_size" + ], + "title": "HTTPClient.MAX_GET_MEM_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#MAX_GET_MEM_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_MEM_SIZE", + "tags": [ + "max_get_mem_size", + "httpclient.max_get_mem_size" + ], + "title": "HTTPClient.MAX_GET_MEM_SIZE" + }, + { + "id": "script-api:dw/net/HTTPClient#allResponseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.allResponseHeaders", + "tags": [ + "allresponseheaders", + "httpclient.allresponseheaders" + ], + "title": "HTTPClient.allResponseHeaders" + }, + { + "id": "script-api:dw/net/HTTPClient#allowRedirect", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.allowRedirect", + "tags": [ + "allowredirect", + "httpclient.allowredirect" + ], + "title": "HTTPClient.allowRedirect" + }, + { + "id": "script-api:dw/net/HTTPClient#bytes", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.bytes", + "tags": [ + "bytes", + "httpclient.bytes" + ], + "title": "HTTPClient.bytes" + }, + { + "id": "script-api:dw/net/HTTPClient#enableCaching", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.enableCaching", + "tags": [ + "enablecaching", + "httpclient.enablecaching" + ], + "title": "HTTPClient.enableCaching" + }, + { + "id": "script-api:dw/net/HTTPClient#errorBytes", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.errorBytes", + "tags": [ + "errorbytes", + "httpclient.errorbytes" + ], + "title": "HTTPClient.errorBytes" + }, + { + "id": "script-api:dw/net/HTTPClient#errorText", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.errorText", + "tags": [ + "errortext", + "httpclient.errortext" + ], + "title": "HTTPClient.errorText" + }, + { + "id": "script-api:dw/net/HTTPClient#getAllResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getAllResponseHeaders", + "tags": [ + "getallresponseheaders", + "httpclient.getallresponseheaders" + ], + "title": "HTTPClient.getAllResponseHeaders" + }, + { + "id": "script-api:dw/net/HTTPClient#getAllowRedirect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getAllowRedirect", + "tags": [ + "getallowredirect", + "httpclient.getallowredirect" + ], + "title": "HTTPClient.getAllowRedirect" + }, + { + "id": "script-api:dw/net/HTTPClient#getBytes", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getBytes", + "tags": [ + "getbytes", + "httpclient.getbytes" + ], + "title": "HTTPClient.getBytes" + }, + { + "id": "script-api:dw/net/HTTPClient#getErrorBytes", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getErrorBytes", + "tags": [ + "geterrorbytes", + "httpclient.geterrorbytes" + ], + "title": "HTTPClient.getErrorBytes" + }, + { + "id": "script-api:dw/net/HTTPClient#getErrorText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getErrorText", + "tags": [ + "geterrortext", + "httpclient.geterrortext" + ], + "title": "HTTPClient.getErrorText" + }, + { + "id": "script-api:dw/net/HTTPClient#getHostNameVerification", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getHostNameVerification", + "tags": [ + "gethostnameverification", + "httpclient.gethostnameverification" + ], + "title": "HTTPClient.getHostNameVerification" + }, + { + "id": "script-api:dw/net/HTTPClient#getIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getIdentity", + "tags": [ + "getidentity", + "httpclient.getidentity" + ], + "title": "HTTPClient.getIdentity" + }, + { + "id": "script-api:dw/net/HTTPClient#getLoggingConfig", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getLoggingConfig", + "tags": [ + "getloggingconfig", + "httpclient.getloggingconfig" + ], + "title": "HTTPClient.getLoggingConfig" + }, + { + "id": "script-api:dw/net/HTTPClient#getResponseHeader", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeader", + "tags": [ + "getresponseheader", + "httpclient.getresponseheader" + ], + "title": "HTTPClient.getResponseHeader" + }, + { + "id": "script-api:dw/net/HTTPClient#getResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeaders", + "tags": [ + "getresponseheaders", + "httpclient.getresponseheaders" + ], + "title": "HTTPClient.getResponseHeaders" + }, + { + "id": "script-api:dw/net/HTTPClient#getResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeaders", + "tags": [ + "getresponseheaders", + "httpclient.getresponseheaders" + ], + "title": "HTTPClient.getResponseHeaders" + }, + { + "id": "script-api:dw/net/HTTPClient#getStatusCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getStatusCode", + "tags": [ + "getstatuscode", + "httpclient.getstatuscode" + ], + "title": "HTTPClient.getStatusCode" + }, + { + "id": "script-api:dw/net/HTTPClient#getStatusMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getStatusMessage", + "tags": [ + "getstatusmessage", + "httpclient.getstatusmessage" + ], + "title": "HTTPClient.getStatusMessage" + }, + { + "id": "script-api:dw/net/HTTPClient#getText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getText", + "tags": [ + "gettext", + "httpclient.gettext" + ], + "title": "HTTPClient.getText" + }, + { + "id": "script-api:dw/net/HTTPClient#getText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getText", + "tags": [ + "gettext", + "httpclient.gettext" + ], + "title": "HTTPClient.getText" + }, + { + "id": "script-api:dw/net/HTTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getTimeout", + "tags": [ + "gettimeout", + "httpclient.gettimeout" + ], + "title": "HTTPClient.getTimeout" + }, + { + "id": "script-api:dw/net/HTTPClient#hostNameVerification", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.hostNameVerification", + "tags": [ + "hostnameverification", + "httpclient.hostnameverification" + ], + "title": "HTTPClient.hostNameVerification" + }, + { + "id": "script-api:dw/net/HTTPClient#identity", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.identity", + "tags": [ + "identity", + "httpclient.identity" + ], + "title": "HTTPClient.identity" + }, + { + "id": "script-api:dw/net/HTTPClient#loggingConfig", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.loggingConfig", + "tags": [ + "loggingconfig", + "httpclient.loggingconfig" + ], + "title": "HTTPClient.loggingConfig" + }, + { + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "id": "script-api:dw/net/HTTPClient#responseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.responseHeaders", + "tags": [ + "responseheaders", + "httpclient.responseheaders" + ], + "title": "HTTPClient.responseHeaders" + }, + { + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "id": "script-api:dw/net/HTTPClient#sendBytes", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendBytes", + "tags": [ + "sendbytes", + "httpclient.sendbytes" + ], + "title": "HTTPClient.sendBytes" + }, + { + "id": "script-api:dw/net/HTTPClient#sendBytesAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendBytesAndReceiveToFile", + "tags": [ + "sendbytesandreceivetofile", + "httpclient.sendbytesandreceivetofile" + ], + "title": "HTTPClient.sendBytesAndReceiveToFile" + }, + { + "id": "script-api:dw/net/HTTPClient#sendMultiPart", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendMultiPart", + "tags": [ + "sendmultipart", + "httpclient.sendmultipart" + ], + "title": "HTTPClient.sendMultiPart" + }, + { + "id": "script-api:dw/net/HTTPClient#setAllowRedirect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setAllowRedirect", + "tags": [ + "setallowredirect", + "httpclient.setallowredirect" + ], + "title": "HTTPClient.setAllowRedirect" + }, + { + "id": "script-api:dw/net/HTTPClient#setHostNameVerification", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setHostNameVerification", + "tags": [ + "sethostnameverification", + "httpclient.sethostnameverification" + ], + "title": "HTTPClient.setHostNameVerification" + }, + { + "id": "script-api:dw/net/HTTPClient#setIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setIdentity", + "tags": [ + "setidentity", + "httpclient.setidentity" + ], + "title": "HTTPClient.setIdentity" + }, + { + "id": "script-api:dw/net/HTTPClient#setLoggingConfig", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setLoggingConfig", + "tags": [ + "setloggingconfig", + "httpclient.setloggingconfig" + ], + "title": "HTTPClient.setLoggingConfig" + }, + { + "id": "script-api:dw/net/HTTPClient#setRequestHeader", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setRequestHeader", + "tags": [ + "setrequestheader", + "httpclient.setrequestheader" + ], + "title": "HTTPClient.setRequestHeader" + }, + { + "id": "script-api:dw/net/HTTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setTimeout", + "tags": [ + "settimeout", + "httpclient.settimeout" + ], + "title": "HTTPClient.setTimeout" + }, + { + "id": "script-api:dw/net/HTTPClient#statusCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.statusCode", + "tags": [ + "statuscode", + "httpclient.statuscode" + ], + "title": "HTTPClient.statusCode" + }, + { + "id": "script-api:dw/net/HTTPClient#statusMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.statusMessage", + "tags": [ + "statusmessage", + "httpclient.statusmessage" + ], + "title": "HTTPClient.statusMessage" + }, + { + "id": "script-api:dw/net/HTTPClient#text", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.text", + "tags": [ + "text", + "httpclient.text" + ], + "title": "HTTPClient.text" + }, + { + "id": "script-api:dw/net/HTTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.timeout", + "tags": [ + "timeout", + "httpclient.timeout" + ], + "title": "HTTPClient.timeout" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPClientLoggingConfig", + "tags": [ + "httpclientloggingconfig", + "dw.net.httpclientloggingconfig", + "dw/net" + ], + "title": "HTTPClientLoggingConfig" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#enabled", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.enabled", + "tags": [ + "enabled", + "httpclientloggingconfig.enabled" + ], + "title": "HTTPClientLoggingConfig.enabled" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#getLevel", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getLevel", + "tags": [ + "getlevel", + "httpclientloggingconfig.getlevel" + ], + "title": "HTTPClientLoggingConfig.getLevel" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveBodyFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveBodyFields", + "tags": [ + "getsensitivebodyfields", + "httpclientloggingconfig.getsensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveBodyFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveHeaders", + "tags": [ + "getsensitiveheaders", + "httpclientloggingconfig.getsensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.getSensitiveHeaders" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveJsonFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveJsonFields", + "tags": [ + "getsensitivejsonfields", + "httpclientloggingconfig.getsensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveJsonFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveXmlFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveXmlFields", + "tags": [ + "getsensitivexmlfields", + "httpclientloggingconfig.getsensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveXmlFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#isEnabled", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.isEnabled", + "tags": [ + "isenabled", + "httpclientloggingconfig.isenabled" + ], + "title": "HTTPClientLoggingConfig.isEnabled" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#level", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.level", + "tags": [ + "level", + "httpclientloggingconfig.level" + ], + "title": "HTTPClientLoggingConfig.level" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveBodyFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveBodyFields", + "tags": [ + "sensitivebodyfields", + "httpclientloggingconfig.sensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveBodyFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveHeaders", + "tags": [ + "sensitiveheaders", + "httpclientloggingconfig.sensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.sensitiveHeaders" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveJsonFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveJsonFields", + "tags": [ + "sensitivejsonfields", + "httpclientloggingconfig.sensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveJsonFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveXmlFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveXmlFields", + "tags": [ + "sensitivexmlfields", + "httpclientloggingconfig.sensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveXmlFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setEnabled", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setEnabled", + "tags": [ + "setenabled", + "httpclientloggingconfig.setenabled" + ], + "title": "HTTPClientLoggingConfig.setEnabled" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setLevel", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setLevel", + "tags": [ + "setlevel", + "httpclientloggingconfig.setlevel" + ], + "title": "HTTPClientLoggingConfig.setLevel" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveBodyFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveBodyFields", + "tags": [ + "setsensitivebodyfields", + "httpclientloggingconfig.setsensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveBodyFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveHeaders", + "tags": [ + "setsensitiveheaders", + "httpclientloggingconfig.setsensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.setSensitiveHeaders" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveJsonFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveJsonFields", + "tags": [ + "setsensitivejsonfields", + "httpclientloggingconfig.setsensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveJsonFields" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveTextPatterns", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveTextPatterns", + "tags": [ + "setsensitivetextpatterns", + "httpclientloggingconfig.setsensitivetextpatterns" + ], + "title": "HTTPClientLoggingConfig.setSensitiveTextPatterns" + }, + { + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveXmlFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveXmlFields", + "tags": [ + "setsensitivexmlfields", + "httpclientloggingconfig.setsensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveXmlFields" + }, + { + "id": "script-api:dw/net/HTTPRequestPart", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPRequestPart", + "tags": [ + "httprequestpart", + "dw.net.httprequestpart", + "dw/net" + ], + "title": "HTTPRequestPart" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#bytesValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.bytesValue", + "tags": [ + "bytesvalue", + "httprequestpart.bytesvalue" + ], + "title": "HTTPRequestPart.bytesValue" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#contentType", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.contentType", + "tags": [ + "contenttype", + "httprequestpart.contenttype" + ], + "title": "HTTPRequestPart.contentType" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#encoding", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.encoding", + "tags": [ + "encoding", + "httprequestpart.encoding" + ], + "title": "HTTPRequestPart.encoding" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#fileName", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.fileName", + "tags": [ + "filename", + "httprequestpart.filename" + ], + "title": "HTTPRequestPart.fileName" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#fileValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.fileValue", + "tags": [ + "filevalue", + "httprequestpart.filevalue" + ], + "title": "HTTPRequestPart.fileValue" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getBytesValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getBytesValue", + "tags": [ + "getbytesvalue", + "httprequestpart.getbytesvalue" + ], + "title": "HTTPRequestPart.getBytesValue" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getContentType", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getContentType", + "tags": [ + "getcontenttype", + "httprequestpart.getcontenttype" + ], + "title": "HTTPRequestPart.getContentType" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getEncoding", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getEncoding", + "tags": [ + "getencoding", + "httprequestpart.getencoding" + ], + "title": "HTTPRequestPart.getEncoding" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getFileName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getFileName", + "tags": [ + "getfilename", + "httprequestpart.getfilename" + ], + "title": "HTTPRequestPart.getFileName" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getFileValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getFileValue", + "tags": [ + "getfilevalue", + "httprequestpart.getfilevalue" + ], + "title": "HTTPRequestPart.getFileValue" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getName", + "tags": [ + "getname", + "httprequestpart.getname" + ], + "title": "HTTPRequestPart.getName" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#getStringValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getStringValue", + "tags": [ + "getstringvalue", + "httprequestpart.getstringvalue" + ], + "title": "HTTPRequestPart.getStringValue" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.name", + "tags": [ + "name", + "httprequestpart.name" + ], + "title": "HTTPRequestPart.name" + }, + { + "id": "script-api:dw/net/HTTPRequestPart#stringValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.stringValue", + "tags": [ + "stringvalue", + "httprequestpart.stringvalue" + ], + "title": "HTTPRequestPart.stringValue" + }, + { + "id": "script-api:dw/net/Mail", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.Mail", + "tags": [ + "mail", + "dw.net.mail", + "dw/net" + ], + "title": "Mail" + }, + { + "id": "script-api:dw/net/Mail#addAttachment", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addAttachment", + "tags": [ + "addattachment", + "mail.addattachment" + ], + "title": "Mail.addAttachment" + }, + { + "id": "script-api:dw/net/Mail#addBcc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addBcc", + "tags": [ + "addbcc", + "mail.addbcc" + ], + "title": "Mail.addBcc" + }, + { + "id": "script-api:dw/net/Mail#addCc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addCc", + "tags": [ + "addcc", + "mail.addcc" + ], + "title": "Mail.addCc" + }, + { + "id": "script-api:dw/net/Mail#addReplyTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addReplyTo", + "tags": [ + "addreplyto", + "mail.addreplyto" + ], + "title": "Mail.addReplyTo" + }, + { + "id": "script-api:dw/net/Mail#addTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addTo", + "tags": [ + "addto", + "mail.addto" + ], + "title": "Mail.addTo" + }, + { + "id": "script-api:dw/net/Mail#bcc", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.bcc", + "tags": [ + "bcc", + "mail.bcc" + ], + "title": "Mail.bcc" + }, + { + "id": "script-api:dw/net/Mail#cc", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.cc", + "tags": [ + "cc", + "mail.cc" + ], + "title": "Mail.cc" + }, + { + "id": "script-api:dw/net/Mail#from", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.from", + "tags": [ + "from", + "mail.from" + ], + "title": "Mail.from" + }, + { + "id": "script-api:dw/net/Mail#getBcc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getBcc", + "tags": [ + "getbcc", + "mail.getbcc" + ], + "title": "Mail.getBcc" + }, + { + "id": "script-api:dw/net/Mail#getCc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getCc", + "tags": [ + "getcc", + "mail.getcc" + ], + "title": "Mail.getCc" + }, + { + "id": "script-api:dw/net/Mail#getFrom", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getFrom", + "tags": [ + "getfrom", + "mail.getfrom" + ], + "title": "Mail.getFrom" + }, + { + "id": "script-api:dw/net/Mail#getReplyTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getReplyTo", + "tags": [ + "getreplyto", + "mail.getreplyto" + ], + "title": "Mail.getReplyTo" + }, + { + "id": "script-api:dw/net/Mail#getSubject", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getSubject", + "tags": [ + "getsubject", + "mail.getsubject" + ], + "title": "Mail.getSubject" + }, + { + "id": "script-api:dw/net/Mail#getTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getTo", + "tags": [ + "getto", + "mail.getto" + ], + "title": "Mail.getTo" + }, + { + "id": "script-api:dw/net/Mail#replyTo", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.replyTo", + "tags": [ + "replyto", + "mail.replyto" + ], + "title": "Mail.replyTo" + }, + { + "id": "script-api:dw/net/Mail#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.send", + "tags": [ + "send", + "mail.send" + ], + "title": "Mail.send" + }, + { + "id": "script-api:dw/net/Mail#setBcc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setBcc", + "tags": [ + "setbcc", + "mail.setbcc" + ], + "title": "Mail.setBcc" + }, + { + "id": "script-api:dw/net/Mail#setCc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setCc", + "tags": [ + "setcc", + "mail.setcc" + ], + "title": "Mail.setCc" + }, + { + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "id": "script-api:dw/net/Mail#setFrom", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setFrom", + "tags": [ + "setfrom", + "mail.setfrom" + ], + "title": "Mail.setFrom" + }, + { + "id": "script-api:dw/net/Mail#setListUnsubscribe", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setListUnsubscribe", + "tags": [ + "setlistunsubscribe", + "mail.setlistunsubscribe" + ], + "title": "Mail.setListUnsubscribe" + }, + { + "id": "script-api:dw/net/Mail#setListUnsubscribePost", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setListUnsubscribePost", + "tags": [ + "setlistunsubscribepost", + "mail.setlistunsubscribepost" + ], + "title": "Mail.setListUnsubscribePost" + }, + { + "id": "script-api:dw/net/Mail#setSubject", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setSubject", + "tags": [ + "setsubject", + "mail.setsubject" + ], + "title": "Mail.setSubject" + }, + { + "id": "script-api:dw/net/Mail#setTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setTo", + "tags": [ + "setto", + "mail.setto" + ], + "title": "Mail.setTo" + }, + { + "id": "script-api:dw/net/Mail#subject", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.subject", + "tags": [ + "subject", + "mail.subject" + ], + "title": "Mail.subject" + }, + { + "id": "script-api:dw/net/Mail#to", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.to", + "tags": [ + "to", + "mail.to" + ], + "title": "Mail.to" + }, + { + "id": "script-api:dw/net/Mail#validateAddress", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.validateAddress", + "tags": [ + "validateaddress", + "mail.validateaddress" + ], + "title": "Mail.validateAddress" + }, + { + "id": "script-api:dw/net/Mail#validateAddress", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.validateAddress", + "tags": [ + "validateaddress", + "mail.validateaddress" + ], + "title": "Mail.validateAddress" + }, + { + "id": "script-api:dw/net/SFTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.SFTPClient", + "tags": [ + "sftpclient", + "dw.net.sftpclient", + "dw/net" + ], + "title": "SFTPClient" + }, + { + "id": "script-api:dw/net/SFTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "sftpclient.max_get_file_size" + ], + "title": "SFTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/SFTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "sftpclient.max_get_file_size" + ], + "title": "SFTPClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/SFTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "sftpclient.max_get_string_size" + ], + "title": "SFTPClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/SFTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "sftpclient.max_get_string_size" + ], + "title": "SFTPClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/SFTPClient#addKnownHostKey", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.addKnownHostKey", + "tags": [ + "addknownhostkey", + "sftpclient.addknownhostkey" + ], + "title": "SFTPClient.addKnownHostKey" + }, + { + "id": "script-api:dw/net/SFTPClient#cd", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.cd", + "tags": [ + "cd", + "sftpclient.cd" + ], + "title": "SFTPClient.cd" + }, + { + "id": "script-api:dw/net/SFTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connect", + "tags": [ + "connect", + "sftpclient.connect" + ], + "title": "SFTPClient.connect" + }, + { + "id": "script-api:dw/net/SFTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connect", + "tags": [ + "connect", + "sftpclient.connect" + ], + "title": "SFTPClient.connect" + }, + { + "id": "script-api:dw/net/SFTPClient#connected", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connected", + "tags": [ + "connected", + "sftpclient.connected" + ], + "title": "SFTPClient.connected" + }, + { + "id": "script-api:dw/net/SFTPClient#del", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.del", + "tags": [ + "del", + "sftpclient.del" + ], + "title": "SFTPClient.del" + }, + { + "id": "script-api:dw/net/SFTPClient#disconnect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.disconnect", + "tags": [ + "disconnect", + "sftpclient.disconnect" + ], + "title": "SFTPClient.disconnect" + }, + { + "id": "script-api:dw/net/SFTPClient#errorMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.errorMessage", + "tags": [ + "errormessage", + "sftpclient.errormessage" + ], + "title": "SFTPClient.errorMessage" + }, + { + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "id": "script-api:dw/net/SFTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getBinary", + "tags": [ + "getbinary", + "sftpclient.getbinary" + ], + "title": "SFTPClient.getBinary" + }, + { + "id": "script-api:dw/net/SFTPClient#getConnected", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getConnected", + "tags": [ + "getconnected", + "sftpclient.getconnected" + ], + "title": "SFTPClient.getConnected" + }, + { + "id": "script-api:dw/net/SFTPClient#getErrorMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getErrorMessage", + "tags": [ + "geterrormessage", + "sftpclient.geterrormessage" + ], + "title": "SFTPClient.getErrorMessage" + }, + { + "id": "script-api:dw/net/SFTPClient#getFileInfo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getFileInfo", + "tags": [ + "getfileinfo", + "sftpclient.getfileinfo" + ], + "title": "SFTPClient.getFileInfo" + }, + { + "id": "script-api:dw/net/SFTPClient#getIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getIdentity", + "tags": [ + "getidentity", + "sftpclient.getidentity" + ], + "title": "SFTPClient.getIdentity" + }, + { + "id": "script-api:dw/net/SFTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getTimeout", + "tags": [ + "gettimeout", + "sftpclient.gettimeout" + ], + "title": "SFTPClient.getTimeout" + }, + { + "id": "script-api:dw/net/SFTPClient#identity", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.identity", + "tags": [ + "identity", + "sftpclient.identity" + ], + "title": "SFTPClient.identity" + }, + { + "id": "script-api:dw/net/SFTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.list", + "tags": [ + "list", + "sftpclient.list" + ], + "title": "SFTPClient.list" + }, + { + "id": "script-api:dw/net/SFTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.list", + "tags": [ + "list", + "sftpclient.list" + ], + "title": "SFTPClient.list" + }, + { + "id": "script-api:dw/net/SFTPClient#mkdir", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.mkdir", + "tags": [ + "mkdir", + "sftpclient.mkdir" + ], + "title": "SFTPClient.mkdir" + }, + { + "id": "script-api:dw/net/SFTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.put", + "tags": [ + "put", + "sftpclient.put" + ], + "title": "SFTPClient.put" + }, + { + "id": "script-api:dw/net/SFTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.put", + "tags": [ + "put", + "sftpclient.put" + ], + "title": "SFTPClient.put" + }, + { + "id": "script-api:dw/net/SFTPClient#putBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.putBinary", + "tags": [ + "putbinary", + "sftpclient.putbinary" + ], + "title": "SFTPClient.putBinary" + }, + { + "id": "script-api:dw/net/SFTPClient#removeDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.removeDirectory", + "tags": [ + "removedirectory", + "sftpclient.removedirectory" + ], + "title": "SFTPClient.removeDirectory" + }, + { + "id": "script-api:dw/net/SFTPClient#rename", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.rename", + "tags": [ + "rename", + "sftpclient.rename" + ], + "title": "SFTPClient.rename" + }, + { + "id": "script-api:dw/net/SFTPClient#setIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.setIdentity", + "tags": [ + "setidentity", + "sftpclient.setidentity" + ], + "title": "SFTPClient.setIdentity" + }, + { + "id": "script-api:dw/net/SFTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.setTimeout", + "tags": [ + "settimeout", + "sftpclient.settimeout" + ], + "title": "SFTPClient.setTimeout" + }, + { + "id": "script-api:dw/net/SFTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.timeout", + "tags": [ + "timeout", + "sftpclient.timeout" + ], + "title": "SFTPClient.timeout" + }, + { + "id": "script-api:dw/net/SFTPFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.SFTPFileInfo", + "tags": [ + "sftpfileinfo", + "dw.net.sftpfileinfo", + "dw/net" + ], + "title": "SFTPFileInfo" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.directory", + "tags": [ + "directory", + "sftpfileinfo.directory" + ], + "title": "SFTPFileInfo.directory" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#getDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getDirectory", + "tags": [ + "getdirectory", + "sftpfileinfo.getdirectory" + ], + "title": "SFTPFileInfo.getDirectory" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#getModificationTime", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getModificationTime", + "tags": [ + "getmodificationtime", + "sftpfileinfo.getmodificationtime" + ], + "title": "SFTPFileInfo.getModificationTime" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getName", + "tags": [ + "getname", + "sftpfileinfo.getname" + ], + "title": "SFTPFileInfo.getName" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getSize", + "tags": [ + "getsize", + "sftpfileinfo.getsize" + ], + "title": "SFTPFileInfo.getSize" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#modificationTime", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.modificationTime", + "tags": [ + "modificationtime", + "sftpfileinfo.modificationtime" + ], + "title": "SFTPFileInfo.modificationTime" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.name", + "tags": [ + "name", + "sftpfileinfo.name" + ], + "title": "SFTPFileInfo.name" + }, + { + "id": "script-api:dw/net/SFTPFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.size", + "tags": [ + "size", + "sftpfileinfo.size" + ], + "title": "SFTPFileInfo.size" + }, + { + "id": "script-api:dw/net/WebDAVClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.WebDAVClient", + "tags": [ + "webdavclient", + "dw.net.webdavclient", + "dw/net" + ], + "title": "WebDAVClient" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_ENCODING", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_ENCODING", + "tags": [ + "default_encoding", + "webdavclient.default_encoding" + ], + "title": "WebDAVClient.DEFAULT_ENCODING" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_ENCODING", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_ENCODING", + "tags": [ + "default_encoding", + "webdavclient.default_encoding" + ], + "title": "WebDAVClient.DEFAULT_ENCODING" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "webdavclient.default_get_file_size" + ], + "title": "WebDAVClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_FILE_SIZE", + "tags": [ + "default_get_file_size", + "webdavclient.default_get_file_size" + ], + "title": "WebDAVClient.DEFAULT_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_STRING_SIZE", + "tags": [ + "default_get_string_size", + "webdavclient.default_get_string_size" + ], + "title": "WebDAVClient.DEFAULT_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_STRING_SIZE", + "tags": [ + "default_get_string_size", + "webdavclient.default_get_string_size" + ], + "title": "WebDAVClient.DEFAULT_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_0", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_0", + "tags": [ + "depth_0", + "webdavclient.depth_0" + ], + "title": "WebDAVClient.DEPTH_0" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_0", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_0", + "tags": [ + "depth_0", + "webdavclient.depth_0" + ], + "title": "WebDAVClient.DEPTH_0" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_1", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_1", + "tags": [ + "depth_1", + "webdavclient.depth_1" + ], + "title": "WebDAVClient.DEPTH_1" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_1", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_1", + "tags": [ + "depth_1", + "webdavclient.depth_1" + ], + "title": "WebDAVClient.DEPTH_1" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_INIFINITY", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_INIFINITY", + "tags": [ + "depth_inifinity", + "webdavclient.depth_inifinity" + ], + "title": "WebDAVClient.DEPTH_INIFINITY" + }, + { + "id": "script-api:dw/net/WebDAVClient#DEPTH_INIFINITY", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_INIFINITY", + "tags": [ + "depth_inifinity", + "webdavclient.depth_inifinity" + ], + "title": "WebDAVClient.DEPTH_INIFINITY" + }, + { + "id": "script-api:dw/net/WebDAVClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "webdavclient.max_get_file_size" + ], + "title": "WebDAVClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_FILE_SIZE", + "tags": [ + "max_get_file_size", + "webdavclient.max_get_file_size" + ], + "title": "WebDAVClient.MAX_GET_FILE_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#MAX_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "webdavclient.max_get_string_size" + ], + "title": "WebDAVClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#MAX_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_STRING_SIZE", + "tags": [ + "max_get_string_size", + "webdavclient.max_get_string_size" + ], + "title": "WebDAVClient.MAX_GET_STRING_SIZE" + }, + { + "id": "script-api:dw/net/WebDAVClient#addRequestHeader", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.addRequestHeader", + "tags": [ + "addrequestheader", + "webdavclient.addrequestheader" + ], + "title": "WebDAVClient.addRequestHeader" + }, + { + "id": "script-api:dw/net/WebDAVClient#allResponseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.allResponseHeaders", + "tags": [ + "allresponseheaders", + "webdavclient.allresponseheaders" + ], + "title": "WebDAVClient.allResponseHeaders" + }, + { + "id": "script-api:dw/net/WebDAVClient#close", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.close", + "tags": [ + "close", + "webdavclient.close" + ], + "title": "WebDAVClient.close" + }, + { + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "id": "script-api:dw/net/WebDAVClient#del", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.del", + "tags": [ + "del", + "webdavclient.del" + ], + "title": "WebDAVClient.del" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "id": "script-api:dw/net/WebDAVClient#getAllResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getAllResponseHeaders", + "tags": [ + "getallresponseheaders", + "webdavclient.getallresponseheaders" + ], + "title": "WebDAVClient.getAllResponseHeaders" + }, + { + "id": "script-api:dw/net/WebDAVClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getBinary", + "tags": [ + "getbinary", + "webdavclient.getbinary" + ], + "title": "WebDAVClient.getBinary" + }, + { + "id": "script-api:dw/net/WebDAVClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getBinary", + "tags": [ + "getbinary", + "webdavclient.getbinary" + ], + "title": "WebDAVClient.getBinary" + }, + { + "id": "script-api:dw/net/WebDAVClient#getResponseHeader", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getResponseHeader", + "tags": [ + "getresponseheader", + "webdavclient.getresponseheader" + ], + "title": "WebDAVClient.getResponseHeader" + }, + { + "id": "script-api:dw/net/WebDAVClient#getStatusCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getStatusCode", + "tags": [ + "getstatuscode", + "webdavclient.getstatuscode" + ], + "title": "WebDAVClient.getStatusCode" + }, + { + "id": "script-api:dw/net/WebDAVClient#getStatusText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getStatusText", + "tags": [ + "getstatustext", + "webdavclient.getstatustext" + ], + "title": "WebDAVClient.getStatusText" + }, + { + "id": "script-api:dw/net/WebDAVClient#mkcol", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.mkcol", + "tags": [ + "mkcol", + "webdavclient.mkcol" + ], + "title": "WebDAVClient.mkcol" + }, + { + "id": "script-api:dw/net/WebDAVClient#move", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.move", + "tags": [ + "move", + "webdavclient.move" + ], + "title": "WebDAVClient.move" + }, + { + "id": "script-api:dw/net/WebDAVClient#move", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.move", + "tags": [ + "move", + "webdavclient.move" + ], + "title": "WebDAVClient.move" + }, + { + "id": "script-api:dw/net/WebDAVClient#options", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.options", + "tags": [ + "options", + "webdavclient.options" + ], + "title": "WebDAVClient.options" + }, + { + "id": "script-api:dw/net/WebDAVClient#propfind", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.propfind", + "tags": [ + "propfind", + "webdavclient.propfind" + ], + "title": "WebDAVClient.propfind" + }, + { + "id": "script-api:dw/net/WebDAVClient#propfind", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.propfind", + "tags": [ + "propfind", + "webdavclient.propfind" + ], + "title": "WebDAVClient.propfind" + }, + { + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "id": "script-api:dw/net/WebDAVClient#statusCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.statusCode", + "tags": [ + "statuscode", + "webdavclient.statuscode" + ], + "title": "WebDAVClient.statusCode" + }, + { + "id": "script-api:dw/net/WebDAVClient#statusText", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.statusText", + "tags": [ + "statustext", + "webdavclient.statustext" + ], + "title": "WebDAVClient.statusText" + }, + { + "id": "script-api:dw/net/WebDAVClient#succeeded", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.succeeded", + "tags": [ + "succeeded", + "webdavclient.succeeded" + ], + "title": "WebDAVClient.succeeded" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.WebDAVFileInfo", + "tags": [ + "webdavfileinfo", + "dw.net.webdavfileinfo", + "dw/net" + ], + "title": "WebDAVFileInfo" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#contentType", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.contentType", + "tags": [ + "contenttype", + "webdavfileinfo.contenttype" + ], + "title": "WebDAVFileInfo.contentType" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#creationDate", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.creationDate", + "tags": [ + "creationdate", + "webdavfileinfo.creationdate" + ], + "title": "WebDAVFileInfo.creationDate" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.directory", + "tags": [ + "directory", + "webdavfileinfo.directory" + ], + "title": "WebDAVFileInfo.directory" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#getContentType", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getContentType", + "tags": [ + "getcontenttype", + "webdavfileinfo.getcontenttype" + ], + "title": "WebDAVFileInfo.getContentType" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#getCreationDate", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getCreationDate", + "tags": [ + "getcreationdate", + "webdavfileinfo.getcreationdate" + ], + "title": "WebDAVFileInfo.getCreationDate" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getName", + "tags": [ + "getname", + "webdavfileinfo.getname" + ], + "title": "WebDAVFileInfo.getName" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#getPath", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getPath", + "tags": [ + "getpath", + "webdavfileinfo.getpath" + ], + "title": "WebDAVFileInfo.getPath" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getSize", + "tags": [ + "getsize", + "webdavfileinfo.getsize" + ], + "title": "WebDAVFileInfo.getSize" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#isDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.isDirectory", + "tags": [ + "isdirectory", + "webdavfileinfo.isdirectory" + ], + "title": "WebDAVFileInfo.isDirectory" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#lastModified", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.lastModified", + "tags": [ + "lastmodified", + "webdavfileinfo.lastmodified" + ], + "title": "WebDAVFileInfo.lastModified" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.name", + "tags": [ + "name", + "webdavfileinfo.name" + ], + "title": "WebDAVFileInfo.name" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#path", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.path", + "tags": [ + "path", + "webdavfileinfo.path" + ], + "title": "WebDAVFileInfo.path" + }, + { + "id": "script-api:dw/net/WebDAVFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.size", + "tags": [ + "size", + "webdavfileinfo.size" + ], + "title": "WebDAVFileInfo.size" + }, + { + "id": "script-api:dw/object", + "kind": "package", + "packagePath": "dw/object", + "qualifiedName": "dw.object", + "tags": [ + "dw/object", + "dw.object" + ], + "title": "dw.object" + }, + { + "id": "script-api:dw/object/ActiveData", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ActiveData", + "tags": [ + "activedata", + "dw.object.activedata", + "dw/object" + ], + "title": "ActiveData" + }, + { + "id": "script-api:dw/object/ActiveData#empty", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ActiveData", + "qualifiedName": "dw.object.ActiveData.empty", + "tags": [ + "empty", + "activedata.empty" + ], + "title": "ActiveData.empty" + }, + { + "id": "script-api:dw/object/ActiveData#isEmpty", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ActiveData", + "qualifiedName": "dw.object.ActiveData.isEmpty", + "tags": [ + "isempty", + "activedata.isempty" + ], + "title": "ActiveData.isEmpty" + }, + { + "id": "script-api:dw/object/CustomAttributes", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomAttributes", + "tags": [ + "customattributes", + "dw.object.customattributes", + "dw/object" + ], + "title": "CustomAttributes" + }, + { + "id": "script-api:dw/object/CustomObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomObject", + "tags": [ + "customobject", + "dw.object.customobject", + "dw/object" + ], + "title": "CustomObject" + }, + { + "id": "script-api:dw/object/CustomObject#getType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObject", + "qualifiedName": "dw.object.CustomObject.getType", + "tags": [ + "gettype", + "customobject.gettype" + ], + "title": "CustomObject.getType" + }, + { + "id": "script-api:dw/object/CustomObject#type", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObject", + "qualifiedName": "dw.object.CustomObject.type", + "tags": [ + "type", + "customobject.type" + ], + "title": "CustomObject.type" + }, + { + "id": "script-api:dw/object/CustomObjectMgr", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomObjectMgr", + "tags": [ + "customobjectmgr", + "dw.object.customobjectmgr", + "dw/object" + ], + "title": "CustomObjectMgr" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.describe", + "tags": [ + "describe", + "customobjectmgr.describe" + ], + "title": "CustomObjectMgr.describe" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.describe", + "tags": [ + "describe", + "customobjectmgr.describe" + ], + "title": "CustomObjectMgr.describe" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getAllCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getAllCustomObjects", + "tags": [ + "getallcustomobjects", + "customobjectmgr.getallcustomobjects" + ], + "title": "CustomObjectMgr.getAllCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getAllCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getAllCustomObjects", + "tags": [ + "getallcustomobjects", + "customobjectmgr.getallcustomobjects" + ], + "title": "CustomObjectMgr.getAllCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObject", + "tags": [ + "querycustomobject", + "customobjectmgr.querycustomobject" + ], + "title": "CustomObjectMgr.queryCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObject", + "tags": [ + "querycustomobject", + "customobjectmgr.querycustomobject" + ], + "title": "CustomObjectMgr.queryCustomObject" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#remove", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.remove", + "tags": [ + "remove", + "customobjectmgr.remove" + ], + "title": "CustomObjectMgr.remove" + }, + { + "id": "script-api:dw/object/CustomObjectMgr#remove", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.remove", + "tags": [ + "remove", + "customobjectmgr.remove" + ], + "title": "CustomObjectMgr.remove" + }, + { + "id": "script-api:dw/object/Extensible", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.Extensible", + "tags": [ + "extensible", + "dw.object.extensible", + "dw/object" + ], + "title": "Extensible" + }, + { + "id": "script-api:dw/object/Extensible#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.custom", + "tags": [ + "custom", + "extensible.custom" + ], + "title": "Extensible.custom" + }, + { + "id": "script-api:dw/object/Extensible#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.describe", + "tags": [ + "describe", + "extensible.describe" + ], + "title": "Extensible.describe" + }, + { + "id": "script-api:dw/object/Extensible#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.getCustom", + "tags": [ + "getcustom", + "extensible.getcustom" + ], + "title": "Extensible.getCustom" + }, + { + "id": "script-api:dw/object/ExtensibleObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ExtensibleObject", + "tags": [ + "extensibleobject", + "dw.object.extensibleobject", + "dw/object" + ], + "title": "ExtensibleObject" + }, + { + "id": "script-api:dw/object/ExtensibleObject#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.custom", + "tags": [ + "custom", + "extensibleobject.custom" + ], + "title": "ExtensibleObject.custom" + }, + { + "id": "script-api:dw/object/ExtensibleObject#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.describe", + "tags": [ + "describe", + "extensibleobject.describe" + ], + "title": "ExtensibleObject.describe" + }, + { + "id": "script-api:dw/object/ExtensibleObject#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.getCustom", + "tags": [ + "getcustom", + "extensibleobject.getcustom" + ], + "title": "ExtensibleObject.getCustom" + }, + { + "id": "script-api:dw/object/Note", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.Note", + "tags": [ + "note", + "dw.object.note", + "dw/object" + ], + "title": "Note" + }, + { + "id": "script-api:dw/object/Note#createdBy", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.createdBy", + "tags": [ + "createdby", + "note.createdby" + ], + "title": "Note.createdBy" + }, + { + "id": "script-api:dw/object/Note#creationDate", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.creationDate", + "tags": [ + "creationdate", + "note.creationdate" + ], + "title": "Note.creationDate" + }, + { + "id": "script-api:dw/object/Note#getCreatedBy", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getCreatedBy", + "tags": [ + "getcreatedby", + "note.getcreatedby" + ], + "title": "Note.getCreatedBy" + }, + { + "id": "script-api:dw/object/Note#getCreationDate", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getCreationDate", + "tags": [ + "getcreationdate", + "note.getcreationdate" + ], + "title": "Note.getCreationDate" + }, + { + "id": "script-api:dw/object/Note#getSubject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getSubject", + "tags": [ + "getsubject", + "note.getsubject" + ], + "title": "Note.getSubject" + }, + { + "id": "script-api:dw/object/Note#getText", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getText", + "tags": [ + "gettext", + "note.gettext" + ], + "title": "Note.getText" + }, + { + "id": "script-api:dw/object/Note#subject", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.subject", + "tags": [ + "subject", + "note.subject" + ], + "title": "Note.subject" + }, + { + "id": "script-api:dw/object/Note#text", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.text", + "tags": [ + "text", + "note.text" + ], + "title": "Note.text" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeDefinition", + "tags": [ + "objectattributedefinition", + "dw.object.objectattributedefinition", + "dw/object" + ], + "title": "ObjectAttributeDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.ID", + "tags": [ + "id", + "objectattributedefinition.id" + ], + "title": "ObjectAttributeDefinition.ID" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_BOOLEAN", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN", + "tags": [ + "value_type_boolean", + "objectattributedefinition.value_type_boolean" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_BOOLEAN", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN", + "tags": [ + "value_type_boolean", + "objectattributedefinition.value_type_boolean" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATE", + "tags": [ + "value_type_date", + "objectattributedefinition.value_type_date" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATE" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATE", + "tags": [ + "value_type_date", + "objectattributedefinition.value_type_date" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATE" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATETIME", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATETIME", + "tags": [ + "value_type_datetime", + "objectattributedefinition.value_type_datetime" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATETIME" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATETIME", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATETIME", + "tags": [ + "value_type_datetime", + "objectattributedefinition.value_type_datetime" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATETIME" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_EMAIL", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_EMAIL", + "tags": [ + "value_type_email", + "objectattributedefinition.value_type_email" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_EMAIL" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_EMAIL", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_EMAIL", + "tags": [ + "value_type_email", + "objectattributedefinition.value_type_email" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_EMAIL" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT", + "tags": [ + "value_type_enum_of_int", + "objectattributedefinition.value_type_enum_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT", + "tags": [ + "value_type_enum_of_int", + "objectattributedefinition.value_type_enum_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING", + "tags": [ + "value_type_enum_of_string", + "objectattributedefinition.value_type_enum_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING", + "tags": [ + "value_type_enum_of_string", + "objectattributedefinition.value_type_enum_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_HTML", + "tags": [ + "value_type_html", + "objectattributedefinition.value_type_html" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_HTML" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_HTML", + "tags": [ + "value_type_html", + "objectattributedefinition.value_type_html" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_HTML" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_IMAGE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_IMAGE", + "tags": [ + "value_type_image", + "objectattributedefinition.value_type_image" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_IMAGE" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_IMAGE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_IMAGE", + "tags": [ + "value_type_image", + "objectattributedefinition.value_type_image" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_IMAGE" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_INT", + "tags": [ + "value_type_int", + "objectattributedefinition.value_type_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_INT", + "tags": [ + "value_type_int", + "objectattributedefinition.value_type_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_MONEY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_MONEY", + "tags": [ + "value_type_money", + "objectattributedefinition.value_type_money" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_MONEY" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_MONEY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_MONEY", + "tags": [ + "value_type_money", + "objectattributedefinition.value_type_money" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_MONEY" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_NUMBER", + "tags": [ + "value_type_number", + "objectattributedefinition.value_type_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_NUMBER" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_NUMBER", + "tags": [ + "value_type_number", + "objectattributedefinition.value_type_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_NUMBER" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_PASSWORD", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_PASSWORD", + "tags": [ + "value_type_password", + "objectattributedefinition.value_type_password" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_PASSWORD" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_PASSWORD", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_PASSWORD", + "tags": [ + "value_type_password", + "objectattributedefinition.value_type_password" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_PASSWORD" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_QUANTITY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_QUANTITY", + "tags": [ + "value_type_quantity", + "objectattributedefinition.value_type_quantity" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_QUANTITY" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_QUANTITY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_QUANTITY", + "tags": [ + "value_type_quantity", + "objectattributedefinition.value_type_quantity" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_QUANTITY" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT", + "tags": [ + "value_type_set_of_int", + "objectattributedefinition.value_type_set_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT", + "tags": [ + "value_type_set_of_int", + "objectattributedefinition.value_type_set_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER", + "tags": [ + "value_type_set_of_number", + "objectattributedefinition.value_type_set_of_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER", + "tags": [ + "value_type_set_of_number", + "objectattributedefinition.value_type_set_of_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING", + "tags": [ + "value_type_set_of_string", + "objectattributedefinition.value_type_set_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING", + "tags": [ + "value_type_set_of_string", + "objectattributedefinition.value_type_set_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_STRING", + "tags": [ + "value_type_string", + "objectattributedefinition.value_type_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_STRING", + "tags": [ + "value_type_string", + "objectattributedefinition.value_type_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_STRING" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_TEXT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_TEXT", + "tags": [ + "value_type_text", + "objectattributedefinition.value_type_text" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_TEXT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_TEXT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_TEXT", + "tags": [ + "value_type_text", + "objectattributedefinition.value_type_text" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_TEXT" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#attributeGroups", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.attributeGroups", + "tags": [ + "attributegroups", + "objectattributedefinition.attributegroups" + ], + "title": "ObjectAttributeDefinition.attributeGroups" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#defaultValue", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.defaultValue", + "tags": [ + "defaultvalue", + "objectattributedefinition.defaultvalue" + ], + "title": "ObjectAttributeDefinition.defaultValue" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.displayName", + "tags": [ + "displayname", + "objectattributedefinition.displayname" + ], + "title": "ObjectAttributeDefinition.displayName" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getAttributeGroups", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getAttributeGroups", + "tags": [ + "getattributegroups", + "objectattributedefinition.getattributegroups" + ], + "title": "ObjectAttributeDefinition.getAttributeGroups" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getDefaultValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getDefaultValue", + "tags": [ + "getdefaultvalue", + "objectattributedefinition.getdefaultvalue" + ], + "title": "ObjectAttributeDefinition.getDefaultValue" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getDisplayName", + "tags": [ + "getdisplayname", + "objectattributedefinition.getdisplayname" + ], + "title": "ObjectAttributeDefinition.getDisplayName" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getID", + "tags": [ + "getid", + "objectattributedefinition.getid" + ], + "title": "ObjectAttributeDefinition.getID" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getObjectTypeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getObjectTypeDefinition", + "tags": [ + "getobjecttypedefinition", + "objectattributedefinition.getobjecttypedefinition" + ], + "title": "ObjectAttributeDefinition.getObjectTypeDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getUnit", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getUnit", + "tags": [ + "getunit", + "objectattributedefinition.getunit" + ], + "title": "ObjectAttributeDefinition.getUnit" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getValueTypeCode", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getValueTypeCode", + "tags": [ + "getvaluetypecode", + "objectattributedefinition.getvaluetypecode" + ], + "title": "ObjectAttributeDefinition.getValueTypeCode" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#getValues", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getValues", + "tags": [ + "getvalues", + "objectattributedefinition.getvalues" + ], + "title": "ObjectAttributeDefinition.getValues" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#isKey", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isKey", + "tags": [ + "iskey", + "objectattributedefinition.iskey" + ], + "title": "ObjectAttributeDefinition.isKey" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#isMandatory", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isMandatory", + "tags": [ + "ismandatory", + "objectattributedefinition.ismandatory" + ], + "title": "ObjectAttributeDefinition.isMandatory" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#isMultiValueType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isMultiValueType", + "tags": [ + "ismultivaluetype", + "objectattributedefinition.ismultivaluetype" + ], + "title": "ObjectAttributeDefinition.isMultiValueType" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#isSetValueType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isSetValueType", + "tags": [ + "issetvaluetype", + "objectattributedefinition.issetvaluetype" + ], + "title": "ObjectAttributeDefinition.isSetValueType" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isSystem", + "tags": [ + "issystem", + "objectattributedefinition.issystem" + ], + "title": "ObjectAttributeDefinition.isSystem" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#key", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.key", + "tags": [ + "key", + "objectattributedefinition.key" + ], + "title": "ObjectAttributeDefinition.key" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#mandatory", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.mandatory", + "tags": [ + "mandatory", + "objectattributedefinition.mandatory" + ], + "title": "ObjectAttributeDefinition.mandatory" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#multiValueType", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.multiValueType", + "tags": [ + "multivaluetype", + "objectattributedefinition.multivaluetype" + ], + "title": "ObjectAttributeDefinition.multiValueType" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#objectTypeDefinition", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.objectTypeDefinition", + "tags": [ + "objecttypedefinition", + "objectattributedefinition.objecttypedefinition" + ], + "title": "ObjectAttributeDefinition.objectTypeDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#requiresEncoding", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.requiresEncoding", + "tags": [ + "requiresencoding", + "objectattributedefinition.requiresencoding" + ], + "title": "ObjectAttributeDefinition.requiresEncoding" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#setValueType", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.setValueType", + "tags": [ + "setvaluetype", + "objectattributedefinition.setvaluetype" + ], + "title": "ObjectAttributeDefinition.setValueType" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.system", + "tags": [ + "system", + "objectattributedefinition.system" + ], + "title": "ObjectAttributeDefinition.system" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#unit", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.unit", + "tags": [ + "unit", + "objectattributedefinition.unit" + ], + "title": "ObjectAttributeDefinition.unit" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#valueTypeCode", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.valueTypeCode", + "tags": [ + "valuetypecode", + "objectattributedefinition.valuetypecode" + ], + "title": "ObjectAttributeDefinition.valueTypeCode" + }, + { + "id": "script-api:dw/object/ObjectAttributeDefinition#values", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.values", + "tags": [ + "values", + "objectattributedefinition.values" + ], + "title": "ObjectAttributeDefinition.values" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeGroup", + "tags": [ + "objectattributegroup", + "dw.object.objectattributegroup", + "dw/object" + ], + "title": "ObjectAttributeGroup" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.ID", + "tags": [ + "id", + "objectattributegroup.id" + ], + "title": "ObjectAttributeGroup.ID" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#attributeDefinitions", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.attributeDefinitions", + "tags": [ + "attributedefinitions", + "objectattributegroup.attributedefinitions" + ], + "title": "ObjectAttributeGroup.attributeDefinitions" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#description", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.description", + "tags": [ + "description", + "objectattributegroup.description" + ], + "title": "ObjectAttributeGroup.description" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.displayName", + "tags": [ + "displayname", + "objectattributegroup.displayname" + ], + "title": "ObjectAttributeGroup.displayName" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getAttributeDefinitions", + "tags": [ + "getattributedefinitions", + "objectattributegroup.getattributedefinitions" + ], + "title": "ObjectAttributeGroup.getAttributeDefinitions" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#getDescription", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getDescription", + "tags": [ + "getdescription", + "objectattributegroup.getdescription" + ], + "title": "ObjectAttributeGroup.getDescription" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getDisplayName", + "tags": [ + "getdisplayname", + "objectattributegroup.getdisplayname" + ], + "title": "ObjectAttributeGroup.getDisplayName" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getID", + "tags": [ + "getid", + "objectattributegroup.getid" + ], + "title": "ObjectAttributeGroup.getID" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#getObjectTypeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getObjectTypeDefinition", + "tags": [ + "getobjecttypedefinition", + "objectattributegroup.getobjecttypedefinition" + ], + "title": "ObjectAttributeGroup.getObjectTypeDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.isSystem", + "tags": [ + "issystem", + "objectattributegroup.issystem" + ], + "title": "ObjectAttributeGroup.isSystem" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#objectTypeDefinition", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.objectTypeDefinition", + "tags": [ + "objecttypedefinition", + "objectattributegroup.objecttypedefinition" + ], + "title": "ObjectAttributeGroup.objectTypeDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeGroup#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.system", + "tags": [ + "system", + "objectattributegroup.system" + ], + "title": "ObjectAttributeGroup.system" + }, + { + "id": "script-api:dw/object/ObjectAttributeValueDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition", + "tags": [ + "objectattributevaluedefinition", + "dw.object.objectattributevaluedefinition", + "dw/object" + ], + "title": "ObjectAttributeValueDefinition" + }, + { + "id": "script-api:dw/object/ObjectAttributeValueDefinition#displayValue", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.displayValue", + "tags": [ + "displayvalue", + "objectattributevaluedefinition.displayvalue" + ], + "title": "ObjectAttributeValueDefinition.displayValue" + }, + { + "id": "script-api:dw/object/ObjectAttributeValueDefinition#getDisplayValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.getDisplayValue", + "tags": [ + "getdisplayvalue", + "objectattributevaluedefinition.getdisplayvalue" + ], + "title": "ObjectAttributeValueDefinition.getDisplayValue" + }, + { + "id": "script-api:dw/object/ObjectAttributeValueDefinition#getValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.getValue", + "tags": [ + "getvalue", + "objectattributevaluedefinition.getvalue" + ], + "title": "ObjectAttributeValueDefinition.getValue" + }, + { + "id": "script-api:dw/object/ObjectAttributeValueDefinition#value", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.value", + "tags": [ + "value", + "objectattributevaluedefinition.value" + ], + "title": "ObjectAttributeValueDefinition.value" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectTypeDefinition", + "tags": [ + "objecttypedefinition", + "dw.object.objecttypedefinition", + "dw/object" + ], + "title": "ObjectTypeDefinition" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.ID", + "tags": [ + "id", + "objecttypedefinition.id" + ], + "title": "ObjectTypeDefinition.ID" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#attributeDefinitions", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.attributeDefinitions", + "tags": [ + "attributedefinitions", + "objecttypedefinition.attributedefinitions" + ], + "title": "ObjectTypeDefinition.attributeDefinitions" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#attributeGroups", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.attributeGroups", + "tags": [ + "attributegroups", + "objecttypedefinition.attributegroups" + ], + "title": "ObjectTypeDefinition.attributeGroups" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.displayName", + "tags": [ + "displayname", + "objecttypedefinition.displayname" + ], + "title": "ObjectTypeDefinition.displayName" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeDefinitions", + "tags": [ + "getattributedefinitions", + "objecttypedefinition.getattributedefinitions" + ], + "title": "ObjectTypeDefinition.getAttributeDefinitions" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeGroup", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeGroup", + "tags": [ + "getattributegroup", + "objecttypedefinition.getattributegroup" + ], + "title": "ObjectTypeDefinition.getAttributeGroup" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeGroups", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeGroups", + "tags": [ + "getattributegroups", + "objecttypedefinition.getattributegroups" + ], + "title": "ObjectTypeDefinition.getAttributeGroups" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getCustomAttributeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getCustomAttributeDefinition", + "tags": [ + "getcustomattributedefinition", + "objecttypedefinition.getcustomattributedefinition" + ], + "title": "ObjectTypeDefinition.getCustomAttributeDefinition" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getDisplayName", + "tags": [ + "getdisplayname", + "objecttypedefinition.getdisplayname" + ], + "title": "ObjectTypeDefinition.getDisplayName" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getID", + "tags": [ + "getid", + "objecttypedefinition.getid" + ], + "title": "ObjectTypeDefinition.getID" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#getSystemAttributeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getSystemAttributeDefinition", + "tags": [ + "getsystemattributedefinition", + "objecttypedefinition.getsystemattributedefinition" + ], + "title": "ObjectTypeDefinition.getSystemAttributeDefinition" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.isSystem", + "tags": [ + "issystem", + "objecttypedefinition.issystem" + ], + "title": "ObjectTypeDefinition.isSystem" + }, + { + "id": "script-api:dw/object/ObjectTypeDefinition#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.system", + "tags": [ + "system", + "objecttypedefinition.system" + ], + "title": "ObjectTypeDefinition.system" + }, + { + "id": "script-api:dw/object/PersistentObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.PersistentObject", + "tags": [ + "persistentobject", + "dw.object.persistentobject", + "dw/object" + ], + "title": "PersistentObject" + }, + { + "id": "script-api:dw/object/PersistentObject#UUID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.UUID", + "tags": [ + "uuid", + "persistentobject.uuid" + ], + "title": "PersistentObject.UUID" + }, + { + "id": "script-api:dw/object/PersistentObject#creationDate", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.creationDate", + "tags": [ + "creationdate", + "persistentobject.creationdate" + ], + "title": "PersistentObject.creationDate" + }, + { + "id": "script-api:dw/object/PersistentObject#getCreationDate", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getCreationDate", + "tags": [ + "getcreationdate", + "persistentobject.getcreationdate" + ], + "title": "PersistentObject.getCreationDate" + }, + { + "id": "script-api:dw/object/PersistentObject#getLastModified", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getLastModified", + "tags": [ + "getlastmodified", + "persistentobject.getlastmodified" + ], + "title": "PersistentObject.getLastModified" + }, + { + "id": "script-api:dw/object/PersistentObject#getUUID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getUUID", + "tags": [ + "getuuid", + "persistentobject.getuuid" + ], + "title": "PersistentObject.getUUID" + }, + { + "id": "script-api:dw/object/PersistentObject#lastModified", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.lastModified", + "tags": [ + "lastmodified", + "persistentobject.lastmodified" + ], + "title": "PersistentObject.lastModified" + }, + { + "id": "script-api:dw/object/SimpleExtensible", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.SimpleExtensible", + "tags": [ + "simpleextensible", + "dw.object.simpleextensible", + "dw/object" + ], + "title": "SimpleExtensible" + }, + { + "id": "script-api:dw/object/SimpleExtensible#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SimpleExtensible", + "qualifiedName": "dw.object.SimpleExtensible.custom", + "tags": [ + "custom", + "simpleextensible.custom" + ], + "title": "SimpleExtensible.custom" + }, + { + "id": "script-api:dw/object/SimpleExtensible#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SimpleExtensible", + "qualifiedName": "dw.object.SimpleExtensible.getCustom", + "tags": [ + "getcustom", + "simpleextensible.getcustom" + ], + "title": "SimpleExtensible.getCustom" + }, + { + "id": "script-api:dw/object/SystemObjectMgr", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.SystemObjectMgr", + "tags": [ + "systemobjectmgr", + "dw.object.systemobjectmgr", + "dw/object" + ], + "title": "SystemObjectMgr" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.describe", + "tags": [ + "describe", + "systemobjectmgr.describe" + ], + "title": "SystemObjectMgr.describe" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.describe", + "tags": [ + "describe", + "systemobjectmgr.describe" + ], + "title": "SystemObjectMgr.describe" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#getAllSystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.getAllSystemObjects", + "tags": [ + "getallsystemobjects", + "systemobjectmgr.getallsystemobjects" + ], + "title": "SystemObjectMgr.getAllSystemObjects" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#getAllSystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.getAllSystemObjects", + "tags": [ + "getallsystemobjects", + "systemobjectmgr.getallsystemobjects" + ], + "title": "SystemObjectMgr.getAllSystemObjects" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObject", + "tags": [ + "querysystemobject", + "systemobjectmgr.querysystemobject" + ], + "title": "SystemObjectMgr.querySystemObject" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObject", + "tags": [ + "querysystemobject", + "systemobjectmgr.querysystemobject" + ], + "title": "SystemObjectMgr.querySystemObject" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "id": "script-api:dw/order", + "kind": "package", + "packagePath": "dw/order", + "qualifiedName": "dw.order", + "tags": [ + "dw/order", + "dw.order" + ], + "title": "dw.order" + }, + { + "id": "script-api:dw/order/AbstractItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AbstractItem", + "tags": [ + "abstractitem", + "dw.order.abstractitem", + "dw/order" + ], + "title": "AbstractItem" + }, + { + "id": "script-api:dw/order/AbstractItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getGrossPrice", + "tags": [ + "getgrossprice", + "abstractitem.getgrossprice" + ], + "title": "AbstractItem.getGrossPrice" + }, + { + "id": "script-api:dw/order/AbstractItem#getItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getItemID", + "tags": [ + "getitemid", + "abstractitem.getitemid" + ], + "title": "AbstractItem.getItemID" + }, + { + "id": "script-api:dw/order/AbstractItem#getLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getLineItem", + "tags": [ + "getlineitem", + "abstractitem.getlineitem" + ], + "title": "AbstractItem.getLineItem" + }, + { + "id": "script-api:dw/order/AbstractItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getNetPrice", + "tags": [ + "getnetprice", + "abstractitem.getnetprice" + ], + "title": "AbstractItem.getNetPrice" + }, + { + "id": "script-api:dw/order/AbstractItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getOrderItem", + "tags": [ + "getorderitem", + "abstractitem.getorderitem" + ], + "title": "AbstractItem.getOrderItem" + }, + { + "id": "script-api:dw/order/AbstractItem#getOrderItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getOrderItemID", + "tags": [ + "getorderitemid", + "abstractitem.getorderitemid" + ], + "title": "AbstractItem.getOrderItemID" + }, + { + "id": "script-api:dw/order/AbstractItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTax", + "tags": [ + "gettax", + "abstractitem.gettax" + ], + "title": "AbstractItem.getTax" + }, + { + "id": "script-api:dw/order/AbstractItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTaxBasis", + "tags": [ + "gettaxbasis", + "abstractitem.gettaxbasis" + ], + "title": "AbstractItem.getTaxBasis" + }, + { + "id": "script-api:dw/order/AbstractItem#getTaxItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTaxItems", + "tags": [ + "gettaxitems", + "abstractitem.gettaxitems" + ], + "title": "AbstractItem.getTaxItems" + }, + { + "id": "script-api:dw/order/AbstractItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.grossPrice", + "tags": [ + "grossprice", + "abstractitem.grossprice" + ], + "title": "AbstractItem.grossPrice" + }, + { + "id": "script-api:dw/order/AbstractItem#itemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.itemID", + "tags": [ + "itemid", + "abstractitem.itemid" + ], + "title": "AbstractItem.itemID" + }, + { + "id": "script-api:dw/order/AbstractItem#lineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.lineItem", + "tags": [ + "lineitem", + "abstractitem.lineitem" + ], + "title": "AbstractItem.lineItem" + }, + { + "id": "script-api:dw/order/AbstractItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.netPrice", + "tags": [ + "netprice", + "abstractitem.netprice" + ], + "title": "AbstractItem.netPrice" + }, + { + "id": "script-api:dw/order/AbstractItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.orderItem", + "tags": [ + "orderitem", + "abstractitem.orderitem" + ], + "title": "AbstractItem.orderItem" + }, + { + "id": "script-api:dw/order/AbstractItem#orderItemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.orderItemID", + "tags": [ + "orderitemid", + "abstractitem.orderitemid" + ], + "title": "AbstractItem.orderItemID" + }, + { + "id": "script-api:dw/order/AbstractItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.tax", + "tags": [ + "tax", + "abstractitem.tax" + ], + "title": "AbstractItem.tax" + }, + { + "id": "script-api:dw/order/AbstractItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.taxBasis", + "tags": [ + "taxbasis", + "abstractitem.taxbasis" + ], + "title": "AbstractItem.taxBasis" + }, + { + "id": "script-api:dw/order/AbstractItem#taxItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.taxItems", + "tags": [ + "taxitems", + "abstractitem.taxitems" + ], + "title": "AbstractItem.taxItems" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AbstractItemCtnr", + "tags": [ + "abstractitemctnr", + "dw.order.abstractitemctnr", + "dw/order" + ], + "title": "AbstractItemCtnr" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.createdBy", + "tags": [ + "createdby", + "abstractitemctnr.createdby" + ], + "title": "AbstractItemCtnr.createdBy" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#creationDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.creationDate", + "tags": [ + "creationdate", + "abstractitemctnr.creationdate" + ], + "title": "AbstractItemCtnr.creationDate" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getCreatedBy", + "tags": [ + "getcreatedby", + "abstractitemctnr.getcreatedby" + ], + "title": "AbstractItemCtnr.getCreatedBy" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getCreationDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getCreationDate", + "tags": [ + "getcreationdate", + "abstractitemctnr.getcreationdate" + ], + "title": "AbstractItemCtnr.getCreationDate" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getGrandTotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getGrandTotal", + "tags": [ + "getgrandtotal", + "abstractitemctnr.getgrandtotal" + ], + "title": "AbstractItemCtnr.getGrandTotal" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getItems", + "tags": [ + "getitems", + "abstractitemctnr.getitems" + ], + "title": "AbstractItemCtnr.getItems" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getLastModified", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getLastModified", + "tags": [ + "getlastmodified", + "abstractitemctnr.getlastmodified" + ], + "title": "AbstractItemCtnr.getLastModified" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getModifiedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getModifiedBy", + "tags": [ + "getmodifiedby", + "abstractitemctnr.getmodifiedby" + ], + "title": "AbstractItemCtnr.getModifiedBy" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getOrder", + "tags": [ + "getorder", + "abstractitemctnr.getorder" + ], + "title": "AbstractItemCtnr.getOrder" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getProductSubtotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getProductSubtotal", + "tags": [ + "getproductsubtotal", + "abstractitemctnr.getproductsubtotal" + ], + "title": "AbstractItemCtnr.getProductSubtotal" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#getServiceSubtotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getServiceSubtotal", + "tags": [ + "getservicesubtotal", + "abstractitemctnr.getservicesubtotal" + ], + "title": "AbstractItemCtnr.getServiceSubtotal" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#grandTotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.grandTotal", + "tags": [ + "grandtotal", + "abstractitemctnr.grandtotal" + ], + "title": "AbstractItemCtnr.grandTotal" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#items", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.items", + "tags": [ + "items", + "abstractitemctnr.items" + ], + "title": "AbstractItemCtnr.items" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#lastModified", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.lastModified", + "tags": [ + "lastmodified", + "abstractitemctnr.lastmodified" + ], + "title": "AbstractItemCtnr.lastModified" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#modifiedBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.modifiedBy", + "tags": [ + "modifiedby", + "abstractitemctnr.modifiedby" + ], + "title": "AbstractItemCtnr.modifiedBy" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#order", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.order", + "tags": [ + "order", + "abstractitemctnr.order" + ], + "title": "AbstractItemCtnr.order" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#productSubtotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.productSubtotal", + "tags": [ + "productsubtotal", + "abstractitemctnr.productsubtotal" + ], + "title": "AbstractItemCtnr.productSubtotal" + }, + { + "id": "script-api:dw/order/AbstractItemCtnr#serviceSubtotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.serviceSubtotal", + "tags": [ + "servicesubtotal", + "abstractitemctnr.servicesubtotal" + ], + "title": "AbstractItemCtnr.serviceSubtotal" + }, + { + "id": "script-api:dw/order/Appeasement", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Appeasement", + "tags": [ + "appeasement", + "dw.order.appeasement", + "dw/order" + ], + "title": "Appeasement" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "appeasement.orderby_itemid" + ], + "title": "Appeasement.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "appeasement.orderby_itemid" + ], + "title": "Appeasement.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "appeasement.orderby_itemposition" + ], + "title": "Appeasement.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "appeasement.orderby_itemposition" + ], + "title": "Appeasement.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "appeasement.orderby_unsorted" + ], + "title": "Appeasement.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Appeasement#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "appeasement.orderby_unsorted" + ], + "title": "Appeasement.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Appeasement#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "appeasement.qualifier_productitems" + ], + "title": "Appeasement.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Appeasement#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "appeasement.qualifier_productitems" + ], + "title": "Appeasement.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Appeasement#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "appeasement.qualifier_serviceitems" + ], + "title": "Appeasement.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Appeasement#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "appeasement.qualifier_serviceitems" + ], + "title": "Appeasement.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Appeasement#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_COMPLETED", + "tags": [ + "status_completed", + "appeasement.status_completed" + ], + "title": "Appeasement.STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Appeasement#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_COMPLETED", + "tags": [ + "status_completed", + "appeasement.status_completed" + ], + "title": "Appeasement.STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Appeasement#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_OPEN", + "tags": [ + "status_open", + "appeasement.status_open" + ], + "title": "Appeasement.STATUS_OPEN" + }, + { + "id": "script-api:dw/order/Appeasement#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_OPEN", + "tags": [ + "status_open", + "appeasement.status_open" + ], + "title": "Appeasement.STATUS_OPEN" + }, + { + "id": "script-api:dw/order/Appeasement#addItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.addItems", + "tags": [ + "additems", + "appeasement.additems" + ], + "title": "Appeasement.addItems" + }, + { + "id": "script-api:dw/order/Appeasement#appeasementNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.appeasementNumber", + "tags": [ + "appeasementnumber", + "appeasement.appeasementnumber" + ], + "title": "Appeasement.appeasementNumber" + }, + { + "id": "script-api:dw/order/Appeasement#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.createInvoice", + "tags": [ + "createinvoice", + "appeasement.createinvoice" + ], + "title": "Appeasement.createInvoice" + }, + { + "id": "script-api:dw/order/Appeasement#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.createInvoice", + "tags": [ + "createinvoice", + "appeasement.createinvoice" + ], + "title": "Appeasement.createInvoice" + }, + { + "id": "script-api:dw/order/Appeasement#getAppeasementNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getAppeasementNumber", + "tags": [ + "getappeasementnumber", + "appeasement.getappeasementnumber" + ], + "title": "Appeasement.getAppeasementNumber" + }, + { + "id": "script-api:dw/order/Appeasement#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getInvoice", + "tags": [ + "getinvoice", + "appeasement.getinvoice" + ], + "title": "Appeasement.getInvoice" + }, + { + "id": "script-api:dw/order/Appeasement#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "appeasement.getinvoicenumber" + ], + "title": "Appeasement.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/Appeasement#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getReasonCode", + "tags": [ + "getreasoncode", + "appeasement.getreasoncode" + ], + "title": "Appeasement.getReasonCode" + }, + { + "id": "script-api:dw/order/Appeasement#getReasonNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getReasonNote", + "tags": [ + "getreasonnote", + "appeasement.getreasonnote" + ], + "title": "Appeasement.getReasonNote" + }, + { + "id": "script-api:dw/order/Appeasement#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getStatus", + "tags": [ + "getstatus", + "appeasement.getstatus" + ], + "title": "Appeasement.getStatus" + }, + { + "id": "script-api:dw/order/Appeasement#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.invoice", + "tags": [ + "invoice", + "appeasement.invoice" + ], + "title": "Appeasement.invoice" + }, + { + "id": "script-api:dw/order/Appeasement#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.invoiceNumber", + "tags": [ + "invoicenumber", + "appeasement.invoicenumber" + ], + "title": "Appeasement.invoiceNumber" + }, + { + "id": "script-api:dw/order/Appeasement#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.reasonCode", + "tags": [ + "reasoncode", + "appeasement.reasoncode" + ], + "title": "Appeasement.reasonCode" + }, + { + "id": "script-api:dw/order/Appeasement#reasonNote", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.reasonNote", + "tags": [ + "reasonnote", + "appeasement.reasonnote" + ], + "title": "Appeasement.reasonNote" + }, + { + "id": "script-api:dw/order/Appeasement#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setReasonCode", + "tags": [ + "setreasoncode", + "appeasement.setreasoncode" + ], + "title": "Appeasement.setReasonCode" + }, + { + "id": "script-api:dw/order/Appeasement#setReasonNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setReasonNote", + "tags": [ + "setreasonnote", + "appeasement.setreasonnote" + ], + "title": "Appeasement.setReasonNote" + }, + { + "id": "script-api:dw/order/Appeasement#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setStatus", + "tags": [ + "setstatus", + "appeasement.setstatus" + ], + "title": "Appeasement.setStatus" + }, + { + "id": "script-api:dw/order/Appeasement#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.status", + "tags": [ + "status", + "appeasement.status" + ], + "title": "Appeasement.status" + }, + { + "id": "script-api:dw/order/AppeasementItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AppeasementItem", + "tags": [ + "appeasementitem", + "dw.order.appeasementitem", + "dw/order" + ], + "title": "AppeasementItem" + }, + { + "id": "script-api:dw/order/AppeasementItem#appeasementNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.appeasementNumber", + "tags": [ + "appeasementnumber", + "appeasementitem.appeasementnumber" + ], + "title": "AppeasementItem.appeasementNumber" + }, + { + "id": "script-api:dw/order/AppeasementItem#getAppeasementNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.getAppeasementNumber", + "tags": [ + "getappeasementnumber", + "appeasementitem.getappeasementnumber" + ], + "title": "AppeasementItem.getAppeasementNumber" + }, + { + "id": "script-api:dw/order/AppeasementItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.getParentItem", + "tags": [ + "getparentitem", + "appeasementitem.getparentitem" + ], + "title": "AppeasementItem.getParentItem" + }, + { + "id": "script-api:dw/order/AppeasementItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.parentItem", + "tags": [ + "parentitem", + "appeasementitem.parentitem" + ], + "title": "AppeasementItem.parentItem" + }, + { + "id": "script-api:dw/order/AppeasementItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.setParentItem", + "tags": [ + "setparentitem", + "appeasementitem.setparentitem" + ], + "title": "AppeasementItem.setParentItem" + }, + { + "id": "script-api:dw/order/Basket", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Basket", + "tags": [ + "basket", + "dw.order.basket", + "dw/order" + ], + "title": "Basket" + }, + { + "id": "script-api:dw/order/Basket#agentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.agentBasket", + "tags": [ + "agentbasket", + "basket.agentbasket" + ], + "title": "Basket.agentBasket" + }, + { + "id": "script-api:dw/order/Basket#getInventoryReservationExpiry", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getInventoryReservationExpiry", + "tags": [ + "getinventoryreservationexpiry", + "basket.getinventoryreservationexpiry" + ], + "title": "Basket.getInventoryReservationExpiry" + }, + { + "id": "script-api:dw/order/Basket#getOrderBeingEdited", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getOrderBeingEdited", + "tags": [ + "getorderbeingedited", + "basket.getorderbeingedited" + ], + "title": "Basket.getOrderBeingEdited" + }, + { + "id": "script-api:dw/order/Basket#getOrderNoBeingEdited", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getOrderNoBeingEdited", + "tags": [ + "getordernobeingedited", + "basket.getordernobeingedited" + ], + "title": "Basket.getOrderNoBeingEdited" + }, + { + "id": "script-api:dw/order/Basket#inventoryReservationExpiry", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.inventoryReservationExpiry", + "tags": [ + "inventoryreservationexpiry", + "basket.inventoryreservationexpiry" + ], + "title": "Basket.inventoryReservationExpiry" + }, + { + "id": "script-api:dw/order/Basket#isAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isAgentBasket", + "tags": [ + "isagentbasket", + "basket.isagentbasket" + ], + "title": "Basket.isAgentBasket" + }, + { + "id": "script-api:dw/order/Basket#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isTaxRoundedAtGroup", + "tags": [ + "istaxroundedatgroup", + "basket.istaxroundedatgroup" + ], + "title": "Basket.isTaxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/Basket#isTemporary", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isTemporary", + "tags": [ + "istemporary", + "basket.istemporary" + ], + "title": "Basket.isTemporary" + }, + { + "id": "script-api:dw/order/Basket#orderBeingEdited", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.orderBeingEdited", + "tags": [ + "orderbeingedited", + "basket.orderbeingedited" + ], + "title": "Basket.orderBeingEdited" + }, + { + "id": "script-api:dw/order/Basket#orderNoBeingEdited", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.orderNoBeingEdited", + "tags": [ + "ordernobeingedited", + "basket.ordernobeingedited" + ], + "title": "Basket.orderNoBeingEdited" + }, + { + "id": "script-api:dw/order/Basket#releaseInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.releaseInventory", + "tags": [ + "releaseinventory", + "basket.releaseinventory" + ], + "title": "Basket.releaseInventory" + }, + { + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "id": "script-api:dw/order/Basket#setBusinessType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setBusinessType", + "tags": [ + "setbusinesstype", + "basket.setbusinesstype" + ], + "title": "Basket.setBusinessType" + }, + { + "id": "script-api:dw/order/Basket#setChannelType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setChannelType", + "tags": [ + "setchanneltype", + "basket.setchanneltype" + ], + "title": "Basket.setChannelType" + }, + { + "id": "script-api:dw/order/Basket#setCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setCustomerNo", + "tags": [ + "setcustomerno", + "basket.setcustomerno" + ], + "title": "Basket.setCustomerNo" + }, + { + "id": "script-api:dw/order/Basket#startCheckout", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.startCheckout", + "tags": [ + "startcheckout", + "basket.startcheckout" + ], + "title": "Basket.startCheckout" + }, + { + "id": "script-api:dw/order/Basket#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.taxRoundedAtGroup", + "tags": [ + "taxroundedatgroup", + "basket.taxroundedatgroup" + ], + "title": "Basket.taxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/Basket#temporary", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.temporary", + "tags": [ + "temporary", + "basket.temporary" + ], + "title": "Basket.temporary" + }, + { + "id": "script-api:dw/order/Basket#updateCurrency", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.updateCurrency", + "tags": [ + "updatecurrency", + "basket.updatecurrency" + ], + "title": "Basket.updateCurrency" + }, + { + "id": "script-api:dw/order/BasketMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.BasketMgr", + "tags": [ + "basketmgr", + "dw.order.basketmgr", + "dw/order" + ], + "title": "BasketMgr" + }, + { + "id": "script-api:dw/order/BasketMgr#baskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.baskets", + "tags": [ + "baskets", + "basketmgr.baskets" + ], + "title": "BasketMgr.baskets" + }, + { + "id": "script-api:dw/order/BasketMgr#baskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.baskets", + "tags": [ + "baskets", + "basketmgr.baskets" + ], + "title": "BasketMgr.baskets" + }, + { + "id": "script-api:dw/order/BasketMgr#createAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createAgentBasket", + "tags": [ + "createagentbasket", + "basketmgr.createagentbasket" + ], + "title": "BasketMgr.createAgentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#createAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createAgentBasket", + "tags": [ + "createagentbasket", + "basketmgr.createagentbasket" + ], + "title": "BasketMgr.createAgentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#createBasketFromOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createBasketFromOrder", + "tags": [ + "createbasketfromorder", + "basketmgr.createbasketfromorder" + ], + "title": "BasketMgr.createBasketFromOrder" + }, + { + "id": "script-api:dw/order/BasketMgr#createBasketFromOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createBasketFromOrder", + "tags": [ + "createbasketfromorder", + "basketmgr.createbasketfromorder" + ], + "title": "BasketMgr.createBasketFromOrder" + }, + { + "id": "script-api:dw/order/BasketMgr#createTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createTemporaryBasket", + "tags": [ + "createtemporarybasket", + "basketmgr.createtemporarybasket" + ], + "title": "BasketMgr.createTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#createTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createTemporaryBasket", + "tags": [ + "createtemporarybasket", + "basketmgr.createtemporarybasket" + ], + "title": "BasketMgr.createTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#currentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentBasket", + "tags": [ + "currentbasket", + "basketmgr.currentbasket" + ], + "title": "BasketMgr.currentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#currentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentBasket", + "tags": [ + "currentbasket", + "basketmgr.currentbasket" + ], + "title": "BasketMgr.currentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#currentOrNewBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentOrNewBasket", + "tags": [ + "currentornewbasket", + "basketmgr.currentornewbasket" + ], + "title": "BasketMgr.currentOrNewBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#currentOrNewBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentOrNewBasket", + "tags": [ + "currentornewbasket", + "basketmgr.currentornewbasket" + ], + "title": "BasketMgr.currentOrNewBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#deleteBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteBasket", + "tags": [ + "deletebasket", + "basketmgr.deletebasket" + ], + "title": "BasketMgr.deleteBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#deleteBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteBasket", + "tags": [ + "deletebasket", + "basketmgr.deletebasket" + ], + "title": "BasketMgr.deleteBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#deleteTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteTemporaryBasket", + "tags": [ + "deletetemporarybasket", + "basketmgr.deletetemporarybasket" + ], + "title": "BasketMgr.deleteTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#deleteTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteTemporaryBasket", + "tags": [ + "deletetemporarybasket", + "basketmgr.deletetemporarybasket" + ], + "title": "BasketMgr.deleteTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBasket", + "tags": [ + "getbasket", + "basketmgr.getbasket" + ], + "title": "BasketMgr.getBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBasket", + "tags": [ + "getbasket", + "basketmgr.getbasket" + ], + "title": "BasketMgr.getBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBaskets", + "tags": [ + "getbaskets", + "basketmgr.getbaskets" + ], + "title": "BasketMgr.getBaskets" + }, + { + "id": "script-api:dw/order/BasketMgr#getBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBaskets", + "tags": [ + "getbaskets", + "basketmgr.getbaskets" + ], + "title": "BasketMgr.getBaskets" + }, + { + "id": "script-api:dw/order/BasketMgr#getCurrentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentBasket", + "tags": [ + "getcurrentbasket", + "basketmgr.getcurrentbasket" + ], + "title": "BasketMgr.getCurrentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getCurrentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentBasket", + "tags": [ + "getcurrentbasket", + "basketmgr.getcurrentbasket" + ], + "title": "BasketMgr.getCurrentBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getCurrentOrNewBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentOrNewBasket", + "tags": [ + "getcurrentornewbasket", + "basketmgr.getcurrentornewbasket" + ], + "title": "BasketMgr.getCurrentOrNewBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getCurrentOrNewBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentOrNewBasket", + "tags": [ + "getcurrentornewbasket", + "basketmgr.getcurrentornewbasket" + ], + "title": "BasketMgr.getCurrentOrNewBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getStoredBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getStoredBasket", + "tags": [ + "getstoredbasket", + "basketmgr.getstoredbasket" + ], + "title": "BasketMgr.getStoredBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getStoredBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getStoredBasket", + "tags": [ + "getstoredbasket", + "basketmgr.getstoredbasket" + ], + "title": "BasketMgr.getStoredBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBasket", + "tags": [ + "gettemporarybasket", + "basketmgr.gettemporarybasket" + ], + "title": "BasketMgr.getTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBasket", + "tags": [ + "gettemporarybasket", + "basketmgr.gettemporarybasket" + ], + "title": "BasketMgr.getTemporaryBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#getTemporaryBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBaskets", + "tags": [ + "gettemporarybaskets", + "basketmgr.gettemporarybaskets" + ], + "title": "BasketMgr.getTemporaryBaskets" + }, + { + "id": "script-api:dw/order/BasketMgr#getTemporaryBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBaskets", + "tags": [ + "gettemporarybaskets", + "basketmgr.gettemporarybaskets" + ], + "title": "BasketMgr.getTemporaryBaskets" + }, + { + "id": "script-api:dw/order/BasketMgr#storedBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.storedBasket", + "tags": [ + "storedbasket", + "basketmgr.storedbasket" + ], + "title": "BasketMgr.storedBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#storedBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.storedBasket", + "tags": [ + "storedbasket", + "basketmgr.storedbasket" + ], + "title": "BasketMgr.storedBasket" + }, + { + "id": "script-api:dw/order/BasketMgr#temporaryBaskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.temporaryBaskets", + "tags": [ + "temporarybaskets", + "basketmgr.temporarybaskets" + ], + "title": "BasketMgr.temporaryBaskets" + }, + { + "id": "script-api:dw/order/BasketMgr#temporaryBaskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.temporaryBaskets", + "tags": [ + "temporarybaskets", + "basketmgr.temporarybaskets" + ], + "title": "BasketMgr.temporaryBaskets" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.BonusDiscountLineItem", + "tags": [ + "bonusdiscountlineitem", + "dw.order.bonusdiscountlineitem", + "dw/order" + ], + "title": "BonusDiscountLineItem" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#bonusChoiceRuleBased", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusChoiceRuleBased", + "tags": [ + "bonuschoicerulebased", + "bonusdiscountlineitem.bonuschoicerulebased" + ], + "title": "BonusDiscountLineItem.bonusChoiceRuleBased" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#bonusProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusProductLineItems", + "tags": [ + "bonusproductlineitems", + "bonusdiscountlineitem.bonusproductlineitems" + ], + "title": "BonusDiscountLineItem.bonusProductLineItems" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#bonusProducts", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusProducts", + "tags": [ + "bonusproducts", + "bonusdiscountlineitem.bonusproducts" + ], + "title": "BonusDiscountLineItem.bonusProducts" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#couponLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.couponLineItem", + "tags": [ + "couponlineitem", + "bonusdiscountlineitem.couponlineitem" + ], + "title": "BonusDiscountLineItem.couponLineItem" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProductLineItems", + "tags": [ + "getbonusproductlineitems", + "bonusdiscountlineitem.getbonusproductlineitems" + ], + "title": "BonusDiscountLineItem.getBonusProductLineItems" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProductPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProductPrice", + "tags": [ + "getbonusproductprice", + "bonusdiscountlineitem.getbonusproductprice" + ], + "title": "BonusDiscountLineItem.getBonusProductPrice" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProducts", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProducts", + "tags": [ + "getbonusproducts", + "bonusdiscountlineitem.getbonusproducts" + ], + "title": "BonusDiscountLineItem.getBonusProducts" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getCouponLineItem", + "tags": [ + "getcouponlineitem", + "bonusdiscountlineitem.getcouponlineitem" + ], + "title": "BonusDiscountLineItem.getCouponLineItem" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getMaxBonusItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getMaxBonusItems", + "tags": [ + "getmaxbonusitems", + "bonusdiscountlineitem.getmaxbonusitems" + ], + "title": "BonusDiscountLineItem.getMaxBonusItems" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getPromotion", + "tags": [ + "getpromotion", + "bonusdiscountlineitem.getpromotion" + ], + "title": "BonusDiscountLineItem.getPromotion" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getPromotionID", + "tags": [ + "getpromotionid", + "bonusdiscountlineitem.getpromotionid" + ], + "title": "BonusDiscountLineItem.getPromotionID" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#isBonusChoiceRuleBased", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.isBonusChoiceRuleBased", + "tags": [ + "isbonuschoicerulebased", + "bonusdiscountlineitem.isbonuschoicerulebased" + ], + "title": "BonusDiscountLineItem.isBonusChoiceRuleBased" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#maxBonusItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.maxBonusItems", + "tags": [ + "maxbonusitems", + "bonusdiscountlineitem.maxbonusitems" + ], + "title": "BonusDiscountLineItem.maxBonusItems" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.promotion", + "tags": [ + "promotion", + "bonusdiscountlineitem.promotion" + ], + "title": "BonusDiscountLineItem.promotion" + }, + { + "id": "script-api:dw/order/BonusDiscountLineItem#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.promotionID", + "tags": [ + "promotionid", + "bonusdiscountlineitem.promotionid" + ], + "title": "BonusDiscountLineItem.promotionID" + }, + { + "id": "script-api:dw/order/CouponLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CouponLineItem", + "tags": [ + "couponlineitem", + "dw.order.couponlineitem", + "dw/order" + ], + "title": "CouponLineItem" + }, + { + "id": "script-api:dw/order/CouponLineItem#applied", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.applied", + "tags": [ + "applied", + "couponlineitem.applied" + ], + "title": "CouponLineItem.applied" + }, + { + "id": "script-api:dw/order/CouponLineItem#associatePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.associatePriceAdjustment", + "tags": [ + "associatepriceadjustment", + "couponlineitem.associatepriceadjustment" + ], + "title": "CouponLineItem.associatePriceAdjustment" + }, + { + "id": "script-api:dw/order/CouponLineItem#basedOnCampaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.basedOnCampaign", + "tags": [ + "basedoncampaign", + "couponlineitem.basedoncampaign" + ], + "title": "CouponLineItem.basedOnCampaign" + }, + { + "id": "script-api:dw/order/CouponLineItem#bonusDiscountLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.bonusDiscountLineItems", + "tags": [ + "bonusdiscountlineitems", + "couponlineitem.bonusdiscountlineitems" + ], + "title": "CouponLineItem.bonusDiscountLineItems" + }, + { + "id": "script-api:dw/order/CouponLineItem#couponCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.couponCode", + "tags": [ + "couponcode", + "couponlineitem.couponcode" + ], + "title": "CouponLineItem.couponCode" + }, + { + "id": "script-api:dw/order/CouponLineItem#getBonusDiscountLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getBonusDiscountLineItems", + "tags": [ + "getbonusdiscountlineitems", + "couponlineitem.getbonusdiscountlineitems" + ], + "title": "CouponLineItem.getBonusDiscountLineItems" + }, + { + "id": "script-api:dw/order/CouponLineItem#getCouponCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getCouponCode", + "tags": [ + "getcouponcode", + "couponlineitem.getcouponcode" + ], + "title": "CouponLineItem.getCouponCode" + }, + { + "id": "script-api:dw/order/CouponLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPriceAdjustments", + "tags": [ + "getpriceadjustments", + "couponlineitem.getpriceadjustments" + ], + "title": "CouponLineItem.getPriceAdjustments" + }, + { + "id": "script-api:dw/order/CouponLineItem#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPromotion", + "tags": [ + "getpromotion", + "couponlineitem.getpromotion" + ], + "title": "CouponLineItem.getPromotion" + }, + { + "id": "script-api:dw/order/CouponLineItem#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPromotionID", + "tags": [ + "getpromotionid", + "couponlineitem.getpromotionid" + ], + "title": "CouponLineItem.getPromotionID" + }, + { + "id": "script-api:dw/order/CouponLineItem#getStatusCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getStatusCode", + "tags": [ + "getstatuscode", + "couponlineitem.getstatuscode" + ], + "title": "CouponLineItem.getStatusCode" + }, + { + "id": "script-api:dw/order/CouponLineItem#isApplied", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isApplied", + "tags": [ + "isapplied", + "couponlineitem.isapplied" + ], + "title": "CouponLineItem.isApplied" + }, + { + "id": "script-api:dw/order/CouponLineItem#isBasedOnCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isBasedOnCampaign", + "tags": [ + "isbasedoncampaign", + "couponlineitem.isbasedoncampaign" + ], + "title": "CouponLineItem.isBasedOnCampaign" + }, + { + "id": "script-api:dw/order/CouponLineItem#isValid", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isValid", + "tags": [ + "isvalid", + "couponlineitem.isvalid" + ], + "title": "CouponLineItem.isValid" + }, + { + "id": "script-api:dw/order/CouponLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.priceAdjustments", + "tags": [ + "priceadjustments", + "couponlineitem.priceadjustments" + ], + "title": "CouponLineItem.priceAdjustments" + }, + { + "id": "script-api:dw/order/CouponLineItem#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.promotion", + "tags": [ + "promotion", + "couponlineitem.promotion" + ], + "title": "CouponLineItem.promotion" + }, + { + "id": "script-api:dw/order/CouponLineItem#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.promotionID", + "tags": [ + "promotionid", + "couponlineitem.promotionid" + ], + "title": "CouponLineItem.promotionID" + }, + { + "id": "script-api:dw/order/CouponLineItem#statusCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.statusCode", + "tags": [ + "statuscode", + "couponlineitem.statuscode" + ], + "title": "CouponLineItem.statusCode" + }, + { + "id": "script-api:dw/order/CouponLineItem#valid", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.valid", + "tags": [ + "valid", + "couponlineitem.valid" + ], + "title": "CouponLineItem.valid" + }, + { + "id": "script-api:dw/order/CreateAgentBasketLimitExceededException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateAgentBasketLimitExceededException", + "tags": [ + "createagentbasketlimitexceededexception", + "dw.order.createagentbasketlimitexceededexception", + "dw/order" + ], + "title": "CreateAgentBasketLimitExceededException" + }, + { + "id": "script-api:dw/order/CreateBasketFromOrderException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateBasketFromOrderException", + "tags": [ + "createbasketfromorderexception", + "dw.order.createbasketfromorderexception", + "dw/order" + ], + "title": "CreateBasketFromOrderException" + }, + { + "id": "script-api:dw/order/CreateBasketFromOrderException#errorCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateBasketFromOrderException", + "qualifiedName": "dw.order.CreateBasketFromOrderException.errorCode", + "tags": [ + "errorcode", + "createbasketfromorderexception.errorcode" + ], + "title": "CreateBasketFromOrderException.errorCode" + }, + { + "id": "script-api:dw/order/CreateBasketFromOrderException#getErrorCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateBasketFromOrderException", + "qualifiedName": "dw.order.CreateBasketFromOrderException.getErrorCode", + "tags": [ + "geterrorcode", + "createbasketfromorderexception.geterrorcode" + ], + "title": "CreateBasketFromOrderException.getErrorCode" + }, + { + "id": "script-api:dw/order/CreateCouponLineItemException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateCouponLineItemException", + "tags": [ + "createcouponlineitemexception", + "dw.order.createcouponlineitemexception", + "dw/order" + ], + "title": "CreateCouponLineItemException" + }, + { + "id": "script-api:dw/order/CreateCouponLineItemException#errorCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateCouponLineItemException", + "qualifiedName": "dw.order.CreateCouponLineItemException.errorCode", + "tags": [ + "errorcode", + "createcouponlineitemexception.errorcode" + ], + "title": "CreateCouponLineItemException.errorCode" + }, + { + "id": "script-api:dw/order/CreateCouponLineItemException#getErrorCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateCouponLineItemException", + "qualifiedName": "dw.order.CreateCouponLineItemException.getErrorCode", + "tags": [ + "geterrorcode", + "createcouponlineitemexception.geterrorcode" + ], + "title": "CreateCouponLineItemException.getErrorCode" + }, + { + "id": "script-api:dw/order/CreateOrderException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateOrderException", + "tags": [ + "createorderexception", + "dw.order.createorderexception", + "dw/order" + ], + "title": "CreateOrderException" + }, + { + "id": "script-api:dw/order/CreateTemporaryBasketLimitExceededException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateTemporaryBasketLimitExceededException", + "tags": [ + "createtemporarybasketlimitexceededexception", + "dw.order.createtemporarybasketlimitexceededexception", + "dw/order" + ], + "title": "CreateTemporaryBasketLimitExceededException" + }, + { + "id": "script-api:dw/order/GiftCertificate", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificate", + "tags": [ + "giftcertificate", + "dw.order.giftcertificate", + "dw/order" + ], + "title": "GiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificate#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.ID", + "tags": [ + "id", + "giftcertificate.id" + ], + "title": "GiftCertificate.ID" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_ISSUED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_ISSUED", + "tags": [ + "status_issued", + "giftcertificate.status_issued" + ], + "title": "GiftCertificate.STATUS_ISSUED" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_ISSUED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_ISSUED", + "tags": [ + "status_issued", + "giftcertificate.status_issued" + ], + "title": "GiftCertificate.STATUS_ISSUED" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_PARTIALLY_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PARTIALLY_REDEEMED", + "tags": [ + "status_partially_redeemed", + "giftcertificate.status_partially_redeemed" + ], + "title": "GiftCertificate.STATUS_PARTIALLY_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_PARTIALLY_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PARTIALLY_REDEEMED", + "tags": [ + "status_partially_redeemed", + "giftcertificate.status_partially_redeemed" + ], + "title": "GiftCertificate.STATUS_PARTIALLY_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PENDING", + "tags": [ + "status_pending", + "giftcertificate.status_pending" + ], + "title": "GiftCertificate.STATUS_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PENDING", + "tags": [ + "status_pending", + "giftcertificate.status_pending" + ], + "title": "GiftCertificate.STATUS_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_REDEEMED", + "tags": [ + "status_redeemed", + "giftcertificate.status_redeemed" + ], + "title": "GiftCertificate.STATUS_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificate#STATUS_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_REDEEMED", + "tags": [ + "status_redeemed", + "giftcertificate.status_redeemed" + ], + "title": "GiftCertificate.STATUS_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificate#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.amount", + "tags": [ + "amount", + "giftcertificate.amount" + ], + "title": "GiftCertificate.amount" + }, + { + "id": "script-api:dw/order/GiftCertificate#balance", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.balance", + "tags": [ + "balance", + "giftcertificate.balance" + ], + "title": "GiftCertificate.balance" + }, + { + "id": "script-api:dw/order/GiftCertificate#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.description", + "tags": [ + "description", + "giftcertificate.description" + ], + "title": "GiftCertificate.description" + }, + { + "id": "script-api:dw/order/GiftCertificate#enabled", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.enabled", + "tags": [ + "enabled", + "giftcertificate.enabled" + ], + "title": "GiftCertificate.enabled" + }, + { + "id": "script-api:dw/order/GiftCertificate#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getAmount", + "tags": [ + "getamount", + "giftcertificate.getamount" + ], + "title": "GiftCertificate.getAmount" + }, + { + "id": "script-api:dw/order/GiftCertificate#getBalance", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getBalance", + "tags": [ + "getbalance", + "giftcertificate.getbalance" + ], + "title": "GiftCertificate.getBalance" + }, + { + "id": "script-api:dw/order/GiftCertificate#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getDescription", + "tags": [ + "getdescription", + "giftcertificate.getdescription" + ], + "title": "GiftCertificate.getDescription" + }, + { + "id": "script-api:dw/order/GiftCertificate#getGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getGiftCertificateCode", + "tags": [ + "getgiftcertificatecode", + "giftcertificate.getgiftcertificatecode" + ], + "title": "GiftCertificate.getGiftCertificateCode" + }, + { + "id": "script-api:dw/order/GiftCertificate#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getID", + "tags": [ + "getid", + "giftcertificate.getid" + ], + "title": "GiftCertificate.getID" + }, + { + "id": "script-api:dw/order/GiftCertificate#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMaskedGiftCertificateCode", + "tags": [ + "getmaskedgiftcertificatecode", + "giftcertificate.getmaskedgiftcertificatecode" + ], + "title": "GiftCertificate.getMaskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/GiftCertificate#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMaskedGiftCertificateCode", + "tags": [ + "getmaskedgiftcertificatecode", + "giftcertificate.getmaskedgiftcertificatecode" + ], + "title": "GiftCertificate.getMaskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/GiftCertificate#getMerchantID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMerchantID", + "tags": [ + "getmerchantid", + "giftcertificate.getmerchantid" + ], + "title": "GiftCertificate.getMerchantID" + }, + { + "id": "script-api:dw/order/GiftCertificate#getMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMessage", + "tags": [ + "getmessage", + "giftcertificate.getmessage" + ], + "title": "GiftCertificate.getMessage" + }, + { + "id": "script-api:dw/order/GiftCertificate#getOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getOrderNo", + "tags": [ + "getorderno", + "giftcertificate.getorderno" + ], + "title": "GiftCertificate.getOrderNo" + }, + { + "id": "script-api:dw/order/GiftCertificate#getRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getRecipientEmail", + "tags": [ + "getrecipientemail", + "giftcertificate.getrecipientemail" + ], + "title": "GiftCertificate.getRecipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificate#getRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getRecipientName", + "tags": [ + "getrecipientname", + "giftcertificate.getrecipientname" + ], + "title": "GiftCertificate.getRecipientName" + }, + { + "id": "script-api:dw/order/GiftCertificate#getSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getSenderName", + "tags": [ + "getsendername", + "giftcertificate.getsendername" + ], + "title": "GiftCertificate.getSenderName" + }, + { + "id": "script-api:dw/order/GiftCertificate#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getStatus", + "tags": [ + "getstatus", + "giftcertificate.getstatus" + ], + "title": "GiftCertificate.getStatus" + }, + { + "id": "script-api:dw/order/GiftCertificate#giftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.giftCertificateCode", + "tags": [ + "giftcertificatecode", + "giftcertificate.giftcertificatecode" + ], + "title": "GiftCertificate.giftCertificateCode" + }, + { + "id": "script-api:dw/order/GiftCertificate#isEnabled", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.isEnabled", + "tags": [ + "isenabled", + "giftcertificate.isenabled" + ], + "title": "GiftCertificate.isEnabled" + }, + { + "id": "script-api:dw/order/GiftCertificate#maskedGiftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.maskedGiftCertificateCode", + "tags": [ + "maskedgiftcertificatecode", + "giftcertificate.maskedgiftcertificatecode" + ], + "title": "GiftCertificate.maskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/GiftCertificate#merchantID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.merchantID", + "tags": [ + "merchantid", + "giftcertificate.merchantid" + ], + "title": "GiftCertificate.merchantID" + }, + { + "id": "script-api:dw/order/GiftCertificate#message", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.message", + "tags": [ + "message", + "giftcertificate.message" + ], + "title": "GiftCertificate.message" + }, + { + "id": "script-api:dw/order/GiftCertificate#orderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.orderNo", + "tags": [ + "orderno", + "giftcertificate.orderno" + ], + "title": "GiftCertificate.orderNo" + }, + { + "id": "script-api:dw/order/GiftCertificate#recipientEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.recipientEmail", + "tags": [ + "recipientemail", + "giftcertificate.recipientemail" + ], + "title": "GiftCertificate.recipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificate#recipientName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.recipientName", + "tags": [ + "recipientname", + "giftcertificate.recipientname" + ], + "title": "GiftCertificate.recipientName" + }, + { + "id": "script-api:dw/order/GiftCertificate#senderName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.senderName", + "tags": [ + "sendername", + "giftcertificate.sendername" + ], + "title": "GiftCertificate.senderName" + }, + { + "id": "script-api:dw/order/GiftCertificate#setDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setDescription", + "tags": [ + "setdescription", + "giftcertificate.setdescription" + ], + "title": "GiftCertificate.setDescription" + }, + { + "id": "script-api:dw/order/GiftCertificate#setEnabled", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setEnabled", + "tags": [ + "setenabled", + "giftcertificate.setenabled" + ], + "title": "GiftCertificate.setEnabled" + }, + { + "id": "script-api:dw/order/GiftCertificate#setMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setMessage", + "tags": [ + "setmessage", + "giftcertificate.setmessage" + ], + "title": "GiftCertificate.setMessage" + }, + { + "id": "script-api:dw/order/GiftCertificate#setOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setOrderNo", + "tags": [ + "setorderno", + "giftcertificate.setorderno" + ], + "title": "GiftCertificate.setOrderNo" + }, + { + "id": "script-api:dw/order/GiftCertificate#setRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setRecipientEmail", + "tags": [ + "setrecipientemail", + "giftcertificate.setrecipientemail" + ], + "title": "GiftCertificate.setRecipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificate#setRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setRecipientName", + "tags": [ + "setrecipientname", + "giftcertificate.setrecipientname" + ], + "title": "GiftCertificate.setRecipientName" + }, + { + "id": "script-api:dw/order/GiftCertificate#setSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setSenderName", + "tags": [ + "setsendername", + "giftcertificate.setsendername" + ], + "title": "GiftCertificate.setSenderName" + }, + { + "id": "script-api:dw/order/GiftCertificate#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setStatus", + "tags": [ + "setstatus", + "giftcertificate.setstatus" + ], + "title": "GiftCertificate.setStatus" + }, + { + "id": "script-api:dw/order/GiftCertificate#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.status", + "tags": [ + "status", + "giftcertificate.status" + ], + "title": "GiftCertificate.status" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateLineItem", + "tags": [ + "giftcertificatelineitem", + "dw.order.giftcertificatelineitem", + "dw/order" + ], + "title": "GiftCertificateLineItem" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getGiftCertificateID", + "tags": [ + "getgiftcertificateid", + "giftcertificatelineitem.getgiftcertificateid" + ], + "title": "GiftCertificateLineItem.getGiftCertificateID" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getMessage", + "tags": [ + "getmessage", + "giftcertificatelineitem.getmessage" + ], + "title": "GiftCertificateLineItem.getMessage" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getProductListItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getProductListItem", + "tags": [ + "getproductlistitem", + "giftcertificatelineitem.getproductlistitem" + ], + "title": "GiftCertificateLineItem.getProductListItem" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getRecipientEmail", + "tags": [ + "getrecipientemail", + "giftcertificatelineitem.getrecipientemail" + ], + "title": "GiftCertificateLineItem.getRecipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getRecipientName", + "tags": [ + "getrecipientname", + "giftcertificatelineitem.getrecipientname" + ], + "title": "GiftCertificateLineItem.getRecipientName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getSenderName", + "tags": [ + "getsendername", + "giftcertificatelineitem.getsendername" + ], + "title": "GiftCertificateLineItem.getSenderName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getShipment", + "tags": [ + "getshipment", + "giftcertificatelineitem.getshipment" + ], + "title": "GiftCertificateLineItem.getShipment" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#giftCertificateID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.giftCertificateID", + "tags": [ + "giftcertificateid", + "giftcertificatelineitem.giftcertificateid" + ], + "title": "GiftCertificateLineItem.giftCertificateID" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#message", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.message", + "tags": [ + "message", + "giftcertificatelineitem.message" + ], + "title": "GiftCertificateLineItem.message" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#productListItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.productListItem", + "tags": [ + "productlistitem", + "giftcertificatelineitem.productlistitem" + ], + "title": "GiftCertificateLineItem.productListItem" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#recipientEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.recipientEmail", + "tags": [ + "recipientemail", + "giftcertificatelineitem.recipientemail" + ], + "title": "GiftCertificateLineItem.recipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#recipientName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.recipientName", + "tags": [ + "recipientname", + "giftcertificatelineitem.recipientname" + ], + "title": "GiftCertificateLineItem.recipientName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#senderName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.senderName", + "tags": [ + "sendername", + "giftcertificatelineitem.sendername" + ], + "title": "GiftCertificateLineItem.senderName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setGiftCertificateID", + "tags": [ + "setgiftcertificateid", + "giftcertificatelineitem.setgiftcertificateid" + ], + "title": "GiftCertificateLineItem.setGiftCertificateID" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setMessage", + "tags": [ + "setmessage", + "giftcertificatelineitem.setmessage" + ], + "title": "GiftCertificateLineItem.setMessage" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setProductListItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setProductListItem", + "tags": [ + "setproductlistitem", + "giftcertificatelineitem.setproductlistitem" + ], + "title": "GiftCertificateLineItem.setProductListItem" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setRecipientEmail", + "tags": [ + "setrecipientemail", + "giftcertificatelineitem.setrecipientemail" + ], + "title": "GiftCertificateLineItem.setRecipientEmail" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setRecipientName", + "tags": [ + "setrecipientname", + "giftcertificatelineitem.setrecipientname" + ], + "title": "GiftCertificateLineItem.setRecipientName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setSenderName", + "tags": [ + "setsendername", + "giftcertificatelineitem.setsendername" + ], + "title": "GiftCertificateLineItem.setSenderName" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#setShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setShipment", + "tags": [ + "setshipment", + "giftcertificatelineitem.setshipment" + ], + "title": "GiftCertificateLineItem.setShipment" + }, + { + "id": "script-api:dw/order/GiftCertificateLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.shipment", + "tags": [ + "shipment", + "giftcertificatelineitem.shipment" + ], + "title": "GiftCertificateLineItem.shipment" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateMgr", + "tags": [ + "giftcertificatemgr", + "dw.order.giftcertificatemgr", + "dw/order" + ], + "title": "GiftCertificateMgr" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_DISABLED", + "tags": [ + "gc_error_disabled", + "giftcertificatemgr.gc_error_disabled" + ], + "title": "GiftCertificateMgr.GC_ERROR_DISABLED" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_DISABLED", + "tags": [ + "gc_error_disabled", + "giftcertificatemgr.gc_error_disabled" + ], + "title": "GiftCertificateMgr.GC_ERROR_DISABLED" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE", + "tags": [ + "gc_error_insufficient_balance", + "giftcertificatemgr.gc_error_insufficient_balance" + ], + "title": "GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE", + "tags": [ + "gc_error_insufficient_balance", + "giftcertificatemgr.gc_error_insufficient_balance" + ], + "title": "GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_AMOUNT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT", + "tags": [ + "gc_error_invalid_amount", + "giftcertificatemgr.gc_error_invalid_amount" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_AMOUNT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT", + "tags": [ + "gc_error_invalid_amount", + "giftcertificatemgr.gc_error_invalid_amount" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_CODE", + "tags": [ + "gc_error_invalid_code", + "giftcertificatemgr.gc_error_invalid_code" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_CODE" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_CODE", + "tags": [ + "gc_error_invalid_code", + "giftcertificatemgr.gc_error_invalid_code" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_CODE" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_PENDING", + "tags": [ + "gc_error_pending", + "giftcertificatemgr.gc_error_pending" + ], + "title": "GiftCertificateMgr.GC_ERROR_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_PENDING", + "tags": [ + "gc_error_pending", + "giftcertificatemgr.gc_error_pending" + ], + "title": "GiftCertificateMgr.GC_ERROR_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_REDEEMED", + "tags": [ + "gc_error_redeemed", + "giftcertificatemgr.gc_error_redeemed" + ], + "title": "GiftCertificateMgr.GC_ERROR_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_REDEEMED", + "tags": [ + "gc_error_redeemed", + "giftcertificatemgr.gc_error_redeemed" + ], + "title": "GiftCertificateMgr.GC_ERROR_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificate", + "tags": [ + "getgiftcertificate", + "giftcertificatemgr.getgiftcertificate" + ], + "title": "GiftCertificateMgr.getGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificate", + "tags": [ + "getgiftcertificate", + "giftcertificatemgr.getgiftcertificate" + ], + "title": "GiftCertificateMgr.getGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByCode", + "tags": [ + "getgiftcertificatebycode", + "giftcertificatemgr.getgiftcertificatebycode" + ], + "title": "GiftCertificateMgr.getGiftCertificateByCode" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByCode", + "tags": [ + "getgiftcertificatebycode", + "giftcertificatemgr.getgiftcertificatebycode" + ], + "title": "GiftCertificateMgr.getGiftCertificateByCode" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByMerchantID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByMerchantID", + "tags": [ + "getgiftcertificatebymerchantid", + "giftcertificatemgr.getgiftcertificatebymerchantid" + ], + "title": "GiftCertificateMgr.getGiftCertificateByMerchantID" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByMerchantID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByMerchantID", + "tags": [ + "getgiftcertificatebymerchantid", + "giftcertificatemgr.getgiftcertificatebymerchantid" + ], + "title": "GiftCertificateMgr.getGiftCertificateByMerchantID" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#redeemGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.redeemGiftCertificate", + "tags": [ + "redeemgiftcertificate", + "giftcertificatemgr.redeemgiftcertificate" + ], + "title": "GiftCertificateMgr.redeemGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateMgr#redeemGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.redeemGiftCertificate", + "tags": [ + "redeemgiftcertificate", + "giftcertificatemgr.redeemgiftcertificate" + ], + "title": "GiftCertificateMgr.redeemGiftCertificate" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateStatusCodes", + "tags": [ + "giftcertificatestatuscodes", + "dw.order.giftcertificatestatuscodes", + "dw/order" + ], + "title": "GiftCertificateStatusCodes" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_CURRENCY_MISMATCH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH", + "tags": [ + "giftcertificate_currency_mismatch", + "giftcertificatestatuscodes.giftcertificate_currency_mismatch" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_CURRENCY_MISMATCH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH", + "tags": [ + "giftcertificate_currency_mismatch", + "giftcertificatestatuscodes.giftcertificate_currency_mismatch" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED", + "tags": [ + "giftcertificate_disabled", + "giftcertificatestatuscodes.giftcertificate_disabled" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED", + "tags": [ + "giftcertificate_disabled", + "giftcertificatestatuscodes.giftcertificate_disabled" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "tags": [ + "giftcertificate_insufficient_balance", + "giftcertificatestatuscodes.giftcertificate_insufficient_balance" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "tags": [ + "giftcertificate_insufficient_balance", + "giftcertificatestatuscodes.giftcertificate_insufficient_balance" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND", + "tags": [ + "giftcertificate_not_found", + "giftcertificatestatuscodes.giftcertificate_not_found" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND", + "tags": [ + "giftcertificate_not_found", + "giftcertificatestatuscodes.giftcertificate_not_found" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING", + "tags": [ + "giftcertificate_pending", + "giftcertificatestatuscodes.giftcertificate_pending" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING", + "tags": [ + "giftcertificate_pending", + "giftcertificatestatuscodes.giftcertificate_pending" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED", + "tags": [ + "giftcertificate_redeemed", + "giftcertificatestatuscodes.giftcertificate_redeemed" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED" + }, + { + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED", + "tags": [ + "giftcertificate_redeemed", + "giftcertificatestatuscodes.giftcertificate_redeemed" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED" + }, + { + "id": "script-api:dw/order/Invoice", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Invoice", + "tags": [ + "invoice", + "dw.order.invoice", + "dw/order" + ], + "title": "Invoice" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_CREATION_DATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_CREATION_DATE", + "tags": [ + "orderby_creation_date", + "invoice.orderby_creation_date" + ], + "title": "Invoice.ORDERBY_CREATION_DATE" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_CREATION_DATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_CREATION_DATE", + "tags": [ + "orderby_creation_date", + "invoice.orderby_creation_date" + ], + "title": "Invoice.ORDERBY_CREATION_DATE" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "invoice.orderby_itemid" + ], + "title": "Invoice.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "invoice.orderby_itemid" + ], + "title": "Invoice.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "invoice.orderby_itemposition" + ], + "title": "Invoice.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "invoice.orderby_itemposition" + ], + "title": "Invoice.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_REVERSE", + "tags": [ + "orderby_reverse", + "invoice.orderby_reverse" + ], + "title": "Invoice.ORDERBY_REVERSE" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_REVERSE", + "tags": [ + "orderby_reverse", + "invoice.orderby_reverse" + ], + "title": "Invoice.ORDERBY_REVERSE" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "invoice.orderby_unsorted" + ], + "title": "Invoice.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Invoice#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "invoice.orderby_unsorted" + ], + "title": "Invoice.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_CAPTURE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_CAPTURE", + "tags": [ + "qualifier_capture", + "invoice.qualifier_capture" + ], + "title": "Invoice.QUALIFIER_CAPTURE" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_CAPTURE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_CAPTURE", + "tags": [ + "qualifier_capture", + "invoice.qualifier_capture" + ], + "title": "Invoice.QUALIFIER_CAPTURE" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "invoice.qualifier_productitems" + ], + "title": "Invoice.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "invoice.qualifier_productitems" + ], + "title": "Invoice.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_REFUND", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_REFUND", + "tags": [ + "qualifier_refund", + "invoice.qualifier_refund" + ], + "title": "Invoice.QUALIFIER_REFUND" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_REFUND", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_REFUND", + "tags": [ + "qualifier_refund", + "invoice.qualifier_refund" + ], + "title": "Invoice.QUALIFIER_REFUND" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "invoice.qualifier_serviceitems" + ], + "title": "Invoice.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Invoice#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "invoice.qualifier_serviceitems" + ], + "title": "Invoice.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_FAILED", + "tags": [ + "status_failed", + "invoice.status_failed" + ], + "title": "Invoice.STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_FAILED", + "tags": [ + "status_failed", + "invoice.status_failed" + ], + "title": "Invoice.STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_MANUAL", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_MANUAL", + "tags": [ + "status_manual", + "invoice.status_manual" + ], + "title": "Invoice.STATUS_MANUAL" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_MANUAL", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_MANUAL", + "tags": [ + "status_manual", + "invoice.status_manual" + ], + "title": "Invoice.STATUS_MANUAL" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_NOT_PAID", + "tags": [ + "status_not_paid", + "invoice.status_not_paid" + ], + "title": "Invoice.STATUS_NOT_PAID" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_NOT_PAID", + "tags": [ + "status_not_paid", + "invoice.status_not_paid" + ], + "title": "Invoice.STATUS_NOT_PAID" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_PAID", + "tags": [ + "status_paid", + "invoice.status_paid" + ], + "title": "Invoice.STATUS_PAID" + }, + { + "id": "script-api:dw/order/Invoice#STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_PAID", + "tags": [ + "status_paid", + "invoice.status_paid" + ], + "title": "Invoice.STATUS_PAID" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_APPEASEMENT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_APPEASEMENT", + "tags": [ + "type_appeasement", + "invoice.type_appeasement" + ], + "title": "Invoice.TYPE_APPEASEMENT" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_APPEASEMENT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_APPEASEMENT", + "tags": [ + "type_appeasement", + "invoice.type_appeasement" + ], + "title": "Invoice.TYPE_APPEASEMENT" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_RETURN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN", + "tags": [ + "type_return", + "invoice.type_return" + ], + "title": "Invoice.TYPE_RETURN" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_RETURN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN", + "tags": [ + "type_return", + "invoice.type_return" + ], + "title": "Invoice.TYPE_RETURN" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_RETURN_CASE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN_CASE", + "tags": [ + "type_return_case", + "invoice.type_return_case" + ], + "title": "Invoice.TYPE_RETURN_CASE" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_RETURN_CASE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN_CASE", + "tags": [ + "type_return_case", + "invoice.type_return_case" + ], + "title": "Invoice.TYPE_RETURN_CASE" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_SHIPPING", + "tags": [ + "type_shipping", + "invoice.type_shipping" + ], + "title": "Invoice.TYPE_SHIPPING" + }, + { + "id": "script-api:dw/order/Invoice#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_SHIPPING", + "tags": [ + "type_shipping", + "invoice.type_shipping" + ], + "title": "Invoice.TYPE_SHIPPING" + }, + { + "id": "script-api:dw/order/Invoice#account", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.account", + "tags": [ + "account", + "invoice.account" + ], + "title": "Invoice.account" + }, + { + "id": "script-api:dw/order/Invoice#addCaptureTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.addCaptureTransaction", + "tags": [ + "addcapturetransaction", + "invoice.addcapturetransaction" + ], + "title": "Invoice.addCaptureTransaction" + }, + { + "id": "script-api:dw/order/Invoice#addRefundTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.addRefundTransaction", + "tags": [ + "addrefundtransaction", + "invoice.addrefundtransaction" + ], + "title": "Invoice.addRefundTransaction" + }, + { + "id": "script-api:dw/order/Invoice#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.capturedAmount", + "tags": [ + "capturedamount", + "invoice.capturedamount" + ], + "title": "Invoice.capturedAmount" + }, + { + "id": "script-api:dw/order/Invoice#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getCapturedAmount", + "tags": [ + "getcapturedamount", + "invoice.getcapturedamount" + ], + "title": "Invoice.getCapturedAmount" + }, + { + "id": "script-api:dw/order/Invoice#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "invoice.getinvoicenumber" + ], + "title": "Invoice.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/Invoice#getPaymentTransactions", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getPaymentTransactions", + "tags": [ + "getpaymenttransactions", + "invoice.getpaymenttransactions" + ], + "title": "Invoice.getPaymentTransactions" + }, + { + "id": "script-api:dw/order/Invoice#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getRefundedAmount", + "tags": [ + "getrefundedamount", + "invoice.getrefundedamount" + ], + "title": "Invoice.getRefundedAmount" + }, + { + "id": "script-api:dw/order/Invoice#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getStatus", + "tags": [ + "getstatus", + "invoice.getstatus" + ], + "title": "Invoice.getStatus" + }, + { + "id": "script-api:dw/order/Invoice#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getType", + "tags": [ + "gettype", + "invoice.gettype" + ], + "title": "Invoice.getType" + }, + { + "id": "script-api:dw/order/Invoice#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.invoiceNumber", + "tags": [ + "invoicenumber", + "invoice.invoicenumber" + ], + "title": "Invoice.invoiceNumber" + }, + { + "id": "script-api:dw/order/Invoice#paymentTransactions", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.paymentTransactions", + "tags": [ + "paymenttransactions", + "invoice.paymenttransactions" + ], + "title": "Invoice.paymentTransactions" + }, + { + "id": "script-api:dw/order/Invoice#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.refundedAmount", + "tags": [ + "refundedamount", + "invoice.refundedamount" + ], + "title": "Invoice.refundedAmount" + }, + { + "id": "script-api:dw/order/Invoice#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.setStatus", + "tags": [ + "setstatus", + "invoice.setstatus" + ], + "title": "Invoice.setStatus" + }, + { + "id": "script-api:dw/order/Invoice#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.status", + "tags": [ + "status", + "invoice.status" + ], + "title": "Invoice.status" + }, + { + "id": "script-api:dw/order/Invoice#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.type", + "tags": [ + "type", + "invoice.type" + ], + "title": "Invoice.type" + }, + { + "id": "script-api:dw/order/InvoiceItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.InvoiceItem", + "tags": [ + "invoiceitem", + "dw.order.invoiceitem", + "dw/order" + ], + "title": "InvoiceItem" + }, + { + "id": "script-api:dw/order/InvoiceItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.basePrice", + "tags": [ + "baseprice", + "invoiceitem.baseprice" + ], + "title": "InvoiceItem.basePrice" + }, + { + "id": "script-api:dw/order/InvoiceItem#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.capturedAmount", + "tags": [ + "capturedamount", + "invoiceitem.capturedamount" + ], + "title": "InvoiceItem.capturedAmount" + }, + { + "id": "script-api:dw/order/InvoiceItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getBasePrice", + "tags": [ + "getbaseprice", + "invoiceitem.getbaseprice" + ], + "title": "InvoiceItem.getBasePrice" + }, + { + "id": "script-api:dw/order/InvoiceItem#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getCapturedAmount", + "tags": [ + "getcapturedamount", + "invoiceitem.getcapturedamount" + ], + "title": "InvoiceItem.getCapturedAmount" + }, + { + "id": "script-api:dw/order/InvoiceItem#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "invoiceitem.getinvoicenumber" + ], + "title": "InvoiceItem.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/InvoiceItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getParentItem", + "tags": [ + "getparentitem", + "invoiceitem.getparentitem" + ], + "title": "InvoiceItem.getParentItem" + }, + { + "id": "script-api:dw/order/InvoiceItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getQuantity", + "tags": [ + "getquantity", + "invoiceitem.getquantity" + ], + "title": "InvoiceItem.getQuantity" + }, + { + "id": "script-api:dw/order/InvoiceItem#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getRefundedAmount", + "tags": [ + "getrefundedamount", + "invoiceitem.getrefundedamount" + ], + "title": "InvoiceItem.getRefundedAmount" + }, + { + "id": "script-api:dw/order/InvoiceItem#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.invoiceNumber", + "tags": [ + "invoicenumber", + "invoiceitem.invoicenumber" + ], + "title": "InvoiceItem.invoiceNumber" + }, + { + "id": "script-api:dw/order/InvoiceItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.parentItem", + "tags": [ + "parentitem", + "invoiceitem.parentitem" + ], + "title": "InvoiceItem.parentItem" + }, + { + "id": "script-api:dw/order/InvoiceItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.quantity", + "tags": [ + "quantity", + "invoiceitem.quantity" + ], + "title": "InvoiceItem.quantity" + }, + { + "id": "script-api:dw/order/InvoiceItem#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.refundedAmount", + "tags": [ + "refundedamount", + "invoiceitem.refundedamount" + ], + "title": "InvoiceItem.refundedAmount" + }, + { + "id": "script-api:dw/order/InvoiceItem#setCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setCapturedAmount", + "tags": [ + "setcapturedamount", + "invoiceitem.setcapturedamount" + ], + "title": "InvoiceItem.setCapturedAmount" + }, + { + "id": "script-api:dw/order/InvoiceItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setParentItem", + "tags": [ + "setparentitem", + "invoiceitem.setparentitem" + ], + "title": "InvoiceItem.setParentItem" + }, + { + "id": "script-api:dw/order/InvoiceItem#setRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setRefundedAmount", + "tags": [ + "setrefundedamount", + "invoiceitem.setrefundedamount" + ], + "title": "InvoiceItem.setRefundedAmount" + }, + { + "id": "script-api:dw/order/LineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItem", + "tags": [ + "lineitem", + "dw.order.lineitem", + "dw/order" + ], + "title": "LineItem" + }, + { + "id": "script-api:dw/order/LineItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.basePrice", + "tags": [ + "baseprice", + "lineitem.baseprice" + ], + "title": "LineItem.basePrice" + }, + { + "id": "script-api:dw/order/LineItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getBasePrice", + "tags": [ + "getbaseprice", + "lineitem.getbaseprice" + ], + "title": "LineItem.getBasePrice" + }, + { + "id": "script-api:dw/order/LineItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getGrossPrice", + "tags": [ + "getgrossprice", + "lineitem.getgrossprice" + ], + "title": "LineItem.getGrossPrice" + }, + { + "id": "script-api:dw/order/LineItem#getLineItemCtnr", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getLineItemCtnr", + "tags": [ + "getlineitemctnr", + "lineitem.getlineitemctnr" + ], + "title": "LineItem.getLineItemCtnr" + }, + { + "id": "script-api:dw/order/LineItem#getLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getLineItemText", + "tags": [ + "getlineitemtext", + "lineitem.getlineitemtext" + ], + "title": "LineItem.getLineItemText" + }, + { + "id": "script-api:dw/order/LineItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getNetPrice", + "tags": [ + "getnetprice", + "lineitem.getnetprice" + ], + "title": "LineItem.getNetPrice" + }, + { + "id": "script-api:dw/order/LineItem#getPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getPrice", + "tags": [ + "getprice", + "lineitem.getprice" + ], + "title": "LineItem.getPrice" + }, + { + "id": "script-api:dw/order/LineItem#getPriceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getPriceValue", + "tags": [ + "getpricevalue", + "lineitem.getpricevalue" + ], + "title": "LineItem.getPriceValue" + }, + { + "id": "script-api:dw/order/LineItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTax", + "tags": [ + "gettax", + "lineitem.gettax" + ], + "title": "LineItem.getTax" + }, + { + "id": "script-api:dw/order/LineItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxBasis", + "tags": [ + "gettaxbasis", + "lineitem.gettaxbasis" + ], + "title": "LineItem.getTaxBasis" + }, + { + "id": "script-api:dw/order/LineItem#getTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxClassID", + "tags": [ + "gettaxclassid", + "lineitem.gettaxclassid" + ], + "title": "LineItem.getTaxClassID" + }, + { + "id": "script-api:dw/order/LineItem#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxRate", + "tags": [ + "gettaxrate", + "lineitem.gettaxrate" + ], + "title": "LineItem.getTaxRate" + }, + { + "id": "script-api:dw/order/LineItem#getTaxes", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxes", + "tags": [ + "gettaxes", + "lineitem.gettaxes" + ], + "title": "LineItem.getTaxes" + }, + { + "id": "script-api:dw/order/LineItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.grossPrice", + "tags": [ + "grossprice", + "lineitem.grossprice" + ], + "title": "LineItem.grossPrice" + }, + { + "id": "script-api:dw/order/LineItem#lineItemCtnr", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.lineItemCtnr", + "tags": [ + "lineitemctnr", + "lineitem.lineitemctnr" + ], + "title": "LineItem.lineItemCtnr" + }, + { + "id": "script-api:dw/order/LineItem#lineItemText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.lineItemText", + "tags": [ + "lineitemtext", + "lineitem.lineitemtext" + ], + "title": "LineItem.lineItemText" + }, + { + "id": "script-api:dw/order/LineItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.netPrice", + "tags": [ + "netprice", + "lineitem.netprice" + ], + "title": "LineItem.netPrice" + }, + { + "id": "script-api:dw/order/LineItem#price", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.price", + "tags": [ + "price", + "lineitem.price" + ], + "title": "LineItem.price" + }, + { + "id": "script-api:dw/order/LineItem#priceValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.priceValue", + "tags": [ + "pricevalue", + "lineitem.pricevalue" + ], + "title": "LineItem.priceValue" + }, + { + "id": "script-api:dw/order/LineItem#setBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setBasePrice", + "tags": [ + "setbaseprice", + "lineitem.setbaseprice" + ], + "title": "LineItem.setBasePrice" + }, + { + "id": "script-api:dw/order/LineItem#setGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setGrossPrice", + "tags": [ + "setgrossprice", + "lineitem.setgrossprice" + ], + "title": "LineItem.setGrossPrice" + }, + { + "id": "script-api:dw/order/LineItem#setLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setLineItemText", + "tags": [ + "setlineitemtext", + "lineitem.setlineitemtext" + ], + "title": "LineItem.setLineItemText" + }, + { + "id": "script-api:dw/order/LineItem#setNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setNetPrice", + "tags": [ + "setnetprice", + "lineitem.setnetprice" + ], + "title": "LineItem.setNetPrice" + }, + { + "id": "script-api:dw/order/LineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setPriceValue", + "tags": [ + "setpricevalue", + "lineitem.setpricevalue" + ], + "title": "LineItem.setPriceValue" + }, + { + "id": "script-api:dw/order/LineItem#setTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTax", + "tags": [ + "settax", + "lineitem.settax" + ], + "title": "LineItem.setTax" + }, + { + "id": "script-api:dw/order/LineItem#setTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxClassID", + "tags": [ + "settaxclassid", + "lineitem.settaxclassid" + ], + "title": "LineItem.setTaxClassID" + }, + { + "id": "script-api:dw/order/LineItem#setTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxRate", + "tags": [ + "settaxrate", + "lineitem.settaxrate" + ], + "title": "LineItem.setTaxRate" + }, + { + "id": "script-api:dw/order/LineItem#setTaxes", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxes", + "tags": [ + "settaxes", + "lineitem.settaxes" + ], + "title": "LineItem.setTaxes" + }, + { + "id": "script-api:dw/order/LineItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.tax", + "tags": [ + "tax", + "lineitem.tax" + ], + "title": "LineItem.tax" + }, + { + "id": "script-api:dw/order/LineItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxBasis", + "tags": [ + "taxbasis", + "lineitem.taxbasis" + ], + "title": "LineItem.taxBasis" + }, + { + "id": "script-api:dw/order/LineItem#taxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxClassID", + "tags": [ + "taxclassid", + "lineitem.taxclassid" + ], + "title": "LineItem.taxClassID" + }, + { + "id": "script-api:dw/order/LineItem#taxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxRate", + "tags": [ + "taxrate", + "lineitem.taxrate" + ], + "title": "LineItem.taxRate" + }, + { + "id": "script-api:dw/order/LineItem#taxes", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxes", + "tags": [ + "taxes", + "lineitem.taxes" + ], + "title": "LineItem.taxes" + }, + { + "id": "script-api:dw/order/LineItem#updatePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updatePrice", + "tags": [ + "updateprice", + "lineitem.updateprice" + ], + "title": "LineItem.updatePrice" + }, + { + "id": "script-api:dw/order/LineItem#updateTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTax", + "tags": [ + "updatetax", + "lineitem.updatetax" + ], + "title": "LineItem.updateTax" + }, + { + "id": "script-api:dw/order/LineItem#updateTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTax", + "tags": [ + "updatetax", + "lineitem.updatetax" + ], + "title": "LineItem.updateTax" + }, + { + "id": "script-api:dw/order/LineItem#updateTaxAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTaxAmount", + "tags": [ + "updatetaxamount", + "lineitem.updatetaxamount" + ], + "title": "LineItem.updateTaxAmount" + }, + { + "id": "script-api:dw/order/LineItemCtnr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItemCtnr", + "tags": [ + "lineitemctnr", + "dw.order.lineitemctnr", + "dw/order" + ], + "title": "LineItemCtnr" + }, + { + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2B", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2B", + "tags": [ + "business_type_b2b", + "lineitemctnr.business_type_b2b" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2B" + }, + { + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2B", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2B", + "tags": [ + "business_type_b2b", + "lineitemctnr.business_type_b2b" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2B" + }, + { + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2C", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2C", + "tags": [ + "business_type_b2c", + "lineitemctnr.business_type_b2c" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2C" + }, + { + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2C", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2C", + "tags": [ + "business_type_b2c", + "lineitemctnr.business_type_b2c" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2C" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CALLCENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CALLCENTER", + "tags": [ + "channel_type_callcenter", + "lineitemctnr.channel_type_callcenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CALLCENTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CALLCENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CALLCENTER", + "tags": [ + "channel_type_callcenter", + "lineitemctnr.channel_type_callcenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CALLCENTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CHATGPT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CHATGPT", + "tags": [ + "channel_type_chatgpt", + "lineitemctnr.channel_type_chatgpt" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CHATGPT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CHATGPT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CHATGPT", + "tags": [ + "channel_type_chatgpt", + "lineitemctnr.channel_type_chatgpt" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CHATGPT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "tags": [ + "channel_type_customerservicecenter", + "lineitemctnr.channel_type_customerservicecenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "tags": [ + "channel_type_customerservicecenter", + "lineitemctnr.channel_type_customerservicecenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_DSS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_DSS", + "tags": [ + "channel_type_dss", + "lineitemctnr.channel_type_dss" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_DSS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_DSS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_DSS", + "tags": [ + "channel_type_dss", + "lineitemctnr.channel_type_dss" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_DSS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_FACEBOOKADS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS", + "tags": [ + "channel_type_facebookads", + "lineitemctnr.channel_type_facebookads" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_FACEBOOKADS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS", + "tags": [ + "channel_type_facebookads", + "lineitemctnr.channel_type_facebookads" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GEMINI", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GEMINI", + "tags": [ + "channel_type_gemini", + "lineitemctnr.channel_type_gemini" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GEMINI" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GEMINI", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GEMINI", + "tags": [ + "channel_type_gemini", + "lineitemctnr.channel_type_gemini" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GEMINI" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GOOGLE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GOOGLE", + "tags": [ + "channel_type_google", + "lineitemctnr.channel_type_google" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GOOGLE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GOOGLE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GOOGLE", + "tags": [ + "channel_type_google", + "lineitemctnr.channel_type_google" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GOOGLE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "tags": [ + "channel_type_instagramcommerce", + "lineitemctnr.channel_type_instagramcommerce" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "tags": [ + "channel_type_instagramcommerce", + "lineitemctnr.channel_type_instagramcommerce" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_MARKETPLACE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_MARKETPLACE", + "tags": [ + "channel_type_marketplace", + "lineitemctnr.channel_type_marketplace" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_MARKETPLACE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_MARKETPLACE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_MARKETPLACE", + "tags": [ + "channel_type_marketplace", + "lineitemctnr.channel_type_marketplace" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_MARKETPLACE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_ONLINERESERVATION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION", + "tags": [ + "channel_type_onlinereservation", + "lineitemctnr.channel_type_onlinereservation" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_ONLINERESERVATION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION", + "tags": [ + "channel_type_onlinereservation", + "lineitemctnr.channel_type_onlinereservation" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_PINTEREST", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_PINTEREST", + "tags": [ + "channel_type_pinterest", + "lineitemctnr.channel_type_pinterest" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_PINTEREST" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_PINTEREST", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_PINTEREST", + "tags": [ + "channel_type_pinterest", + "lineitemctnr.channel_type_pinterest" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_PINTEREST" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SNAPCHAT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SNAPCHAT", + "tags": [ + "channel_type_snapchat", + "lineitemctnr.channel_type_snapchat" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SNAPCHAT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SNAPCHAT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SNAPCHAT", + "tags": [ + "channel_type_snapchat", + "lineitemctnr.channel_type_snapchat" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SNAPCHAT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STORE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STORE", + "tags": [ + "channel_type_store", + "lineitemctnr.channel_type_store" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STORE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STORE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STORE", + "tags": [ + "channel_type_store", + "lineitemctnr.channel_type_store" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STORE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STOREFRONT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STOREFRONT", + "tags": [ + "channel_type_storefront", + "lineitemctnr.channel_type_storefront" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STOREFRONT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STOREFRONT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STOREFRONT", + "tags": [ + "channel_type_storefront", + "lineitemctnr.channel_type_storefront" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STOREFRONT" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SUBSCRIPTIONS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS", + "tags": [ + "channel_type_subscriptions", + "lineitemctnr.channel_type_subscriptions" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SUBSCRIPTIONS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS", + "tags": [ + "channel_type_subscriptions", + "lineitemctnr.channel_type_subscriptions" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TIKTOK", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TIKTOK", + "tags": [ + "channel_type_tiktok", + "lineitemctnr.channel_type_tiktok" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TIKTOK" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TIKTOK", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TIKTOK", + "tags": [ + "channel_type_tiktok", + "lineitemctnr.channel_type_tiktok" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TIKTOK" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TWITTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TWITTER", + "tags": [ + "channel_type_twitter", + "lineitemctnr.channel_type_twitter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TWITTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TWITTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TWITTER", + "tags": [ + "channel_type_twitter", + "lineitemctnr.channel_type_twitter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TWITTER" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_WHATSAPP", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_WHATSAPP", + "tags": [ + "channel_type_whatsapp", + "lineitemctnr.channel_type_whatsapp" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_WHATSAPP" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_WHATSAPP", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_WHATSAPP", + "tags": [ + "channel_type_whatsapp", + "lineitemctnr.channel_type_whatsapp" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_WHATSAPP" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_YOUTUBE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_YOUTUBE", + "tags": [ + "channel_type_youtube", + "lineitemctnr.channel_type_youtube" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_YOUTUBE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_YOUTUBE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_YOUTUBE", + "tags": [ + "channel_type_youtube", + "lineitemctnr.channel_type_youtube" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_YOUTUBE" + }, + { + "id": "script-api:dw/order/LineItemCtnr#addNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.addNote", + "tags": [ + "addnote", + "lineitemctnr.addnote" + ], + "title": "LineItemCtnr.addNote" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalGrossPrice", + "tags": [ + "adjustedmerchandizetotalgrossprice", + "lineitemctnr.adjustedmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalNetPrice", + "tags": [ + "adjustedmerchandizetotalnetprice", + "lineitemctnr.adjustedmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalPrice", + "tags": [ + "adjustedmerchandizetotalprice", + "lineitemctnr.adjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalTax", + "tags": [ + "adjustedmerchandizetotaltax", + "lineitemctnr.adjustedmerchandizetotaltax" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalGrossPrice", + "tags": [ + "adjustedshippingtotalgrossprice", + "lineitemctnr.adjustedshippingtotalgrossprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalNetPrice", + "tags": [ + "adjustedshippingtotalnetprice", + "lineitemctnr.adjustedshippingtotalnetprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalPrice", + "tags": [ + "adjustedshippingtotalprice", + "lineitemctnr.adjustedshippingtotalprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalTax", + "tags": [ + "adjustedshippingtotaltax", + "lineitemctnr.adjustedshippingtotaltax" + ], + "title": "LineItemCtnr.adjustedShippingTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#allGiftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allGiftCertificateLineItems", + "tags": [ + "allgiftcertificatelineitems", + "lineitemctnr.allgiftcertificatelineitems" + ], + "title": "LineItemCtnr.allGiftCertificateLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#allLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allLineItems", + "tags": [ + "alllineitems", + "lineitemctnr.alllineitems" + ], + "title": "LineItemCtnr.allLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#allProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allProductLineItems", + "tags": [ + "allproductlineitems", + "lineitemctnr.allproductlineitems" + ], + "title": "LineItemCtnr.allProductLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#allProductQuantities", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allProductQuantities", + "tags": [ + "allproductquantities", + "lineitemctnr.allproductquantities" + ], + "title": "LineItemCtnr.allProductQuantities" + }, + { + "id": "script-api:dw/order/LineItemCtnr#allShippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allShippingPriceAdjustments", + "tags": [ + "allshippingpriceadjustments", + "lineitemctnr.allshippingpriceadjustments" + ], + "title": "LineItemCtnr.allShippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#billingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.billingAddress", + "tags": [ + "billingaddress", + "lineitemctnr.billingaddress" + ], + "title": "LineItemCtnr.billingAddress" + }, + { + "id": "script-api:dw/order/LineItemCtnr#bonusDiscountLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.bonusDiscountLineItems", + "tags": [ + "bonusdiscountlineitems", + "lineitemctnr.bonusdiscountlineitems" + ], + "title": "LineItemCtnr.bonusDiscountLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#bonusLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.bonusLineItems", + "tags": [ + "bonuslineitems", + "lineitemctnr.bonuslineitems" + ], + "title": "LineItemCtnr.bonusLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#businessType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.businessType", + "tags": [ + "businesstype", + "lineitemctnr.businesstype" + ], + "title": "LineItemCtnr.businessType" + }, + { + "id": "script-api:dw/order/LineItemCtnr#channelType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.channelType", + "tags": [ + "channeltype", + "lineitemctnr.channeltype" + ], + "title": "LineItemCtnr.channelType" + }, + { + "id": "script-api:dw/order/LineItemCtnr#couponLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.couponLineItems", + "tags": [ + "couponlineitems", + "lineitemctnr.couponlineitems" + ], + "title": "LineItemCtnr.couponLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createBillingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createBillingAddress", + "tags": [ + "createbillingaddress", + "lineitemctnr.createbillingaddress" + ], + "title": "LineItemCtnr.createBillingAddress" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createBonusProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createBonusProductLineItem", + "tags": [ + "createbonusproductlineitem", + "lineitemctnr.createbonusproductlineitem" + ], + "title": "LineItemCtnr.createBonusProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createCouponLineItem", + "tags": [ + "createcouponlineitem", + "lineitemctnr.createcouponlineitem" + ], + "title": "LineItemCtnr.createCouponLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createCouponLineItem", + "tags": [ + "createcouponlineitem", + "lineitemctnr.createcouponlineitem" + ], + "title": "LineItemCtnr.createCouponLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createGiftCertificateLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createGiftCertificateLineItem", + "tags": [ + "creategiftcertificatelineitem", + "lineitemctnr.creategiftcertificatelineitem" + ], + "title": "LineItemCtnr.createGiftCertificateLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createGiftCertificatePaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createGiftCertificatePaymentInstrument", + "tags": [ + "creategiftcertificatepaymentinstrument", + "lineitemctnr.creategiftcertificatepaymentinstrument" + ], + "title": "LineItemCtnr.createGiftCertificatePaymentInstrument" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPaymentInstrument", + "tags": [ + "createpaymentinstrument", + "lineitemctnr.createpaymentinstrument" + ], + "title": "LineItemCtnr.createPaymentInstrument" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createPaymentInstrumentFromWallet", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPaymentInstrumentFromWallet", + "tags": [ + "createpaymentinstrumentfromwallet", + "lineitemctnr.createpaymentinstrumentfromwallet" + ], + "title": "LineItemCtnr.createPaymentInstrumentFromWallet" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPriceAdjustment", + "tags": [ + "createpriceadjustment", + "lineitemctnr.createpriceadjustment" + ], + "title": "LineItemCtnr.createPriceAdjustment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPriceAdjustment", + "tags": [ + "createpriceadjustment", + "lineitemctnr.createpriceadjustment" + ], + "title": "LineItemCtnr.createPriceAdjustment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createShipment", + "tags": [ + "createshipment", + "lineitemctnr.createshipment" + ], + "title": "LineItemCtnr.createShipment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createShippingPriceAdjustment", + "tags": [ + "createshippingpriceadjustment", + "lineitemctnr.createshippingpriceadjustment" + ], + "title": "LineItemCtnr.createShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#currencyCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.currencyCode", + "tags": [ + "currencycode", + "lineitemctnr.currencycode" + ], + "title": "LineItemCtnr.currencyCode" + }, + { + "id": "script-api:dw/order/LineItemCtnr#customer", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customer", + "tags": [ + "customer", + "lineitemctnr.customer" + ], + "title": "LineItemCtnr.customer" + }, + { + "id": "script-api:dw/order/LineItemCtnr#customerEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerEmail", + "tags": [ + "customeremail", + "lineitemctnr.customeremail" + ], + "title": "LineItemCtnr.customerEmail" + }, + { + "id": "script-api:dw/order/LineItemCtnr#customerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerName", + "tags": [ + "customername", + "lineitemctnr.customername" + ], + "title": "LineItemCtnr.customerName" + }, + { + "id": "script-api:dw/order/LineItemCtnr#customerNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerNo", + "tags": [ + "customerno", + "lineitemctnr.customerno" + ], + "title": "LineItemCtnr.customerNo" + }, + { + "id": "script-api:dw/order/LineItemCtnr#defaultShipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.defaultShipment", + "tags": [ + "defaultshipment", + "lineitemctnr.defaultshipment" + ], + "title": "LineItemCtnr.defaultShipment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#etag", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.etag", + "tags": [ + "etag", + "lineitemctnr.etag" + ], + "title": "LineItemCtnr.etag" + }, + { + "id": "script-api:dw/order/LineItemCtnr#externallyTaxed", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.externallyTaxed", + "tags": [ + "externallytaxed", + "lineitemctnr.externallytaxed" + ], + "title": "LineItemCtnr.externallyTaxed" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalGrossPrice", + "tags": [ + "getadjustedmerchandizetotalgrossprice", + "lineitemctnr.getadjustedmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalNetPrice", + "tags": [ + "getadjustedmerchandizetotalnetprice", + "lineitemctnr.getadjustedmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalPrice", + "tags": [ + "getadjustedmerchandizetotalprice", + "lineitemctnr.getadjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalPrice", + "tags": [ + "getadjustedmerchandizetotalprice", + "lineitemctnr.getadjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalTax", + "tags": [ + "getadjustedmerchandizetotaltax", + "lineitemctnr.getadjustedmerchandizetotaltax" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalGrossPrice", + "tags": [ + "getadjustedshippingtotalgrossprice", + "lineitemctnr.getadjustedshippingtotalgrossprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalNetPrice", + "tags": [ + "getadjustedshippingtotalnetprice", + "lineitemctnr.getadjustedshippingtotalnetprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalPrice", + "tags": [ + "getadjustedshippingtotalprice", + "lineitemctnr.getadjustedshippingtotalprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalTax", + "tags": [ + "getadjustedshippingtotaltax", + "lineitemctnr.getadjustedshippingtotaltax" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllGiftCertificateLineItems", + "tags": [ + "getallgiftcertificatelineitems", + "lineitemctnr.getallgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getAllGiftCertificateLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllLineItems", + "tags": [ + "getalllineitems", + "lineitemctnr.getalllineitems" + ], + "title": "LineItemCtnr.getAllLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductLineItems", + "tags": [ + "getallproductlineitems", + "lineitemctnr.getallproductlineitems" + ], + "title": "LineItemCtnr.getAllProductLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductLineItems", + "tags": [ + "getallproductlineitems", + "lineitemctnr.getallproductlineitems" + ], + "title": "LineItemCtnr.getAllProductLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductQuantities", + "tags": [ + "getallproductquantities", + "lineitemctnr.getallproductquantities" + ], + "title": "LineItemCtnr.getAllProductQuantities" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getAllShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllShippingPriceAdjustments", + "tags": [ + "getallshippingpriceadjustments", + "lineitemctnr.getallshippingpriceadjustments" + ], + "title": "LineItemCtnr.getAllShippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getBillingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBillingAddress", + "tags": [ + "getbillingaddress", + "lineitemctnr.getbillingaddress" + ], + "title": "LineItemCtnr.getBillingAddress" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getBonusDiscountLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBonusDiscountLineItems", + "tags": [ + "getbonusdiscountlineitems", + "lineitemctnr.getbonusdiscountlineitems" + ], + "title": "LineItemCtnr.getBonusDiscountLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getBonusLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBonusLineItems", + "tags": [ + "getbonuslineitems", + "lineitemctnr.getbonuslineitems" + ], + "title": "LineItemCtnr.getBonusLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getBusinessType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBusinessType", + "tags": [ + "getbusinesstype", + "lineitemctnr.getbusinesstype" + ], + "title": "LineItemCtnr.getBusinessType" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getChannelType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getChannelType", + "tags": [ + "getchanneltype", + "lineitemctnr.getchanneltype" + ], + "title": "LineItemCtnr.getChannelType" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCouponLineItem", + "tags": [ + "getcouponlineitem", + "lineitemctnr.getcouponlineitem" + ], + "title": "LineItemCtnr.getCouponLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCouponLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCouponLineItems", + "tags": [ + "getcouponlineitems", + "lineitemctnr.getcouponlineitems" + ], + "title": "LineItemCtnr.getCouponLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCurrencyCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCurrencyCode", + "tags": [ + "getcurrencycode", + "lineitemctnr.getcurrencycode" + ], + "title": "LineItemCtnr.getCurrencyCode" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCustomer", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomer", + "tags": [ + "getcustomer", + "lineitemctnr.getcustomer" + ], + "title": "LineItemCtnr.getCustomer" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCustomerEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerEmail", + "tags": [ + "getcustomeremail", + "lineitemctnr.getcustomeremail" + ], + "title": "LineItemCtnr.getCustomerEmail" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCustomerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerName", + "tags": [ + "getcustomername", + "lineitemctnr.getcustomername" + ], + "title": "LineItemCtnr.getCustomerName" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerNo", + "tags": [ + "getcustomerno", + "lineitemctnr.getcustomerno" + ], + "title": "LineItemCtnr.getCustomerNo" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getDefaultShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getDefaultShipment", + "tags": [ + "getdefaultshipment", + "lineitemctnr.getdefaultshipment" + ], + "title": "LineItemCtnr.getDefaultShipment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getEtag", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getEtag", + "tags": [ + "getetag", + "lineitemctnr.getetag" + ], + "title": "LineItemCtnr.getEtag" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateLineItems", + "tags": [ + "getgiftcertificatelineitems", + "lineitemctnr.getgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getGiftCertificateLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateLineItems", + "tags": [ + "getgiftcertificatelineitems", + "lineitemctnr.getgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getGiftCertificateLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificatePaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificatePaymentInstruments", + "tags": [ + "getgiftcertificatepaymentinstruments", + "lineitemctnr.getgiftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.getGiftCertificatePaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificatePaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificatePaymentInstruments", + "tags": [ + "getgiftcertificatepaymentinstruments", + "lineitemctnr.getgiftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.getGiftCertificatePaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalGrossPrice", + "tags": [ + "getgiftcertificatetotalgrossprice", + "lineitemctnr.getgiftcertificatetotalgrossprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalNetPrice", + "tags": [ + "getgiftcertificatetotalnetprice", + "lineitemctnr.getgiftcertificatetotalnetprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalPrice", + "tags": [ + "getgiftcertificatetotalprice", + "lineitemctnr.getgiftcertificatetotalprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalTax", + "tags": [ + "getgiftcertificatetotaltax", + "lineitemctnr.getgiftcertificatetotaltax" + ], + "title": "LineItemCtnr.getGiftCertificateTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalGrossPrice", + "tags": [ + "getmerchandizetotalgrossprice", + "lineitemctnr.getmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalNetPrice", + "tags": [ + "getmerchandizetotalnetprice", + "lineitemctnr.getmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalPrice", + "tags": [ + "getmerchandizetotalprice", + "lineitemctnr.getmerchandizetotalprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalTax", + "tags": [ + "getmerchandizetotaltax", + "lineitemctnr.getmerchandizetotaltax" + ], + "title": "LineItemCtnr.getMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getNotes", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getNotes", + "tags": [ + "getnotes", + "lineitemctnr.getnotes" + ], + "title": "LineItemCtnr.getNotes" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "lineitemctnr.getpaymentinstrument" + ], + "title": "LineItemCtnr.getPaymentInstrument" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstruments", + "tags": [ + "getpaymentinstruments", + "lineitemctnr.getpaymentinstruments" + ], + "title": "LineItemCtnr.getPaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstruments", + "tags": [ + "getpaymentinstruments", + "lineitemctnr.getpaymentinstruments" + ], + "title": "LineItemCtnr.getPaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPriceAdjustmentByPromotionID", + "tags": [ + "getpriceadjustmentbypromotionid", + "lineitemctnr.getpriceadjustmentbypromotionid" + ], + "title": "LineItemCtnr.getPriceAdjustmentByPromotionID" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPriceAdjustments", + "tags": [ + "getpriceadjustments", + "lineitemctnr.getpriceadjustments" + ], + "title": "LineItemCtnr.getPriceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductLineItems", + "tags": [ + "getproductlineitems", + "lineitemctnr.getproductlineitems" + ], + "title": "LineItemCtnr.getProductLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductLineItems", + "tags": [ + "getproductlineitems", + "lineitemctnr.getproductlineitems" + ], + "title": "LineItemCtnr.getProductLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantities", + "tags": [ + "getproductquantities", + "lineitemctnr.getproductquantities" + ], + "title": "LineItemCtnr.getProductQuantities" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantities", + "tags": [ + "getproductquantities", + "lineitemctnr.getproductquantities" + ], + "title": "LineItemCtnr.getProductQuantities" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getProductQuantityTotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantityTotal", + "tags": [ + "getproductquantitytotal", + "lineitemctnr.getproductquantitytotal" + ], + "title": "LineItemCtnr.getProductQuantityTotal" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShipment", + "tags": [ + "getshipment", + "lineitemctnr.getshipment" + ], + "title": "LineItemCtnr.getShipment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShipments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShipments", + "tags": [ + "getshipments", + "lineitemctnr.getshipments" + ], + "title": "LineItemCtnr.getShipments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingPriceAdjustmentByPromotionID", + "tags": [ + "getshippingpriceadjustmentbypromotionid", + "lineitemctnr.getshippingpriceadjustmentbypromotionid" + ], + "title": "LineItemCtnr.getShippingPriceAdjustmentByPromotionID" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingPriceAdjustments", + "tags": [ + "getshippingpriceadjustments", + "lineitemctnr.getshippingpriceadjustments" + ], + "title": "LineItemCtnr.getShippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalGrossPrice", + "tags": [ + "getshippingtotalgrossprice", + "lineitemctnr.getshippingtotalgrossprice" + ], + "title": "LineItemCtnr.getShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalNetPrice", + "tags": [ + "getshippingtotalnetprice", + "lineitemctnr.getshippingtotalnetprice" + ], + "title": "LineItemCtnr.getShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalPrice", + "tags": [ + "getshippingtotalprice", + "lineitemctnr.getshippingtotalprice" + ], + "title": "LineItemCtnr.getShippingTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalTax", + "tags": [ + "getshippingtotaltax", + "lineitemctnr.getshippingtotaltax" + ], + "title": "LineItemCtnr.getShippingTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getTaxTotalsPerTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTaxTotalsPerTaxRate", + "tags": [ + "gettaxtotalspertaxrate", + "lineitemctnr.gettaxtotalspertaxrate" + ], + "title": "LineItemCtnr.getTaxTotalsPerTaxRate" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalGrossPrice", + "tags": [ + "gettotalgrossprice", + "lineitemctnr.gettotalgrossprice" + ], + "title": "LineItemCtnr.getTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalNetPrice", + "tags": [ + "gettotalnetprice", + "lineitemctnr.gettotalnetprice" + ], + "title": "LineItemCtnr.getTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#getTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalTax", + "tags": [ + "gettotaltax", + "lineitemctnr.gettotaltax" + ], + "title": "LineItemCtnr.getTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateLineItems", + "tags": [ + "giftcertificatelineitems", + "lineitemctnr.giftcertificatelineitems" + ], + "title": "LineItemCtnr.giftCertificateLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificatePaymentInstruments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificatePaymentInstruments", + "tags": [ + "giftcertificatepaymentinstruments", + "lineitemctnr.giftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.giftCertificatePaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalGrossPrice", + "tags": [ + "giftcertificatetotalgrossprice", + "lineitemctnr.giftcertificatetotalgrossprice" + ], + "title": "LineItemCtnr.giftCertificateTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalNetPrice", + "tags": [ + "giftcertificatetotalnetprice", + "lineitemctnr.giftcertificatetotalnetprice" + ], + "title": "LineItemCtnr.giftCertificateTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalPrice", + "tags": [ + "giftcertificatetotalprice", + "lineitemctnr.giftcertificatetotalprice" + ], + "title": "LineItemCtnr.giftCertificateTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalTax", + "tags": [ + "giftcertificatetotaltax", + "lineitemctnr.giftcertificatetotaltax" + ], + "title": "LineItemCtnr.giftCertificateTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#isExternallyTaxed", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.isExternallyTaxed", + "tags": [ + "isexternallytaxed", + "lineitemctnr.isexternallytaxed" + ], + "title": "LineItemCtnr.isExternallyTaxed" + }, + { + "id": "script-api:dw/order/LineItemCtnr#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.isTaxRoundedAtGroup", + "tags": [ + "istaxroundedatgroup", + "lineitemctnr.istaxroundedatgroup" + ], + "title": "LineItemCtnr.isTaxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalGrossPrice", + "tags": [ + "merchandizetotalgrossprice", + "lineitemctnr.merchandizetotalgrossprice" + ], + "title": "LineItemCtnr.merchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalNetPrice", + "tags": [ + "merchandizetotalnetprice", + "lineitemctnr.merchandizetotalnetprice" + ], + "title": "LineItemCtnr.merchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalPrice", + "tags": [ + "merchandizetotalprice", + "lineitemctnr.merchandizetotalprice" + ], + "title": "LineItemCtnr.merchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalTax", + "tags": [ + "merchandizetotaltax", + "lineitemctnr.merchandizetotaltax" + ], + "title": "LineItemCtnr.merchandizeTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#notes", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.notes", + "tags": [ + "notes", + "lineitemctnr.notes" + ], + "title": "LineItemCtnr.notes" + }, + { + "id": "script-api:dw/order/LineItemCtnr#paymentInstrument", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.paymentInstrument", + "tags": [ + "paymentinstrument", + "lineitemctnr.paymentinstrument" + ], + "title": "LineItemCtnr.paymentInstrument" + }, + { + "id": "script-api:dw/order/LineItemCtnr#paymentInstruments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.paymentInstruments", + "tags": [ + "paymentinstruments", + "lineitemctnr.paymentinstruments" + ], + "title": "LineItemCtnr.paymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.priceAdjustments", + "tags": [ + "priceadjustments", + "lineitemctnr.priceadjustments" + ], + "title": "LineItemCtnr.priceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#productLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productLineItems", + "tags": [ + "productlineitems", + "lineitemctnr.productlineitems" + ], + "title": "LineItemCtnr.productLineItems" + }, + { + "id": "script-api:dw/order/LineItemCtnr#productQuantities", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productQuantities", + "tags": [ + "productquantities", + "lineitemctnr.productquantities" + ], + "title": "LineItemCtnr.productQuantities" + }, + { + "id": "script-api:dw/order/LineItemCtnr#productQuantityTotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productQuantityTotal", + "tags": [ + "productquantitytotal", + "lineitemctnr.productquantitytotal" + ], + "title": "LineItemCtnr.productQuantityTotal" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeAllPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeAllPaymentInstruments", + "tags": [ + "removeallpaymentinstruments", + "lineitemctnr.removeallpaymentinstruments" + ], + "title": "LineItemCtnr.removeAllPaymentInstruments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeBonusDiscountLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeBonusDiscountLineItem", + "tags": [ + "removebonusdiscountlineitem", + "lineitemctnr.removebonusdiscountlineitem" + ], + "title": "LineItemCtnr.removeBonusDiscountLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeCouponLineItem", + "tags": [ + "removecouponlineitem", + "lineitemctnr.removecouponlineitem" + ], + "title": "LineItemCtnr.removeCouponLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeGiftCertificateLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeGiftCertificateLineItem", + "tags": [ + "removegiftcertificatelineitem", + "lineitemctnr.removegiftcertificatelineitem" + ], + "title": "LineItemCtnr.removeGiftCertificateLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeNote", + "tags": [ + "removenote", + "lineitemctnr.removenote" + ], + "title": "LineItemCtnr.removeNote" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removePaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removePaymentInstrument", + "tags": [ + "removepaymentinstrument", + "lineitemctnr.removepaymentinstrument" + ], + "title": "LineItemCtnr.removePaymentInstrument" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removePriceAdjustment", + "tags": [ + "removepriceadjustment", + "lineitemctnr.removepriceadjustment" + ], + "title": "LineItemCtnr.removePriceAdjustment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeProductLineItem", + "tags": [ + "removeproductlineitem", + "lineitemctnr.removeproductlineitem" + ], + "title": "LineItemCtnr.removeProductLineItem" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeShipment", + "tags": [ + "removeshipment", + "lineitemctnr.removeshipment" + ], + "title": "LineItemCtnr.removeShipment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeShippingPriceAdjustment", + "tags": [ + "removeshippingpriceadjustment", + "lineitemctnr.removeshippingpriceadjustment" + ], + "title": "LineItemCtnr.removeShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/LineItemCtnr#setCustomerEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.setCustomerEmail", + "tags": [ + "setcustomeremail", + "lineitemctnr.setcustomeremail" + ], + "title": "LineItemCtnr.setCustomerEmail" + }, + { + "id": "script-api:dw/order/LineItemCtnr#setCustomerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.setCustomerName", + "tags": [ + "setcustomername", + "lineitemctnr.setcustomername" + ], + "title": "LineItemCtnr.setCustomerName" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shipments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shipments", + "tags": [ + "shipments", + "lineitemctnr.shipments" + ], + "title": "LineItemCtnr.shipments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingPriceAdjustments", + "tags": [ + "shippingpriceadjustments", + "lineitemctnr.shippingpriceadjustments" + ], + "title": "LineItemCtnr.shippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalGrossPrice", + "tags": [ + "shippingtotalgrossprice", + "lineitemctnr.shippingtotalgrossprice" + ], + "title": "LineItemCtnr.shippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalNetPrice", + "tags": [ + "shippingtotalnetprice", + "lineitemctnr.shippingtotalnetprice" + ], + "title": "LineItemCtnr.shippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalPrice", + "tags": [ + "shippingtotalprice", + "lineitemctnr.shippingtotalprice" + ], + "title": "LineItemCtnr.shippingTotalPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#shippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalTax", + "tags": [ + "shippingtotaltax", + "lineitemctnr.shippingtotaltax" + ], + "title": "LineItemCtnr.shippingTotalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.taxRoundedAtGroup", + "tags": [ + "taxroundedatgroup", + "lineitemctnr.taxroundedatgroup" + ], + "title": "LineItemCtnr.taxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/LineItemCtnr#taxTotalsPerTaxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.taxTotalsPerTaxRate", + "tags": [ + "taxtotalspertaxrate", + "lineitemctnr.taxtotalspertaxrate" + ], + "title": "LineItemCtnr.taxTotalsPerTaxRate" + }, + { + "id": "script-api:dw/order/LineItemCtnr#totalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalGrossPrice", + "tags": [ + "totalgrossprice", + "lineitemctnr.totalgrossprice" + ], + "title": "LineItemCtnr.totalGrossPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#totalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalNetPrice", + "tags": [ + "totalnetprice", + "lineitemctnr.totalnetprice" + ], + "title": "LineItemCtnr.totalNetPrice" + }, + { + "id": "script-api:dw/order/LineItemCtnr#totalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalTax", + "tags": [ + "totaltax", + "lineitemctnr.totaltax" + ], + "title": "LineItemCtnr.totalTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#updateOrderLevelPriceAdjustmentTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.updateOrderLevelPriceAdjustmentTax", + "tags": [ + "updateorderlevelpriceadjustmenttax", + "lineitemctnr.updateorderlevelpriceadjustmenttax" + ], + "title": "LineItemCtnr.updateOrderLevelPriceAdjustmentTax" + }, + { + "id": "script-api:dw/order/LineItemCtnr#updateTotals", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.updateTotals", + "tags": [ + "updatetotals", + "lineitemctnr.updatetotals" + ], + "title": "LineItemCtnr.updateTotals" + }, + { + "id": "script-api:dw/order/LineItemCtnr#verifyPriceAdjustmentLimits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.verifyPriceAdjustmentLimits", + "tags": [ + "verifypriceadjustmentlimits", + "lineitemctnr.verifypriceadjustmentlimits" + ], + "title": "LineItemCtnr.verifyPriceAdjustmentLimits" + }, + { + "id": "script-api:dw/order/LineItemTax", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItemTax", + "tags": [ + "lineitemtax", + "dw.order.lineitemtax", + "dw/order" + ], + "title": "LineItemTax" + }, + { + "id": "script-api:dw/order/LineItemTax#getTaxId", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxId", + "tags": [ + "gettaxid", + "lineitemtax.gettaxid" + ], + "title": "LineItemTax.getTaxId" + }, + { + "id": "script-api:dw/order/LineItemTax#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxRate", + "tags": [ + "gettaxrate", + "lineitemtax.gettaxrate" + ], + "title": "LineItemTax.getTaxRate" + }, + { + "id": "script-api:dw/order/LineItemTax#getTaxValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxValue", + "tags": [ + "gettaxvalue", + "lineitemtax.gettaxvalue" + ], + "title": "LineItemTax.getTaxValue" + }, + { + "id": "script-api:dw/order/LineItemTax#taxId", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxId", + "tags": [ + "taxid", + "lineitemtax.taxid" + ], + "title": "LineItemTax.taxId" + }, + { + "id": "script-api:dw/order/LineItemTax#taxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxRate", + "tags": [ + "taxrate", + "lineitemtax.taxrate" + ], + "title": "LineItemTax.taxRate" + }, + { + "id": "script-api:dw/order/LineItemTax#taxValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxValue", + "tags": [ + "taxvalue", + "lineitemtax.taxvalue" + ], + "title": "LineItemTax.taxValue" + }, + { + "id": "script-api:dw/order/Order", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Order", + "tags": [ + "order", + "dw.order.order", + "dw/order" + ], + "title": "Order" + }, + { + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_CONFIRMED", + "tags": [ + "confirmation_status_confirmed", + "order.confirmation_status_confirmed" + ], + "title": "Order.CONFIRMATION_STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_CONFIRMED", + "tags": [ + "confirmation_status_confirmed", + "order.confirmation_status_confirmed" + ], + "title": "Order.CONFIRMATION_STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_NOTCONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_NOTCONFIRMED", + "tags": [ + "confirmation_status_notconfirmed", + "order.confirmation_status_notconfirmed" + ], + "title": "Order.CONFIRMATION_STATUS_NOTCONFIRMED" + }, + { + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_NOTCONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_NOTCONFIRMED", + "tags": [ + "confirmation_status_notconfirmed", + "order.confirmation_status_notconfirmed" + ], + "title": "Order.CONFIRMATION_STATUS_NOTCONFIRMED" + }, + { + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "order.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "order.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_pkcs1padding", + "order.encryption_algorithm_rsa_ecb_pkcs1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING" + }, + { + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_pkcs1padding", + "order.encryption_algorithm_rsa_ecb_pkcs1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_EXPORTED", + "tags": [ + "export_status_exported", + "order.export_status_exported" + ], + "title": "Order.EXPORT_STATUS_EXPORTED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_EXPORTED", + "tags": [ + "export_status_exported", + "order.export_status_exported" + ], + "title": "Order.EXPORT_STATUS_EXPORTED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_FAILED", + "tags": [ + "export_status_failed", + "order.export_status_failed" + ], + "title": "Order.EXPORT_STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_FAILED", + "tags": [ + "export_status_failed", + "order.export_status_failed" + ], + "title": "Order.EXPORT_STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_NOTEXPORTED", + "tags": [ + "export_status_notexported", + "order.export_status_notexported" + ], + "title": "Order.EXPORT_STATUS_NOTEXPORTED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_NOTEXPORTED", + "tags": [ + "export_status_notexported", + "order.export_status_notexported" + ], + "title": "Order.EXPORT_STATUS_NOTEXPORTED" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_READY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_READY", + "tags": [ + "export_status_ready", + "order.export_status_ready" + ], + "title": "Order.EXPORT_STATUS_READY" + }, + { + "id": "script-api:dw/order/Order#EXPORT_STATUS_READY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_READY", + "tags": [ + "export_status_ready", + "order.export_status_ready" + ], + "title": "Order.EXPORT_STATUS_READY" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CANCELLED", + "tags": [ + "order_status_cancelled", + "order.order_status_cancelled" + ], + "title": "Order.ORDER_STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CANCELLED", + "tags": [ + "order_status_cancelled", + "order.order_status_cancelled" + ], + "title": "Order.ORDER_STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_COMPLETED", + "tags": [ + "order_status_completed", + "order.order_status_completed" + ], + "title": "Order.ORDER_STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_COMPLETED", + "tags": [ + "order_status_completed", + "order.order_status_completed" + ], + "title": "Order.ORDER_STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CREATED", + "tags": [ + "order_status_created", + "order.order_status_created" + ], + "title": "Order.ORDER_STATUS_CREATED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CREATED", + "tags": [ + "order_status_created", + "order.order_status_created" + ], + "title": "Order.ORDER_STATUS_CREATED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_FAILED", + "tags": [ + "order_status_failed", + "order.order_status_failed" + ], + "title": "Order.ORDER_STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_FAILED", + "tags": [ + "order_status_failed", + "order.order_status_failed" + ], + "title": "Order.ORDER_STATUS_FAILED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_NEW", + "tags": [ + "order_status_new", + "order.order_status_new" + ], + "title": "Order.ORDER_STATUS_NEW" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_NEW", + "tags": [ + "order_status_new", + "order.order_status_new" + ], + "title": "Order.ORDER_STATUS_NEW" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_OPEN", + "tags": [ + "order_status_open", + "order.order_status_open" + ], + "title": "Order.ORDER_STATUS_OPEN" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_OPEN", + "tags": [ + "order_status_open", + "order.order_status_open" + ], + "title": "Order.ORDER_STATUS_OPEN" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_REPLACED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_REPLACED", + "tags": [ + "order_status_replaced", + "order.order_status_replaced" + ], + "title": "Order.ORDER_STATUS_REPLACED" + }, + { + "id": "script-api:dw/order/Order#ORDER_STATUS_REPLACED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_REPLACED", + "tags": [ + "order_status_replaced", + "order.order_status_replaced" + ], + "title": "Order.ORDER_STATUS_REPLACED" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_NOTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_NOTPAID", + "tags": [ + "payment_status_notpaid", + "order.payment_status_notpaid" + ], + "title": "Order.PAYMENT_STATUS_NOTPAID" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_NOTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_NOTPAID", + "tags": [ + "payment_status_notpaid", + "order.payment_status_notpaid" + ], + "title": "Order.PAYMENT_STATUS_NOTPAID" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PAID", + "tags": [ + "payment_status_paid", + "order.payment_status_paid" + ], + "title": "Order.PAYMENT_STATUS_PAID" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PAID", + "tags": [ + "payment_status_paid", + "order.payment_status_paid" + ], + "title": "Order.PAYMENT_STATUS_PAID" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PARTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PARTPAID", + "tags": [ + "payment_status_partpaid", + "order.payment_status_partpaid" + ], + "title": "Order.PAYMENT_STATUS_PARTPAID" + }, + { + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PARTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PARTPAID", + "tags": [ + "payment_status_partpaid", + "order.payment_status_partpaid" + ], + "title": "Order.PAYMENT_STATUS_PARTPAID" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_NOTSHIPPED", + "tags": [ + "shipping_status_notshipped", + "order.shipping_status_notshipped" + ], + "title": "Order.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_NOTSHIPPED", + "tags": [ + "shipping_status_notshipped", + "order.shipping_status_notshipped" + ], + "title": "Order.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_PARTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_PARTSHIPPED", + "tags": [ + "shipping_status_partshipped", + "order.shipping_status_partshipped" + ], + "title": "Order.SHIPPING_STATUS_PARTSHIPPED" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_PARTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_PARTSHIPPED", + "tags": [ + "shipping_status_partshipped", + "order.shipping_status_partshipped" + ], + "title": "Order.SHIPPING_STATUS_PARTSHIPPED" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_SHIPPED", + "tags": [ + "shipping_status_shipped", + "order.shipping_status_shipped" + ], + "title": "Order.SHIPPING_STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/Order#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_SHIPPED", + "tags": [ + "shipping_status_shipped", + "order.shipping_status_shipped" + ], + "title": "Order.SHIPPING_STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/Order#affiliatePartnerID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.affiliatePartnerID", + "tags": [ + "affiliatepartnerid", + "order.affiliatepartnerid" + ], + "title": "Order.affiliatePartnerID" + }, + { + "id": "script-api:dw/order/Order#affiliatePartnerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.affiliatePartnerName", + "tags": [ + "affiliatepartnername", + "order.affiliatepartnername" + ], + "title": "Order.affiliatePartnerName" + }, + { + "id": "script-api:dw/order/Order#appeasementItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.appeasementItems", + "tags": [ + "appeasementitems", + "order.appeasementitems" + ], + "title": "Order.appeasementItems" + }, + { + "id": "script-api:dw/order/Order#appeasements", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.appeasements", + "tags": [ + "appeasements", + "order.appeasements" + ], + "title": "Order.appeasements" + }, + { + "id": "script-api:dw/order/Order#cancelCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.cancelCode", + "tags": [ + "cancelcode", + "order.cancelcode" + ], + "title": "Order.cancelCode" + }, + { + "id": "script-api:dw/order/Order#cancelDescription", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.cancelDescription", + "tags": [ + "canceldescription", + "order.canceldescription" + ], + "title": "Order.cancelDescription" + }, + { + "id": "script-api:dw/order/Order#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.capturedAmount", + "tags": [ + "capturedamount", + "order.capturedamount" + ], + "title": "Order.capturedAmount" + }, + { + "id": "script-api:dw/order/Order#confirmationStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.confirmationStatus", + "tags": [ + "confirmationstatus", + "order.confirmationstatus" + ], + "title": "Order.confirmationStatus" + }, + { + "id": "script-api:dw/order/Order#createAppeasement", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createAppeasement", + "tags": [ + "createappeasement", + "order.createappeasement" + ], + "title": "Order.createAppeasement" + }, + { + "id": "script-api:dw/order/Order#createAppeasement", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createAppeasement", + "tags": [ + "createappeasement", + "order.createappeasement" + ], + "title": "Order.createAppeasement" + }, + { + "id": "script-api:dw/order/Order#createReturnCase", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createReturnCase", + "tags": [ + "createreturncase", + "order.createreturncase" + ], + "title": "Order.createReturnCase" + }, + { + "id": "script-api:dw/order/Order#createReturnCase", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createReturnCase", + "tags": [ + "createreturncase", + "order.createreturncase" + ], + "title": "Order.createReturnCase" + }, + { + "id": "script-api:dw/order/Order#createServiceItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createServiceItem", + "tags": [ + "createserviceitem", + "order.createserviceitem" + ], + "title": "Order.createServiceItem" + }, + { + "id": "script-api:dw/order/Order#createShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createShippingOrder", + "tags": [ + "createshippingorder", + "order.createshippingorder" + ], + "title": "Order.createShippingOrder" + }, + { + "id": "script-api:dw/order/Order#createShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createShippingOrder", + "tags": [ + "createshippingorder", + "order.createshippingorder" + ], + "title": "Order.createShippingOrder" + }, + { + "id": "script-api:dw/order/Order#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createdBy", + "tags": [ + "createdby", + "order.createdby" + ], + "title": "Order.createdBy" + }, + { + "id": "script-api:dw/order/Order#currentOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.currentOrder", + "tags": [ + "currentorder", + "order.currentorder" + ], + "title": "Order.currentOrder" + }, + { + "id": "script-api:dw/order/Order#currentOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.currentOrderNo", + "tags": [ + "currentorderno", + "order.currentorderno" + ], + "title": "Order.currentOrderNo" + }, + { + "id": "script-api:dw/order/Order#customerLocaleID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.customerLocaleID", + "tags": [ + "customerlocaleid", + "order.customerlocaleid" + ], + "title": "Order.customerLocaleID" + }, + { + "id": "script-api:dw/order/Order#customerOrderReference", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.customerOrderReference", + "tags": [ + "customerorderreference", + "order.customerorderreference" + ], + "title": "Order.customerOrderReference" + }, + { + "id": "script-api:dw/order/Order#exportAfter", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.exportAfter", + "tags": [ + "exportafter", + "order.exportafter" + ], + "title": "Order.exportAfter" + }, + { + "id": "script-api:dw/order/Order#exportStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.exportStatus", + "tags": [ + "exportstatus", + "order.exportstatus" + ], + "title": "Order.exportStatus" + }, + { + "id": "script-api:dw/order/Order#externalOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderNo", + "tags": [ + "externalorderno", + "order.externalorderno" + ], + "title": "Order.externalOrderNo" + }, + { + "id": "script-api:dw/order/Order#externalOrderStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderStatus", + "tags": [ + "externalorderstatus", + "order.externalorderstatus" + ], + "title": "Order.externalOrderStatus" + }, + { + "id": "script-api:dw/order/Order#externalOrderText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderText", + "tags": [ + "externalordertext", + "order.externalordertext" + ], + "title": "Order.externalOrderText" + }, + { + "id": "script-api:dw/order/Order#getAffiliatePartnerID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAffiliatePartnerID", + "tags": [ + "getaffiliatepartnerid", + "order.getaffiliatepartnerid" + ], + "title": "Order.getAffiliatePartnerID" + }, + { + "id": "script-api:dw/order/Order#getAffiliatePartnerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAffiliatePartnerName", + "tags": [ + "getaffiliatepartnername", + "order.getaffiliatepartnername" + ], + "title": "Order.getAffiliatePartnerName" + }, + { + "id": "script-api:dw/order/Order#getAppeasement", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasement", + "tags": [ + "getappeasement", + "order.getappeasement" + ], + "title": "Order.getAppeasement" + }, + { + "id": "script-api:dw/order/Order#getAppeasementItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasementItem", + "tags": [ + "getappeasementitem", + "order.getappeasementitem" + ], + "title": "Order.getAppeasementItem" + }, + { + "id": "script-api:dw/order/Order#getAppeasementItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasementItems", + "tags": [ + "getappeasementitems", + "order.getappeasementitems" + ], + "title": "Order.getAppeasementItems" + }, + { + "id": "script-api:dw/order/Order#getAppeasements", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasements", + "tags": [ + "getappeasements", + "order.getappeasements" + ], + "title": "Order.getAppeasements" + }, + { + "id": "script-api:dw/order/Order#getCancelCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCancelCode", + "tags": [ + "getcancelcode", + "order.getcancelcode" + ], + "title": "Order.getCancelCode" + }, + { + "id": "script-api:dw/order/Order#getCancelDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCancelDescription", + "tags": [ + "getcanceldescription", + "order.getcanceldescription" + ], + "title": "Order.getCancelDescription" + }, + { + "id": "script-api:dw/order/Order#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCapturedAmount", + "tags": [ + "getcapturedamount", + "order.getcapturedamount" + ], + "title": "Order.getCapturedAmount" + }, + { + "id": "script-api:dw/order/Order#getConfirmationStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getConfirmationStatus", + "tags": [ + "getconfirmationstatus", + "order.getconfirmationstatus" + ], + "title": "Order.getConfirmationStatus" + }, + { + "id": "script-api:dw/order/Order#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCreatedBy", + "tags": [ + "getcreatedby", + "order.getcreatedby" + ], + "title": "Order.getCreatedBy" + }, + { + "id": "script-api:dw/order/Order#getCurrentOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCurrentOrder", + "tags": [ + "getcurrentorder", + "order.getcurrentorder" + ], + "title": "Order.getCurrentOrder" + }, + { + "id": "script-api:dw/order/Order#getCurrentOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCurrentOrderNo", + "tags": [ + "getcurrentorderno", + "order.getcurrentorderno" + ], + "title": "Order.getCurrentOrderNo" + }, + { + "id": "script-api:dw/order/Order#getCustomerLocaleID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCustomerLocaleID", + "tags": [ + "getcustomerlocaleid", + "order.getcustomerlocaleid" + ], + "title": "Order.getCustomerLocaleID" + }, + { + "id": "script-api:dw/order/Order#getCustomerOrderReference", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCustomerOrderReference", + "tags": [ + "getcustomerorderreference", + "order.getcustomerorderreference" + ], + "title": "Order.getCustomerOrderReference" + }, + { + "id": "script-api:dw/order/Order#getExportAfter", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExportAfter", + "tags": [ + "getexportafter", + "order.getexportafter" + ], + "title": "Order.getExportAfter" + }, + { + "id": "script-api:dw/order/Order#getExportStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExportStatus", + "tags": [ + "getexportstatus", + "order.getexportstatus" + ], + "title": "Order.getExportStatus" + }, + { + "id": "script-api:dw/order/Order#getExternalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderNo", + "tags": [ + "getexternalorderno", + "order.getexternalorderno" + ], + "title": "Order.getExternalOrderNo" + }, + { + "id": "script-api:dw/order/Order#getExternalOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderStatus", + "tags": [ + "getexternalorderstatus", + "order.getexternalorderstatus" + ], + "title": "Order.getExternalOrderStatus" + }, + { + "id": "script-api:dw/order/Order#getExternalOrderText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderText", + "tags": [ + "getexternalordertext", + "order.getexternalordertext" + ], + "title": "Order.getExternalOrderText" + }, + { + "id": "script-api:dw/order/Order#getGlobalPartyID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getGlobalPartyID", + "tags": [ + "getglobalpartyid", + "order.getglobalpartyid" + ], + "title": "Order.getGlobalPartyID" + }, + { + "id": "script-api:dw/order/Order#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoice", + "tags": [ + "getinvoice", + "order.getinvoice" + ], + "title": "Order.getInvoice" + }, + { + "id": "script-api:dw/order/Order#getInvoiceItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceItem", + "tags": [ + "getinvoiceitem", + "order.getinvoiceitem" + ], + "title": "Order.getInvoiceItem" + }, + { + "id": "script-api:dw/order/Order#getInvoiceItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceItems", + "tags": [ + "getinvoiceitems", + "order.getinvoiceitems" + ], + "title": "Order.getInvoiceItems" + }, + { + "id": "script-api:dw/order/Order#getInvoiceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceNo", + "tags": [ + "getinvoiceno", + "order.getinvoiceno" + ], + "title": "Order.getInvoiceNo" + }, + { + "id": "script-api:dw/order/Order#getInvoices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoices", + "tags": [ + "getinvoices", + "order.getinvoices" + ], + "title": "Order.getInvoices" + }, + { + "id": "script-api:dw/order/Order#getOrderExportXML", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderExportXML", + "tags": [ + "getorderexportxml", + "order.getorderexportxml" + ], + "title": "Order.getOrderExportXML" + }, + { + "id": "script-api:dw/order/Order#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderItem", + "tags": [ + "getorderitem", + "order.getorderitem" + ], + "title": "Order.getOrderItem" + }, + { + "id": "script-api:dw/order/Order#getOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderNo", + "tags": [ + "getorderno", + "order.getorderno" + ], + "title": "Order.getOrderNo" + }, + { + "id": "script-api:dw/order/Order#getOrderToken", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderToken", + "tags": [ + "getordertoken", + "order.getordertoken" + ], + "title": "Order.getOrderToken" + }, + { + "id": "script-api:dw/order/Order#getOriginalOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOriginalOrder", + "tags": [ + "getoriginalorder", + "order.getoriginalorder" + ], + "title": "Order.getOriginalOrder" + }, + { + "id": "script-api:dw/order/Order#getOriginalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOriginalOrderNo", + "tags": [ + "getoriginalorderno", + "order.getoriginalorderno" + ], + "title": "Order.getOriginalOrderNo" + }, + { + "id": "script-api:dw/order/Order#getPaymentStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getPaymentStatus", + "tags": [ + "getpaymentstatus", + "order.getpaymentstatus" + ], + "title": "Order.getPaymentStatus" + }, + { + "id": "script-api:dw/order/Order#getPaymentTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getPaymentTransaction", + "tags": [ + "getpaymenttransaction", + "order.getpaymenttransaction" + ], + "title": "Order.getPaymentTransaction" + }, + { + "id": "script-api:dw/order/Order#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getRefundedAmount", + "tags": [ + "getrefundedamount", + "order.getrefundedamount" + ], + "title": "Order.getRefundedAmount" + }, + { + "id": "script-api:dw/order/Order#getRemoteHost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getRemoteHost", + "tags": [ + "getremotehost", + "order.getremotehost" + ], + "title": "Order.getRemoteHost" + }, + { + "id": "script-api:dw/order/Order#getReplaceCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplaceCode", + "tags": [ + "getreplacecode", + "order.getreplacecode" + ], + "title": "Order.getReplaceCode" + }, + { + "id": "script-api:dw/order/Order#getReplaceDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplaceDescription", + "tags": [ + "getreplacedescription", + "order.getreplacedescription" + ], + "title": "Order.getReplaceDescription" + }, + { + "id": "script-api:dw/order/Order#getReplacedOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacedOrder", + "tags": [ + "getreplacedorder", + "order.getreplacedorder" + ], + "title": "Order.getReplacedOrder" + }, + { + "id": "script-api:dw/order/Order#getReplacedOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacedOrderNo", + "tags": [ + "getreplacedorderno", + "order.getreplacedorderno" + ], + "title": "Order.getReplacedOrderNo" + }, + { + "id": "script-api:dw/order/Order#getReplacementOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacementOrder", + "tags": [ + "getreplacementorder", + "order.getreplacementorder" + ], + "title": "Order.getReplacementOrder" + }, + { + "id": "script-api:dw/order/Order#getReplacementOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacementOrderNo", + "tags": [ + "getreplacementorderno", + "order.getreplacementorderno" + ], + "title": "Order.getReplacementOrderNo" + }, + { + "id": "script-api:dw/order/Order#getReturn", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturn", + "tags": [ + "getreturn", + "order.getreturn" + ], + "title": "Order.getReturn" + }, + { + "id": "script-api:dw/order/Order#getReturnCase", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCase", + "tags": [ + "getreturncase", + "order.getreturncase" + ], + "title": "Order.getReturnCase" + }, + { + "id": "script-api:dw/order/Order#getReturnCaseItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCaseItem", + "tags": [ + "getreturncaseitem", + "order.getreturncaseitem" + ], + "title": "Order.getReturnCaseItem" + }, + { + "id": "script-api:dw/order/Order#getReturnCaseItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCaseItems", + "tags": [ + "getreturncaseitems", + "order.getreturncaseitems" + ], + "title": "Order.getReturnCaseItems" + }, + { + "id": "script-api:dw/order/Order#getReturnCases", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCases", + "tags": [ + "getreturncases", + "order.getreturncases" + ], + "title": "Order.getReturnCases" + }, + { + "id": "script-api:dw/order/Order#getReturnItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnItem", + "tags": [ + "getreturnitem", + "order.getreturnitem" + ], + "title": "Order.getReturnItem" + }, + { + "id": "script-api:dw/order/Order#getReturnItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnItems", + "tags": [ + "getreturnitems", + "order.getreturnitems" + ], + "title": "Order.getReturnItems" + }, + { + "id": "script-api:dw/order/Order#getReturns", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturns", + "tags": [ + "getreturns", + "order.getreturns" + ], + "title": "Order.getReturns" + }, + { + "id": "script-api:dw/order/Order#getShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrder", + "tags": [ + "getshippingorder", + "order.getshippingorder" + ], + "title": "Order.getShippingOrder" + }, + { + "id": "script-api:dw/order/Order#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrderItem", + "tags": [ + "getshippingorderitem", + "order.getshippingorderitem" + ], + "title": "Order.getShippingOrderItem" + }, + { + "id": "script-api:dw/order/Order#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrderItems", + "tags": [ + "getshippingorderitems", + "order.getshippingorderitems" + ], + "title": "Order.getShippingOrderItems" + }, + { + "id": "script-api:dw/order/Order#getShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrders", + "tags": [ + "getshippingorders", + "order.getshippingorders" + ], + "title": "Order.getShippingOrders" + }, + { + "id": "script-api:dw/order/Order#getShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingStatus", + "tags": [ + "getshippingstatus", + "order.getshippingstatus" + ], + "title": "Order.getShippingStatus" + }, + { + "id": "script-api:dw/order/Order#getSourceCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCode", + "tags": [ + "getsourcecode", + "order.getsourcecode" + ], + "title": "Order.getSourceCode" + }, + { + "id": "script-api:dw/order/Order#getSourceCodeGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCodeGroup", + "tags": [ + "getsourcecodegroup", + "order.getsourcecodegroup" + ], + "title": "Order.getSourceCodeGroup" + }, + { + "id": "script-api:dw/order/Order#getSourceCodeGroupID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCodeGroupID", + "tags": [ + "getsourcecodegroupid", + "order.getsourcecodegroupid" + ], + "title": "Order.getSourceCodeGroupID" + }, + { + "id": "script-api:dw/order/Order#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getStatus", + "tags": [ + "getstatus", + "order.getstatus" + ], + "title": "Order.getStatus" + }, + { + "id": "script-api:dw/order/Order#globalPartyID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.globalPartyID", + "tags": [ + "globalpartyid", + "order.globalpartyid" + ], + "title": "Order.globalPartyID" + }, + { + "id": "script-api:dw/order/Order#imported", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.imported", + "tags": [ + "imported", + "order.imported" + ], + "title": "Order.imported" + }, + { + "id": "script-api:dw/order/Order#invoiceItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoiceItems", + "tags": [ + "invoiceitems", + "order.invoiceitems" + ], + "title": "Order.invoiceItems" + }, + { + "id": "script-api:dw/order/Order#invoiceNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoiceNo", + "tags": [ + "invoiceno", + "order.invoiceno" + ], + "title": "Order.invoiceNo" + }, + { + "id": "script-api:dw/order/Order#invoices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoices", + "tags": [ + "invoices", + "order.invoices" + ], + "title": "Order.invoices" + }, + { + "id": "script-api:dw/order/Order#isImported", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.isImported", + "tags": [ + "isimported", + "order.isimported" + ], + "title": "Order.isImported" + }, + { + "id": "script-api:dw/order/Order#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.isTaxRoundedAtGroup", + "tags": [ + "istaxroundedatgroup", + "order.istaxroundedatgroup" + ], + "title": "Order.isTaxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/Order#orderExportXML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderExportXML", + "tags": [ + "orderexportxml", + "order.orderexportxml" + ], + "title": "Order.orderExportXML" + }, + { + "id": "script-api:dw/order/Order#orderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderNo", + "tags": [ + "orderno", + "order.orderno" + ], + "title": "Order.orderNo" + }, + { + "id": "script-api:dw/order/Order#orderToken", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderToken", + "tags": [ + "ordertoken", + "order.ordertoken" + ], + "title": "Order.orderToken" + }, + { + "id": "script-api:dw/order/Order#originalOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.originalOrder", + "tags": [ + "originalorder", + "order.originalorder" + ], + "title": "Order.originalOrder" + }, + { + "id": "script-api:dw/order/Order#originalOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.originalOrderNo", + "tags": [ + "originalorderno", + "order.originalorderno" + ], + "title": "Order.originalOrderNo" + }, + { + "id": "script-api:dw/order/Order#paymentStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.paymentStatus", + "tags": [ + "paymentstatus", + "order.paymentstatus" + ], + "title": "Order.paymentStatus" + }, + { + "id": "script-api:dw/order/Order#paymentTransaction", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.paymentTransaction", + "tags": [ + "paymenttransaction", + "order.paymenttransaction" + ], + "title": "Order.paymentTransaction" + }, + { + "id": "script-api:dw/order/Order#reauthorize", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.reauthorize", + "tags": [ + "reauthorize", + "order.reauthorize" + ], + "title": "Order.reauthorize" + }, + { + "id": "script-api:dw/order/Order#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.refundedAmount", + "tags": [ + "refundedamount", + "order.refundedamount" + ], + "title": "Order.refundedAmount" + }, + { + "id": "script-api:dw/order/Order#remoteHost", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.remoteHost", + "tags": [ + "remotehost", + "order.remotehost" + ], + "title": "Order.remoteHost" + }, + { + "id": "script-api:dw/order/Order#removeRemoteHost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.removeRemoteHost", + "tags": [ + "removeremotehost", + "order.removeremotehost" + ], + "title": "Order.removeRemoteHost" + }, + { + "id": "script-api:dw/order/Order#replaceCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replaceCode", + "tags": [ + "replacecode", + "order.replacecode" + ], + "title": "Order.replaceCode" + }, + { + "id": "script-api:dw/order/Order#replaceDescription", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replaceDescription", + "tags": [ + "replacedescription", + "order.replacedescription" + ], + "title": "Order.replaceDescription" + }, + { + "id": "script-api:dw/order/Order#replacedOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacedOrder", + "tags": [ + "replacedorder", + "order.replacedorder" + ], + "title": "Order.replacedOrder" + }, + { + "id": "script-api:dw/order/Order#replacedOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacedOrderNo", + "tags": [ + "replacedorderno", + "order.replacedorderno" + ], + "title": "Order.replacedOrderNo" + }, + { + "id": "script-api:dw/order/Order#replacementOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacementOrder", + "tags": [ + "replacementorder", + "order.replacementorder" + ], + "title": "Order.replacementOrder" + }, + { + "id": "script-api:dw/order/Order#replacementOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacementOrderNo", + "tags": [ + "replacementorderno", + "order.replacementorderno" + ], + "title": "Order.replacementOrderNo" + }, + { + "id": "script-api:dw/order/Order#returnCaseItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnCaseItems", + "tags": [ + "returncaseitems", + "order.returncaseitems" + ], + "title": "Order.returnCaseItems" + }, + { + "id": "script-api:dw/order/Order#returnCases", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnCases", + "tags": [ + "returncases", + "order.returncases" + ], + "title": "Order.returnCases" + }, + { + "id": "script-api:dw/order/Order#returnItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnItems", + "tags": [ + "returnitems", + "order.returnitems" + ], + "title": "Order.returnItems" + }, + { + "id": "script-api:dw/order/Order#returns", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returns", + "tags": [ + "returns", + "order.returns" + ], + "title": "Order.returns" + }, + { + "id": "script-api:dw/order/Order#setAffiliatePartnerID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setAffiliatePartnerID", + "tags": [ + "setaffiliatepartnerid", + "order.setaffiliatepartnerid" + ], + "title": "Order.setAffiliatePartnerID" + }, + { + "id": "script-api:dw/order/Order#setAffiliatePartnerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setAffiliatePartnerName", + "tags": [ + "setaffiliatepartnername", + "order.setaffiliatepartnername" + ], + "title": "Order.setAffiliatePartnerName" + }, + { + "id": "script-api:dw/order/Order#setCancelCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCancelCode", + "tags": [ + "setcancelcode", + "order.setcancelcode" + ], + "title": "Order.setCancelCode" + }, + { + "id": "script-api:dw/order/Order#setCancelDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCancelDescription", + "tags": [ + "setcanceldescription", + "order.setcanceldescription" + ], + "title": "Order.setCancelDescription" + }, + { + "id": "script-api:dw/order/Order#setConfirmationStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setConfirmationStatus", + "tags": [ + "setconfirmationstatus", + "order.setconfirmationstatus" + ], + "title": "Order.setConfirmationStatus" + }, + { + "id": "script-api:dw/order/Order#setCustomer", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomer", + "tags": [ + "setcustomer", + "order.setcustomer" + ], + "title": "Order.setCustomer" + }, + { + "id": "script-api:dw/order/Order#setCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomerNo", + "tags": [ + "setcustomerno", + "order.setcustomerno" + ], + "title": "Order.setCustomerNo" + }, + { + "id": "script-api:dw/order/Order#setCustomerOrderReference", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomerOrderReference", + "tags": [ + "setcustomerorderreference", + "order.setcustomerorderreference" + ], + "title": "Order.setCustomerOrderReference" + }, + { + "id": "script-api:dw/order/Order#setExportAfter", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExportAfter", + "tags": [ + "setexportafter", + "order.setexportafter" + ], + "title": "Order.setExportAfter" + }, + { + "id": "script-api:dw/order/Order#setExportStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExportStatus", + "tags": [ + "setexportstatus", + "order.setexportstatus" + ], + "title": "Order.setExportStatus" + }, + { + "id": "script-api:dw/order/Order#setExternalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderNo", + "tags": [ + "setexternalorderno", + "order.setexternalorderno" + ], + "title": "Order.setExternalOrderNo" + }, + { + "id": "script-api:dw/order/Order#setExternalOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderStatus", + "tags": [ + "setexternalorderstatus", + "order.setexternalorderstatus" + ], + "title": "Order.setExternalOrderStatus" + }, + { + "id": "script-api:dw/order/Order#setExternalOrderText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderText", + "tags": [ + "setexternalordertext", + "order.setexternalordertext" + ], + "title": "Order.setExternalOrderText" + }, + { + "id": "script-api:dw/order/Order#setInvoiceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setInvoiceNo", + "tags": [ + "setinvoiceno", + "order.setinvoiceno" + ], + "title": "Order.setInvoiceNo" + }, + { + "id": "script-api:dw/order/Order#setOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setOrderStatus", + "tags": [ + "setorderstatus", + "order.setorderstatus" + ], + "title": "Order.setOrderStatus" + }, + { + "id": "script-api:dw/order/Order#setPaymentStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setPaymentStatus", + "tags": [ + "setpaymentstatus", + "order.setpaymentstatus" + ], + "title": "Order.setPaymentStatus" + }, + { + "id": "script-api:dw/order/Order#setReplaceCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setReplaceCode", + "tags": [ + "setreplacecode", + "order.setreplacecode" + ], + "title": "Order.setReplaceCode" + }, + { + "id": "script-api:dw/order/Order#setReplaceDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setReplaceDescription", + "tags": [ + "setreplacedescription", + "order.setreplacedescription" + ], + "title": "Order.setReplaceDescription" + }, + { + "id": "script-api:dw/order/Order#setShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setShippingStatus", + "tags": [ + "setshippingstatus", + "order.setshippingstatus" + ], + "title": "Order.setShippingStatus" + }, + { + "id": "script-api:dw/order/Order#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setStatus", + "tags": [ + "setstatus", + "order.setstatus" + ], + "title": "Order.setStatus" + }, + { + "id": "script-api:dw/order/Order#shippingOrderItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingOrderItems", + "tags": [ + "shippingorderitems", + "order.shippingorderitems" + ], + "title": "Order.shippingOrderItems" + }, + { + "id": "script-api:dw/order/Order#shippingOrders", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingOrders", + "tags": [ + "shippingorders", + "order.shippingorders" + ], + "title": "Order.shippingOrders" + }, + { + "id": "script-api:dw/order/Order#shippingStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingStatus", + "tags": [ + "shippingstatus", + "order.shippingstatus" + ], + "title": "Order.shippingStatus" + }, + { + "id": "script-api:dw/order/Order#sourceCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCode", + "tags": [ + "sourcecode", + "order.sourcecode" + ], + "title": "Order.sourceCode" + }, + { + "id": "script-api:dw/order/Order#sourceCodeGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCodeGroup", + "tags": [ + "sourcecodegroup", + "order.sourcecodegroup" + ], + "title": "Order.sourceCodeGroup" + }, + { + "id": "script-api:dw/order/Order#sourceCodeGroupID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCodeGroupID", + "tags": [ + "sourcecodegroupid", + "order.sourcecodegroupid" + ], + "title": "Order.sourceCodeGroupID" + }, + { + "id": "script-api:dw/order/Order#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.status", + "tags": [ + "status", + "order.status" + ], + "title": "Order.status" + }, + { + "id": "script-api:dw/order/Order#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.taxRoundedAtGroup", + "tags": [ + "taxroundedatgroup", + "order.taxroundedatgroup" + ], + "title": "Order.taxRoundedAtGroup" + }, + { + "id": "script-api:dw/order/Order#trackOrderChange", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.trackOrderChange", + "tags": [ + "trackorderchange", + "order.trackorderchange" + ], + "title": "Order.trackOrderChange" + }, + { + "id": "script-api:dw/order/OrderAddress", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderAddress", + "tags": [ + "orderaddress", + "dw.order.orderaddress", + "dw/order" + ], + "title": "OrderAddress" + }, + { + "id": "script-api:dw/order/OrderAddress#address1", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.address1", + "tags": [ + "address1", + "orderaddress.address1" + ], + "title": "OrderAddress.address1" + }, + { + "id": "script-api:dw/order/OrderAddress#address2", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.address2", + "tags": [ + "address2", + "orderaddress.address2" + ], + "title": "OrderAddress.address2" + }, + { + "id": "script-api:dw/order/OrderAddress#city", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.city", + "tags": [ + "city", + "orderaddress.city" + ], + "title": "OrderAddress.city" + }, + { + "id": "script-api:dw/order/OrderAddress#companyName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.companyName", + "tags": [ + "companyname", + "orderaddress.companyname" + ], + "title": "OrderAddress.companyName" + }, + { + "id": "script-api:dw/order/OrderAddress#countryCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.countryCode", + "tags": [ + "countrycode", + "orderaddress.countrycode" + ], + "title": "OrderAddress.countryCode" + }, + { + "id": "script-api:dw/order/OrderAddress#firstName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.firstName", + "tags": [ + "firstname", + "orderaddress.firstname" + ], + "title": "OrderAddress.firstName" + }, + { + "id": "script-api:dw/order/OrderAddress#fullName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.fullName", + "tags": [ + "fullname", + "orderaddress.fullname" + ], + "title": "OrderAddress.fullName" + }, + { + "id": "script-api:dw/order/OrderAddress#getAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getAddress1", + "tags": [ + "getaddress1", + "orderaddress.getaddress1" + ], + "title": "OrderAddress.getAddress1" + }, + { + "id": "script-api:dw/order/OrderAddress#getAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getAddress2", + "tags": [ + "getaddress2", + "orderaddress.getaddress2" + ], + "title": "OrderAddress.getAddress2" + }, + { + "id": "script-api:dw/order/OrderAddress#getCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCity", + "tags": [ + "getcity", + "orderaddress.getcity" + ], + "title": "OrderAddress.getCity" + }, + { + "id": "script-api:dw/order/OrderAddress#getCompanyName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCompanyName", + "tags": [ + "getcompanyname", + "orderaddress.getcompanyname" + ], + "title": "OrderAddress.getCompanyName" + }, + { + "id": "script-api:dw/order/OrderAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCountryCode", + "tags": [ + "getcountrycode", + "orderaddress.getcountrycode" + ], + "title": "OrderAddress.getCountryCode" + }, + { + "id": "script-api:dw/order/OrderAddress#getFirstName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getFirstName", + "tags": [ + "getfirstname", + "orderaddress.getfirstname" + ], + "title": "OrderAddress.getFirstName" + }, + { + "id": "script-api:dw/order/OrderAddress#getFullName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getFullName", + "tags": [ + "getfullname", + "orderaddress.getfullname" + ], + "title": "OrderAddress.getFullName" + }, + { + "id": "script-api:dw/order/OrderAddress#getJobTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getJobTitle", + "tags": [ + "getjobtitle", + "orderaddress.getjobtitle" + ], + "title": "OrderAddress.getJobTitle" + }, + { + "id": "script-api:dw/order/OrderAddress#getLastName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getLastName", + "tags": [ + "getlastname", + "orderaddress.getlastname" + ], + "title": "OrderAddress.getLastName" + }, + { + "id": "script-api:dw/order/OrderAddress#getPhone", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPhone", + "tags": [ + "getphone", + "orderaddress.getphone" + ], + "title": "OrderAddress.getPhone" + }, + { + "id": "script-api:dw/order/OrderAddress#getPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPostBox", + "tags": [ + "getpostbox", + "orderaddress.getpostbox" + ], + "title": "OrderAddress.getPostBox" + }, + { + "id": "script-api:dw/order/OrderAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPostalCode", + "tags": [ + "getpostalcode", + "orderaddress.getpostalcode" + ], + "title": "OrderAddress.getPostalCode" + }, + { + "id": "script-api:dw/order/OrderAddress#getSalutation", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSalutation", + "tags": [ + "getsalutation", + "orderaddress.getsalutation" + ], + "title": "OrderAddress.getSalutation" + }, + { + "id": "script-api:dw/order/OrderAddress#getSecondName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSecondName", + "tags": [ + "getsecondname", + "orderaddress.getsecondname" + ], + "title": "OrderAddress.getSecondName" + }, + { + "id": "script-api:dw/order/OrderAddress#getStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getStateCode", + "tags": [ + "getstatecode", + "orderaddress.getstatecode" + ], + "title": "OrderAddress.getStateCode" + }, + { + "id": "script-api:dw/order/OrderAddress#getSuffix", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSuffix", + "tags": [ + "getsuffix", + "orderaddress.getsuffix" + ], + "title": "OrderAddress.getSuffix" + }, + { + "id": "script-api:dw/order/OrderAddress#getSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSuite", + "tags": [ + "getsuite", + "orderaddress.getsuite" + ], + "title": "OrderAddress.getSuite" + }, + { + "id": "script-api:dw/order/OrderAddress#getTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getTitle", + "tags": [ + "gettitle", + "orderaddress.gettitle" + ], + "title": "OrderAddress.getTitle" + }, + { + "id": "script-api:dw/order/OrderAddress#isEquivalentAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.isEquivalentAddress", + "tags": [ + "isequivalentaddress", + "orderaddress.isequivalentaddress" + ], + "title": "OrderAddress.isEquivalentAddress" + }, + { + "id": "script-api:dw/order/OrderAddress#jobTitle", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.jobTitle", + "tags": [ + "jobtitle", + "orderaddress.jobtitle" + ], + "title": "OrderAddress.jobTitle" + }, + { + "id": "script-api:dw/order/OrderAddress#lastName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.lastName", + "tags": [ + "lastname", + "orderaddress.lastname" + ], + "title": "OrderAddress.lastName" + }, + { + "id": "script-api:dw/order/OrderAddress#phone", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.phone", + "tags": [ + "phone", + "orderaddress.phone" + ], + "title": "OrderAddress.phone" + }, + { + "id": "script-api:dw/order/OrderAddress#postBox", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.postBox", + "tags": [ + "postbox", + "orderaddress.postbox" + ], + "title": "OrderAddress.postBox" + }, + { + "id": "script-api:dw/order/OrderAddress#postalCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.postalCode", + "tags": [ + "postalcode", + "orderaddress.postalcode" + ], + "title": "OrderAddress.postalCode" + }, + { + "id": "script-api:dw/order/OrderAddress#salutation", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.salutation", + "tags": [ + "salutation", + "orderaddress.salutation" + ], + "title": "OrderAddress.salutation" + }, + { + "id": "script-api:dw/order/OrderAddress#secondName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.secondName", + "tags": [ + "secondname", + "orderaddress.secondname" + ], + "title": "OrderAddress.secondName" + }, + { + "id": "script-api:dw/order/OrderAddress#setAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setAddress1", + "tags": [ + "setaddress1", + "orderaddress.setaddress1" + ], + "title": "OrderAddress.setAddress1" + }, + { + "id": "script-api:dw/order/OrderAddress#setAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setAddress2", + "tags": [ + "setaddress2", + "orderaddress.setaddress2" + ], + "title": "OrderAddress.setAddress2" + }, + { + "id": "script-api:dw/order/OrderAddress#setCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCity", + "tags": [ + "setcity", + "orderaddress.setcity" + ], + "title": "OrderAddress.setCity" + }, + { + "id": "script-api:dw/order/OrderAddress#setCompanyName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCompanyName", + "tags": [ + "setcompanyname", + "orderaddress.setcompanyname" + ], + "title": "OrderAddress.setCompanyName" + }, + { + "id": "script-api:dw/order/OrderAddress#setCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCountryCode", + "tags": [ + "setcountrycode", + "orderaddress.setcountrycode" + ], + "title": "OrderAddress.setCountryCode" + }, + { + "id": "script-api:dw/order/OrderAddress#setFirstName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setFirstName", + "tags": [ + "setfirstname", + "orderaddress.setfirstname" + ], + "title": "OrderAddress.setFirstName" + }, + { + "id": "script-api:dw/order/OrderAddress#setJobTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setJobTitle", + "tags": [ + "setjobtitle", + "orderaddress.setjobtitle" + ], + "title": "OrderAddress.setJobTitle" + }, + { + "id": "script-api:dw/order/OrderAddress#setLastName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setLastName", + "tags": [ + "setlastname", + "orderaddress.setlastname" + ], + "title": "OrderAddress.setLastName" + }, + { + "id": "script-api:dw/order/OrderAddress#setPhone", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPhone", + "tags": [ + "setphone", + "orderaddress.setphone" + ], + "title": "OrderAddress.setPhone" + }, + { + "id": "script-api:dw/order/OrderAddress#setPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPostBox", + "tags": [ + "setpostbox", + "orderaddress.setpostbox" + ], + "title": "OrderAddress.setPostBox" + }, + { + "id": "script-api:dw/order/OrderAddress#setPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPostalCode", + "tags": [ + "setpostalcode", + "orderaddress.setpostalcode" + ], + "title": "OrderAddress.setPostalCode" + }, + { + "id": "script-api:dw/order/OrderAddress#setSaluation", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSaluation", + "tags": [ + "setsaluation", + "orderaddress.setsaluation" + ], + "title": "OrderAddress.setSaluation" + }, + { + "id": "script-api:dw/order/OrderAddress#setSalutation", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSalutation", + "tags": [ + "setsalutation", + "orderaddress.setsalutation" + ], + "title": "OrderAddress.setSalutation" + }, + { + "id": "script-api:dw/order/OrderAddress#setSecondName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSecondName", + "tags": [ + "setsecondname", + "orderaddress.setsecondname" + ], + "title": "OrderAddress.setSecondName" + }, + { + "id": "script-api:dw/order/OrderAddress#setStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setStateCode", + "tags": [ + "setstatecode", + "orderaddress.setstatecode" + ], + "title": "OrderAddress.setStateCode" + }, + { + "id": "script-api:dw/order/OrderAddress#setSuffix", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSuffix", + "tags": [ + "setsuffix", + "orderaddress.setsuffix" + ], + "title": "OrderAddress.setSuffix" + }, + { + "id": "script-api:dw/order/OrderAddress#setSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSuite", + "tags": [ + "setsuite", + "orderaddress.setsuite" + ], + "title": "OrderAddress.setSuite" + }, + { + "id": "script-api:dw/order/OrderAddress#setTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setTitle", + "tags": [ + "settitle", + "orderaddress.settitle" + ], + "title": "OrderAddress.setTitle" + }, + { + "id": "script-api:dw/order/OrderAddress#stateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.stateCode", + "tags": [ + "statecode", + "orderaddress.statecode" + ], + "title": "OrderAddress.stateCode" + }, + { + "id": "script-api:dw/order/OrderAddress#suffix", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.suffix", + "tags": [ + "suffix", + "orderaddress.suffix" + ], + "title": "OrderAddress.suffix" + }, + { + "id": "script-api:dw/order/OrderAddress#suite", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.suite", + "tags": [ + "suite", + "orderaddress.suite" + ], + "title": "OrderAddress.suite" + }, + { + "id": "script-api:dw/order/OrderAddress#title", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.title", + "tags": [ + "title", + "orderaddress.title" + ], + "title": "OrderAddress.title" + }, + { + "id": "script-api:dw/order/OrderItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderItem", + "tags": [ + "orderitem", + "dw.order.orderitem", + "dw/order" + ], + "title": "OrderItem" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_BACKORDER", + "tags": [ + "status_backorder", + "orderitem.status_backorder" + ], + "title": "OrderItem.STATUS_BACKORDER" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_BACKORDER", + "tags": [ + "status_backorder", + "orderitem.status_backorder" + ], + "title": "OrderItem.STATUS_BACKORDER" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "orderitem.status_cancelled" + ], + "title": "OrderItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "orderitem.status_cancelled" + ], + "title": "OrderItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "orderitem.status_confirmed" + ], + "title": "OrderItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "orderitem.status_confirmed" + ], + "title": "OrderItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CREATED", + "tags": [ + "status_created", + "orderitem.status_created" + ], + "title": "OrderItem.STATUS_CREATED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CREATED", + "tags": [ + "status_created", + "orderitem.status_created" + ], + "title": "OrderItem.STATUS_CREATED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_NEW", + "tags": [ + "status_new", + "orderitem.status_new" + ], + "title": "OrderItem.STATUS_NEW" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_NEW", + "tags": [ + "status_new", + "orderitem.status_new" + ], + "title": "OrderItem.STATUS_NEW" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_OPEN", + "tags": [ + "status_open", + "orderitem.status_open" + ], + "title": "OrderItem.STATUS_OPEN" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_OPEN", + "tags": [ + "status_open", + "orderitem.status_open" + ], + "title": "OrderItem.STATUS_OPEN" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "orderitem.status_shipped" + ], + "title": "OrderItem.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "orderitem.status_shipped" + ], + "title": "OrderItem.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "orderitem.status_warehouse" + ], + "title": "OrderItem.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/OrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "orderitem.status_warehouse" + ], + "title": "OrderItem.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/OrderItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_PRODUCT", + "tags": [ + "type_product", + "orderitem.type_product" + ], + "title": "OrderItem.TYPE_PRODUCT" + }, + { + "id": "script-api:dw/order/OrderItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_PRODUCT", + "tags": [ + "type_product", + "orderitem.type_product" + ], + "title": "OrderItem.TYPE_PRODUCT" + }, + { + "id": "script-api:dw/order/OrderItem#TYPE_SERVICE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_SERVICE", + "tags": [ + "type_service", + "orderitem.type_service" + ], + "title": "OrderItem.TYPE_SERVICE" + }, + { + "id": "script-api:dw/order/OrderItem#TYPE_SERVICE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_SERVICE", + "tags": [ + "type_service", + "orderitem.type_service" + ], + "title": "OrderItem.TYPE_SERVICE" + }, + { + "id": "script-api:dw/order/OrderItem#allocateInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.allocateInventory", + "tags": [ + "allocateinventory", + "orderitem.allocateinventory" + ], + "title": "OrderItem.allocateInventory" + }, + { + "id": "script-api:dw/order/OrderItem#appeasedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.appeasedAmount", + "tags": [ + "appeasedamount", + "orderitem.appeasedamount" + ], + "title": "OrderItem.appeasedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.capturedAmount", + "tags": [ + "capturedamount", + "orderitem.capturedamount" + ], + "title": "OrderItem.capturedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#getAppeasedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getAppeasedAmount", + "tags": [ + "getappeasedamount", + "orderitem.getappeasedamount" + ], + "title": "OrderItem.getAppeasedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getCapturedAmount", + "tags": [ + "getcapturedamount", + "orderitem.getcapturedamount" + ], + "title": "OrderItem.getCapturedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#getInvoiceItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getInvoiceItems", + "tags": [ + "getinvoiceitems", + "orderitem.getinvoiceitems" + ], + "title": "OrderItem.getInvoiceItems" + }, + { + "id": "script-api:dw/order/OrderItem#getItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getItemID", + "tags": [ + "getitemid", + "orderitem.getitemid" + ], + "title": "OrderItem.getItemID" + }, + { + "id": "script-api:dw/order/OrderItem#getLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getLineItem", + "tags": [ + "getlineitem", + "orderitem.getlineitem" + ], + "title": "OrderItem.getLineItem" + }, + { + "id": "script-api:dw/order/OrderItem#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getRefundedAmount", + "tags": [ + "getrefundedamount", + "orderitem.getrefundedamount" + ], + "title": "OrderItem.getRefundedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#getReturnCaseItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getReturnCaseItems", + "tags": [ + "getreturncaseitems", + "orderitem.getreturncaseitems" + ], + "title": "OrderItem.getReturnCaseItems" + }, + { + "id": "script-api:dw/order/OrderItem#getReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getReturnedQuantity", + "tags": [ + "getreturnedquantity", + "orderitem.getreturnedquantity" + ], + "title": "OrderItem.getReturnedQuantity" + }, + { + "id": "script-api:dw/order/OrderItem#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItem", + "tags": [ + "getshippingorderitem", + "orderitem.getshippingorderitem" + ], + "title": "OrderItem.getShippingOrderItem" + }, + { + "id": "script-api:dw/order/OrderItem#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItems", + "tags": [ + "getshippingorderitems", + "orderitem.getshippingorderitems" + ], + "title": "OrderItem.getShippingOrderItems" + }, + { + "id": "script-api:dw/order/OrderItem#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItems", + "tags": [ + "getshippingorderitems", + "orderitem.getshippingorderitems" + ], + "title": "OrderItem.getShippingOrderItems" + }, + { + "id": "script-api:dw/order/OrderItem#getSplitItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getSplitItems", + "tags": [ + "getsplititems", + "orderitem.getsplititems" + ], + "title": "OrderItem.getSplitItems" + }, + { + "id": "script-api:dw/order/OrderItem#getSplitSourceItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getSplitSourceItem", + "tags": [ + "getsplitsourceitem", + "orderitem.getsplitsourceitem" + ], + "title": "OrderItem.getSplitSourceItem" + }, + { + "id": "script-api:dw/order/OrderItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getStatus", + "tags": [ + "getstatus", + "orderitem.getstatus" + ], + "title": "OrderItem.getStatus" + }, + { + "id": "script-api:dw/order/OrderItem#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getType", + "tags": [ + "gettype", + "orderitem.gettype" + ], + "title": "OrderItem.getType" + }, + { + "id": "script-api:dw/order/OrderItem#invoiceItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.invoiceItems", + "tags": [ + "invoiceitems", + "orderitem.invoiceitems" + ], + "title": "OrderItem.invoiceItems" + }, + { + "id": "script-api:dw/order/OrderItem#itemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.itemID", + "tags": [ + "itemid", + "orderitem.itemid" + ], + "title": "OrderItem.itemID" + }, + { + "id": "script-api:dw/order/OrderItem#lineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.lineItem", + "tags": [ + "lineitem", + "orderitem.lineitem" + ], + "title": "OrderItem.lineItem" + }, + { + "id": "script-api:dw/order/OrderItem#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.refundedAmount", + "tags": [ + "refundedamount", + "orderitem.refundedamount" + ], + "title": "OrderItem.refundedAmount" + }, + { + "id": "script-api:dw/order/OrderItem#returnCaseItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.returnCaseItems", + "tags": [ + "returncaseitems", + "orderitem.returncaseitems" + ], + "title": "OrderItem.returnCaseItems" + }, + { + "id": "script-api:dw/order/OrderItem#returnedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.returnedQuantity", + "tags": [ + "returnedquantity", + "orderitem.returnedquantity" + ], + "title": "OrderItem.returnedQuantity" + }, + { + "id": "script-api:dw/order/OrderItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.setStatus", + "tags": [ + "setstatus", + "orderitem.setstatus" + ], + "title": "OrderItem.setStatus" + }, + { + "id": "script-api:dw/order/OrderItem#shippingOrderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.shippingOrderItem", + "tags": [ + "shippingorderitem", + "orderitem.shippingorderitem" + ], + "title": "OrderItem.shippingOrderItem" + }, + { + "id": "script-api:dw/order/OrderItem#shippingOrderItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.shippingOrderItems", + "tags": [ + "shippingorderitems", + "orderitem.shippingorderitems" + ], + "title": "OrderItem.shippingOrderItems" + }, + { + "id": "script-api:dw/order/OrderItem#splitItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.splitItems", + "tags": [ + "splititems", + "orderitem.splititems" + ], + "title": "OrderItem.splitItems" + }, + { + "id": "script-api:dw/order/OrderItem#splitSourceItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.splitSourceItem", + "tags": [ + "splitsourceitem", + "orderitem.splitsourceitem" + ], + "title": "OrderItem.splitSourceItem" + }, + { + "id": "script-api:dw/order/OrderItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.status", + "tags": [ + "status", + "orderitem.status" + ], + "title": "OrderItem.status" + }, + { + "id": "script-api:dw/order/OrderItem#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.type", + "tags": [ + "type", + "orderitem.type" + ], + "title": "OrderItem.type" + }, + { + "id": "script-api:dw/order/OrderMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderMgr", + "tags": [ + "ordermgr", + "dw.order.ordermgr", + "dw/order" + ], + "title": "OrderMgr" + }, + { + "id": "script-api:dw/order/OrderMgr#cancelOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.cancelOrder", + "tags": [ + "cancelorder", + "ordermgr.cancelorder" + ], + "title": "OrderMgr.cancelOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#cancelOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.cancelOrder", + "tags": [ + "cancelorder", + "ordermgr.cancelorder" + ], + "title": "OrderMgr.cancelOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "title": "OrderMgr.createOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "title": "OrderMgr.createOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "title": "OrderMgr.createOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "title": "OrderMgr.createOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderNo", + "tags": [ + "createorderno", + "ordermgr.createorderno" + ], + "title": "OrderMgr.createOrderNo" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderNo", + "tags": [ + "createorderno", + "ordermgr.createorderno" + ], + "title": "OrderMgr.createOrderNo" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrderSequenceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderSequenceNo", + "tags": [ + "createordersequenceno", + "ordermgr.createordersequenceno" + ], + "title": "OrderMgr.createOrderSequenceNo" + }, + { + "id": "script-api:dw/order/OrderMgr#createOrderSequenceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderSequenceNo", + "tags": [ + "createordersequenceno", + "ordermgr.createordersequenceno" + ], + "title": "OrderMgr.createOrderSequenceNo" + }, + { + "id": "script-api:dw/order/OrderMgr#createShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createShippingOrders", + "tags": [ + "createshippingorders", + "ordermgr.createshippingorders" + ], + "title": "OrderMgr.createShippingOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#createShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createShippingOrders", + "tags": [ + "createshippingorders", + "ordermgr.createshippingorders" + ], + "title": "OrderMgr.createShippingOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#describeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.describeOrder", + "tags": [ + "describeorder", + "ordermgr.describeorder" + ], + "title": "OrderMgr.describeOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#describeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.describeOrder", + "tags": [ + "describeorder", + "ordermgr.describeorder" + ], + "title": "OrderMgr.describeOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#placeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.placeOrder", + "tags": [ + "placeorder", + "ordermgr.placeorder" + ], + "title": "OrderMgr.placeOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#placeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.placeOrder", + "tags": [ + "placeorder", + "ordermgr.placeorder" + ], + "title": "OrderMgr.placeOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#processOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.processOrders", + "tags": [ + "processorders", + "ordermgr.processorders" + ], + "title": "OrderMgr.processOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#processOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.processOrders", + "tags": [ + "processorders", + "ordermgr.processorders" + ], + "title": "OrderMgr.processOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrder", + "tags": [ + "queryorder", + "ordermgr.queryorder" + ], + "title": "OrderMgr.queryOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrder", + "tags": [ + "queryorder", + "ordermgr.queryorder" + ], + "title": "OrderMgr.queryOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrder", + "tags": [ + "searchorder", + "ordermgr.searchorder" + ], + "title": "OrderMgr.searchOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrder", + "tags": [ + "searchorder", + "ordermgr.searchorder" + ], + "title": "OrderMgr.searchOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "id": "script-api:dw/order/OrderMgr#undoCancelOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoCancelOrder", + "tags": [ + "undocancelorder", + "ordermgr.undocancelorder" + ], + "title": "OrderMgr.undoCancelOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#undoCancelOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoCancelOrder", + "tags": [ + "undocancelorder", + "ordermgr.undocancelorder" + ], + "title": "OrderMgr.undoCancelOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#undoFailOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoFailOrder", + "tags": [ + "undofailorder", + "ordermgr.undofailorder" + ], + "title": "OrderMgr.undoFailOrder" + }, + { + "id": "script-api:dw/order/OrderMgr#undoFailOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoFailOrder", + "tags": [ + "undofailorder", + "ordermgr.undofailorder" + ], + "title": "OrderMgr.undoFailOrder" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderPaymentInstrument", + "tags": [ + "orderpaymentinstrument", + "dw.order.orderpaymentinstrument", + "dw/order" + ], + "title": "OrderPaymentInstrument" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.bankAccountDriversLicense", + "tags": [ + "bankaccountdriverslicense", + "orderpaymentinstrument.bankaccountdriverslicense" + ], + "title": "OrderPaymentInstrument.bankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.bankAccountNumber", + "tags": [ + "bankaccountnumber", + "orderpaymentinstrument.bankaccountnumber" + ], + "title": "OrderPaymentInstrument.bankAccountNumber" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.capturedAmount", + "tags": [ + "capturedamount", + "orderpaymentinstrument.capturedamount" + ], + "title": "OrderPaymentInstrument.capturedAmount" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.creditCardNumber", + "tags": [ + "creditcardnumber", + "orderpaymentinstrument.creditcardnumber" + ], + "title": "OrderPaymentInstrument.creditCardNumber" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getBankAccountDriversLicense", + "tags": [ + "getbankaccountdriverslicense", + "orderpaymentinstrument.getbankaccountdriverslicense" + ], + "title": "OrderPaymentInstrument.getBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getBankAccountNumber", + "tags": [ + "getbankaccountnumber", + "orderpaymentinstrument.getbankaccountnumber" + ], + "title": "OrderPaymentInstrument.getBankAccountNumber" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getCapturedAmount", + "tags": [ + "getcapturedamount", + "orderpaymentinstrument.getcapturedamount" + ], + "title": "OrderPaymentInstrument.getCapturedAmount" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getCreditCardNumber", + "tags": [ + "getcreditcardnumber", + "orderpaymentinstrument.getcreditcardnumber" + ], + "title": "OrderPaymentInstrument.getCreditCardNumber" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getPaymentTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getPaymentTransaction", + "tags": [ + "getpaymenttransaction", + "orderpaymentinstrument.getpaymenttransaction" + ], + "title": "OrderPaymentInstrument.getPaymentTransaction" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getRefundedAmount", + "tags": [ + "getrefundedamount", + "orderpaymentinstrument.getrefundedamount" + ], + "title": "OrderPaymentInstrument.getRefundedAmount" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#paymentTransaction", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.paymentTransaction", + "tags": [ + "paymenttransaction", + "orderpaymentinstrument.paymenttransaction" + ], + "title": "OrderPaymentInstrument.paymentTransaction" + }, + { + "id": "script-api:dw/order/OrderPaymentInstrument#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.refundedAmount", + "tags": [ + "refundedamount", + "orderpaymentinstrument.refundedamount" + ], + "title": "OrderPaymentInstrument.refundedAmount" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderProcessStatusCodes", + "tags": [ + "orderprocessstatuscodes", + "dw.order.orderprocessstatuscodes", + "dw/order" + ], + "title": "OrderProcessStatusCodes" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#COUPON_INVALID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.COUPON_INVALID", + "tags": [ + "coupon_invalid", + "orderprocessstatuscodes.coupon_invalid" + ], + "title": "OrderProcessStatusCodes.COUPON_INVALID" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#COUPON_INVALID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.COUPON_INVALID", + "tags": [ + "coupon_invalid", + "orderprocessstatuscodes.coupon_invalid" + ], + "title": "OrderProcessStatusCodes.COUPON_INVALID" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#INVENTORY_RESERVATION_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED", + "tags": [ + "inventory_reservation_failed", + "orderprocessstatuscodes.inventory_reservation_failed" + ], + "title": "OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#INVENTORY_RESERVATION_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED", + "tags": [ + "inventory_reservation_failed", + "orderprocessstatuscodes.inventory_reservation_failed" + ], + "title": "OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED", + "tags": [ + "order_already_cancelled", + "orderprocessstatuscodes.order_already_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED", + "tags": [ + "order_already_cancelled", + "orderprocessstatuscodes.order_already_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_EXPORTED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED", + "tags": [ + "order_already_exported", + "orderprocessstatuscodes.order_already_exported" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_EXPORTED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED", + "tags": [ + "order_already_exported", + "orderprocessstatuscodes.order_already_exported" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_FAILED", + "tags": [ + "order_already_failed", + "orderprocessstatuscodes.order_already_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_FAILED", + "tags": [ + "order_already_failed", + "orderprocessstatuscodes.order_already_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_REPLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED", + "tags": [ + "order_already_replaced", + "orderprocessstatuscodes.order_already_replaced" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_REPLACED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_REPLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED", + "tags": [ + "order_already_replaced", + "orderprocessstatuscodes.order_already_replaced" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_REPLACED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_CONTAINS_GC", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC", + "tags": [ + "order_contains_gc", + "orderprocessstatuscodes.order_contains_gc" + ], + "title": "OrderProcessStatusCodes.ORDER_CONTAINS_GC" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_CONTAINS_GC", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC", + "tags": [ + "order_contains_gc", + "orderprocessstatuscodes.order_contains_gc" + ], + "title": "OrderProcessStatusCodes.ORDER_CONTAINS_GC" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_CANCELLED", + "tags": [ + "order_not_cancelled", + "orderprocessstatuscodes.order_not_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_CANCELLED", + "tags": [ + "order_not_cancelled", + "orderprocessstatuscodes.order_not_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_CANCELLED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_FAILED", + "tags": [ + "order_not_failed", + "orderprocessstatuscodes.order_not_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_FAILED", + "tags": [ + "order_not_failed", + "orderprocessstatuscodes.order_not_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_FAILED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_PLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_PLACED", + "tags": [ + "order_not_placed", + "orderprocessstatuscodes.order_not_placed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_PLACED" + }, + { + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_PLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_PLACED", + "tags": [ + "order_not_placed", + "orderprocessstatuscodes.order_not_placed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_PLACED" + }, + { + "id": "script-api:dw/order/PaymentCard", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentCard", + "tags": [ + "paymentcard", + "dw.order.paymentcard", + "dw/order" + ], + "title": "PaymentCard" + }, + { + "id": "script-api:dw/order/PaymentCard#active", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.active", + "tags": [ + "active", + "paymentcard.active" + ], + "title": "PaymentCard.active" + }, + { + "id": "script-api:dw/order/PaymentCard#cardType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.cardType", + "tags": [ + "cardtype", + "paymentcard.cardtype" + ], + "title": "PaymentCard.cardType" + }, + { + "id": "script-api:dw/order/PaymentCard#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.description", + "tags": [ + "description", + "paymentcard.description" + ], + "title": "PaymentCard.description" + }, + { + "id": "script-api:dw/order/PaymentCard#getCardType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getCardType", + "tags": [ + "getcardtype", + "paymentcard.getcardtype" + ], + "title": "PaymentCard.getCardType" + }, + { + "id": "script-api:dw/order/PaymentCard#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getDescription", + "tags": [ + "getdescription", + "paymentcard.getdescription" + ], + "title": "PaymentCard.getDescription" + }, + { + "id": "script-api:dw/order/PaymentCard#getImage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getImage", + "tags": [ + "getimage", + "paymentcard.getimage" + ], + "title": "PaymentCard.getImage" + }, + { + "id": "script-api:dw/order/PaymentCard#getName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getName", + "tags": [ + "getname", + "paymentcard.getname" + ], + "title": "PaymentCard.getName" + }, + { + "id": "script-api:dw/order/PaymentCard#image", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.image", + "tags": [ + "image", + "paymentcard.image" + ], + "title": "PaymentCard.image" + }, + { + "id": "script-api:dw/order/PaymentCard#isActive", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.isActive", + "tags": [ + "isactive", + "paymentcard.isactive" + ], + "title": "PaymentCard.isActive" + }, + { + "id": "script-api:dw/order/PaymentCard#isApplicable", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.isApplicable", + "tags": [ + "isapplicable", + "paymentcard.isapplicable" + ], + "title": "PaymentCard.isApplicable" + }, + { + "id": "script-api:dw/order/PaymentCard#name", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.name", + "tags": [ + "name", + "paymentcard.name" + ], + "title": "PaymentCard.name" + }, + { + "id": "script-api:dw/order/PaymentCard#verify", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.verify", + "tags": [ + "verify", + "paymentcard.verify" + ], + "title": "PaymentCard.verify" + }, + { + "id": "script-api:dw/order/PaymentCard#verify", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.verify", + "tags": [ + "verify", + "paymentcard.verify" + ], + "title": "PaymentCard.verify" + }, + { + "id": "script-api:dw/order/PaymentInstrument", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentInstrument", + "tags": [ + "paymentinstrument", + "dw.order.paymentinstrument", + "dw/order" + ], + "title": "PaymentInstrument" + }, + { + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA", + "tags": [ + "encryption_algorithm_rsa", + "paymentinstrument.encryption_algorithm_rsa" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA" + }, + { + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA", + "tags": [ + "encryption_algorithm_rsa", + "paymentinstrument.encryption_algorithm_rsa" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA" + }, + { + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "paymentinstrument.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "paymentinstrument.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_BANK_TRANSFER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BANK_TRANSFER", + "tags": [ + "method_bank_transfer", + "paymentinstrument.method_bank_transfer" + ], + "title": "PaymentInstrument.METHOD_BANK_TRANSFER" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_BANK_TRANSFER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BANK_TRANSFER", + "tags": [ + "method_bank_transfer", + "paymentinstrument.method_bank_transfer" + ], + "title": "PaymentInstrument.METHOD_BANK_TRANSFER" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_BML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BML", + "tags": [ + "method_bml", + "paymentinstrument.method_bml" + ], + "title": "PaymentInstrument.METHOD_BML" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_BML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BML", + "tags": [ + "method_bml", + "paymentinstrument.method_bml" + ], + "title": "PaymentInstrument.METHOD_BML" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_CREDIT_CARD", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_CREDIT_CARD", + "tags": [ + "method_credit_card", + "paymentinstrument.method_credit_card" + ], + "title": "PaymentInstrument.METHOD_CREDIT_CARD" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_CREDIT_CARD", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_CREDIT_CARD", + "tags": [ + "method_credit_card", + "paymentinstrument.method_credit_card" + ], + "title": "PaymentInstrument.METHOD_CREDIT_CARD" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_ANDROID_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_ANDROID_PAY", + "tags": [ + "method_dw_android_pay", + "paymentinstrument.method_dw_android_pay" + ], + "title": "PaymentInstrument.METHOD_DW_ANDROID_PAY" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_ANDROID_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_ANDROID_PAY", + "tags": [ + "method_dw_android_pay", + "paymentinstrument.method_dw_android_pay" + ], + "title": "PaymentInstrument.METHOD_DW_ANDROID_PAY" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_APPLE_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_APPLE_PAY", + "tags": [ + "method_dw_apple_pay", + "paymentinstrument.method_dw_apple_pay" + ], + "title": "PaymentInstrument.METHOD_DW_APPLE_PAY" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_APPLE_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_APPLE_PAY", + "tags": [ + "method_dw_apple_pay", + "paymentinstrument.method_dw_apple_pay" + ], + "title": "PaymentInstrument.METHOD_DW_APPLE_PAY" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_GIFT_CERTIFICATE", + "tags": [ + "method_gift_certificate", + "paymentinstrument.method_gift_certificate" + ], + "title": "PaymentInstrument.METHOD_GIFT_CERTIFICATE" + }, + { + "id": "script-api:dw/order/PaymentInstrument#METHOD_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_GIFT_CERTIFICATE", + "tags": [ + "method_gift_certificate", + "paymentinstrument.method_gift_certificate" + ], + "title": "PaymentInstrument.METHOD_GIFT_CERTIFICATE" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicense", + "tags": [ + "bankaccountdriverslicense", + "paymentinstrument.bankaccountdriverslicense" + ], + "title": "PaymentInstrument.bankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicenseLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicenseLastDigits", + "tags": [ + "bankaccountdriverslicenselastdigits", + "paymentinstrument.bankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.bankAccountDriversLicenseLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicenseStateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicenseStateCode", + "tags": [ + "bankaccountdriverslicensestatecode", + "paymentinstrument.bankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.bankAccountDriversLicenseStateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountHolder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountHolder", + "tags": [ + "bankaccountholder", + "paymentinstrument.bankaccountholder" + ], + "title": "PaymentInstrument.bankAccountHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountNumber", + "tags": [ + "bankaccountnumber", + "paymentinstrument.bankaccountnumber" + ], + "title": "PaymentInstrument.bankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankAccountNumberLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountNumberLastDigits", + "tags": [ + "bankaccountnumberlastdigits", + "paymentinstrument.bankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.bankAccountNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#bankRoutingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankRoutingNumber", + "tags": [ + "bankroutingnumber", + "paymentinstrument.bankroutingnumber" + ], + "title": "PaymentInstrument.bankRoutingNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardExpirationMonth", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpirationMonth", + "tags": [ + "creditcardexpirationmonth", + "paymentinstrument.creditcardexpirationmonth" + ], + "title": "PaymentInstrument.creditCardExpirationMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardExpirationYear", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpirationYear", + "tags": [ + "creditcardexpirationyear", + "paymentinstrument.creditcardexpirationyear" + ], + "title": "PaymentInstrument.creditCardExpirationYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardExpired", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpired", + "tags": [ + "creditcardexpired", + "paymentinstrument.creditcardexpired" + ], + "title": "PaymentInstrument.creditCardExpired" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardHolder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardHolder", + "tags": [ + "creditcardholder", + "paymentinstrument.creditcardholder" + ], + "title": "PaymentInstrument.creditCardHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardIssueNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardIssueNumber", + "tags": [ + "creditcardissuenumber", + "paymentinstrument.creditcardissuenumber" + ], + "title": "PaymentInstrument.creditCardIssueNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardNumber", + "tags": [ + "creditcardnumber", + "paymentinstrument.creditcardnumber" + ], + "title": "PaymentInstrument.creditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardNumberLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardNumberLastDigits", + "tags": [ + "creditcardnumberlastdigits", + "paymentinstrument.creditcardnumberlastdigits" + ], + "title": "PaymentInstrument.creditCardNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardToken", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardToken", + "tags": [ + "creditcardtoken", + "paymentinstrument.creditcardtoken" + ], + "title": "PaymentInstrument.creditCardToken" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardType", + "tags": [ + "creditcardtype", + "paymentinstrument.creditcardtype" + ], + "title": "PaymentInstrument.creditCardType" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardValidFromMonth", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardValidFromMonth", + "tags": [ + "creditcardvalidfrommonth", + "paymentinstrument.creditcardvalidfrommonth" + ], + "title": "PaymentInstrument.creditCardValidFromMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#creditCardValidFromYear", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardValidFromYear", + "tags": [ + "creditcardvalidfromyear", + "paymentinstrument.creditcardvalidfromyear" + ], + "title": "PaymentInstrument.creditCardValidFromYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicense", + "tags": [ + "getbankaccountdriverslicense", + "paymentinstrument.getbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseLastDigits", + "tags": [ + "getbankaccountdriverslicenselastdigits", + "paymentinstrument.getbankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseLastDigits", + "tags": [ + "getbankaccountdriverslicenselastdigits", + "paymentinstrument.getbankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseStateCode", + "tags": [ + "getbankaccountdriverslicensestatecode", + "paymentinstrument.getbankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseStateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountHolder", + "tags": [ + "getbankaccountholder", + "paymentinstrument.getbankaccountholder" + ], + "title": "PaymentInstrument.getBankAccountHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumber", + "tags": [ + "getbankaccountnumber", + "paymentinstrument.getbankaccountnumber" + ], + "title": "PaymentInstrument.getBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumberLastDigits", + "tags": [ + "getbankaccountnumberlastdigits", + "paymentinstrument.getbankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.getBankAccountNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumberLastDigits", + "tags": [ + "getbankaccountnumberlastdigits", + "paymentinstrument.getbankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.getBankAccountNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getBankRoutingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankRoutingNumber", + "tags": [ + "getbankroutingnumber", + "paymentinstrument.getbankroutingnumber" + ], + "title": "PaymentInstrument.getBankRoutingNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardExpirationMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardExpirationMonth", + "tags": [ + "getcreditcardexpirationmonth", + "paymentinstrument.getcreditcardexpirationmonth" + ], + "title": "PaymentInstrument.getCreditCardExpirationMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardExpirationYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardExpirationYear", + "tags": [ + "getcreditcardexpirationyear", + "paymentinstrument.getcreditcardexpirationyear" + ], + "title": "PaymentInstrument.getCreditCardExpirationYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardHolder", + "tags": [ + "getcreditcardholder", + "paymentinstrument.getcreditcardholder" + ], + "title": "PaymentInstrument.getCreditCardHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardIssueNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardIssueNumber", + "tags": [ + "getcreditcardissuenumber", + "paymentinstrument.getcreditcardissuenumber" + ], + "title": "PaymentInstrument.getCreditCardIssueNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumber", + "tags": [ + "getcreditcardnumber", + "paymentinstrument.getcreditcardnumber" + ], + "title": "PaymentInstrument.getCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumberLastDigits", + "tags": [ + "getcreditcardnumberlastdigits", + "paymentinstrument.getcreditcardnumberlastdigits" + ], + "title": "PaymentInstrument.getCreditCardNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumberLastDigits", + "tags": [ + "getcreditcardnumberlastdigits", + "paymentinstrument.getcreditcardnumberlastdigits" + ], + "title": "PaymentInstrument.getCreditCardNumberLastDigits" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardToken", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardToken", + "tags": [ + "getcreditcardtoken", + "paymentinstrument.getcreditcardtoken" + ], + "title": "PaymentInstrument.getCreditCardToken" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardType", + "tags": [ + "getcreditcardtype", + "paymentinstrument.getcreditcardtype" + ], + "title": "PaymentInstrument.getCreditCardType" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardValidFromMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardValidFromMonth", + "tags": [ + "getcreditcardvalidfrommonth", + "paymentinstrument.getcreditcardvalidfrommonth" + ], + "title": "PaymentInstrument.getCreditCardValidFromMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getCreditCardValidFromYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardValidFromYear", + "tags": [ + "getcreditcardvalidfromyear", + "paymentinstrument.getcreditcardvalidfromyear" + ], + "title": "PaymentInstrument.getCreditCardValidFromYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getEncryptedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedBankAccountDriversLicense", + "tags": [ + "getencryptedbankaccountdriverslicense", + "paymentinstrument.getencryptedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getEncryptedBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getEncryptedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedBankAccountNumber", + "tags": [ + "getencryptedbankaccountnumber", + "paymentinstrument.getencryptedbankaccountnumber" + ], + "title": "PaymentInstrument.getEncryptedBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getEncryptedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedCreditCardNumber", + "tags": [ + "getencryptedcreditcardnumber", + "paymentinstrument.getencryptedcreditcardnumber" + ], + "title": "PaymentInstrument.getEncryptedCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getEncryptedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedCreditCardNumber", + "tags": [ + "getencryptedcreditcardnumber", + "paymentinstrument.getencryptedcreditcardnumber" + ], + "title": "PaymentInstrument.getEncryptedCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getGiftCertificateCode", + "tags": [ + "getgiftcertificatecode", + "paymentinstrument.getgiftcertificatecode" + ], + "title": "PaymentInstrument.getGiftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getGiftCertificateID", + "tags": [ + "getgiftcertificateid", + "paymentinstrument.getgiftcertificateid" + ], + "title": "PaymentInstrument.getGiftCertificateID" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountDriversLicense", + "tags": [ + "getmaskedbankaccountdriverslicense", + "paymentinstrument.getmaskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getMaskedBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountDriversLicense", + "tags": [ + "getmaskedbankaccountdriverslicense", + "paymentinstrument.getmaskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getMaskedBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountNumber", + "tags": [ + "getmaskedbankaccountnumber", + "paymentinstrument.getmaskedbankaccountnumber" + ], + "title": "PaymentInstrument.getMaskedBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountNumber", + "tags": [ + "getmaskedbankaccountnumber", + "paymentinstrument.getmaskedbankaccountnumber" + ], + "title": "PaymentInstrument.getMaskedBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedCreditCardNumber", + "tags": [ + "getmaskedcreditcardnumber", + "paymentinstrument.getmaskedcreditcardnumber" + ], + "title": "PaymentInstrument.getMaskedCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedCreditCardNumber", + "tags": [ + "getmaskedcreditcardnumber", + "paymentinstrument.getmaskedcreditcardnumber" + ], + "title": "PaymentInstrument.getMaskedCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedGiftCertificateCode", + "tags": [ + "getmaskedgiftcertificatecode", + "paymentinstrument.getmaskedgiftcertificatecode" + ], + "title": "PaymentInstrument.getMaskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedGiftCertificateCode", + "tags": [ + "getmaskedgiftcertificatecode", + "paymentinstrument.getmaskedgiftcertificatecode" + ], + "title": "PaymentInstrument.getMaskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getPaymentMethod", + "tags": [ + "getpaymentmethod", + "paymentinstrument.getpaymentmethod" + ], + "title": "PaymentInstrument.getPaymentMethod" + }, + { + "id": "script-api:dw/order/PaymentInstrument#giftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.giftCertificateCode", + "tags": [ + "giftcertificatecode", + "paymentinstrument.giftcertificatecode" + ], + "title": "PaymentInstrument.giftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#giftCertificateID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.giftCertificateID", + "tags": [ + "giftcertificateid", + "paymentinstrument.giftcertificateid" + ], + "title": "PaymentInstrument.giftCertificateID" + }, + { + "id": "script-api:dw/order/PaymentInstrument#isCreditCardExpired", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.isCreditCardExpired", + "tags": [ + "iscreditcardexpired", + "paymentinstrument.iscreditcardexpired" + ], + "title": "PaymentInstrument.isCreditCardExpired" + }, + { + "id": "script-api:dw/order/PaymentInstrument#isPermanentlyMasked", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.isPermanentlyMasked", + "tags": [ + "ispermanentlymasked", + "paymentinstrument.ispermanentlymasked" + ], + "title": "PaymentInstrument.isPermanentlyMasked" + }, + { + "id": "script-api:dw/order/PaymentInstrument#maskedBankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedBankAccountDriversLicense", + "tags": [ + "maskedbankaccountdriverslicense", + "paymentinstrument.maskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.maskedBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#maskedBankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedBankAccountNumber", + "tags": [ + "maskedbankaccountnumber", + "paymentinstrument.maskedbankaccountnumber" + ], + "title": "PaymentInstrument.maskedBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#maskedCreditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedCreditCardNumber", + "tags": [ + "maskedcreditcardnumber", + "paymentinstrument.maskedcreditcardnumber" + ], + "title": "PaymentInstrument.maskedCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#maskedGiftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedGiftCertificateCode", + "tags": [ + "maskedgiftcertificatecode", + "paymentinstrument.maskedgiftcertificatecode" + ], + "title": "PaymentInstrument.maskedGiftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#paymentMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.paymentMethod", + "tags": [ + "paymentmethod", + "paymentinstrument.paymentmethod" + ], + "title": "PaymentInstrument.paymentMethod" + }, + { + "id": "script-api:dw/order/PaymentInstrument#permanentlyMasked", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.permanentlyMasked", + "tags": [ + "permanentlymasked", + "paymentinstrument.permanentlymasked" + ], + "title": "PaymentInstrument.permanentlyMasked" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountDriversLicense", + "tags": [ + "setbankaccountdriverslicense", + "paymentinstrument.setbankaccountdriverslicense" + ], + "title": "PaymentInstrument.setBankAccountDriversLicense" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setBankAccountDriversLicenseStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountDriversLicenseStateCode", + "tags": [ + "setbankaccountdriverslicensestatecode", + "paymentinstrument.setbankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.setBankAccountDriversLicenseStateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setBankAccountHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountHolder", + "tags": [ + "setbankaccountholder", + "paymentinstrument.setbankaccountholder" + ], + "title": "PaymentInstrument.setBankAccountHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountNumber", + "tags": [ + "setbankaccountnumber", + "paymentinstrument.setbankaccountnumber" + ], + "title": "PaymentInstrument.setBankAccountNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setBankRoutingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankRoutingNumber", + "tags": [ + "setbankroutingnumber", + "paymentinstrument.setbankroutingnumber" + ], + "title": "PaymentInstrument.setBankRoutingNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardExpirationMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardExpirationMonth", + "tags": [ + "setcreditcardexpirationmonth", + "paymentinstrument.setcreditcardexpirationmonth" + ], + "title": "PaymentInstrument.setCreditCardExpirationMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardExpirationYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardExpirationYear", + "tags": [ + "setcreditcardexpirationyear", + "paymentinstrument.setcreditcardexpirationyear" + ], + "title": "PaymentInstrument.setCreditCardExpirationYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardHolder", + "tags": [ + "setcreditcardholder", + "paymentinstrument.setcreditcardholder" + ], + "title": "PaymentInstrument.setCreditCardHolder" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardIssueNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardIssueNumber", + "tags": [ + "setcreditcardissuenumber", + "paymentinstrument.setcreditcardissuenumber" + ], + "title": "PaymentInstrument.setCreditCardIssueNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardNumber", + "tags": [ + "setcreditcardnumber", + "paymentinstrument.setcreditcardnumber" + ], + "title": "PaymentInstrument.setCreditCardNumber" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardToken", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardToken", + "tags": [ + "setcreditcardtoken", + "paymentinstrument.setcreditcardtoken" + ], + "title": "PaymentInstrument.setCreditCardToken" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardType", + "tags": [ + "setcreditcardtype", + "paymentinstrument.setcreditcardtype" + ], + "title": "PaymentInstrument.setCreditCardType" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardValidFromMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardValidFromMonth", + "tags": [ + "setcreditcardvalidfrommonth", + "paymentinstrument.setcreditcardvalidfrommonth" + ], + "title": "PaymentInstrument.setCreditCardValidFromMonth" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setCreditCardValidFromYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardValidFromYear", + "tags": [ + "setcreditcardvalidfromyear", + "paymentinstrument.setcreditcardvalidfromyear" + ], + "title": "PaymentInstrument.setCreditCardValidFromYear" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setGiftCertificateCode", + "tags": [ + "setgiftcertificatecode", + "paymentinstrument.setgiftcertificatecode" + ], + "title": "PaymentInstrument.setGiftCertificateCode" + }, + { + "id": "script-api:dw/order/PaymentInstrument#setGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setGiftCertificateID", + "tags": [ + "setgiftcertificateid", + "paymentinstrument.setgiftcertificateid" + ], + "title": "PaymentInstrument.setGiftCertificateID" + }, + { + "id": "script-api:dw/order/PaymentMethod", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentMethod", + "tags": [ + "paymentmethod", + "dw.order.paymentmethod", + "dw/order" + ], + "title": "PaymentMethod" + }, + { + "id": "script-api:dw/order/PaymentMethod#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.ID", + "tags": [ + "id", + "paymentmethod.id" + ], + "title": "PaymentMethod.ID" + }, + { + "id": "script-api:dw/order/PaymentMethod#active", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.active", + "tags": [ + "active", + "paymentmethod.active" + ], + "title": "PaymentMethod.active" + }, + { + "id": "script-api:dw/order/PaymentMethod#activePaymentCards", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.activePaymentCards", + "tags": [ + "activepaymentcards", + "paymentmethod.activepaymentcards" + ], + "title": "PaymentMethod.activePaymentCards" + }, + { + "id": "script-api:dw/order/PaymentMethod#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.description", + "tags": [ + "description", + "paymentmethod.description" + ], + "title": "PaymentMethod.description" + }, + { + "id": "script-api:dw/order/PaymentMethod#getActivePaymentCards", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getActivePaymentCards", + "tags": [ + "getactivepaymentcards", + "paymentmethod.getactivepaymentcards" + ], + "title": "PaymentMethod.getActivePaymentCards" + }, + { + "id": "script-api:dw/order/PaymentMethod#getApplicablePaymentCards", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getApplicablePaymentCards", + "tags": [ + "getapplicablepaymentcards", + "paymentmethod.getapplicablepaymentcards" + ], + "title": "PaymentMethod.getApplicablePaymentCards" + }, + { + "id": "script-api:dw/order/PaymentMethod#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getDescription", + "tags": [ + "getdescription", + "paymentmethod.getdescription" + ], + "title": "PaymentMethod.getDescription" + }, + { + "id": "script-api:dw/order/PaymentMethod#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getID", + "tags": [ + "getid", + "paymentmethod.getid" + ], + "title": "PaymentMethod.getID" + }, + { + "id": "script-api:dw/order/PaymentMethod#getImage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getImage", + "tags": [ + "getimage", + "paymentmethod.getimage" + ], + "title": "PaymentMethod.getImage" + }, + { + "id": "script-api:dw/order/PaymentMethod#getName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getName", + "tags": [ + "getname", + "paymentmethod.getname" + ], + "title": "PaymentMethod.getName" + }, + { + "id": "script-api:dw/order/PaymentMethod#getPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getPaymentProcessor", + "tags": [ + "getpaymentprocessor", + "paymentmethod.getpaymentprocessor" + ], + "title": "PaymentMethod.getPaymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentMethod#image", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.image", + "tags": [ + "image", + "paymentmethod.image" + ], + "title": "PaymentMethod.image" + }, + { + "id": "script-api:dw/order/PaymentMethod#isActive", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.isActive", + "tags": [ + "isactive", + "paymentmethod.isactive" + ], + "title": "PaymentMethod.isActive" + }, + { + "id": "script-api:dw/order/PaymentMethod#isApplicable", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.isApplicable", + "tags": [ + "isapplicable", + "paymentmethod.isapplicable" + ], + "title": "PaymentMethod.isApplicable" + }, + { + "id": "script-api:dw/order/PaymentMethod#name", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.name", + "tags": [ + "name", + "paymentmethod.name" + ], + "title": "PaymentMethod.name" + }, + { + "id": "script-api:dw/order/PaymentMethod#paymentProcessor", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.paymentProcessor", + "tags": [ + "paymentprocessor", + "paymentmethod.paymentprocessor" + ], + "title": "PaymentMethod.paymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentMgr", + "tags": [ + "paymentmgr", + "dw.order.paymentmgr", + "dw/order" + ], + "title": "PaymentMgr" + }, + { + "id": "script-api:dw/order/PaymentMgr#activePaymentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.activePaymentMethods", + "tags": [ + "activepaymentmethods", + "paymentmgr.activepaymentmethods" + ], + "title": "PaymentMgr.activePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#activePaymentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.activePaymentMethods", + "tags": [ + "activepaymentmethods", + "paymentmgr.activepaymentmethods" + ], + "title": "PaymentMgr.activePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#getActivePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getActivePaymentMethods", + "tags": [ + "getactivepaymentmethods", + "paymentmgr.getactivepaymentmethods" + ], + "title": "PaymentMgr.getActivePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#getActivePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getActivePaymentMethods", + "tags": [ + "getactivepaymentmethods", + "paymentmgr.getactivepaymentmethods" + ], + "title": "PaymentMgr.getActivePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#getApplicablePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getApplicablePaymentMethods", + "tags": [ + "getapplicablepaymentmethods", + "paymentmgr.getapplicablepaymentmethods" + ], + "title": "PaymentMgr.getApplicablePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#getApplicablePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getApplicablePaymentMethods", + "tags": [ + "getapplicablepaymentmethods", + "paymentmgr.getapplicablepaymentmethods" + ], + "title": "PaymentMgr.getApplicablePaymentMethods" + }, + { + "id": "script-api:dw/order/PaymentMgr#getPaymentCard", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentCard", + "tags": [ + "getpaymentcard", + "paymentmgr.getpaymentcard" + ], + "title": "PaymentMgr.getPaymentCard" + }, + { + "id": "script-api:dw/order/PaymentMgr#getPaymentCard", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentCard", + "tags": [ + "getpaymentcard", + "paymentmgr.getpaymentcard" + ], + "title": "PaymentMgr.getPaymentCard" + }, + { + "id": "script-api:dw/order/PaymentMgr#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentMethod", + "tags": [ + "getpaymentmethod", + "paymentmgr.getpaymentmethod" + ], + "title": "PaymentMgr.getPaymentMethod" + }, + { + "id": "script-api:dw/order/PaymentMgr#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentMethod", + "tags": [ + "getpaymentmethod", + "paymentmgr.getpaymentmethod" + ], + "title": "PaymentMgr.getPaymentMethod" + }, + { + "id": "script-api:dw/order/PaymentProcessor", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentProcessor", + "tags": [ + "paymentprocessor", + "dw.order.paymentprocessor", + "dw/order" + ], + "title": "PaymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentProcessor#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.ID", + "tags": [ + "id", + "paymentprocessor.id" + ], + "title": "PaymentProcessor.ID" + }, + { + "id": "script-api:dw/order/PaymentProcessor#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.getID", + "tags": [ + "getid", + "paymentprocessor.getid" + ], + "title": "PaymentProcessor.getID" + }, + { + "id": "script-api:dw/order/PaymentProcessor#getPreferenceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.getPreferenceValue", + "tags": [ + "getpreferencevalue", + "paymentprocessor.getpreferencevalue" + ], + "title": "PaymentProcessor.getPreferenceValue" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentStatusCodes", + "tags": [ + "paymentstatuscodes", + "dw.order.paymentstatuscodes", + "dw/order" + ], + "title": "PaymentStatusCodes" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER", + "tags": [ + "creditcard_invalid_card_number", + "paymentstatuscodes.creditcard_invalid_card_number" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER", + "tags": [ + "creditcard_invalid_card_number", + "paymentstatuscodes.creditcard_invalid_card_number" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_EXPIRATION_DATE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE", + "tags": [ + "creditcard_invalid_expiration_date", + "paymentstatuscodes.creditcard_invalid_expiration_date" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_EXPIRATION_DATE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE", + "tags": [ + "creditcard_invalid_expiration_date", + "paymentstatuscodes.creditcard_invalid_expiration_date" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_SECURITY_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE", + "tags": [ + "creditcard_invalid_security_code", + "paymentstatuscodes.creditcard_invalid_security_code" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE" + }, + { + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_SECURITY_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE", + "tags": [ + "creditcard_invalid_security_code", + "paymentstatuscodes.creditcard_invalid_security_code" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE" + }, + { + "id": "script-api:dw/order/PaymentTransaction", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentTransaction", + "tags": [ + "paymenttransaction", + "dw.order.paymenttransaction", + "dw/order" + ], + "title": "PaymentTransaction" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH", + "tags": [ + "type_auth", + "paymenttransaction.type_auth" + ], + "title": "PaymentTransaction.TYPE_AUTH" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH", + "tags": [ + "type_auth", + "paymenttransaction.type_auth" + ], + "title": "PaymentTransaction.TYPE_AUTH" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH_REVERSAL", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH_REVERSAL", + "tags": [ + "type_auth_reversal", + "paymenttransaction.type_auth_reversal" + ], + "title": "PaymentTransaction.TYPE_AUTH_REVERSAL" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH_REVERSAL", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH_REVERSAL", + "tags": [ + "type_auth_reversal", + "paymenttransaction.type_auth_reversal" + ], + "title": "PaymentTransaction.TYPE_AUTH_REVERSAL" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_CAPTURE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CAPTURE", + "tags": [ + "type_capture", + "paymenttransaction.type_capture" + ], + "title": "PaymentTransaction.TYPE_CAPTURE" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_CAPTURE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CAPTURE", + "tags": [ + "type_capture", + "paymenttransaction.type_capture" + ], + "title": "PaymentTransaction.TYPE_CAPTURE" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_CREDIT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CREDIT", + "tags": [ + "type_credit", + "paymenttransaction.type_credit" + ], + "title": "PaymentTransaction.TYPE_CREDIT" + }, + { + "id": "script-api:dw/order/PaymentTransaction#TYPE_CREDIT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CREDIT", + "tags": [ + "type_credit", + "paymenttransaction.type_credit" + ], + "title": "PaymentTransaction.TYPE_CREDIT" + }, + { + "id": "script-api:dw/order/PaymentTransaction#accountID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.accountID", + "tags": [ + "accountid", + "paymenttransaction.accountid" + ], + "title": "PaymentTransaction.accountID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#accountType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.accountType", + "tags": [ + "accounttype", + "paymenttransaction.accounttype" + ], + "title": "PaymentTransaction.accountType" + }, + { + "id": "script-api:dw/order/PaymentTransaction#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.amount", + "tags": [ + "amount", + "paymenttransaction.amount" + ], + "title": "PaymentTransaction.amount" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getAccountID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAccountID", + "tags": [ + "getaccountid", + "paymenttransaction.getaccountid" + ], + "title": "PaymentTransaction.getAccountID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getAccountType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAccountType", + "tags": [ + "getaccounttype", + "paymenttransaction.getaccounttype" + ], + "title": "PaymentTransaction.getAccountType" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAmount", + "tags": [ + "getamount", + "paymenttransaction.getamount" + ], + "title": "PaymentTransaction.getAmount" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getPaymentInstrument", + "tags": [ + "getpaymentinstrument", + "paymenttransaction.getpaymentinstrument" + ], + "title": "PaymentTransaction.getPaymentInstrument" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getPaymentProcessor", + "tags": [ + "getpaymentprocessor", + "paymenttransaction.getpaymentprocessor" + ], + "title": "PaymentTransaction.getPaymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getTransactionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getTransactionID", + "tags": [ + "gettransactionid", + "paymenttransaction.gettransactionid" + ], + "title": "PaymentTransaction.getTransactionID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getType", + "tags": [ + "gettype", + "paymenttransaction.gettype" + ], + "title": "PaymentTransaction.getType" + }, + { + "id": "script-api:dw/order/PaymentTransaction#paymentInstrument", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.paymentInstrument", + "tags": [ + "paymentinstrument", + "paymenttransaction.paymentinstrument" + ], + "title": "PaymentTransaction.paymentInstrument" + }, + { + "id": "script-api:dw/order/PaymentTransaction#paymentProcessor", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.paymentProcessor", + "tags": [ + "paymentprocessor", + "paymenttransaction.paymentprocessor" + ], + "title": "PaymentTransaction.paymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setAccountID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAccountID", + "tags": [ + "setaccountid", + "paymenttransaction.setaccountid" + ], + "title": "PaymentTransaction.setAccountID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setAccountType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAccountType", + "tags": [ + "setaccounttype", + "paymenttransaction.setaccounttype" + ], + "title": "PaymentTransaction.setAccountType" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAmount", + "tags": [ + "setamount", + "paymenttransaction.setamount" + ], + "title": "PaymentTransaction.setAmount" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setPaymentProcessor", + "tags": [ + "setpaymentprocessor", + "paymenttransaction.setpaymentprocessor" + ], + "title": "PaymentTransaction.setPaymentProcessor" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setTransactionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setTransactionID", + "tags": [ + "settransactionid", + "paymenttransaction.settransactionid" + ], + "title": "PaymentTransaction.setTransactionID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#setType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setType", + "tags": [ + "settype", + "paymenttransaction.settype" + ], + "title": "PaymentTransaction.setType" + }, + { + "id": "script-api:dw/order/PaymentTransaction#transactionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.transactionID", + "tags": [ + "transactionid", + "paymenttransaction.transactionid" + ], + "title": "PaymentTransaction.transactionID" + }, + { + "id": "script-api:dw/order/PaymentTransaction#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.type", + "tags": [ + "type", + "paymenttransaction.type" + ], + "title": "PaymentTransaction.type" + }, + { + "id": "script-api:dw/order/PriceAdjustment", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PriceAdjustment", + "tags": [ + "priceadjustment", + "dw.order.priceadjustment", + "dw/order" + ], + "title": "PriceAdjustment" + }, + { + "id": "script-api:dw/order/PriceAdjustment#ABTest", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTest", + "tags": [ + "abtest", + "priceadjustment.abtest" + ], + "title": "PriceAdjustment.ABTest" + }, + { + "id": "script-api:dw/order/PriceAdjustment#ABTestID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestID", + "tags": [ + "abtestid", + "priceadjustment.abtestid" + ], + "title": "PriceAdjustment.ABTestID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#ABTestSegment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestSegment", + "tags": [ + "abtestsegment", + "priceadjustment.abtestsegment" + ], + "title": "PriceAdjustment.ABTestSegment" + }, + { + "id": "script-api:dw/order/PriceAdjustment#ABTestSegmentID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestSegmentID", + "tags": [ + "abtestsegmentid", + "priceadjustment.abtestsegmentid" + ], + "title": "PriceAdjustment.ABTestSegmentID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#appliedDiscount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.appliedDiscount", + "tags": [ + "applieddiscount", + "priceadjustment.applieddiscount" + ], + "title": "PriceAdjustment.appliedDiscount" + }, + { + "id": "script-api:dw/order/PriceAdjustment#basedOnABTest", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnABTest", + "tags": [ + "basedonabtest", + "priceadjustment.basedonabtest" + ], + "title": "PriceAdjustment.basedOnABTest" + }, + { + "id": "script-api:dw/order/PriceAdjustment#basedOnCampaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnCampaign", + "tags": [ + "basedoncampaign", + "priceadjustment.basedoncampaign" + ], + "title": "PriceAdjustment.basedOnCampaign" + }, + { + "id": "script-api:dw/order/PriceAdjustment#basedOnCoupon", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnCoupon", + "tags": [ + "basedoncoupon", + "priceadjustment.basedoncoupon" + ], + "title": "PriceAdjustment.basedOnCoupon" + }, + { + "id": "script-api:dw/order/PriceAdjustment#campaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.campaign", + "tags": [ + "campaign", + "priceadjustment.campaign" + ], + "title": "PriceAdjustment.campaign" + }, + { + "id": "script-api:dw/order/PriceAdjustment#campaignID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.campaignID", + "tags": [ + "campaignid", + "priceadjustment.campaignid" + ], + "title": "PriceAdjustment.campaignID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#couponLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.couponLineItem", + "tags": [ + "couponlineitem", + "priceadjustment.couponlineitem" + ], + "title": "PriceAdjustment.couponLineItem" + }, + { + "id": "script-api:dw/order/PriceAdjustment#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.createdBy", + "tags": [ + "createdby", + "priceadjustment.createdby" + ], + "title": "PriceAdjustment.createdBy" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getABTest", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTest", + "tags": [ + "getabtest", + "priceadjustment.getabtest" + ], + "title": "PriceAdjustment.getABTest" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getABTestID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestID", + "tags": [ + "getabtestid", + "priceadjustment.getabtestid" + ], + "title": "PriceAdjustment.getABTestID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getABTestSegment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestSegment", + "tags": [ + "getabtestsegment", + "priceadjustment.getabtestsegment" + ], + "title": "PriceAdjustment.getABTestSegment" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getABTestSegmentID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestSegmentID", + "tags": [ + "getabtestsegmentid", + "priceadjustment.getabtestsegmentid" + ], + "title": "PriceAdjustment.getABTestSegmentID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getAppliedDiscount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getAppliedDiscount", + "tags": [ + "getapplieddiscount", + "priceadjustment.getapplieddiscount" + ], + "title": "PriceAdjustment.getAppliedDiscount" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCampaign", + "tags": [ + "getcampaign", + "priceadjustment.getcampaign" + ], + "title": "PriceAdjustment.getCampaign" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getCampaignID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCampaignID", + "tags": [ + "getcampaignid", + "priceadjustment.getcampaignid" + ], + "title": "PriceAdjustment.getCampaignID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCouponLineItem", + "tags": [ + "getcouponlineitem", + "priceadjustment.getcouponlineitem" + ], + "title": "PriceAdjustment.getCouponLineItem" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCreatedBy", + "tags": [ + "getcreatedby", + "priceadjustment.getcreatedby" + ], + "title": "PriceAdjustment.getCreatedBy" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getPromotion", + "tags": [ + "getpromotion", + "priceadjustment.getpromotion" + ], + "title": "PriceAdjustment.getPromotion" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getPromotionID", + "tags": [ + "getpromotionid", + "priceadjustment.getpromotionid" + ], + "title": "PriceAdjustment.getPromotionID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getProratedPrices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getProratedPrices", + "tags": [ + "getproratedprices", + "priceadjustment.getproratedprices" + ], + "title": "PriceAdjustment.getProratedPrices" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getQuantity", + "tags": [ + "getquantity", + "priceadjustment.getquantity" + ], + "title": "PriceAdjustment.getQuantity" + }, + { + "id": "script-api:dw/order/PriceAdjustment#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getReasonCode", + "tags": [ + "getreasoncode", + "priceadjustment.getreasoncode" + ], + "title": "PriceAdjustment.getReasonCode" + }, + { + "id": "script-api:dw/order/PriceAdjustment#isBasedOnABTest", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnABTest", + "tags": [ + "isbasedonabtest", + "priceadjustment.isbasedonabtest" + ], + "title": "PriceAdjustment.isBasedOnABTest" + }, + { + "id": "script-api:dw/order/PriceAdjustment#isBasedOnCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnCampaign", + "tags": [ + "isbasedoncampaign", + "priceadjustment.isbasedoncampaign" + ], + "title": "PriceAdjustment.isBasedOnCampaign" + }, + { + "id": "script-api:dw/order/PriceAdjustment#isBasedOnCoupon", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnCoupon", + "tags": [ + "isbasedoncoupon", + "priceadjustment.isbasedoncoupon" + ], + "title": "PriceAdjustment.isBasedOnCoupon" + }, + { + "id": "script-api:dw/order/PriceAdjustment#isCustom", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isCustom", + "tags": [ + "iscustom", + "priceadjustment.iscustom" + ], + "title": "PriceAdjustment.isCustom" + }, + { + "id": "script-api:dw/order/PriceAdjustment#isManual", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isManual", + "tags": [ + "ismanual", + "priceadjustment.ismanual" + ], + "title": "PriceAdjustment.isManual" + }, + { + "id": "script-api:dw/order/PriceAdjustment#manual", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.manual", + "tags": [ + "manual", + "priceadjustment.manual" + ], + "title": "PriceAdjustment.manual" + }, + { + "id": "script-api:dw/order/PriceAdjustment#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.promotion", + "tags": [ + "promotion", + "priceadjustment.promotion" + ], + "title": "PriceAdjustment.promotion" + }, + { + "id": "script-api:dw/order/PriceAdjustment#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.promotionID", + "tags": [ + "promotionid", + "priceadjustment.promotionid" + ], + "title": "PriceAdjustment.promotionID" + }, + { + "id": "script-api:dw/order/PriceAdjustment#proratedPrices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.proratedPrices", + "tags": [ + "proratedprices", + "priceadjustment.proratedprices" + ], + "title": "PriceAdjustment.proratedPrices" + }, + { + "id": "script-api:dw/order/PriceAdjustment#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.quantity", + "tags": [ + "quantity", + "priceadjustment.quantity" + ], + "title": "PriceAdjustment.quantity" + }, + { + "id": "script-api:dw/order/PriceAdjustment#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.reasonCode", + "tags": [ + "reasoncode", + "priceadjustment.reasoncode" + ], + "title": "PriceAdjustment.reasonCode" + }, + { + "id": "script-api:dw/order/PriceAdjustment#setManual", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.setManual", + "tags": [ + "setmanual", + "priceadjustment.setmanual" + ], + "title": "PriceAdjustment.setManual" + }, + { + "id": "script-api:dw/order/PriceAdjustment#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.setReasonCode", + "tags": [ + "setreasoncode", + "priceadjustment.setreasoncode" + ], + "title": "PriceAdjustment.setReasonCode" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes", + "tags": [ + "priceadjustmentlimittypes", + "dw.order.priceadjustmentlimittypes", + "dw/order" + ], + "title": "PriceAdjustmentLimitTypes" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ITEM", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ITEM", + "tags": [ + "type_item", + "priceadjustmentlimittypes.type_item" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ITEM" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ITEM", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ITEM", + "tags": [ + "type_item", + "priceadjustmentlimittypes.type_item" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ITEM" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ORDER", + "tags": [ + "type_order", + "priceadjustmentlimittypes.type_order" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ORDER" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ORDER", + "tags": [ + "type_order", + "priceadjustmentlimittypes.type_order" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ORDER" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_SHIPPING", + "tags": [ + "type_shipping", + "priceadjustmentlimittypes.type_shipping" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_SHIPPING" + }, + { + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_SHIPPING", + "tags": [ + "type_shipping", + "priceadjustmentlimittypes.type_shipping" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_SHIPPING" + }, + { + "id": "script-api:dw/order/ProductLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductLineItem", + "tags": [ + "productlineitem", + "dw.order.productlineitem", + "dw/order" + ], + "title": "ProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedGrossPrice", + "tags": [ + "adjustedgrossprice", + "productlineitem.adjustedgrossprice" + ], + "title": "ProductLineItem.adjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedNetPrice", + "tags": [ + "adjustednetprice", + "productlineitem.adjustednetprice" + ], + "title": "ProductLineItem.adjustedNetPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedPrice", + "tags": [ + "adjustedprice", + "productlineitem.adjustedprice" + ], + "title": "ProductLineItem.adjustedPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedTax", + "tags": [ + "adjustedtax", + "productlineitem.adjustedtax" + ], + "title": "ProductLineItem.adjustedTax" + }, + { + "id": "script-api:dw/order/ProductLineItem#bonusDiscountLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bonusDiscountLineItem", + "tags": [ + "bonusdiscountlineitem", + "productlineitem.bonusdiscountlineitem" + ], + "title": "ProductLineItem.bonusDiscountLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#bonusProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bonusProductLineItem", + "tags": [ + "bonusproductlineitem", + "productlineitem.bonusproductlineitem" + ], + "title": "ProductLineItem.bonusProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#bundledProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bundledProductLineItem", + "tags": [ + "bundledproductlineitem", + "productlineitem.bundledproductlineitem" + ], + "title": "ProductLineItem.bundledProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#bundledProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bundledProductLineItems", + "tags": [ + "bundledproductlineitems", + "productlineitem.bundledproductlineitems" + ], + "title": "ProductLineItem.bundledProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#catalogProduct", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.catalogProduct", + "tags": [ + "catalogproduct", + "productlineitem.catalogproduct" + ], + "title": "ProductLineItem.catalogProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#category", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.category", + "tags": [ + "category", + "productlineitem.category" + ], + "title": "ProductLineItem.category" + }, + { + "id": "script-api:dw/order/ProductLineItem#categoryID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.categoryID", + "tags": [ + "categoryid", + "productlineitem.categoryid" + ], + "title": "ProductLineItem.categoryID" + }, + { + "id": "script-api:dw/order/ProductLineItem#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createPriceAdjustment", + "tags": [ + "createpriceadjustment", + "productlineitem.createpriceadjustment" + ], + "title": "ProductLineItem.createPriceAdjustment" + }, + { + "id": "script-api:dw/order/ProductLineItem#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createPriceAdjustment", + "tags": [ + "createpriceadjustment", + "productlineitem.createpriceadjustment" + ], + "title": "ProductLineItem.createPriceAdjustment" + }, + { + "id": "script-api:dw/order/ProductLineItem#createShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createShippingLineItem", + "tags": [ + "createshippinglineitem", + "productlineitem.createshippinglineitem" + ], + "title": "ProductLineItem.createShippingLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#externalLineItemStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.externalLineItemStatus", + "tags": [ + "externallineitemstatus", + "productlineitem.externallineitemstatus" + ], + "title": "ProductLineItem.externalLineItemStatus" + }, + { + "id": "script-api:dw/order/ProductLineItem#externalLineItemText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.externalLineItemText", + "tags": [ + "externallineitemtext", + "productlineitem.externallineitemtext" + ], + "title": "ProductLineItem.externalLineItemText" + }, + { + "id": "script-api:dw/order/ProductLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedGrossPrice", + "tags": [ + "getadjustedgrossprice", + "productlineitem.getadjustedgrossprice" + ], + "title": "ProductLineItem.getAdjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedNetPrice", + "tags": [ + "getadjustednetprice", + "productlineitem.getadjustednetprice" + ], + "title": "ProductLineItem.getAdjustedNetPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedPrice", + "tags": [ + "getadjustedprice", + "productlineitem.getadjustedprice" + ], + "title": "ProductLineItem.getAdjustedPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedPrice", + "tags": [ + "getadjustedprice", + "productlineitem.getadjustedprice" + ], + "title": "ProductLineItem.getAdjustedPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedTax", + "tags": [ + "getadjustedtax", + "productlineitem.getadjustedtax" + ], + "title": "ProductLineItem.getAdjustedTax" + }, + { + "id": "script-api:dw/order/ProductLineItem#getBonusDiscountLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getBonusDiscountLineItem", + "tags": [ + "getbonusdiscountlineitem", + "productlineitem.getbonusdiscountlineitem" + ], + "title": "ProductLineItem.getBonusDiscountLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#getBundledProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getBundledProductLineItems", + "tags": [ + "getbundledproductlineitems", + "productlineitem.getbundledproductlineitems" + ], + "title": "ProductLineItem.getBundledProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#getCategory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getCategory", + "tags": [ + "getcategory", + "productlineitem.getcategory" + ], + "title": "ProductLineItem.getCategory" + }, + { + "id": "script-api:dw/order/ProductLineItem#getCategoryID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getCategoryID", + "tags": [ + "getcategoryid", + "productlineitem.getcategoryid" + ], + "title": "ProductLineItem.getCategoryID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getExternalLineItemStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getExternalLineItemStatus", + "tags": [ + "getexternallineitemstatus", + "productlineitem.getexternallineitemstatus" + ], + "title": "ProductLineItem.getExternalLineItemStatus" + }, + { + "id": "script-api:dw/order/ProductLineItem#getExternalLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getExternalLineItemText", + "tags": [ + "getexternallineitemtext", + "productlineitem.getexternallineitemtext" + ], + "title": "ProductLineItem.getExternalLineItemText" + }, + { + "id": "script-api:dw/order/ProductLineItem#getGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getGiftMessage", + "tags": [ + "getgiftmessage", + "productlineitem.getgiftmessage" + ], + "title": "ProductLineItem.getGiftMessage" + }, + { + "id": "script-api:dw/order/ProductLineItem#getManufacturerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getManufacturerName", + "tags": [ + "getmanufacturername", + "productlineitem.getmanufacturername" + ], + "title": "ProductLineItem.getManufacturerName" + }, + { + "id": "script-api:dw/order/ProductLineItem#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getManufacturerSKU", + "tags": [ + "getmanufacturersku", + "productlineitem.getmanufacturersku" + ], + "title": "ProductLineItem.getManufacturerSKU" + }, + { + "id": "script-api:dw/order/ProductLineItem#getMinOrderQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getMinOrderQuantity", + "tags": [ + "getminorderquantity", + "productlineitem.getminorderquantity" + ], + "title": "ProductLineItem.getMinOrderQuantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#getMinOrderQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getMinOrderQuantityValue", + "tags": [ + "getminorderquantityvalue", + "productlineitem.getminorderquantityvalue" + ], + "title": "ProductLineItem.getMinOrderQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#getOptionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionID", + "tags": [ + "getoptionid", + "productlineitem.getoptionid" + ], + "title": "ProductLineItem.getOptionID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getOptionModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionModel", + "tags": [ + "getoptionmodel", + "productlineitem.getoptionmodel" + ], + "title": "ProductLineItem.getOptionModel" + }, + { + "id": "script-api:dw/order/ProductLineItem#getOptionProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionProductLineItems", + "tags": [ + "getoptionproductlineitems", + "productlineitem.getoptionproductlineitems" + ], + "title": "ProductLineItem.getOptionProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#getOptionValueID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionValueID", + "tags": [ + "getoptionvalueid", + "productlineitem.getoptionvalueid" + ], + "title": "ProductLineItem.getOptionValueID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOrderItem", + "tags": [ + "getorderitem", + "productlineitem.getorderitem" + ], + "title": "ProductLineItem.getOrderItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#getParent", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getParent", + "tags": [ + "getparent", + "productlineitem.getparent" + ], + "title": "ProductLineItem.getParent" + }, + { + "id": "script-api:dw/order/ProductLineItem#getPosition", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPosition", + "tags": [ + "getposition", + "productlineitem.getposition" + ], + "title": "ProductLineItem.getPosition" + }, + { + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentByPromotionID", + "tags": [ + "getpriceadjustmentbypromotionid", + "productlineitem.getpriceadjustmentbypromotionid" + ], + "title": "ProductLineItem.getPriceAdjustmentByPromotionID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentByPromotionIDAndCouponCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentByPromotionIDAndCouponCode", + "tags": [ + "getpriceadjustmentbypromotionidandcouponcode", + "productlineitem.getpriceadjustmentbypromotionidandcouponcode" + ], + "title": "ProductLineItem.getPriceAdjustmentByPromotionIDAndCouponCode" + }, + { + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustments", + "tags": [ + "getpriceadjustments", + "productlineitem.getpriceadjustments" + ], + "title": "ProductLineItem.getPriceAdjustments" + }, + { + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentsByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentsByPromotionID", + "tags": [ + "getpriceadjustmentsbypromotionid", + "productlineitem.getpriceadjustmentsbypromotionid" + ], + "title": "ProductLineItem.getPriceAdjustmentsByPromotionID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProduct", + "tags": [ + "getproduct", + "productlineitem.getproduct" + ], + "title": "ProductLineItem.getProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProductID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductID", + "tags": [ + "getproductid", + "productlineitem.getproductid" + ], + "title": "ProductLineItem.getProductID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProductInventoryList", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductInventoryList", + "tags": [ + "getproductinventorylist", + "productlineitem.getproductinventorylist" + ], + "title": "ProductLineItem.getProductInventoryList" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProductInventoryListID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductInventoryListID", + "tags": [ + "getproductinventorylistid", + "productlineitem.getproductinventorylistid" + ], + "title": "ProductLineItem.getProductInventoryListID" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProductListItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductListItem", + "tags": [ + "getproductlistitem", + "productlineitem.getproductlistitem" + ], + "title": "ProductLineItem.getProductListItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProductName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductName", + "tags": [ + "getproductname", + "productlineitem.getproductname" + ], + "title": "ProductLineItem.getProductName" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProratedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProratedPrice", + "tags": [ + "getproratedprice", + "productlineitem.getproratedprice" + ], + "title": "ProductLineItem.getProratedPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#getProratedPriceAdjustmentPrices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProratedPriceAdjustmentPrices", + "tags": [ + "getproratedpriceadjustmentprices", + "productlineitem.getproratedpriceadjustmentprices" + ], + "title": "ProductLineItem.getProratedPriceAdjustmentPrices" + }, + { + "id": "script-api:dw/order/ProductLineItem#getQualifyingProductLineItemForBonusProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQualifyingProductLineItemForBonusProduct", + "tags": [ + "getqualifyingproductlineitemforbonusproduct", + "productlineitem.getqualifyingproductlineitemforbonusproduct" + ], + "title": "ProductLineItem.getQualifyingProductLineItemForBonusProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQuantity", + "tags": [ + "getquantity", + "productlineitem.getquantity" + ], + "title": "ProductLineItem.getQuantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#getQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQuantityValue", + "tags": [ + "getquantityvalue", + "productlineitem.getquantityvalue" + ], + "title": "ProductLineItem.getQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#getRelatedBonusProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getRelatedBonusProductLineItems", + "tags": [ + "getrelatedbonusproductlineitems", + "productlineitem.getrelatedbonusproductlineitems" + ], + "title": "ProductLineItem.getRelatedBonusProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getShipment", + "tags": [ + "getshipment", + "productlineitem.getshipment" + ], + "title": "ProductLineItem.getShipment" + }, + { + "id": "script-api:dw/order/ProductLineItem#getShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getShippingLineItem", + "tags": [ + "getshippinglineitem", + "productlineitem.getshippinglineitem" + ], + "title": "ProductLineItem.getShippingLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#getStepQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getStepQuantity", + "tags": [ + "getstepquantity", + "productlineitem.getstepquantity" + ], + "title": "ProductLineItem.getStepQuantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#getStepQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getStepQuantityValue", + "tags": [ + "getstepquantityvalue", + "productlineitem.getstepquantityvalue" + ], + "title": "ProductLineItem.getStepQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#gift", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.gift", + "tags": [ + "gift", + "productlineitem.gift" + ], + "title": "ProductLineItem.gift" + }, + { + "id": "script-api:dw/order/ProductLineItem#giftMessage", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.giftMessage", + "tags": [ + "giftmessage", + "productlineitem.giftmessage" + ], + "title": "ProductLineItem.giftMessage" + }, + { + "id": "script-api:dw/order/ProductLineItem#isBonusProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isBonusProductLineItem", + "tags": [ + "isbonusproductlineitem", + "productlineitem.isbonusproductlineitem" + ], + "title": "ProductLineItem.isBonusProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#isBundledProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isBundledProductLineItem", + "tags": [ + "isbundledproductlineitem", + "productlineitem.isbundledproductlineitem" + ], + "title": "ProductLineItem.isBundledProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#isCatalogProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isCatalogProduct", + "tags": [ + "iscatalogproduct", + "productlineitem.iscatalogproduct" + ], + "title": "ProductLineItem.isCatalogProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#isGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isGift", + "tags": [ + "isgift", + "productlineitem.isgift" + ], + "title": "ProductLineItem.isGift" + }, + { + "id": "script-api:dw/order/ProductLineItem#isOptionProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isOptionProductLineItem", + "tags": [ + "isoptionproductlineitem", + "productlineitem.isoptionproductlineitem" + ], + "title": "ProductLineItem.isOptionProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#isReserved", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isReserved", + "tags": [ + "isreserved", + "productlineitem.isreserved" + ], + "title": "ProductLineItem.isReserved" + }, + { + "id": "script-api:dw/order/ProductLineItem#manufacturerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.manufacturerName", + "tags": [ + "manufacturername", + "productlineitem.manufacturername" + ], + "title": "ProductLineItem.manufacturerName" + }, + { + "id": "script-api:dw/order/ProductLineItem#manufacturerSKU", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.manufacturerSKU", + "tags": [ + "manufacturersku", + "productlineitem.manufacturersku" + ], + "title": "ProductLineItem.manufacturerSKU" + }, + { + "id": "script-api:dw/order/ProductLineItem#minOrderQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.minOrderQuantity", + "tags": [ + "minorderquantity", + "productlineitem.minorderquantity" + ], + "title": "ProductLineItem.minOrderQuantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#minOrderQuantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.minOrderQuantityValue", + "tags": [ + "minorderquantityvalue", + "productlineitem.minorderquantityvalue" + ], + "title": "ProductLineItem.minOrderQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#optionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionID", + "tags": [ + "optionid", + "productlineitem.optionid" + ], + "title": "ProductLineItem.optionID" + }, + { + "id": "script-api:dw/order/ProductLineItem#optionModel", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionModel", + "tags": [ + "optionmodel", + "productlineitem.optionmodel" + ], + "title": "ProductLineItem.optionModel" + }, + { + "id": "script-api:dw/order/ProductLineItem#optionProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionProductLineItem", + "tags": [ + "optionproductlineitem", + "productlineitem.optionproductlineitem" + ], + "title": "ProductLineItem.optionProductLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#optionProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionProductLineItems", + "tags": [ + "optionproductlineitems", + "productlineitem.optionproductlineitems" + ], + "title": "ProductLineItem.optionProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#optionValueID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionValueID", + "tags": [ + "optionvalueid", + "productlineitem.optionvalueid" + ], + "title": "ProductLineItem.optionValueID" + }, + { + "id": "script-api:dw/order/ProductLineItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.orderItem", + "tags": [ + "orderitem", + "productlineitem.orderitem" + ], + "title": "ProductLineItem.orderItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#parent", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.parent", + "tags": [ + "parent", + "productlineitem.parent" + ], + "title": "ProductLineItem.parent" + }, + { + "id": "script-api:dw/order/ProductLineItem#position", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.position", + "tags": [ + "position", + "productlineitem.position" + ], + "title": "ProductLineItem.position" + }, + { + "id": "script-api:dw/order/ProductLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.priceAdjustments", + "tags": [ + "priceadjustments", + "productlineitem.priceadjustments" + ], + "title": "ProductLineItem.priceAdjustments" + }, + { + "id": "script-api:dw/order/ProductLineItem#product", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.product", + "tags": [ + "product", + "productlineitem.product" + ], + "title": "ProductLineItem.product" + }, + { + "id": "script-api:dw/order/ProductLineItem#productID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productID", + "tags": [ + "productid", + "productlineitem.productid" + ], + "title": "ProductLineItem.productID" + }, + { + "id": "script-api:dw/order/ProductLineItem#productInventoryList", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productInventoryList", + "tags": [ + "productinventorylist", + "productlineitem.productinventorylist" + ], + "title": "ProductLineItem.productInventoryList" + }, + { + "id": "script-api:dw/order/ProductLineItem#productInventoryListID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productInventoryListID", + "tags": [ + "productinventorylistid", + "productlineitem.productinventorylistid" + ], + "title": "ProductLineItem.productInventoryListID" + }, + { + "id": "script-api:dw/order/ProductLineItem#productListItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productListItem", + "tags": [ + "productlistitem", + "productlineitem.productlistitem" + ], + "title": "ProductLineItem.productListItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#productName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productName", + "tags": [ + "productname", + "productlineitem.productname" + ], + "title": "ProductLineItem.productName" + }, + { + "id": "script-api:dw/order/ProductLineItem#proratedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.proratedPrice", + "tags": [ + "proratedprice", + "productlineitem.proratedprice" + ], + "title": "ProductLineItem.proratedPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#proratedPriceAdjustmentPrices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.proratedPriceAdjustmentPrices", + "tags": [ + "proratedpriceadjustmentprices", + "productlineitem.proratedpriceadjustmentprices" + ], + "title": "ProductLineItem.proratedPriceAdjustmentPrices" + }, + { + "id": "script-api:dw/order/ProductLineItem#qualifyingProductLineItemForBonusProduct", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.qualifyingProductLineItemForBonusProduct", + "tags": [ + "qualifyingproductlineitemforbonusproduct", + "productlineitem.qualifyingproductlineitemforbonusproduct" + ], + "title": "ProductLineItem.qualifyingProductLineItemForBonusProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.quantity", + "tags": [ + "quantity", + "productlineitem.quantity" + ], + "title": "ProductLineItem.quantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#quantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.quantityValue", + "tags": [ + "quantityvalue", + "productlineitem.quantityvalue" + ], + "title": "ProductLineItem.quantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#relatedBonusProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.relatedBonusProductLineItems", + "tags": [ + "relatedbonusproductlineitems", + "productlineitem.relatedbonusproductlineitems" + ], + "title": "ProductLineItem.relatedBonusProductLineItems" + }, + { + "id": "script-api:dw/order/ProductLineItem#removePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.removePriceAdjustment", + "tags": [ + "removepriceadjustment", + "productlineitem.removepriceadjustment" + ], + "title": "ProductLineItem.removePriceAdjustment" + }, + { + "id": "script-api:dw/order/ProductLineItem#removeShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.removeShippingLineItem", + "tags": [ + "removeshippinglineitem", + "productlineitem.removeshippinglineitem" + ], + "title": "ProductLineItem.removeShippingLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#replaceProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.replaceProduct", + "tags": [ + "replaceproduct", + "productlineitem.replaceproduct" + ], + "title": "ProductLineItem.replaceProduct" + }, + { + "id": "script-api:dw/order/ProductLineItem#reserved", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.reserved", + "tags": [ + "reserved", + "productlineitem.reserved" + ], + "title": "ProductLineItem.reserved" + }, + { + "id": "script-api:dw/order/ProductLineItem#setCategory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setCategory", + "tags": [ + "setcategory", + "productlineitem.setcategory" + ], + "title": "ProductLineItem.setCategory" + }, + { + "id": "script-api:dw/order/ProductLineItem#setCategoryID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setCategoryID", + "tags": [ + "setcategoryid", + "productlineitem.setcategoryid" + ], + "title": "ProductLineItem.setCategoryID" + }, + { + "id": "script-api:dw/order/ProductLineItem#setExternalLineItemStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setExternalLineItemStatus", + "tags": [ + "setexternallineitemstatus", + "productlineitem.setexternallineitemstatus" + ], + "title": "ProductLineItem.setExternalLineItemStatus" + }, + { + "id": "script-api:dw/order/ProductLineItem#setExternalLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setExternalLineItemText", + "tags": [ + "setexternallineitemtext", + "productlineitem.setexternallineitemtext" + ], + "title": "ProductLineItem.setExternalLineItemText" + }, + { + "id": "script-api:dw/order/ProductLineItem#setGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setGift", + "tags": [ + "setgift", + "productlineitem.setgift" + ], + "title": "ProductLineItem.setGift" + }, + { + "id": "script-api:dw/order/ProductLineItem#setGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setGiftMessage", + "tags": [ + "setgiftmessage", + "productlineitem.setgiftmessage" + ], + "title": "ProductLineItem.setGiftMessage" + }, + { + "id": "script-api:dw/order/ProductLineItem#setManufacturerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setManufacturerName", + "tags": [ + "setmanufacturername", + "productlineitem.setmanufacturername" + ], + "title": "ProductLineItem.setManufacturerName" + }, + { + "id": "script-api:dw/order/ProductLineItem#setManufacturerSKU", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setManufacturerSKU", + "tags": [ + "setmanufacturersku", + "productlineitem.setmanufacturersku" + ], + "title": "ProductLineItem.setManufacturerSKU" + }, + { + "id": "script-api:dw/order/ProductLineItem#setMinOrderQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setMinOrderQuantityValue", + "tags": [ + "setminorderquantityvalue", + "productlineitem.setminorderquantityvalue" + ], + "title": "ProductLineItem.setMinOrderQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#setPosition", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setPosition", + "tags": [ + "setposition", + "productlineitem.setposition" + ], + "title": "ProductLineItem.setPosition" + }, + { + "id": "script-api:dw/order/ProductLineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setPriceValue", + "tags": [ + "setpricevalue", + "productlineitem.setpricevalue" + ], + "title": "ProductLineItem.setPriceValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#setProductInventoryList", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductInventoryList", + "tags": [ + "setproductinventorylist", + "productlineitem.setproductinventorylist" + ], + "title": "ProductLineItem.setProductInventoryList" + }, + { + "id": "script-api:dw/order/ProductLineItem#setProductInventoryListID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductInventoryListID", + "tags": [ + "setproductinventorylistid", + "productlineitem.setproductinventorylistid" + ], + "title": "ProductLineItem.setProductInventoryListID" + }, + { + "id": "script-api:dw/order/ProductLineItem#setProductName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductName", + "tags": [ + "setproductname", + "productlineitem.setproductname" + ], + "title": "ProductLineItem.setProductName" + }, + { + "id": "script-api:dw/order/ProductLineItem#setQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setQuantityValue", + "tags": [ + "setquantityvalue", + "productlineitem.setquantityvalue" + ], + "title": "ProductLineItem.setQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#setShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setShipment", + "tags": [ + "setshipment", + "productlineitem.setshipment" + ], + "title": "ProductLineItem.setShipment" + }, + { + "id": "script-api:dw/order/ProductLineItem#setStepQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setStepQuantityValue", + "tags": [ + "setstepquantityvalue", + "productlineitem.setstepquantityvalue" + ], + "title": "ProductLineItem.setStepQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.shipment", + "tags": [ + "shipment", + "productlineitem.shipment" + ], + "title": "ProductLineItem.shipment" + }, + { + "id": "script-api:dw/order/ProductLineItem#shippingLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.shippingLineItem", + "tags": [ + "shippinglineitem", + "productlineitem.shippinglineitem" + ], + "title": "ProductLineItem.shippingLineItem" + }, + { + "id": "script-api:dw/order/ProductLineItem#stepQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.stepQuantity", + "tags": [ + "stepquantity", + "productlineitem.stepquantity" + ], + "title": "ProductLineItem.stepQuantity" + }, + { + "id": "script-api:dw/order/ProductLineItem#stepQuantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.stepQuantityValue", + "tags": [ + "stepquantityvalue", + "productlineitem.stepquantityvalue" + ], + "title": "ProductLineItem.stepQuantityValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#updateOptionPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateOptionPrice", + "tags": [ + "updateoptionprice", + "productlineitem.updateoptionprice" + ], + "title": "ProductLineItem.updateOptionPrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#updateOptionValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateOptionValue", + "tags": [ + "updateoptionvalue", + "productlineitem.updateoptionvalue" + ], + "title": "ProductLineItem.updateOptionValue" + }, + { + "id": "script-api:dw/order/ProductLineItem#updatePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updatePrice", + "tags": [ + "updateprice", + "productlineitem.updateprice" + ], + "title": "ProductLineItem.updatePrice" + }, + { + "id": "script-api:dw/order/ProductLineItem#updateQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateQuantity", + "tags": [ + "updatequantity", + "productlineitem.updatequantity" + ], + "title": "ProductLineItem.updateQuantity" + }, + { + "id": "script-api:dw/order/ProductShippingCost", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingCost", + "tags": [ + "productshippingcost", + "dw.order.productshippingcost", + "dw/order" + ], + "title": "ProductShippingCost" + }, + { + "id": "script-api:dw/order/ProductShippingCost#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.amount", + "tags": [ + "amount", + "productshippingcost.amount" + ], + "title": "ProductShippingCost.amount" + }, + { + "id": "script-api:dw/order/ProductShippingCost#fixedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.fixedPrice", + "tags": [ + "fixedprice", + "productshippingcost.fixedprice" + ], + "title": "ProductShippingCost.fixedPrice" + }, + { + "id": "script-api:dw/order/ProductShippingCost#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.getAmount", + "tags": [ + "getamount", + "productshippingcost.getamount" + ], + "title": "ProductShippingCost.getAmount" + }, + { + "id": "script-api:dw/order/ProductShippingCost#isFixedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.isFixedPrice", + "tags": [ + "isfixedprice", + "productshippingcost.isfixedprice" + ], + "title": "ProductShippingCost.isFixedPrice" + }, + { + "id": "script-api:dw/order/ProductShippingCost#isSurcharge", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.isSurcharge", + "tags": [ + "issurcharge", + "productshippingcost.issurcharge" + ], + "title": "ProductShippingCost.isSurcharge" + }, + { + "id": "script-api:dw/order/ProductShippingCost#surcharge", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.surcharge", + "tags": [ + "surcharge", + "productshippingcost.surcharge" + ], + "title": "ProductShippingCost.surcharge" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingLineItem", + "tags": [ + "productshippinglineitem", + "dw.order.productshippinglineitem", + "dw/order" + ], + "title": "ProductShippingLineItem" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#PRODUCT_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.PRODUCT_SHIPPING_ID", + "tags": [ + "product_shipping_id", + "productshippinglineitem.product_shipping_id" + ], + "title": "ProductShippingLineItem.PRODUCT_SHIPPING_ID" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#PRODUCT_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.PRODUCT_SHIPPING_ID", + "tags": [ + "product_shipping_id", + "productshippinglineitem.product_shipping_id" + ], + "title": "ProductShippingLineItem.PRODUCT_SHIPPING_ID" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedGrossPrice", + "tags": [ + "adjustedgrossprice", + "productshippinglineitem.adjustedgrossprice" + ], + "title": "ProductShippingLineItem.adjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedNetPrice", + "tags": [ + "adjustednetprice", + "productshippinglineitem.adjustednetprice" + ], + "title": "ProductShippingLineItem.adjustedNetPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedPrice", + "tags": [ + "adjustedprice", + "productshippinglineitem.adjustedprice" + ], + "title": "ProductShippingLineItem.adjustedPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedTax", + "tags": [ + "adjustedtax", + "productshippinglineitem.adjustedtax" + ], + "title": "ProductShippingLineItem.adjustedTax" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedGrossPrice", + "tags": [ + "getadjustedgrossprice", + "productshippinglineitem.getadjustedgrossprice" + ], + "title": "ProductShippingLineItem.getAdjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedNetPrice", + "tags": [ + "getadjustednetprice", + "productshippinglineitem.getadjustednetprice" + ], + "title": "ProductShippingLineItem.getAdjustedNetPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedPrice", + "tags": [ + "getadjustedprice", + "productshippinglineitem.getadjustedprice" + ], + "title": "ProductShippingLineItem.getAdjustedPrice" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedTax", + "tags": [ + "getadjustedtax", + "productshippinglineitem.getadjustedtax" + ], + "title": "ProductShippingLineItem.getAdjustedTax" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getPriceAdjustments", + "tags": [ + "getpriceadjustments", + "productshippinglineitem.getpriceadjustments" + ], + "title": "ProductShippingLineItem.getPriceAdjustments" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getProductLineItem", + "tags": [ + "getproductlineitem", + "productshippinglineitem.getproductlineitem" + ], + "title": "ProductShippingLineItem.getProductLineItem" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getQuantity", + "tags": [ + "getquantity", + "productshippinglineitem.getquantity" + ], + "title": "ProductShippingLineItem.getQuantity" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getShipment", + "tags": [ + "getshipment", + "productshippinglineitem.getshipment" + ], + "title": "ProductShippingLineItem.getShipment" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#isSurcharge", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.isSurcharge", + "tags": [ + "issurcharge", + "productshippinglineitem.issurcharge" + ], + "title": "ProductShippingLineItem.isSurcharge" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.priceAdjustments", + "tags": [ + "priceadjustments", + "productshippinglineitem.priceadjustments" + ], + "title": "ProductShippingLineItem.priceAdjustments" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#productLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.productLineItem", + "tags": [ + "productlineitem", + "productshippinglineitem.productlineitem" + ], + "title": "ProductShippingLineItem.productLineItem" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.quantity", + "tags": [ + "quantity", + "productshippinglineitem.quantity" + ], + "title": "ProductShippingLineItem.quantity" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setPriceValue", + "tags": [ + "setpricevalue", + "productshippinglineitem.setpricevalue" + ], + "title": "ProductShippingLineItem.setPriceValue" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#setQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setQuantity", + "tags": [ + "setquantity", + "productshippinglineitem.setquantity" + ], + "title": "ProductShippingLineItem.setQuantity" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#setSurcharge", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setSurcharge", + "tags": [ + "setsurcharge", + "productshippinglineitem.setsurcharge" + ], + "title": "ProductShippingLineItem.setSurcharge" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.shipment", + "tags": [ + "shipment", + "productshippinglineitem.shipment" + ], + "title": "ProductShippingLineItem.shipment" + }, + { + "id": "script-api:dw/order/ProductShippingLineItem#surcharge", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.surcharge", + "tags": [ + "surcharge", + "productshippinglineitem.surcharge" + ], + "title": "ProductShippingLineItem.surcharge" + }, + { + "id": "script-api:dw/order/ProductShippingModel", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingModel", + "tags": [ + "productshippingmodel", + "dw.order.productshippingmodel", + "dw/order" + ], + "title": "ProductShippingModel" + }, + { + "id": "script-api:dw/order/ProductShippingModel#applicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.applicableShippingMethods", + "tags": [ + "applicableshippingmethods", + "productshippingmodel.applicableshippingmethods" + ], + "title": "ProductShippingModel.applicableShippingMethods" + }, + { + "id": "script-api:dw/order/ProductShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getApplicableShippingMethods", + "tags": [ + "getapplicableshippingmethods", + "productshippingmodel.getapplicableshippingmethods" + ], + "title": "ProductShippingModel.getApplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ProductShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getInapplicableShippingMethods", + "tags": [ + "getinapplicableshippingmethods", + "productshippingmodel.getinapplicableshippingmethods" + ], + "title": "ProductShippingModel.getInapplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ProductShippingModel#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getShippingCost", + "tags": [ + "getshippingcost", + "productshippingmodel.getshippingcost" + ], + "title": "ProductShippingModel.getShippingCost" + }, + { + "id": "script-api:dw/order/ProductShippingModel#getShippingMethodsWithShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getShippingMethodsWithShippingCost", + "tags": [ + "getshippingmethodswithshippingcost", + "productshippingmodel.getshippingmethodswithshippingcost" + ], + "title": "ProductShippingModel.getShippingMethodsWithShippingCost" + }, + { + "id": "script-api:dw/order/ProductShippingModel#inapplicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.inapplicableShippingMethods", + "tags": [ + "inapplicableshippingmethods", + "productshippingmodel.inapplicableshippingmethods" + ], + "title": "ProductShippingModel.inapplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ProductShippingModel#shippingMethodsWithShippingCost", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.shippingMethodsWithShippingCost", + "tags": [ + "shippingmethodswithshippingcost", + "productshippingmodel.shippingmethodswithshippingcost" + ], + "title": "ProductShippingModel.shippingMethodsWithShippingCost" + }, + { + "id": "script-api:dw/order/Return", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Return", + "tags": [ + "return", + "dw.order.return", + "dw/order" + ], + "title": "Return" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "return.orderby_itemid" + ], + "title": "Return.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "return.orderby_itemid" + ], + "title": "Return.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "return.orderby_itemposition" + ], + "title": "Return.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "return.orderby_itemposition" + ], + "title": "Return.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "return.orderby_unsorted" + ], + "title": "Return.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Return#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "return.orderby_unsorted" + ], + "title": "Return.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/Return#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "return.qualifier_productitems" + ], + "title": "Return.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Return#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "return.qualifier_productitems" + ], + "title": "Return.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/Return#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "return.qualifier_serviceitems" + ], + "title": "Return.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Return#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "return.qualifier_serviceitems" + ], + "title": "Return.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/Return#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_COMPLETED", + "tags": [ + "status_completed", + "return.status_completed" + ], + "title": "Return.STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Return#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_COMPLETED", + "tags": [ + "status_completed", + "return.status_completed" + ], + "title": "Return.STATUS_COMPLETED" + }, + { + "id": "script-api:dw/order/Return#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_NEW", + "tags": [ + "status_new", + "return.status_new" + ], + "title": "Return.STATUS_NEW" + }, + { + "id": "script-api:dw/order/Return#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_NEW", + "tags": [ + "status_new", + "return.status_new" + ], + "title": "Return.STATUS_NEW" + }, + { + "id": "script-api:dw/order/Return#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createInvoice", + "tags": [ + "createinvoice", + "return.createinvoice" + ], + "title": "Return.createInvoice" + }, + { + "id": "script-api:dw/order/Return#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createInvoice", + "tags": [ + "createinvoice", + "return.createinvoice" + ], + "title": "Return.createInvoice" + }, + { + "id": "script-api:dw/order/Return#createItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createItem", + "tags": [ + "createitem", + "return.createitem" + ], + "title": "Return.createItem" + }, + { + "id": "script-api:dw/order/Return#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getInvoice", + "tags": [ + "getinvoice", + "return.getinvoice" + ], + "title": "Return.getInvoice" + }, + { + "id": "script-api:dw/order/Return#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "return.getinvoicenumber" + ], + "title": "Return.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/Return#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getNote", + "tags": [ + "getnote", + "return.getnote" + ], + "title": "Return.getNote" + }, + { + "id": "script-api:dw/order/Return#getReturnCase", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getReturnCase", + "tags": [ + "getreturncase", + "return.getreturncase" + ], + "title": "Return.getReturnCase" + }, + { + "id": "script-api:dw/order/Return#getReturnNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getReturnNumber", + "tags": [ + "getreturnnumber", + "return.getreturnnumber" + ], + "title": "Return.getReturnNumber" + }, + { + "id": "script-api:dw/order/Return#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getStatus", + "tags": [ + "getstatus", + "return.getstatus" + ], + "title": "Return.getStatus" + }, + { + "id": "script-api:dw/order/Return#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.invoice", + "tags": [ + "invoice", + "return.invoice" + ], + "title": "Return.invoice" + }, + { + "id": "script-api:dw/order/Return#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.invoiceNumber", + "tags": [ + "invoicenumber", + "return.invoicenumber" + ], + "title": "Return.invoiceNumber" + }, + { + "id": "script-api:dw/order/Return#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.note", + "tags": [ + "note", + "return.note" + ], + "title": "Return.note" + }, + { + "id": "script-api:dw/order/Return#returnCase", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.returnCase", + "tags": [ + "returncase", + "return.returncase" + ], + "title": "Return.returnCase" + }, + { + "id": "script-api:dw/order/Return#returnNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.returnNumber", + "tags": [ + "returnnumber", + "return.returnnumber" + ], + "title": "Return.returnNumber" + }, + { + "id": "script-api:dw/order/Return#setNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.setNote", + "tags": [ + "setnote", + "return.setnote" + ], + "title": "Return.setNote" + }, + { + "id": "script-api:dw/order/Return#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.setStatus", + "tags": [ + "setstatus", + "return.setstatus" + ], + "title": "Return.setStatus" + }, + { + "id": "script-api:dw/order/Return#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.status", + "tags": [ + "status", + "return.status" + ], + "title": "Return.status" + }, + { + "id": "script-api:dw/order/ReturnCase", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnCase", + "tags": [ + "returncase", + "dw.order.returncase", + "dw/order" + ], + "title": "ReturnCase" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "returncase.orderby_itemid" + ], + "title": "ReturnCase.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "returncase.orderby_itemid" + ], + "title": "ReturnCase.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "returncase.orderby_itemposition" + ], + "title": "ReturnCase.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "returncase.orderby_itemposition" + ], + "title": "ReturnCase.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "returncase.orderby_unsorted" + ], + "title": "ReturnCase.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/ReturnCase#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "returncase.orderby_unsorted" + ], + "title": "ReturnCase.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/ReturnCase#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "returncase.qualifier_productitems" + ], + "title": "ReturnCase.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/ReturnCase#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "returncase.qualifier_productitems" + ], + "title": "ReturnCase.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/ReturnCase#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "returncase.qualifier_serviceitems" + ], + "title": "ReturnCase.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/ReturnCase#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "returncase.qualifier_serviceitems" + ], + "title": "ReturnCase.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/ReturnCase#RMA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.RMA", + "tags": [ + "rma", + "returncase.rma" + ], + "title": "ReturnCase.RMA" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "returncase.status_cancelled" + ], + "title": "ReturnCase.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "returncase.status_cancelled" + ], + "title": "ReturnCase.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "returncase.status_confirmed" + ], + "title": "ReturnCase.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "returncase.status_confirmed" + ], + "title": "ReturnCase.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_NEW", + "tags": [ + "status_new", + "returncase.status_new" + ], + "title": "ReturnCase.STATUS_NEW" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_NEW", + "tags": [ + "status_new", + "returncase.status_new" + ], + "title": "ReturnCase.STATUS_NEW" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_PARTIAL_RETURNED", + "tags": [ + "status_partial_returned", + "returncase.status_partial_returned" + ], + "title": "ReturnCase.STATUS_PARTIAL_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_PARTIAL_RETURNED", + "tags": [ + "status_partial_returned", + "returncase.status_partial_returned" + ], + "title": "ReturnCase.STATUS_PARTIAL_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_RETURNED", + "tags": [ + "status_returned", + "returncase.status_returned" + ], + "title": "ReturnCase.STATUS_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCase#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_RETURNED", + "tags": [ + "status_returned", + "returncase.status_returned" + ], + "title": "ReturnCase.STATUS_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCase#confirm", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.confirm", + "tags": [ + "confirm", + "returncase.confirm" + ], + "title": "ReturnCase.confirm" + }, + { + "id": "script-api:dw/order/ReturnCase#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createInvoice", + "tags": [ + "createinvoice", + "returncase.createinvoice" + ], + "title": "ReturnCase.createInvoice" + }, + { + "id": "script-api:dw/order/ReturnCase#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createInvoice", + "tags": [ + "createinvoice", + "returncase.createinvoice" + ], + "title": "ReturnCase.createInvoice" + }, + { + "id": "script-api:dw/order/ReturnCase#createItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createItem", + "tags": [ + "createitem", + "returncase.createitem" + ], + "title": "ReturnCase.createItem" + }, + { + "id": "script-api:dw/order/ReturnCase#createReturn", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createReturn", + "tags": [ + "createreturn", + "returncase.createreturn" + ], + "title": "ReturnCase.createReturn" + }, + { + "id": "script-api:dw/order/ReturnCase#createReturn", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createReturn", + "tags": [ + "createreturn", + "returncase.createreturn" + ], + "title": "ReturnCase.createReturn" + }, + { + "id": "script-api:dw/order/ReturnCase#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getInvoice", + "tags": [ + "getinvoice", + "returncase.getinvoice" + ], + "title": "ReturnCase.getInvoice" + }, + { + "id": "script-api:dw/order/ReturnCase#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "returncase.getinvoicenumber" + ], + "title": "ReturnCase.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/ReturnCase#getReturnCaseNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getReturnCaseNumber", + "tags": [ + "getreturncasenumber", + "returncase.getreturncasenumber" + ], + "title": "ReturnCase.getReturnCaseNumber" + }, + { + "id": "script-api:dw/order/ReturnCase#getReturns", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getReturns", + "tags": [ + "getreturns", + "returncase.getreturns" + ], + "title": "ReturnCase.getReturns" + }, + { + "id": "script-api:dw/order/ReturnCase#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getStatus", + "tags": [ + "getstatus", + "returncase.getstatus" + ], + "title": "ReturnCase.getStatus" + }, + { + "id": "script-api:dw/order/ReturnCase#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.invoice", + "tags": [ + "invoice", + "returncase.invoice" + ], + "title": "ReturnCase.invoice" + }, + { + "id": "script-api:dw/order/ReturnCase#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.invoiceNumber", + "tags": [ + "invoicenumber", + "returncase.invoicenumber" + ], + "title": "ReturnCase.invoiceNumber" + }, + { + "id": "script-api:dw/order/ReturnCase#isRMA", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.isRMA", + "tags": [ + "isrma", + "returncase.isrma" + ], + "title": "ReturnCase.isRMA" + }, + { + "id": "script-api:dw/order/ReturnCase#returnCaseNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.returnCaseNumber", + "tags": [ + "returncasenumber", + "returncase.returncasenumber" + ], + "title": "ReturnCase.returnCaseNumber" + }, + { + "id": "script-api:dw/order/ReturnCase#returns", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.returns", + "tags": [ + "returns", + "returncase.returns" + ], + "title": "ReturnCase.returns" + }, + { + "id": "script-api:dw/order/ReturnCase#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.status", + "tags": [ + "status", + "returncase.status" + ], + "title": "ReturnCase.status" + }, + { + "id": "script-api:dw/order/ReturnCaseItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnCaseItem", + "tags": [ + "returncaseitem", + "dw.order.returncaseitem", + "dw/order" + ], + "title": "ReturnCaseItem" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "returncaseitem.status_cancelled" + ], + "title": "ReturnCaseItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "returncaseitem.status_cancelled" + ], + "title": "ReturnCaseItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "returncaseitem.status_confirmed" + ], + "title": "ReturnCaseItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "returncaseitem.status_confirmed" + ], + "title": "ReturnCaseItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_NEW", + "tags": [ + "status_new", + "returncaseitem.status_new" + ], + "title": "ReturnCaseItem.STATUS_NEW" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_NEW", + "tags": [ + "status_new", + "returncaseitem.status_new" + ], + "title": "ReturnCaseItem.STATUS_NEW" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_PARTIAL_RETURNED", + "tags": [ + "status_partial_returned", + "returncaseitem.status_partial_returned" + ], + "title": "ReturnCaseItem.STATUS_PARTIAL_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_PARTIAL_RETURNED", + "tags": [ + "status_partial_returned", + "returncaseitem.status_partial_returned" + ], + "title": "ReturnCaseItem.STATUS_PARTIAL_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_RETURNED", + "tags": [ + "status_returned", + "returncaseitem.status_returned" + ], + "title": "ReturnCaseItem.STATUS_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_RETURNED", + "tags": [ + "status_returned", + "returncaseitem.status_returned" + ], + "title": "ReturnCaseItem.STATUS_RETURNED" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#authorizedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.authorizedQuantity", + "tags": [ + "authorizedquantity", + "returncaseitem.authorizedquantity" + ], + "title": "ReturnCaseItem.authorizedQuantity" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.basePrice", + "tags": [ + "baseprice", + "returncaseitem.baseprice" + ], + "title": "ReturnCaseItem.basePrice" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#createReturnItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.createReturnItem", + "tags": [ + "createreturnitem", + "returncaseitem.createreturnitem" + ], + "title": "ReturnCaseItem.createReturnItem" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getAuthorizedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getAuthorizedQuantity", + "tags": [ + "getauthorizedquantity", + "returncaseitem.getauthorizedquantity" + ], + "title": "ReturnCaseItem.getAuthorizedQuantity" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getBasePrice", + "tags": [ + "getbaseprice", + "returncaseitem.getbaseprice" + ], + "title": "ReturnCaseItem.getBasePrice" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getNote", + "tags": [ + "getnote", + "returncaseitem.getnote" + ], + "title": "ReturnCaseItem.getNote" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getParentItem", + "tags": [ + "getparentitem", + "returncaseitem.getparentitem" + ], + "title": "ReturnCaseItem.getParentItem" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReasonCode", + "tags": [ + "getreasoncode", + "returncaseitem.getreasoncode" + ], + "title": "ReturnCaseItem.getReasonCode" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getReturnCaseNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReturnCaseNumber", + "tags": [ + "getreturncasenumber", + "returncaseitem.getreturncasenumber" + ], + "title": "ReturnCaseItem.getReturnCaseNumber" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getReturnItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReturnItems", + "tags": [ + "getreturnitems", + "returncaseitem.getreturnitems" + ], + "title": "ReturnCaseItem.getReturnItems" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getStatus", + "tags": [ + "getstatus", + "returncaseitem.getstatus" + ], + "title": "ReturnCaseItem.getStatus" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.note", + "tags": [ + "note", + "returncaseitem.note" + ], + "title": "ReturnCaseItem.note" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.parentItem", + "tags": [ + "parentitem", + "returncaseitem.parentitem" + ], + "title": "ReturnCaseItem.parentItem" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.reasonCode", + "tags": [ + "reasoncode", + "returncaseitem.reasoncode" + ], + "title": "ReturnCaseItem.reasonCode" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#returnCaseNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.returnCaseNumber", + "tags": [ + "returncasenumber", + "returncaseitem.returncasenumber" + ], + "title": "ReturnCaseItem.returnCaseNumber" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#returnItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.returnItems", + "tags": [ + "returnitems", + "returncaseitem.returnitems" + ], + "title": "ReturnCaseItem.returnItems" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#setAuthorizedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setAuthorizedQuantity", + "tags": [ + "setauthorizedquantity", + "returncaseitem.setauthorizedquantity" + ], + "title": "ReturnCaseItem.setAuthorizedQuantity" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#setNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setNote", + "tags": [ + "setnote", + "returncaseitem.setnote" + ], + "title": "ReturnCaseItem.setNote" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setParentItem", + "tags": [ + "setparentitem", + "returncaseitem.setparentitem" + ], + "title": "ReturnCaseItem.setParentItem" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setReasonCode", + "tags": [ + "setreasoncode", + "returncaseitem.setreasoncode" + ], + "title": "ReturnCaseItem.setReasonCode" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setStatus", + "tags": [ + "setstatus", + "returncaseitem.setstatus" + ], + "title": "ReturnCaseItem.setStatus" + }, + { + "id": "script-api:dw/order/ReturnCaseItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.status", + "tags": [ + "status", + "returncaseitem.status" + ], + "title": "ReturnCaseItem.status" + }, + { + "id": "script-api:dw/order/ReturnItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnItem", + "tags": [ + "returnitem", + "dw.order.returnitem", + "dw/order" + ], + "title": "ReturnItem" + }, + { + "id": "script-api:dw/order/ReturnItem#addTaxItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.addTaxItem", + "tags": [ + "addtaxitem", + "returnitem.addtaxitem" + ], + "title": "ReturnItem.addTaxItem" + }, + { + "id": "script-api:dw/order/ReturnItem#applyPriceRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.applyPriceRate", + "tags": [ + "applypricerate", + "returnitem.applypricerate" + ], + "title": "ReturnItem.applyPriceRate" + }, + { + "id": "script-api:dw/order/ReturnItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.basePrice", + "tags": [ + "baseprice", + "returnitem.baseprice" + ], + "title": "ReturnItem.basePrice" + }, + { + "id": "script-api:dw/order/ReturnItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getBasePrice", + "tags": [ + "getbaseprice", + "returnitem.getbaseprice" + ], + "title": "ReturnItem.getBasePrice" + }, + { + "id": "script-api:dw/order/ReturnItem#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getNote", + "tags": [ + "getnote", + "returnitem.getnote" + ], + "title": "ReturnItem.getNote" + }, + { + "id": "script-api:dw/order/ReturnItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getParentItem", + "tags": [ + "getparentitem", + "returnitem.getparentitem" + ], + "title": "ReturnItem.getParentItem" + }, + { + "id": "script-api:dw/order/ReturnItem#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReasonCode", + "tags": [ + "getreasoncode", + "returnitem.getreasoncode" + ], + "title": "ReturnItem.getReasonCode" + }, + { + "id": "script-api:dw/order/ReturnItem#getReturnCaseItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnCaseItem", + "tags": [ + "getreturncaseitem", + "returnitem.getreturncaseitem" + ], + "title": "ReturnItem.getReturnCaseItem" + }, + { + "id": "script-api:dw/order/ReturnItem#getReturnNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnNumber", + "tags": [ + "getreturnnumber", + "returnitem.getreturnnumber" + ], + "title": "ReturnItem.getReturnNumber" + }, + { + "id": "script-api:dw/order/ReturnItem#getReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnedQuantity", + "tags": [ + "getreturnedquantity", + "returnitem.getreturnedquantity" + ], + "title": "ReturnItem.getReturnedQuantity" + }, + { + "id": "script-api:dw/order/ReturnItem#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.note", + "tags": [ + "note", + "returnitem.note" + ], + "title": "ReturnItem.note" + }, + { + "id": "script-api:dw/order/ReturnItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.parentItem", + "tags": [ + "parentitem", + "returnitem.parentitem" + ], + "title": "ReturnItem.parentItem" + }, + { + "id": "script-api:dw/order/ReturnItem#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.reasonCode", + "tags": [ + "reasoncode", + "returnitem.reasoncode" + ], + "title": "ReturnItem.reasonCode" + }, + { + "id": "script-api:dw/order/ReturnItem#returnCaseItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnCaseItem", + "tags": [ + "returncaseitem", + "returnitem.returncaseitem" + ], + "title": "ReturnItem.returnCaseItem" + }, + { + "id": "script-api:dw/order/ReturnItem#returnNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnNumber", + "tags": [ + "returnnumber", + "returnitem.returnnumber" + ], + "title": "ReturnItem.returnNumber" + }, + { + "id": "script-api:dw/order/ReturnItem#returnedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnedQuantity", + "tags": [ + "returnedquantity", + "returnitem.returnedquantity" + ], + "title": "ReturnItem.returnedQuantity" + }, + { + "id": "script-api:dw/order/ReturnItem#setNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setNote", + "tags": [ + "setnote", + "returnitem.setnote" + ], + "title": "ReturnItem.setNote" + }, + { + "id": "script-api:dw/order/ReturnItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setParentItem", + "tags": [ + "setparentitem", + "returnitem.setparentitem" + ], + "title": "ReturnItem.setParentItem" + }, + { + "id": "script-api:dw/order/ReturnItem#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setReasonCode", + "tags": [ + "setreasoncode", + "returnitem.setreasoncode" + ], + "title": "ReturnItem.setReasonCode" + }, + { + "id": "script-api:dw/order/ReturnItem#setReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setReturnedQuantity", + "tags": [ + "setreturnedquantity", + "returnitem.setreturnedquantity" + ], + "title": "ReturnItem.setReturnedQuantity" + }, + { + "id": "script-api:dw/order/ReturnItem#setTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setTaxBasis", + "tags": [ + "settaxbasis", + "returnitem.settaxbasis" + ], + "title": "ReturnItem.setTaxBasis" + }, + { + "id": "script-api:dw/order/ReturnItem#setTaxItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setTaxItems", + "tags": [ + "settaxitems", + "returnitem.settaxitems" + ], + "title": "ReturnItem.setTaxItems" + }, + { + "id": "script-api:dw/order/Shipment", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Shipment", + "tags": [ + "shipment", + "dw.order.shipment", + "dw/order" + ], + "title": "Shipment" + }, + { + "id": "script-api:dw/order/Shipment#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.ID", + "tags": [ + "id", + "shipment.id" + ], + "title": "Shipment.ID" + }, + { + "id": "script-api:dw/order/Shipment#SHIPMENT_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_NOTSHIPPED", + "tags": [ + "shipment_notshipped", + "shipment.shipment_notshipped" + ], + "title": "Shipment.SHIPMENT_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPMENT_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_NOTSHIPPED", + "tags": [ + "shipment_notshipped", + "shipment.shipment_notshipped" + ], + "title": "Shipment.SHIPMENT_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPMENT_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_SHIPPED", + "tags": [ + "shipment_shipped", + "shipment.shipment_shipped" + ], + "title": "Shipment.SHIPMENT_SHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPMENT_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_SHIPPED", + "tags": [ + "shipment_shipped", + "shipment.shipment_shipped" + ], + "title": "Shipment.SHIPMENT_SHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_NOTSHIPPED", + "tags": [ + "shipping_status_notshipped", + "shipment.shipping_status_notshipped" + ], + "title": "Shipment.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_NOTSHIPPED", + "tags": [ + "shipping_status_notshipped", + "shipment.shipping_status_notshipped" + ], + "title": "Shipment.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_SHIPPED", + "tags": [ + "shipping_status_shipped", + "shipment.shipping_status_shipped" + ], + "title": "Shipment.SHIPPING_STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_SHIPPED", + "tags": [ + "shipping_status_shipped", + "shipment.shipping_status_shipped" + ], + "title": "Shipment.SHIPPING_STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalGrossPrice", + "tags": [ + "adjustedmerchandizetotalgrossprice", + "shipment.adjustedmerchandizetotalgrossprice" + ], + "title": "Shipment.adjustedMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalNetPrice", + "tags": [ + "adjustedmerchandizetotalnetprice", + "shipment.adjustedmerchandizetotalnetprice" + ], + "title": "Shipment.adjustedMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalPrice", + "tags": [ + "adjustedmerchandizetotalprice", + "shipment.adjustedmerchandizetotalprice" + ], + "title": "Shipment.adjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalTax", + "tags": [ + "adjustedmerchandizetotaltax", + "shipment.adjustedmerchandizetotaltax" + ], + "title": "Shipment.adjustedMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#adjustedShippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalGrossPrice", + "tags": [ + "adjustedshippingtotalgrossprice", + "shipment.adjustedshippingtotalgrossprice" + ], + "title": "Shipment.adjustedShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedShippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalNetPrice", + "tags": [ + "adjustedshippingtotalnetprice", + "shipment.adjustedshippingtotalnetprice" + ], + "title": "Shipment.adjustedShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedShippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalPrice", + "tags": [ + "adjustedshippingtotalprice", + "shipment.adjustedshippingtotalprice" + ], + "title": "Shipment.adjustedShippingTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#adjustedShippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalTax", + "tags": [ + "adjustedshippingtotaltax", + "shipment.adjustedshippingtotaltax" + ], + "title": "Shipment.adjustedShippingTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#allLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.allLineItems", + "tags": [ + "alllineitems", + "shipment.alllineitems" + ], + "title": "Shipment.allLineItems" + }, + { + "id": "script-api:dw/order/Shipment#createShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingAddress", + "tags": [ + "createshippingaddress", + "shipment.createshippingaddress" + ], + "title": "Shipment.createShippingAddress" + }, + { + "id": "script-api:dw/order/Shipment#createShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingLineItem", + "tags": [ + "createshippinglineitem", + "shipment.createshippinglineitem" + ], + "title": "Shipment.createShippingLineItem" + }, + { + "id": "script-api:dw/order/Shipment#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingPriceAdjustment", + "tags": [ + "createshippingpriceadjustment", + "shipment.createshippingpriceadjustment" + ], + "title": "Shipment.createShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/Shipment#default", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.default", + "tags": [ + "default", + "shipment.default" + ], + "title": "Shipment.default" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalGrossPrice", + "tags": [ + "getadjustedmerchandizetotalgrossprice", + "shipment.getadjustedmerchandizetotalgrossprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalNetPrice", + "tags": [ + "getadjustedmerchandizetotalnetprice", + "shipment.getadjustedmerchandizetotalnetprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalPrice", + "tags": [ + "getadjustedmerchandizetotalprice", + "shipment.getadjustedmerchandizetotalprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalPrice", + "tags": [ + "getadjustedmerchandizetotalprice", + "shipment.getadjustedmerchandizetotalprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalTax", + "tags": [ + "getadjustedmerchandizetotaltax", + "shipment.getadjustedmerchandizetotaltax" + ], + "title": "Shipment.getAdjustedMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalGrossPrice", + "tags": [ + "getadjustedshippingtotalgrossprice", + "shipment.getadjustedshippingtotalgrossprice" + ], + "title": "Shipment.getAdjustedShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalNetPrice", + "tags": [ + "getadjustedshippingtotalnetprice", + "shipment.getadjustedshippingtotalnetprice" + ], + "title": "Shipment.getAdjustedShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalPrice", + "tags": [ + "getadjustedshippingtotalprice", + "shipment.getadjustedshippingtotalprice" + ], + "title": "Shipment.getAdjustedShippingTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalTax", + "tags": [ + "getadjustedshippingtotaltax", + "shipment.getadjustedshippingtotaltax" + ], + "title": "Shipment.getAdjustedShippingTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#getAllLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAllLineItems", + "tags": [ + "getalllineitems", + "shipment.getalllineitems" + ], + "title": "Shipment.getAllLineItems" + }, + { + "id": "script-api:dw/order/Shipment#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getGiftCertificateLineItems", + "tags": [ + "getgiftcertificatelineitems", + "shipment.getgiftcertificatelineitems" + ], + "title": "Shipment.getGiftCertificateLineItems" + }, + { + "id": "script-api:dw/order/Shipment#getGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getGiftMessage", + "tags": [ + "getgiftmessage", + "shipment.getgiftmessage" + ], + "title": "Shipment.getGiftMessage" + }, + { + "id": "script-api:dw/order/Shipment#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getID", + "tags": [ + "getid", + "shipment.getid" + ], + "title": "Shipment.getID" + }, + { + "id": "script-api:dw/order/Shipment#getMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalGrossPrice", + "tags": [ + "getmerchandizetotalgrossprice", + "shipment.getmerchandizetotalgrossprice" + ], + "title": "Shipment.getMerchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#getMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalNetPrice", + "tags": [ + "getmerchandizetotalnetprice", + "shipment.getmerchandizetotalnetprice" + ], + "title": "Shipment.getMerchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#getMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalPrice", + "tags": [ + "getmerchandizetotalprice", + "shipment.getmerchandizetotalprice" + ], + "title": "Shipment.getMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getMerchandizeTotalPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalPriceAdjustments", + "tags": [ + "getmerchandizetotalpriceadjustments", + "shipment.getmerchandizetotalpriceadjustments" + ], + "title": "Shipment.getMerchandizeTotalPriceAdjustments" + }, + { + "id": "script-api:dw/order/Shipment#getMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalTax", + "tags": [ + "getmerchandizetotaltax", + "shipment.getmerchandizetotaltax" + ], + "title": "Shipment.getMerchandizeTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getProductLineItems", + "tags": [ + "getproductlineitems", + "shipment.getproductlineitems" + ], + "title": "Shipment.getProductLineItems" + }, + { + "id": "script-api:dw/order/Shipment#getProratedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getProratedMerchandizeTotalPrice", + "tags": [ + "getproratedmerchandizetotalprice", + "shipment.getproratedmerchandizetotalprice" + ], + "title": "Shipment.getProratedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getShipmentNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShipmentNo", + "tags": [ + "getshipmentno", + "shipment.getshipmentno" + ], + "title": "Shipment.getShipmentNo" + }, + { + "id": "script-api:dw/order/Shipment#getShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingAddress", + "tags": [ + "getshippingaddress", + "shipment.getshippingaddress" + ], + "title": "Shipment.getShippingAddress" + }, + { + "id": "script-api:dw/order/Shipment#getShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingLineItem", + "tags": [ + "getshippinglineitem", + "shipment.getshippinglineitem" + ], + "title": "Shipment.getShippingLineItem" + }, + { + "id": "script-api:dw/order/Shipment#getShippingLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingLineItems", + "tags": [ + "getshippinglineitems", + "shipment.getshippinglineitems" + ], + "title": "Shipment.getShippingLineItems" + }, + { + "id": "script-api:dw/order/Shipment#getShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingMethod", + "tags": [ + "getshippingmethod", + "shipment.getshippingmethod" + ], + "title": "Shipment.getShippingMethod" + }, + { + "id": "script-api:dw/order/Shipment#getShippingMethodID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingMethodID", + "tags": [ + "getshippingmethodid", + "shipment.getshippingmethodid" + ], + "title": "Shipment.getShippingMethodID" + }, + { + "id": "script-api:dw/order/Shipment#getShippingPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingPriceAdjustmentByPromotionID", + "tags": [ + "getshippingpriceadjustmentbypromotionid", + "shipment.getshippingpriceadjustmentbypromotionid" + ], + "title": "Shipment.getShippingPriceAdjustmentByPromotionID" + }, + { + "id": "script-api:dw/order/Shipment#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingPriceAdjustments", + "tags": [ + "getshippingpriceadjustments", + "shipment.getshippingpriceadjustments" + ], + "title": "Shipment.getShippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/Shipment#getShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingStatus", + "tags": [ + "getshippingstatus", + "shipment.getshippingstatus" + ], + "title": "Shipment.getShippingStatus" + }, + { + "id": "script-api:dw/order/Shipment#getShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalGrossPrice", + "tags": [ + "getshippingtotalgrossprice", + "shipment.getshippingtotalgrossprice" + ], + "title": "Shipment.getShippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#getShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalNetPrice", + "tags": [ + "getshippingtotalnetprice", + "shipment.getshippingtotalnetprice" + ], + "title": "Shipment.getShippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#getShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalPrice", + "tags": [ + "getshippingtotalprice", + "shipment.getshippingtotalprice" + ], + "title": "Shipment.getShippingTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#getShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalTax", + "tags": [ + "getshippingtotaltax", + "shipment.getshippingtotaltax" + ], + "title": "Shipment.getShippingTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#getStandardShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getStandardShippingLineItem", + "tags": [ + "getstandardshippinglineitem", + "shipment.getstandardshippinglineitem" + ], + "title": "Shipment.getStandardShippingLineItem" + }, + { + "id": "script-api:dw/order/Shipment#getTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalGrossPrice", + "tags": [ + "gettotalgrossprice", + "shipment.gettotalgrossprice" + ], + "title": "Shipment.getTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#getTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalNetPrice", + "tags": [ + "gettotalnetprice", + "shipment.gettotalnetprice" + ], + "title": "Shipment.getTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#getTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalTax", + "tags": [ + "gettotaltax", + "shipment.gettotaltax" + ], + "title": "Shipment.getTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#getTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTrackingNumber", + "tags": [ + "gettrackingnumber", + "shipment.gettrackingnumber" + ], + "title": "Shipment.getTrackingNumber" + }, + { + "id": "script-api:dw/order/Shipment#gift", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.gift", + "tags": [ + "gift", + "shipment.gift" + ], + "title": "Shipment.gift" + }, + { + "id": "script-api:dw/order/Shipment#giftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.giftCertificateLineItems", + "tags": [ + "giftcertificatelineitems", + "shipment.giftcertificatelineitems" + ], + "title": "Shipment.giftCertificateLineItems" + }, + { + "id": "script-api:dw/order/Shipment#giftMessage", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.giftMessage", + "tags": [ + "giftmessage", + "shipment.giftmessage" + ], + "title": "Shipment.giftMessage" + }, + { + "id": "script-api:dw/order/Shipment#isDefault", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.isDefault", + "tags": [ + "isdefault", + "shipment.isdefault" + ], + "title": "Shipment.isDefault" + }, + { + "id": "script-api:dw/order/Shipment#isGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.isGift", + "tags": [ + "isgift", + "shipment.isgift" + ], + "title": "Shipment.isGift" + }, + { + "id": "script-api:dw/order/Shipment#merchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalGrossPrice", + "tags": [ + "merchandizetotalgrossprice", + "shipment.merchandizetotalgrossprice" + ], + "title": "Shipment.merchandizeTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#merchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalNetPrice", + "tags": [ + "merchandizetotalnetprice", + "shipment.merchandizetotalnetprice" + ], + "title": "Shipment.merchandizeTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#merchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalPrice", + "tags": [ + "merchandizetotalprice", + "shipment.merchandizetotalprice" + ], + "title": "Shipment.merchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#merchandizeTotalPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalPriceAdjustments", + "tags": [ + "merchandizetotalpriceadjustments", + "shipment.merchandizetotalpriceadjustments" + ], + "title": "Shipment.merchandizeTotalPriceAdjustments" + }, + { + "id": "script-api:dw/order/Shipment#merchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalTax", + "tags": [ + "merchandizetotaltax", + "shipment.merchandizetotaltax" + ], + "title": "Shipment.merchandizeTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#productLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.productLineItems", + "tags": [ + "productlineitems", + "shipment.productlineitems" + ], + "title": "Shipment.productLineItems" + }, + { + "id": "script-api:dw/order/Shipment#proratedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.proratedMerchandizeTotalPrice", + "tags": [ + "proratedmerchandizetotalprice", + "shipment.proratedmerchandizetotalprice" + ], + "title": "Shipment.proratedMerchandizeTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#removeShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.removeShippingLineItem", + "tags": [ + "removeshippinglineitem", + "shipment.removeshippinglineitem" + ], + "title": "Shipment.removeShippingLineItem" + }, + { + "id": "script-api:dw/order/Shipment#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.removeShippingPriceAdjustment", + "tags": [ + "removeshippingpriceadjustment", + "shipment.removeshippingpriceadjustment" + ], + "title": "Shipment.removeShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/Shipment#setGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setGift", + "tags": [ + "setgift", + "shipment.setgift" + ], + "title": "Shipment.setGift" + }, + { + "id": "script-api:dw/order/Shipment#setGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setGiftMessage", + "tags": [ + "setgiftmessage", + "shipment.setgiftmessage" + ], + "title": "Shipment.setGiftMessage" + }, + { + "id": "script-api:dw/order/Shipment#setShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setShippingMethod", + "tags": [ + "setshippingmethod", + "shipment.setshippingmethod" + ], + "title": "Shipment.setShippingMethod" + }, + { + "id": "script-api:dw/order/Shipment#setShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setShippingStatus", + "tags": [ + "setshippingstatus", + "shipment.setshippingstatus" + ], + "title": "Shipment.setShippingStatus" + }, + { + "id": "script-api:dw/order/Shipment#setTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setTrackingNumber", + "tags": [ + "settrackingnumber", + "shipment.settrackingnumber" + ], + "title": "Shipment.setTrackingNumber" + }, + { + "id": "script-api:dw/order/Shipment#shipmentNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shipmentNo", + "tags": [ + "shipmentno", + "shipment.shipmentno" + ], + "title": "Shipment.shipmentNo" + }, + { + "id": "script-api:dw/order/Shipment#shippingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingAddress", + "tags": [ + "shippingaddress", + "shipment.shippingaddress" + ], + "title": "Shipment.shippingAddress" + }, + { + "id": "script-api:dw/order/Shipment#shippingLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingLineItems", + "tags": [ + "shippinglineitems", + "shipment.shippinglineitems" + ], + "title": "Shipment.shippingLineItems" + }, + { + "id": "script-api:dw/order/Shipment#shippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingMethod", + "tags": [ + "shippingmethod", + "shipment.shippingmethod" + ], + "title": "Shipment.shippingMethod" + }, + { + "id": "script-api:dw/order/Shipment#shippingMethodID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingMethodID", + "tags": [ + "shippingmethodid", + "shipment.shippingmethodid" + ], + "title": "Shipment.shippingMethodID" + }, + { + "id": "script-api:dw/order/Shipment#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingPriceAdjustments", + "tags": [ + "shippingpriceadjustments", + "shipment.shippingpriceadjustments" + ], + "title": "Shipment.shippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/Shipment#shippingStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingStatus", + "tags": [ + "shippingstatus", + "shipment.shippingstatus" + ], + "title": "Shipment.shippingStatus" + }, + { + "id": "script-api:dw/order/Shipment#shippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalGrossPrice", + "tags": [ + "shippingtotalgrossprice", + "shipment.shippingtotalgrossprice" + ], + "title": "Shipment.shippingTotalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#shippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalNetPrice", + "tags": [ + "shippingtotalnetprice", + "shipment.shippingtotalnetprice" + ], + "title": "Shipment.shippingTotalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#shippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalPrice", + "tags": [ + "shippingtotalprice", + "shipment.shippingtotalprice" + ], + "title": "Shipment.shippingTotalPrice" + }, + { + "id": "script-api:dw/order/Shipment#shippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalTax", + "tags": [ + "shippingtotaltax", + "shipment.shippingtotaltax" + ], + "title": "Shipment.shippingTotalTax" + }, + { + "id": "script-api:dw/order/Shipment#standardShippingLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.standardShippingLineItem", + "tags": [ + "standardshippinglineitem", + "shipment.standardshippinglineitem" + ], + "title": "Shipment.standardShippingLineItem" + }, + { + "id": "script-api:dw/order/Shipment#totalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalGrossPrice", + "tags": [ + "totalgrossprice", + "shipment.totalgrossprice" + ], + "title": "Shipment.totalGrossPrice" + }, + { + "id": "script-api:dw/order/Shipment#totalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalNetPrice", + "tags": [ + "totalnetprice", + "shipment.totalnetprice" + ], + "title": "Shipment.totalNetPrice" + }, + { + "id": "script-api:dw/order/Shipment#totalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalTax", + "tags": [ + "totaltax", + "shipment.totaltax" + ], + "title": "Shipment.totalTax" + }, + { + "id": "script-api:dw/order/Shipment#trackingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.trackingNumber", + "tags": [ + "trackingnumber", + "shipment.trackingnumber" + ], + "title": "Shipment.trackingNumber" + }, + { + "id": "script-api:dw/order/ShipmentShippingCost", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShipmentShippingCost", + "tags": [ + "shipmentshippingcost", + "dw.order.shipmentshippingcost", + "dw/order" + ], + "title": "ShipmentShippingCost" + }, + { + "id": "script-api:dw/order/ShipmentShippingCost#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingCost", + "qualifiedName": "dw.order.ShipmentShippingCost.amount", + "tags": [ + "amount", + "shipmentshippingcost.amount" + ], + "title": "ShipmentShippingCost.amount" + }, + { + "id": "script-api:dw/order/ShipmentShippingCost#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingCost", + "qualifiedName": "dw.order.ShipmentShippingCost.getAmount", + "tags": [ + "getamount", + "shipmentshippingcost.getamount" + ], + "title": "ShipmentShippingCost.getAmount" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShipmentShippingModel", + "tags": [ + "shipmentshippingmodel", + "dw.order.shipmentshippingmodel", + "dw/order" + ], + "title": "ShipmentShippingModel" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#applicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.applicableShippingMethods", + "tags": [ + "applicableshippingmethods", + "shipmentshippingmodel.applicableshippingmethods" + ], + "title": "ShipmentShippingModel.applicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getApplicableShippingMethods", + "tags": [ + "getapplicableshippingmethods", + "shipmentshippingmodel.getapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getApplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getApplicableShippingMethods", + "tags": [ + "getapplicableshippingmethods", + "shipmentshippingmodel.getapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getApplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getInapplicableShippingMethods", + "tags": [ + "getinapplicableshippingmethods", + "shipmentshippingmodel.getinapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getInapplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getInapplicableShippingMethods", + "tags": [ + "getinapplicableshippingmethods", + "shipmentshippingmodel.getinapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getInapplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getShippingCost", + "tags": [ + "getshippingcost", + "shipmentshippingmodel.getshippingcost" + ], + "title": "ShipmentShippingModel.getShippingCost" + }, + { + "id": "script-api:dw/order/ShipmentShippingModel#inapplicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.inapplicableShippingMethods", + "tags": [ + "inapplicableshippingmethods", + "shipmentshippingmodel.inapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.inapplicableShippingMethods" + }, + { + "id": "script-api:dw/order/ShippingLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingLineItem", + "tags": [ + "shippinglineitem", + "dw.order.shippinglineitem", + "dw/order" + ], + "title": "ShippingLineItem" + }, + { + "id": "script-api:dw/order/ShippingLineItem#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.ID", + "tags": [ + "id", + "shippinglineitem.id" + ], + "title": "ShippingLineItem.ID" + }, + { + "id": "script-api:dw/order/ShippingLineItem#STANDARD_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.STANDARD_SHIPPING_ID", + "tags": [ + "standard_shipping_id", + "shippinglineitem.standard_shipping_id" + ], + "title": "ShippingLineItem.STANDARD_SHIPPING_ID" + }, + { + "id": "script-api:dw/order/ShippingLineItem#STANDARD_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.STANDARD_SHIPPING_ID", + "tags": [ + "standard_shipping_id", + "shippinglineitem.standard_shipping_id" + ], + "title": "ShippingLineItem.STANDARD_SHIPPING_ID" + }, + { + "id": "script-api:dw/order/ShippingLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedGrossPrice", + "tags": [ + "adjustedgrossprice", + "shippinglineitem.adjustedgrossprice" + ], + "title": "ShippingLineItem.adjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedNetPrice", + "tags": [ + "adjustednetprice", + "shippinglineitem.adjustednetprice" + ], + "title": "ShippingLineItem.adjustedNetPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedPrice", + "tags": [ + "adjustedprice", + "shippinglineitem.adjustedprice" + ], + "title": "ShippingLineItem.adjustedPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedTax", + "tags": [ + "adjustedtax", + "shippinglineitem.adjustedtax" + ], + "title": "ShippingLineItem.adjustedTax" + }, + { + "id": "script-api:dw/order/ShippingLineItem#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.createShippingPriceAdjustment", + "tags": [ + "createshippingpriceadjustment", + "shippinglineitem.createshippingpriceadjustment" + ], + "title": "ShippingLineItem.createShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/ShippingLineItem#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.createShippingPriceAdjustment", + "tags": [ + "createshippingpriceadjustment", + "shippinglineitem.createshippingpriceadjustment" + ], + "title": "ShippingLineItem.createShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedGrossPrice", + "tags": [ + "getadjustedgrossprice", + "shippinglineitem.getadjustedgrossprice" + ], + "title": "ShippingLineItem.getAdjustedGrossPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedNetPrice", + "tags": [ + "getadjustednetprice", + "shippinglineitem.getadjustednetprice" + ], + "title": "ShippingLineItem.getAdjustedNetPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedPrice", + "tags": [ + "getadjustedprice", + "shippinglineitem.getadjustedprice" + ], + "title": "ShippingLineItem.getAdjustedPrice" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedTax", + "tags": [ + "getadjustedtax", + "shippinglineitem.getadjustedtax" + ], + "title": "ShippingLineItem.getAdjustedTax" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getID", + "tags": [ + "getid", + "shippinglineitem.getid" + ], + "title": "ShippingLineItem.getID" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getOrderItem", + "tags": [ + "getorderitem", + "shippinglineitem.getorderitem" + ], + "title": "ShippingLineItem.getOrderItem" + }, + { + "id": "script-api:dw/order/ShippingLineItem#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getShippingPriceAdjustments", + "tags": [ + "getshippingpriceadjustments", + "shippinglineitem.getshippingpriceadjustments" + ], + "title": "ShippingLineItem.getShippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/ShippingLineItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.orderItem", + "tags": [ + "orderitem", + "shippinglineitem.orderitem" + ], + "title": "ShippingLineItem.orderItem" + }, + { + "id": "script-api:dw/order/ShippingLineItem#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.removeShippingPriceAdjustment", + "tags": [ + "removeshippingpriceadjustment", + "shippinglineitem.removeshippingpriceadjustment" + ], + "title": "ShippingLineItem.removeShippingPriceAdjustment" + }, + { + "id": "script-api:dw/order/ShippingLineItem#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.shippingPriceAdjustments", + "tags": [ + "shippingpriceadjustments", + "shippinglineitem.shippingpriceadjustments" + ], + "title": "ShippingLineItem.shippingPriceAdjustments" + }, + { + "id": "script-api:dw/order/ShippingLocation", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingLocation", + "tags": [ + "shippinglocation", + "dw.order.shippinglocation", + "dw/order" + ], + "title": "ShippingLocation" + }, + { + "id": "script-api:dw/order/ShippingLocation#address1", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.address1", + "tags": [ + "address1", + "shippinglocation.address1" + ], + "title": "ShippingLocation.address1" + }, + { + "id": "script-api:dw/order/ShippingLocation#address2", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.address2", + "tags": [ + "address2", + "shippinglocation.address2" + ], + "title": "ShippingLocation.address2" + }, + { + "id": "script-api:dw/order/ShippingLocation#city", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.city", + "tags": [ + "city", + "shippinglocation.city" + ], + "title": "ShippingLocation.city" + }, + { + "id": "script-api:dw/order/ShippingLocation#countryCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.countryCode", + "tags": [ + "countrycode", + "shippinglocation.countrycode" + ], + "title": "ShippingLocation.countryCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#getAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getAddress1", + "tags": [ + "getaddress1", + "shippinglocation.getaddress1" + ], + "title": "ShippingLocation.getAddress1" + }, + { + "id": "script-api:dw/order/ShippingLocation#getAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getAddress2", + "tags": [ + "getaddress2", + "shippinglocation.getaddress2" + ], + "title": "ShippingLocation.getAddress2" + }, + { + "id": "script-api:dw/order/ShippingLocation#getCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getCity", + "tags": [ + "getcity", + "shippinglocation.getcity" + ], + "title": "ShippingLocation.getCity" + }, + { + "id": "script-api:dw/order/ShippingLocation#getCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getCountryCode", + "tags": [ + "getcountrycode", + "shippinglocation.getcountrycode" + ], + "title": "ShippingLocation.getCountryCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#getPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getPostBox", + "tags": [ + "getpostbox", + "shippinglocation.getpostbox" + ], + "title": "ShippingLocation.getPostBox" + }, + { + "id": "script-api:dw/order/ShippingLocation#getPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getPostalCode", + "tags": [ + "getpostalcode", + "shippinglocation.getpostalcode" + ], + "title": "ShippingLocation.getPostalCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#getStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getStateCode", + "tags": [ + "getstatecode", + "shippinglocation.getstatecode" + ], + "title": "ShippingLocation.getStateCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#getSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getSuite", + "tags": [ + "getsuite", + "shippinglocation.getsuite" + ], + "title": "ShippingLocation.getSuite" + }, + { + "id": "script-api:dw/order/ShippingLocation#postBox", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.postBox", + "tags": [ + "postbox", + "shippinglocation.postbox" + ], + "title": "ShippingLocation.postBox" + }, + { + "id": "script-api:dw/order/ShippingLocation#postalCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.postalCode", + "tags": [ + "postalcode", + "shippinglocation.postalcode" + ], + "title": "ShippingLocation.postalCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#setAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setAddress1", + "tags": [ + "setaddress1", + "shippinglocation.setaddress1" + ], + "title": "ShippingLocation.setAddress1" + }, + { + "id": "script-api:dw/order/ShippingLocation#setAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setAddress2", + "tags": [ + "setaddress2", + "shippinglocation.setaddress2" + ], + "title": "ShippingLocation.setAddress2" + }, + { + "id": "script-api:dw/order/ShippingLocation#setCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setCity", + "tags": [ + "setcity", + "shippinglocation.setcity" + ], + "title": "ShippingLocation.setCity" + }, + { + "id": "script-api:dw/order/ShippingLocation#setCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setCountryCode", + "tags": [ + "setcountrycode", + "shippinglocation.setcountrycode" + ], + "title": "ShippingLocation.setCountryCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#setPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setPostBox", + "tags": [ + "setpostbox", + "shippinglocation.setpostbox" + ], + "title": "ShippingLocation.setPostBox" + }, + { + "id": "script-api:dw/order/ShippingLocation#setPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setPostalCode", + "tags": [ + "setpostalcode", + "shippinglocation.setpostalcode" + ], + "title": "ShippingLocation.setPostalCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#setStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setStateCode", + "tags": [ + "setstatecode", + "shippinglocation.setstatecode" + ], + "title": "ShippingLocation.setStateCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#setSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setSuite", + "tags": [ + "setsuite", + "shippinglocation.setsuite" + ], + "title": "ShippingLocation.setSuite" + }, + { + "id": "script-api:dw/order/ShippingLocation#stateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.stateCode", + "tags": [ + "statecode", + "shippinglocation.statecode" + ], + "title": "ShippingLocation.stateCode" + }, + { + "id": "script-api:dw/order/ShippingLocation#suite", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.suite", + "tags": [ + "suite", + "shippinglocation.suite" + ], + "title": "ShippingLocation.suite" + }, + { + "id": "script-api:dw/order/ShippingMethod", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingMethod", + "tags": [ + "shippingmethod", + "dw.order.shippingmethod", + "dw/order" + ], + "title": "ShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingMethod#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.ID", + "tags": [ + "id", + "shippingmethod.id" + ], + "title": "ShippingMethod.ID" + }, + { + "id": "script-api:dw/order/ShippingMethod#baseMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.baseMethod", + "tags": [ + "basemethod", + "shippingmethod.basemethod" + ], + "title": "ShippingMethod.baseMethod" + }, + { + "id": "script-api:dw/order/ShippingMethod#currencyCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.currencyCode", + "tags": [ + "currencycode", + "shippingmethod.currencycode" + ], + "title": "ShippingMethod.currencyCode" + }, + { + "id": "script-api:dw/order/ShippingMethod#customerGroups", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.customerGroups", + "tags": [ + "customergroups", + "shippingmethod.customergroups" + ], + "title": "ShippingMethod.customerGroups" + }, + { + "id": "script-api:dw/order/ShippingMethod#defaultMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.defaultMethod", + "tags": [ + "defaultmethod", + "shippingmethod.defaultmethod" + ], + "title": "ShippingMethod.defaultMethod" + }, + { + "id": "script-api:dw/order/ShippingMethod#dependentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.dependentMethods", + "tags": [ + "dependentmethods", + "shippingmethod.dependentmethods" + ], + "title": "ShippingMethod.dependentMethods" + }, + { + "id": "script-api:dw/order/ShippingMethod#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.description", + "tags": [ + "description", + "shippingmethod.description" + ], + "title": "ShippingMethod.description" + }, + { + "id": "script-api:dw/order/ShippingMethod#displayName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.displayName", + "tags": [ + "displayname", + "shippingmethod.displayname" + ], + "title": "ShippingMethod.displayName" + }, + { + "id": "script-api:dw/order/ShippingMethod#getBaseMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getBaseMethod", + "tags": [ + "getbasemethod", + "shippingmethod.getbasemethod" + ], + "title": "ShippingMethod.getBaseMethod" + }, + { + "id": "script-api:dw/order/ShippingMethod#getCurrencyCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getCurrencyCode", + "tags": [ + "getcurrencycode", + "shippingmethod.getcurrencycode" + ], + "title": "ShippingMethod.getCurrencyCode" + }, + { + "id": "script-api:dw/order/ShippingMethod#getCustomerGroups", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getCustomerGroups", + "tags": [ + "getcustomergroups", + "shippingmethod.getcustomergroups" + ], + "title": "ShippingMethod.getCustomerGroups" + }, + { + "id": "script-api:dw/order/ShippingMethod#getDependentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDependentMethods", + "tags": [ + "getdependentmethods", + "shippingmethod.getdependentmethods" + ], + "title": "ShippingMethod.getDependentMethods" + }, + { + "id": "script-api:dw/order/ShippingMethod#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDescription", + "tags": [ + "getdescription", + "shippingmethod.getdescription" + ], + "title": "ShippingMethod.getDescription" + }, + { + "id": "script-api:dw/order/ShippingMethod#getDisplayName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDisplayName", + "tags": [ + "getdisplayname", + "shippingmethod.getdisplayname" + ], + "title": "ShippingMethod.getDisplayName" + }, + { + "id": "script-api:dw/order/ShippingMethod#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getID", + "tags": [ + "getid", + "shippingmethod.getid" + ], + "title": "ShippingMethod.getID" + }, + { + "id": "script-api:dw/order/ShippingMethod#getTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getTaxClassID", + "tags": [ + "gettaxclassid", + "shippingmethod.gettaxclassid" + ], + "title": "ShippingMethod.getTaxClassID" + }, + { + "id": "script-api:dw/order/ShippingMethod#isDefaultMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.isDefaultMethod", + "tags": [ + "isdefaultmethod", + "shippingmethod.isdefaultmethod" + ], + "title": "ShippingMethod.isDefaultMethod" + }, + { + "id": "script-api:dw/order/ShippingMethod#isOnline", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.isOnline", + "tags": [ + "isonline", + "shippingmethod.isonline" + ], + "title": "ShippingMethod.isOnline" + }, + { + "id": "script-api:dw/order/ShippingMethod#online", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.online", + "tags": [ + "online", + "shippingmethod.online" + ], + "title": "ShippingMethod.online" + }, + { + "id": "script-api:dw/order/ShippingMethod#taxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.taxClassID", + "tags": [ + "taxclassid", + "shippingmethod.taxclassid" + ], + "title": "ShippingMethod.taxClassID" + }, + { + "id": "script-api:dw/order/ShippingMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingMgr", + "tags": [ + "shippingmgr", + "dw.order.shippingmgr", + "dw/order" + ], + "title": "ShippingMgr" + }, + { + "id": "script-api:dw/order/ShippingMgr#allShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.allShippingMethods", + "tags": [ + "allshippingmethods", + "shippingmgr.allshippingmethods" + ], + "title": "ShippingMgr.allShippingMethods" + }, + { + "id": "script-api:dw/order/ShippingMgr#allShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.allShippingMethods", + "tags": [ + "allshippingmethods", + "shippingmgr.allshippingmethods" + ], + "title": "ShippingMgr.allShippingMethods" + }, + { + "id": "script-api:dw/order/ShippingMgr#applyShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.applyShippingCost", + "tags": [ + "applyshippingcost", + "shippingmgr.applyshippingcost" + ], + "title": "ShippingMgr.applyShippingCost" + }, + { + "id": "script-api:dw/order/ShippingMgr#applyShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.applyShippingCost", + "tags": [ + "applyshippingcost", + "shippingmgr.applyshippingcost" + ], + "title": "ShippingMgr.applyShippingCost" + }, + { + "id": "script-api:dw/order/ShippingMgr#defaultShippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.defaultShippingMethod", + "tags": [ + "defaultshippingmethod", + "shippingmgr.defaultshippingmethod" + ], + "title": "ShippingMgr.defaultShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingMgr#defaultShippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.defaultShippingMethod", + "tags": [ + "defaultshippingmethod", + "shippingmgr.defaultshippingmethod" + ], + "title": "ShippingMgr.defaultShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingMgr#getAllShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getAllShippingMethods", + "tags": [ + "getallshippingmethods", + "shippingmgr.getallshippingmethods" + ], + "title": "ShippingMgr.getAllShippingMethods" + }, + { + "id": "script-api:dw/order/ShippingMgr#getAllShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getAllShippingMethods", + "tags": [ + "getallshippingmethods", + "shippingmgr.getallshippingmethods" + ], + "title": "ShippingMgr.getAllShippingMethods" + }, + { + "id": "script-api:dw/order/ShippingMgr#getDefaultShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getDefaultShippingMethod", + "tags": [ + "getdefaultshippingmethod", + "shippingmgr.getdefaultshippingmethod" + ], + "title": "ShippingMgr.getDefaultShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingMgr#getDefaultShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getDefaultShippingMethod", + "tags": [ + "getdefaultshippingmethod", + "shippingmgr.getdefaultshippingmethod" + ], + "title": "ShippingMgr.getDefaultShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingMgr#getProductShippingModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getProductShippingModel", + "tags": [ + "getproductshippingmodel", + "shippingmgr.getproductshippingmodel" + ], + "title": "ShippingMgr.getProductShippingModel" + }, + { + "id": "script-api:dw/order/ShippingMgr#getProductShippingModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getProductShippingModel", + "tags": [ + "getproductshippingmodel", + "shippingmgr.getproductshippingmodel" + ], + "title": "ShippingMgr.getProductShippingModel" + }, + { + "id": "script-api:dw/order/ShippingMgr#getShipmentShippingModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShipmentShippingModel", + "tags": [ + "getshipmentshippingmodel", + "shippingmgr.getshipmentshippingmodel" + ], + "title": "ShippingMgr.getShipmentShippingModel" + }, + { + "id": "script-api:dw/order/ShippingMgr#getShipmentShippingModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShipmentShippingModel", + "tags": [ + "getshipmentshippingmodel", + "shippingmgr.getshipmentshippingmodel" + ], + "title": "ShippingMgr.getShipmentShippingModel" + }, + { + "id": "script-api:dw/order/ShippingMgr#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShippingCost", + "tags": [ + "getshippingcost", + "shippingmgr.getshippingcost" + ], + "title": "ShippingMgr.getShippingCost" + }, + { + "id": "script-api:dw/order/ShippingMgr#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShippingCost", + "tags": [ + "getshippingcost", + "shippingmgr.getshippingcost" + ], + "title": "ShippingMgr.getShippingCost" + }, + { + "id": "script-api:dw/order/ShippingOrder", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingOrder", + "tags": [ + "shippingorder", + "dw.order.shippingorder", + "dw/order" + ], + "title": "ShippingOrder" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "shippingorder.orderby_itemid" + ], + "title": "ShippingOrder.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMID", + "tags": [ + "orderby_itemid", + "shippingorder.orderby_itemid" + ], + "title": "ShippingOrder.ORDERBY_ITEMID" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "shippingorder.orderby_itemposition" + ], + "title": "ShippingOrder.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMPOSITION", + "tags": [ + "orderby_itemposition", + "shippingorder.orderby_itemposition" + ], + "title": "ShippingOrder.ORDERBY_ITEMPOSITION" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "shippingorder.orderby_unsorted" + ], + "title": "ShippingOrder.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/ShippingOrder#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_UNSORTED", + "tags": [ + "orderby_unsorted", + "shippingorder.orderby_unsorted" + ], + "title": "ShippingOrder.ORDERBY_UNSORTED" + }, + { + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "shippingorder.qualifier_productitems" + ], + "title": "ShippingOrder.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_PRODUCTITEMS", + "tags": [ + "qualifier_productitems", + "shippingorder.qualifier_productitems" + ], + "title": "ShippingOrder.QUALIFIER_PRODUCTITEMS" + }, + { + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "shippingorder.qualifier_serviceitems" + ], + "title": "ShippingOrder.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_SERVICEITEMS", + "tags": [ + "qualifier_serviceitems", + "shippingorder.qualifier_serviceitems" + ], + "title": "ShippingOrder.QUALIFIER_SERVICEITEMS" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "shippingorder.status_cancelled" + ], + "title": "ShippingOrder.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "shippingorder.status_cancelled" + ], + "title": "ShippingOrder.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "shippingorder.status_confirmed" + ], + "title": "ShippingOrder.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "shippingorder.status_confirmed" + ], + "title": "ShippingOrder.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "shippingorder.status_shipped" + ], + "title": "ShippingOrder.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "shippingorder.status_shipped" + ], + "title": "ShippingOrder.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "shippingorder.status_warehouse" + ], + "title": "ShippingOrder.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/ShippingOrder#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "shippingorder.status_warehouse" + ], + "title": "ShippingOrder.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/ShippingOrder#addTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.addTrackingInfo", + "tags": [ + "addtrackinginfo", + "shippingorder.addtrackinginfo" + ], + "title": "ShippingOrder.addTrackingInfo" + }, + { + "id": "script-api:dw/order/ShippingOrder#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createInvoice", + "tags": [ + "createinvoice", + "shippingorder.createinvoice" + ], + "title": "ShippingOrder.createInvoice" + }, + { + "id": "script-api:dw/order/ShippingOrder#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createInvoice", + "tags": [ + "createinvoice", + "shippingorder.createinvoice" + ], + "title": "ShippingOrder.createInvoice" + }, + { + "id": "script-api:dw/order/ShippingOrder#createShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createShippingOrderItem", + "tags": [ + "createshippingorderitem", + "shippingorder.createshippingorderitem" + ], + "title": "ShippingOrder.createShippingOrderItem" + }, + { + "id": "script-api:dw/order/ShippingOrder#createShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createShippingOrderItem", + "tags": [ + "createshippingorderitem", + "shippingorder.createshippingorderitem" + ], + "title": "ShippingOrder.createShippingOrderItem" + }, + { + "id": "script-api:dw/order/ShippingOrder#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getInvoice", + "tags": [ + "getinvoice", + "shippingorder.getinvoice" + ], + "title": "ShippingOrder.getInvoice" + }, + { + "id": "script-api:dw/order/ShippingOrder#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getInvoiceNumber", + "tags": [ + "getinvoicenumber", + "shippingorder.getinvoicenumber" + ], + "title": "ShippingOrder.getInvoiceNumber" + }, + { + "id": "script-api:dw/order/ShippingOrder#getShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShipDate", + "tags": [ + "getshipdate", + "shippingorder.getshipdate" + ], + "title": "ShippingOrder.getShipDate" + }, + { + "id": "script-api:dw/order/ShippingOrder#getShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingAddress", + "tags": [ + "getshippingaddress", + "shippingorder.getshippingaddress" + ], + "title": "ShippingOrder.getShippingAddress" + }, + { + "id": "script-api:dw/order/ShippingOrder#getShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingMethod", + "tags": [ + "getshippingmethod", + "shippingorder.getshippingmethod" + ], + "title": "ShippingOrder.getShippingMethod" + }, + { + "id": "script-api:dw/order/ShippingOrder#getShippingOrderNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingOrderNumber", + "tags": [ + "getshippingordernumber", + "shippingorder.getshippingordernumber" + ], + "title": "ShippingOrder.getShippingOrderNumber" + }, + { + "id": "script-api:dw/order/ShippingOrder#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getStatus", + "tags": [ + "getstatus", + "shippingorder.getstatus" + ], + "title": "ShippingOrder.getStatus" + }, + { + "id": "script-api:dw/order/ShippingOrder#getTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getTrackingInfo", + "tags": [ + "gettrackinginfo", + "shippingorder.gettrackinginfo" + ], + "title": "ShippingOrder.getTrackingInfo" + }, + { + "id": "script-api:dw/order/ShippingOrder#getTrackingInfos", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getTrackingInfos", + "tags": [ + "gettrackinginfos", + "shippingorder.gettrackinginfos" + ], + "title": "ShippingOrder.getTrackingInfos" + }, + { + "id": "script-api:dw/order/ShippingOrder#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.invoice", + "tags": [ + "invoice", + "shippingorder.invoice" + ], + "title": "ShippingOrder.invoice" + }, + { + "id": "script-api:dw/order/ShippingOrder#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.invoiceNumber", + "tags": [ + "invoicenumber", + "shippingorder.invoicenumber" + ], + "title": "ShippingOrder.invoiceNumber" + }, + { + "id": "script-api:dw/order/ShippingOrder#setShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShipDate", + "tags": [ + "setshipdate", + "shippingorder.setshipdate" + ], + "title": "ShippingOrder.setShipDate" + }, + { + "id": "script-api:dw/order/ShippingOrder#setShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShippingAddress", + "tags": [ + "setshippingaddress", + "shippingorder.setshippingaddress" + ], + "title": "ShippingOrder.setShippingAddress" + }, + { + "id": "script-api:dw/order/ShippingOrder#setShippingMethodID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShippingMethodID", + "tags": [ + "setshippingmethodid", + "shippingorder.setshippingmethodid" + ], + "title": "ShippingOrder.setShippingMethodID" + }, + { + "id": "script-api:dw/order/ShippingOrder#setStatusWarehouse", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setStatusWarehouse", + "tags": [ + "setstatuswarehouse", + "shippingorder.setstatuswarehouse" + ], + "title": "ShippingOrder.setStatusWarehouse" + }, + { + "id": "script-api:dw/order/ShippingOrder#shipDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shipDate", + "tags": [ + "shipdate", + "shippingorder.shipdate" + ], + "title": "ShippingOrder.shipDate" + }, + { + "id": "script-api:dw/order/ShippingOrder#shippingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingAddress", + "tags": [ + "shippingaddress", + "shippingorder.shippingaddress" + ], + "title": "ShippingOrder.shippingAddress" + }, + { + "id": "script-api:dw/order/ShippingOrder#shippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingMethod", + "tags": [ + "shippingmethod", + "shippingorder.shippingmethod" + ], + "title": "ShippingOrder.shippingMethod" + }, + { + "id": "script-api:dw/order/ShippingOrder#shippingOrderNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingOrderNumber", + "tags": [ + "shippingordernumber", + "shippingorder.shippingordernumber" + ], + "title": "ShippingOrder.shippingOrderNumber" + }, + { + "id": "script-api:dw/order/ShippingOrder#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.status", + "tags": [ + "status", + "shippingorder.status" + ], + "title": "ShippingOrder.status" + }, + { + "id": "script-api:dw/order/ShippingOrder#trackingInfos", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.trackingInfos", + "tags": [ + "trackinginfos", + "shippingorder.trackinginfos" + ], + "title": "ShippingOrder.trackingInfos" + }, + { + "id": "script-api:dw/order/ShippingOrderItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingOrderItem", + "tags": [ + "shippingorderitem", + "dw.order.shippingorderitem", + "dw/order" + ], + "title": "ShippingOrderItem" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "shippingorderitem.status_cancelled" + ], + "title": "ShippingOrderItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CANCELLED", + "tags": [ + "status_cancelled", + "shippingorderitem.status_cancelled" + ], + "title": "ShippingOrderItem.STATUS_CANCELLED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "shippingorderitem.status_confirmed" + ], + "title": "ShippingOrderItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CONFIRMED", + "tags": [ + "status_confirmed", + "shippingorderitem.status_confirmed" + ], + "title": "ShippingOrderItem.STATUS_CONFIRMED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "shippingorderitem.status_shipped" + ], + "title": "ShippingOrderItem.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_SHIPPED", + "tags": [ + "status_shipped", + "shippingorderitem.status_shipped" + ], + "title": "ShippingOrderItem.STATUS_SHIPPED" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "shippingorderitem.status_warehouse" + ], + "title": "ShippingOrderItem.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_WAREHOUSE", + "tags": [ + "status_warehouse", + "shippingorderitem.status_warehouse" + ], + "title": "ShippingOrderItem.STATUS_WAREHOUSE" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#addTrackingRef", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.addTrackingRef", + "tags": [ + "addtrackingref", + "shippingorderitem.addtrackingref" + ], + "title": "ShippingOrderItem.addTrackingRef" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#applyPriceRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.applyPriceRate", + "tags": [ + "applypricerate", + "shippingorderitem.applypricerate" + ], + "title": "ShippingOrderItem.applyPriceRate" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.basePrice", + "tags": [ + "baseprice", + "shippingorderitem.baseprice" + ], + "title": "ShippingOrderItem.basePrice" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getBasePrice", + "tags": [ + "getbaseprice", + "shippingorderitem.getbaseprice" + ], + "title": "ShippingOrderItem.getBasePrice" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getParentItem", + "tags": [ + "getparentitem", + "shippingorderitem.getparentitem" + ], + "title": "ShippingOrderItem.getParentItem" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getQuantity", + "tags": [ + "getquantity", + "shippingorderitem.getquantity" + ], + "title": "ShippingOrderItem.getQuantity" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getShippingOrderNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getShippingOrderNumber", + "tags": [ + "getshippingordernumber", + "shippingorderitem.getshippingordernumber" + ], + "title": "ShippingOrderItem.getShippingOrderNumber" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getStatus", + "tags": [ + "getstatus", + "shippingorderitem.getstatus" + ], + "title": "ShippingOrderItem.getStatus" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#getTrackingRefs", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getTrackingRefs", + "tags": [ + "gettrackingrefs", + "shippingorderitem.gettrackingrefs" + ], + "title": "ShippingOrderItem.getTrackingRefs" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.parentItem", + "tags": [ + "parentitem", + "shippingorderitem.parentitem" + ], + "title": "ShippingOrderItem.parentItem" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.quantity", + "tags": [ + "quantity", + "shippingorderitem.quantity" + ], + "title": "ShippingOrderItem.quantity" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.setParentItem", + "tags": [ + "setparentitem", + "shippingorderitem.setparentitem" + ], + "title": "ShippingOrderItem.setParentItem" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.setStatus", + "tags": [ + "setstatus", + "shippingorderitem.setstatus" + ], + "title": "ShippingOrderItem.setStatus" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#shippingOrderNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.shippingOrderNumber", + "tags": [ + "shippingordernumber", + "shippingorderitem.shippingordernumber" + ], + "title": "ShippingOrderItem.shippingOrderNumber" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#split", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.split", + "tags": [ + "split", + "shippingorderitem.split" + ], + "title": "ShippingOrderItem.split" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#split", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.split", + "tags": [ + "split", + "shippingorderitem.split" + ], + "title": "ShippingOrderItem.split" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.status", + "tags": [ + "status", + "shippingorderitem.status" + ], + "title": "ShippingOrderItem.status" + }, + { + "id": "script-api:dw/order/ShippingOrderItem#trackingRefs", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.trackingRefs", + "tags": [ + "trackingrefs", + "shippingorderitem.trackingrefs" + ], + "title": "ShippingOrderItem.trackingRefs" + }, + { + "id": "script-api:dw/order/SumItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.SumItem", + "tags": [ + "sumitem", + "dw.order.sumitem", + "dw/order" + ], + "title": "SumItem" + }, + { + "id": "script-api:dw/order/SumItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getGrossPrice", + "tags": [ + "getgrossprice", + "sumitem.getgrossprice" + ], + "title": "SumItem.getGrossPrice" + }, + { + "id": "script-api:dw/order/SumItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getNetPrice", + "tags": [ + "getnetprice", + "sumitem.getnetprice" + ], + "title": "SumItem.getNetPrice" + }, + { + "id": "script-api:dw/order/SumItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTax", + "tags": [ + "gettax", + "sumitem.gettax" + ], + "title": "SumItem.getTax" + }, + { + "id": "script-api:dw/order/SumItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTaxBasis", + "tags": [ + "gettaxbasis", + "sumitem.gettaxbasis" + ], + "title": "SumItem.getTaxBasis" + }, + { + "id": "script-api:dw/order/SumItem#getTaxItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTaxItems", + "tags": [ + "gettaxitems", + "sumitem.gettaxitems" + ], + "title": "SumItem.getTaxItems" + }, + { + "id": "script-api:dw/order/SumItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.grossPrice", + "tags": [ + "grossprice", + "sumitem.grossprice" + ], + "title": "SumItem.grossPrice" + }, + { + "id": "script-api:dw/order/SumItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.netPrice", + "tags": [ + "netprice", + "sumitem.netprice" + ], + "title": "SumItem.netPrice" + }, + { + "id": "script-api:dw/order/SumItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.tax", + "tags": [ + "tax", + "sumitem.tax" + ], + "title": "SumItem.tax" + }, + { + "id": "script-api:dw/order/SumItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.taxBasis", + "tags": [ + "taxbasis", + "sumitem.taxbasis" + ], + "title": "SumItem.taxBasis" + }, + { + "id": "script-api:dw/order/SumItem#taxItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.taxItems", + "tags": [ + "taxitems", + "sumitem.taxitems" + ], + "title": "SumItem.taxItems" + }, + { + "id": "script-api:dw/order/TaxGroup", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxGroup", + "tags": [ + "taxgroup", + "dw.order.taxgroup", + "dw/order" + ], + "title": "TaxGroup" + }, + { + "id": "script-api:dw/order/TaxGroup#caption", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.caption", + "tags": [ + "caption", + "taxgroup.caption" + ], + "title": "TaxGroup.caption" + }, + { + "id": "script-api:dw/order/TaxGroup#create", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.create", + "tags": [ + "create", + "taxgroup.create" + ], + "title": "TaxGroup.create" + }, + { + "id": "script-api:dw/order/TaxGroup#create", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.create", + "tags": [ + "create", + "taxgroup.create" + ], + "title": "TaxGroup.create" + }, + { + "id": "script-api:dw/order/TaxGroup#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.description", + "tags": [ + "description", + "taxgroup.description" + ], + "title": "TaxGroup.description" + }, + { + "id": "script-api:dw/order/TaxGroup#getCaption", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getCaption", + "tags": [ + "getcaption", + "taxgroup.getcaption" + ], + "title": "TaxGroup.getCaption" + }, + { + "id": "script-api:dw/order/TaxGroup#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getDescription", + "tags": [ + "getdescription", + "taxgroup.getdescription" + ], + "title": "TaxGroup.getDescription" + }, + { + "id": "script-api:dw/order/TaxGroup#getRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getRate", + "tags": [ + "getrate", + "taxgroup.getrate" + ], + "title": "TaxGroup.getRate" + }, + { + "id": "script-api:dw/order/TaxGroup#getTaxType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getTaxType", + "tags": [ + "gettaxtype", + "taxgroup.gettaxtype" + ], + "title": "TaxGroup.getTaxType" + }, + { + "id": "script-api:dw/order/TaxGroup#rate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.rate", + "tags": [ + "rate", + "taxgroup.rate" + ], + "title": "TaxGroup.rate" + }, + { + "id": "script-api:dw/order/TaxGroup#taxType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.taxType", + "tags": [ + "taxtype", + "taxgroup.taxtype" + ], + "title": "TaxGroup.taxType" + }, + { + "id": "script-api:dw/order/TaxItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxItem", + "tags": [ + "taxitem", + "dw.order.taxitem", + "dw/order" + ], + "title": "TaxItem" + }, + { + "id": "script-api:dw/order/TaxItem#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.amount", + "tags": [ + "amount", + "taxitem.amount" + ], + "title": "TaxItem.amount" + }, + { + "id": "script-api:dw/order/TaxItem#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.getAmount", + "tags": [ + "getamount", + "taxitem.getamount" + ], + "title": "TaxItem.getAmount" + }, + { + "id": "script-api:dw/order/TaxItem#getTaxGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.getTaxGroup", + "tags": [ + "gettaxgroup", + "taxitem.gettaxgroup" + ], + "title": "TaxItem.getTaxGroup" + }, + { + "id": "script-api:dw/order/TaxItem#taxGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.taxGroup", + "tags": [ + "taxgroup", + "taxitem.taxgroup" + ], + "title": "TaxItem.taxGroup" + }, + { + "id": "script-api:dw/order/TaxMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxMgr", + "tags": [ + "taxmgr", + "dw.order.taxmgr", + "dw/order" + ], + "title": "TaxMgr" + }, + { + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_GROSS", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_GROSS", + "tags": [ + "tax_policy_gross", + "taxmgr.tax_policy_gross" + ], + "title": "TaxMgr.TAX_POLICY_GROSS" + }, + { + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_GROSS", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_GROSS", + "tags": [ + "tax_policy_gross", + "taxmgr.tax_policy_gross" + ], + "title": "TaxMgr.TAX_POLICY_GROSS" + }, + { + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_NET", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_NET", + "tags": [ + "tax_policy_net", + "taxmgr.tax_policy_net" + ], + "title": "TaxMgr.TAX_POLICY_NET" + }, + { + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_NET", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_NET", + "tags": [ + "tax_policy_net", + "taxmgr.tax_policy_net" + ], + "title": "TaxMgr.TAX_POLICY_NET" + }, + { + "id": "script-api:dw/order/TaxMgr#applyExternalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyExternalTax", + "tags": [ + "applyexternaltax", + "taxmgr.applyexternaltax" + ], + "title": "TaxMgr.applyExternalTax" + }, + { + "id": "script-api:dw/order/TaxMgr#applyExternalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyExternalTax", + "tags": [ + "applyexternaltax", + "taxmgr.applyexternaltax" + ], + "title": "TaxMgr.applyExternalTax" + }, + { + "id": "script-api:dw/order/TaxMgr#applyTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyTax", + "tags": [ + "applytax", + "taxmgr.applytax" + ], + "title": "TaxMgr.applyTax" + }, + { + "id": "script-api:dw/order/TaxMgr#applyTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyTax", + "tags": [ + "applytax", + "taxmgr.applytax" + ], + "title": "TaxMgr.applyTax" + }, + { + "id": "script-api:dw/order/TaxMgr#customRateTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.customRateTaxClassID", + "tags": [ + "customratetaxclassid", + "taxmgr.customratetaxclassid" + ], + "title": "TaxMgr.customRateTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#customRateTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.customRateTaxClassID", + "tags": [ + "customratetaxclassid", + "taxmgr.customratetaxclassid" + ], + "title": "TaxMgr.customRateTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#defaultTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxClassID", + "tags": [ + "defaulttaxclassid", + "taxmgr.defaulttaxclassid" + ], + "title": "TaxMgr.defaultTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#defaultTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxClassID", + "tags": [ + "defaulttaxclassid", + "taxmgr.defaulttaxclassid" + ], + "title": "TaxMgr.defaultTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#defaultTaxJurisdictionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxJurisdictionID", + "tags": [ + "defaulttaxjurisdictionid", + "taxmgr.defaulttaxjurisdictionid" + ], + "title": "TaxMgr.defaultTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#defaultTaxJurisdictionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxJurisdictionID", + "tags": [ + "defaulttaxjurisdictionid", + "taxmgr.defaulttaxjurisdictionid" + ], + "title": "TaxMgr.defaultTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#getCustomRateTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getCustomRateTaxClassID", + "tags": [ + "getcustomratetaxclassid", + "taxmgr.getcustomratetaxclassid" + ], + "title": "TaxMgr.getCustomRateTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getCustomRateTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getCustomRateTaxClassID", + "tags": [ + "getcustomratetaxclassid", + "taxmgr.getcustomratetaxclassid" + ], + "title": "TaxMgr.getCustomRateTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getDefaultTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxClassID", + "tags": [ + "getdefaulttaxclassid", + "taxmgr.getdefaulttaxclassid" + ], + "title": "TaxMgr.getDefaultTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getDefaultTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxClassID", + "tags": [ + "getdefaulttaxclassid", + "taxmgr.getdefaulttaxclassid" + ], + "title": "TaxMgr.getDefaultTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getDefaultTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxJurisdictionID", + "tags": [ + "getdefaulttaxjurisdictionid", + "taxmgr.getdefaulttaxjurisdictionid" + ], + "title": "TaxMgr.getDefaultTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#getDefaultTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxJurisdictionID", + "tags": [ + "getdefaulttaxjurisdictionid", + "taxmgr.getdefaulttaxjurisdictionid" + ], + "title": "TaxMgr.getDefaultTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxExemptTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxExemptTaxClassID", + "tags": [ + "gettaxexempttaxclassid", + "taxmgr.gettaxexempttaxclassid" + ], + "title": "TaxMgr.getTaxExemptTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxExemptTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxExemptTaxClassID", + "tags": [ + "gettaxexempttaxclassid", + "taxmgr.gettaxexempttaxclassid" + ], + "title": "TaxMgr.getTaxExemptTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxJurisdictionID", + "tags": [ + "gettaxjurisdictionid", + "taxmgr.gettaxjurisdictionid" + ], + "title": "TaxMgr.getTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxJurisdictionID", + "tags": [ + "gettaxjurisdictionid", + "taxmgr.gettaxjurisdictionid" + ], + "title": "TaxMgr.getTaxJurisdictionID" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxRate", + "tags": [ + "gettaxrate", + "taxmgr.gettaxrate" + ], + "title": "TaxMgr.getTaxRate" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxRate", + "tags": [ + "gettaxrate", + "taxmgr.gettaxrate" + ], + "title": "TaxMgr.getTaxRate" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxationPolicy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxationPolicy", + "tags": [ + "gettaxationpolicy", + "taxmgr.gettaxationpolicy" + ], + "title": "TaxMgr.getTaxationPolicy" + }, + { + "id": "script-api:dw/order/TaxMgr#getTaxationPolicy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxationPolicy", + "tags": [ + "gettaxationpolicy", + "taxmgr.gettaxationpolicy" + ], + "title": "TaxMgr.getTaxationPolicy" + }, + { + "id": "script-api:dw/order/TaxMgr#taxExemptTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxExemptTaxClassID", + "tags": [ + "taxexempttaxclassid", + "taxmgr.taxexempttaxclassid" + ], + "title": "TaxMgr.taxExemptTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#taxExemptTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxExemptTaxClassID", + "tags": [ + "taxexempttaxclassid", + "taxmgr.taxexempttaxclassid" + ], + "title": "TaxMgr.taxExemptTaxClassID" + }, + { + "id": "script-api:dw/order/TaxMgr#taxationPolicy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxationPolicy", + "tags": [ + "taxationpolicy", + "taxmgr.taxationpolicy" + ], + "title": "TaxMgr.taxationPolicy" + }, + { + "id": "script-api:dw/order/TaxMgr#taxationPolicy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxationPolicy", + "tags": [ + "taxationpolicy", + "taxmgr.taxationpolicy" + ], + "title": "TaxMgr.taxationPolicy" + }, + { + "id": "script-api:dw/order/TrackingInfo", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TrackingInfo", + "tags": [ + "trackinginfo", + "dw.order.trackinginfo", + "dw/order" + ], + "title": "TrackingInfo" + }, + { + "id": "script-api:dw/order/TrackingInfo#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.ID", + "tags": [ + "id", + "trackinginfo.id" + ], + "title": "TrackingInfo.ID" + }, + { + "id": "script-api:dw/order/TrackingInfo#carrier", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.carrier", + "tags": [ + "carrier", + "trackinginfo.carrier" + ], + "title": "TrackingInfo.carrier" + }, + { + "id": "script-api:dw/order/TrackingInfo#carrierService", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.carrierService", + "tags": [ + "carrierservice", + "trackinginfo.carrierservice" + ], + "title": "TrackingInfo.carrierService" + }, + { + "id": "script-api:dw/order/TrackingInfo#getCarrier", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getCarrier", + "tags": [ + "getcarrier", + "trackinginfo.getcarrier" + ], + "title": "TrackingInfo.getCarrier" + }, + { + "id": "script-api:dw/order/TrackingInfo#getCarrierService", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getCarrierService", + "tags": [ + "getcarrierservice", + "trackinginfo.getcarrierservice" + ], + "title": "TrackingInfo.getCarrierService" + }, + { + "id": "script-api:dw/order/TrackingInfo#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getID", + "tags": [ + "getid", + "trackinginfo.getid" + ], + "title": "TrackingInfo.getID" + }, + { + "id": "script-api:dw/order/TrackingInfo#getShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getShipDate", + "tags": [ + "getshipdate", + "trackinginfo.getshipdate" + ], + "title": "TrackingInfo.getShipDate" + }, + { + "id": "script-api:dw/order/TrackingInfo#getShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getShippingOrder", + "tags": [ + "getshippingorder", + "trackinginfo.getshippingorder" + ], + "title": "TrackingInfo.getShippingOrder" + }, + { + "id": "script-api:dw/order/TrackingInfo#getTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getTrackingNumber", + "tags": [ + "gettrackingnumber", + "trackinginfo.gettrackingnumber" + ], + "title": "TrackingInfo.getTrackingNumber" + }, + { + "id": "script-api:dw/order/TrackingInfo#getTrackingRefs", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getTrackingRefs", + "tags": [ + "gettrackingrefs", + "trackinginfo.gettrackingrefs" + ], + "title": "TrackingInfo.getTrackingRefs" + }, + { + "id": "script-api:dw/order/TrackingInfo#getWarehouseID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getWarehouseID", + "tags": [ + "getwarehouseid", + "trackinginfo.getwarehouseid" + ], + "title": "TrackingInfo.getWarehouseID" + }, + { + "id": "script-api:dw/order/TrackingInfo#setCarrier", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setCarrier", + "tags": [ + "setcarrier", + "trackinginfo.setcarrier" + ], + "title": "TrackingInfo.setCarrier" + }, + { + "id": "script-api:dw/order/TrackingInfo#setCarrierService", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setCarrierService", + "tags": [ + "setcarrierservice", + "trackinginfo.setcarrierservice" + ], + "title": "TrackingInfo.setCarrierService" + }, + { + "id": "script-api:dw/order/TrackingInfo#setShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setShipDate", + "tags": [ + "setshipdate", + "trackinginfo.setshipdate" + ], + "title": "TrackingInfo.setShipDate" + }, + { + "id": "script-api:dw/order/TrackingInfo#setTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setTrackingNumber", + "tags": [ + "settrackingnumber", + "trackinginfo.settrackingnumber" + ], + "title": "TrackingInfo.setTrackingNumber" + }, + { + "id": "script-api:dw/order/TrackingInfo#setWarehouseID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setWarehouseID", + "tags": [ + "setwarehouseid", + "trackinginfo.setwarehouseid" + ], + "title": "TrackingInfo.setWarehouseID" + }, + { + "id": "script-api:dw/order/TrackingInfo#shipDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.shipDate", + "tags": [ + "shipdate", + "trackinginfo.shipdate" + ], + "title": "TrackingInfo.shipDate" + }, + { + "id": "script-api:dw/order/TrackingInfo#shippingOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.shippingOrder", + "tags": [ + "shippingorder", + "trackinginfo.shippingorder" + ], + "title": "TrackingInfo.shippingOrder" + }, + { + "id": "script-api:dw/order/TrackingInfo#trackingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.trackingNumber", + "tags": [ + "trackingnumber", + "trackinginfo.trackingnumber" + ], + "title": "TrackingInfo.trackingNumber" + }, + { + "id": "script-api:dw/order/TrackingInfo#trackingRefs", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.trackingRefs", + "tags": [ + "trackingrefs", + "trackinginfo.trackingrefs" + ], + "title": "TrackingInfo.trackingRefs" + }, + { + "id": "script-api:dw/order/TrackingInfo#warehouseID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.warehouseID", + "tags": [ + "warehouseid", + "trackinginfo.warehouseid" + ], + "title": "TrackingInfo.warehouseID" + }, + { + "id": "script-api:dw/order/TrackingRef", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TrackingRef", + "tags": [ + "trackingref", + "dw.order.trackingref", + "dw/order" + ], + "title": "TrackingRef" + }, + { + "id": "script-api:dw/order/TrackingRef#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getQuantity", + "tags": [ + "getquantity", + "trackingref.getquantity" + ], + "title": "TrackingRef.getQuantity" + }, + { + "id": "script-api:dw/order/TrackingRef#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getShippingOrderItem", + "tags": [ + "getshippingorderitem", + "trackingref.getshippingorderitem" + ], + "title": "TrackingRef.getShippingOrderItem" + }, + { + "id": "script-api:dw/order/TrackingRef#getTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getTrackingInfo", + "tags": [ + "gettrackinginfo", + "trackingref.gettrackinginfo" + ], + "title": "TrackingRef.getTrackingInfo" + }, + { + "id": "script-api:dw/order/TrackingRef#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.quantity", + "tags": [ + "quantity", + "trackingref.quantity" + ], + "title": "TrackingRef.quantity" + }, + { + "id": "script-api:dw/order/TrackingRef#setQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.setQuantity", + "tags": [ + "setquantity", + "trackingref.setquantity" + ], + "title": "TrackingRef.setQuantity" + }, + { + "id": "script-api:dw/order/TrackingRef#shippingOrderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.shippingOrderItem", + "tags": [ + "shippingorderitem", + "trackingref.shippingorderitem" + ], + "title": "TrackingRef.shippingOrderItem" + }, + { + "id": "script-api:dw/order/TrackingRef#trackingInfo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.trackingInfo", + "tags": [ + "trackinginfo", + "trackingref.trackinginfo" + ], + "title": "TrackingRef.trackingInfo" + }, + { + "id": "script-api:dw/order/hooks", + "kind": "package", + "packagePath": "dw/order/hooks", + "qualifiedName": "dw.order.hooks", + "tags": [ + "dw/order/hooks", + "dw.order.hooks" + ], + "title": "dw.order.hooks" + }, + { + "id": "script-api:dw/order/hooks/BasketMergeHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks", + "tags": [ + "basketmergehooks", + "dw.order.hooks.basketmergehooks", + "dw/order/hooks" + ], + "title": "BasketMergeHooks" + }, + { + "id": "script-api:dw/order/hooks/BasketMergeHooks#extensionPointMerge", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/BasketMergeHooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks.extensionPointMerge", + "tags": [ + "extensionpointmerge", + "basketmergehooks.extensionpointmerge" + ], + "title": "BasketMergeHooks.extensionPointMerge" + }, + { + "id": "script-api:dw/order/hooks/BasketMergeHooks#mergeBasket", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/BasketMergeHooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks.mergeBasket", + "tags": [ + "mergebasket", + "basketmergehooks.mergebasket" + ], + "title": "BasketMergeHooks.mergeBasket" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.CalculateHooks", + "tags": [ + "calculatehooks", + "dw.order.hooks.calculatehooks", + "dw/order/hooks" + ], + "title": "CalculateHooks" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#calculate", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculate", + "tags": [ + "calculate", + "calculatehooks.calculate" + ], + "title": "CalculateHooks.calculate" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#calculateShipping", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculateShipping", + "tags": [ + "calculateshipping", + "calculatehooks.calculateshipping" + ], + "title": "CalculateHooks.calculateShipping" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#calculateTax", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculateTax", + "tags": [ + "calculatetax", + "calculatehooks.calculatetax" + ], + "title": "CalculateHooks.calculateTax" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculate", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculate", + "tags": [ + "extensionpointcalculate", + "calculatehooks.extensionpointcalculate" + ], + "title": "CalculateHooks.extensionPointCalculate" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculateShipping", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculateShipping", + "tags": [ + "extensionpointcalculateshipping", + "calculatehooks.extensionpointcalculateshipping" + ], + "title": "CalculateHooks.extensionPointCalculateShipping" + }, + { + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculateTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculateTax", + "tags": [ + "extensionpointcalculatetax", + "calculatehooks.extensionpointcalculatetax" + ], + "title": "CalculateHooks.extensionPointCalculateTax" + }, + { + "id": "script-api:dw/order/hooks/CheckoutHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks", + "tags": [ + "checkouthooks", + "dw.order.hooks.checkouthooks", + "dw/order/hooks" + ], + "title": "CheckoutHooks" + }, + { + "id": "script-api:dw/order/hooks/CheckoutHooks#extensionPointPopulateCustomerDetails", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CheckoutHooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks.extensionPointPopulateCustomerDetails", + "tags": [ + "extensionpointpopulatecustomerdetails", + "checkouthooks.extensionpointpopulatecustomerdetails" + ], + "title": "CheckoutHooks.extensionPointPopulateCustomerDetails" + }, + { + "id": "script-api:dw/order/hooks/CheckoutHooks#populateCustomerDetails", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CheckoutHooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks.populateCustomerDetails", + "tags": [ + "populatecustomerdetails", + "checkouthooks.populatecustomerdetails" + ], + "title": "CheckoutHooks.populateCustomerDetails" + }, + { + "id": "script-api:dw/order/hooks/OrderHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.OrderHooks", + "tags": [ + "orderhooks", + "dw.order.hooks.orderhooks", + "dw/order/hooks" + ], + "title": "OrderHooks" + }, + { + "id": "script-api:dw/order/hooks/OrderHooks#createOrderNo", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/OrderHooks", + "qualifiedName": "dw.order.hooks.OrderHooks.createOrderNo", + "tags": [ + "createorderno", + "orderhooks.createorderno" + ], + "title": "OrderHooks.createOrderNo" + }, + { + "id": "script-api:dw/order/hooks/OrderHooks#extensionPointCreateOrderNo", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/OrderHooks", + "qualifiedName": "dw.order.hooks.OrderHooks.extensionPointCreateOrderNo", + "tags": [ + "extensionpointcreateorderno", + "orderhooks.extensionpointcreateorderno" + ], + "title": "OrderHooks.extensionPointCreateOrderNo" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.PaymentHooks", + "tags": [ + "paymenthooks", + "dw.order.hooks.paymenthooks", + "dw/order/hooks" + ], + "title": "PaymentHooks" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#authorize", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.authorize", + "tags": [ + "authorize", + "paymenthooks.authorize" + ], + "title": "PaymentHooks.authorize" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#authorizeCreditCard", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.authorizeCreditCard", + "tags": [ + "authorizecreditcard", + "paymenthooks.authorizecreditcard" + ], + "title": "PaymentHooks.authorizeCreditCard" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#capture", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.capture", + "tags": [ + "capture", + "paymenthooks.capture" + ], + "title": "PaymentHooks.capture" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointAuthorize", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointAuthorize", + "tags": [ + "extensionpointauthorize", + "paymenthooks.extensionpointauthorize" + ], + "title": "PaymentHooks.extensionPointAuthorize" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointAuthorizeCreditCard", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointAuthorizeCreditCard", + "tags": [ + "extensionpointauthorizecreditcard", + "paymenthooks.extensionpointauthorizecreditcard" + ], + "title": "PaymentHooks.extensionPointAuthorizeCreditCard" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointCapture", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointCapture", + "tags": [ + "extensionpointcapture", + "paymenthooks.extensionpointcapture" + ], + "title": "PaymentHooks.extensionPointCapture" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointReauthorize", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointReauthorize", + "tags": [ + "extensionpointreauthorize", + "paymenthooks.extensionpointreauthorize" + ], + "title": "PaymentHooks.extensionPointReauthorize" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointRefund", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointRefund", + "tags": [ + "extensionpointrefund", + "paymenthooks.extensionpointrefund" + ], + "title": "PaymentHooks.extensionPointRefund" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointReleaseAuthorization", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointReleaseAuthorization", + "tags": [ + "extensionpointreleaseauthorization", + "paymenthooks.extensionpointreleaseauthorization" + ], + "title": "PaymentHooks.extensionPointReleaseAuthorization" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointValidateAuthorization", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointValidateAuthorization", + "tags": [ + "extensionpointvalidateauthorization", + "paymenthooks.extensionpointvalidateauthorization" + ], + "title": "PaymentHooks.extensionPointValidateAuthorization" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#reauthorize", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.reauthorize", + "tags": [ + "reauthorize", + "paymenthooks.reauthorize" + ], + "title": "PaymentHooks.reauthorize" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#refund", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.refund", + "tags": [ + "refund", + "paymenthooks.refund" + ], + "title": "PaymentHooks.refund" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#releaseAuthorization", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.releaseAuthorization", + "tags": [ + "releaseauthorization", + "paymenthooks.releaseauthorization" + ], + "title": "PaymentHooks.releaseAuthorization" + }, + { + "id": "script-api:dw/order/hooks/PaymentHooks#validateAuthorization", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.validateAuthorization", + "tags": [ + "validateauthorization", + "paymenthooks.validateauthorization" + ], + "title": "PaymentHooks.validateAuthorization" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.ReturnHooks", + "tags": [ + "returnhooks", + "dw.order.hooks.returnhooks", + "dw/order/hooks" + ], + "title": "ReturnHooks" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#addReturnItem", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.addReturnItem", + "tags": [ + "addreturnitem", + "returnhooks.addreturnitem" + ], + "title": "ReturnHooks.addReturnItem" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#afterStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.afterStatusChange", + "tags": [ + "afterstatuschange", + "returnhooks.afterstatuschange" + ], + "title": "ReturnHooks.afterStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#changeStatus", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.changeStatus", + "tags": [ + "changestatus", + "returnhooks.changestatus" + ], + "title": "ReturnHooks.changeStatus" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#createReturn", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.createReturn", + "tags": [ + "createreturn", + "returnhooks.createreturn" + ], + "title": "ReturnHooks.createReturn" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointAddReturnItem", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointAddReturnItem", + "tags": [ + "extensionpointaddreturnitem", + "returnhooks.extensionpointaddreturnitem" + ], + "title": "ReturnHooks.extensionPointAddReturnItem" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointAfterStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointAfterStatusChange", + "tags": [ + "extensionpointafterstatuschange", + "returnhooks.extensionpointafterstatuschange" + ], + "title": "ReturnHooks.extensionPointAfterStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointChangeStatus", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointChangeStatus", + "tags": [ + "extensionpointchangestatus", + "returnhooks.extensionpointchangestatus" + ], + "title": "ReturnHooks.extensionPointChangeStatus" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointCreateReturn", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointCreateReturn", + "tags": [ + "extensionpointcreatereturn", + "returnhooks.extensionpointcreatereturn" + ], + "title": "ReturnHooks.extensionPointCreateReturn" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointNotifyStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointNotifyStatusChange", + "tags": [ + "extensionpointnotifystatuschange", + "returnhooks.extensionpointnotifystatuschange" + ], + "title": "ReturnHooks.extensionPointNotifyStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ReturnHooks#notifyStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.notifyStatusChange", + "tags": [ + "notifystatuschange", + "returnhooks.notifystatuschange" + ], + "title": "ReturnHooks.notifyStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks", + "tags": [ + "shippingorderhooks", + "dw.order.hooks.shippingorderhooks", + "dw/order/hooks" + ], + "title": "ShippingOrderHooks" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#afterStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.afterStatusChange", + "tags": [ + "afterstatuschange", + "shippingorderhooks.afterstatuschange" + ], + "title": "ShippingOrderHooks.afterStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#changeStatus", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.changeStatus", + "tags": [ + "changestatus", + "shippingorderhooks.changestatus" + ], + "title": "ShippingOrderHooks.changeStatus" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#createShippingOrders", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.createShippingOrders", + "tags": [ + "createshippingorders", + "shippingorderhooks.createshippingorders" + ], + "title": "ShippingOrderHooks.createShippingOrders" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointAfterStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointAfterStatusChange", + "tags": [ + "extensionpointafterstatuschange", + "shippingorderhooks.extensionpointafterstatuschange" + ], + "title": "ShippingOrderHooks.extensionPointAfterStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointChangeStatus", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointChangeStatus", + "tags": [ + "extensionpointchangestatus", + "shippingorderhooks.extensionpointchangestatus" + ], + "title": "ShippingOrderHooks.extensionPointChangeStatus" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointCreateShippingOrders", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointCreateShippingOrders", + "tags": [ + "extensionpointcreateshippingorders", + "shippingorderhooks.extensionpointcreateshippingorders" + ], + "title": "ShippingOrderHooks.extensionPointCreateShippingOrders" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointNotifyStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointNotifyStatusChange", + "tags": [ + "extensionpointnotifystatuschange", + "shippingorderhooks.extensionpointnotifystatuschange" + ], + "title": "ShippingOrderHooks.extensionPointNotifyStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointPrepareCreateShippingOrders", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointPrepareCreateShippingOrders", + "tags": [ + "extensionpointpreparecreateshippingorders", + "shippingorderhooks.extensionpointpreparecreateshippingorders" + ], + "title": "ShippingOrderHooks.extensionPointPrepareCreateShippingOrders" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointResolveShippingOrder", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointResolveShippingOrder", + "tags": [ + "extensionpointresolveshippingorder", + "shippingorderhooks.extensionpointresolveshippingorder" + ], + "title": "ShippingOrderHooks.extensionPointResolveShippingOrder" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderCancelled", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderCancelled", + "tags": [ + "extensionpointshippingordercancelled", + "shippingorderhooks.extensionpointshippingordercancelled" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderCancelled" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderShipped", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderShipped", + "tags": [ + "extensionpointshippingordershipped", + "shippingorderhooks.extensionpointshippingordershipped" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderShipped" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderWarehouse", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderWarehouse", + "tags": [ + "extensionpointshippingorderwarehouse", + "shippingorderhooks.extensionpointshippingorderwarehouse" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderWarehouse" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointUpdateShippingOrderItem", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointUpdateShippingOrderItem", + "tags": [ + "extensionpointupdateshippingorderitem", + "shippingorderhooks.extensionpointupdateshippingorderitem" + ], + "title": "ShippingOrderHooks.extensionPointUpdateShippingOrderItem" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#notifyStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.notifyStatusChange", + "tags": [ + "notifystatuschange", + "shippingorderhooks.notifystatuschange" + ], + "title": "ShippingOrderHooks.notifyStatusChange" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#prepareCreateShippingOrders", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.prepareCreateShippingOrders", + "tags": [ + "preparecreateshippingorders", + "shippingorderhooks.preparecreateshippingorders" + ], + "title": "ShippingOrderHooks.prepareCreateShippingOrders" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#resolveShippingOrder", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.resolveShippingOrder", + "tags": [ + "resolveshippingorder", + "shippingorderhooks.resolveshippingorder" + ], + "title": "ShippingOrderHooks.resolveShippingOrder" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderCancelled", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderCancelled", + "tags": [ + "setshippingordercancelled", + "shippingorderhooks.setshippingordercancelled" + ], + "title": "ShippingOrderHooks.setShippingOrderCancelled" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderShipped", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderShipped", + "tags": [ + "setshippingordershipped", + "shippingorderhooks.setshippingordershipped" + ], + "title": "ShippingOrderHooks.setShippingOrderShipped" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderWarehouse", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderWarehouse", + "tags": [ + "setshippingorderwarehouse", + "shippingorderhooks.setshippingorderwarehouse" + ], + "title": "ShippingOrderHooks.setShippingOrderWarehouse" + }, + { + "id": "script-api:dw/order/hooks/ShippingOrderHooks#updateShippingOrderItem", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.updateShippingOrderItem", + "tags": [ + "updateshippingorderitem", + "shippingorderhooks.updateshippingorderitem" + ], + "title": "ShippingOrderHooks.updateShippingOrderItem" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.TaxHooks", + "tags": [ + "taxhooks", + "dw.order.hooks.taxhooks", + "dw/order/hooks" + ], + "title": "TaxHooks" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#calculate", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.calculate", + "tags": [ + "calculate", + "taxhooks.calculate" + ], + "title": "TaxHooks.calculate" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#cancel", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.cancel", + "tags": [ + "cancel", + "taxhooks.cancel" + ], + "title": "TaxHooks.cancel" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#commit", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.commit", + "tags": [ + "commit", + "taxhooks.commit" + ], + "title": "TaxHooks.commit" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCalculateTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCalculateTax", + "tags": [ + "extensionpointappcalculatetax", + "taxhooks.extensionpointappcalculatetax" + ], + "title": "TaxHooks.extensionPointAppCalculateTax" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCancelTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCancelTax", + "tags": [ + "extensionpointappcanceltax", + "taxhooks.extensionpointappcanceltax" + ], + "title": "TaxHooks.extensionPointAppCancelTax" + }, + { + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCommitTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCommitTax", + "tags": [ + "extensionpointappcommittax", + "taxhooks.extensionpointappcommittax" + ], + "title": "TaxHooks.extensionPointAppCommitTax" + }, + { + "id": "script-api:dw/rpc", + "kind": "package", + "packagePath": "dw/rpc", + "qualifiedName": "dw.rpc", + "tags": [ + "dw/rpc", + "dw.rpc" + ], + "title": "dw.rpc" + }, + { + "id": "script-api:dw/rpc/SOAPUtil", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.SOAPUtil", + "tags": [ + "soaputil", + "dw.rpc.soaputil", + "dw/rpc" + ], + "title": "SOAPUtil" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ACTION", + "tags": [ + "ws_action", + "soaputil.ws_action" + ], + "title": "SOAPUtil.WS_ACTION" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ACTION", + "tags": [ + "ws_action", + "soaputil.ws_action" + ], + "title": "SOAPUtil.WS_ACTION" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPT", + "tags": [ + "ws_encrypt", + "soaputil.ws_encrypt" + ], + "title": "SOAPUtil.WS_ENCRYPT" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPT", + "tags": [ + "ws_encrypt", + "soaputil.ws_encrypt" + ], + "title": "SOAPUtil.WS_ENCRYPT" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_PARTS", + "tags": [ + "ws_encryption_parts", + "soaputil.ws_encryption_parts" + ], + "title": "SOAPUtil.WS_ENCRYPTION_PARTS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_PARTS", + "tags": [ + "ws_encryption_parts", + "soaputil.ws_encryption_parts" + ], + "title": "SOAPUtil.WS_ENCRYPTION_PARTS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_USER", + "tags": [ + "ws_encryption_user", + "soaputil.ws_encryption_user" + ], + "title": "SOAPUtil.WS_ENCRYPTION_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_USER", + "tags": [ + "ws_encryption_user", + "soaputil.ws_encryption_user" + ], + "title": "SOAPUtil.WS_ENCRYPTION_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_enc_prop_keystore_alias", + "soaputil.ws_enc_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_enc_prop_keystore_alias", + "soaputil.ws_enc_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_PW", + "tags": [ + "ws_enc_prop_keystore_pw", + "soaputil.ws_enc_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_PW", + "tags": [ + "ws_enc_prop_keystore_pw", + "soaputil.ws_enc_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_enc_prop_keystore_type", + "soaputil.ws_enc_prop_keystore_type" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_enc_prop_keystore_type", + "soaputil.ws_enc_prop_keystore_type" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_NO_SECURITY", + "tags": [ + "ws_no_security", + "soaputil.ws_no_security" + ], + "title": "SOAPUtil.WS_NO_SECURITY" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_NO_SECURITY", + "tags": [ + "ws_no_security", + "soaputil.ws_no_security" + ], + "title": "SOAPUtil.WS_NO_SECURITY" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PASSWORD_TYPE", + "tags": [ + "ws_password_type", + "soaputil.ws_password_type" + ], + "title": "SOAPUtil.WS_PASSWORD_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PASSWORD_TYPE", + "tags": [ + "ws_password_type", + "soaputil.ws_password_type" + ], + "title": "SOAPUtil.WS_PASSWORD_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_DIGEST", + "tags": [ + "ws_pw_digest", + "soaputil.ws_pw_digest" + ], + "title": "SOAPUtil.WS_PW_DIGEST" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_DIGEST", + "tags": [ + "ws_pw_digest", + "soaputil.ws_pw_digest" + ], + "title": "SOAPUtil.WS_PW_DIGEST" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_TEXT", + "tags": [ + "ws_pw_text", + "soaputil.ws_pw_text" + ], + "title": "SOAPUtil.WS_PW_TEXT" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_TEXT", + "tags": [ + "ws_pw_text", + "soaputil.ws_pw_text" + ], + "title": "SOAPUtil.WS_PW_TEXT" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SECRETS_MAP", + "tags": [ + "ws_secrets_map", + "soaputil.ws_secrets_map" + ], + "title": "SOAPUtil.WS_SECRETS_MAP" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SECRETS_MAP", + "tags": [ + "ws_secrets_map", + "soaputil.ws_secrets_map" + ], + "title": "SOAPUtil.WS_SECRETS_MAP" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE", + "tags": [ + "ws_signature", + "soaputil.ws_signature" + ], + "title": "SOAPUtil.WS_SIGNATURE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE", + "tags": [ + "ws_signature", + "soaputil.ws_signature" + ], + "title": "SOAPUtil.WS_SIGNATURE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_PARTS", + "tags": [ + "ws_signature_parts", + "soaputil.ws_signature_parts" + ], + "title": "SOAPUtil.WS_SIGNATURE_PARTS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_PARTS", + "tags": [ + "ws_signature_parts", + "soaputil.ws_signature_parts" + ], + "title": "SOAPUtil.WS_SIGNATURE_PARTS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_USER", + "tags": [ + "ws_signature_user", + "soaputil.ws_signature_user" + ], + "title": "SOAPUtil.WS_SIGNATURE_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_USER", + "tags": [ + "ws_signature_user", + "soaputil.ws_signature_user" + ], + "title": "SOAPUtil.WS_SIGNATURE_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_DIGEST_ALGO", + "tags": [ + "ws_sig_digest_algo", + "soaputil.ws_sig_digest_algo" + ], + "title": "SOAPUtil.WS_SIG_DIGEST_ALGO" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_DIGEST_ALGO", + "tags": [ + "ws_sig_digest_algo", + "soaputil.ws_sig_digest_algo" + ], + "title": "SOAPUtil.WS_SIG_DIGEST_ALGO" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_sig_prop_keystore_alias", + "soaputil.ws_sig_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_sig_prop_keystore_alias", + "soaputil.ws_sig_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_PW", + "tags": [ + "ws_sig_prop_keystore_pw", + "soaputil.ws_sig_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_PW", + "tags": [ + "ws_sig_prop_keystore_pw", + "soaputil.ws_sig_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_sig_prop_keystore_type", + "soaputil.ws_sig_prop_keystore_type" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_sig_prop_keystore_type", + "soaputil.ws_sig_prop_keystore_type" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_TIMESTAMP", + "tags": [ + "ws_timestamp", + "soaputil.ws_timestamp" + ], + "title": "SOAPUtil.WS_TIMESTAMP" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_TIMESTAMP", + "tags": [ + "ws_timestamp", + "soaputil.ws_timestamp" + ], + "title": "SOAPUtil.WS_TIMESTAMP" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USER", + "tags": [ + "ws_user", + "soaputil.ws_user" + ], + "title": "SOAPUtil.WS_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USER", + "tags": [ + "ws_user", + "soaputil.ws_user" + ], + "title": "SOAPUtil.WS_USER" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USERNAME_TOKEN", + "tags": [ + "ws_username_token", + "soaputil.ws_username_token" + ], + "title": "SOAPUtil.WS_USERNAME_TOKEN" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USERNAME_TOKEN", + "tags": [ + "ws_username_token", + "soaputil.ws_username_token" + ], + "title": "SOAPUtil.WS_USERNAME_TOKEN" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPRequestHeader", + "tags": [ + "gethttprequestheader", + "soaputil.gethttprequestheader" + ], + "title": "SOAPUtil.getHTTPRequestHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPRequestHeader", + "tags": [ + "gethttprequestheader", + "soaputil.gethttprequestheader" + ], + "title": "SOAPUtil.getHTTPRequestHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#getHTTPResponseHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPResponseHeader", + "tags": [ + "gethttpresponseheader", + "soaputil.gethttpresponseheader" + ], + "title": "SOAPUtil.getHTTPResponseHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#getHTTPResponseHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPResponseHeader", + "tags": [ + "gethttpresponseheader", + "soaputil.gethttpresponseheader" + ], + "title": "SOAPUtil.getHTTPResponseHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHTTPRequestHeader", + "tags": [ + "sethttprequestheader", + "soaputil.sethttprequestheader" + ], + "title": "SOAPUtil.setHTTPRequestHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHTTPRequestHeader", + "tags": [ + "sethttprequestheader", + "soaputil.sethttprequestheader" + ], + "title": "SOAPUtil.setHTTPRequestHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setWSSecurityConfig", + "tags": [ + "setwssecurityconfig", + "soaputil.setwssecurityconfig" + ], + "title": "SOAPUtil.setWSSecurityConfig" + }, + { + "id": "script-api:dw/rpc/SOAPUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setWSSecurityConfig", + "tags": [ + "setwssecurityconfig", + "soaputil.setwssecurityconfig" + ], + "title": "SOAPUtil.setWSSecurityConfig" + }, + { + "id": "script-api:dw/rpc/Stub", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.Stub", + "tags": [ + "stub", + "dw.rpc.stub", + "dw/rpc" + ], + "title": "Stub" + }, + { + "id": "script-api:dw/rpc/Stub#CONNECTION_TIMEOUT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.CONNECTION_TIMEOUT", + "tags": [ + "connection_timeout", + "stub.connection_timeout" + ], + "title": "Stub.CONNECTION_TIMEOUT" + }, + { + "id": "script-api:dw/rpc/Stub#CONNECTION_TIMEOUT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.CONNECTION_TIMEOUT", + "tags": [ + "connection_timeout", + "stub.connection_timeout" + ], + "title": "Stub.CONNECTION_TIMEOUT" + }, + { + "id": "script-api:dw/rpc/Stub#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY", + "tags": [ + "endpoint_address_property", + "stub.endpoint_address_property" + ], + "title": "Stub.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY", + "tags": [ + "endpoint_address_property", + "stub.endpoint_address_property" + ], + "title": "Stub.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.PASSWORD_PROPERTY", + "tags": [ + "password_property", + "stub.password_property" + ], + "title": "Stub.PASSWORD_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.PASSWORD_PROPERTY", + "tags": [ + "password_property", + "stub.password_property" + ], + "title": "Stub.PASSWORD_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.SESSION_MAINTAIN_PROPERTY", + "tags": [ + "session_maintain_property", + "stub.session_maintain_property" + ], + "title": "Stub.SESSION_MAINTAIN_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.SESSION_MAINTAIN_PROPERTY", + "tags": [ + "session_maintain_property", + "stub.session_maintain_property" + ], + "title": "Stub.SESSION_MAINTAIN_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.USERNAME_PROPERTY", + "tags": [ + "username_property", + "stub.username_property" + ], + "title": "Stub.USERNAME_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.USERNAME_PROPERTY", + "tags": [ + "username_property", + "stub.username_property" + ], + "title": "Stub.USERNAME_PROPERTY" + }, + { + "id": "script-api:dw/rpc/Stub#_getProperty", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub._getProperty", + "tags": [ + "_getproperty", + "stub._getproperty" + ], + "title": "Stub._getProperty" + }, + { + "id": "script-api:dw/rpc/Stub#_setProperty", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub._setProperty", + "tags": [ + "_setproperty", + "stub._setproperty" + ], + "title": "Stub._setProperty" + }, + { + "id": "script-api:dw/rpc/Stub#getPassword", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getPassword", + "tags": [ + "getpassword", + "stub.getpassword" + ], + "title": "Stub.getPassword" + }, + { + "id": "script-api:dw/rpc/Stub#getTimeout", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getTimeout", + "tags": [ + "gettimeout", + "stub.gettimeout" + ], + "title": "Stub.getTimeout" + }, + { + "id": "script-api:dw/rpc/Stub#getUsername", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getUsername", + "tags": [ + "getusername", + "stub.getusername" + ], + "title": "Stub.getUsername" + }, + { + "id": "script-api:dw/rpc/Stub#password", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.password", + "tags": [ + "password", + "stub.password" + ], + "title": "Stub.password" + }, + { + "id": "script-api:dw/rpc/Stub#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setHeader", + "tags": [ + "setheader", + "stub.setheader" + ], + "title": "Stub.setHeader" + }, + { + "id": "script-api:dw/rpc/Stub#setPassword", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setPassword", + "tags": [ + "setpassword", + "stub.setpassword" + ], + "title": "Stub.setPassword" + }, + { + "id": "script-api:dw/rpc/Stub#setTimeout", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setTimeout", + "tags": [ + "settimeout", + "stub.settimeout" + ], + "title": "Stub.setTimeout" + }, + { + "id": "script-api:dw/rpc/Stub#setUsername", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setUsername", + "tags": [ + "setusername", + "stub.setusername" + ], + "title": "Stub.setUsername" + }, + { + "id": "script-api:dw/rpc/Stub#timeout", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.timeout", + "tags": [ + "timeout", + "stub.timeout" + ], + "title": "Stub.timeout" + }, + { + "id": "script-api:dw/rpc/Stub#username", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.username", + "tags": [ + "username", + "stub.username" + ], + "title": "Stub.username" + }, + { + "id": "script-api:dw/rpc/WebReference", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.WebReference", + "tags": [ + "webreference", + "dw.rpc.webreference", + "dw/rpc" + ], + "title": "WebReference" + }, + { + "id": "script-api:dw/rpc/WebReference#defaultService", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.defaultService", + "tags": [ + "defaultservice", + "webreference.defaultservice" + ], + "title": "WebReference.defaultService" + }, + { + "id": "script-api:dw/rpc/WebReference#getDefaultService", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.getDefaultService", + "tags": [ + "getdefaultservice", + "webreference.getdefaultservice" + ], + "title": "WebReference.getDefaultService" + }, + { + "id": "script-api:dw/rpc/WebReference#getService", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.getService", + "tags": [ + "getservice", + "webreference.getservice" + ], + "title": "WebReference.getService" + }, + { + "id": "script-api:dw/sitemap", + "kind": "package", + "packagePath": "dw/sitemap", + "qualifiedName": "dw.sitemap", + "tags": [ + "dw/sitemap", + "dw.sitemap" + ], + "title": "dw.sitemap" + }, + { + "id": "script-api:dw/sitemap/SitemapFile", + "kind": "class", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap", + "qualifiedName": "dw.sitemap.SitemapFile", + "tags": [ + "sitemapfile", + "dw.sitemap.sitemapfile", + "dw/sitemap" + ], + "title": "SitemapFile" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#fileName", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileName", + "tags": [ + "filename", + "sitemapfile.filename" + ], + "title": "SitemapFile.fileName" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#fileSize", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileSize", + "tags": [ + "filesize", + "sitemapfile.filesize" + ], + "title": "SitemapFile.fileSize" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#fileURL", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileURL", + "tags": [ + "fileurl", + "sitemapfile.fileurl" + ], + "title": "SitemapFile.fileURL" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#getFileName", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileName", + "tags": [ + "getfilename", + "sitemapfile.getfilename" + ], + "title": "SitemapFile.getFileName" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#getFileSize", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileSize", + "tags": [ + "getfilesize", + "sitemapfile.getfilesize" + ], + "title": "SitemapFile.getFileSize" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#getFileURL", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileURL", + "tags": [ + "getfileurl", + "sitemapfile.getfileurl" + ], + "title": "SitemapFile.getFileURL" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#getHostName", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getHostName", + "tags": [ + "gethostname", + "sitemapfile.gethostname" + ], + "title": "SitemapFile.getHostName" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#hostName", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.hostName", + "tags": [ + "hostname", + "sitemapfile.hostname" + ], + "title": "SitemapFile.hostName" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#isValid", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.isValid", + "tags": [ + "isvalid", + "sitemapfile.isvalid" + ], + "title": "SitemapFile.isValid" + }, + { + "id": "script-api:dw/sitemap/SitemapFile#valid", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.valid", + "tags": [ + "valid", + "sitemapfile.valid" + ], + "title": "SitemapFile.valid" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr", + "kind": "class", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap", + "qualifiedName": "dw.sitemap.SitemapMgr", + "tags": [ + "sitemapmgr", + "dw.sitemap.sitemapmgr", + "dw/sitemap" + ], + "title": "SitemapMgr" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#addCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.addCustomSitemapFile", + "tags": [ + "addcustomsitemapfile", + "sitemapmgr.addcustomsitemapfile" + ], + "title": "SitemapMgr.addCustomSitemapFile" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#addCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.addCustomSitemapFile", + "tags": [ + "addcustomsitemapfile", + "sitemapmgr.addcustomsitemapfile" + ], + "title": "SitemapMgr.addCustomSitemapFile" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#customSitemapFiles", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.customSitemapFiles", + "tags": [ + "customsitemapfiles", + "sitemapmgr.customsitemapfiles" + ], + "title": "SitemapMgr.customSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#customSitemapFiles", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.customSitemapFiles", + "tags": [ + "customsitemapfiles", + "sitemapmgr.customsitemapfiles" + ], + "title": "SitemapMgr.customSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFile", + "tags": [ + "deletecustomsitemapfile", + "sitemapmgr.deletecustomsitemapfile" + ], + "title": "SitemapMgr.deleteCustomSitemapFile" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFile", + "tags": [ + "deletecustomsitemapfile", + "sitemapmgr.deletecustomsitemapfile" + ], + "title": "SitemapMgr.deleteCustomSitemapFile" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#getCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.getCustomSitemapFiles", + "tags": [ + "getcustomsitemapfiles", + "sitemapmgr.getcustomsitemapfiles" + ], + "title": "SitemapMgr.getCustomSitemapFiles" + }, + { + "id": "script-api:dw/sitemap/SitemapMgr#getCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.getCustomSitemapFiles", + "tags": [ + "getcustomsitemapfiles", + "sitemapmgr.getcustomsitemapfiles" + ], + "title": "SitemapMgr.getCustomSitemapFiles" + }, + { + "id": "script-api:dw/suggest", + "kind": "package", + "packagePath": "dw/suggest", + "qualifiedName": "dw.suggest", + "tags": [ + "dw/suggest", + "dw.suggest" + ], + "title": "dw.suggest" + }, + { + "id": "script-api:dw/suggest/BrandSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.BrandSuggestions", + "tags": [ + "brandsuggestions", + "dw.suggest.brandsuggestions", + "dw/suggest" + ], + "title": "BrandSuggestions" + }, + { + "id": "script-api:dw/suggest/CategorySuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.CategorySuggestions", + "tags": [ + "categorysuggestions", + "dw.suggest.categorysuggestions", + "dw/suggest" + ], + "title": "CategorySuggestions" + }, + { + "id": "script-api:dw/suggest/CategorySuggestions#getSuggestedCategories", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/CategorySuggestions", + "qualifiedName": "dw.suggest.CategorySuggestions.getSuggestedCategories", + "tags": [ + "getsuggestedcategories", + "categorysuggestions.getsuggestedcategories" + ], + "title": "CategorySuggestions.getSuggestedCategories" + }, + { + "id": "script-api:dw/suggest/CategorySuggestions#suggestedCategories", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/CategorySuggestions", + "qualifiedName": "dw.suggest.CategorySuggestions.suggestedCategories", + "tags": [ + "suggestedcategories", + "categorysuggestions.suggestedcategories" + ], + "title": "CategorySuggestions.suggestedCategories" + }, + { + "id": "script-api:dw/suggest/ContentSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.ContentSuggestions", + "tags": [ + "contentsuggestions", + "dw.suggest.contentsuggestions", + "dw/suggest" + ], + "title": "ContentSuggestions" + }, + { + "id": "script-api:dw/suggest/ContentSuggestions#getSuggestedContent", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ContentSuggestions", + "qualifiedName": "dw.suggest.ContentSuggestions.getSuggestedContent", + "tags": [ + "getsuggestedcontent", + "contentsuggestions.getsuggestedcontent" + ], + "title": "ContentSuggestions.getSuggestedContent" + }, + { + "id": "script-api:dw/suggest/ContentSuggestions#suggestedContent", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ContentSuggestions", + "qualifiedName": "dw.suggest.ContentSuggestions.suggestedContent", + "tags": [ + "suggestedcontent", + "contentsuggestions.suggestedcontent" + ], + "title": "ContentSuggestions.suggestedContent" + }, + { + "id": "script-api:dw/suggest/CustomSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.CustomSuggestions", + "tags": [ + "customsuggestions", + "dw.suggest.customsuggestions", + "dw/suggest" + ], + "title": "CustomSuggestions" + }, + { + "id": "script-api:dw/suggest/ProductSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.ProductSuggestions", + "tags": [ + "productsuggestions", + "dw.suggest.productsuggestions", + "dw/suggest" + ], + "title": "ProductSuggestions" + }, + { + "id": "script-api:dw/suggest/ProductSuggestions#getSuggestedProducts", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ProductSuggestions", + "qualifiedName": "dw.suggest.ProductSuggestions.getSuggestedProducts", + "tags": [ + "getsuggestedproducts", + "productsuggestions.getsuggestedproducts" + ], + "title": "ProductSuggestions.getSuggestedProducts" + }, + { + "id": "script-api:dw/suggest/ProductSuggestions#suggestedProducts", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ProductSuggestions", + "qualifiedName": "dw.suggest.ProductSuggestions.suggestedProducts", + "tags": [ + "suggestedproducts", + "productsuggestions.suggestedproducts" + ], + "title": "ProductSuggestions.suggestedProducts" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions", + "tags": [ + "searchphrasesuggestions", + "dw.suggest.searchphrasesuggestions", + "dw/suggest" + ], + "title": "SearchPhraseSuggestions" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#getSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.getSuggestedPhrases", + "tags": [ + "getsuggestedphrases", + "searchphrasesuggestions.getsuggestedphrases" + ], + "title": "SearchPhraseSuggestions.getSuggestedPhrases" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#getSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.getSuggestedTerms", + "tags": [ + "getsuggestedterms", + "searchphrasesuggestions.getsuggestedterms" + ], + "title": "SearchPhraseSuggestions.getSuggestedTerms" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#hasSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.hasSuggestedPhrases", + "tags": [ + "hassuggestedphrases", + "searchphrasesuggestions.hassuggestedphrases" + ], + "title": "SearchPhraseSuggestions.hasSuggestedPhrases" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#hasSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.hasSuggestedTerms", + "tags": [ + "hassuggestedterms", + "searchphrasesuggestions.hassuggestedterms" + ], + "title": "SearchPhraseSuggestions.hasSuggestedTerms" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#suggestedPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.suggestedPhrases", + "tags": [ + "suggestedphrases", + "searchphrasesuggestions.suggestedphrases" + ], + "title": "SearchPhraseSuggestions.suggestedPhrases" + }, + { + "id": "script-api:dw/suggest/SearchPhraseSuggestions#suggestedTerms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.suggestedTerms", + "tags": [ + "suggestedterms", + "searchphrasesuggestions.suggestedterms" + ], + "title": "SearchPhraseSuggestions.suggestedTerms" + }, + { + "id": "script-api:dw/suggest/SuggestModel", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestModel", + "tags": [ + "suggestmodel", + "dw.suggest.suggestmodel", + "dw/suggest" + ], + "title": "SuggestModel" + }, + { + "id": "script-api:dw/suggest/SuggestModel#MAX_SUGGESTIONS", + "kind": "constant", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.MAX_SUGGESTIONS", + "tags": [ + "max_suggestions", + "suggestmodel.max_suggestions" + ], + "title": "SuggestModel.MAX_SUGGESTIONS" + }, + { + "id": "script-api:dw/suggest/SuggestModel#MAX_SUGGESTIONS", + "kind": "constant", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.MAX_SUGGESTIONS", + "tags": [ + "max_suggestions", + "suggestmodel.max_suggestions" + ], + "title": "SuggestModel.MAX_SUGGESTIONS" + }, + { + "id": "script-api:dw/suggest/SuggestModel#addRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.addRefinementValues", + "tags": [ + "addrefinementvalues", + "suggestmodel.addrefinementvalues" + ], + "title": "SuggestModel.addRefinementValues" + }, + { + "id": "script-api:dw/suggest/SuggestModel#brandSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.brandSuggestions", + "tags": [ + "brandsuggestions", + "suggestmodel.brandsuggestions" + ], + "title": "SuggestModel.brandSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#categorySuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.categorySuggestions", + "tags": [ + "categorysuggestions", + "suggestmodel.categorysuggestions" + ], + "title": "SuggestModel.categorySuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#contentSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.contentSuggestions", + "tags": [ + "contentsuggestions", + "suggestmodel.contentsuggestions" + ], + "title": "SuggestModel.contentSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#customSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.customSuggestions", + "tags": [ + "customsuggestions", + "suggestmodel.customsuggestions" + ], + "title": "SuggestModel.customSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#filteredByFolder", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.filteredByFolder", + "tags": [ + "filteredbyfolder", + "suggestmodel.filteredbyfolder" + ], + "title": "SuggestModel.filteredByFolder" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getBrandSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getBrandSuggestions", + "tags": [ + "getbrandsuggestions", + "suggestmodel.getbrandsuggestions" + ], + "title": "SuggestModel.getBrandSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getCategorySuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getCategorySuggestions", + "tags": [ + "getcategorysuggestions", + "suggestmodel.getcategorysuggestions" + ], + "title": "SuggestModel.getCategorySuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getContentSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getContentSuggestions", + "tags": [ + "getcontentsuggestions", + "suggestmodel.getcontentsuggestions" + ], + "title": "SuggestModel.getContentSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getCustomSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getCustomSuggestions", + "tags": [ + "getcustomsuggestions", + "suggestmodel.getcustomsuggestions" + ], + "title": "SuggestModel.getCustomSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getPopularSearchPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getPopularSearchPhrases", + "tags": [ + "getpopularsearchphrases", + "suggestmodel.getpopularsearchphrases" + ], + "title": "SuggestModel.getPopularSearchPhrases" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getProductSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getProductSuggestions", + "tags": [ + "getproductsuggestions", + "suggestmodel.getproductsuggestions" + ], + "title": "SuggestModel.getProductSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#getRecentSearchPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getRecentSearchPhrases", + "tags": [ + "getrecentsearchphrases", + "suggestmodel.getrecentsearchphrases" + ], + "title": "SuggestModel.getRecentSearchPhrases" + }, + { + "id": "script-api:dw/suggest/SuggestModel#isFilteredByFolder", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.isFilteredByFolder", + "tags": [ + "isfilteredbyfolder", + "suggestmodel.isfilteredbyfolder" + ], + "title": "SuggestModel.isFilteredByFolder" + }, + { + "id": "script-api:dw/suggest/SuggestModel#popularSearchPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.popularSearchPhrases", + "tags": [ + "popularsearchphrases", + "suggestmodel.popularsearchphrases" + ], + "title": "SuggestModel.popularSearchPhrases" + }, + { + "id": "script-api:dw/suggest/SuggestModel#productSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.productSuggestions", + "tags": [ + "productsuggestions", + "suggestmodel.productsuggestions" + ], + "title": "SuggestModel.productSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#recentSearchPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.recentSearchPhrases", + "tags": [ + "recentsearchphrases", + "suggestmodel.recentsearchphrases" + ], + "title": "SuggestModel.recentSearchPhrases" + }, + { + "id": "script-api:dw/suggest/SuggestModel#removeRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.removeRefinementValues", + "tags": [ + "removerefinementvalues", + "suggestmodel.removerefinementvalues" + ], + "title": "SuggestModel.removeRefinementValues" + }, + { + "id": "script-api:dw/suggest/SuggestModel#setCategoryID", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setCategoryID", + "tags": [ + "setcategoryid", + "suggestmodel.setcategoryid" + ], + "title": "SuggestModel.setCategoryID" + }, + { + "id": "script-api:dw/suggest/SuggestModel#setFilteredByFolder", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setFilteredByFolder", + "tags": [ + "setfilteredbyfolder", + "suggestmodel.setfilteredbyfolder" + ], + "title": "SuggestModel.setFilteredByFolder" + }, + { + "id": "script-api:dw/suggest/SuggestModel#setMaxSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setMaxSuggestions", + "tags": [ + "setmaxsuggestions", + "suggestmodel.setmaxsuggestions" + ], + "title": "SuggestModel.setMaxSuggestions" + }, + { + "id": "script-api:dw/suggest/SuggestModel#setRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setRefinementValues", + "tags": [ + "setrefinementvalues", + "suggestmodel.setrefinementvalues" + ], + "title": "SuggestModel.setRefinementValues" + }, + { + "id": "script-api:dw/suggest/SuggestModel#setSearchPhrase", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setSearchPhrase", + "tags": [ + "setsearchphrase", + "suggestmodel.setsearchphrase" + ], + "title": "SuggestModel.setSearchPhrase" + }, + { + "id": "script-api:dw/suggest/SuggestedCategory", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedCategory", + "tags": [ + "suggestedcategory", + "dw.suggest.suggestedcategory", + "dw/suggest" + ], + "title": "SuggestedCategory" + }, + { + "id": "script-api:dw/suggest/SuggestedCategory#category", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedCategory", + "qualifiedName": "dw.suggest.SuggestedCategory.category", + "tags": [ + "category", + "suggestedcategory.category" + ], + "title": "SuggestedCategory.category" + }, + { + "id": "script-api:dw/suggest/SuggestedCategory#getCategory", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedCategory", + "qualifiedName": "dw.suggest.SuggestedCategory.getCategory", + "tags": [ + "getcategory", + "suggestedcategory.getcategory" + ], + "title": "SuggestedCategory.getCategory" + }, + { + "id": "script-api:dw/suggest/SuggestedContent", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedContent", + "tags": [ + "suggestedcontent", + "dw.suggest.suggestedcontent", + "dw/suggest" + ], + "title": "SuggestedContent" + }, + { + "id": "script-api:dw/suggest/SuggestedContent#content", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedContent", + "qualifiedName": "dw.suggest.SuggestedContent.content", + "tags": [ + "content", + "suggestedcontent.content" + ], + "title": "SuggestedContent.content" + }, + { + "id": "script-api:dw/suggest/SuggestedContent#getContent", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedContent", + "qualifiedName": "dw.suggest.SuggestedContent.getContent", + "tags": [ + "getcontent", + "suggestedcontent.getcontent" + ], + "title": "SuggestedContent.getContent" + }, + { + "id": "script-api:dw/suggest/SuggestedPhrase", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedPhrase", + "tags": [ + "suggestedphrase", + "dw.suggest.suggestedphrase", + "dw/suggest" + ], + "title": "SuggestedPhrase" + }, + { + "id": "script-api:dw/suggest/SuggestedPhrase#exactMatch", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.exactMatch", + "tags": [ + "exactmatch", + "suggestedphrase.exactmatch" + ], + "title": "SuggestedPhrase.exactMatch" + }, + { + "id": "script-api:dw/suggest/SuggestedPhrase#getPhrase", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.getPhrase", + "tags": [ + "getphrase", + "suggestedphrase.getphrase" + ], + "title": "SuggestedPhrase.getPhrase" + }, + { + "id": "script-api:dw/suggest/SuggestedPhrase#isExactMatch", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.isExactMatch", + "tags": [ + "isexactmatch", + "suggestedphrase.isexactmatch" + ], + "title": "SuggestedPhrase.isExactMatch" + }, + { + "id": "script-api:dw/suggest/SuggestedPhrase#phrase", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.phrase", + "tags": [ + "phrase", + "suggestedphrase.phrase" + ], + "title": "SuggestedPhrase.phrase" + }, + { + "id": "script-api:dw/suggest/SuggestedProduct", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedProduct", + "tags": [ + "suggestedproduct", + "dw.suggest.suggestedproduct", + "dw/suggest" + ], + "title": "SuggestedProduct" + }, + { + "id": "script-api:dw/suggest/SuggestedProduct#getProductSearchHit", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedProduct", + "qualifiedName": "dw.suggest.SuggestedProduct.getProductSearchHit", + "tags": [ + "getproductsearchhit", + "suggestedproduct.getproductsearchhit" + ], + "title": "SuggestedProduct.getProductSearchHit" + }, + { + "id": "script-api:dw/suggest/SuggestedProduct#productSearchHit", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedProduct", + "qualifiedName": "dw.suggest.SuggestedProduct.productSearchHit", + "tags": [ + "productsearchhit", + "suggestedproduct.productsearchhit" + ], + "title": "SuggestedProduct.productSearchHit" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedTerm", + "tags": [ + "suggestedterm", + "dw.suggest.suggestedterm", + "dw/suggest" + ], + "title": "SuggestedTerm" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#additional", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.additional", + "tags": [ + "additional", + "suggestedterm.additional" + ], + "title": "SuggestedTerm.additional" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#completed", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.completed", + "tags": [ + "completed", + "suggestedterm.completed" + ], + "title": "SuggestedTerm.completed" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#corrected", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.corrected", + "tags": [ + "corrected", + "suggestedterm.corrected" + ], + "title": "SuggestedTerm.corrected" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#exactMatch", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.exactMatch", + "tags": [ + "exactmatch", + "suggestedterm.exactmatch" + ], + "title": "SuggestedTerm.exactMatch" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#getValue", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.getValue", + "tags": [ + "getvalue", + "suggestedterm.getvalue" + ], + "title": "SuggestedTerm.getValue" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#isAdditional", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isAdditional", + "tags": [ + "isadditional", + "suggestedterm.isadditional" + ], + "title": "SuggestedTerm.isAdditional" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#isCompleted", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isCompleted", + "tags": [ + "iscompleted", + "suggestedterm.iscompleted" + ], + "title": "SuggestedTerm.isCompleted" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#isCorrected", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isCorrected", + "tags": [ + "iscorrected", + "suggestedterm.iscorrected" + ], + "title": "SuggestedTerm.isCorrected" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#isExactMatch", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isExactMatch", + "tags": [ + "isexactmatch", + "suggestedterm.isexactmatch" + ], + "title": "SuggestedTerm.isExactMatch" + }, + { + "id": "script-api:dw/suggest/SuggestedTerm#value", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.value", + "tags": [ + "value", + "suggestedterm.value" + ], + "title": "SuggestedTerm.value" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedTerms", + "tags": [ + "suggestedterms", + "dw.suggest.suggestedterms", + "dw/suggest" + ], + "title": "SuggestedTerms" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#empty", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.empty", + "tags": [ + "empty", + "suggestedterms.empty" + ], + "title": "SuggestedTerms.empty" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#firstTerm", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.firstTerm", + "tags": [ + "firstterm", + "suggestedterms.firstterm" + ], + "title": "SuggestedTerms.firstTerm" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#getFirstTerm", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getFirstTerm", + "tags": [ + "getfirstterm", + "suggestedterms.getfirstterm" + ], + "title": "SuggestedTerms.getFirstTerm" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#getOriginalTerm", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getOriginalTerm", + "tags": [ + "getoriginalterm", + "suggestedterms.getoriginalterm" + ], + "title": "SuggestedTerms.getOriginalTerm" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#getTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getTerms", + "tags": [ + "getterms", + "suggestedterms.getterms" + ], + "title": "SuggestedTerms.getTerms" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#isEmpty", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.isEmpty", + "tags": [ + "isempty", + "suggestedterms.isempty" + ], + "title": "SuggestedTerms.isEmpty" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#originalTerm", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.originalTerm", + "tags": [ + "originalterm", + "suggestedterms.originalterm" + ], + "title": "SuggestedTerms.originalTerm" + }, + { + "id": "script-api:dw/suggest/SuggestedTerms#terms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.terms", + "tags": [ + "terms", + "suggestedterms.terms" + ], + "title": "SuggestedTerms.terms" + }, + { + "id": "script-api:dw/suggest/Suggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.Suggestions", + "tags": [ + "suggestions", + "dw.suggest.suggestions", + "dw/suggest" + ], + "title": "Suggestions" + }, + { + "id": "script-api:dw/suggest/Suggestions#getSearchPhraseSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSearchPhraseSuggestions", + "tags": [ + "getsearchphrasesuggestions", + "suggestions.getsearchphrasesuggestions" + ], + "title": "Suggestions.getSearchPhraseSuggestions" + }, + { + "id": "script-api:dw/suggest/Suggestions#getSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSuggestedPhrases", + "tags": [ + "getsuggestedphrases", + "suggestions.getsuggestedphrases" + ], + "title": "Suggestions.getSuggestedPhrases" + }, + { + "id": "script-api:dw/suggest/Suggestions#getSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSuggestedTerms", + "tags": [ + "getsuggestedterms", + "suggestions.getsuggestedterms" + ], + "title": "Suggestions.getSuggestedTerms" + }, + { + "id": "script-api:dw/suggest/Suggestions#hasSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestedPhrases", + "tags": [ + "hassuggestedphrases", + "suggestions.hassuggestedphrases" + ], + "title": "Suggestions.hasSuggestedPhrases" + }, + { + "id": "script-api:dw/suggest/Suggestions#hasSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestedTerms", + "tags": [ + "hassuggestedterms", + "suggestions.hassuggestedterms" + ], + "title": "Suggestions.hasSuggestedTerms" + }, + { + "id": "script-api:dw/suggest/Suggestions#hasSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestions", + "tags": [ + "hassuggestions", + "suggestions.hassuggestions" + ], + "title": "Suggestions.hasSuggestions" + }, + { + "id": "script-api:dw/suggest/Suggestions#searchPhraseSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.searchPhraseSuggestions", + "tags": [ + "searchphrasesuggestions", + "suggestions.searchphrasesuggestions" + ], + "title": "Suggestions.searchPhraseSuggestions" + }, + { + "id": "script-api:dw/suggest/Suggestions#suggestedPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.suggestedPhrases", + "tags": [ + "suggestedphrases", + "suggestions.suggestedphrases" + ], + "title": "Suggestions.suggestedPhrases" + }, + { + "id": "script-api:dw/suggest/Suggestions#suggestedTerms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.suggestedTerms", + "tags": [ + "suggestedterms", + "suggestions.suggestedterms" + ], + "title": "Suggestions.suggestedTerms" + }, + { + "id": "script-api:dw/svc", + "kind": "package", + "packagePath": "dw/svc", + "qualifiedName": "dw.svc", + "tags": [ + "dw/svc", + "dw.svc" + ], + "title": "dw.svc" + }, + { + "id": "script-api:dw/svc/FTPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.FTPService", + "tags": [ + "ftpservice", + "dw.svc.ftpservice", + "dw/svc" + ], + "title": "FTPService" + }, + { + "id": "script-api:dw/svc/FTPService#autoDisconnect", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.autoDisconnect", + "tags": [ + "autodisconnect", + "ftpservice.autodisconnect" + ], + "title": "FTPService.autoDisconnect" + }, + { + "id": "script-api:dw/svc/FTPService#client", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.client", + "tags": [ + "client", + "ftpservice.client" + ], + "title": "FTPService.client" + }, + { + "id": "script-api:dw/svc/FTPService#getClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.getClient", + "tags": [ + "getclient", + "ftpservice.getclient" + ], + "title": "FTPService.getClient" + }, + { + "id": "script-api:dw/svc/FTPService#isAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.isAutoDisconnect", + "tags": [ + "isautodisconnect", + "ftpservice.isautodisconnect" + ], + "title": "FTPService.isAutoDisconnect" + }, + { + "id": "script-api:dw/svc/FTPService#setAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.setAutoDisconnect", + "tags": [ + "setautodisconnect", + "ftpservice.setautodisconnect" + ], + "title": "FTPService.setAutoDisconnect" + }, + { + "id": "script-api:dw/svc/FTPService#setOperation", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.setOperation", + "tags": [ + "setoperation", + "ftpservice.setoperation" + ], + "title": "FTPService.setOperation" + }, + { + "id": "script-api:dw/svc/FTPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.FTPServiceDefinition", + "tags": [ + "ftpservicedefinition", + "dw.svc.ftpservicedefinition", + "dw/svc" + ], + "title": "FTPServiceDefinition" + }, + { + "id": "script-api:dw/svc/FTPServiceDefinition#autoDisconnect", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.autoDisconnect", + "tags": [ + "autodisconnect", + "ftpservicedefinition.autodisconnect" + ], + "title": "FTPServiceDefinition.autoDisconnect" + }, + { + "id": "script-api:dw/svc/FTPServiceDefinition#isAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.isAutoDisconnect", + "tags": [ + "isautodisconnect", + "ftpservicedefinition.isautodisconnect" + ], + "title": "FTPServiceDefinition.isAutoDisconnect" + }, + { + "id": "script-api:dw/svc/FTPServiceDefinition#setAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.setAutoDisconnect", + "tags": [ + "setautodisconnect", + "ftpservicedefinition.setautodisconnect" + ], + "title": "FTPServiceDefinition.setAutoDisconnect" + }, + { + "id": "script-api:dw/svc/HTTPFormService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPFormService", + "tags": [ + "httpformservice", + "dw.svc.httpformservice", + "dw/svc" + ], + "title": "HTTPFormService" + }, + { + "id": "script-api:dw/svc/HTTPFormServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPFormServiceDefinition", + "tags": [ + "httpformservicedefinition", + "dw.svc.httpformservicedefinition", + "dw/svc" + ], + "title": "HTTPFormServiceDefinition" + }, + { + "id": "script-api:dw/svc/HTTPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPService", + "tags": [ + "httpservice", + "dw.svc.httpservice", + "dw/svc" + ], + "title": "HTTPService" + }, + { + "id": "script-api:dw/svc/HTTPService#addHeader", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.addHeader", + "tags": [ + "addheader", + "httpservice.addheader" + ], + "title": "HTTPService.addHeader" + }, + { + "id": "script-api:dw/svc/HTTPService#addParam", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.addParam", + "tags": [ + "addparam", + "httpservice.addparam" + ], + "title": "HTTPService.addParam" + }, + { + "id": "script-api:dw/svc/HTTPService#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.authentication", + "tags": [ + "authentication", + "httpservice.authentication" + ], + "title": "HTTPService.authentication" + }, + { + "id": "script-api:dw/svc/HTTPService#cachingTTL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.cachingTTL", + "tags": [ + "cachingttl", + "httpservice.cachingttl" + ], + "title": "HTTPService.cachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPService#client", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.client", + "tags": [ + "client", + "httpservice.client" + ], + "title": "HTTPService.client" + }, + { + "id": "script-api:dw/svc/HTTPService#encoding", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.encoding", + "tags": [ + "encoding", + "httpservice.encoding" + ], + "title": "HTTPService.encoding" + }, + { + "id": "script-api:dw/svc/HTTPService#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getAuthentication", + "tags": [ + "getauthentication", + "httpservice.getauthentication" + ], + "title": "HTTPService.getAuthentication" + }, + { + "id": "script-api:dw/svc/HTTPService#getCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getCachingTTL", + "tags": [ + "getcachingttl", + "httpservice.getcachingttl" + ], + "title": "HTTPService.getCachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPService#getClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getClient", + "tags": [ + "getclient", + "httpservice.getclient" + ], + "title": "HTTPService.getClient" + }, + { + "id": "script-api:dw/svc/HTTPService#getEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getEncoding", + "tags": [ + "getencoding", + "httpservice.getencoding" + ], + "title": "HTTPService.getEncoding" + }, + { + "id": "script-api:dw/svc/HTTPService#getHostNameVerification", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getHostNameVerification", + "tags": [ + "gethostnameverification", + "httpservice.gethostnameverification" + ], + "title": "HTTPService.getHostNameVerification" + }, + { + "id": "script-api:dw/svc/HTTPService#getIdentity", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getIdentity", + "tags": [ + "getidentity", + "httpservice.getidentity" + ], + "title": "HTTPService.getIdentity" + }, + { + "id": "script-api:dw/svc/HTTPService#getOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getOutFile", + "tags": [ + "getoutfile", + "httpservice.getoutfile" + ], + "title": "HTTPService.getOutFile" + }, + { + "id": "script-api:dw/svc/HTTPService#getRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getRequestMethod", + "tags": [ + "getrequestmethod", + "httpservice.getrequestmethod" + ], + "title": "HTTPService.getRequestMethod" + }, + { + "id": "script-api:dw/svc/HTTPService#hostNameVerification", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.hostNameVerification", + "tags": [ + "hostnameverification", + "httpservice.hostnameverification" + ], + "title": "HTTPService.hostNameVerification" + }, + { + "id": "script-api:dw/svc/HTTPService#identity", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.identity", + "tags": [ + "identity", + "httpservice.identity" + ], + "title": "HTTPService.identity" + }, + { + "id": "script-api:dw/svc/HTTPService#outFile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.outFile", + "tags": [ + "outfile", + "httpservice.outfile" + ], + "title": "HTTPService.outFile" + }, + { + "id": "script-api:dw/svc/HTTPService#requestMethod", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.requestMethod", + "tags": [ + "requestmethod", + "httpservice.requestmethod" + ], + "title": "HTTPService.requestMethod" + }, + { + "id": "script-api:dw/svc/HTTPService#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setAuthentication", + "tags": [ + "setauthentication", + "httpservice.setauthentication" + ], + "title": "HTTPService.setAuthentication" + }, + { + "id": "script-api:dw/svc/HTTPService#setCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setCachingTTL", + "tags": [ + "setcachingttl", + "httpservice.setcachingttl" + ], + "title": "HTTPService.setCachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPService#setEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setEncoding", + "tags": [ + "setencoding", + "httpservice.setencoding" + ], + "title": "HTTPService.setEncoding" + }, + { + "id": "script-api:dw/svc/HTTPService#setHostNameVerification", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setHostNameVerification", + "tags": [ + "sethostnameverification", + "httpservice.sethostnameverification" + ], + "title": "HTTPService.setHostNameVerification" + }, + { + "id": "script-api:dw/svc/HTTPService#setIdentity", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setIdentity", + "tags": [ + "setidentity", + "httpservice.setidentity" + ], + "title": "HTTPService.setIdentity" + }, + { + "id": "script-api:dw/svc/HTTPService#setOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setOutFile", + "tags": [ + "setoutfile", + "httpservice.setoutfile" + ], + "title": "HTTPService.setOutFile" + }, + { + "id": "script-api:dw/svc/HTTPService#setRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setRequestMethod", + "tags": [ + "setrequestmethod", + "httpservice.setrequestmethod" + ], + "title": "HTTPService.setRequestMethod" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPServiceDefinition", + "tags": [ + "httpservicedefinition", + "dw.svc.httpservicedefinition", + "dw/svc" + ], + "title": "HTTPServiceDefinition" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#addHeader", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.addHeader", + "tags": [ + "addheader", + "httpservicedefinition.addheader" + ], + "title": "HTTPServiceDefinition.addHeader" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#addParam", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.addParam", + "tags": [ + "addparam", + "httpservicedefinition.addparam" + ], + "title": "HTTPServiceDefinition.addParam" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.authentication", + "tags": [ + "authentication", + "httpservicedefinition.authentication" + ], + "title": "HTTPServiceDefinition.authentication" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#cachingTTL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.cachingTTL", + "tags": [ + "cachingttl", + "httpservicedefinition.cachingttl" + ], + "title": "HTTPServiceDefinition.cachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#encoding", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.encoding", + "tags": [ + "encoding", + "httpservicedefinition.encoding" + ], + "title": "HTTPServiceDefinition.encoding" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getAuthentication", + "tags": [ + "getauthentication", + "httpservicedefinition.getauthentication" + ], + "title": "HTTPServiceDefinition.getAuthentication" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#getCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getCachingTTL", + "tags": [ + "getcachingttl", + "httpservicedefinition.getcachingttl" + ], + "title": "HTTPServiceDefinition.getCachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#getEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getEncoding", + "tags": [ + "getencoding", + "httpservicedefinition.getencoding" + ], + "title": "HTTPServiceDefinition.getEncoding" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#getOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getOutFile", + "tags": [ + "getoutfile", + "httpservicedefinition.getoutfile" + ], + "title": "HTTPServiceDefinition.getOutFile" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#getRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getRequestMethod", + "tags": [ + "getrequestmethod", + "httpservicedefinition.getrequestmethod" + ], + "title": "HTTPServiceDefinition.getRequestMethod" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#outFile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.outFile", + "tags": [ + "outfile", + "httpservicedefinition.outfile" + ], + "title": "HTTPServiceDefinition.outFile" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#requestMethod", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.requestMethod", + "tags": [ + "requestmethod", + "httpservicedefinition.requestmethod" + ], + "title": "HTTPServiceDefinition.requestMethod" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setAuthentication", + "tags": [ + "setauthentication", + "httpservicedefinition.setauthentication" + ], + "title": "HTTPServiceDefinition.setAuthentication" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#setCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setCachingTTL", + "tags": [ + "setcachingttl", + "httpservicedefinition.setcachingttl" + ], + "title": "HTTPServiceDefinition.setCachingTTL" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#setEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setEncoding", + "tags": [ + "setencoding", + "httpservicedefinition.setencoding" + ], + "title": "HTTPServiceDefinition.setEncoding" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#setOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setOutFile", + "tags": [ + "setoutfile", + "httpservicedefinition.setoutfile" + ], + "title": "HTTPServiceDefinition.setOutFile" + }, + { + "id": "script-api:dw/svc/HTTPServiceDefinition#setRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setRequestMethod", + "tags": [ + "setrequestmethod", + "httpservicedefinition.setrequestmethod" + ], + "title": "HTTPServiceDefinition.setRequestMethod" + }, + { + "id": "script-api:dw/svc/LocalServiceRegistry", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.LocalServiceRegistry", + "tags": [ + "localserviceregistry", + "dw.svc.localserviceregistry", + "dw/svc" + ], + "title": "LocalServiceRegistry" + }, + { + "id": "script-api:dw/svc/LocalServiceRegistry#createService", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/LocalServiceRegistry", + "qualifiedName": "dw.svc.LocalServiceRegistry.createService", + "tags": [ + "createservice", + "localserviceregistry.createservice" + ], + "title": "LocalServiceRegistry.createService" + }, + { + "id": "script-api:dw/svc/LocalServiceRegistry#createService", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/LocalServiceRegistry", + "qualifiedName": "dw.svc.LocalServiceRegistry.createService", + "tags": [ + "createservice", + "localserviceregistry.createservice" + ], + "title": "LocalServiceRegistry.createService" + }, + { + "id": "script-api:dw/svc/Result", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.Result", + "tags": [ + "result", + "dw.svc.result", + "dw/svc" + ], + "title": "Result" + }, + { + "id": "script-api:dw/svc/Result#ERROR", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ERROR", + "tags": [ + "error", + "result.error" + ], + "title": "Result.ERROR" + }, + { + "id": "script-api:dw/svc/Result#ERROR", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ERROR", + "tags": [ + "error", + "result.error" + ], + "title": "Result.ERROR" + }, + { + "id": "script-api:dw/svc/Result#OK", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.OK", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.OK" + }, + { + "id": "script-api:dw/svc/Result#OK", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.OK", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.OK" + }, + { + "id": "script-api:dw/svc/Result#SERVICE_UNAVAILABLE", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.SERVICE_UNAVAILABLE", + "tags": [ + "service_unavailable", + "result.service_unavailable" + ], + "title": "Result.SERVICE_UNAVAILABLE" + }, + { + "id": "script-api:dw/svc/Result#SERVICE_UNAVAILABLE", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.SERVICE_UNAVAILABLE", + "tags": [ + "service_unavailable", + "result.service_unavailable" + ], + "title": "Result.SERVICE_UNAVAILABLE" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_CIRCUIT_BROKEN", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CIRCUIT_BROKEN", + "tags": [ + "unavailable_circuit_broken", + "result.unavailable_circuit_broken" + ], + "title": "Result.UNAVAILABLE_CIRCUIT_BROKEN" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_CIRCUIT_BROKEN", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CIRCUIT_BROKEN", + "tags": [ + "unavailable_circuit_broken", + "result.unavailable_circuit_broken" + ], + "title": "Result.UNAVAILABLE_CIRCUIT_BROKEN" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_CONFIG_PROBLEM", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CONFIG_PROBLEM", + "tags": [ + "unavailable_config_problem", + "result.unavailable_config_problem" + ], + "title": "Result.UNAVAILABLE_CONFIG_PROBLEM" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_CONFIG_PROBLEM", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CONFIG_PROBLEM", + "tags": [ + "unavailable_config_problem", + "result.unavailable_config_problem" + ], + "title": "Result.UNAVAILABLE_CONFIG_PROBLEM" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_DISABLED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_DISABLED", + "tags": [ + "unavailable_disabled", + "result.unavailable_disabled" + ], + "title": "Result.UNAVAILABLE_DISABLED" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_DISABLED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_DISABLED", + "tags": [ + "unavailable_disabled", + "result.unavailable_disabled" + ], + "title": "Result.UNAVAILABLE_DISABLED" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_RATE_LIMITED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_RATE_LIMITED", + "tags": [ + "unavailable_rate_limited", + "result.unavailable_rate_limited" + ], + "title": "Result.UNAVAILABLE_RATE_LIMITED" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_RATE_LIMITED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_RATE_LIMITED", + "tags": [ + "unavailable_rate_limited", + "result.unavailable_rate_limited" + ], + "title": "Result.UNAVAILABLE_RATE_LIMITED" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_TIMEOUT", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_TIMEOUT", + "tags": [ + "unavailable_timeout", + "result.unavailable_timeout" + ], + "title": "Result.UNAVAILABLE_TIMEOUT" + }, + { + "id": "script-api:dw/svc/Result#UNAVAILABLE_TIMEOUT", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_TIMEOUT", + "tags": [ + "unavailable_timeout", + "result.unavailable_timeout" + ], + "title": "Result.UNAVAILABLE_TIMEOUT" + }, + { + "id": "script-api:dw/svc/Result#error", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.error", + "tags": [ + "error", + "result.error" + ], + "title": "Result.error" + }, + { + "id": "script-api:dw/svc/Result#errorMessage", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.errorMessage", + "tags": [ + "errormessage", + "result.errormessage" + ], + "title": "Result.errorMessage" + }, + { + "id": "script-api:dw/svc/Result#getError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getError", + "tags": [ + "geterror", + "result.geterror" + ], + "title": "Result.getError" + }, + { + "id": "script-api:dw/svc/Result#getErrorMessage", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getErrorMessage", + "tags": [ + "geterrormessage", + "result.geterrormessage" + ], + "title": "Result.getErrorMessage" + }, + { + "id": "script-api:dw/svc/Result#getMsg", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getMsg", + "tags": [ + "getmsg", + "result.getmsg" + ], + "title": "Result.getMsg" + }, + { + "id": "script-api:dw/svc/Result#getObject", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getObject", + "tags": [ + "getobject", + "result.getobject" + ], + "title": "Result.getObject" + }, + { + "id": "script-api:dw/svc/Result#getStatus", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getStatus", + "tags": [ + "getstatus", + "result.getstatus" + ], + "title": "Result.getStatus" + }, + { + "id": "script-api:dw/svc/Result#getUnavailableReason", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getUnavailableReason", + "tags": [ + "getunavailablereason", + "result.getunavailablereason" + ], + "title": "Result.getUnavailableReason" + }, + { + "id": "script-api:dw/svc/Result#isMockResult", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.isMockResult", + "tags": [ + "ismockresult", + "result.ismockresult" + ], + "title": "Result.isMockResult" + }, + { + "id": "script-api:dw/svc/Result#isOk", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.isOk", + "tags": [ + "isok", + "result.isok" + ], + "title": "Result.isOk" + }, + { + "id": "script-api:dw/svc/Result#mockResult", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.mockResult", + "tags": [ + "mockresult", + "result.mockresult" + ], + "title": "Result.mockResult" + }, + { + "id": "script-api:dw/svc/Result#msg", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.msg", + "tags": [ + "msg", + "result.msg" + ], + "title": "Result.msg" + }, + { + "id": "script-api:dw/svc/Result#object", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.object", + "tags": [ + "object", + "result.object" + ], + "title": "Result.object" + }, + { + "id": "script-api:dw/svc/Result#ok", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ok", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.ok" + }, + { + "id": "script-api:dw/svc/Result#status", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.status", + "tags": [ + "status", + "result.status" + ], + "title": "Result.status" + }, + { + "id": "script-api:dw/svc/Result#toString", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.toString", + "tags": [ + "tostring", + "result.tostring" + ], + "title": "Result.toString" + }, + { + "id": "script-api:dw/svc/Result#unavailableReason", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.unavailableReason", + "tags": [ + "unavailablereason", + "result.unavailablereason" + ], + "title": "Result.unavailableReason" + }, + { + "id": "script-api:dw/svc/SOAPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.SOAPService", + "tags": [ + "soapservice", + "dw.svc.soapservice", + "dw/svc" + ], + "title": "SOAPService" + }, + { + "id": "script-api:dw/svc/SOAPService#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.authentication", + "tags": [ + "authentication", + "soapservice.authentication" + ], + "title": "SOAPService.authentication" + }, + { + "id": "script-api:dw/svc/SOAPService#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.getAuthentication", + "tags": [ + "getauthentication", + "soapservice.getauthentication" + ], + "title": "SOAPService.getAuthentication" + }, + { + "id": "script-api:dw/svc/SOAPService#getServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.getServiceClient", + "tags": [ + "getserviceclient", + "soapservice.getserviceclient" + ], + "title": "SOAPService.getServiceClient" + }, + { + "id": "script-api:dw/svc/SOAPService#serviceClient", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.serviceClient", + "tags": [ + "serviceclient", + "soapservice.serviceclient" + ], + "title": "SOAPService.serviceClient" + }, + { + "id": "script-api:dw/svc/SOAPService#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.setAuthentication", + "tags": [ + "setauthentication", + "soapservice.setauthentication" + ], + "title": "SOAPService.setAuthentication" + }, + { + "id": "script-api:dw/svc/SOAPService#setServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.setServiceClient", + "tags": [ + "setserviceclient", + "soapservice.setserviceclient" + ], + "title": "SOAPService.setServiceClient" + }, + { + "id": "script-api:dw/svc/SOAPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.SOAPServiceDefinition", + "tags": [ + "soapservicedefinition", + "dw.svc.soapservicedefinition", + "dw/svc" + ], + "title": "SOAPServiceDefinition" + }, + { + "id": "script-api:dw/svc/Service", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.Service", + "tags": [ + "service", + "dw.svc.service", + "dw/svc" + ], + "title": "Service" + }, + { + "id": "script-api:dw/svc/Service#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.URL", + "tags": [ + "url", + "service.url" + ], + "title": "Service.URL" + }, + { + "id": "script-api:dw/svc/Service#call", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.call", + "tags": [ + "call", + "service.call" + ], + "title": "Service.call" + }, + { + "id": "script-api:dw/svc/Service#configuration", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.configuration", + "tags": [ + "configuration", + "service.configuration" + ], + "title": "Service.configuration" + }, + { + "id": "script-api:dw/svc/Service#credentialID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.credentialID", + "tags": [ + "credentialid", + "service.credentialid" + ], + "title": "Service.credentialID" + }, + { + "id": "script-api:dw/svc/Service#getConfiguration", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getConfiguration", + "tags": [ + "getconfiguration", + "service.getconfiguration" + ], + "title": "Service.getConfiguration" + }, + { + "id": "script-api:dw/svc/Service#getCredentialID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getCredentialID", + "tags": [ + "getcredentialid", + "service.getcredentialid" + ], + "title": "Service.getCredentialID" + }, + { + "id": "script-api:dw/svc/Service#getRequestData", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getRequestData", + "tags": [ + "getrequestdata", + "service.getrequestdata" + ], + "title": "Service.getRequestData" + }, + { + "id": "script-api:dw/svc/Service#getResponse", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getResponse", + "tags": [ + "getresponse", + "service.getresponse" + ], + "title": "Service.getResponse" + }, + { + "id": "script-api:dw/svc/Service#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getURL", + "tags": [ + "geturl", + "service.geturl" + ], + "title": "Service.getURL" + }, + { + "id": "script-api:dw/svc/Service#isMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.isMock", + "tags": [ + "ismock", + "service.ismock" + ], + "title": "Service.isMock" + }, + { + "id": "script-api:dw/svc/Service#isThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.isThrowOnError", + "tags": [ + "isthrowonerror", + "service.isthrowonerror" + ], + "title": "Service.isThrowOnError" + }, + { + "id": "script-api:dw/svc/Service#mock", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.mock", + "tags": [ + "mock", + "service.mock" + ], + "title": "Service.mock" + }, + { + "id": "script-api:dw/svc/Service#requestData", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.requestData", + "tags": [ + "requestdata", + "service.requestdata" + ], + "title": "Service.requestData" + }, + { + "id": "script-api:dw/svc/Service#response", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.response", + "tags": [ + "response", + "service.response" + ], + "title": "Service.response" + }, + { + "id": "script-api:dw/svc/Service#setCredentialID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setCredentialID", + "tags": [ + "setcredentialid", + "service.setcredentialid" + ], + "title": "Service.setCredentialID" + }, + { + "id": "script-api:dw/svc/Service#setMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setMock", + "tags": [ + "setmock", + "service.setmock" + ], + "title": "Service.setMock" + }, + { + "id": "script-api:dw/svc/Service#setThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setThrowOnError", + "tags": [ + "setthrowonerror", + "service.setthrowonerror" + ], + "title": "Service.setThrowOnError" + }, + { + "id": "script-api:dw/svc/Service#setURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setURL", + "tags": [ + "seturl", + "service.seturl" + ], + "title": "Service.setURL" + }, + { + "id": "script-api:dw/svc/Service#throwOnError", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.throwOnError", + "tags": [ + "throwonerror", + "service.throwonerror" + ], + "title": "Service.throwOnError" + }, + { + "id": "script-api:dw/svc/ServiceCallback", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceCallback", + "tags": [ + "servicecallback", + "dw.svc.servicecallback", + "dw/svc" + ], + "title": "ServiceCallback" + }, + { + "id": "script-api:dw/svc/ServiceCallback#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.URL", + "tags": [ + "url", + "servicecallback.url" + ], + "title": "ServiceCallback.URL" + }, + { + "id": "script-api:dw/svc/ServiceCallback#createRequest", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.createRequest", + "tags": [ + "createrequest", + "servicecallback.createrequest" + ], + "title": "ServiceCallback.createRequest" + }, + { + "id": "script-api:dw/svc/ServiceCallback#execute", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.execute", + "tags": [ + "execute", + "servicecallback.execute" + ], + "title": "ServiceCallback.execute" + }, + { + "id": "script-api:dw/svc/ServiceCallback#filterLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.filterLogMessage", + "tags": [ + "filterlogmessage", + "servicecallback.filterlogmessage" + ], + "title": "ServiceCallback.filterLogMessage" + }, + { + "id": "script-api:dw/svc/ServiceCallback#getRequestLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getRequestLogMessage", + "tags": [ + "getrequestlogmessage", + "servicecallback.getrequestlogmessage" + ], + "title": "ServiceCallback.getRequestLogMessage" + }, + { + "id": "script-api:dw/svc/ServiceCallback#getResponseLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getResponseLogMessage", + "tags": [ + "getresponselogmessage", + "servicecallback.getresponselogmessage" + ], + "title": "ServiceCallback.getResponseLogMessage" + }, + { + "id": "script-api:dw/svc/ServiceCallback#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getURL", + "tags": [ + "geturl", + "servicecallback.geturl" + ], + "title": "ServiceCallback.getURL" + }, + { + "id": "script-api:dw/svc/ServiceCallback#initServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.initServiceClient", + "tags": [ + "initserviceclient", + "servicecallback.initserviceclient" + ], + "title": "ServiceCallback.initServiceClient" + }, + { + "id": "script-api:dw/svc/ServiceCallback#mockCall", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.mockCall", + "tags": [ + "mockcall", + "servicecallback.mockcall" + ], + "title": "ServiceCallback.mockCall" + }, + { + "id": "script-api:dw/svc/ServiceCallback#mockFull", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.mockFull", + "tags": [ + "mockfull", + "servicecallback.mockfull" + ], + "title": "ServiceCallback.mockFull" + }, + { + "id": "script-api:dw/svc/ServiceCallback#parseResponse", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.parseResponse", + "tags": [ + "parseresponse", + "servicecallback.parseresponse" + ], + "title": "ServiceCallback.parseResponse" + }, + { + "id": "script-api:dw/svc/ServiceConfig", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceConfig", + "tags": [ + "serviceconfig", + "dw.svc.serviceconfig", + "dw/svc" + ], + "title": "ServiceConfig" + }, + { + "id": "script-api:dw/svc/ServiceConfig#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.ID", + "tags": [ + "id", + "serviceconfig.id" + ], + "title": "ServiceConfig.ID" + }, + { + "id": "script-api:dw/svc/ServiceConfig#credential", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.credential", + "tags": [ + "credential", + "serviceconfig.credential" + ], + "title": "ServiceConfig.credential" + }, + { + "id": "script-api:dw/svc/ServiceConfig#getCredential", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getCredential", + "tags": [ + "getcredential", + "serviceconfig.getcredential" + ], + "title": "ServiceConfig.getCredential" + }, + { + "id": "script-api:dw/svc/ServiceConfig#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getID", + "tags": [ + "getid", + "serviceconfig.getid" + ], + "title": "ServiceConfig.getID" + }, + { + "id": "script-api:dw/svc/ServiceConfig#getProfile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getProfile", + "tags": [ + "getprofile", + "serviceconfig.getprofile" + ], + "title": "ServiceConfig.getProfile" + }, + { + "id": "script-api:dw/svc/ServiceConfig#getServiceType", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getServiceType", + "tags": [ + "getservicetype", + "serviceconfig.getservicetype" + ], + "title": "ServiceConfig.getServiceType" + }, + { + "id": "script-api:dw/svc/ServiceConfig#profile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.profile", + "tags": [ + "profile", + "serviceconfig.profile" + ], + "title": "ServiceConfig.profile" + }, + { + "id": "script-api:dw/svc/ServiceConfig#serviceType", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.serviceType", + "tags": [ + "servicetype", + "serviceconfig.servicetype" + ], + "title": "ServiceConfig.serviceType" + }, + { + "id": "script-api:dw/svc/ServiceCredential", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceCredential", + "tags": [ + "servicecredential", + "dw.svc.servicecredential", + "dw/svc" + ], + "title": "ServiceCredential" + }, + { + "id": "script-api:dw/svc/ServiceCredential#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ENCRYPTION_ALGORITHM_RSA", + "tags": [ + "encryption_algorithm_rsa", + "servicecredential.encryption_algorithm_rsa" + ], + "title": "ServiceCredential.ENCRYPTION_ALGORITHM_RSA" + }, + { + "id": "script-api:dw/svc/ServiceCredential#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ENCRYPTION_ALGORITHM_RSA", + "tags": [ + "encryption_algorithm_rsa", + "servicecredential.encryption_algorithm_rsa" + ], + "title": "ServiceCredential.ENCRYPTION_ALGORITHM_RSA" + }, + { + "id": "script-api:dw/svc/ServiceCredential#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ID", + "tags": [ + "id", + "servicecredential.id" + ], + "title": "ServiceCredential.ID" + }, + { + "id": "script-api:dw/svc/ServiceCredential#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.URL", + "tags": [ + "url", + "servicecredential.url" + ], + "title": "ServiceCredential.URL" + }, + { + "id": "script-api:dw/svc/ServiceCredential#getEncryptedPassword", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getEncryptedPassword", + "tags": [ + "getencryptedpassword", + "servicecredential.getencryptedpassword" + ], + "title": "ServiceCredential.getEncryptedPassword" + }, + { + "id": "script-api:dw/svc/ServiceCredential#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getID", + "tags": [ + "getid", + "servicecredential.getid" + ], + "title": "ServiceCredential.getID" + }, + { + "id": "script-api:dw/svc/ServiceCredential#getPassword", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getPassword", + "tags": [ + "getpassword", + "servicecredential.getpassword" + ], + "title": "ServiceCredential.getPassword" + }, + { + "id": "script-api:dw/svc/ServiceCredential#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getURL", + "tags": [ + "geturl", + "servicecredential.geturl" + ], + "title": "ServiceCredential.getURL" + }, + { + "id": "script-api:dw/svc/ServiceCredential#getUser", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getUser", + "tags": [ + "getuser", + "servicecredential.getuser" + ], + "title": "ServiceCredential.getUser" + }, + { + "id": "script-api:dw/svc/ServiceCredential#password", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.password", + "tags": [ + "password", + "servicecredential.password" + ], + "title": "ServiceCredential.password" + }, + { + "id": "script-api:dw/svc/ServiceCredential#user", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.user", + "tags": [ + "user", + "servicecredential.user" + ], + "title": "ServiceCredential.user" + }, + { + "id": "script-api:dw/svc/ServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceDefinition", + "tags": [ + "servicedefinition", + "dw.svc.servicedefinition", + "dw/svc" + ], + "title": "ServiceDefinition" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#configuration", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.configuration", + "tags": [ + "configuration", + "servicedefinition.configuration" + ], + "title": "ServiceDefinition.configuration" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#configure", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.configure", + "tags": [ + "configure", + "servicedefinition.configure" + ], + "title": "ServiceDefinition.configure" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#getConfiguration", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.getConfiguration", + "tags": [ + "getconfiguration", + "servicedefinition.getconfiguration" + ], + "title": "ServiceDefinition.getConfiguration" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#getServiceName", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.getServiceName", + "tags": [ + "getservicename", + "servicedefinition.getservicename" + ], + "title": "ServiceDefinition.getServiceName" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#isMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.isMock", + "tags": [ + "ismock", + "servicedefinition.ismock" + ], + "title": "ServiceDefinition.isMock" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#isThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.isThrowOnError", + "tags": [ + "isthrowonerror", + "servicedefinition.isthrowonerror" + ], + "title": "ServiceDefinition.isThrowOnError" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#mock", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.mock", + "tags": [ + "mock", + "servicedefinition.mock" + ], + "title": "ServiceDefinition.mock" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#serviceName", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.serviceName", + "tags": [ + "servicename", + "servicedefinition.servicename" + ], + "title": "ServiceDefinition.serviceName" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#setMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.setMock", + "tags": [ + "setmock", + "servicedefinition.setmock" + ], + "title": "ServiceDefinition.setMock" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#setThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.setThrowOnError", + "tags": [ + "setthrowonerror", + "servicedefinition.setthrowonerror" + ], + "title": "ServiceDefinition.setThrowOnError" + }, + { + "id": "script-api:dw/svc/ServiceDefinition#throwOnError", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.throwOnError", + "tags": [ + "throwonerror", + "servicedefinition.throwonerror" + ], + "title": "ServiceDefinition.throwOnError" + }, + { + "id": "script-api:dw/svc/ServiceProfile", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceProfile", + "tags": [ + "serviceprofile", + "dw.svc.serviceprofile", + "dw/svc" + ], + "title": "ServiceProfile" + }, + { + "id": "script-api:dw/svc/ServiceProfile#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.ID", + "tags": [ + "id", + "serviceprofile.id" + ], + "title": "ServiceProfile.ID" + }, + { + "id": "script-api:dw/svc/ServiceProfile#cbCalls", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.cbCalls", + "tags": [ + "cbcalls", + "serviceprofile.cbcalls" + ], + "title": "ServiceProfile.cbCalls" + }, + { + "id": "script-api:dw/svc/ServiceProfile#cbMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.cbMillis", + "tags": [ + "cbmillis", + "serviceprofile.cbmillis" + ], + "title": "ServiceProfile.cbMillis" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getCbCalls", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getCbCalls", + "tags": [ + "getcbcalls", + "serviceprofile.getcbcalls" + ], + "title": "ServiceProfile.getCbCalls" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getCbMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getCbMillis", + "tags": [ + "getcbmillis", + "serviceprofile.getcbmillis" + ], + "title": "ServiceProfile.getCbMillis" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getID", + "tags": [ + "getid", + "serviceprofile.getid" + ], + "title": "ServiceProfile.getID" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getRateLimitCalls", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getRateLimitCalls", + "tags": [ + "getratelimitcalls", + "serviceprofile.getratelimitcalls" + ], + "title": "ServiceProfile.getRateLimitCalls" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getRateLimitMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getRateLimitMillis", + "tags": [ + "getratelimitmillis", + "serviceprofile.getratelimitmillis" + ], + "title": "ServiceProfile.getRateLimitMillis" + }, + { + "id": "script-api:dw/svc/ServiceProfile#getTimeoutMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getTimeoutMillis", + "tags": [ + "gettimeoutmillis", + "serviceprofile.gettimeoutmillis" + ], + "title": "ServiceProfile.getTimeoutMillis" + }, + { + "id": "script-api:dw/svc/ServiceProfile#rateLimitCalls", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.rateLimitCalls", + "tags": [ + "ratelimitcalls", + "serviceprofile.ratelimitcalls" + ], + "title": "ServiceProfile.rateLimitCalls" + }, + { + "id": "script-api:dw/svc/ServiceProfile#rateLimitMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.rateLimitMillis", + "tags": [ + "ratelimitmillis", + "serviceprofile.ratelimitmillis" + ], + "title": "ServiceProfile.rateLimitMillis" + }, + { + "id": "script-api:dw/svc/ServiceProfile#timeoutMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.timeoutMillis", + "tags": [ + "timeoutmillis", + "serviceprofile.timeoutmillis" + ], + "title": "ServiceProfile.timeoutMillis" + }, + { + "id": "script-api:dw/svc/ServiceRegistry", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceRegistry", + "tags": [ + "serviceregistry", + "dw.svc.serviceregistry", + "dw/svc" + ], + "title": "ServiceRegistry" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#configure", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.configure", + "tags": [ + "configure", + "serviceregistry.configure" + ], + "title": "ServiceRegistry.configure" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#configure", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.configure", + "tags": [ + "configure", + "serviceregistry.configure" + ], + "title": "ServiceRegistry.configure" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#get", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.get", + "tags": [ + "get", + "serviceregistry.get" + ], + "title": "ServiceRegistry.get" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#get", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.get", + "tags": [ + "get", + "serviceregistry.get" + ], + "title": "ServiceRegistry.get" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#getDefinition", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.getDefinition", + "tags": [ + "getdefinition", + "serviceregistry.getdefinition" + ], + "title": "ServiceRegistry.getDefinition" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#getDefinition", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.getDefinition", + "tags": [ + "getdefinition", + "serviceregistry.getdefinition" + ], + "title": "ServiceRegistry.getDefinition" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#isConfigured", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.isConfigured", + "tags": [ + "isconfigured", + "serviceregistry.isconfigured" + ], + "title": "ServiceRegistry.isConfigured" + }, + { + "id": "script-api:dw/svc/ServiceRegistry#isConfigured", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.isConfigured", + "tags": [ + "isconfigured", + "serviceregistry.isconfigured" + ], + "title": "ServiceRegistry.isConfigured" + }, + { + "id": "script-api:dw/system", + "kind": "package", + "packagePath": "dw/system", + "qualifiedName": "dw.system", + "tags": [ + "dw/system", + "dw.system" + ], + "title": "dw.system" + }, + { + "id": "script-api:dw/system/AgentUserStatusCodes", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.AgentUserStatusCodes", + "tags": [ + "agentuserstatuscodes", + "dw.system.agentuserstatuscodes", + "dw/system" + ], + "title": "AgentUserStatusCodes" + }, + { + "id": "script-api:dw/system/Cache", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Cache", + "tags": [ + "cache", + "dw.system.cache", + "dw/system" + ], + "title": "Cache" + }, + { + "id": "script-api:dw/system/Cache#get", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.get", + "tags": [ + "get", + "cache.get" + ], + "title": "Cache.get" + }, + { + "id": "script-api:dw/system/Cache#get", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.get", + "tags": [ + "get", + "cache.get" + ], + "title": "Cache.get" + }, + { + "id": "script-api:dw/system/Cache#invalidate", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.invalidate", + "tags": [ + "invalidate", + "cache.invalidate" + ], + "title": "Cache.invalidate" + }, + { + "id": "script-api:dw/system/Cache#put", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.put", + "tags": [ + "put", + "cache.put" + ], + "title": "Cache.put" + }, + { + "id": "script-api:dw/system/CacheMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.CacheMgr", + "tags": [ + "cachemgr", + "dw.system.cachemgr", + "dw/system" + ], + "title": "CacheMgr" + }, + { + "id": "script-api:dw/system/CacheMgr#getCache", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/CacheMgr", + "qualifiedName": "dw.system.CacheMgr.getCache", + "tags": [ + "getcache", + "cachemgr.getcache" + ], + "title": "CacheMgr.getCache" + }, + { + "id": "script-api:dw/system/CacheMgr#getCache", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/CacheMgr", + "qualifiedName": "dw.system.CacheMgr.getCache", + "tags": [ + "getcache", + "cachemgr.getcache" + ], + "title": "CacheMgr.getCache" + }, + { + "id": "script-api:dw/system/HookMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.HookMgr", + "tags": [ + "hookmgr", + "dw.system.hookmgr", + "dw/system" + ], + "title": "HookMgr" + }, + { + "id": "script-api:dw/system/HookMgr#callHook", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.callHook", + "tags": [ + "callhook", + "hookmgr.callhook" + ], + "title": "HookMgr.callHook" + }, + { + "id": "script-api:dw/system/HookMgr#callHook", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.callHook", + "tags": [ + "callhook", + "hookmgr.callhook" + ], + "title": "HookMgr.callHook" + }, + { + "id": "script-api:dw/system/HookMgr#hasHook", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.hasHook", + "tags": [ + "hashook", + "hookmgr.hashook" + ], + "title": "HookMgr.hasHook" + }, + { + "id": "script-api:dw/system/HookMgr#hasHook", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.hasHook", + "tags": [ + "hashook", + "hookmgr.hashook" + ], + "title": "HookMgr.hasHook" + }, + { + "id": "script-api:dw/system/InternalObject", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.InternalObject", + "tags": [ + "internalobject", + "dw.system.internalobject", + "dw/system" + ], + "title": "InternalObject" + }, + { + "id": "script-api:dw/system/InternalObject#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/InternalObject", + "qualifiedName": "dw.system.InternalObject.toString", + "tags": [ + "tostring", + "internalobject.tostring" + ], + "title": "InternalObject.toString" + }, + { + "id": "script-api:dw/system/InternalObject#valueOf", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/InternalObject", + "qualifiedName": "dw.system.InternalObject.valueOf", + "tags": [ + "valueof", + "internalobject.valueof" + ], + "title": "InternalObject.valueOf" + }, + { + "id": "script-api:dw/system/JobProcessMonitor", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.JobProcessMonitor", + "tags": [ + "jobprocessmonitor", + "dw.system.jobprocessmonitor", + "dw/system" + ], + "title": "JobProcessMonitor" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#getTotalWork", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.getTotalWork", + "tags": [ + "gettotalwork", + "jobprocessmonitor.gettotalwork" + ], + "title": "JobProcessMonitor.getTotalWork" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#getWorkMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.getWorkMessage", + "tags": [ + "getworkmessage", + "jobprocessmonitor.getworkmessage" + ], + "title": "JobProcessMonitor.getWorkMessage" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#setTotalWork", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.setTotalWork", + "tags": [ + "settotalwork", + "jobprocessmonitor.settotalwork" + ], + "title": "JobProcessMonitor.setTotalWork" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#setWorkMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.setWorkMessage", + "tags": [ + "setworkmessage", + "jobprocessmonitor.setworkmessage" + ], + "title": "JobProcessMonitor.setWorkMessage" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#totalWork", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.totalWork", + "tags": [ + "totalwork", + "jobprocessmonitor.totalwork" + ], + "title": "JobProcessMonitor.totalWork" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#workMessage", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.workMessage", + "tags": [ + "workmessage", + "jobprocessmonitor.workmessage" + ], + "title": "JobProcessMonitor.workMessage" + }, + { + "id": "script-api:dw/system/JobProcessMonitor#worked", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.worked", + "tags": [ + "worked", + "jobprocessmonitor.worked" + ], + "title": "JobProcessMonitor.worked" + }, + { + "id": "script-api:dw/system/Log", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Log", + "tags": [ + "log", + "dw.system.log", + "dw/system" + ], + "title": "Log" + }, + { + "id": "script-api:dw/system/Log#NDC", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.NDC", + "tags": [ + "ndc", + "log.ndc" + ], + "title": "Log.NDC" + }, + { + "id": "script-api:dw/system/Log#NDC", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.NDC", + "tags": [ + "ndc", + "log.ndc" + ], + "title": "Log.NDC" + }, + { + "id": "script-api:dw/system/Log#debug", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.debug", + "tags": [ + "debug", + "log.debug" + ], + "title": "Log.debug" + }, + { + "id": "script-api:dw/system/Log#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.debugEnabled", + "tags": [ + "debugenabled", + "log.debugenabled" + ], + "title": "Log.debugEnabled" + }, + { + "id": "script-api:dw/system/Log#error", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.error", + "tags": [ + "error", + "log.error" + ], + "title": "Log.error" + }, + { + "id": "script-api:dw/system/Log#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.errorEnabled", + "tags": [ + "errorenabled", + "log.errorenabled" + ], + "title": "Log.errorEnabled" + }, + { + "id": "script-api:dw/system/Log#fatal", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.fatal", + "tags": [ + "fatal", + "log.fatal" + ], + "title": "Log.fatal" + }, + { + "id": "script-api:dw/system/Log#getNDC", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.getNDC", + "tags": [ + "getndc", + "log.getndc" + ], + "title": "Log.getNDC" + }, + { + "id": "script-api:dw/system/Log#getNDC", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.getNDC", + "tags": [ + "getndc", + "log.getndc" + ], + "title": "Log.getNDC" + }, + { + "id": "script-api:dw/system/Log#info", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.info", + "tags": [ + "info", + "log.info" + ], + "title": "Log.info" + }, + { + "id": "script-api:dw/system/Log#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.infoEnabled", + "tags": [ + "infoenabled", + "log.infoenabled" + ], + "title": "Log.infoEnabled" + }, + { + "id": "script-api:dw/system/Log#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isDebugEnabled", + "tags": [ + "isdebugenabled", + "log.isdebugenabled" + ], + "title": "Log.isDebugEnabled" + }, + { + "id": "script-api:dw/system/Log#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isErrorEnabled", + "tags": [ + "iserrorenabled", + "log.iserrorenabled" + ], + "title": "Log.isErrorEnabled" + }, + { + "id": "script-api:dw/system/Log#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isInfoEnabled", + "tags": [ + "isinfoenabled", + "log.isinfoenabled" + ], + "title": "Log.isInfoEnabled" + }, + { + "id": "script-api:dw/system/Log#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isWarnEnabled", + "tags": [ + "iswarnenabled", + "log.iswarnenabled" + ], + "title": "Log.isWarnEnabled" + }, + { + "id": "script-api:dw/system/Log#warn", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.warn", + "tags": [ + "warn", + "log.warn" + ], + "title": "Log.warn" + }, + { + "id": "script-api:dw/system/Log#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.warnEnabled", + "tags": [ + "warnenabled", + "log.warnenabled" + ], + "title": "Log.warnEnabled" + }, + { + "id": "script-api:dw/system/LogNDC", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.LogNDC", + "tags": [ + "logndc", + "dw.system.logndc", + "dw/system" + ], + "title": "LogNDC" + }, + { + "id": "script-api:dw/system/LogNDC#peek", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.peek", + "tags": [ + "peek", + "logndc.peek" + ], + "title": "LogNDC.peek" + }, + { + "id": "script-api:dw/system/LogNDC#pop", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.pop", + "tags": [ + "pop", + "logndc.pop" + ], + "title": "LogNDC.pop" + }, + { + "id": "script-api:dw/system/LogNDC#push", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.push", + "tags": [ + "push", + "logndc.push" + ], + "title": "LogNDC.push" + }, + { + "id": "script-api:dw/system/LogNDC#remove", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.remove", + "tags": [ + "remove", + "logndc.remove" + ], + "title": "LogNDC.remove" + }, + { + "id": "script-api:dw/system/Logger", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Logger", + "tags": [ + "logger", + "dw.system.logger", + "dw/system" + ], + "title": "Logger" + }, + { + "id": "script-api:dw/system/Logger#debug", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debug", + "tags": [ + "debug", + "logger.debug" + ], + "title": "Logger.debug" + }, + { + "id": "script-api:dw/system/Logger#debug", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debug", + "tags": [ + "debug", + "logger.debug" + ], + "title": "Logger.debug" + }, + { + "id": "script-api:dw/system/Logger#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debugEnabled", + "tags": [ + "debugenabled", + "logger.debugenabled" + ], + "title": "Logger.debugEnabled" + }, + { + "id": "script-api:dw/system/Logger#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debugEnabled", + "tags": [ + "debugenabled", + "logger.debugenabled" + ], + "title": "Logger.debugEnabled" + }, + { + "id": "script-api:dw/system/Logger#error", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.error", + "tags": [ + "error", + "logger.error" + ], + "title": "Logger.error" + }, + { + "id": "script-api:dw/system/Logger#error", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.error", + "tags": [ + "error", + "logger.error" + ], + "title": "Logger.error" + }, + { + "id": "script-api:dw/system/Logger#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.errorEnabled", + "tags": [ + "errorenabled", + "logger.errorenabled" + ], + "title": "Logger.errorEnabled" + }, + { + "id": "script-api:dw/system/Logger#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.errorEnabled", + "tags": [ + "errorenabled", + "logger.errorenabled" + ], + "title": "Logger.errorEnabled" + }, + { + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "id": "script-api:dw/system/Logger#getRootLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getRootLogger", + "tags": [ + "getrootlogger", + "logger.getrootlogger" + ], + "title": "Logger.getRootLogger" + }, + { + "id": "script-api:dw/system/Logger#getRootLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getRootLogger", + "tags": [ + "getrootlogger", + "logger.getrootlogger" + ], + "title": "Logger.getRootLogger" + }, + { + "id": "script-api:dw/system/Logger#info", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.info", + "tags": [ + "info", + "logger.info" + ], + "title": "Logger.info" + }, + { + "id": "script-api:dw/system/Logger#info", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.info", + "tags": [ + "info", + "logger.info" + ], + "title": "Logger.info" + }, + { + "id": "script-api:dw/system/Logger#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.infoEnabled", + "tags": [ + "infoenabled", + "logger.infoenabled" + ], + "title": "Logger.infoEnabled" + }, + { + "id": "script-api:dw/system/Logger#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.infoEnabled", + "tags": [ + "infoenabled", + "logger.infoenabled" + ], + "title": "Logger.infoEnabled" + }, + { + "id": "script-api:dw/system/Logger#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isDebugEnabled", + "tags": [ + "isdebugenabled", + "logger.isdebugenabled" + ], + "title": "Logger.isDebugEnabled" + }, + { + "id": "script-api:dw/system/Logger#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isDebugEnabled", + "tags": [ + "isdebugenabled", + "logger.isdebugenabled" + ], + "title": "Logger.isDebugEnabled" + }, + { + "id": "script-api:dw/system/Logger#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isErrorEnabled", + "tags": [ + "iserrorenabled", + "logger.iserrorenabled" + ], + "title": "Logger.isErrorEnabled" + }, + { + "id": "script-api:dw/system/Logger#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isErrorEnabled", + "tags": [ + "iserrorenabled", + "logger.iserrorenabled" + ], + "title": "Logger.isErrorEnabled" + }, + { + "id": "script-api:dw/system/Logger#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isInfoEnabled", + "tags": [ + "isinfoenabled", + "logger.isinfoenabled" + ], + "title": "Logger.isInfoEnabled" + }, + { + "id": "script-api:dw/system/Logger#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isInfoEnabled", + "tags": [ + "isinfoenabled", + "logger.isinfoenabled" + ], + "title": "Logger.isInfoEnabled" + }, + { + "id": "script-api:dw/system/Logger#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isWarnEnabled", + "tags": [ + "iswarnenabled", + "logger.iswarnenabled" + ], + "title": "Logger.isWarnEnabled" + }, + { + "id": "script-api:dw/system/Logger#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isWarnEnabled", + "tags": [ + "iswarnenabled", + "logger.iswarnenabled" + ], + "title": "Logger.isWarnEnabled" + }, + { + "id": "script-api:dw/system/Logger#rootLogger", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.rootLogger", + "tags": [ + "rootlogger", + "logger.rootlogger" + ], + "title": "Logger.rootLogger" + }, + { + "id": "script-api:dw/system/Logger#rootLogger", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.rootLogger", + "tags": [ + "rootlogger", + "logger.rootlogger" + ], + "title": "Logger.rootLogger" + }, + { + "id": "script-api:dw/system/Logger#warn", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warn", + "tags": [ + "warn", + "logger.warn" + ], + "title": "Logger.warn" + }, + { + "id": "script-api:dw/system/Logger#warn", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warn", + "tags": [ + "warn", + "logger.warn" + ], + "title": "Logger.warn" + }, + { + "id": "script-api:dw/system/Logger#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warnEnabled", + "tags": [ + "warnenabled", + "logger.warnenabled" + ], + "title": "Logger.warnEnabled" + }, + { + "id": "script-api:dw/system/Logger#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warnEnabled", + "tags": [ + "warnenabled", + "logger.warnenabled" + ], + "title": "Logger.warnEnabled" + }, + { + "id": "script-api:dw/system/OrganizationPreferences", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.OrganizationPreferences", + "tags": [ + "organizationpreferences", + "dw.system.organizationpreferences", + "dw/system" + ], + "title": "OrganizationPreferences" + }, + { + "id": "script-api:dw/system/Pipeline", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Pipeline", + "tags": [ + "pipeline", + "dw.system.pipeline", + "dw/system" + ], + "title": "Pipeline" + }, + { + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "id": "script-api:dw/system/PipelineDictionary", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.PipelineDictionary", + "tags": [ + "pipelinedictionary", + "dw.system.pipelinedictionary", + "dw/system" + ], + "title": "PipelineDictionary" + }, + { + "id": "script-api:dw/system/RESTErrorResponse", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTErrorResponse", + "tags": [ + "resterrorresponse", + "dw.system.resterrorresponse", + "dw/system" + ], + "title": "RESTErrorResponse" + }, + { + "id": "script-api:dw/system/RESTErrorResponse#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.custom", + "tags": [ + "custom", + "resterrorresponse.custom" + ], + "title": "RESTErrorResponse.custom" + }, + { + "id": "script-api:dw/system/RESTErrorResponse#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.getCustom", + "tags": [ + "getcustom", + "resterrorresponse.getcustom" + ], + "title": "RESTErrorResponse.getCustom" + }, + { + "id": "script-api:dw/system/RESTErrorResponse#render", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.render", + "tags": [ + "render", + "resterrorresponse.render" + ], + "title": "RESTErrorResponse.render" + }, + { + "id": "script-api:dw/system/RESTResponseMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTResponseMgr", + "tags": [ + "restresponsemgr", + "dw.system.restresponsemgr", + "dw/system" + ], + "title": "RESTResponseMgr" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createEmptySuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createEmptySuccess", + "tags": [ + "createemptysuccess", + "restresponsemgr.createemptysuccess" + ], + "title": "RESTResponseMgr.createEmptySuccess" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createEmptySuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createEmptySuccess", + "tags": [ + "createemptysuccess", + "restresponsemgr.createemptysuccess" + ], + "title": "RESTResponseMgr.createEmptySuccess" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "title": "RESTResponseMgr.createError" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createScapiRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createScapiRemoteInclude", + "tags": [ + "createscapiremoteinclude", + "restresponsemgr.createscapiremoteinclude" + ], + "title": "RESTResponseMgr.createScapiRemoteInclude" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createScapiRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createScapiRemoteInclude", + "tags": [ + "createscapiremoteinclude", + "restresponsemgr.createscapiremoteinclude" + ], + "title": "RESTResponseMgr.createScapiRemoteInclude" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createStorefrontControllerRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude", + "tags": [ + "createstorefrontcontrollerremoteinclude", + "restresponsemgr.createstorefrontcontrollerremoteinclude" + ], + "title": "RESTResponseMgr.createStorefrontControllerRemoteInclude" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createStorefrontControllerRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude", + "tags": [ + "createstorefrontcontrollerremoteinclude", + "restresponsemgr.createstorefrontcontrollerremoteinclude" + ], + "title": "RESTResponseMgr.createStorefrontControllerRemoteInclude" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "id": "script-api:dw/system/RESTSuccessResponse", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTSuccessResponse", + "tags": [ + "restsuccessresponse", + "dw.system.restsuccessresponse", + "dw/system" + ], + "title": "RESTSuccessResponse" + }, + { + "id": "script-api:dw/system/RESTSuccessResponse#render", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTSuccessResponse", + "qualifiedName": "dw.system.RESTSuccessResponse.render", + "tags": [ + "render", + "restsuccessresponse.render" + ], + "title": "RESTSuccessResponse.render" + }, + { + "id": "script-api:dw/system/RemoteInclude", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RemoteInclude", + "tags": [ + "remoteinclude", + "dw.system.remoteinclude", + "dw/system" + ], + "title": "RemoteInclude" + }, + { + "id": "script-api:dw/system/RemoteInclude#getUrl", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.getUrl", + "tags": [ + "geturl", + "remoteinclude.geturl" + ], + "title": "RemoteInclude.getUrl" + }, + { + "id": "script-api:dw/system/RemoteInclude#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.toString", + "tags": [ + "tostring", + "remoteinclude.tostring" + ], + "title": "RemoteInclude.toString" + }, + { + "id": "script-api:dw/system/RemoteInclude#url", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.url", + "tags": [ + "url", + "remoteinclude.url" + ], + "title": "RemoteInclude.url" + }, + { + "id": "script-api:dw/system/RemoteInclude#valueOf", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.valueOf", + "tags": [ + "valueof", + "remoteinclude.valueof" + ], + "title": "RemoteInclude.valueOf" + }, + { + "id": "script-api:dw/system/Request", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Request", + "tags": [ + "request", + "dw.system.request", + "dw/system" + ], + "title": "Request" + }, + { + "id": "script-api:dw/system/Request#SCAPI", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPI", + "tags": [ + "scapi", + "request.scapi" + ], + "title": "Request.SCAPI" + }, + { + "id": "script-api:dw/system/Request#SCAPIPathParameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPIPathParameters", + "tags": [ + "scapipathparameters", + "request.scapipathparameters" + ], + "title": "Request.SCAPIPathParameters" + }, + { + "id": "script-api:dw/system/Request#SCAPIPathPattern", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPIPathPattern", + "tags": [ + "scapipathpattern", + "request.scapipathpattern" + ], + "title": "Request.SCAPIPathPattern" + }, + { + "id": "script-api:dw/system/Request#addHttpCookie", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.addHttpCookie", + "tags": [ + "addhttpcookie", + "request.addhttpcookie" + ], + "title": "Request.addHttpCookie" + }, + { + "id": "script-api:dw/system/Request#clientId", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.clientId", + "tags": [ + "clientid", + "request.clientid" + ], + "title": "Request.clientId" + }, + { + "id": "script-api:dw/system/Request#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.custom", + "tags": [ + "custom", + "request.custom" + ], + "title": "Request.custom" + }, + { + "id": "script-api:dw/system/Request#geolocation", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.geolocation", + "tags": [ + "geolocation", + "request.geolocation" + ], + "title": "Request.geolocation" + }, + { + "id": "script-api:dw/system/Request#getClientId", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getClientId", + "tags": [ + "getclientid", + "request.getclientid" + ], + "title": "Request.getClientId" + }, + { + "id": "script-api:dw/system/Request#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getCustom", + "tags": [ + "getcustom", + "request.getcustom" + ], + "title": "Request.getCustom" + }, + { + "id": "script-api:dw/system/Request#getGeolocation", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getGeolocation", + "tags": [ + "getgeolocation", + "request.getgeolocation" + ], + "title": "Request.getGeolocation" + }, + { + "id": "script-api:dw/system/Request#getHttpCookies", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpCookies", + "tags": [ + "gethttpcookies", + "request.gethttpcookies" + ], + "title": "Request.getHttpCookies" + }, + { + "id": "script-api:dw/system/Request#getHttpHeaders", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpHeaders", + "tags": [ + "gethttpheaders", + "request.gethttpheaders" + ], + "title": "Request.getHttpHeaders" + }, + { + "id": "script-api:dw/system/Request#getHttpHost", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpHost", + "tags": [ + "gethttphost", + "request.gethttphost" + ], + "title": "Request.getHttpHost" + }, + { + "id": "script-api:dw/system/Request#getHttpLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpLocale", + "tags": [ + "gethttplocale", + "request.gethttplocale" + ], + "title": "Request.getHttpLocale" + }, + { + "id": "script-api:dw/system/Request#getHttpMethod", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpMethod", + "tags": [ + "gethttpmethod", + "request.gethttpmethod" + ], + "title": "Request.getHttpMethod" + }, + { + "id": "script-api:dw/system/Request#getHttpParameterMap", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpParameterMap", + "tags": [ + "gethttpparametermap", + "request.gethttpparametermap" + ], + "title": "Request.getHttpParameterMap" + }, + { + "id": "script-api:dw/system/Request#getHttpParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpParameters", + "tags": [ + "gethttpparameters", + "request.gethttpparameters" + ], + "title": "Request.getHttpParameters" + }, + { + "id": "script-api:dw/system/Request#getHttpPath", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpPath", + "tags": [ + "gethttppath", + "request.gethttppath" + ], + "title": "Request.getHttpPath" + }, + { + "id": "script-api:dw/system/Request#getHttpProtocol", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpProtocol", + "tags": [ + "gethttpprotocol", + "request.gethttpprotocol" + ], + "title": "Request.getHttpProtocol" + }, + { + "id": "script-api:dw/system/Request#getHttpQueryString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpQueryString", + "tags": [ + "gethttpquerystring", + "request.gethttpquerystring" + ], + "title": "Request.getHttpQueryString" + }, + { + "id": "script-api:dw/system/Request#getHttpReferer", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpReferer", + "tags": [ + "gethttpreferer", + "request.gethttpreferer" + ], + "title": "Request.getHttpReferer" + }, + { + "id": "script-api:dw/system/Request#getHttpRemoteAddress", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpRemoteAddress", + "tags": [ + "gethttpremoteaddress", + "request.gethttpremoteaddress" + ], + "title": "Request.getHttpRemoteAddress" + }, + { + "id": "script-api:dw/system/Request#getHttpURL", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpURL", + "tags": [ + "gethttpurl", + "request.gethttpurl" + ], + "title": "Request.getHttpURL" + }, + { + "id": "script-api:dw/system/Request#getHttpUserAgent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpUserAgent", + "tags": [ + "gethttpuseragent", + "request.gethttpuseragent" + ], + "title": "Request.getHttpUserAgent" + }, + { + "id": "script-api:dw/system/Request#getLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getLocale", + "tags": [ + "getlocale", + "request.getlocale" + ], + "title": "Request.getLocale" + }, + { + "id": "script-api:dw/system/Request#getOcapiVersion", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getOcapiVersion", + "tags": [ + "getocapiversion", + "request.getocapiversion" + ], + "title": "Request.getOcapiVersion" + }, + { + "id": "script-api:dw/system/Request#getPageMetaData", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getPageMetaData", + "tags": [ + "getpagemetadata", + "request.getpagemetadata" + ], + "title": "Request.getPageMetaData" + }, + { + "id": "script-api:dw/system/Request#getRequestID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getRequestID", + "tags": [ + "getrequestid", + "request.getrequestid" + ], + "title": "Request.getRequestID" + }, + { + "id": "script-api:dw/system/Request#getSCAPIPathParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSCAPIPathParameters", + "tags": [ + "getscapipathparameters", + "request.getscapipathparameters" + ], + "title": "Request.getSCAPIPathParameters" + }, + { + "id": "script-api:dw/system/Request#getSCAPIPathPattern", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSCAPIPathPattern", + "tags": [ + "getscapipathpattern", + "request.getscapipathpattern" + ], + "title": "Request.getSCAPIPathPattern" + }, + { + "id": "script-api:dw/system/Request#getSession", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSession", + "tags": [ + "getsession", + "request.getsession" + ], + "title": "Request.getSession" + }, + { + "id": "script-api:dw/system/Request#getTriggeredForm", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getTriggeredForm", + "tags": [ + "gettriggeredform", + "request.gettriggeredform" + ], + "title": "Request.getTriggeredForm" + }, + { + "id": "script-api:dw/system/Request#getTriggeredFormAction", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getTriggeredFormAction", + "tags": [ + "gettriggeredformaction", + "request.gettriggeredformaction" + ], + "title": "Request.getTriggeredFormAction" + }, + { + "id": "script-api:dw/system/Request#httpCookies", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpCookies", + "tags": [ + "httpcookies", + "request.httpcookies" + ], + "title": "Request.httpCookies" + }, + { + "id": "script-api:dw/system/Request#httpHeaders", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpHeaders", + "tags": [ + "httpheaders", + "request.httpheaders" + ], + "title": "Request.httpHeaders" + }, + { + "id": "script-api:dw/system/Request#httpHost", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpHost", + "tags": [ + "httphost", + "request.httphost" + ], + "title": "Request.httpHost" + }, + { + "id": "script-api:dw/system/Request#httpLocale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpLocale", + "tags": [ + "httplocale", + "request.httplocale" + ], + "title": "Request.httpLocale" + }, + { + "id": "script-api:dw/system/Request#httpMethod", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpMethod", + "tags": [ + "httpmethod", + "request.httpmethod" + ], + "title": "Request.httpMethod" + }, + { + "id": "script-api:dw/system/Request#httpParameterMap", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpParameterMap", + "tags": [ + "httpparametermap", + "request.httpparametermap" + ], + "title": "Request.httpParameterMap" + }, + { + "id": "script-api:dw/system/Request#httpParameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpParameters", + "tags": [ + "httpparameters", + "request.httpparameters" + ], + "title": "Request.httpParameters" + }, + { + "id": "script-api:dw/system/Request#httpPath", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpPath", + "tags": [ + "httppath", + "request.httppath" + ], + "title": "Request.httpPath" + }, + { + "id": "script-api:dw/system/Request#httpProtocol", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpProtocol", + "tags": [ + "httpprotocol", + "request.httpprotocol" + ], + "title": "Request.httpProtocol" + }, + { + "id": "script-api:dw/system/Request#httpQueryString", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpQueryString", + "tags": [ + "httpquerystring", + "request.httpquerystring" + ], + "title": "Request.httpQueryString" + }, + { + "id": "script-api:dw/system/Request#httpReferer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpReferer", + "tags": [ + "httpreferer", + "request.httpreferer" + ], + "title": "Request.httpReferer" + }, + { + "id": "script-api:dw/system/Request#httpRemoteAddress", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpRemoteAddress", + "tags": [ + "httpremoteaddress", + "request.httpremoteaddress" + ], + "title": "Request.httpRemoteAddress" + }, + { + "id": "script-api:dw/system/Request#httpRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpRequest", + "tags": [ + "httprequest", + "request.httprequest" + ], + "title": "Request.httpRequest" + }, + { + "id": "script-api:dw/system/Request#httpSecure", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpSecure", + "tags": [ + "httpsecure", + "request.httpsecure" + ], + "title": "Request.httpSecure" + }, + { + "id": "script-api:dw/system/Request#httpURL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpURL", + "tags": [ + "httpurl", + "request.httpurl" + ], + "title": "Request.httpURL" + }, + { + "id": "script-api:dw/system/Request#httpUserAgent", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpUserAgent", + "tags": [ + "httpuseragent", + "request.httpuseragent" + ], + "title": "Request.httpUserAgent" + }, + { + "id": "script-api:dw/system/Request#includeRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.includeRequest", + "tags": [ + "includerequest", + "request.includerequest" + ], + "title": "Request.includeRequest" + }, + { + "id": "script-api:dw/system/Request#isHttpRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isHttpRequest", + "tags": [ + "ishttprequest", + "request.ishttprequest" + ], + "title": "Request.isHttpRequest" + }, + { + "id": "script-api:dw/system/Request#isHttpSecure", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isHttpSecure", + "tags": [ + "ishttpsecure", + "request.ishttpsecure" + ], + "title": "Request.isHttpSecure" + }, + { + "id": "script-api:dw/system/Request#isIncludeRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isIncludeRequest", + "tags": [ + "isincluderequest", + "request.isincluderequest" + ], + "title": "Request.isIncludeRequest" + }, + { + "id": "script-api:dw/system/Request#isSCAPI", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isSCAPI", + "tags": [ + "isscapi", + "request.isscapi" + ], + "title": "Request.isSCAPI" + }, + { + "id": "script-api:dw/system/Request#locale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.locale", + "tags": [ + "locale", + "request.locale" + ], + "title": "Request.locale" + }, + { + "id": "script-api:dw/system/Request#ocapiVersion", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.ocapiVersion", + "tags": [ + "ocapiversion", + "request.ocapiversion" + ], + "title": "Request.ocapiVersion" + }, + { + "id": "script-api:dw/system/Request#pageMetaData", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.pageMetaData", + "tags": [ + "pagemetadata", + "request.pagemetadata" + ], + "title": "Request.pageMetaData" + }, + { + "id": "script-api:dw/system/Request#requestID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.requestID", + "tags": [ + "requestid", + "request.requestid" + ], + "title": "Request.requestID" + }, + { + "id": "script-api:dw/system/Request#session", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.session", + "tags": [ + "session", + "request.session" + ], + "title": "Request.session" + }, + { + "id": "script-api:dw/system/Request#setGeolocation", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.setGeolocation", + "tags": [ + "setgeolocation", + "request.setgeolocation" + ], + "title": "Request.setGeolocation" + }, + { + "id": "script-api:dw/system/Request#setLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.setLocale", + "tags": [ + "setlocale", + "request.setlocale" + ], + "title": "Request.setLocale" + }, + { + "id": "script-api:dw/system/Request#triggeredForm", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.triggeredForm", + "tags": [ + "triggeredform", + "request.triggeredform" + ], + "title": "Request.triggeredForm" + }, + { + "id": "script-api:dw/system/Request#triggeredFormAction", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.triggeredFormAction", + "tags": [ + "triggeredformaction", + "request.triggeredformaction" + ], + "title": "Request.triggeredFormAction" + }, + { + "id": "script-api:dw/system/RequestHooks", + "kind": "interface", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RequestHooks", + "tags": [ + "requesthooks", + "dw.system.requesthooks", + "dw/system" + ], + "title": "RequestHooks" + }, + { + "id": "script-api:dw/system/RequestHooks#extensionPointOnRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.extensionPointOnRequest", + "tags": [ + "extensionpointonrequest", + "requesthooks.extensionpointonrequest" + ], + "title": "RequestHooks.extensionPointOnRequest" + }, + { + "id": "script-api:dw/system/RequestHooks#extensionPointOnSession", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.extensionPointOnSession", + "tags": [ + "extensionpointonsession", + "requesthooks.extensionpointonsession" + ], + "title": "RequestHooks.extensionPointOnSession" + }, + { + "id": "script-api:dw/system/RequestHooks#onRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.onRequest", + "tags": [ + "onrequest", + "requesthooks.onrequest" + ], + "title": "RequestHooks.onRequest" + }, + { + "id": "script-api:dw/system/RequestHooks#onSession", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.onSession", + "tags": [ + "onsession", + "requesthooks.onsession" + ], + "title": "RequestHooks.onSession" + }, + { + "id": "script-api:dw/system/Response", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Response", + "tags": [ + "response", + "dw.system.response", + "dw/system" + ], + "title": "Response" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_CREDENTIALS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_CREDENTIALS", + "tags": [ + "access_control_allow_credentials", + "response.access_control_allow_credentials" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_CREDENTIALS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_CREDENTIALS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_CREDENTIALS", + "tags": [ + "access_control_allow_credentials", + "response.access_control_allow_credentials" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_CREDENTIALS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_HEADERS", + "tags": [ + "access_control_allow_headers", + "response.access_control_allow_headers" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_HEADERS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_HEADERS", + "tags": [ + "access_control_allow_headers", + "response.access_control_allow_headers" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_HEADERS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_METHODS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_METHODS", + "tags": [ + "access_control_allow_methods", + "response.access_control_allow_methods" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_METHODS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_METHODS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_METHODS", + "tags": [ + "access_control_allow_methods", + "response.access_control_allow_methods" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_METHODS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_ORIGIN", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_ORIGIN", + "tags": [ + "access_control_allow_origin", + "response.access_control_allow_origin" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_ORIGIN" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_ORIGIN", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_ORIGIN", + "tags": [ + "access_control_allow_origin", + "response.access_control_allow_origin" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_ORIGIN" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_EXPOSE_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_EXPOSE_HEADERS", + "tags": [ + "access_control_expose_headers", + "response.access_control_expose_headers" + ], + "title": "Response.ACCESS_CONTROL_EXPOSE_HEADERS" + }, + { + "id": "script-api:dw/system/Response#ACCESS_CONTROL_EXPOSE_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_EXPOSE_HEADERS", + "tags": [ + "access_control_expose_headers", + "response.access_control_expose_headers" + ], + "title": "Response.ACCESS_CONTROL_EXPOSE_HEADERS" + }, + { + "id": "script-api:dw/system/Response#ALLOW", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ALLOW", + "tags": [ + "allow", + "response.allow" + ], + "title": "Response.ALLOW" + }, + { + "id": "script-api:dw/system/Response#ALLOW", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ALLOW", + "tags": [ + "allow", + "response.allow" + ], + "title": "Response.ALLOW" + }, + { + "id": "script-api:dw/system/Response#CONTENT_DISPOSITION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_DISPOSITION", + "tags": [ + "content_disposition", + "response.content_disposition" + ], + "title": "Response.CONTENT_DISPOSITION" + }, + { + "id": "script-api:dw/system/Response#CONTENT_DISPOSITION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_DISPOSITION", + "tags": [ + "content_disposition", + "response.content_disposition" + ], + "title": "Response.CONTENT_DISPOSITION" + }, + { + "id": "script-api:dw/system/Response#CONTENT_LANGUAGE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LANGUAGE", + "tags": [ + "content_language", + "response.content_language" + ], + "title": "Response.CONTENT_LANGUAGE" + }, + { + "id": "script-api:dw/system/Response#CONTENT_LANGUAGE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LANGUAGE", + "tags": [ + "content_language", + "response.content_language" + ], + "title": "Response.CONTENT_LANGUAGE" + }, + { + "id": "script-api:dw/system/Response#CONTENT_LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LOCATION", + "tags": [ + "content_location", + "response.content_location" + ], + "title": "Response.CONTENT_LOCATION" + }, + { + "id": "script-api:dw/system/Response#CONTENT_LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LOCATION", + "tags": [ + "content_location", + "response.content_location" + ], + "title": "Response.CONTENT_LOCATION" + }, + { + "id": "script-api:dw/system/Response#CONTENT_MD5", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_MD5", + "tags": [ + "content_md5", + "response.content_md5" + ], + "title": "Response.CONTENT_MD5" + }, + { + "id": "script-api:dw/system/Response#CONTENT_MD5", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_MD5", + "tags": [ + "content_md5", + "response.content_md5" + ], + "title": "Response.CONTENT_MD5" + }, + { + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY", + "tags": [ + "content_security_policy", + "response.content_security_policy" + ], + "title": "Response.CONTENT_SECURITY_POLICY" + }, + { + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY", + "tags": [ + "content_security_policy", + "response.content_security_policy" + ], + "title": "Response.CONTENT_SECURITY_POLICY" + }, + { + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY_REPORT_ONLY", + "tags": [ + "content_security_policy_report_only", + "response.content_security_policy_report_only" + ], + "title": "Response.CONTENT_SECURITY_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY_REPORT_ONLY", + "tags": [ + "content_security_policy_report_only", + "response.content_security_policy_report_only" + ], + "title": "Response.CONTENT_SECURITY_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CONTENT_TYPE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_TYPE", + "tags": [ + "content_type", + "response.content_type" + ], + "title": "Response.CONTENT_TYPE" + }, + { + "id": "script-api:dw/system/Response#CONTENT_TYPE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_TYPE", + "tags": [ + "content_type", + "response.content_type" + ], + "title": "Response.CONTENT_TYPE" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY", + "tags": [ + "cross_origin_embedder_policy", + "response.cross_origin_embedder_policy" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY", + "tags": [ + "cross_origin_embedder_policy", + "response.cross_origin_embedder_policy" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "tags": [ + "cross_origin_embedder_policy_report_only", + "response.cross_origin_embedder_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "tags": [ + "cross_origin_embedder_policy_report_only", + "response.cross_origin_embedder_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY", + "tags": [ + "cross_origin_opener_policy", + "response.cross_origin_opener_policy" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY", + "tags": [ + "cross_origin_opener_policy", + "response.cross_origin_opener_policy" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "tags": [ + "cross_origin_opener_policy_report_only", + "response.cross_origin_opener_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "tags": [ + "cross_origin_opener_policy_report_only", + "response.cross_origin_opener_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_RESOURCE_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_RESOURCE_POLICY", + "tags": [ + "cross_origin_resource_policy", + "response.cross_origin_resource_policy" + ], + "title": "Response.CROSS_ORIGIN_RESOURCE_POLICY" + }, + { + "id": "script-api:dw/system/Response#CROSS_ORIGIN_RESOURCE_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_RESOURCE_POLICY", + "tags": [ + "cross_origin_resource_policy", + "response.cross_origin_resource_policy" + ], + "title": "Response.CROSS_ORIGIN_RESOURCE_POLICY" + }, + { + "id": "script-api:dw/system/Response#LINK", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LINK", + "tags": [ + "link", + "response.link" + ], + "title": "Response.LINK" + }, + { + "id": "script-api:dw/system/Response#LINK", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LINK", + "tags": [ + "link", + "response.link" + ], + "title": "Response.LINK" + }, + { + "id": "script-api:dw/system/Response#LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LOCATION", + "tags": [ + "location", + "response.location" + ], + "title": "Response.LOCATION" + }, + { + "id": "script-api:dw/system/Response#LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LOCATION", + "tags": [ + "location", + "response.location" + ], + "title": "Response.LOCATION" + }, + { + "id": "script-api:dw/system/Response#PERMISSIONS_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PERMISSIONS_POLICY", + "tags": [ + "permissions_policy", + "response.permissions_policy" + ], + "title": "Response.PERMISSIONS_POLICY" + }, + { + "id": "script-api:dw/system/Response#PERMISSIONS_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PERMISSIONS_POLICY", + "tags": [ + "permissions_policy", + "response.permissions_policy" + ], + "title": "Response.PERMISSIONS_POLICY" + }, + { + "id": "script-api:dw/system/Response#PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "tags": [ + "platform_for_privacy_preferences_project", + "response.platform_for_privacy_preferences_project" + ], + "title": "Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT" + }, + { + "id": "script-api:dw/system/Response#PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "tags": [ + "platform_for_privacy_preferences_project", + "response.platform_for_privacy_preferences_project" + ], + "title": "Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT" + }, + { + "id": "script-api:dw/system/Response#REFERRER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFERRER_POLICY", + "tags": [ + "referrer_policy", + "response.referrer_policy" + ], + "title": "Response.REFERRER_POLICY" + }, + { + "id": "script-api:dw/system/Response#REFERRER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFERRER_POLICY", + "tags": [ + "referrer_policy", + "response.referrer_policy" + ], + "title": "Response.REFERRER_POLICY" + }, + { + "id": "script-api:dw/system/Response#REFRESH", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFRESH", + "tags": [ + "refresh", + "response.refresh" + ], + "title": "Response.REFRESH" + }, + { + "id": "script-api:dw/system/Response#REFRESH", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFRESH", + "tags": [ + "refresh", + "response.refresh" + ], + "title": "Response.REFRESH" + }, + { + "id": "script-api:dw/system/Response#RETRY_AFTER", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.RETRY_AFTER", + "tags": [ + "retry_after", + "response.retry_after" + ], + "title": "Response.RETRY_AFTER" + }, + { + "id": "script-api:dw/system/Response#RETRY_AFTER", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.RETRY_AFTER", + "tags": [ + "retry_after", + "response.retry_after" + ], + "title": "Response.RETRY_AFTER" + }, + { + "id": "script-api:dw/system/Response#SERVICE_WORKER_ALLOWED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.SERVICE_WORKER_ALLOWED", + "tags": [ + "service_worker_allowed", + "response.service_worker_allowed" + ], + "title": "Response.SERVICE_WORKER_ALLOWED" + }, + { + "id": "script-api:dw/system/Response#SERVICE_WORKER_ALLOWED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.SERVICE_WORKER_ALLOWED", + "tags": [ + "service_worker_allowed", + "response.service_worker_allowed" + ], + "title": "Response.SERVICE_WORKER_ALLOWED" + }, + { + "id": "script-api:dw/system/Response#VARY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.VARY", + "tags": [ + "vary", + "response.vary" + ], + "title": "Response.VARY" + }, + { + "id": "script-api:dw/system/Response#VARY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.VARY", + "tags": [ + "vary", + "response.vary" + ], + "title": "Response.VARY" + }, + { + "id": "script-api:dw/system/Response#X_CONTENT_TYPE_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_CONTENT_TYPE_OPTIONS", + "tags": [ + "x_content_type_options", + "response.x_content_type_options" + ], + "title": "Response.X_CONTENT_TYPE_OPTIONS" + }, + { + "id": "script-api:dw/system/Response#X_CONTENT_TYPE_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_CONTENT_TYPE_OPTIONS", + "tags": [ + "x_content_type_options", + "response.x_content_type_options" + ], + "title": "Response.X_CONTENT_TYPE_OPTIONS" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS", + "tags": [ + "x_frame_options", + "response.x_frame_options" + ], + "title": "Response.X_FRAME_OPTIONS" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS", + "tags": [ + "x_frame_options", + "response.x_frame_options" + ], + "title": "Response.X_FRAME_OPTIONS" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_ALLOW_FROM", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_ALLOW_FROM", + "tags": [ + "x_frame_options_allow_from", + "response.x_frame_options_allow_from" + ], + "title": "Response.X_FRAME_OPTIONS_ALLOW_FROM" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_ALLOW_FROM", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_ALLOW_FROM", + "tags": [ + "x_frame_options_allow_from", + "response.x_frame_options_allow_from" + ], + "title": "Response.X_FRAME_OPTIONS_ALLOW_FROM" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_DENY_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_DENY_VALUE", + "tags": [ + "x_frame_options_deny_value", + "response.x_frame_options_deny_value" + ], + "title": "Response.X_FRAME_OPTIONS_DENY_VALUE" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_DENY_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_DENY_VALUE", + "tags": [ + "x_frame_options_deny_value", + "response.x_frame_options_deny_value" + ], + "title": "Response.X_FRAME_OPTIONS_DENY_VALUE" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "tags": [ + "x_frame_options_sameorigin_value", + "response.x_frame_options_sameorigin_value" + ], + "title": "Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE" + }, + { + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "tags": [ + "x_frame_options_sameorigin_value", + "response.x_frame_options_sameorigin_value" + ], + "title": "Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE" + }, + { + "id": "script-api:dw/system/Response#X_ROBOTS_TAG", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_ROBOTS_TAG", + "tags": [ + "x_robots_tag", + "response.x_robots_tag" + ], + "title": "Response.X_ROBOTS_TAG" + }, + { + "id": "script-api:dw/system/Response#X_ROBOTS_TAG", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_ROBOTS_TAG", + "tags": [ + "x_robots_tag", + "response.x_robots_tag" + ], + "title": "Response.X_ROBOTS_TAG" + }, + { + "id": "script-api:dw/system/Response#X_XSS_PROTECTION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_XSS_PROTECTION", + "tags": [ + "x_xss_protection", + "response.x_xss_protection" + ], + "title": "Response.X_XSS_PROTECTION" + }, + { + "id": "script-api:dw/system/Response#X_XSS_PROTECTION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_XSS_PROTECTION", + "tags": [ + "x_xss_protection", + "response.x_xss_protection" + ], + "title": "Response.X_XSS_PROTECTION" + }, + { + "id": "script-api:dw/system/Response#addHttpCookie", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.addHttpCookie", + "tags": [ + "addhttpcookie", + "response.addhttpcookie" + ], + "title": "Response.addHttpCookie" + }, + { + "id": "script-api:dw/system/Response#addHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.addHttpHeader", + "tags": [ + "addhttpheader", + "response.addhttpheader" + ], + "title": "Response.addHttpHeader" + }, + { + "id": "script-api:dw/system/Response#containsHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.containsHttpHeader", + "tags": [ + "containshttpheader", + "response.containshttpheader" + ], + "title": "Response.containsHttpHeader" + }, + { + "id": "script-api:dw/system/Response#getWriter", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.getWriter", + "tags": [ + "getwriter", + "response.getwriter" + ], + "title": "Response.getWriter" + }, + { + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "id": "script-api:dw/system/Response#setBuffered", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setBuffered", + "tags": [ + "setbuffered", + "response.setbuffered" + ], + "title": "Response.setBuffered" + }, + { + "id": "script-api:dw/system/Response#setContentType", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setContentType", + "tags": [ + "setcontenttype", + "response.setcontenttype" + ], + "title": "Response.setContentType" + }, + { + "id": "script-api:dw/system/Response#setExpires", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setExpires", + "tags": [ + "setexpires", + "response.setexpires" + ], + "title": "Response.setExpires" + }, + { + "id": "script-api:dw/system/Response#setExpires", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setExpires", + "tags": [ + "setexpires", + "response.setexpires" + ], + "title": "Response.setExpires" + }, + { + "id": "script-api:dw/system/Response#setHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setHttpHeader", + "tags": [ + "sethttpheader", + "response.sethttpheader" + ], + "title": "Response.setHttpHeader" + }, + { + "id": "script-api:dw/system/Response#setStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setStatus", + "tags": [ + "setstatus", + "response.setstatus" + ], + "title": "Response.setStatus" + }, + { + "id": "script-api:dw/system/Response#setVaryBy", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setVaryBy", + "tags": [ + "setvaryby", + "response.setvaryby" + ], + "title": "Response.setVaryBy" + }, + { + "id": "script-api:dw/system/Response#writer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.writer", + "tags": [ + "writer", + "response.writer" + ], + "title": "Response.writer" + }, + { + "id": "script-api:dw/system/SearchStatus", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.SearchStatus", + "tags": [ + "searchstatus", + "dw.system.searchstatus", + "dw/system" + ], + "title": "SearchStatus" + }, + { + "id": "script-api:dw/system/SearchStatus#EMPTY_QUERY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.EMPTY_QUERY", + "tags": [ + "empty_query", + "searchstatus.empty_query" + ], + "title": "SearchStatus.EMPTY_QUERY" + }, + { + "id": "script-api:dw/system/SearchStatus#EMPTY_QUERY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.EMPTY_QUERY", + "tags": [ + "empty_query", + "searchstatus.empty_query" + ], + "title": "SearchStatus.EMPTY_QUERY" + }, + { + "id": "script-api:dw/system/SearchStatus#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ERROR", + "tags": [ + "error", + "searchstatus.error" + ], + "title": "SearchStatus.ERROR" + }, + { + "id": "script-api:dw/system/SearchStatus#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ERROR", + "tags": [ + "error", + "searchstatus.error" + ], + "title": "SearchStatus.ERROR" + }, + { + "id": "script-api:dw/system/SearchStatus#LIMITED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.LIMITED", + "tags": [ + "limited", + "searchstatus.limited" + ], + "title": "SearchStatus.LIMITED" + }, + { + "id": "script-api:dw/system/SearchStatus#LIMITED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.LIMITED", + "tags": [ + "limited", + "searchstatus.limited" + ], + "title": "SearchStatus.LIMITED" + }, + { + "id": "script-api:dw/system/SearchStatus#NOT_EXECUTED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NOT_EXECUTED", + "tags": [ + "not_executed", + "searchstatus.not_executed" + ], + "title": "SearchStatus.NOT_EXECUTED" + }, + { + "id": "script-api:dw/system/SearchStatus#NOT_EXECUTED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NOT_EXECUTED", + "tags": [ + "not_executed", + "searchstatus.not_executed" + ], + "title": "SearchStatus.NOT_EXECUTED" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_CATALOG", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATALOG", + "tags": [ + "no_catalog", + "searchstatus.no_catalog" + ], + "title": "SearchStatus.NO_CATALOG" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_CATALOG", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATALOG", + "tags": [ + "no_catalog", + "searchstatus.no_catalog" + ], + "title": "SearchStatus.NO_CATALOG" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATEGORY", + "tags": [ + "no_category", + "searchstatus.no_category" + ], + "title": "SearchStatus.NO_CATEGORY" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATEGORY", + "tags": [ + "no_category", + "searchstatus.no_category" + ], + "title": "SearchStatus.NO_CATEGORY" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_INDEX", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_INDEX", + "tags": [ + "no_index", + "searchstatus.no_index" + ], + "title": "SearchStatus.NO_INDEX" + }, + { + "id": "script-api:dw/system/SearchStatus#NO_INDEX", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_INDEX", + "tags": [ + "no_index", + "searchstatus.no_index" + ], + "title": "SearchStatus.NO_INDEX" + }, + { + "id": "script-api:dw/system/SearchStatus#OFFLINE_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.OFFLINE_CATEGORY", + "tags": [ + "offline_category", + "searchstatus.offline_category" + ], + "title": "SearchStatus.OFFLINE_CATEGORY" + }, + { + "id": "script-api:dw/system/SearchStatus#OFFLINE_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.OFFLINE_CATEGORY", + "tags": [ + "offline_category", + "searchstatus.offline_category" + ], + "title": "SearchStatus.OFFLINE_CATEGORY" + }, + { + "id": "script-api:dw/system/SearchStatus#ROOT_SEARCH", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ROOT_SEARCH", + "tags": [ + "root_search", + "searchstatus.root_search" + ], + "title": "SearchStatus.ROOT_SEARCH" + }, + { + "id": "script-api:dw/system/SearchStatus#ROOT_SEARCH", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ROOT_SEARCH", + "tags": [ + "root_search", + "searchstatus.root_search" + ], + "title": "SearchStatus.ROOT_SEARCH" + }, + { + "id": "script-api:dw/system/SearchStatus#SUCCESSFUL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.SUCCESSFUL", + "tags": [ + "successful", + "searchstatus.successful" + ], + "title": "SearchStatus.SUCCESSFUL" + }, + { + "id": "script-api:dw/system/SearchStatus#SUCCESSFUL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.SUCCESSFUL", + "tags": [ + "successful", + "searchstatus.successful" + ], + "title": "SearchStatus.SUCCESSFUL" + }, + { + "id": "script-api:dw/system/SearchStatus#description", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.description", + "tags": [ + "description", + "searchstatus.description" + ], + "title": "SearchStatus.description" + }, + { + "id": "script-api:dw/system/SearchStatus#getDescription", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.getDescription", + "tags": [ + "getdescription", + "searchstatus.getdescription" + ], + "title": "SearchStatus.getDescription" + }, + { + "id": "script-api:dw/system/SearchStatus#getStatusCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.getStatusCode", + "tags": [ + "getstatuscode", + "searchstatus.getstatuscode" + ], + "title": "SearchStatus.getStatusCode" + }, + { + "id": "script-api:dw/system/SearchStatus#statusCode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.statusCode", + "tags": [ + "statuscode", + "searchstatus.statuscode" + ], + "title": "SearchStatus.statusCode" + }, + { + "id": "script-api:dw/system/SearchStatus#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.toString", + "tags": [ + "tostring", + "searchstatus.tostring" + ], + "title": "SearchStatus.toString" + }, + { + "id": "script-api:dw/system/Session", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Session", + "tags": [ + "session", + "dw.system.session", + "dw/system" + ], + "title": "Session" + }, + { + "id": "script-api:dw/system/Session#clickStream", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.clickStream", + "tags": [ + "clickstream", + "session.clickstream" + ], + "title": "Session.clickStream" + }, + { + "id": "script-api:dw/system/Session#currency", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.currency", + "tags": [ + "currency", + "session.currency" + ], + "title": "Session.currency" + }, + { + "id": "script-api:dw/system/Session#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.custom", + "tags": [ + "custom", + "session.custom" + ], + "title": "Session.custom" + }, + { + "id": "script-api:dw/system/Session#customer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customer", + "tags": [ + "customer", + "session.customer" + ], + "title": "Session.customer" + }, + { + "id": "script-api:dw/system/Session#customerAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customerAuthenticated", + "tags": [ + "customerauthenticated", + "session.customerauthenticated" + ], + "title": "Session.customerAuthenticated" + }, + { + "id": "script-api:dw/system/Session#customerExternallyAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customerExternallyAuthenticated", + "tags": [ + "customerexternallyauthenticated", + "session.customerexternallyauthenticated" + ], + "title": "Session.customerExternallyAuthenticated" + }, + { + "id": "script-api:dw/system/Session#forms", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.forms", + "tags": [ + "forms", + "session.forms" + ], + "title": "Session.forms" + }, + { + "id": "script-api:dw/system/Session#generateGuestSessionSignature", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.generateGuestSessionSignature", + "tags": [ + "generateguestsessionsignature", + "session.generateguestsessionsignature" + ], + "title": "Session.generateGuestSessionSignature" + }, + { + "id": "script-api:dw/system/Session#generateRegisteredSessionSignature", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.generateRegisteredSessionSignature", + "tags": [ + "generateregisteredsessionsignature", + "session.generateregisteredsessionsignature" + ], + "title": "Session.generateRegisteredSessionSignature" + }, + { + "id": "script-api:dw/system/Session#getClickStream", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getClickStream", + "tags": [ + "getclickstream", + "session.getclickstream" + ], + "title": "Session.getClickStream" + }, + { + "id": "script-api:dw/system/Session#getCurrency", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCurrency", + "tags": [ + "getcurrency", + "session.getcurrency" + ], + "title": "Session.getCurrency" + }, + { + "id": "script-api:dw/system/Session#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCustom", + "tags": [ + "getcustom", + "session.getcustom" + ], + "title": "Session.getCustom" + }, + { + "id": "script-api:dw/system/Session#getCustomer", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCustomer", + "tags": [ + "getcustomer", + "session.getcustomer" + ], + "title": "Session.getCustomer" + }, + { + "id": "script-api:dw/system/Session#getForms", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getForms", + "tags": [ + "getforms", + "session.getforms" + ], + "title": "Session.getForms" + }, + { + "id": "script-api:dw/system/Session#getLastReceivedSourceCodeInfo", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getLastReceivedSourceCodeInfo", + "tags": [ + "getlastreceivedsourcecodeinfo", + "session.getlastreceivedsourcecodeinfo" + ], + "title": "Session.getLastReceivedSourceCodeInfo" + }, + { + "id": "script-api:dw/system/Session#getPrivacy", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getPrivacy", + "tags": [ + "getprivacy", + "session.getprivacy" + ], + "title": "Session.getPrivacy" + }, + { + "id": "script-api:dw/system/Session#getSessionID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getSessionID", + "tags": [ + "getsessionid", + "session.getsessionid" + ], + "title": "Session.getSessionID" + }, + { + "id": "script-api:dw/system/Session#getSourceCodeInfo", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getSourceCodeInfo", + "tags": [ + "getsourcecodeinfo", + "session.getsourcecodeinfo" + ], + "title": "Session.getSourceCodeInfo" + }, + { + "id": "script-api:dw/system/Session#getUserName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getUserName", + "tags": [ + "getusername", + "session.getusername" + ], + "title": "Session.getUserName" + }, + { + "id": "script-api:dw/system/Session#isCustomerAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isCustomerAuthenticated", + "tags": [ + "iscustomerauthenticated", + "session.iscustomerauthenticated" + ], + "title": "Session.isCustomerAuthenticated" + }, + { + "id": "script-api:dw/system/Session#isCustomerExternallyAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isCustomerExternallyAuthenticated", + "tags": [ + "iscustomerexternallyauthenticated", + "session.iscustomerexternallyauthenticated" + ], + "title": "Session.isCustomerExternallyAuthenticated" + }, + { + "id": "script-api:dw/system/Session#isTrackingAllowed", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isTrackingAllowed", + "tags": [ + "istrackingallowed", + "session.istrackingallowed" + ], + "title": "Session.isTrackingAllowed" + }, + { + "id": "script-api:dw/system/Session#isUserAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isUserAuthenticated", + "tags": [ + "isuserauthenticated", + "session.isuserauthenticated" + ], + "title": "Session.isUserAuthenticated" + }, + { + "id": "script-api:dw/system/Session#lastReceivedSourceCodeInfo", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.lastReceivedSourceCodeInfo", + "tags": [ + "lastreceivedsourcecodeinfo", + "session.lastreceivedsourcecodeinfo" + ], + "title": "Session.lastReceivedSourceCodeInfo" + }, + { + "id": "script-api:dw/system/Session#privacy", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.privacy", + "tags": [ + "privacy", + "session.privacy" + ], + "title": "Session.privacy" + }, + { + "id": "script-api:dw/system/Session#sessionID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.sessionID", + "tags": [ + "sessionid", + "session.sessionid" + ], + "title": "Session.sessionID" + }, + { + "id": "script-api:dw/system/Session#setCurrency", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setCurrency", + "tags": [ + "setcurrency", + "session.setcurrency" + ], + "title": "Session.setCurrency" + }, + { + "id": "script-api:dw/system/Session#setSourceCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setSourceCode", + "tags": [ + "setsourcecode", + "session.setsourcecode" + ], + "title": "Session.setSourceCode" + }, + { + "id": "script-api:dw/system/Session#setTrackingAllowed", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setTrackingAllowed", + "tags": [ + "settrackingallowed", + "session.settrackingallowed" + ], + "title": "Session.setTrackingAllowed" + }, + { + "id": "script-api:dw/system/Session#sourceCodeInfo", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.sourceCodeInfo", + "tags": [ + "sourcecodeinfo", + "session.sourcecodeinfo" + ], + "title": "Session.sourceCodeInfo" + }, + { + "id": "script-api:dw/system/Session#trackingAllowed", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.trackingAllowed", + "tags": [ + "trackingallowed", + "session.trackingallowed" + ], + "title": "Session.trackingAllowed" + }, + { + "id": "script-api:dw/system/Session#userAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.userAuthenticated", + "tags": [ + "userauthenticated", + "session.userauthenticated" + ], + "title": "Session.userAuthenticated" + }, + { + "id": "script-api:dw/system/Session#userName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.userName", + "tags": [ + "username", + "session.username" + ], + "title": "Session.userName" + }, + { + "id": "script-api:dw/system/Site", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Site", + "tags": [ + "site", + "dw.system.site", + "dw/system" + ], + "title": "Site" + }, + { + "id": "script-api:dw/system/Site#ID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.ID", + "tags": [ + "id", + "site.id" + ], + "title": "Site.ID" + }, + { + "id": "script-api:dw/system/Site#OMSEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.OMSEnabled", + "tags": [ + "omsenabled", + "site.omsenabled" + ], + "title": "Site.OMSEnabled" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_MAINTENANCE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_MAINTENANCE", + "tags": [ + "site_status_maintenance", + "site.site_status_maintenance" + ], + "title": "Site.SITE_STATUS_MAINTENANCE" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_MAINTENANCE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_MAINTENANCE", + "tags": [ + "site_status_maintenance", + "site.site_status_maintenance" + ], + "title": "Site.SITE_STATUS_MAINTENANCE" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_ONLINE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_ONLINE", + "tags": [ + "site_status_online", + "site.site_status_online" + ], + "title": "Site.SITE_STATUS_ONLINE" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_ONLINE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_ONLINE", + "tags": [ + "site_status_online", + "site.site_status_online" + ], + "title": "Site.SITE_STATUS_ONLINE" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_PROTECTED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_PROTECTED", + "tags": [ + "site_status_protected", + "site.site_status_protected" + ], + "title": "Site.SITE_STATUS_PROTECTED" + }, + { + "id": "script-api:dw/system/Site#SITE_STATUS_PROTECTED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_PROTECTED", + "tags": [ + "site_status_protected", + "site.site_status_protected" + ], + "title": "Site.SITE_STATUS_PROTECTED" + }, + { + "id": "script-api:dw/system/Site#allSites", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allSites", + "tags": [ + "allsites", + "site.allsites" + ], + "title": "Site.allSites" + }, + { + "id": "script-api:dw/system/Site#allSites", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allSites", + "tags": [ + "allsites", + "site.allsites" + ], + "title": "Site.allSites" + }, + { + "id": "script-api:dw/system/Site#allowedCurrencies", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allowedCurrencies", + "tags": [ + "allowedcurrencies", + "site.allowedcurrencies" + ], + "title": "Site.allowedCurrencies" + }, + { + "id": "script-api:dw/system/Site#allowedLocales", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allowedLocales", + "tags": [ + "allowedlocales", + "site.allowedlocales" + ], + "title": "Site.allowedLocales" + }, + { + "id": "script-api:dw/system/Site#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.calendar", + "tags": [ + "calendar", + "site.calendar" + ], + "title": "Site.calendar" + }, + { + "id": "script-api:dw/system/Site#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.calendar", + "tags": [ + "calendar", + "site.calendar" + ], + "title": "Site.calendar" + }, + { + "id": "script-api:dw/system/Site#currencyCode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.currencyCode", + "tags": [ + "currencycode", + "site.currencycode" + ], + "title": "Site.currencyCode" + }, + { + "id": "script-api:dw/system/Site#current", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.current", + "tags": [ + "current", + "site.current" + ], + "title": "Site.current" + }, + { + "id": "script-api:dw/system/Site#current", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.current", + "tags": [ + "current", + "site.current" + ], + "title": "Site.current" + }, + { + "id": "script-api:dw/system/Site#defaultCurrency", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.defaultCurrency", + "tags": [ + "defaultcurrency", + "site.defaultcurrency" + ], + "title": "Site.defaultCurrency" + }, + { + "id": "script-api:dw/system/Site#defaultLocale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.defaultLocale", + "tags": [ + "defaultlocale", + "site.defaultlocale" + ], + "title": "Site.defaultLocale" + }, + { + "id": "script-api:dw/system/Site#einsteinSiteID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.einsteinSiteID", + "tags": [ + "einsteinsiteid", + "site.einsteinsiteid" + ], + "title": "Site.einsteinSiteID" + }, + { + "id": "script-api:dw/system/Site#getAllSites", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllSites", + "tags": [ + "getallsites", + "site.getallsites" + ], + "title": "Site.getAllSites" + }, + { + "id": "script-api:dw/system/Site#getAllSites", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllSites", + "tags": [ + "getallsites", + "site.getallsites" + ], + "title": "Site.getAllSites" + }, + { + "id": "script-api:dw/system/Site#getAllowedCurrencies", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllowedCurrencies", + "tags": [ + "getallowedcurrencies", + "site.getallowedcurrencies" + ], + "title": "Site.getAllowedCurrencies" + }, + { + "id": "script-api:dw/system/Site#getAllowedLocales", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllowedLocales", + "tags": [ + "getallowedlocales", + "site.getallowedlocales" + ], + "title": "Site.getAllowedLocales" + }, + { + "id": "script-api:dw/system/Site#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCalendar", + "tags": [ + "getcalendar", + "site.getcalendar" + ], + "title": "Site.getCalendar" + }, + { + "id": "script-api:dw/system/Site#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCalendar", + "tags": [ + "getcalendar", + "site.getcalendar" + ], + "title": "Site.getCalendar" + }, + { + "id": "script-api:dw/system/Site#getCurrencyCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrencyCode", + "tags": [ + "getcurrencycode", + "site.getcurrencycode" + ], + "title": "Site.getCurrencyCode" + }, + { + "id": "script-api:dw/system/Site#getCurrent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrent", + "tags": [ + "getcurrent", + "site.getcurrent" + ], + "title": "Site.getCurrent" + }, + { + "id": "script-api:dw/system/Site#getCurrent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrent", + "tags": [ + "getcurrent", + "site.getcurrent" + ], + "title": "Site.getCurrent" + }, + { + "id": "script-api:dw/system/Site#getCustomPreferenceValue", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCustomPreferenceValue", + "tags": [ + "getcustompreferencevalue", + "site.getcustompreferencevalue" + ], + "title": "Site.getCustomPreferenceValue" + }, + { + "id": "script-api:dw/system/Site#getDefaultCurrency", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getDefaultCurrency", + "tags": [ + "getdefaultcurrency", + "site.getdefaultcurrency" + ], + "title": "Site.getDefaultCurrency" + }, + { + "id": "script-api:dw/system/Site#getDefaultLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getDefaultLocale", + "tags": [ + "getdefaultlocale", + "site.getdefaultlocale" + ], + "title": "Site.getDefaultLocale" + }, + { + "id": "script-api:dw/system/Site#getEinsteinSiteID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getEinsteinSiteID", + "tags": [ + "geteinsteinsiteid", + "site.geteinsteinsiteid" + ], + "title": "Site.getEinsteinSiteID" + }, + { + "id": "script-api:dw/system/Site#getHttpHostName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getHttpHostName", + "tags": [ + "gethttphostname", + "site.gethttphostname" + ], + "title": "Site.getHttpHostName" + }, + { + "id": "script-api:dw/system/Site#getHttpsHostName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getHttpsHostName", + "tags": [ + "gethttpshostname", + "site.gethttpshostname" + ], + "title": "Site.getHttpsHostName" + }, + { + "id": "script-api:dw/system/Site#getID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getID", + "tags": [ + "getid", + "site.getid" + ], + "title": "Site.getID" + }, + { + "id": "script-api:dw/system/Site#getName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getName", + "tags": [ + "getname", + "site.getname" + ], + "title": "Site.getName" + }, + { + "id": "script-api:dw/system/Site#getPageMetaTag", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPageMetaTag", + "tags": [ + "getpagemetatag", + "site.getpagemetatag" + ], + "title": "Site.getPageMetaTag" + }, + { + "id": "script-api:dw/system/Site#getPageMetaTags", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPageMetaTags", + "tags": [ + "getpagemetatags", + "site.getpagemetatags" + ], + "title": "Site.getPageMetaTags" + }, + { + "id": "script-api:dw/system/Site#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPreferences", + "tags": [ + "getpreferences", + "site.getpreferences" + ], + "title": "Site.getPreferences" + }, + { + "id": "script-api:dw/system/Site#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getStatus", + "tags": [ + "getstatus", + "site.getstatus" + ], + "title": "Site.getStatus" + }, + { + "id": "script-api:dw/system/Site#getTimezone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getTimezone", + "tags": [ + "gettimezone", + "site.gettimezone" + ], + "title": "Site.getTimezone" + }, + { + "id": "script-api:dw/system/Site#getTimezoneOffset", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getTimezoneOffset", + "tags": [ + "gettimezoneoffset", + "site.gettimezoneoffset" + ], + "title": "Site.getTimezoneOffset" + }, + { + "id": "script-api:dw/system/Site#httpHostName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.httpHostName", + "tags": [ + "httphostname", + "site.httphostname" + ], + "title": "Site.httpHostName" + }, + { + "id": "script-api:dw/system/Site#httpsHostName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.httpsHostName", + "tags": [ + "httpshostname", + "site.httpshostname" + ], + "title": "Site.httpsHostName" + }, + { + "id": "script-api:dw/system/Site#isOMSEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.isOMSEnabled", + "tags": [ + "isomsenabled", + "site.isomsenabled" + ], + "title": "Site.isOMSEnabled" + }, + { + "id": "script-api:dw/system/Site#name", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.name", + "tags": [ + "name", + "site.name" + ], + "title": "Site.name" + }, + { + "id": "script-api:dw/system/Site#pageMetaTags", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.pageMetaTags", + "tags": [ + "pagemetatags", + "site.pagemetatags" + ], + "title": "Site.pageMetaTags" + }, + { + "id": "script-api:dw/system/Site#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.preferences", + "tags": [ + "preferences", + "site.preferences" + ], + "title": "Site.preferences" + }, + { + "id": "script-api:dw/system/Site#setCustomPreferenceValue", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.setCustomPreferenceValue", + "tags": [ + "setcustompreferencevalue", + "site.setcustompreferencevalue" + ], + "title": "Site.setCustomPreferenceValue" + }, + { + "id": "script-api:dw/system/Site#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.status", + "tags": [ + "status", + "site.status" + ], + "title": "Site.status" + }, + { + "id": "script-api:dw/system/Site#timezone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.timezone", + "tags": [ + "timezone", + "site.timezone" + ], + "title": "Site.timezone" + }, + { + "id": "script-api:dw/system/Site#timezoneOffset", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.timezoneOffset", + "tags": [ + "timezoneoffset", + "site.timezoneoffset" + ], + "title": "Site.timezoneOffset" + }, + { + "id": "script-api:dw/system/SitePreferences", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.SitePreferences", + "tags": [ + "sitepreferences", + "dw.system.sitepreferences", + "dw/system" + ], + "title": "SitePreferences" + }, + { + "id": "script-api:dw/system/SitePreferences#getSourceCodeURLParameterName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SitePreferences", + "qualifiedName": "dw.system.SitePreferences.getSourceCodeURLParameterName", + "tags": [ + "getsourcecodeurlparametername", + "sitepreferences.getsourcecodeurlparametername" + ], + "title": "SitePreferences.getSourceCodeURLParameterName" + }, + { + "id": "script-api:dw/system/SitePreferences#sourceCodeURLParameterName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SitePreferences", + "qualifiedName": "dw.system.SitePreferences.sourceCodeURLParameterName", + "tags": [ + "sourcecodeurlparametername", + "sitepreferences.sourcecodeurlparametername" + ], + "title": "SitePreferences.sourceCodeURLParameterName" + }, + { + "id": "script-api:dw/system/Status", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Status", + "tags": [ + "status", + "dw.system.status", + "dw/system" + ], + "title": "Status" + }, + { + "id": "script-api:dw/system/Status#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.ERROR", + "tags": [ + "error", + "status.error" + ], + "title": "Status.ERROR" + }, + { + "id": "script-api:dw/system/Status#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.ERROR", + "tags": [ + "error", + "status.error" + ], + "title": "Status.ERROR" + }, + { + "id": "script-api:dw/system/Status#OK", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.OK", + "tags": [ + "ok", + "status.ok" + ], + "title": "Status.OK" + }, + { + "id": "script-api:dw/system/Status#OK", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.OK", + "tags": [ + "ok", + "status.ok" + ], + "title": "Status.OK" + }, + { + "id": "script-api:dw/system/Status#addDetail", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.addDetail", + "tags": [ + "adddetail", + "status.adddetail" + ], + "title": "Status.addDetail" + }, + { + "id": "script-api:dw/system/Status#addItem", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.addItem", + "tags": [ + "additem", + "status.additem" + ], + "title": "Status.addItem" + }, + { + "id": "script-api:dw/system/Status#code", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.code", + "tags": [ + "code", + "status.code" + ], + "title": "Status.code" + }, + { + "id": "script-api:dw/system/Status#details", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.details", + "tags": [ + "details", + "status.details" + ], + "title": "Status.details" + }, + { + "id": "script-api:dw/system/Status#error", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.error", + "tags": [ + "error", + "status.error" + ], + "title": "Status.error" + }, + { + "id": "script-api:dw/system/Status#getCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getCode", + "tags": [ + "getcode", + "status.getcode" + ], + "title": "Status.getCode" + }, + { + "id": "script-api:dw/system/Status#getDetail", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getDetail", + "tags": [ + "getdetail", + "status.getdetail" + ], + "title": "Status.getDetail" + }, + { + "id": "script-api:dw/system/Status#getDetails", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getDetails", + "tags": [ + "getdetails", + "status.getdetails" + ], + "title": "Status.getDetails" + }, + { + "id": "script-api:dw/system/Status#getItems", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getItems", + "tags": [ + "getitems", + "status.getitems" + ], + "title": "Status.getItems" + }, + { + "id": "script-api:dw/system/Status#getMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getMessage", + "tags": [ + "getmessage", + "status.getmessage" + ], + "title": "Status.getMessage" + }, + { + "id": "script-api:dw/system/Status#getParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getParameters", + "tags": [ + "getparameters", + "status.getparameters" + ], + "title": "Status.getParameters" + }, + { + "id": "script-api:dw/system/Status#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getStatus", + "tags": [ + "getstatus", + "status.getstatus" + ], + "title": "Status.getStatus" + }, + { + "id": "script-api:dw/system/Status#isError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.isError", + "tags": [ + "iserror", + "status.iserror" + ], + "title": "Status.isError" + }, + { + "id": "script-api:dw/system/Status#items", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.items", + "tags": [ + "items", + "status.items" + ], + "title": "Status.items" + }, + { + "id": "script-api:dw/system/Status#message", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.message", + "tags": [ + "message", + "status.message" + ], + "title": "Status.message" + }, + { + "id": "script-api:dw/system/Status#parameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.parameters", + "tags": [ + "parameters", + "status.parameters" + ], + "title": "Status.parameters" + }, + { + "id": "script-api:dw/system/Status#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.status", + "tags": [ + "status", + "status.status" + ], + "title": "Status.status" + }, + { + "id": "script-api:dw/system/StatusItem", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.StatusItem", + "tags": [ + "statusitem", + "dw.system.statusitem", + "dw/system" + ], + "title": "StatusItem" + }, + { + "id": "script-api:dw/system/StatusItem#addDetail", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.addDetail", + "tags": [ + "adddetail", + "statusitem.adddetail" + ], + "title": "StatusItem.addDetail" + }, + { + "id": "script-api:dw/system/StatusItem#code", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.code", + "tags": [ + "code", + "statusitem.code" + ], + "title": "StatusItem.code" + }, + { + "id": "script-api:dw/system/StatusItem#details", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.details", + "tags": [ + "details", + "statusitem.details" + ], + "title": "StatusItem.details" + }, + { + "id": "script-api:dw/system/StatusItem#error", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.error", + "tags": [ + "error", + "statusitem.error" + ], + "title": "StatusItem.error" + }, + { + "id": "script-api:dw/system/StatusItem#getCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getCode", + "tags": [ + "getcode", + "statusitem.getcode" + ], + "title": "StatusItem.getCode" + }, + { + "id": "script-api:dw/system/StatusItem#getDetails", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getDetails", + "tags": [ + "getdetails", + "statusitem.getdetails" + ], + "title": "StatusItem.getDetails" + }, + { + "id": "script-api:dw/system/StatusItem#getMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getMessage", + "tags": [ + "getmessage", + "statusitem.getmessage" + ], + "title": "StatusItem.getMessage" + }, + { + "id": "script-api:dw/system/StatusItem#getParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getParameters", + "tags": [ + "getparameters", + "statusitem.getparameters" + ], + "title": "StatusItem.getParameters" + }, + { + "id": "script-api:dw/system/StatusItem#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getStatus", + "tags": [ + "getstatus", + "statusitem.getstatus" + ], + "title": "StatusItem.getStatus" + }, + { + "id": "script-api:dw/system/StatusItem#isError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.isError", + "tags": [ + "iserror", + "statusitem.iserror" + ], + "title": "StatusItem.isError" + }, + { + "id": "script-api:dw/system/StatusItem#message", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.message", + "tags": [ + "message", + "statusitem.message" + ], + "title": "StatusItem.message" + }, + { + "id": "script-api:dw/system/StatusItem#parameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.parameters", + "tags": [ + "parameters", + "statusitem.parameters" + ], + "title": "StatusItem.parameters" + }, + { + "id": "script-api:dw/system/StatusItem#setCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setCode", + "tags": [ + "setcode", + "statusitem.setcode" + ], + "title": "StatusItem.setCode" + }, + { + "id": "script-api:dw/system/StatusItem#setMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setMessage", + "tags": [ + "setmessage", + "statusitem.setmessage" + ], + "title": "StatusItem.setMessage" + }, + { + "id": "script-api:dw/system/StatusItem#setParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setParameters", + "tags": [ + "setparameters", + "statusitem.setparameters" + ], + "title": "StatusItem.setParameters" + }, + { + "id": "script-api:dw/system/StatusItem#setStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setStatus", + "tags": [ + "setstatus", + "statusitem.setstatus" + ], + "title": "StatusItem.setStatus" + }, + { + "id": "script-api:dw/system/StatusItem#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.status", + "tags": [ + "status", + "statusitem.status" + ], + "title": "StatusItem.status" + }, + { + "id": "script-api:dw/system/System", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.System", + "tags": [ + "system", + "dw.system.system", + "dw/system" + ], + "title": "System" + }, + { + "id": "script-api:dw/system/System#DEVELOPMENT_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.DEVELOPMENT_SYSTEM", + "tags": [ + "development_system", + "system.development_system" + ], + "title": "System.DEVELOPMENT_SYSTEM" + }, + { + "id": "script-api:dw/system/System#DEVELOPMENT_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.DEVELOPMENT_SYSTEM", + "tags": [ + "development_system", + "system.development_system" + ], + "title": "System.DEVELOPMENT_SYSTEM" + }, + { + "id": "script-api:dw/system/System#PRODUCTION_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.PRODUCTION_SYSTEM", + "tags": [ + "production_system", + "system.production_system" + ], + "title": "System.PRODUCTION_SYSTEM" + }, + { + "id": "script-api:dw/system/System#PRODUCTION_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.PRODUCTION_SYSTEM", + "tags": [ + "production_system", + "system.production_system" + ], + "title": "System.PRODUCTION_SYSTEM" + }, + { + "id": "script-api:dw/system/System#STAGING_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.STAGING_SYSTEM", + "tags": [ + "staging_system", + "system.staging_system" + ], + "title": "System.STAGING_SYSTEM" + }, + { + "id": "script-api:dw/system/System#STAGING_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.STAGING_SYSTEM", + "tags": [ + "staging_system", + "system.staging_system" + ], + "title": "System.STAGING_SYSTEM" + }, + { + "id": "script-api:dw/system/System#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.calendar", + "tags": [ + "calendar", + "system.calendar" + ], + "title": "System.calendar" + }, + { + "id": "script-api:dw/system/System#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.calendar", + "tags": [ + "calendar", + "system.calendar" + ], + "title": "System.calendar" + }, + { + "id": "script-api:dw/system/System#compatibilityMode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.compatibilityMode", + "tags": [ + "compatibilitymode", + "system.compatibilitymode" + ], + "title": "System.compatibilityMode" + }, + { + "id": "script-api:dw/system/System#compatibilityMode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.compatibilityMode", + "tags": [ + "compatibilitymode", + "system.compatibilitymode" + ], + "title": "System.compatibilityMode" + }, + { + "id": "script-api:dw/system/System#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCalendar", + "tags": [ + "getcalendar", + "system.getcalendar" + ], + "title": "System.getCalendar" + }, + { + "id": "script-api:dw/system/System#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCalendar", + "tags": [ + "getcalendar", + "system.getcalendar" + ], + "title": "System.getCalendar" + }, + { + "id": "script-api:dw/system/System#getCompatibilityMode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCompatibilityMode", + "tags": [ + "getcompatibilitymode", + "system.getcompatibilitymode" + ], + "title": "System.getCompatibilityMode" + }, + { + "id": "script-api:dw/system/System#getCompatibilityMode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCompatibilityMode", + "tags": [ + "getcompatibilitymode", + "system.getcompatibilitymode" + ], + "title": "System.getCompatibilityMode" + }, + { + "id": "script-api:dw/system/System#getInstanceHostname", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceHostname", + "tags": [ + "getinstancehostname", + "system.getinstancehostname" + ], + "title": "System.getInstanceHostname" + }, + { + "id": "script-api:dw/system/System#getInstanceHostname", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceHostname", + "tags": [ + "getinstancehostname", + "system.getinstancehostname" + ], + "title": "System.getInstanceHostname" + }, + { + "id": "script-api:dw/system/System#getInstanceTimeZone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceTimeZone", + "tags": [ + "getinstancetimezone", + "system.getinstancetimezone" + ], + "title": "System.getInstanceTimeZone" + }, + { + "id": "script-api:dw/system/System#getInstanceTimeZone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceTimeZone", + "tags": [ + "getinstancetimezone", + "system.getinstancetimezone" + ], + "title": "System.getInstanceTimeZone" + }, + { + "id": "script-api:dw/system/System#getInstanceType", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceType", + "tags": [ + "getinstancetype", + "system.getinstancetype" + ], + "title": "System.getInstanceType" + }, + { + "id": "script-api:dw/system/System#getInstanceType", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceType", + "tags": [ + "getinstancetype", + "system.getinstancetype" + ], + "title": "System.getInstanceType" + }, + { + "id": "script-api:dw/system/System#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getPreferences", + "tags": [ + "getpreferences", + "system.getpreferences" + ], + "title": "System.getPreferences" + }, + { + "id": "script-api:dw/system/System#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getPreferences", + "tags": [ + "getpreferences", + "system.getpreferences" + ], + "title": "System.getPreferences" + }, + { + "id": "script-api:dw/system/System#instanceHostname", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceHostname", + "tags": [ + "instancehostname", + "system.instancehostname" + ], + "title": "System.instanceHostname" + }, + { + "id": "script-api:dw/system/System#instanceHostname", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceHostname", + "tags": [ + "instancehostname", + "system.instancehostname" + ], + "title": "System.instanceHostname" + }, + { + "id": "script-api:dw/system/System#instanceTimeZone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceTimeZone", + "tags": [ + "instancetimezone", + "system.instancetimezone" + ], + "title": "System.instanceTimeZone" + }, + { + "id": "script-api:dw/system/System#instanceTimeZone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceTimeZone", + "tags": [ + "instancetimezone", + "system.instancetimezone" + ], + "title": "System.instanceTimeZone" + }, + { + "id": "script-api:dw/system/System#instanceType", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceType", + "tags": [ + "instancetype", + "system.instancetype" + ], + "title": "System.instanceType" + }, + { + "id": "script-api:dw/system/System#instanceType", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceType", + "tags": [ + "instancetype", + "system.instancetype" + ], + "title": "System.instanceType" + }, + { + "id": "script-api:dw/system/System#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.preferences", + "tags": [ + "preferences", + "system.preferences" + ], + "title": "System.preferences" + }, + { + "id": "script-api:dw/system/System#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.preferences", + "tags": [ + "preferences", + "system.preferences" + ], + "title": "System.preferences" + }, + { + "id": "script-api:dw/system/Transaction", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Transaction", + "tags": [ + "transaction", + "dw.system.transaction", + "dw/system" + ], + "title": "Transaction" + }, + { + "id": "script-api:dw/system/Transaction#begin", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.begin", + "tags": [ + "begin", + "transaction.begin" + ], + "title": "Transaction.begin" + }, + { + "id": "script-api:dw/system/Transaction#begin", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.begin", + "tags": [ + "begin", + "transaction.begin" + ], + "title": "Transaction.begin" + }, + { + "id": "script-api:dw/system/Transaction#commit", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.commit", + "tags": [ + "commit", + "transaction.commit" + ], + "title": "Transaction.commit" + }, + { + "id": "script-api:dw/system/Transaction#commit", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.commit", + "tags": [ + "commit", + "transaction.commit" + ], + "title": "Transaction.commit" + }, + { + "id": "script-api:dw/system/Transaction#rollback", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.rollback", + "tags": [ + "rollback", + "transaction.rollback" + ], + "title": "Transaction.rollback" + }, + { + "id": "script-api:dw/system/Transaction#rollback", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.rollback", + "tags": [ + "rollback", + "transaction.rollback" + ], + "title": "Transaction.rollback" + }, + { + "id": "script-api:dw/system/Transaction#wrap", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.wrap", + "tags": [ + "wrap", + "transaction.wrap" + ], + "title": "Transaction.wrap" + }, + { + "id": "script-api:dw/system/Transaction#wrap", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.wrap", + "tags": [ + "wrap", + "transaction.wrap" + ], + "title": "Transaction.wrap" + }, + { + "id": "script-api:dw/template", + "kind": "package", + "packagePath": "dw/template", + "qualifiedName": "dw.template", + "tags": [ + "dw/template", + "dw.template" + ], + "title": "dw.template" + }, + { + "id": "script-api:dw/template/ISML", + "kind": "class", + "packagePath": "dw/template", + "parentId": "script-api:dw/template", + "qualifiedName": "dw.template.ISML", + "tags": [ + "isml", + "dw.template.isml", + "dw/template" + ], + "title": "ISML" + }, + { + "id": "script-api:dw/template/ISML#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/ISML", + "qualifiedName": "dw.template.ISML.renderTemplate", + "tags": [ + "rendertemplate", + "isml.rendertemplate" + ], + "title": "ISML.renderTemplate" + }, + { + "id": "script-api:dw/template/ISML#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/ISML", + "qualifiedName": "dw.template.ISML.renderTemplate", + "tags": [ + "rendertemplate", + "isml.rendertemplate" + ], + "title": "ISML.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity", + "kind": "class", + "packagePath": "dw/template", + "parentId": "script-api:dw/template", + "qualifiedName": "dw.template.Velocity", + "tags": [ + "velocity", + "dw.template.velocity", + "dw/template" + ], + "title": "Velocity" + }, + { + "id": "script-api:dw/template/Velocity#remoteInclude", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.remoteInclude", + "tags": [ + "remoteinclude", + "velocity.remoteinclude" + ], + "title": "Velocity.remoteInclude" + }, + { + "id": "script-api:dw/template/Velocity#remoteInclude", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.remoteInclude", + "tags": [ + "remoteinclude", + "velocity.remoteinclude" + ], + "title": "Velocity.remoteInclude" + }, + { + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "id": "script-api:dw/util", + "kind": "package", + "packagePath": "dw/util", + "qualifiedName": "dw.util", + "tags": [ + "dw/util", + "dw.util" + ], + "title": "dw.util" + }, + { + "id": "script-api:dw/util/ArrayList", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.ArrayList", + "tags": [ + "arraylist", + "dw.util.arraylist", + "dw/util" + ], + "title": "ArrayList" + }, + { + "id": "script-api:dw/util/ArrayList#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/ArrayList", + "qualifiedName": "dw.util.ArrayList.clone", + "tags": [ + "clone", + "arraylist.clone" + ], + "title": "ArrayList.clone" + }, + { + "id": "script-api:dw/util/Assert", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Assert", + "tags": [ + "assert", + "dw.util.assert", + "dw/util" + ], + "title": "Assert" + }, + { + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "id": "script-api:dw/util/BigInteger", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.BigInteger", + "tags": [ + "biginteger", + "dw.util.biginteger", + "dw/util" + ], + "title": "BigInteger" + }, + { + "id": "script-api:dw/util/BigInteger#abs", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.abs", + "tags": [ + "abs", + "biginteger.abs" + ], + "title": "BigInteger.abs" + }, + { + "id": "script-api:dw/util/BigInteger#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.add", + "tags": [ + "add", + "biginteger.add" + ], + "title": "BigInteger.add" + }, + { + "id": "script-api:dw/util/BigInteger#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.add", + "tags": [ + "add", + "biginteger.add" + ], + "title": "BigInteger.add" + }, + { + "id": "script-api:dw/util/BigInteger#divide", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.divide", + "tags": [ + "divide", + "biginteger.divide" + ], + "title": "BigInteger.divide" + }, + { + "id": "script-api:dw/util/BigInteger#divide", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.divide", + "tags": [ + "divide", + "biginteger.divide" + ], + "title": "BigInteger.divide" + }, + { + "id": "script-api:dw/util/BigInteger#equals", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.equals", + "tags": [ + "equals", + "biginteger.equals" + ], + "title": "BigInteger.equals" + }, + { + "id": "script-api:dw/util/BigInteger#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.get", + "tags": [ + "get", + "biginteger.get" + ], + "title": "BigInteger.get" + }, + { + "id": "script-api:dw/util/BigInteger#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.hashCode", + "tags": [ + "hashcode", + "biginteger.hashcode" + ], + "title": "BigInteger.hashCode" + }, + { + "id": "script-api:dw/util/BigInteger#multiply", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.multiply", + "tags": [ + "multiply", + "biginteger.multiply" + ], + "title": "BigInteger.multiply" + }, + { + "id": "script-api:dw/util/BigInteger#multiply", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.multiply", + "tags": [ + "multiply", + "biginteger.multiply" + ], + "title": "BigInteger.multiply" + }, + { + "id": "script-api:dw/util/BigInteger#negate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.negate", + "tags": [ + "negate", + "biginteger.negate" + ], + "title": "BigInteger.negate" + }, + { + "id": "script-api:dw/util/BigInteger#subtract", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.subtract", + "tags": [ + "subtract", + "biginteger.subtract" + ], + "title": "BigInteger.subtract" + }, + { + "id": "script-api:dw/util/BigInteger#subtract", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.subtract", + "tags": [ + "subtract", + "biginteger.subtract" + ], + "title": "BigInteger.subtract" + }, + { + "id": "script-api:dw/util/BigInteger#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.toString", + "tags": [ + "tostring", + "biginteger.tostring" + ], + "title": "BigInteger.toString" + }, + { + "id": "script-api:dw/util/BigInteger#valueOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.valueOf", + "tags": [ + "valueof", + "biginteger.valueof" + ], + "title": "BigInteger.valueOf" + }, + { + "id": "script-api:dw/util/Bytes", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Bytes", + "tags": [ + "bytes", + "dw.util.bytes", + "dw/util" + ], + "title": "Bytes" + }, + { + "id": "script-api:dw/util/Bytes#MAX_BYTES", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.MAX_BYTES", + "tags": [ + "max_bytes", + "bytes.max_bytes" + ], + "title": "Bytes.MAX_BYTES" + }, + { + "id": "script-api:dw/util/Bytes#MAX_BYTES", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.MAX_BYTES", + "tags": [ + "max_bytes", + "bytes.max_bytes" + ], + "title": "Bytes.MAX_BYTES" + }, + { + "id": "script-api:dw/util/Bytes#asUint8Array", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.asUint8Array", + "tags": [ + "asuint8array", + "bytes.asuint8array" + ], + "title": "Bytes.asUint8Array" + }, + { + "id": "script-api:dw/util/Bytes#byteAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.byteAt", + "tags": [ + "byteat", + "bytes.byteat" + ], + "title": "Bytes.byteAt" + }, + { + "id": "script-api:dw/util/Bytes#bytesAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.bytesAt", + "tags": [ + "bytesat", + "bytes.bytesat" + ], + "title": "Bytes.bytesAt" + }, + { + "id": "script-api:dw/util/Bytes#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.getLength", + "tags": [ + "getlength", + "bytes.getlength" + ], + "title": "Bytes.getLength" + }, + { + "id": "script-api:dw/util/Bytes#intAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.intAt", + "tags": [ + "intat", + "bytes.intat" + ], + "title": "Bytes.intAt" + }, + { + "id": "script-api:dw/util/Bytes#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.length", + "tags": [ + "length", + "bytes.length" + ], + "title": "Bytes.length" + }, + { + "id": "script-api:dw/util/Bytes#reverse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.reverse", + "tags": [ + "reverse", + "bytes.reverse" + ], + "title": "Bytes.reverse" + }, + { + "id": "script-api:dw/util/Bytes#shortAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.shortAt", + "tags": [ + "shortat", + "bytes.shortat" + ], + "title": "Bytes.shortAt" + }, + { + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "tags": [ + "tostring", + "bytes.tostring" + ], + "title": "Bytes.toString" + }, + { + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "tags": [ + "tostring", + "bytes.tostring" + ], + "title": "Bytes.toString" + }, + { + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "tags": [ + "tostring", + "bytes.tostring" + ], + "title": "Bytes.toString" + }, + { + "id": "script-api:dw/util/Calendar", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Calendar", + "tags": [ + "calendar", + "dw.util.calendar", + "dw/util" + ], + "title": "Calendar" + }, + { + "id": "script-api:dw/util/Calendar#AM_PM", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AM_PM", + "tags": [ + "am_pm", + "calendar.am_pm" + ], + "title": "Calendar.AM_PM" + }, + { + "id": "script-api:dw/util/Calendar#AM_PM", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AM_PM", + "tags": [ + "am_pm", + "calendar.am_pm" + ], + "title": "Calendar.AM_PM" + }, + { + "id": "script-api:dw/util/Calendar#APRIL", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.APRIL", + "tags": [ + "april", + "calendar.april" + ], + "title": "Calendar.APRIL" + }, + { + "id": "script-api:dw/util/Calendar#APRIL", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.APRIL", + "tags": [ + "april", + "calendar.april" + ], + "title": "Calendar.APRIL" + }, + { + "id": "script-api:dw/util/Calendar#AUGUST", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AUGUST", + "tags": [ + "august", + "calendar.august" + ], + "title": "Calendar.AUGUST" + }, + { + "id": "script-api:dw/util/Calendar#AUGUST", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AUGUST", + "tags": [ + "august", + "calendar.august" + ], + "title": "Calendar.AUGUST" + }, + { + "id": "script-api:dw/util/Calendar#DATE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DATE", + "tags": [ + "date", + "calendar.date" + ], + "title": "Calendar.DATE" + }, + { + "id": "script-api:dw/util/Calendar#DATE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DATE", + "tags": [ + "date", + "calendar.date" + ], + "title": "Calendar.DATE" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_MONTH", + "tags": [ + "day_of_month", + "calendar.day_of_month" + ], + "title": "Calendar.DAY_OF_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_MONTH", + "tags": [ + "day_of_month", + "calendar.day_of_month" + ], + "title": "Calendar.DAY_OF_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK", + "tags": [ + "day_of_week", + "calendar.day_of_week" + ], + "title": "Calendar.DAY_OF_WEEK" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK", + "tags": [ + "day_of_week", + "calendar.day_of_week" + ], + "title": "Calendar.DAY_OF_WEEK" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK_IN_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK_IN_MONTH", + "tags": [ + "day_of_week_in_month", + "calendar.day_of_week_in_month" + ], + "title": "Calendar.DAY_OF_WEEK_IN_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK_IN_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK_IN_MONTH", + "tags": [ + "day_of_week_in_month", + "calendar.day_of_week_in_month" + ], + "title": "Calendar.DAY_OF_WEEK_IN_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_YEAR", + "tags": [ + "day_of_year", + "calendar.day_of_year" + ], + "title": "Calendar.DAY_OF_YEAR" + }, + { + "id": "script-api:dw/util/Calendar#DAY_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_YEAR", + "tags": [ + "day_of_year", + "calendar.day_of_year" + ], + "title": "Calendar.DAY_OF_YEAR" + }, + { + "id": "script-api:dw/util/Calendar#DECEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DECEMBER", + "tags": [ + "december", + "calendar.december" + ], + "title": "Calendar.DECEMBER" + }, + { + "id": "script-api:dw/util/Calendar#DECEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DECEMBER", + "tags": [ + "december", + "calendar.december" + ], + "title": "Calendar.DECEMBER" + }, + { + "id": "script-api:dw/util/Calendar#DST_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DST_OFFSET", + "tags": [ + "dst_offset", + "calendar.dst_offset" + ], + "title": "Calendar.DST_OFFSET" + }, + { + "id": "script-api:dw/util/Calendar#DST_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DST_OFFSET", + "tags": [ + "dst_offset", + "calendar.dst_offset" + ], + "title": "Calendar.DST_OFFSET" + }, + { + "id": "script-api:dw/util/Calendar#ERA", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ERA", + "tags": [ + "era", + "calendar.era" + ], + "title": "Calendar.ERA" + }, + { + "id": "script-api:dw/util/Calendar#ERA", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ERA", + "tags": [ + "era", + "calendar.era" + ], + "title": "Calendar.ERA" + }, + { + "id": "script-api:dw/util/Calendar#FEBRUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FEBRUARY", + "tags": [ + "february", + "calendar.february" + ], + "title": "Calendar.FEBRUARY" + }, + { + "id": "script-api:dw/util/Calendar#FEBRUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FEBRUARY", + "tags": [ + "february", + "calendar.february" + ], + "title": "Calendar.FEBRUARY" + }, + { + "id": "script-api:dw/util/Calendar#FRIDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FRIDAY", + "tags": [ + "friday", + "calendar.friday" + ], + "title": "Calendar.FRIDAY" + }, + { + "id": "script-api:dw/util/Calendar#FRIDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FRIDAY", + "tags": [ + "friday", + "calendar.friday" + ], + "title": "Calendar.FRIDAY" + }, + { + "id": "script-api:dw/util/Calendar#HOUR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR", + "tags": [ + "hour", + "calendar.hour" + ], + "title": "Calendar.HOUR" + }, + { + "id": "script-api:dw/util/Calendar#HOUR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR", + "tags": [ + "hour", + "calendar.hour" + ], + "title": "Calendar.HOUR" + }, + { + "id": "script-api:dw/util/Calendar#HOUR_OF_DAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR_OF_DAY", + "tags": [ + "hour_of_day", + "calendar.hour_of_day" + ], + "title": "Calendar.HOUR_OF_DAY" + }, + { + "id": "script-api:dw/util/Calendar#HOUR_OF_DAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR_OF_DAY", + "tags": [ + "hour_of_day", + "calendar.hour_of_day" + ], + "title": "Calendar.HOUR_OF_DAY" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_PATTERN", + "tags": [ + "input_date_pattern", + "calendar.input_date_pattern" + ], + "title": "Calendar.INPUT_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_PATTERN", + "tags": [ + "input_date_pattern", + "calendar.input_date_pattern" + ], + "title": "Calendar.INPUT_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_DATE_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_TIME_PATTERN", + "tags": [ + "input_date_time_pattern", + "calendar.input_date_time_pattern" + ], + "title": "Calendar.INPUT_DATE_TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_DATE_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_TIME_PATTERN", + "tags": [ + "input_date_time_pattern", + "calendar.input_date_time_pattern" + ], + "title": "Calendar.INPUT_DATE_TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_TIME_PATTERN", + "tags": [ + "input_time_pattern", + "calendar.input_time_pattern" + ], + "title": "Calendar.INPUT_TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#INPUT_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_TIME_PATTERN", + "tags": [ + "input_time_pattern", + "calendar.input_time_pattern" + ], + "title": "Calendar.INPUT_TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#JANUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JANUARY", + "tags": [ + "january", + "calendar.january" + ], + "title": "Calendar.JANUARY" + }, + { + "id": "script-api:dw/util/Calendar#JANUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JANUARY", + "tags": [ + "january", + "calendar.january" + ], + "title": "Calendar.JANUARY" + }, + { + "id": "script-api:dw/util/Calendar#JULY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JULY", + "tags": [ + "july", + "calendar.july" + ], + "title": "Calendar.JULY" + }, + { + "id": "script-api:dw/util/Calendar#JULY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JULY", + "tags": [ + "july", + "calendar.july" + ], + "title": "Calendar.JULY" + }, + { + "id": "script-api:dw/util/Calendar#JUNE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JUNE", + "tags": [ + "june", + "calendar.june" + ], + "title": "Calendar.JUNE" + }, + { + "id": "script-api:dw/util/Calendar#JUNE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JUNE", + "tags": [ + "june", + "calendar.june" + ], + "title": "Calendar.JUNE" + }, + { + "id": "script-api:dw/util/Calendar#LONG_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.LONG_DATE_PATTERN", + "tags": [ + "long_date_pattern", + "calendar.long_date_pattern" + ], + "title": "Calendar.LONG_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#LONG_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.LONG_DATE_PATTERN", + "tags": [ + "long_date_pattern", + "calendar.long_date_pattern" + ], + "title": "Calendar.LONG_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#MARCH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MARCH", + "tags": [ + "march", + "calendar.march" + ], + "title": "Calendar.MARCH" + }, + { + "id": "script-api:dw/util/Calendar#MARCH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MARCH", + "tags": [ + "march", + "calendar.march" + ], + "title": "Calendar.MARCH" + }, + { + "id": "script-api:dw/util/Calendar#MAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MAY", + "tags": [ + "may", + "calendar.may" + ], + "title": "Calendar.MAY" + }, + { + "id": "script-api:dw/util/Calendar#MAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MAY", + "tags": [ + "may", + "calendar.may" + ], + "title": "Calendar.MAY" + }, + { + "id": "script-api:dw/util/Calendar#MILLISECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MILLISECOND", + "tags": [ + "millisecond", + "calendar.millisecond" + ], + "title": "Calendar.MILLISECOND" + }, + { + "id": "script-api:dw/util/Calendar#MILLISECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MILLISECOND", + "tags": [ + "millisecond", + "calendar.millisecond" + ], + "title": "Calendar.MILLISECOND" + }, + { + "id": "script-api:dw/util/Calendar#MINUTE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MINUTE", + "tags": [ + "minute", + "calendar.minute" + ], + "title": "Calendar.MINUTE" + }, + { + "id": "script-api:dw/util/Calendar#MINUTE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MINUTE", + "tags": [ + "minute", + "calendar.minute" + ], + "title": "Calendar.MINUTE" + }, + { + "id": "script-api:dw/util/Calendar#MONDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONDAY", + "tags": [ + "monday", + "calendar.monday" + ], + "title": "Calendar.MONDAY" + }, + { + "id": "script-api:dw/util/Calendar#MONDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONDAY", + "tags": [ + "monday", + "calendar.monday" + ], + "title": "Calendar.MONDAY" + }, + { + "id": "script-api:dw/util/Calendar#MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONTH", + "tags": [ + "month", + "calendar.month" + ], + "title": "Calendar.MONTH" + }, + { + "id": "script-api:dw/util/Calendar#MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONTH", + "tags": [ + "month", + "calendar.month" + ], + "title": "Calendar.MONTH" + }, + { + "id": "script-api:dw/util/Calendar#NOVEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.NOVEMBER", + "tags": [ + "november", + "calendar.november" + ], + "title": "Calendar.NOVEMBER" + }, + { + "id": "script-api:dw/util/Calendar#NOVEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.NOVEMBER", + "tags": [ + "november", + "calendar.november" + ], + "title": "Calendar.NOVEMBER" + }, + { + "id": "script-api:dw/util/Calendar#OCTOBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.OCTOBER", + "tags": [ + "october", + "calendar.october" + ], + "title": "Calendar.OCTOBER" + }, + { + "id": "script-api:dw/util/Calendar#OCTOBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.OCTOBER", + "tags": [ + "october", + "calendar.october" + ], + "title": "Calendar.OCTOBER" + }, + { + "id": "script-api:dw/util/Calendar#SATURDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SATURDAY", + "tags": [ + "saturday", + "calendar.saturday" + ], + "title": "Calendar.SATURDAY" + }, + { + "id": "script-api:dw/util/Calendar#SATURDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SATURDAY", + "tags": [ + "saturday", + "calendar.saturday" + ], + "title": "Calendar.SATURDAY" + }, + { + "id": "script-api:dw/util/Calendar#SECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SECOND", + "tags": [ + "second", + "calendar.second" + ], + "title": "Calendar.SECOND" + }, + { + "id": "script-api:dw/util/Calendar#SECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SECOND", + "tags": [ + "second", + "calendar.second" + ], + "title": "Calendar.SECOND" + }, + { + "id": "script-api:dw/util/Calendar#SEPTEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SEPTEMBER", + "tags": [ + "september", + "calendar.september" + ], + "title": "Calendar.SEPTEMBER" + }, + { + "id": "script-api:dw/util/Calendar#SEPTEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SEPTEMBER", + "tags": [ + "september", + "calendar.september" + ], + "title": "Calendar.SEPTEMBER" + }, + { + "id": "script-api:dw/util/Calendar#SHORT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SHORT_DATE_PATTERN", + "tags": [ + "short_date_pattern", + "calendar.short_date_pattern" + ], + "title": "Calendar.SHORT_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#SHORT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SHORT_DATE_PATTERN", + "tags": [ + "short_date_pattern", + "calendar.short_date_pattern" + ], + "title": "Calendar.SHORT_DATE_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#SUNDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SUNDAY", + "tags": [ + "sunday", + "calendar.sunday" + ], + "title": "Calendar.SUNDAY" + }, + { + "id": "script-api:dw/util/Calendar#SUNDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SUNDAY", + "tags": [ + "sunday", + "calendar.sunday" + ], + "title": "Calendar.SUNDAY" + }, + { + "id": "script-api:dw/util/Calendar#THURSDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.THURSDAY", + "tags": [ + "thursday", + "calendar.thursday" + ], + "title": "Calendar.THURSDAY" + }, + { + "id": "script-api:dw/util/Calendar#THURSDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.THURSDAY", + "tags": [ + "thursday", + "calendar.thursday" + ], + "title": "Calendar.THURSDAY" + }, + { + "id": "script-api:dw/util/Calendar#TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TIME_PATTERN", + "tags": [ + "time_pattern", + "calendar.time_pattern" + ], + "title": "Calendar.TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TIME_PATTERN", + "tags": [ + "time_pattern", + "calendar.time_pattern" + ], + "title": "Calendar.TIME_PATTERN" + }, + { + "id": "script-api:dw/util/Calendar#TUESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TUESDAY", + "tags": [ + "tuesday", + "calendar.tuesday" + ], + "title": "Calendar.TUESDAY" + }, + { + "id": "script-api:dw/util/Calendar#TUESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TUESDAY", + "tags": [ + "tuesday", + "calendar.tuesday" + ], + "title": "Calendar.TUESDAY" + }, + { + "id": "script-api:dw/util/Calendar#WEDNESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEDNESDAY", + "tags": [ + "wednesday", + "calendar.wednesday" + ], + "title": "Calendar.WEDNESDAY" + }, + { + "id": "script-api:dw/util/Calendar#WEDNESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEDNESDAY", + "tags": [ + "wednesday", + "calendar.wednesday" + ], + "title": "Calendar.WEDNESDAY" + }, + { + "id": "script-api:dw/util/Calendar#WEEK_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_MONTH", + "tags": [ + "week_of_month", + "calendar.week_of_month" + ], + "title": "Calendar.WEEK_OF_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#WEEK_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_MONTH", + "tags": [ + "week_of_month", + "calendar.week_of_month" + ], + "title": "Calendar.WEEK_OF_MONTH" + }, + { + "id": "script-api:dw/util/Calendar#WEEK_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_YEAR", + "tags": [ + "week_of_year", + "calendar.week_of_year" + ], + "title": "Calendar.WEEK_OF_YEAR" + }, + { + "id": "script-api:dw/util/Calendar#WEEK_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_YEAR", + "tags": [ + "week_of_year", + "calendar.week_of_year" + ], + "title": "Calendar.WEEK_OF_YEAR" + }, + { + "id": "script-api:dw/util/Calendar#YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.YEAR", + "tags": [ + "year", + "calendar.year" + ], + "title": "Calendar.YEAR" + }, + { + "id": "script-api:dw/util/Calendar#YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.YEAR", + "tags": [ + "year", + "calendar.year" + ], + "title": "Calendar.YEAR" + }, + { + "id": "script-api:dw/util/Calendar#ZONE_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ZONE_OFFSET", + "tags": [ + "zone_offset", + "calendar.zone_offset" + ], + "title": "Calendar.ZONE_OFFSET" + }, + { + "id": "script-api:dw/util/Calendar#ZONE_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ZONE_OFFSET", + "tags": [ + "zone_offset", + "calendar.zone_offset" + ], + "title": "Calendar.ZONE_OFFSET" + }, + { + "id": "script-api:dw/util/Calendar#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.add", + "tags": [ + "add", + "calendar.add" + ], + "title": "Calendar.add" + }, + { + "id": "script-api:dw/util/Calendar#after", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.after", + "tags": [ + "after", + "calendar.after" + ], + "title": "Calendar.after" + }, + { + "id": "script-api:dw/util/Calendar#before", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.before", + "tags": [ + "before", + "calendar.before" + ], + "title": "Calendar.before" + }, + { + "id": "script-api:dw/util/Calendar#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.clear", + "tags": [ + "clear", + "calendar.clear" + ], + "title": "Calendar.clear" + }, + { + "id": "script-api:dw/util/Calendar#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.clear", + "tags": [ + "clear", + "calendar.clear" + ], + "title": "Calendar.clear" + }, + { + "id": "script-api:dw/util/Calendar#compareTo", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.compareTo", + "tags": [ + "compareto", + "calendar.compareto" + ], + "title": "Calendar.compareTo" + }, + { + "id": "script-api:dw/util/Calendar#equals", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.equals", + "tags": [ + "equals", + "calendar.equals" + ], + "title": "Calendar.equals" + }, + { + "id": "script-api:dw/util/Calendar#firstDayOfWeek", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.firstDayOfWeek", + "tags": [ + "firstdayofweek", + "calendar.firstdayofweek" + ], + "title": "Calendar.firstDayOfWeek" + }, + { + "id": "script-api:dw/util/Calendar#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.get", + "tags": [ + "get", + "calendar.get" + ], + "title": "Calendar.get" + }, + { + "id": "script-api:dw/util/Calendar#getActualMaximum", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getActualMaximum", + "tags": [ + "getactualmaximum", + "calendar.getactualmaximum" + ], + "title": "Calendar.getActualMaximum" + }, + { + "id": "script-api:dw/util/Calendar#getActualMinimum", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getActualMinimum", + "tags": [ + "getactualminimum", + "calendar.getactualminimum" + ], + "title": "Calendar.getActualMinimum" + }, + { + "id": "script-api:dw/util/Calendar#getFirstDayOfWeek", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getFirstDayOfWeek", + "tags": [ + "getfirstdayofweek", + "calendar.getfirstdayofweek" + ], + "title": "Calendar.getFirstDayOfWeek" + }, + { + "id": "script-api:dw/util/Calendar#getMaximum", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getMaximum", + "tags": [ + "getmaximum", + "calendar.getmaximum" + ], + "title": "Calendar.getMaximum" + }, + { + "id": "script-api:dw/util/Calendar#getMinimum", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getMinimum", + "tags": [ + "getminimum", + "calendar.getminimum" + ], + "title": "Calendar.getMinimum" + }, + { + "id": "script-api:dw/util/Calendar#getTime", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getTime", + "tags": [ + "gettime", + "calendar.gettime" + ], + "title": "Calendar.getTime" + }, + { + "id": "script-api:dw/util/Calendar#getTimeZone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getTimeZone", + "tags": [ + "gettimezone", + "calendar.gettimezone" + ], + "title": "Calendar.getTimeZone" + }, + { + "id": "script-api:dw/util/Calendar#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.hashCode", + "tags": [ + "hashcode", + "calendar.hashcode" + ], + "title": "Calendar.hashCode" + }, + { + "id": "script-api:dw/util/Calendar#isLeapYear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isLeapYear", + "tags": [ + "isleapyear", + "calendar.isleapyear" + ], + "title": "Calendar.isLeapYear" + }, + { + "id": "script-api:dw/util/Calendar#isSameDay", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSameDay", + "tags": [ + "issameday", + "calendar.issameday" + ], + "title": "Calendar.isSameDay" + }, + { + "id": "script-api:dw/util/Calendar#isSameDayByTimestamp", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSameDayByTimestamp", + "tags": [ + "issamedaybytimestamp", + "calendar.issamedaybytimestamp" + ], + "title": "Calendar.isSameDayByTimestamp" + }, + { + "id": "script-api:dw/util/Calendar#isSet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSet", + "tags": [ + "isset", + "calendar.isset" + ], + "title": "Calendar.isSet" + }, + { + "id": "script-api:dw/util/Calendar#parseByFormat", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.parseByFormat", + "tags": [ + "parsebyformat", + "calendar.parsebyformat" + ], + "title": "Calendar.parseByFormat" + }, + { + "id": "script-api:dw/util/Calendar#parseByLocale", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.parseByLocale", + "tags": [ + "parsebylocale", + "calendar.parsebylocale" + ], + "title": "Calendar.parseByLocale" + }, + { + "id": "script-api:dw/util/Calendar#roll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.roll", + "tags": [ + "roll", + "calendar.roll" + ], + "title": "Calendar.roll" + }, + { + "id": "script-api:dw/util/Calendar#roll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.roll", + "tags": [ + "roll", + "calendar.roll" + ], + "title": "Calendar.roll" + }, + { + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "id": "script-api:dw/util/Calendar#setFirstDayOfWeek", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setFirstDayOfWeek", + "tags": [ + "setfirstdayofweek", + "calendar.setfirstdayofweek" + ], + "title": "Calendar.setFirstDayOfWeek" + }, + { + "id": "script-api:dw/util/Calendar#setTime", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setTime", + "tags": [ + "settime", + "calendar.settime" + ], + "title": "Calendar.setTime" + }, + { + "id": "script-api:dw/util/Calendar#setTimeZone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setTimeZone", + "tags": [ + "settimezone", + "calendar.settimezone" + ], + "title": "Calendar.setTimeZone" + }, + { + "id": "script-api:dw/util/Calendar#time", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.time", + "tags": [ + "time", + "calendar.time" + ], + "title": "Calendar.time" + }, + { + "id": "script-api:dw/util/Calendar#timeZone", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.timeZone", + "tags": [ + "timezone", + "calendar.timezone" + ], + "title": "Calendar.timeZone" + }, + { + "id": "script-api:dw/util/Collection", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Collection", + "tags": [ + "collection", + "dw.util.collection", + "dw/util" + ], + "title": "Collection" + }, + { + "id": "script-api:dw/util/Collection#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.add", + "tags": [ + "add", + "collection.add" + ], + "title": "Collection.add" + }, + { + "id": "script-api:dw/util/Collection#add1", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.add1", + "tags": [ + "add1", + "collection.add1" + ], + "title": "Collection.add1" + }, + { + "id": "script-api:dw/util/Collection#addAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.addAll", + "tags": [ + "addall", + "collection.addall" + ], + "title": "Collection.addAll" + }, + { + "id": "script-api:dw/util/Collection#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.clear", + "tags": [ + "clear", + "collection.clear" + ], + "title": "Collection.clear" + }, + { + "id": "script-api:dw/util/Collection#contains", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.contains", + "tags": [ + "contains", + "collection.contains" + ], + "title": "Collection.contains" + }, + { + "id": "script-api:dw/util/Collection#containsAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.containsAll", + "tags": [ + "containsall", + "collection.containsall" + ], + "title": "Collection.containsAll" + }, + { + "id": "script-api:dw/util/Collection#empty", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.empty", + "tags": [ + "empty", + "collection.empty" + ], + "title": "Collection.empty" + }, + { + "id": "script-api:dw/util/Collection#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.getLength", + "tags": [ + "getlength", + "collection.getlength" + ], + "title": "Collection.getLength" + }, + { + "id": "script-api:dw/util/Collection#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.isEmpty", + "tags": [ + "isempty", + "collection.isempty" + ], + "title": "Collection.isEmpty" + }, + { + "id": "script-api:dw/util/Collection#iterator", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.iterator", + "tags": [ + "iterator", + "collection.iterator" + ], + "title": "Collection.iterator" + }, + { + "id": "script-api:dw/util/Collection#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.length", + "tags": [ + "length", + "collection.length" + ], + "title": "Collection.length" + }, + { + "id": "script-api:dw/util/Collection#remove", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.remove", + "tags": [ + "remove", + "collection.remove" + ], + "title": "Collection.remove" + }, + { + "id": "script-api:dw/util/Collection#removeAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.removeAll", + "tags": [ + "removeall", + "collection.removeall" + ], + "title": "Collection.removeAll" + }, + { + "id": "script-api:dw/util/Collection#retainAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.retainAll", + "tags": [ + "retainall", + "collection.retainall" + ], + "title": "Collection.retainAll" + }, + { + "id": "script-api:dw/util/Collection#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.size", + "tags": [ + "size", + "collection.size" + ], + "title": "Collection.size" + }, + { + "id": "script-api:dw/util/Collection#toArray", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.toArray", + "tags": [ + "toarray", + "collection.toarray" + ], + "title": "Collection.toArray" + }, + { + "id": "script-api:dw/util/Collection#toArray", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.toArray", + "tags": [ + "toarray", + "collection.toarray" + ], + "title": "Collection.toArray" + }, + { + "id": "script-api:dw/util/Currency", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Currency", + "tags": [ + "currency", + "dw.util.currency", + "dw/util" + ], + "title": "Currency" + }, + { + "id": "script-api:dw/util/Currency#currencyCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.currencyCode", + "tags": [ + "currencycode", + "currency.currencycode" + ], + "title": "Currency.currencyCode" + }, + { + "id": "script-api:dw/util/Currency#defaultFractionDigits", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.defaultFractionDigits", + "tags": [ + "defaultfractiondigits", + "currency.defaultfractiondigits" + ], + "title": "Currency.defaultFractionDigits" + }, + { + "id": "script-api:dw/util/Currency#getCurrency", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrency", + "tags": [ + "getcurrency", + "currency.getcurrency" + ], + "title": "Currency.getCurrency" + }, + { + "id": "script-api:dw/util/Currency#getCurrency", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrency", + "tags": [ + "getcurrency", + "currency.getcurrency" + ], + "title": "Currency.getCurrency" + }, + { + "id": "script-api:dw/util/Currency#getCurrencyCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrencyCode", + "tags": [ + "getcurrencycode", + "currency.getcurrencycode" + ], + "title": "Currency.getCurrencyCode" + }, + { + "id": "script-api:dw/util/Currency#getDefaultFractionDigits", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getDefaultFractionDigits", + "tags": [ + "getdefaultfractiondigits", + "currency.getdefaultfractiondigits" + ], + "title": "Currency.getDefaultFractionDigits" + }, + { + "id": "script-api:dw/util/Currency#getName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getName", + "tags": [ + "getname", + "currency.getname" + ], + "title": "Currency.getName" + }, + { + "id": "script-api:dw/util/Currency#getSymbol", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getSymbol", + "tags": [ + "getsymbol", + "currency.getsymbol" + ], + "title": "Currency.getSymbol" + }, + { + "id": "script-api:dw/util/Currency#name", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.name", + "tags": [ + "name", + "currency.name" + ], + "title": "Currency.name" + }, + { + "id": "script-api:dw/util/Currency#symbol", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.symbol", + "tags": [ + "symbol", + "currency.symbol" + ], + "title": "Currency.symbol" + }, + { + "id": "script-api:dw/util/Currency#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.toString", + "tags": [ + "tostring", + "currency.tostring" + ], + "title": "Currency.toString" + }, + { + "id": "script-api:dw/util/DateUtils", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.DateUtils", + "tags": [ + "dateutils", + "dw.util.dateutils", + "dw/util" + ], + "title": "DateUtils" + }, + { + "id": "script-api:dw/util/DateUtils#nowForInstance", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForInstance", + "tags": [ + "nowforinstance", + "dateutils.nowforinstance" + ], + "title": "DateUtils.nowForInstance" + }, + { + "id": "script-api:dw/util/DateUtils#nowForInstance", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForInstance", + "tags": [ + "nowforinstance", + "dateutils.nowforinstance" + ], + "title": "DateUtils.nowForInstance" + }, + { + "id": "script-api:dw/util/DateUtils#nowForSite", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForSite", + "tags": [ + "nowforsite", + "dateutils.nowforsite" + ], + "title": "DateUtils.nowForSite" + }, + { + "id": "script-api:dw/util/DateUtils#nowForSite", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForSite", + "tags": [ + "nowforsite", + "dateutils.nowforsite" + ], + "title": "DateUtils.nowForSite" + }, + { + "id": "script-api:dw/util/DateUtils#nowInUTC", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowInUTC", + "tags": [ + "nowinutc", + "dateutils.nowinutc" + ], + "title": "DateUtils.nowInUTC" + }, + { + "id": "script-api:dw/util/DateUtils#nowInUTC", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowInUTC", + "tags": [ + "nowinutc", + "dateutils.nowinutc" + ], + "title": "DateUtils.nowInUTC" + }, + { + "id": "script-api:dw/util/Decimal", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Decimal", + "tags": [ + "decimal", + "dw.util.decimal", + "dw/util" + ], + "title": "Decimal" + }, + { + "id": "script-api:dw/util/Decimal#abs", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.abs", + "tags": [ + "abs", + "decimal.abs" + ], + "title": "Decimal.abs" + }, + { + "id": "script-api:dw/util/Decimal#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.add", + "tags": [ + "add", + "decimal.add" + ], + "title": "Decimal.add" + }, + { + "id": "script-api:dw/util/Decimal#add", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.add", + "tags": [ + "add", + "decimal.add" + ], + "title": "Decimal.add" + }, + { + "id": "script-api:dw/util/Decimal#addPercent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.addPercent", + "tags": [ + "addpercent", + "decimal.addpercent" + ], + "title": "Decimal.addPercent" + }, + { + "id": "script-api:dw/util/Decimal#addPercent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.addPercent", + "tags": [ + "addpercent", + "decimal.addpercent" + ], + "title": "Decimal.addPercent" + }, + { + "id": "script-api:dw/util/Decimal#divide", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.divide", + "tags": [ + "divide", + "decimal.divide" + ], + "title": "Decimal.divide" + }, + { + "id": "script-api:dw/util/Decimal#divide", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.divide", + "tags": [ + "divide", + "decimal.divide" + ], + "title": "Decimal.divide" + }, + { + "id": "script-api:dw/util/Decimal#equals", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.equals", + "tags": [ + "equals", + "decimal.equals" + ], + "title": "Decimal.equals" + }, + { + "id": "script-api:dw/util/Decimal#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.get", + "tags": [ + "get", + "decimal.get" + ], + "title": "Decimal.get" + }, + { + "id": "script-api:dw/util/Decimal#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.hashCode", + "tags": [ + "hashcode", + "decimal.hashcode" + ], + "title": "Decimal.hashCode" + }, + { + "id": "script-api:dw/util/Decimal#multiply", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.multiply", + "tags": [ + "multiply", + "decimal.multiply" + ], + "title": "Decimal.multiply" + }, + { + "id": "script-api:dw/util/Decimal#multiply", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.multiply", + "tags": [ + "multiply", + "decimal.multiply" + ], + "title": "Decimal.multiply" + }, + { + "id": "script-api:dw/util/Decimal#negate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.negate", + "tags": [ + "negate", + "decimal.negate" + ], + "title": "Decimal.negate" + }, + { + "id": "script-api:dw/util/Decimal#round", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.round", + "tags": [ + "round", + "decimal.round" + ], + "title": "Decimal.round" + }, + { + "id": "script-api:dw/util/Decimal#subtract", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtract", + "tags": [ + "subtract", + "decimal.subtract" + ], + "title": "Decimal.subtract" + }, + { + "id": "script-api:dw/util/Decimal#subtract", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtract", + "tags": [ + "subtract", + "decimal.subtract" + ], + "title": "Decimal.subtract" + }, + { + "id": "script-api:dw/util/Decimal#subtractPercent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtractPercent", + "tags": [ + "subtractpercent", + "decimal.subtractpercent" + ], + "title": "Decimal.subtractPercent" + }, + { + "id": "script-api:dw/util/Decimal#subtractPercent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtractPercent", + "tags": [ + "subtractpercent", + "decimal.subtractpercent" + ], + "title": "Decimal.subtractPercent" + }, + { + "id": "script-api:dw/util/Decimal#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.toString", + "tags": [ + "tostring", + "decimal.tostring" + ], + "title": "Decimal.toString" + }, + { + "id": "script-api:dw/util/Decimal#valueOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.valueOf", + "tags": [ + "valueof", + "decimal.valueof" + ], + "title": "Decimal.valueOf" + }, + { + "id": "script-api:dw/util/FilteringCollection", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.FilteringCollection", + "tags": [ + "filteringcollection", + "dw.util.filteringcollection", + "dw/util" + ], + "title": "FilteringCollection" + }, + { + "id": "script-api:dw/util/FilteringCollection#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.ORDERBY_REVERSE", + "tags": [ + "orderby_reverse", + "filteringcollection.orderby_reverse" + ], + "title": "FilteringCollection.ORDERBY_REVERSE" + }, + { + "id": "script-api:dw/util/FilteringCollection#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.ORDERBY_REVERSE", + "tags": [ + "orderby_reverse", + "filteringcollection.orderby_reverse" + ], + "title": "FilteringCollection.ORDERBY_REVERSE" + }, + { + "id": "script-api:dw/util/FilteringCollection#asMap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.asMap", + "tags": [ + "asmap", + "filteringcollection.asmap" + ], + "title": "FilteringCollection.asMap" + }, + { + "id": "script-api:dw/util/FilteringCollection#select", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.select", + "tags": [ + "select", + "filteringcollection.select" + ], + "title": "FilteringCollection.select" + }, + { + "id": "script-api:dw/util/FilteringCollection#sort", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.sort", + "tags": [ + "sort", + "filteringcollection.sort" + ], + "title": "FilteringCollection.sort" + }, + { + "id": "script-api:dw/util/Geolocation", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Geolocation", + "tags": [ + "geolocation", + "dw.util.geolocation", + "dw/util" + ], + "title": "Geolocation" + }, + { + "id": "script-api:dw/util/Geolocation#available", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.available", + "tags": [ + "available", + "geolocation.available" + ], + "title": "Geolocation.available" + }, + { + "id": "script-api:dw/util/Geolocation#city", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.city", + "tags": [ + "city", + "geolocation.city" + ], + "title": "Geolocation.city" + }, + { + "id": "script-api:dw/util/Geolocation#countryCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.countryCode", + "tags": [ + "countrycode", + "geolocation.countrycode" + ], + "title": "Geolocation.countryCode" + }, + { + "id": "script-api:dw/util/Geolocation#countryName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.countryName", + "tags": [ + "countryname", + "geolocation.countryname" + ], + "title": "Geolocation.countryName" + }, + { + "id": "script-api:dw/util/Geolocation#getCity", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCity", + "tags": [ + "getcity", + "geolocation.getcity" + ], + "title": "Geolocation.getCity" + }, + { + "id": "script-api:dw/util/Geolocation#getCountryCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCountryCode", + "tags": [ + "getcountrycode", + "geolocation.getcountrycode" + ], + "title": "Geolocation.getCountryCode" + }, + { + "id": "script-api:dw/util/Geolocation#getCountryName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCountryName", + "tags": [ + "getcountryname", + "geolocation.getcountryname" + ], + "title": "Geolocation.getCountryName" + }, + { + "id": "script-api:dw/util/Geolocation#getLatitude", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getLatitude", + "tags": [ + "getlatitude", + "geolocation.getlatitude" + ], + "title": "Geolocation.getLatitude" + }, + { + "id": "script-api:dw/util/Geolocation#getLongitude", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getLongitude", + "tags": [ + "getlongitude", + "geolocation.getlongitude" + ], + "title": "Geolocation.getLongitude" + }, + { + "id": "script-api:dw/util/Geolocation#getMetroCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getMetroCode", + "tags": [ + "getmetrocode", + "geolocation.getmetrocode" + ], + "title": "Geolocation.getMetroCode" + }, + { + "id": "script-api:dw/util/Geolocation#getPostalCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getPostalCode", + "tags": [ + "getpostalcode", + "geolocation.getpostalcode" + ], + "title": "Geolocation.getPostalCode" + }, + { + "id": "script-api:dw/util/Geolocation#getRegionCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getRegionCode", + "tags": [ + "getregioncode", + "geolocation.getregioncode" + ], + "title": "Geolocation.getRegionCode" + }, + { + "id": "script-api:dw/util/Geolocation#getRegionName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getRegionName", + "tags": [ + "getregionname", + "geolocation.getregionname" + ], + "title": "Geolocation.getRegionName" + }, + { + "id": "script-api:dw/util/Geolocation#isAvailable", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.isAvailable", + "tags": [ + "isavailable", + "geolocation.isavailable" + ], + "title": "Geolocation.isAvailable" + }, + { + "id": "script-api:dw/util/Geolocation#latitude", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.latitude", + "tags": [ + "latitude", + "geolocation.latitude" + ], + "title": "Geolocation.latitude" + }, + { + "id": "script-api:dw/util/Geolocation#longitude", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.longitude", + "tags": [ + "longitude", + "geolocation.longitude" + ], + "title": "Geolocation.longitude" + }, + { + "id": "script-api:dw/util/Geolocation#metroCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.metroCode", + "tags": [ + "metrocode", + "geolocation.metrocode" + ], + "title": "Geolocation.metroCode" + }, + { + "id": "script-api:dw/util/Geolocation#postalCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.postalCode", + "tags": [ + "postalcode", + "geolocation.postalcode" + ], + "title": "Geolocation.postalCode" + }, + { + "id": "script-api:dw/util/Geolocation#regionCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.regionCode", + "tags": [ + "regioncode", + "geolocation.regioncode" + ], + "title": "Geolocation.regionCode" + }, + { + "id": "script-api:dw/util/Geolocation#regionName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.regionName", + "tags": [ + "regionname", + "geolocation.regionname" + ], + "title": "Geolocation.regionName" + }, + { + "id": "script-api:dw/util/HashMap", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.HashMap", + "tags": [ + "hashmap", + "dw.util.hashmap", + "dw/util" + ], + "title": "HashMap" + }, + { + "id": "script-api:dw/util/HashMap#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/HashMap", + "qualifiedName": "dw.util.HashMap.clone", + "tags": [ + "clone", + "hashmap.clone" + ], + "title": "HashMap.clone" + }, + { + "id": "script-api:dw/util/HashSet", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.HashSet", + "tags": [ + "hashset", + "dw.util.hashset", + "dw/util" + ], + "title": "HashSet" + }, + { + "id": "script-api:dw/util/HashSet#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/HashSet", + "qualifiedName": "dw.util.HashSet.clone", + "tags": [ + "clone", + "hashset.clone" + ], + "title": "HashSet.clone" + }, + { + "id": "script-api:dw/util/Iterator", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Iterator", + "tags": [ + "iterator", + "dw.util.iterator", + "dw/util" + ], + "title": "Iterator" + }, + { + "id": "script-api:dw/util/Iterator#asList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.asList", + "tags": [ + "aslist", + "iterator.aslist" + ], + "title": "Iterator.asList" + }, + { + "id": "script-api:dw/util/Iterator#asList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.asList", + "tags": [ + "aslist", + "iterator.aslist" + ], + "title": "Iterator.asList" + }, + { + "id": "script-api:dw/util/Iterator#hasNext", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.hasNext", + "tags": [ + "hasnext", + "iterator.hasnext" + ], + "title": "Iterator.hasNext" + }, + { + "id": "script-api:dw/util/Iterator#next", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.next", + "tags": [ + "next", + "iterator.next" + ], + "title": "Iterator.next" + }, + { + "id": "script-api:dw/util/LinkedHashMap", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.LinkedHashMap", + "tags": [ + "linkedhashmap", + "dw.util.linkedhashmap", + "dw/util" + ], + "title": "LinkedHashMap" + }, + { + "id": "script-api:dw/util/LinkedHashMap#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/LinkedHashMap", + "qualifiedName": "dw.util.LinkedHashMap.clone", + "tags": [ + "clone", + "linkedhashmap.clone" + ], + "title": "LinkedHashMap.clone" + }, + { + "id": "script-api:dw/util/LinkedHashSet", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.LinkedHashSet", + "tags": [ + "linkedhashset", + "dw.util.linkedhashset", + "dw/util" + ], + "title": "LinkedHashSet" + }, + { + "id": "script-api:dw/util/LinkedHashSet#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/LinkedHashSet", + "qualifiedName": "dw.util.LinkedHashSet.clone", + "tags": [ + "clone", + "linkedhashset.clone" + ], + "title": "LinkedHashSet.clone" + }, + { + "id": "script-api:dw/util/List", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.List", + "tags": [ + "list", + "dw.util.list", + "dw/util" + ], + "title": "List" + }, + { + "id": "script-api:dw/util/List#EMPTY_LIST", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.EMPTY_LIST", + "tags": [ + "empty_list", + "list.empty_list" + ], + "title": "List.EMPTY_LIST" + }, + { + "id": "script-api:dw/util/List#EMPTY_LIST", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.EMPTY_LIST", + "tags": [ + "empty_list", + "list.empty_list" + ], + "title": "List.EMPTY_LIST" + }, + { + "id": "script-api:dw/util/List#addAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.addAt", + "tags": [ + "addat", + "list.addat" + ], + "title": "List.addAt" + }, + { + "id": "script-api:dw/util/List#concat", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.concat", + "tags": [ + "concat", + "list.concat" + ], + "title": "List.concat" + }, + { + "id": "script-api:dw/util/List#fill", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.fill", + "tags": [ + "fill", + "list.fill" + ], + "title": "List.fill" + }, + { + "id": "script-api:dw/util/List#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.get", + "tags": [ + "get", + "list.get" + ], + "title": "List.get" + }, + { + "id": "script-api:dw/util/List#indexOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.indexOf", + "tags": [ + "indexof", + "list.indexof" + ], + "title": "List.indexOf" + }, + { + "id": "script-api:dw/util/List#join", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.join", + "tags": [ + "join", + "list.join" + ], + "title": "List.join" + }, + { + "id": "script-api:dw/util/List#join", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.join", + "tags": [ + "join", + "list.join" + ], + "title": "List.join" + }, + { + "id": "script-api:dw/util/List#lastIndexOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.lastIndexOf", + "tags": [ + "lastindexof", + "list.lastindexof" + ], + "title": "List.lastIndexOf" + }, + { + "id": "script-api:dw/util/List#pop", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.pop", + "tags": [ + "pop", + "list.pop" + ], + "title": "List.pop" + }, + { + "id": "script-api:dw/util/List#push", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.push", + "tags": [ + "push", + "list.push" + ], + "title": "List.push" + }, + { + "id": "script-api:dw/util/List#removeAt", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.removeAt", + "tags": [ + "removeat", + "list.removeat" + ], + "title": "List.removeAt" + }, + { + "id": "script-api:dw/util/List#replaceAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.replaceAll", + "tags": [ + "replaceall", + "list.replaceall" + ], + "title": "List.replaceAll" + }, + { + "id": "script-api:dw/util/List#reverse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.reverse", + "tags": [ + "reverse", + "list.reverse" + ], + "title": "List.reverse" + }, + { + "id": "script-api:dw/util/List#rotate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.rotate", + "tags": [ + "rotate", + "list.rotate" + ], + "title": "List.rotate" + }, + { + "id": "script-api:dw/util/List#set", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.set", + "tags": [ + "set", + "list.set" + ], + "title": "List.set" + }, + { + "id": "script-api:dw/util/List#shift", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.shift", + "tags": [ + "shift", + "list.shift" + ], + "title": "List.shift" + }, + { + "id": "script-api:dw/util/List#shuffle", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.shuffle", + "tags": [ + "shuffle", + "list.shuffle" + ], + "title": "List.shuffle" + }, + { + "id": "script-api:dw/util/List#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.size", + "tags": [ + "size", + "list.size" + ], + "title": "List.size" + }, + { + "id": "script-api:dw/util/List#slice", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.slice", + "tags": [ + "slice", + "list.slice" + ], + "title": "List.slice" + }, + { + "id": "script-api:dw/util/List#slice", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.slice", + "tags": [ + "slice", + "list.slice" + ], + "title": "List.slice" + }, + { + "id": "script-api:dw/util/List#sort", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.sort", + "tags": [ + "sort", + "list.sort" + ], + "title": "List.sort" + }, + { + "id": "script-api:dw/util/List#sort", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.sort", + "tags": [ + "sort", + "list.sort" + ], + "title": "List.sort" + }, + { + "id": "script-api:dw/util/List#subList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.subList", + "tags": [ + "sublist", + "list.sublist" + ], + "title": "List.subList" + }, + { + "id": "script-api:dw/util/List#swap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.swap", + "tags": [ + "swap", + "list.swap" + ], + "title": "List.swap" + }, + { + "id": "script-api:dw/util/List#unshift", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.unshift", + "tags": [ + "unshift", + "list.unshift" + ], + "title": "List.unshift" + }, + { + "id": "script-api:dw/util/Locale", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Locale", + "tags": [ + "locale", + "dw.util.locale", + "dw/util" + ], + "title": "Locale" + }, + { + "id": "script-api:dw/util/Locale#ID", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ID", + "tags": [ + "id", + "locale.id" + ], + "title": "Locale.ID" + }, + { + "id": "script-api:dw/util/Locale#ISO3Country", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ISO3Country", + "tags": [ + "iso3country", + "locale.iso3country" + ], + "title": "Locale.ISO3Country" + }, + { + "id": "script-api:dw/util/Locale#ISO3Language", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ISO3Language", + "tags": [ + "iso3language", + "locale.iso3language" + ], + "title": "Locale.ISO3Language" + }, + { + "id": "script-api:dw/util/Locale#country", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.country", + "tags": [ + "country", + "locale.country" + ], + "title": "Locale.country" + }, + { + "id": "script-api:dw/util/Locale#displayCountry", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayCountry", + "tags": [ + "displaycountry", + "locale.displaycountry" + ], + "title": "Locale.displayCountry" + }, + { + "id": "script-api:dw/util/Locale#displayLanguage", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayLanguage", + "tags": [ + "displaylanguage", + "locale.displaylanguage" + ], + "title": "Locale.displayLanguage" + }, + { + "id": "script-api:dw/util/Locale#displayName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayName", + "tags": [ + "displayname", + "locale.displayname" + ], + "title": "Locale.displayName" + }, + { + "id": "script-api:dw/util/Locale#getCountry", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getCountry", + "tags": [ + "getcountry", + "locale.getcountry" + ], + "title": "Locale.getCountry" + }, + { + "id": "script-api:dw/util/Locale#getDisplayCountry", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayCountry", + "tags": [ + "getdisplaycountry", + "locale.getdisplaycountry" + ], + "title": "Locale.getDisplayCountry" + }, + { + "id": "script-api:dw/util/Locale#getDisplayLanguage", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayLanguage", + "tags": [ + "getdisplaylanguage", + "locale.getdisplaylanguage" + ], + "title": "Locale.getDisplayLanguage" + }, + { + "id": "script-api:dw/util/Locale#getDisplayName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayName", + "tags": [ + "getdisplayname", + "locale.getdisplayname" + ], + "title": "Locale.getDisplayName" + }, + { + "id": "script-api:dw/util/Locale#getID", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getID", + "tags": [ + "getid", + "locale.getid" + ], + "title": "Locale.getID" + }, + { + "id": "script-api:dw/util/Locale#getISO3Country", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getISO3Country", + "tags": [ + "getiso3country", + "locale.getiso3country" + ], + "title": "Locale.getISO3Country" + }, + { + "id": "script-api:dw/util/Locale#getISO3Language", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getISO3Language", + "tags": [ + "getiso3language", + "locale.getiso3language" + ], + "title": "Locale.getISO3Language" + }, + { + "id": "script-api:dw/util/Locale#getLanguage", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLanguage", + "tags": [ + "getlanguage", + "locale.getlanguage" + ], + "title": "Locale.getLanguage" + }, + { + "id": "script-api:dw/util/Locale#getLocale", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLocale", + "tags": [ + "getlocale", + "locale.getlocale" + ], + "title": "Locale.getLocale" + }, + { + "id": "script-api:dw/util/Locale#getLocale", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLocale", + "tags": [ + "getlocale", + "locale.getlocale" + ], + "title": "Locale.getLocale" + }, + { + "id": "script-api:dw/util/Locale#language", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.language", + "tags": [ + "language", + "locale.language" + ], + "title": "Locale.language" + }, + { + "id": "script-api:dw/util/Locale#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.toString", + "tags": [ + "tostring", + "locale.tostring" + ], + "title": "Locale.toString" + }, + { + "id": "script-api:dw/util/Map", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Map", + "tags": [ + "map", + "dw.util.map", + "dw/util" + ], + "title": "Map" + }, + { + "id": "script-api:dw/util/Map#EMPTY_MAP", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.EMPTY_MAP", + "tags": [ + "empty_map", + "map.empty_map" + ], + "title": "Map.EMPTY_MAP" + }, + { + "id": "script-api:dw/util/Map#EMPTY_MAP", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.EMPTY_MAP", + "tags": [ + "empty_map", + "map.empty_map" + ], + "title": "Map.EMPTY_MAP" + }, + { + "id": "script-api:dw/util/Map#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.clear", + "tags": [ + "clear", + "map.clear" + ], + "title": "Map.clear" + }, + { + "id": "script-api:dw/util/Map#containsKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.containsKey", + "tags": [ + "containskey", + "map.containskey" + ], + "title": "Map.containsKey" + }, + { + "id": "script-api:dw/util/Map#containsValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.containsValue", + "tags": [ + "containsvalue", + "map.containsvalue" + ], + "title": "Map.containsValue" + }, + { + "id": "script-api:dw/util/Map#empty", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.empty", + "tags": [ + "empty", + "map.empty" + ], + "title": "Map.empty" + }, + { + "id": "script-api:dw/util/Map#entrySet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.entrySet", + "tags": [ + "entryset", + "map.entryset" + ], + "title": "Map.entrySet" + }, + { + "id": "script-api:dw/util/Map#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.get", + "tags": [ + "get", + "map.get" + ], + "title": "Map.get" + }, + { + "id": "script-api:dw/util/Map#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.getLength", + "tags": [ + "getlength", + "map.getlength" + ], + "title": "Map.getLength" + }, + { + "id": "script-api:dw/util/Map#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.isEmpty", + "tags": [ + "isempty", + "map.isempty" + ], + "title": "Map.isEmpty" + }, + { + "id": "script-api:dw/util/Map#keySet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.keySet", + "tags": [ + "keyset", + "map.keyset" + ], + "title": "Map.keySet" + }, + { + "id": "script-api:dw/util/Map#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.length", + "tags": [ + "length", + "map.length" + ], + "title": "Map.length" + }, + { + "id": "script-api:dw/util/Map#put", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.put", + "tags": [ + "put", + "map.put" + ], + "title": "Map.put" + }, + { + "id": "script-api:dw/util/Map#putAll", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.putAll", + "tags": [ + "putall", + "map.putall" + ], + "title": "Map.putAll" + }, + { + "id": "script-api:dw/util/Map#remove", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.remove", + "tags": [ + "remove", + "map.remove" + ], + "title": "Map.remove" + }, + { + "id": "script-api:dw/util/Map#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.size", + "tags": [ + "size", + "map.size" + ], + "title": "Map.size" + }, + { + "id": "script-api:dw/util/Map#values", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.values", + "tags": [ + "values", + "map.values" + ], + "title": "Map.values" + }, + { + "id": "script-api:dw/util/MapEntry", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MapEntry", + "tags": [ + "mapentry", + "dw.util.mapentry", + "dw/util" + ], + "title": "MapEntry" + }, + { + "id": "script-api:dw/util/MapEntry#getKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.getKey", + "tags": [ + "getkey", + "mapentry.getkey" + ], + "title": "MapEntry.getKey" + }, + { + "id": "script-api:dw/util/MapEntry#getValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.getValue", + "tags": [ + "getvalue", + "mapentry.getvalue" + ], + "title": "MapEntry.getValue" + }, + { + "id": "script-api:dw/util/MapEntry#key", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.key", + "tags": [ + "key", + "mapentry.key" + ], + "title": "MapEntry.key" + }, + { + "id": "script-api:dw/util/MapEntry#value", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.value", + "tags": [ + "value", + "mapentry.value" + ], + "title": "MapEntry.value" + }, + { + "id": "script-api:dw/util/MappingKey", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MappingKey", + "tags": [ + "mappingkey", + "dw.util.mappingkey", + "dw/util" + ], + "title": "MappingKey" + }, + { + "id": "script-api:dw/util/MappingKey#getKeyComponents", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.getKeyComponents", + "tags": [ + "getkeycomponents", + "mappingkey.getkeycomponents" + ], + "title": "MappingKey.getKeyComponents" + }, + { + "id": "script-api:dw/util/MappingKey#getSingleComponentKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.getSingleComponentKey", + "tags": [ + "getsinglecomponentkey", + "mappingkey.getsinglecomponentkey" + ], + "title": "MappingKey.getSingleComponentKey" + }, + { + "id": "script-api:dw/util/MappingKey#keyComponents", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.keyComponents", + "tags": [ + "keycomponents", + "mappingkey.keycomponents" + ], + "title": "MappingKey.keyComponents" + }, + { + "id": "script-api:dw/util/MappingKey#singleComponentKey", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.singleComponentKey", + "tags": [ + "singlecomponentkey", + "mappingkey.singlecomponentkey" + ], + "title": "MappingKey.singleComponentKey" + }, + { + "id": "script-api:dw/util/MappingMgr", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MappingMgr", + "tags": [ + "mappingmgr", + "dw.util.mappingmgr", + "dw/util" + ], + "title": "MappingMgr" + }, + { + "id": "script-api:dw/util/MappingMgr#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.get", + "tags": [ + "get", + "mappingmgr.get" + ], + "title": "MappingMgr.get" + }, + { + "id": "script-api:dw/util/MappingMgr#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.get", + "tags": [ + "get", + "mappingmgr.get" + ], + "title": "MappingMgr.get" + }, + { + "id": "script-api:dw/util/MappingMgr#getFirst", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getFirst", + "tags": [ + "getfirst", + "mappingmgr.getfirst" + ], + "title": "MappingMgr.getFirst" + }, + { + "id": "script-api:dw/util/MappingMgr#getFirst", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getFirst", + "tags": [ + "getfirst", + "mappingmgr.getfirst" + ], + "title": "MappingMgr.getFirst" + }, + { + "id": "script-api:dw/util/MappingMgr#getMappingNames", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getMappingNames", + "tags": [ + "getmappingnames", + "mappingmgr.getmappingnames" + ], + "title": "MappingMgr.getMappingNames" + }, + { + "id": "script-api:dw/util/MappingMgr#getMappingNames", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getMappingNames", + "tags": [ + "getmappingnames", + "mappingmgr.getmappingnames" + ], + "title": "MappingMgr.getMappingNames" + }, + { + "id": "script-api:dw/util/MappingMgr#keyIterator", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.keyIterator", + "tags": [ + "keyiterator", + "mappingmgr.keyiterator" + ], + "title": "MappingMgr.keyIterator" + }, + { + "id": "script-api:dw/util/MappingMgr#keyIterator", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.keyIterator", + "tags": [ + "keyiterator", + "mappingmgr.keyiterator" + ], + "title": "MappingMgr.keyIterator" + }, + { + "id": "script-api:dw/util/MappingMgr#mappingNames", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.mappingNames", + "tags": [ + "mappingnames", + "mappingmgr.mappingnames" + ], + "title": "MappingMgr.mappingNames" + }, + { + "id": "script-api:dw/util/MappingMgr#mappingNames", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.mappingNames", + "tags": [ + "mappingnames", + "mappingmgr.mappingnames" + ], + "title": "MappingMgr.mappingNames" + }, + { + "id": "script-api:dw/util/PropertyComparator", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.PropertyComparator", + "tags": [ + "propertycomparator", + "dw.util.propertycomparator", + "dw/util" + ], + "title": "PropertyComparator" + }, + { + "id": "script-api:dw/util/PropertyComparator#compare", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/PropertyComparator", + "qualifiedName": "dw.util.PropertyComparator.compare", + "tags": [ + "compare", + "propertycomparator.compare" + ], + "title": "PropertyComparator.compare" + }, + { + "id": "script-api:dw/util/SecureEncoder", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SecureEncoder", + "tags": [ + "secureencoder", + "dw.util.secureencoder", + "dw/util" + ], + "title": "SecureEncoder" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlContent", + "tags": [ + "forhtmlcontent", + "secureencoder.forhtmlcontent" + ], + "title": "SecureEncoder.forHtmlContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlContent", + "tags": [ + "forhtmlcontent", + "secureencoder.forhtmlcontent" + ], + "title": "SecureEncoder.forHtmlContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInDoubleQuoteAttribute", + "tags": [ + "forhtmlindoublequoteattribute", + "secureencoder.forhtmlindoublequoteattribute" + ], + "title": "SecureEncoder.forHtmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInDoubleQuoteAttribute", + "tags": [ + "forhtmlindoublequoteattribute", + "secureencoder.forhtmlindoublequoteattribute" + ], + "title": "SecureEncoder.forHtmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInSingleQuoteAttribute", + "tags": [ + "forhtmlinsinglequoteattribute", + "secureencoder.forhtmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forHtmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInSingleQuoteAttribute", + "tags": [ + "forhtmlinsinglequoteattribute", + "secureencoder.forhtmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forHtmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlUnquotedAttribute", + "tags": [ + "forhtmlunquotedattribute", + "secureencoder.forhtmlunquotedattribute" + ], + "title": "SecureEncoder.forHtmlUnquotedAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlUnquotedAttribute", + "tags": [ + "forhtmlunquotedattribute", + "secureencoder.forhtmlunquotedattribute" + ], + "title": "SecureEncoder.forHtmlUnquotedAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJSONValue", + "tags": [ + "forjsonvalue", + "secureencoder.forjsonvalue" + ], + "title": "SecureEncoder.forJSONValue" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJSONValue", + "tags": [ + "forjsonvalue", + "secureencoder.forjsonvalue" + ], + "title": "SecureEncoder.forJSONValue" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInAttribute", + "tags": [ + "forjavascriptinattribute", + "secureencoder.forjavascriptinattribute" + ], + "title": "SecureEncoder.forJavaScriptInAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInAttribute", + "tags": [ + "forjavascriptinattribute", + "secureencoder.forjavascriptinattribute" + ], + "title": "SecureEncoder.forJavaScriptInAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInBlock", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInBlock", + "tags": [ + "forjavascriptinblock", + "secureencoder.forjavascriptinblock" + ], + "title": "SecureEncoder.forJavaScriptInBlock" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInBlock", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInBlock", + "tags": [ + "forjavascriptinblock", + "secureencoder.forjavascriptinblock" + ], + "title": "SecureEncoder.forJavaScriptInBlock" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInHTML", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInHTML", + "tags": [ + "forjavascriptinhtml", + "secureencoder.forjavascriptinhtml" + ], + "title": "SecureEncoder.forJavaScriptInHTML" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInHTML", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInHTML", + "tags": [ + "forjavascriptinhtml", + "secureencoder.forjavascriptinhtml" + ], + "title": "SecureEncoder.forJavaScriptInHTML" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInSource", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInSource", + "tags": [ + "forjavascriptinsource", + "secureencoder.forjavascriptinsource" + ], + "title": "SecureEncoder.forJavaScriptInSource" + }, + { + "id": "script-api:dw/util/SecureEncoder#forJavaScriptInSource", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJavaScriptInSource", + "tags": [ + "forjavascriptinsource", + "secureencoder.forjavascriptinsource" + ], + "title": "SecureEncoder.forJavaScriptInSource" + }, + { + "id": "script-api:dw/util/SecureEncoder#forUriComponent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forUriComponent", + "tags": [ + "foruricomponent", + "secureencoder.foruricomponent" + ], + "title": "SecureEncoder.forUriComponent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forUriComponent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forUriComponent", + "tags": [ + "foruricomponent", + "secureencoder.foruricomponent" + ], + "title": "SecureEncoder.forUriComponent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forUriComponentStrict", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forUriComponentStrict", + "tags": [ + "foruricomponentstrict", + "secureencoder.foruricomponentstrict" + ], + "title": "SecureEncoder.forUriComponentStrict" + }, + { + "id": "script-api:dw/util/SecureEncoder#forUriComponentStrict", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forUriComponentStrict", + "tags": [ + "foruricomponentstrict", + "secureencoder.foruricomponentstrict" + ], + "title": "SecureEncoder.forUriComponentStrict" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlCommentContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlCommentContent", + "tags": [ + "forxmlcommentcontent", + "secureencoder.forxmlcommentcontent" + ], + "title": "SecureEncoder.forXmlCommentContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlCommentContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlCommentContent", + "tags": [ + "forxmlcommentcontent", + "secureencoder.forxmlcommentcontent" + ], + "title": "SecureEncoder.forXmlCommentContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlContent", + "tags": [ + "forxmlcontent", + "secureencoder.forxmlcontent" + ], + "title": "SecureEncoder.forXmlContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlContent", + "tags": [ + "forxmlcontent", + "secureencoder.forxmlcontent" + ], + "title": "SecureEncoder.forXmlContent" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlInDoubleQuoteAttribute", + "tags": [ + "forxmlindoublequoteattribute", + "secureencoder.forxmlindoublequoteattribute" + ], + "title": "SecureEncoder.forXmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlInDoubleQuoteAttribute", + "tags": [ + "forxmlindoublequoteattribute", + "secureencoder.forxmlindoublequoteattribute" + ], + "title": "SecureEncoder.forXmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlInSingleQuoteAttribute", + "tags": [ + "forxmlinsinglequoteattribute", + "secureencoder.forxmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forXmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureEncoder#forXmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forXmlInSingleQuoteAttribute", + "tags": [ + "forxmlinsinglequoteattribute", + "secureencoder.forxmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forXmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SecureFilter", + "tags": [ + "securefilter", + "dw.util.securefilter", + "dw/util" + ], + "title": "SecureFilter" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlContent", + "tags": [ + "forhtmlcontent", + "securefilter.forhtmlcontent" + ], + "title": "SecureFilter.forHtmlContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlContent", + "tags": [ + "forhtmlcontent", + "securefilter.forhtmlcontent" + ], + "title": "SecureFilter.forHtmlContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlInDoubleQuoteAttribute", + "tags": [ + "forhtmlindoublequoteattribute", + "securefilter.forhtmlindoublequoteattribute" + ], + "title": "SecureFilter.forHtmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlInDoubleQuoteAttribute", + "tags": [ + "forhtmlindoublequoteattribute", + "securefilter.forhtmlindoublequoteattribute" + ], + "title": "SecureFilter.forHtmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlInSingleQuoteAttribute", + "tags": [ + "forhtmlinsinglequoteattribute", + "securefilter.forhtmlinsinglequoteattribute" + ], + "title": "SecureFilter.forHtmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlInSingleQuoteAttribute", + "tags": [ + "forhtmlinsinglequoteattribute", + "securefilter.forhtmlinsinglequoteattribute" + ], + "title": "SecureFilter.forHtmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlUnquotedAttribute", + "tags": [ + "forhtmlunquotedattribute", + "securefilter.forhtmlunquotedattribute" + ], + "title": "SecureFilter.forHtmlUnquotedAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forHtmlUnquotedAttribute", + "tags": [ + "forhtmlunquotedattribute", + "securefilter.forhtmlunquotedattribute" + ], + "title": "SecureFilter.forHtmlUnquotedAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJSONValue", + "tags": [ + "forjsonvalue", + "securefilter.forjsonvalue" + ], + "title": "SecureFilter.forJSONValue" + }, + { + "id": "script-api:dw/util/SecureFilter#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJSONValue", + "tags": [ + "forjsonvalue", + "securefilter.forjsonvalue" + ], + "title": "SecureFilter.forJSONValue" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInAttribute", + "tags": [ + "forjavascriptinattribute", + "securefilter.forjavascriptinattribute" + ], + "title": "SecureFilter.forJavaScriptInAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInAttribute", + "tags": [ + "forjavascriptinattribute", + "securefilter.forjavascriptinattribute" + ], + "title": "SecureFilter.forJavaScriptInAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInBlock", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInBlock", + "tags": [ + "forjavascriptinblock", + "securefilter.forjavascriptinblock" + ], + "title": "SecureFilter.forJavaScriptInBlock" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInBlock", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInBlock", + "tags": [ + "forjavascriptinblock", + "securefilter.forjavascriptinblock" + ], + "title": "SecureFilter.forJavaScriptInBlock" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInHTML", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInHTML", + "tags": [ + "forjavascriptinhtml", + "securefilter.forjavascriptinhtml" + ], + "title": "SecureFilter.forJavaScriptInHTML" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInHTML", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInHTML", + "tags": [ + "forjavascriptinhtml", + "securefilter.forjavascriptinhtml" + ], + "title": "SecureFilter.forJavaScriptInHTML" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInSource", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInSource", + "tags": [ + "forjavascriptinsource", + "securefilter.forjavascriptinsource" + ], + "title": "SecureFilter.forJavaScriptInSource" + }, + { + "id": "script-api:dw/util/SecureFilter#forJavaScriptInSource", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forJavaScriptInSource", + "tags": [ + "forjavascriptinsource", + "securefilter.forjavascriptinsource" + ], + "title": "SecureFilter.forJavaScriptInSource" + }, + { + "id": "script-api:dw/util/SecureFilter#forUriComponent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forUriComponent", + "tags": [ + "foruricomponent", + "securefilter.foruricomponent" + ], + "title": "SecureFilter.forUriComponent" + }, + { + "id": "script-api:dw/util/SecureFilter#forUriComponent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forUriComponent", + "tags": [ + "foruricomponent", + "securefilter.foruricomponent" + ], + "title": "SecureFilter.forUriComponent" + }, + { + "id": "script-api:dw/util/SecureFilter#forUriComponentStrict", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forUriComponentStrict", + "tags": [ + "foruricomponentstrict", + "securefilter.foruricomponentstrict" + ], + "title": "SecureFilter.forUriComponentStrict" + }, + { + "id": "script-api:dw/util/SecureFilter#forUriComponentStrict", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forUriComponentStrict", + "tags": [ + "foruricomponentstrict", + "securefilter.foruricomponentstrict" + ], + "title": "SecureFilter.forUriComponentStrict" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlCommentContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlCommentContent", + "tags": [ + "forxmlcommentcontent", + "securefilter.forxmlcommentcontent" + ], + "title": "SecureFilter.forXmlCommentContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlCommentContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlCommentContent", + "tags": [ + "forxmlcommentcontent", + "securefilter.forxmlcommentcontent" + ], + "title": "SecureFilter.forXmlCommentContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlContent", + "tags": [ + "forxmlcontent", + "securefilter.forxmlcontent" + ], + "title": "SecureFilter.forXmlContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlContent", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlContent", + "tags": [ + "forxmlcontent", + "securefilter.forxmlcontent" + ], + "title": "SecureFilter.forXmlContent" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlInDoubleQuoteAttribute", + "tags": [ + "forxmlindoublequoteattribute", + "securefilter.forxmlindoublequoteattribute" + ], + "title": "SecureFilter.forXmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlInDoubleQuoteAttribute", + "tags": [ + "forxmlindoublequoteattribute", + "securefilter.forxmlindoublequoteattribute" + ], + "title": "SecureFilter.forXmlInDoubleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlInSingleQuoteAttribute", + "tags": [ + "forxmlinsinglequoteattribute", + "securefilter.forxmlinsinglequoteattribute" + ], + "title": "SecureFilter.forXmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SecureFilter#forXmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SecureFilter", + "qualifiedName": "dw.util.SecureFilter.forXmlInSingleQuoteAttribute", + "tags": [ + "forxmlinsinglequoteattribute", + "securefilter.forxmlinsinglequoteattribute" + ], + "title": "SecureFilter.forXmlInSingleQuoteAttribute" + }, + { + "id": "script-api:dw/util/SeekableIterator", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SeekableIterator", + "tags": [ + "seekableiterator", + "dw.util.seekableiterator", + "dw/util" + ], + "title": "SeekableIterator" + }, + { + "id": "script-api:dw/util/SeekableIterator#asList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.asList", + "tags": [ + "aslist", + "seekableiterator.aslist" + ], + "title": "SeekableIterator.asList" + }, + { + "id": "script-api:dw/util/SeekableIterator#asList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.asList", + "tags": [ + "aslist", + "seekableiterator.aslist" + ], + "title": "SeekableIterator.asList" + }, + { + "id": "script-api:dw/util/SeekableIterator#close", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.close", + "tags": [ + "close", + "seekableiterator.close" + ], + "title": "SeekableIterator.close" + }, + { + "id": "script-api:dw/util/SeekableIterator#count", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.count", + "tags": [ + "count", + "seekableiterator.count" + ], + "title": "SeekableIterator.count" + }, + { + "id": "script-api:dw/util/SeekableIterator#first", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.first", + "tags": [ + "first", + "seekableiterator.first" + ], + "title": "SeekableIterator.first" + }, + { + "id": "script-api:dw/util/SeekableIterator#forward", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.forward", + "tags": [ + "forward", + "seekableiterator.forward" + ], + "title": "SeekableIterator.forward" + }, + { + "id": "script-api:dw/util/SeekableIterator#forward", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.forward", + "tags": [ + "forward", + "seekableiterator.forward" + ], + "title": "SeekableIterator.forward" + }, + { + "id": "script-api:dw/util/SeekableIterator#getCount", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.getCount", + "tags": [ + "getcount", + "seekableiterator.getcount" + ], + "title": "SeekableIterator.getCount" + }, + { + "id": "script-api:dw/util/SeekableIterator#hasNext", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.hasNext", + "tags": [ + "hasnext", + "seekableiterator.hasnext" + ], + "title": "SeekableIterator.hasNext" + }, + { + "id": "script-api:dw/util/SeekableIterator#next", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SeekableIterator", + "qualifiedName": "dw.util.SeekableIterator.next", + "tags": [ + "next", + "seekableiterator.next" + ], + "title": "SeekableIterator.next" + }, + { + "id": "script-api:dw/util/Set", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Set", + "tags": [ + "set", + "dw.util.set", + "dw/util" + ], + "title": "Set" + }, + { + "id": "script-api:dw/util/Set#EMPTY_SET", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Set", + "qualifiedName": "dw.util.Set.EMPTY_SET", + "tags": [ + "empty_set", + "set.empty_set" + ], + "title": "Set.EMPTY_SET" + }, + { + "id": "script-api:dw/util/Set#EMPTY_SET", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Set", + "qualifiedName": "dw.util.Set.EMPTY_SET", + "tags": [ + "empty_set", + "set.empty_set" + ], + "title": "Set.EMPTY_SET" + }, + { + "id": "script-api:dw/util/SortedMap", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SortedMap", + "tags": [ + "sortedmap", + "dw.util.sortedmap", + "dw/util" + ], + "title": "SortedMap" + }, + { + "id": "script-api:dw/util/SortedMap#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.clone", + "tags": [ + "clone", + "sortedmap.clone" + ], + "title": "SortedMap.clone" + }, + { + "id": "script-api:dw/util/SortedMap#firstKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.firstKey", + "tags": [ + "firstkey", + "sortedmap.firstkey" + ], + "title": "SortedMap.firstKey" + }, + { + "id": "script-api:dw/util/SortedMap#headMap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.headMap", + "tags": [ + "headmap", + "sortedmap.headmap" + ], + "title": "SortedMap.headMap" + }, + { + "id": "script-api:dw/util/SortedMap#lastKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.lastKey", + "tags": [ + "lastkey", + "sortedmap.lastkey" + ], + "title": "SortedMap.lastKey" + }, + { + "id": "script-api:dw/util/SortedMap#subMap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.subMap", + "tags": [ + "submap", + "sortedmap.submap" + ], + "title": "SortedMap.subMap" + }, + { + "id": "script-api:dw/util/SortedMap#tailMap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedMap", + "qualifiedName": "dw.util.SortedMap.tailMap", + "tags": [ + "tailmap", + "sortedmap.tailmap" + ], + "title": "SortedMap.tailMap" + }, + { + "id": "script-api:dw/util/SortedSet", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SortedSet", + "tags": [ + "sortedset", + "dw.util.sortedset", + "dw/util" + ], + "title": "SortedSet" + }, + { + "id": "script-api:dw/util/SortedSet#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.clone", + "tags": [ + "clone", + "sortedset.clone" + ], + "title": "SortedSet.clone" + }, + { + "id": "script-api:dw/util/SortedSet#first", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.first", + "tags": [ + "first", + "sortedset.first" + ], + "title": "SortedSet.first" + }, + { + "id": "script-api:dw/util/SortedSet#headSet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.headSet", + "tags": [ + "headset", + "sortedset.headset" + ], + "title": "SortedSet.headSet" + }, + { + "id": "script-api:dw/util/SortedSet#last", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.last", + "tags": [ + "last", + "sortedset.last" + ], + "title": "SortedSet.last" + }, + { + "id": "script-api:dw/util/SortedSet#subSet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.subSet", + "tags": [ + "subset", + "sortedset.subset" + ], + "title": "SortedSet.subSet" + }, + { + "id": "script-api:dw/util/SortedSet#tailSet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/SortedSet", + "qualifiedName": "dw.util.SortedSet.tailSet", + "tags": [ + "tailset", + "sortedset.tailset" + ], + "title": "SortedSet.tailSet" + }, + { + "id": "script-api:dw/util/StringUtils", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.StringUtils", + "tags": [ + "stringutils", + "dw.util.stringutils", + "dw/util" + ], + "title": "StringUtils" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_HTML", + "tags": [ + "encode_type_html", + "stringutils.encode_type_html" + ], + "title": "StringUtils.ENCODE_TYPE_HTML" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_HTML", + "tags": [ + "encode_type_html", + "stringutils.encode_type_html" + ], + "title": "StringUtils.ENCODE_TYPE_HTML" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_WML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_WML", + "tags": [ + "encode_type_wml", + "stringutils.encode_type_wml" + ], + "title": "StringUtils.ENCODE_TYPE_WML" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_WML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_WML", + "tags": [ + "encode_type_wml", + "stringutils.encode_type_wml" + ], + "title": "StringUtils.ENCODE_TYPE_WML" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_XML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_XML", + "tags": [ + "encode_type_xml", + "stringutils.encode_type_xml" + ], + "title": "StringUtils.ENCODE_TYPE_XML" + }, + { + "id": "script-api:dw/util/StringUtils#ENCODE_TYPE_XML", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ENCODE_TYPE_XML", + "tags": [ + "encode_type_xml", + "stringutils.encode_type_xml" + ], + "title": "StringUtils.ENCODE_TYPE_XML" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_CHAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_CHAR", + "tags": [ + "truncate_char", + "stringutils.truncate_char" + ], + "title": "StringUtils.TRUNCATE_CHAR" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_CHAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_CHAR", + "tags": [ + "truncate_char", + "stringutils.truncate_char" + ], + "title": "StringUtils.TRUNCATE_CHAR" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_SENTENCE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_SENTENCE", + "tags": [ + "truncate_sentence", + "stringutils.truncate_sentence" + ], + "title": "StringUtils.TRUNCATE_SENTENCE" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_SENTENCE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_SENTENCE", + "tags": [ + "truncate_sentence", + "stringutils.truncate_sentence" + ], + "title": "StringUtils.TRUNCATE_SENTENCE" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_WORD", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_WORD", + "tags": [ + "truncate_word", + "stringutils.truncate_word" + ], + "title": "StringUtils.TRUNCATE_WORD" + }, + { + "id": "script-api:dw/util/StringUtils#TRUNCATE_WORD", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.TRUNCATE_WORD", + "tags": [ + "truncate_word", + "stringutils.truncate_word" + ], + "title": "StringUtils.TRUNCATE_WORD" + }, + { + "id": "script-api:dw/util/StringUtils#decodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeBase64", + "tags": [ + "decodebase64", + "stringutils.decodebase64" + ], + "title": "StringUtils.decodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#decodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeBase64", + "tags": [ + "decodebase64", + "stringutils.decodebase64" + ], + "title": "StringUtils.decodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#decodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeBase64", + "tags": [ + "decodebase64", + "stringutils.decodebase64" + ], + "title": "StringUtils.decodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#decodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeBase64", + "tags": [ + "decodebase64", + "stringutils.decodebase64" + ], + "title": "StringUtils.decodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#decodeString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeString", + "tags": [ + "decodestring", + "stringutils.decodestring" + ], + "title": "StringUtils.decodeString" + }, + { + "id": "script-api:dw/util/StringUtils#decodeString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.decodeString", + "tags": [ + "decodestring", + "stringutils.decodestring" + ], + "title": "StringUtils.decodeString" + }, + { + "id": "script-api:dw/util/StringUtils#encodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeBase64", + "tags": [ + "encodebase64", + "stringutils.encodebase64" + ], + "title": "StringUtils.encodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#encodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeBase64", + "tags": [ + "encodebase64", + "stringutils.encodebase64" + ], + "title": "StringUtils.encodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#encodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeBase64", + "tags": [ + "encodebase64", + "stringutils.encodebase64" + ], + "title": "StringUtils.encodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#encodeBase64", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeBase64", + "tags": [ + "encodebase64", + "stringutils.encodebase64" + ], + "title": "StringUtils.encodeBase64" + }, + { + "id": "script-api:dw/util/StringUtils#encodeString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeString", + "tags": [ + "encodestring", + "stringutils.encodestring" + ], + "title": "StringUtils.encodeString" + }, + { + "id": "script-api:dw/util/StringUtils#encodeString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.encodeString", + "tags": [ + "encodestring", + "stringutils.encodestring" + ], + "title": "StringUtils.encodeString" + }, + { + "id": "script-api:dw/util/StringUtils#format", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.format", + "tags": [ + "format", + "stringutils.format" + ], + "title": "StringUtils.format" + }, + { + "id": "script-api:dw/util/StringUtils#format", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.format", + "tags": [ + "format", + "stringutils.format" + ], + "title": "StringUtils.format" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatCalendar", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatCalendar", + "tags": [ + "formatcalendar", + "stringutils.formatcalendar" + ], + "title": "StringUtils.formatCalendar" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatDate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatDate", + "tags": [ + "formatdate", + "stringutils.formatdate" + ], + "title": "StringUtils.formatDate" + }, + { + "id": "script-api:dw/util/StringUtils#formatInteger", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatInteger", + "tags": [ + "formatinteger", + "stringutils.formatinteger" + ], + "title": "StringUtils.formatInteger" + }, + { + "id": "script-api:dw/util/StringUtils#formatInteger", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatInteger", + "tags": [ + "formatinteger", + "stringutils.formatinteger" + ], + "title": "StringUtils.formatInteger" + }, + { + "id": "script-api:dw/util/StringUtils#formatMoney", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatMoney", + "tags": [ + "formatmoney", + "stringutils.formatmoney" + ], + "title": "StringUtils.formatMoney" + }, + { + "id": "script-api:dw/util/StringUtils#formatMoney", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatMoney", + "tags": [ + "formatmoney", + "stringutils.formatmoney" + ], + "title": "StringUtils.formatMoney" + }, + { + "id": "script-api:dw/util/StringUtils#formatNumber", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatNumber", + "tags": [ + "formatnumber", + "stringutils.formatnumber" + ], + "title": "StringUtils.formatNumber" + }, + { + "id": "script-api:dw/util/StringUtils#formatNumber", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.formatNumber", + "tags": [ + "formatnumber", + "stringutils.formatnumber" + ], + "title": "StringUtils.formatNumber" + }, + { + "id": "script-api:dw/util/StringUtils#garble", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.garble", + "tags": [ + "garble", + "stringutils.garble" + ], + "title": "StringUtils.garble" + }, + { + "id": "script-api:dw/util/StringUtils#garble", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.garble", + "tags": [ + "garble", + "stringutils.garble" + ], + "title": "StringUtils.garble" + }, + { + "id": "script-api:dw/util/StringUtils#ltrim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ltrim", + "tags": [ + "ltrim", + "stringutils.ltrim" + ], + "title": "StringUtils.ltrim" + }, + { + "id": "script-api:dw/util/StringUtils#ltrim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.ltrim", + "tags": [ + "ltrim", + "stringutils.ltrim" + ], + "title": "StringUtils.ltrim" + }, + { + "id": "script-api:dw/util/StringUtils#pad", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.pad", + "tags": [ + "pad", + "stringutils.pad" + ], + "title": "StringUtils.pad" + }, + { + "id": "script-api:dw/util/StringUtils#pad", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.pad", + "tags": [ + "pad", + "stringutils.pad" + ], + "title": "StringUtils.pad" + }, + { + "id": "script-api:dw/util/StringUtils#rtrim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.rtrim", + "tags": [ + "rtrim", + "stringutils.rtrim" + ], + "title": "StringUtils.rtrim" + }, + { + "id": "script-api:dw/util/StringUtils#rtrim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.rtrim", + "tags": [ + "rtrim", + "stringutils.rtrim" + ], + "title": "StringUtils.rtrim" + }, + { + "id": "script-api:dw/util/StringUtils#stringToHtml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToHtml", + "tags": [ + "stringtohtml", + "stringutils.stringtohtml" + ], + "title": "StringUtils.stringToHtml" + }, + { + "id": "script-api:dw/util/StringUtils#stringToHtml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToHtml", + "tags": [ + "stringtohtml", + "stringutils.stringtohtml" + ], + "title": "StringUtils.stringToHtml" + }, + { + "id": "script-api:dw/util/StringUtils#stringToWml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToWml", + "tags": [ + "stringtowml", + "stringutils.stringtowml" + ], + "title": "StringUtils.stringToWml" + }, + { + "id": "script-api:dw/util/StringUtils#stringToWml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToWml", + "tags": [ + "stringtowml", + "stringutils.stringtowml" + ], + "title": "StringUtils.stringToWml" + }, + { + "id": "script-api:dw/util/StringUtils#stringToXml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToXml", + "tags": [ + "stringtoxml", + "stringutils.stringtoxml" + ], + "title": "StringUtils.stringToXml" + }, + { + "id": "script-api:dw/util/StringUtils#stringToXml", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.stringToXml", + "tags": [ + "stringtoxml", + "stringutils.stringtoxml" + ], + "title": "StringUtils.stringToXml" + }, + { + "id": "script-api:dw/util/StringUtils#trim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.trim", + "tags": [ + "trim", + "stringutils.trim" + ], + "title": "StringUtils.trim" + }, + { + "id": "script-api:dw/util/StringUtils#trim", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.trim", + "tags": [ + "trim", + "stringutils.trim" + ], + "title": "StringUtils.trim" + }, + { + "id": "script-api:dw/util/StringUtils#truncate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.truncate", + "tags": [ + "truncate", + "stringutils.truncate" + ], + "title": "StringUtils.truncate" + }, + { + "id": "script-api:dw/util/StringUtils#truncate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/StringUtils", + "qualifiedName": "dw.util.StringUtils.truncate", + "tags": [ + "truncate", + "stringutils.truncate" + ], + "title": "StringUtils.truncate" + }, + { + "id": "script-api:dw/util/Template", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Template", + "tags": [ + "template", + "dw.util.template", + "dw/util" + ], + "title": "Template" + }, + { + "id": "script-api:dw/util/Template#render", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Template", + "qualifiedName": "dw.util.Template.render", + "tags": [ + "render", + "template.render" + ], + "title": "Template.render" + }, + { + "id": "script-api:dw/util/Template#render", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Template", + "qualifiedName": "dw.util.Template.render", + "tags": [ + "render", + "template.render" + ], + "title": "Template.render" + }, + { + "id": "script-api:dw/util/Template#setLocale", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Template", + "qualifiedName": "dw.util.Template.setLocale", + "tags": [ + "setlocale", + "template.setlocale" + ], + "title": "Template.setLocale" + }, + { + "id": "script-api:dw/util/UUIDUtils", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.UUIDUtils", + "tags": [ + "uuidutils", + "dw.util.uuidutils", + "dw/util" + ], + "title": "UUIDUtils" + }, + { + "id": "script-api:dw/util/UUIDUtils#createUUID", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/UUIDUtils", + "qualifiedName": "dw.util.UUIDUtils.createUUID", + "tags": [ + "createuuid", + "uuidutils.createuuid" + ], + "title": "UUIDUtils.createUUID" + }, + { + "id": "script-api:dw/util/UUIDUtils#createUUID", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/UUIDUtils", + "qualifiedName": "dw.util.UUIDUtils.createUUID", + "tags": [ + "createuuid", + "uuidutils.createuuid" + ], + "title": "UUIDUtils.createUUID" + }, + { + "id": "script-api:dw/value", + "kind": "package", + "packagePath": "dw/value", + "qualifiedName": "dw.value", + "tags": [ + "dw/value", + "dw.value" + ], + "title": "dw.value" + }, + { + "id": "script-api:dw/value/EnumValue", + "kind": "class", + "packagePath": "dw/value", + "parentId": "script-api:dw/value", + "qualifiedName": "dw.value.EnumValue", + "tags": [ + "enumvalue", + "dw.value.enumvalue", + "dw/value" + ], + "title": "EnumValue" + }, + { + "id": "script-api:dw/value/EnumValue#displayValue", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.displayValue", + "tags": [ + "displayvalue", + "enumvalue.displayvalue" + ], + "title": "EnumValue.displayValue" + }, + { + "id": "script-api:dw/value/EnumValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.getDisplayValue", + "tags": [ + "getdisplayvalue", + "enumvalue.getdisplayvalue" + ], + "title": "EnumValue.getDisplayValue" + }, + { + "id": "script-api:dw/value/EnumValue#getValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.getValue", + "tags": [ + "getvalue", + "enumvalue.getvalue" + ], + "title": "EnumValue.getValue" + }, + { + "id": "script-api:dw/value/EnumValue#toString", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.toString", + "tags": [ + "tostring", + "enumvalue.tostring" + ], + "title": "EnumValue.toString" + }, + { + "id": "script-api:dw/value/EnumValue#value", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.value", + "tags": [ + "value", + "enumvalue.value" + ], + "title": "EnumValue.value" + }, + { + "id": "script-api:dw/value/EnumValue#valueOf", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/EnumValue", + "qualifiedName": "dw.value.EnumValue.valueOf", + "tags": [ + "valueof", + "enumvalue.valueof" + ], + "title": "EnumValue.valueOf" + }, + { + "id": "script-api:dw/value/MimeEncodedText", + "kind": "class", + "packagePath": "dw/value", + "parentId": "script-api:dw/value", + "qualifiedName": "dw.value.MimeEncodedText", + "tags": [ + "mimeencodedtext", + "dw.value.mimeencodedtext", + "dw/value" + ], + "title": "MimeEncodedText" + }, + { + "id": "script-api:dw/value/MimeEncodedText#encoding", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.encoding", + "tags": [ + "encoding", + "mimeencodedtext.encoding" + ], + "title": "MimeEncodedText.encoding" + }, + { + "id": "script-api:dw/value/MimeEncodedText#getEncoding", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.getEncoding", + "tags": [ + "getencoding", + "mimeencodedtext.getencoding" + ], + "title": "MimeEncodedText.getEncoding" + }, + { + "id": "script-api:dw/value/MimeEncodedText#getMimeType", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.getMimeType", + "tags": [ + "getmimetype", + "mimeencodedtext.getmimetype" + ], + "title": "MimeEncodedText.getMimeType" + }, + { + "id": "script-api:dw/value/MimeEncodedText#getText", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.getText", + "tags": [ + "gettext", + "mimeencodedtext.gettext" + ], + "title": "MimeEncodedText.getText" + }, + { + "id": "script-api:dw/value/MimeEncodedText#mimeType", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.mimeType", + "tags": [ + "mimetype", + "mimeencodedtext.mimetype" + ], + "title": "MimeEncodedText.mimeType" + }, + { + "id": "script-api:dw/value/MimeEncodedText#text", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/MimeEncodedText", + "qualifiedName": "dw.value.MimeEncodedText.text", + "tags": [ + "text", + "mimeencodedtext.text" + ], + "title": "MimeEncodedText.text" + }, + { + "id": "script-api:dw/value/Money", + "kind": "class", + "packagePath": "dw/value", + "parentId": "script-api:dw/value", + "qualifiedName": "dw.value.Money", + "tags": [ + "money", + "dw.value.money", + "dw/value" + ], + "title": "Money" + }, + { + "id": "script-api:dw/value/Money#NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.NOT_AVAILABLE", + "tags": [ + "not_available", + "money.not_available" + ], + "title": "Money.NOT_AVAILABLE" + }, + { + "id": "script-api:dw/value/Money#NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.NOT_AVAILABLE", + "tags": [ + "not_available", + "money.not_available" + ], + "title": "Money.NOT_AVAILABLE" + }, + { + "id": "script-api:dw/value/Money#add", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.add", + "tags": [ + "add", + "money.add" + ], + "title": "Money.add" + }, + { + "id": "script-api:dw/value/Money#addPercent", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.addPercent", + "tags": [ + "addpercent", + "money.addpercent" + ], + "title": "Money.addPercent" + }, + { + "id": "script-api:dw/value/Money#addRate", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.addRate", + "tags": [ + "addrate", + "money.addrate" + ], + "title": "Money.addRate" + }, + { + "id": "script-api:dw/value/Money#available", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.available", + "tags": [ + "available", + "money.available" + ], + "title": "Money.available" + }, + { + "id": "script-api:dw/value/Money#compareTo", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.compareTo", + "tags": [ + "compareto", + "money.compareto" + ], + "title": "Money.compareTo" + }, + { + "id": "script-api:dw/value/Money#currencyCode", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.currencyCode", + "tags": [ + "currencycode", + "money.currencycode" + ], + "title": "Money.currencyCode" + }, + { + "id": "script-api:dw/value/Money#decimalValue", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.decimalValue", + "tags": [ + "decimalvalue", + "money.decimalvalue" + ], + "title": "Money.decimalValue" + }, + { + "id": "script-api:dw/value/Money#divide", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.divide", + "tags": [ + "divide", + "money.divide" + ], + "title": "Money.divide" + }, + { + "id": "script-api:dw/value/Money#equals", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.equals", + "tags": [ + "equals", + "money.equals" + ], + "title": "Money.equals" + }, + { + "id": "script-api:dw/value/Money#getCurrencyCode", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.getCurrencyCode", + "tags": [ + "getcurrencycode", + "money.getcurrencycode" + ], + "title": "Money.getCurrencyCode" + }, + { + "id": "script-api:dw/value/Money#getDecimalValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.getDecimalValue", + "tags": [ + "getdecimalvalue", + "money.getdecimalvalue" + ], + "title": "Money.getDecimalValue" + }, + { + "id": "script-api:dw/value/Money#getValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.getValue", + "tags": [ + "getvalue", + "money.getvalue" + ], + "title": "Money.getValue" + }, + { + "id": "script-api:dw/value/Money#getValueOrNull", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.getValueOrNull", + "tags": [ + "getvalueornull", + "money.getvalueornull" + ], + "title": "Money.getValueOrNull" + }, + { + "id": "script-api:dw/value/Money#hashCode", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.hashCode", + "tags": [ + "hashcode", + "money.hashcode" + ], + "title": "Money.hashCode" + }, + { + "id": "script-api:dw/value/Money#isAvailable", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.isAvailable", + "tags": [ + "isavailable", + "money.isavailable" + ], + "title": "Money.isAvailable" + }, + { + "id": "script-api:dw/value/Money#isOfSameCurrency", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.isOfSameCurrency", + "tags": [ + "isofsamecurrency", + "money.isofsamecurrency" + ], + "title": "Money.isOfSameCurrency" + }, + { + "id": "script-api:dw/value/Money#multiply", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.multiply", + "tags": [ + "multiply", + "money.multiply" + ], + "title": "Money.multiply" + }, + { + "id": "script-api:dw/value/Money#multiply", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.multiply", + "tags": [ + "multiply", + "money.multiply" + ], + "title": "Money.multiply" + }, + { + "id": "script-api:dw/value/Money#newMoney", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.newMoney", + "tags": [ + "newmoney", + "money.newmoney" + ], + "title": "Money.newMoney" + }, + { + "id": "script-api:dw/value/Money#percentLessThan", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.percentLessThan", + "tags": [ + "percentlessthan", + "money.percentlessthan" + ], + "title": "Money.percentLessThan" + }, + { + "id": "script-api:dw/value/Money#percentOf", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.percentOf", + "tags": [ + "percentof", + "money.percentof" + ], + "title": "Money.percentOf" + }, + { + "id": "script-api:dw/value/Money#prorate", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.prorate", + "tags": [ + "prorate", + "money.prorate" + ], + "title": "Money.prorate" + }, + { + "id": "script-api:dw/value/Money#prorate", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.prorate", + "tags": [ + "prorate", + "money.prorate" + ], + "title": "Money.prorate" + }, + { + "id": "script-api:dw/value/Money#subtract", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.subtract", + "tags": [ + "subtract", + "money.subtract" + ], + "title": "Money.subtract" + }, + { + "id": "script-api:dw/value/Money#subtractPercent", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.subtractPercent", + "tags": [ + "subtractpercent", + "money.subtractpercent" + ], + "title": "Money.subtractPercent" + }, + { + "id": "script-api:dw/value/Money#subtractRate", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.subtractRate", + "tags": [ + "subtractrate", + "money.subtractrate" + ], + "title": "Money.subtractRate" + }, + { + "id": "script-api:dw/value/Money#toFormattedString", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.toFormattedString", + "tags": [ + "toformattedstring", + "money.toformattedstring" + ], + "title": "Money.toFormattedString" + }, + { + "id": "script-api:dw/value/Money#toNumberString", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.toNumberString", + "tags": [ + "tonumberstring", + "money.tonumberstring" + ], + "title": "Money.toNumberString" + }, + { + "id": "script-api:dw/value/Money#toString", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.toString", + "tags": [ + "tostring", + "money.tostring" + ], + "title": "Money.toString" + }, + { + "id": "script-api:dw/value/Money#value", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.value", + "tags": [ + "value", + "money.value" + ], + "title": "Money.value" + }, + { + "id": "script-api:dw/value/Money#valueOf", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.valueOf", + "tags": [ + "valueof", + "money.valueof" + ], + "title": "Money.valueOf" + }, + { + "id": "script-api:dw/value/Money#valueOrNull", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Money", + "qualifiedName": "dw.value.Money.valueOrNull", + "tags": [ + "valueornull", + "money.valueornull" + ], + "title": "Money.valueOrNull" + }, + { + "id": "script-api:dw/value/Quantity", + "kind": "class", + "packagePath": "dw/value", + "parentId": "script-api:dw/value", + "qualifiedName": "dw.value.Quantity", + "tags": [ + "quantity", + "dw.value.quantity", + "dw/value" + ], + "title": "Quantity" + }, + { + "id": "script-api:dw/value/Quantity#add", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.add", + "tags": [ + "add", + "quantity.add" + ], + "title": "Quantity.add" + }, + { + "id": "script-api:dw/value/Quantity#available", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.available", + "tags": [ + "available", + "quantity.available" + ], + "title": "Quantity.available" + }, + { + "id": "script-api:dw/value/Quantity#compareTo", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.compareTo", + "tags": [ + "compareto", + "quantity.compareto" + ], + "title": "Quantity.compareTo" + }, + { + "id": "script-api:dw/value/Quantity#decimalValue", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.decimalValue", + "tags": [ + "decimalvalue", + "quantity.decimalvalue" + ], + "title": "Quantity.decimalValue" + }, + { + "id": "script-api:dw/value/Quantity#divide", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.divide", + "tags": [ + "divide", + "quantity.divide" + ], + "title": "Quantity.divide" + }, + { + "id": "script-api:dw/value/Quantity#equals", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.equals", + "tags": [ + "equals", + "quantity.equals" + ], + "title": "Quantity.equals" + }, + { + "id": "script-api:dw/value/Quantity#getDecimalValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.getDecimalValue", + "tags": [ + "getdecimalvalue", + "quantity.getdecimalvalue" + ], + "title": "Quantity.getDecimalValue" + }, + { + "id": "script-api:dw/value/Quantity#getUnit", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.getUnit", + "tags": [ + "getunit", + "quantity.getunit" + ], + "title": "Quantity.getUnit" + }, + { + "id": "script-api:dw/value/Quantity#getValue", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.getValue", + "tags": [ + "getvalue", + "quantity.getvalue" + ], + "title": "Quantity.getValue" + }, + { + "id": "script-api:dw/value/Quantity#hashCode", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.hashCode", + "tags": [ + "hashcode", + "quantity.hashcode" + ], + "title": "Quantity.hashCode" + }, + { + "id": "script-api:dw/value/Quantity#isAvailable", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.isAvailable", + "tags": [ + "isavailable", + "quantity.isavailable" + ], + "title": "Quantity.isAvailable" + }, + { + "id": "script-api:dw/value/Quantity#isOfSameUnit", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.isOfSameUnit", + "tags": [ + "isofsameunit", + "quantity.isofsameunit" + ], + "title": "Quantity.isOfSameUnit" + }, + { + "id": "script-api:dw/value/Quantity#multiply", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.multiply", + "tags": [ + "multiply", + "quantity.multiply" + ], + "title": "Quantity.multiply" + }, + { + "id": "script-api:dw/value/Quantity#newQuantity", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.newQuantity", + "tags": [ + "newquantity", + "quantity.newquantity" + ], + "title": "Quantity.newQuantity" + }, + { + "id": "script-api:dw/value/Quantity#round", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.round", + "tags": [ + "round", + "quantity.round" + ], + "title": "Quantity.round" + }, + { + "id": "script-api:dw/value/Quantity#subtract", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.subtract", + "tags": [ + "subtract", + "quantity.subtract" + ], + "title": "Quantity.subtract" + }, + { + "id": "script-api:dw/value/Quantity#toString", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.toString", + "tags": [ + "tostring", + "quantity.tostring" + ], + "title": "Quantity.toString" + }, + { + "id": "script-api:dw/value/Quantity#unit", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.unit", + "tags": [ + "unit", + "quantity.unit" + ], + "title": "Quantity.unit" + }, + { + "id": "script-api:dw/value/Quantity#value", + "kind": "property", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.value", + "tags": [ + "value", + "quantity.value" + ], + "title": "Quantity.value" + }, + { + "id": "script-api:dw/value/Quantity#valueOf", + "kind": "method", + "packagePath": "dw/value", + "parentId": "script-api:dw/value/Quantity", + "qualifiedName": "dw.value.Quantity.valueOf", + "tags": [ + "valueof", + "quantity.valueof" + ], + "title": "Quantity.valueOf" + }, + { + "id": "script-api:dw/web", + "kind": "package", + "packagePath": "dw/web", + "qualifiedName": "dw.web", + "tags": [ + "dw/web", + "dw.web" + ], + "title": "dw.web" + }, + { + "id": "script-api:dw/web/CSRFProtection", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.CSRFProtection", + "tags": [ + "csrfprotection", + "dw.web.csrfprotection", + "dw/web" + ], + "title": "CSRFProtection" + }, + { + "id": "script-api:dw/web/CSRFProtection#generateToken", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.generateToken", + "tags": [ + "generatetoken", + "csrfprotection.generatetoken" + ], + "title": "CSRFProtection.generateToken" + }, + { + "id": "script-api:dw/web/CSRFProtection#generateToken", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.generateToken", + "tags": [ + "generatetoken", + "csrfprotection.generatetoken" + ], + "title": "CSRFProtection.generateToken" + }, + { + "id": "script-api:dw/web/CSRFProtection#getTokenName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.getTokenName", + "tags": [ + "gettokenname", + "csrfprotection.gettokenname" + ], + "title": "CSRFProtection.getTokenName" + }, + { + "id": "script-api:dw/web/CSRFProtection#getTokenName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.getTokenName", + "tags": [ + "gettokenname", + "csrfprotection.gettokenname" + ], + "title": "CSRFProtection.getTokenName" + }, + { + "id": "script-api:dw/web/CSRFProtection#tokenName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.tokenName", + "tags": [ + "tokenname", + "csrfprotection.tokenname" + ], + "title": "CSRFProtection.tokenName" + }, + { + "id": "script-api:dw/web/CSRFProtection#tokenName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.tokenName", + "tags": [ + "tokenname", + "csrfprotection.tokenname" + ], + "title": "CSRFProtection.tokenName" + }, + { + "id": "script-api:dw/web/CSRFProtection#validateRequest", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.validateRequest", + "tags": [ + "validaterequest", + "csrfprotection.validaterequest" + ], + "title": "CSRFProtection.validateRequest" + }, + { + "id": "script-api:dw/web/CSRFProtection#validateRequest", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/CSRFProtection", + "qualifiedName": "dw.web.CSRFProtection.validateRequest", + "tags": [ + "validaterequest", + "csrfprotection.validaterequest" + ], + "title": "CSRFProtection.validateRequest" + }, + { + "id": "script-api:dw/web/ClickStream", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.ClickStream", + "tags": [ + "clickstream", + "dw.web.clickstream", + "dw/web" + ], + "title": "ClickStream" + }, + { + "id": "script-api:dw/web/ClickStream#clicks", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.clicks", + "tags": [ + "clicks", + "clickstream.clicks" + ], + "title": "ClickStream.clicks" + }, + { + "id": "script-api:dw/web/ClickStream#enabled", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.enabled", + "tags": [ + "enabled", + "clickstream.enabled" + ], + "title": "ClickStream.enabled" + }, + { + "id": "script-api:dw/web/ClickStream#first", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.first", + "tags": [ + "first", + "clickstream.first" + ], + "title": "ClickStream.first" + }, + { + "id": "script-api:dw/web/ClickStream#getClicks", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.getClicks", + "tags": [ + "getclicks", + "clickstream.getclicks" + ], + "title": "ClickStream.getClicks" + }, + { + "id": "script-api:dw/web/ClickStream#getFirst", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.getFirst", + "tags": [ + "getfirst", + "clickstream.getfirst" + ], + "title": "ClickStream.getFirst" + }, + { + "id": "script-api:dw/web/ClickStream#getLast", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.getLast", + "tags": [ + "getlast", + "clickstream.getlast" + ], + "title": "ClickStream.getLast" + }, + { + "id": "script-api:dw/web/ClickStream#isEnabled", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.isEnabled", + "tags": [ + "isenabled", + "clickstream.isenabled" + ], + "title": "ClickStream.isEnabled" + }, + { + "id": "script-api:dw/web/ClickStream#isPartial", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.isPartial", + "tags": [ + "ispartial", + "clickstream.ispartial" + ], + "title": "ClickStream.isPartial" + }, + { + "id": "script-api:dw/web/ClickStream#last", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.last", + "tags": [ + "last", + "clickstream.last" + ], + "title": "ClickStream.last" + }, + { + "id": "script-api:dw/web/ClickStream#partial", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStream", + "qualifiedName": "dw.web.ClickStream.partial", + "tags": [ + "partial", + "clickstream.partial" + ], + "title": "ClickStream.partial" + }, + { + "id": "script-api:dw/web/ClickStreamEntry", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.ClickStreamEntry", + "tags": [ + "clickstreamentry", + "dw.web.clickstreamentry", + "dw/web" + ], + "title": "ClickStreamEntry" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getHost", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getHost", + "tags": [ + "gethost", + "clickstreamentry.gethost" + ], + "title": "ClickStreamEntry.getHost" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getLocale", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getLocale", + "tags": [ + "getlocale", + "clickstreamentry.getlocale" + ], + "title": "ClickStreamEntry.getLocale" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getParameter", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getParameter", + "tags": [ + "getparameter", + "clickstreamentry.getparameter" + ], + "title": "ClickStreamEntry.getParameter" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getPath", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getPath", + "tags": [ + "getpath", + "clickstreamentry.getpath" + ], + "title": "ClickStreamEntry.getPath" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getPipelineName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getPipelineName", + "tags": [ + "getpipelinename", + "clickstreamentry.getpipelinename" + ], + "title": "ClickStreamEntry.getPipelineName" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getQueryString", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getQueryString", + "tags": [ + "getquerystring", + "clickstreamentry.getquerystring" + ], + "title": "ClickStreamEntry.getQueryString" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getReferer", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getReferer", + "tags": [ + "getreferer", + "clickstreamentry.getreferer" + ], + "title": "ClickStreamEntry.getReferer" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getRemoteAddress", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getRemoteAddress", + "tags": [ + "getremoteaddress", + "clickstreamentry.getremoteaddress" + ], + "title": "ClickStreamEntry.getRemoteAddress" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getTimestamp", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getTimestamp", + "tags": [ + "gettimestamp", + "clickstreamentry.gettimestamp" + ], + "title": "ClickStreamEntry.getTimestamp" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getUrl", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getUrl", + "tags": [ + "geturl", + "clickstreamentry.geturl" + ], + "title": "ClickStreamEntry.getUrl" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#getUserAgent", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.getUserAgent", + "tags": [ + "getuseragent", + "clickstreamentry.getuseragent" + ], + "title": "ClickStreamEntry.getUserAgent" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#host", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.host", + "tags": [ + "host", + "clickstreamentry.host" + ], + "title": "ClickStreamEntry.host" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#locale", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.locale", + "tags": [ + "locale", + "clickstreamentry.locale" + ], + "title": "ClickStreamEntry.locale" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#path", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.path", + "tags": [ + "path", + "clickstreamentry.path" + ], + "title": "ClickStreamEntry.path" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#pipelineName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.pipelineName", + "tags": [ + "pipelinename", + "clickstreamentry.pipelinename" + ], + "title": "ClickStreamEntry.pipelineName" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#queryString", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.queryString", + "tags": [ + "querystring", + "clickstreamentry.querystring" + ], + "title": "ClickStreamEntry.queryString" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#referer", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.referer", + "tags": [ + "referer", + "clickstreamentry.referer" + ], + "title": "ClickStreamEntry.referer" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#remoteAddress", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.remoteAddress", + "tags": [ + "remoteaddress", + "clickstreamentry.remoteaddress" + ], + "title": "ClickStreamEntry.remoteAddress" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#timestamp", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.timestamp", + "tags": [ + "timestamp", + "clickstreamentry.timestamp" + ], + "title": "ClickStreamEntry.timestamp" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#url", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.url", + "tags": [ + "url", + "clickstreamentry.url" + ], + "title": "ClickStreamEntry.url" + }, + { + "id": "script-api:dw/web/ClickStreamEntry#userAgent", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/ClickStreamEntry", + "qualifiedName": "dw.web.ClickStreamEntry.userAgent", + "tags": [ + "useragent", + "clickstreamentry.useragent" + ], + "title": "ClickStreamEntry.userAgent" + }, + { + "id": "script-api:dw/web/Cookie", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.Cookie", + "tags": [ + "cookie", + "dw.web.cookie", + "dw/web" + ], + "title": "Cookie" + }, + { + "id": "script-api:dw/web/Cookie#EMPTYNAME", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.EMPTYNAME", + "tags": [ + "emptyname", + "cookie.emptyname" + ], + "title": "Cookie.EMPTYNAME" + }, + { + "id": "script-api:dw/web/Cookie#EMPTYNAME", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.EMPTYNAME", + "tags": [ + "emptyname", + "cookie.emptyname" + ], + "title": "Cookie.EMPTYNAME" + }, + { + "id": "script-api:dw/web/Cookie#comment", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.comment", + "tags": [ + "comment", + "cookie.comment" + ], + "title": "Cookie.comment" + }, + { + "id": "script-api:dw/web/Cookie#domain", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.domain", + "tags": [ + "domain", + "cookie.domain" + ], + "title": "Cookie.domain" + }, + { + "id": "script-api:dw/web/Cookie#getComment", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getComment", + "tags": [ + "getcomment", + "cookie.getcomment" + ], + "title": "Cookie.getComment" + }, + { + "id": "script-api:dw/web/Cookie#getDomain", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getDomain", + "tags": [ + "getdomain", + "cookie.getdomain" + ], + "title": "Cookie.getDomain" + }, + { + "id": "script-api:dw/web/Cookie#getMaxAge", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getMaxAge", + "tags": [ + "getmaxage", + "cookie.getmaxage" + ], + "title": "Cookie.getMaxAge" + }, + { + "id": "script-api:dw/web/Cookie#getName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getName", + "tags": [ + "getname", + "cookie.getname" + ], + "title": "Cookie.getName" + }, + { + "id": "script-api:dw/web/Cookie#getPath", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getPath", + "tags": [ + "getpath", + "cookie.getpath" + ], + "title": "Cookie.getPath" + }, + { + "id": "script-api:dw/web/Cookie#getSecure", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getSecure", + "tags": [ + "getsecure", + "cookie.getsecure" + ], + "title": "Cookie.getSecure" + }, + { + "id": "script-api:dw/web/Cookie#getValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getValue", + "tags": [ + "getvalue", + "cookie.getvalue" + ], + "title": "Cookie.getValue" + }, + { + "id": "script-api:dw/web/Cookie#getVersion", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.getVersion", + "tags": [ + "getversion", + "cookie.getversion" + ], + "title": "Cookie.getVersion" + }, + { + "id": "script-api:dw/web/Cookie#httpOnly", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.httpOnly", + "tags": [ + "httponly", + "cookie.httponly" + ], + "title": "Cookie.httpOnly" + }, + { + "id": "script-api:dw/web/Cookie#isHttpOnly", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.isHttpOnly", + "tags": [ + "ishttponly", + "cookie.ishttponly" + ], + "title": "Cookie.isHttpOnly" + }, + { + "id": "script-api:dw/web/Cookie#maxAge", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.maxAge", + "tags": [ + "maxage", + "cookie.maxage" + ], + "title": "Cookie.maxAge" + }, + { + "id": "script-api:dw/web/Cookie#name", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.name", + "tags": [ + "name", + "cookie.name" + ], + "title": "Cookie.name" + }, + { + "id": "script-api:dw/web/Cookie#path", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.path", + "tags": [ + "path", + "cookie.path" + ], + "title": "Cookie.path" + }, + { + "id": "script-api:dw/web/Cookie#secure", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.secure", + "tags": [ + "secure", + "cookie.secure" + ], + "title": "Cookie.secure" + }, + { + "id": "script-api:dw/web/Cookie#setComment", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setComment", + "tags": [ + "setcomment", + "cookie.setcomment" + ], + "title": "Cookie.setComment" + }, + { + "id": "script-api:dw/web/Cookie#setDomain", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setDomain", + "tags": [ + "setdomain", + "cookie.setdomain" + ], + "title": "Cookie.setDomain" + }, + { + "id": "script-api:dw/web/Cookie#setHttpOnly", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setHttpOnly", + "tags": [ + "sethttponly", + "cookie.sethttponly" + ], + "title": "Cookie.setHttpOnly" + }, + { + "id": "script-api:dw/web/Cookie#setMaxAge", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setMaxAge", + "tags": [ + "setmaxage", + "cookie.setmaxage" + ], + "title": "Cookie.setMaxAge" + }, + { + "id": "script-api:dw/web/Cookie#setPath", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setPath", + "tags": [ + "setpath", + "cookie.setpath" + ], + "title": "Cookie.setPath" + }, + { + "id": "script-api:dw/web/Cookie#setSecure", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setSecure", + "tags": [ + "setsecure", + "cookie.setsecure" + ], + "title": "Cookie.setSecure" + }, + { + "id": "script-api:dw/web/Cookie#setValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setValue", + "tags": [ + "setvalue", + "cookie.setvalue" + ], + "title": "Cookie.setValue" + }, + { + "id": "script-api:dw/web/Cookie#setVersion", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.setVersion", + "tags": [ + "setversion", + "cookie.setversion" + ], + "title": "Cookie.setVersion" + }, + { + "id": "script-api:dw/web/Cookie#value", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.value", + "tags": [ + "value", + "cookie.value" + ], + "title": "Cookie.value" + }, + { + "id": "script-api:dw/web/Cookie#version", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookie", + "qualifiedName": "dw.web.Cookie.version", + "tags": [ + "version", + "cookie.version" + ], + "title": "Cookie.version" + }, + { + "id": "script-api:dw/web/Cookies", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.Cookies", + "tags": [ + "cookies", + "dw.web.cookies", + "dw/web" + ], + "title": "Cookies" + }, + { + "id": "script-api:dw/web/Cookies#cookieCount", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookies", + "qualifiedName": "dw.web.Cookies.cookieCount", + "tags": [ + "cookiecount", + "cookies.cookiecount" + ], + "title": "Cookies.cookieCount" + }, + { + "id": "script-api:dw/web/Cookies#getCookieCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Cookies", + "qualifiedName": "dw.web.Cookies.getCookieCount", + "tags": [ + "getcookiecount", + "cookies.getcookiecount" + ], + "title": "Cookies.getCookieCount" + }, + { + "id": "script-api:dw/web/Form", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.Form", + "tags": [ + "form", + "dw.web.form", + "dw/web" + ], + "title": "Form" + }, + { + "id": "script-api:dw/web/Form#getSecureKeyHtmlName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Form", + "qualifiedName": "dw.web.Form.getSecureKeyHtmlName", + "tags": [ + "getsecurekeyhtmlname", + "form.getsecurekeyhtmlname" + ], + "title": "Form.getSecureKeyHtmlName" + }, + { + "id": "script-api:dw/web/Form#getSecureKeyValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Form", + "qualifiedName": "dw.web.Form.getSecureKeyValue", + "tags": [ + "getsecurekeyvalue", + "form.getsecurekeyvalue" + ], + "title": "Form.getSecureKeyValue" + }, + { + "id": "script-api:dw/web/Form#secureKeyHtmlName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Form", + "qualifiedName": "dw.web.Form.secureKeyHtmlName", + "tags": [ + "securekeyhtmlname", + "form.securekeyhtmlname" + ], + "title": "Form.secureKeyHtmlName" + }, + { + "id": "script-api:dw/web/Form#secureKeyValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Form", + "qualifiedName": "dw.web.Form.secureKeyValue", + "tags": [ + "securekeyvalue", + "form.securekeyvalue" + ], + "title": "Form.secureKeyValue" + }, + { + "id": "script-api:dw/web/FormAction", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormAction", + "tags": [ + "formaction", + "dw.web.formaction", + "dw/web" + ], + "title": "FormAction" + }, + { + "id": "script-api:dw/web/FormAction#description", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.description", + "tags": [ + "description", + "formaction.description" + ], + "title": "FormAction.description" + }, + { + "id": "script-api:dw/web/FormAction#getDescription", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.getDescription", + "tags": [ + "getdescription", + "formaction.getdescription" + ], + "title": "FormAction.getDescription" + }, + { + "id": "script-api:dw/web/FormAction#getLabel", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.getLabel", + "tags": [ + "getlabel", + "formaction.getlabel" + ], + "title": "FormAction.getLabel" + }, + { + "id": "script-api:dw/web/FormAction#getObject", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.getObject", + "tags": [ + "getobject", + "formaction.getobject" + ], + "title": "FormAction.getObject" + }, + { + "id": "script-api:dw/web/FormAction#getX", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.getX", + "tags": [ + "getx", + "formaction.getx" + ], + "title": "FormAction.getX" + }, + { + "id": "script-api:dw/web/FormAction#getY", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.getY", + "tags": [ + "gety", + "formaction.gety" + ], + "title": "FormAction.getY" + }, + { + "id": "script-api:dw/web/FormAction#isSubmitted", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.isSubmitted", + "tags": [ + "issubmitted", + "formaction.issubmitted" + ], + "title": "FormAction.isSubmitted" + }, + { + "id": "script-api:dw/web/FormAction#isTriggered", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.isTriggered", + "tags": [ + "istriggered", + "formaction.istriggered" + ], + "title": "FormAction.isTriggered" + }, + { + "id": "script-api:dw/web/FormAction#label", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.label", + "tags": [ + "label", + "formaction.label" + ], + "title": "FormAction.label" + }, + { + "id": "script-api:dw/web/FormAction#object", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.object", + "tags": [ + "object", + "formaction.object" + ], + "title": "FormAction.object" + }, + { + "id": "script-api:dw/web/FormAction#submitted", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.submitted", + "tags": [ + "submitted", + "formaction.submitted" + ], + "title": "FormAction.submitted" + }, + { + "id": "script-api:dw/web/FormAction#triggered", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.triggered", + "tags": [ + "triggered", + "formaction.triggered" + ], + "title": "FormAction.triggered" + }, + { + "id": "script-api:dw/web/FormAction#x", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.x", + "tags": [ + "x", + "formaction.x" + ], + "title": "FormAction.x" + }, + { + "id": "script-api:dw/web/FormAction#y", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormAction", + "qualifiedName": "dw.web.FormAction.y", + "tags": [ + "y", + "formaction.y" + ], + "title": "FormAction.y" + }, + { + "id": "script-api:dw/web/FormElement", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormElement", + "tags": [ + "formelement", + "dw.web.formelement", + "dw/web" + ], + "title": "FormElement" + }, + { + "id": "script-api:dw/web/FormElement#clearFormElement", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.clearFormElement", + "tags": [ + "clearformelement", + "formelement.clearformelement" + ], + "title": "FormElement.clearFormElement" + }, + { + "id": "script-api:dw/web/FormElement#dynamicHtmlName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.dynamicHtmlName", + "tags": [ + "dynamichtmlname", + "formelement.dynamichtmlname" + ], + "title": "FormElement.dynamicHtmlName" + }, + { + "id": "script-api:dw/web/FormElement#formId", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.formId", + "tags": [ + "formid", + "formelement.formid" + ], + "title": "FormElement.formId" + }, + { + "id": "script-api:dw/web/FormElement#getDynamicHtmlName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.getDynamicHtmlName", + "tags": [ + "getdynamichtmlname", + "formelement.getdynamichtmlname" + ], + "title": "FormElement.getDynamicHtmlName" + }, + { + "id": "script-api:dw/web/FormElement#getFormId", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.getFormId", + "tags": [ + "getformid", + "formelement.getformid" + ], + "title": "FormElement.getFormId" + }, + { + "id": "script-api:dw/web/FormElement#getHtmlName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.getHtmlName", + "tags": [ + "gethtmlname", + "formelement.gethtmlname" + ], + "title": "FormElement.getHtmlName" + }, + { + "id": "script-api:dw/web/FormElement#getParent", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.getParent", + "tags": [ + "getparent", + "formelement.getparent" + ], + "title": "FormElement.getParent" + }, + { + "id": "script-api:dw/web/FormElement#getValidationResult", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.getValidationResult", + "tags": [ + "getvalidationresult", + "formelement.getvalidationresult" + ], + "title": "FormElement.getValidationResult" + }, + { + "id": "script-api:dw/web/FormElement#htmlName", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.htmlName", + "tags": [ + "htmlname", + "formelement.htmlname" + ], + "title": "FormElement.htmlName" + }, + { + "id": "script-api:dw/web/FormElement#invalidateFormElement", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.invalidateFormElement", + "tags": [ + "invalidateformelement", + "formelement.invalidateformelement" + ], + "title": "FormElement.invalidateFormElement" + }, + { + "id": "script-api:dw/web/FormElement#invalidateFormElement", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.invalidateFormElement", + "tags": [ + "invalidateformelement", + "formelement.invalidateformelement" + ], + "title": "FormElement.invalidateFormElement" + }, + { + "id": "script-api:dw/web/FormElement#isValid", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.isValid", + "tags": [ + "isvalid", + "formelement.isvalid" + ], + "title": "FormElement.isValid" + }, + { + "id": "script-api:dw/web/FormElement#parent", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.parent", + "tags": [ + "parent", + "formelement.parent" + ], + "title": "FormElement.parent" + }, + { + "id": "script-api:dw/web/FormElement#valid", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.valid", + "tags": [ + "valid", + "formelement.valid" + ], + "title": "FormElement.valid" + }, + { + "id": "script-api:dw/web/FormElement#validationResult", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElement", + "qualifiedName": "dw.web.FormElement.validationResult", + "tags": [ + "validationresult", + "formelement.validationresult" + ], + "title": "FormElement.validationResult" + }, + { + "id": "script-api:dw/web/FormElementValidationResult", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormElementValidationResult", + "tags": [ + "formelementvalidationresult", + "dw.web.formelementvalidationresult", + "dw/web" + ], + "title": "FormElementValidationResult" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#addData", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.addData", + "tags": [ + "adddata", + "formelementvalidationresult.adddata" + ], + "title": "FormElementValidationResult.addData" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#data", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.data", + "tags": [ + "data", + "formelementvalidationresult.data" + ], + "title": "FormElementValidationResult.data" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#getData", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.getData", + "tags": [ + "getdata", + "formelementvalidationresult.getdata" + ], + "title": "FormElementValidationResult.getData" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#getMessage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.getMessage", + "tags": [ + "getmessage", + "formelementvalidationresult.getmessage" + ], + "title": "FormElementValidationResult.getMessage" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#isValid", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.isValid", + "tags": [ + "isvalid", + "formelementvalidationresult.isvalid" + ], + "title": "FormElementValidationResult.isValid" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#message", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.message", + "tags": [ + "message", + "formelementvalidationresult.message" + ], + "title": "FormElementValidationResult.message" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#setMessage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.setMessage", + "tags": [ + "setmessage", + "formelementvalidationresult.setmessage" + ], + "title": "FormElementValidationResult.setMessage" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#setValid", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.setValid", + "tags": [ + "setvalid", + "formelementvalidationresult.setvalid" + ], + "title": "FormElementValidationResult.setValid" + }, + { + "id": "script-api:dw/web/FormElementValidationResult#valid", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormElementValidationResult", + "qualifiedName": "dw.web.FormElementValidationResult.valid", + "tags": [ + "valid", + "formelementvalidationresult.valid" + ], + "title": "FormElementValidationResult.valid" + }, + { + "id": "script-api:dw/web/FormField", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormField", + "tags": [ + "formfield", + "dw.web.formfield", + "dw/web" + ], + "title": "FormField" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_BOOLEAN", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_BOOLEAN", + "tags": [ + "field_type_boolean", + "formfield.field_type_boolean" + ], + "title": "FormField.FIELD_TYPE_BOOLEAN" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_BOOLEAN", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_BOOLEAN", + "tags": [ + "field_type_boolean", + "formfield.field_type_boolean" + ], + "title": "FormField.FIELD_TYPE_BOOLEAN" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_DATE", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_DATE", + "tags": [ + "field_type_date", + "formfield.field_type_date" + ], + "title": "FormField.FIELD_TYPE_DATE" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_DATE", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_DATE", + "tags": [ + "field_type_date", + "formfield.field_type_date" + ], + "title": "FormField.FIELD_TYPE_DATE" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_INTEGER", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_INTEGER", + "tags": [ + "field_type_integer", + "formfield.field_type_integer" + ], + "title": "FormField.FIELD_TYPE_INTEGER" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_INTEGER", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_INTEGER", + "tags": [ + "field_type_integer", + "formfield.field_type_integer" + ], + "title": "FormField.FIELD_TYPE_INTEGER" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_NUMBER", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_NUMBER", + "tags": [ + "field_type_number", + "formfield.field_type_number" + ], + "title": "FormField.FIELD_TYPE_NUMBER" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_NUMBER", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_NUMBER", + "tags": [ + "field_type_number", + "formfield.field_type_number" + ], + "title": "FormField.FIELD_TYPE_NUMBER" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_STRING", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_STRING", + "tags": [ + "field_type_string", + "formfield.field_type_string" + ], + "title": "FormField.FIELD_TYPE_STRING" + }, + { + "id": "script-api:dw/web/FormField#FIELD_TYPE_STRING", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.FIELD_TYPE_STRING", + "tags": [ + "field_type_string", + "formfield.field_type_string" + ], + "title": "FormField.FIELD_TYPE_STRING" + }, + { + "id": "script-api:dw/web/FormField#checked", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.checked", + "tags": [ + "checked", + "formfield.checked" + ], + "title": "FormField.checked" + }, + { + "id": "script-api:dw/web/FormField#description", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.description", + "tags": [ + "description", + "formfield.description" + ], + "title": "FormField.description" + }, + { + "id": "script-api:dw/web/FormField#error", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.error", + "tags": [ + "error", + "formfield.error" + ], + "title": "FormField.error" + }, + { + "id": "script-api:dw/web/FormField#getDescription", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getDescription", + "tags": [ + "getdescription", + "formfield.getdescription" + ], + "title": "FormField.getDescription" + }, + { + "id": "script-api:dw/web/FormField#getError", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getError", + "tags": [ + "geterror", + "formfield.geterror" + ], + "title": "FormField.getError" + }, + { + "id": "script-api:dw/web/FormField#getHtmlValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getHtmlValue", + "tags": [ + "gethtmlvalue", + "formfield.gethtmlvalue" + ], + "title": "FormField.getHtmlValue" + }, + { + "id": "script-api:dw/web/FormField#getLabel", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getLabel", + "tags": [ + "getlabel", + "formfield.getlabel" + ], + "title": "FormField.getLabel" + }, + { + "id": "script-api:dw/web/FormField#getMaxLength", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getMaxLength", + "tags": [ + "getmaxlength", + "formfield.getmaxlength" + ], + "title": "FormField.getMaxLength" + }, + { + "id": "script-api:dw/web/FormField#getMaxValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getMaxValue", + "tags": [ + "getmaxvalue", + "formfield.getmaxvalue" + ], + "title": "FormField.getMaxValue" + }, + { + "id": "script-api:dw/web/FormField#getMinLength", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getMinLength", + "tags": [ + "getminlength", + "formfield.getminlength" + ], + "title": "FormField.getMinLength" + }, + { + "id": "script-api:dw/web/FormField#getMinValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getMinValue", + "tags": [ + "getminvalue", + "formfield.getminvalue" + ], + "title": "FormField.getMinValue" + }, + { + "id": "script-api:dw/web/FormField#getOptions", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getOptions", + "tags": [ + "getoptions", + "formfield.getoptions" + ], + "title": "FormField.getOptions" + }, + { + "id": "script-api:dw/web/FormField#getRegEx", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getRegEx", + "tags": [ + "getregex", + "formfield.getregex" + ], + "title": "FormField.getRegEx" + }, + { + "id": "script-api:dw/web/FormField#getSelectedOption", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getSelectedOption", + "tags": [ + "getselectedoption", + "formfield.getselectedoption" + ], + "title": "FormField.getSelectedOption" + }, + { + "id": "script-api:dw/web/FormField#getSelectedOptionObject", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getSelectedOptionObject", + "tags": [ + "getselectedoptionobject", + "formfield.getselectedoptionobject" + ], + "title": "FormField.getSelectedOptionObject" + }, + { + "id": "script-api:dw/web/FormField#getType", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getType", + "tags": [ + "gettype", + "formfield.gettype" + ], + "title": "FormField.getType" + }, + { + "id": "script-api:dw/web/FormField#getValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.getValue", + "tags": [ + "getvalue", + "formfield.getvalue" + ], + "title": "FormField.getValue" + }, + { + "id": "script-api:dw/web/FormField#htmlValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.htmlValue", + "tags": [ + "htmlvalue", + "formfield.htmlvalue" + ], + "title": "FormField.htmlValue" + }, + { + "id": "script-api:dw/web/FormField#isChecked", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.isChecked", + "tags": [ + "ischecked", + "formfield.ischecked" + ], + "title": "FormField.isChecked" + }, + { + "id": "script-api:dw/web/FormField#isMandatory", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.isMandatory", + "tags": [ + "ismandatory", + "formfield.ismandatory" + ], + "title": "FormField.isMandatory" + }, + { + "id": "script-api:dw/web/FormField#isSelected", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.isSelected", + "tags": [ + "isselected", + "formfield.isselected" + ], + "title": "FormField.isSelected" + }, + { + "id": "script-api:dw/web/FormField#label", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.label", + "tags": [ + "label", + "formfield.label" + ], + "title": "FormField.label" + }, + { + "id": "script-api:dw/web/FormField#mandatory", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.mandatory", + "tags": [ + "mandatory", + "formfield.mandatory" + ], + "title": "FormField.mandatory" + }, + { + "id": "script-api:dw/web/FormField#maxLength", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.maxLength", + "tags": [ + "maxlength", + "formfield.maxlength" + ], + "title": "FormField.maxLength" + }, + { + "id": "script-api:dw/web/FormField#maxValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.maxValue", + "tags": [ + "maxvalue", + "formfield.maxvalue" + ], + "title": "FormField.maxValue" + }, + { + "id": "script-api:dw/web/FormField#minLength", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.minLength", + "tags": [ + "minlength", + "formfield.minlength" + ], + "title": "FormField.minLength" + }, + { + "id": "script-api:dw/web/FormField#minValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.minValue", + "tags": [ + "minvalue", + "formfield.minvalue" + ], + "title": "FormField.minValue" + }, + { + "id": "script-api:dw/web/FormField#options", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.options", + "tags": [ + "options", + "formfield.options" + ], + "title": "FormField.options" + }, + { + "id": "script-api:dw/web/FormField#regEx", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.regEx", + "tags": [ + "regex", + "formfield.regex" + ], + "title": "FormField.regEx" + }, + { + "id": "script-api:dw/web/FormField#selected", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.selected", + "tags": [ + "selected", + "formfield.selected" + ], + "title": "FormField.selected" + }, + { + "id": "script-api:dw/web/FormField#selectedOption", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.selectedOption", + "tags": [ + "selectedoption", + "formfield.selectedoption" + ], + "title": "FormField.selectedOption" + }, + { + "id": "script-api:dw/web/FormField#selectedOptionObject", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.selectedOptionObject", + "tags": [ + "selectedoptionobject", + "formfield.selectedoptionobject" + ], + "title": "FormField.selectedOptionObject" + }, + { + "id": "script-api:dw/web/FormField#setHtmlValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setHtmlValue", + "tags": [ + "sethtmlvalue", + "formfield.sethtmlvalue" + ], + "title": "FormField.setHtmlValue" + }, + { + "id": "script-api:dw/web/FormField#setOptions", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setOptions", + "tags": [ + "setoptions", + "formfield.setoptions" + ], + "title": "FormField.setOptions" + }, + { + "id": "script-api:dw/web/FormField#setOptions", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setOptions", + "tags": [ + "setoptions", + "formfield.setoptions" + ], + "title": "FormField.setOptions" + }, + { + "id": "script-api:dw/web/FormField#setOptions", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setOptions", + "tags": [ + "setoptions", + "formfield.setoptions" + ], + "title": "FormField.setOptions" + }, + { + "id": "script-api:dw/web/FormField#setOptions", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setOptions", + "tags": [ + "setoptions", + "formfield.setoptions" + ], + "title": "FormField.setOptions" + }, + { + "id": "script-api:dw/web/FormField#setValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.setValue", + "tags": [ + "setvalue", + "formfield.setvalue" + ], + "title": "FormField.setValue" + }, + { + "id": "script-api:dw/web/FormField#type", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.type", + "tags": [ + "type", + "formfield.type" + ], + "title": "FormField.type" + }, + { + "id": "script-api:dw/web/FormField#value", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormField", + "qualifiedName": "dw.web.FormField.value", + "tags": [ + "value", + "formfield.value" + ], + "title": "FormField.value" + }, + { + "id": "script-api:dw/web/FormFieldOption", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormFieldOption", + "tags": [ + "formfieldoption", + "dw.web.formfieldoption", + "dw/web" + ], + "title": "FormFieldOption" + }, + { + "id": "script-api:dw/web/FormFieldOption#checked", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.checked", + "tags": [ + "checked", + "formfieldoption.checked" + ], + "title": "FormFieldOption.checked" + }, + { + "id": "script-api:dw/web/FormFieldOption#getHtmlValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getHtmlValue", + "tags": [ + "gethtmlvalue", + "formfieldoption.gethtmlvalue" + ], + "title": "FormFieldOption.getHtmlValue" + }, + { + "id": "script-api:dw/web/FormFieldOption#getLabel", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getLabel", + "tags": [ + "getlabel", + "formfieldoption.getlabel" + ], + "title": "FormFieldOption.getLabel" + }, + { + "id": "script-api:dw/web/FormFieldOption#getObject", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getObject", + "tags": [ + "getobject", + "formfieldoption.getobject" + ], + "title": "FormFieldOption.getObject" + }, + { + "id": "script-api:dw/web/FormFieldOption#getOptionId", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getOptionId", + "tags": [ + "getoptionid", + "formfieldoption.getoptionid" + ], + "title": "FormFieldOption.getOptionId" + }, + { + "id": "script-api:dw/web/FormFieldOption#getParent", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getParent", + "tags": [ + "getparent", + "formfieldoption.getparent" + ], + "title": "FormFieldOption.getParent" + }, + { + "id": "script-api:dw/web/FormFieldOption#getValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.getValue", + "tags": [ + "getvalue", + "formfieldoption.getvalue" + ], + "title": "FormFieldOption.getValue" + }, + { + "id": "script-api:dw/web/FormFieldOption#htmlValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.htmlValue", + "tags": [ + "htmlvalue", + "formfieldoption.htmlvalue" + ], + "title": "FormFieldOption.htmlValue" + }, + { + "id": "script-api:dw/web/FormFieldOption#isChecked", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.isChecked", + "tags": [ + "ischecked", + "formfieldoption.ischecked" + ], + "title": "FormFieldOption.isChecked" + }, + { + "id": "script-api:dw/web/FormFieldOption#isSelected", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.isSelected", + "tags": [ + "isselected", + "formfieldoption.isselected" + ], + "title": "FormFieldOption.isSelected" + }, + { + "id": "script-api:dw/web/FormFieldOption#label", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.label", + "tags": [ + "label", + "formfieldoption.label" + ], + "title": "FormFieldOption.label" + }, + { + "id": "script-api:dw/web/FormFieldOption#object", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.object", + "tags": [ + "object", + "formfieldoption.object" + ], + "title": "FormFieldOption.object" + }, + { + "id": "script-api:dw/web/FormFieldOption#optionId", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.optionId", + "tags": [ + "optionid", + "formfieldoption.optionid" + ], + "title": "FormFieldOption.optionId" + }, + { + "id": "script-api:dw/web/FormFieldOption#parent", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.parent", + "tags": [ + "parent", + "formfieldoption.parent" + ], + "title": "FormFieldOption.parent" + }, + { + "id": "script-api:dw/web/FormFieldOption#selected", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.selected", + "tags": [ + "selected", + "formfieldoption.selected" + ], + "title": "FormFieldOption.selected" + }, + { + "id": "script-api:dw/web/FormFieldOption#setLabel", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.setLabel", + "tags": [ + "setlabel", + "formfieldoption.setlabel" + ], + "title": "FormFieldOption.setLabel" + }, + { + "id": "script-api:dw/web/FormFieldOption#value", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOption", + "qualifiedName": "dw.web.FormFieldOption.value", + "tags": [ + "value", + "formfieldoption.value" + ], + "title": "FormFieldOption.value" + }, + { + "id": "script-api:dw/web/FormFieldOptions", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormFieldOptions", + "tags": [ + "formfieldoptions", + "dw.web.formfieldoptions", + "dw/web" + ], + "title": "FormFieldOptions" + }, + { + "id": "script-api:dw/web/FormFieldOptions#getOptionsCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOptions", + "qualifiedName": "dw.web.FormFieldOptions.getOptionsCount", + "tags": [ + "getoptionscount", + "formfieldoptions.getoptionscount" + ], + "title": "FormFieldOptions.getOptionsCount" + }, + { + "id": "script-api:dw/web/FormFieldOptions#optionsCount", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormFieldOptions", + "qualifiedName": "dw.web.FormFieldOptions.optionsCount", + "tags": [ + "optionscount", + "formfieldoptions.optionscount" + ], + "title": "FormFieldOptions.optionsCount" + }, + { + "id": "script-api:dw/web/FormGroup", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormGroup", + "tags": [ + "formgroup", + "dw.web.formgroup", + "dw/web" + ], + "title": "FormGroup" + }, + { + "id": "script-api:dw/web/FormGroup#accept", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.accept", + "tags": [ + "accept", + "formgroup.accept" + ], + "title": "FormGroup.accept" + }, + { + "id": "script-api:dw/web/FormGroup#childCount", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.childCount", + "tags": [ + "childcount", + "formgroup.childcount" + ], + "title": "FormGroup.childCount" + }, + { + "id": "script-api:dw/web/FormGroup#copyFrom", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.copyFrom", + "tags": [ + "copyfrom", + "formgroup.copyfrom" + ], + "title": "FormGroup.copyFrom" + }, + { + "id": "script-api:dw/web/FormGroup#copyTo", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.copyTo", + "tags": [ + "copyto", + "formgroup.copyto" + ], + "title": "FormGroup.copyTo" + }, + { + "id": "script-api:dw/web/FormGroup#error", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.error", + "tags": [ + "error", + "formgroup.error" + ], + "title": "FormGroup.error" + }, + { + "id": "script-api:dw/web/FormGroup#getChildCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.getChildCount", + "tags": [ + "getchildcount", + "formgroup.getchildcount" + ], + "title": "FormGroup.getChildCount" + }, + { + "id": "script-api:dw/web/FormGroup#getError", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.getError", + "tags": [ + "geterror", + "formgroup.geterror" + ], + "title": "FormGroup.getError" + }, + { + "id": "script-api:dw/web/FormGroup#getObject", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.getObject", + "tags": [ + "getobject", + "formgroup.getobject" + ], + "title": "FormGroup.getObject" + }, + { + "id": "script-api:dw/web/FormGroup#getSubmittedAction", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.getSubmittedAction", + "tags": [ + "getsubmittedaction", + "formgroup.getsubmittedaction" + ], + "title": "FormGroup.getSubmittedAction" + }, + { + "id": "script-api:dw/web/FormGroup#getTriggeredAction", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.getTriggeredAction", + "tags": [ + "gettriggeredaction", + "formgroup.gettriggeredaction" + ], + "title": "FormGroup.getTriggeredAction" + }, + { + "id": "script-api:dw/web/FormGroup#object", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.object", + "tags": [ + "object", + "formgroup.object" + ], + "title": "FormGroup.object" + }, + { + "id": "script-api:dw/web/FormGroup#submittedAction", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.submittedAction", + "tags": [ + "submittedaction", + "formgroup.submittedaction" + ], + "title": "FormGroup.submittedAction" + }, + { + "id": "script-api:dw/web/FormGroup#triggeredAction", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormGroup", + "qualifiedName": "dw.web.FormGroup.triggeredAction", + "tags": [ + "triggeredaction", + "formgroup.triggeredaction" + ], + "title": "FormGroup.triggeredAction" + }, + { + "id": "script-api:dw/web/FormList", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormList", + "tags": [ + "formlist", + "dw.web.formlist", + "dw/web" + ], + "title": "FormList" + }, + { + "id": "script-api:dw/web/FormList#getSelectManyItems", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.getSelectManyItems", + "tags": [ + "getselectmanyitems", + "formlist.getselectmanyitems" + ], + "title": "FormList.getSelectManyItems" + }, + { + "id": "script-api:dw/web/FormList#getSelectManyObjects", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.getSelectManyObjects", + "tags": [ + "getselectmanyobjects", + "formlist.getselectmanyobjects" + ], + "title": "FormList.getSelectManyObjects" + }, + { + "id": "script-api:dw/web/FormList#getSelectOneItem", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.getSelectOneItem", + "tags": [ + "getselectoneitem", + "formlist.getselectoneitem" + ], + "title": "FormList.getSelectOneItem" + }, + { + "id": "script-api:dw/web/FormList#getSelectOneObject", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.getSelectOneObject", + "tags": [ + "getselectoneobject", + "formlist.getselectoneobject" + ], + "title": "FormList.getSelectOneObject" + }, + { + "id": "script-api:dw/web/FormList#selectManyItems", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.selectManyItems", + "tags": [ + "selectmanyitems", + "formlist.selectmanyitems" + ], + "title": "FormList.selectManyItems" + }, + { + "id": "script-api:dw/web/FormList#selectManyObjects", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.selectManyObjects", + "tags": [ + "selectmanyobjects", + "formlist.selectmanyobjects" + ], + "title": "FormList.selectManyObjects" + }, + { + "id": "script-api:dw/web/FormList#selectOneItem", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.selectOneItem", + "tags": [ + "selectoneitem", + "formlist.selectoneitem" + ], + "title": "FormList.selectOneItem" + }, + { + "id": "script-api:dw/web/FormList#selectOneObject", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormList", + "qualifiedName": "dw.web.FormList.selectOneObject", + "tags": [ + "selectoneobject", + "formlist.selectoneobject" + ], + "title": "FormList.selectOneObject" + }, + { + "id": "script-api:dw/web/FormListItem", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.FormListItem", + "tags": [ + "formlistitem", + "dw.web.formlistitem", + "dw/web" + ], + "title": "FormListItem" + }, + { + "id": "script-api:dw/web/FormListItem#getItemIndex", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormListItem", + "qualifiedName": "dw.web.FormListItem.getItemIndex", + "tags": [ + "getitemindex", + "formlistitem.getitemindex" + ], + "title": "FormListItem.getItemIndex" + }, + { + "id": "script-api:dw/web/FormListItem#itemIndex", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/FormListItem", + "qualifiedName": "dw.web.FormListItem.itemIndex", + "tags": [ + "itemindex", + "formlistitem.itemindex" + ], + "title": "FormListItem.itemIndex" + }, + { + "id": "script-api:dw/web/Forms", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.Forms", + "tags": [ + "forms", + "dw.web.forms", + "dw/web" + ], + "title": "Forms" + }, + { + "id": "script-api:dw/web/HttpParameter", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.HttpParameter", + "tags": [ + "httpparameter", + "dw.web.httpparameter", + "dw/web" + ], + "title": "HttpParameter" + }, + { + "id": "script-api:dw/web/HttpParameter#booleanValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.booleanValue", + "tags": [ + "booleanvalue", + "httpparameter.booleanvalue" + ], + "title": "HttpParameter.booleanValue" + }, + { + "id": "script-api:dw/web/HttpParameter#containsStringValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.containsStringValue", + "tags": [ + "containsstringvalue", + "httpparameter.containsstringvalue" + ], + "title": "HttpParameter.containsStringValue" + }, + { + "id": "script-api:dw/web/HttpParameter#dateValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.dateValue", + "tags": [ + "datevalue", + "httpparameter.datevalue" + ], + "title": "HttpParameter.dateValue" + }, + { + "id": "script-api:dw/web/HttpParameter#doubleValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.doubleValue", + "tags": [ + "doublevalue", + "httpparameter.doublevalue" + ], + "title": "HttpParameter.doubleValue" + }, + { + "id": "script-api:dw/web/HttpParameter#empty", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.empty", + "tags": [ + "empty", + "httpparameter.empty" + ], + "title": "HttpParameter.empty" + }, + { + "id": "script-api:dw/web/HttpParameter#getBooleanValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getBooleanValue", + "tags": [ + "getbooleanvalue", + "httpparameter.getbooleanvalue" + ], + "title": "HttpParameter.getBooleanValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getBooleanValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getBooleanValue", + "tags": [ + "getbooleanvalue", + "httpparameter.getbooleanvalue" + ], + "title": "HttpParameter.getBooleanValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getDateValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getDateValue", + "tags": [ + "getdatevalue", + "httpparameter.getdatevalue" + ], + "title": "HttpParameter.getDateValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getDateValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getDateValue", + "tags": [ + "getdatevalue", + "httpparameter.getdatevalue" + ], + "title": "HttpParameter.getDateValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getDoubleValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getDoubleValue", + "tags": [ + "getdoublevalue", + "httpparameter.getdoublevalue" + ], + "title": "HttpParameter.getDoubleValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getDoubleValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getDoubleValue", + "tags": [ + "getdoublevalue", + "httpparameter.getdoublevalue" + ], + "title": "HttpParameter.getDoubleValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getIntValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getIntValue", + "tags": [ + "getintvalue", + "httpparameter.getintvalue" + ], + "title": "HttpParameter.getIntValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getIntValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getIntValue", + "tags": [ + "getintvalue", + "httpparameter.getintvalue" + ], + "title": "HttpParameter.getIntValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getRawValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getRawValue", + "tags": [ + "getrawvalue", + "httpparameter.getrawvalue" + ], + "title": "HttpParameter.getRawValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getRawValues", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getRawValues", + "tags": [ + "getrawvalues", + "httpparameter.getrawvalues" + ], + "title": "HttpParameter.getRawValues" + }, + { + "id": "script-api:dw/web/HttpParameter#getStringValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getStringValue", + "tags": [ + "getstringvalue", + "httpparameter.getstringvalue" + ], + "title": "HttpParameter.getStringValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getStringValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getStringValue", + "tags": [ + "getstringvalue", + "httpparameter.getstringvalue" + ], + "title": "HttpParameter.getStringValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getStringValues", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getStringValues", + "tags": [ + "getstringvalues", + "httpparameter.getstringvalues" + ], + "title": "HttpParameter.getStringValues" + }, + { + "id": "script-api:dw/web/HttpParameter#getValue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getValue", + "tags": [ + "getvalue", + "httpparameter.getvalue" + ], + "title": "HttpParameter.getValue" + }, + { + "id": "script-api:dw/web/HttpParameter#getValues", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.getValues", + "tags": [ + "getvalues", + "httpparameter.getvalues" + ], + "title": "HttpParameter.getValues" + }, + { + "id": "script-api:dw/web/HttpParameter#intValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.intValue", + "tags": [ + "intvalue", + "httpparameter.intvalue" + ], + "title": "HttpParameter.intValue" + }, + { + "id": "script-api:dw/web/HttpParameter#isChecked", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.isChecked", + "tags": [ + "ischecked", + "httpparameter.ischecked" + ], + "title": "HttpParameter.isChecked" + }, + { + "id": "script-api:dw/web/HttpParameter#isEmpty", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.isEmpty", + "tags": [ + "isempty", + "httpparameter.isempty" + ], + "title": "HttpParameter.isEmpty" + }, + { + "id": "script-api:dw/web/HttpParameter#isSubmitted", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.isSubmitted", + "tags": [ + "issubmitted", + "httpparameter.issubmitted" + ], + "title": "HttpParameter.isSubmitted" + }, + { + "id": "script-api:dw/web/HttpParameter#rawValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.rawValue", + "tags": [ + "rawvalue", + "httpparameter.rawvalue" + ], + "title": "HttpParameter.rawValue" + }, + { + "id": "script-api:dw/web/HttpParameter#rawValues", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.rawValues", + "tags": [ + "rawvalues", + "httpparameter.rawvalues" + ], + "title": "HttpParameter.rawValues" + }, + { + "id": "script-api:dw/web/HttpParameter#stringValue", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.stringValue", + "tags": [ + "stringvalue", + "httpparameter.stringvalue" + ], + "title": "HttpParameter.stringValue" + }, + { + "id": "script-api:dw/web/HttpParameter#stringValues", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.stringValues", + "tags": [ + "stringvalues", + "httpparameter.stringvalues" + ], + "title": "HttpParameter.stringValues" + }, + { + "id": "script-api:dw/web/HttpParameter#submitted", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.submitted", + "tags": [ + "submitted", + "httpparameter.submitted" + ], + "title": "HttpParameter.submitted" + }, + { + "id": "script-api:dw/web/HttpParameter#toString", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.toString", + "tags": [ + "tostring", + "httpparameter.tostring" + ], + "title": "HttpParameter.toString" + }, + { + "id": "script-api:dw/web/HttpParameter#value", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.value", + "tags": [ + "value", + "httpparameter.value" + ], + "title": "HttpParameter.value" + }, + { + "id": "script-api:dw/web/HttpParameter#values", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameter", + "qualifiedName": "dw.web.HttpParameter.values", + "tags": [ + "values", + "httpparameter.values" + ], + "title": "HttpParameter.values" + }, + { + "id": "script-api:dw/web/HttpParameterMap", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.HttpParameterMap", + "tags": [ + "httpparametermap", + "dw.web.httpparametermap", + "dw/web" + ], + "title": "HttpParameterMap" + }, + { + "id": "script-api:dw/web/HttpParameterMap#get", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.get", + "tags": [ + "get", + "httpparametermap.get" + ], + "title": "HttpParameterMap.get" + }, + { + "id": "script-api:dw/web/HttpParameterMap#getParameterCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.getParameterCount", + "tags": [ + "getparametercount", + "httpparametermap.getparametercount" + ], + "title": "HttpParameterMap.getParameterCount" + }, + { + "id": "script-api:dw/web/HttpParameterMap#getParameterMap", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.getParameterMap", + "tags": [ + "getparametermap", + "httpparametermap.getparametermap" + ], + "title": "HttpParameterMap.getParameterMap" + }, + { + "id": "script-api:dw/web/HttpParameterMap#getParameterNames", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.getParameterNames", + "tags": [ + "getparameternames", + "httpparametermap.getparameternames" + ], + "title": "HttpParameterMap.getParameterNames" + }, + { + "id": "script-api:dw/web/HttpParameterMap#getRequestBodyAsString", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.getRequestBodyAsString", + "tags": [ + "getrequestbodyasstring", + "httpparametermap.getrequestbodyasstring" + ], + "title": "HttpParameterMap.getRequestBodyAsString" + }, + { + "id": "script-api:dw/web/HttpParameterMap#isParameterSubmitted", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.isParameterSubmitted", + "tags": [ + "isparametersubmitted", + "httpparametermap.isparametersubmitted" + ], + "title": "HttpParameterMap.isParameterSubmitted" + }, + { + "id": "script-api:dw/web/HttpParameterMap#parameterCount", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.parameterCount", + "tags": [ + "parametercount", + "httpparametermap.parametercount" + ], + "title": "HttpParameterMap.parameterCount" + }, + { + "id": "script-api:dw/web/HttpParameterMap#parameterNames", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.parameterNames", + "tags": [ + "parameternames", + "httpparametermap.parameternames" + ], + "title": "HttpParameterMap.parameterNames" + }, + { + "id": "script-api:dw/web/HttpParameterMap#processMultipart", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.processMultipart", + "tags": [ + "processmultipart", + "httpparametermap.processmultipart" + ], + "title": "HttpParameterMap.processMultipart" + }, + { + "id": "script-api:dw/web/HttpParameterMap#requestBodyAsString", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/HttpParameterMap", + "qualifiedName": "dw.web.HttpParameterMap.requestBodyAsString", + "tags": [ + "requestbodyasstring", + "httpparametermap.requestbodyasstring" + ], + "title": "HttpParameterMap.requestBodyAsString" + }, + { + "id": "script-api:dw/web/LoopIterator", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.LoopIterator", + "tags": [ + "loopiterator", + "dw.web.loopiterator", + "dw/web" + ], + "title": "LoopIterator" + }, + { + "id": "script-api:dw/web/LoopIterator#begin", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.begin", + "tags": [ + "begin", + "loopiterator.begin" + ], + "title": "LoopIterator.begin" + }, + { + "id": "script-api:dw/web/LoopIterator#count", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.count", + "tags": [ + "count", + "loopiterator.count" + ], + "title": "LoopIterator.count" + }, + { + "id": "script-api:dw/web/LoopIterator#end", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.end", + "tags": [ + "end", + "loopiterator.end" + ], + "title": "LoopIterator.end" + }, + { + "id": "script-api:dw/web/LoopIterator#even", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.even", + "tags": [ + "even", + "loopiterator.even" + ], + "title": "LoopIterator.even" + }, + { + "id": "script-api:dw/web/LoopIterator#first", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.first", + "tags": [ + "first", + "loopiterator.first" + ], + "title": "LoopIterator.first" + }, + { + "id": "script-api:dw/web/LoopIterator#getBegin", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getBegin", + "tags": [ + "getbegin", + "loopiterator.getbegin" + ], + "title": "LoopIterator.getBegin" + }, + { + "id": "script-api:dw/web/LoopIterator#getCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getCount", + "tags": [ + "getcount", + "loopiterator.getcount" + ], + "title": "LoopIterator.getCount" + }, + { + "id": "script-api:dw/web/LoopIterator#getEnd", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getEnd", + "tags": [ + "getend", + "loopiterator.getend" + ], + "title": "LoopIterator.getEnd" + }, + { + "id": "script-api:dw/web/LoopIterator#getIndex", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getIndex", + "tags": [ + "getindex", + "loopiterator.getindex" + ], + "title": "LoopIterator.getIndex" + }, + { + "id": "script-api:dw/web/LoopIterator#getLength", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getLength", + "tags": [ + "getlength", + "loopiterator.getlength" + ], + "title": "LoopIterator.getLength" + }, + { + "id": "script-api:dw/web/LoopIterator#getStep", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.getStep", + "tags": [ + "getstep", + "loopiterator.getstep" + ], + "title": "LoopIterator.getStep" + }, + { + "id": "script-api:dw/web/LoopIterator#index", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.index", + "tags": [ + "index", + "loopiterator.index" + ], + "title": "LoopIterator.index" + }, + { + "id": "script-api:dw/web/LoopIterator#isEven", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.isEven", + "tags": [ + "iseven", + "loopiterator.iseven" + ], + "title": "LoopIterator.isEven" + }, + { + "id": "script-api:dw/web/LoopIterator#isFirst", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.isFirst", + "tags": [ + "isfirst", + "loopiterator.isfirst" + ], + "title": "LoopIterator.isFirst" + }, + { + "id": "script-api:dw/web/LoopIterator#isLast", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.isLast", + "tags": [ + "islast", + "loopiterator.islast" + ], + "title": "LoopIterator.isLast" + }, + { + "id": "script-api:dw/web/LoopIterator#isOdd", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.isOdd", + "tags": [ + "isodd", + "loopiterator.isodd" + ], + "title": "LoopIterator.isOdd" + }, + { + "id": "script-api:dw/web/LoopIterator#last", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.last", + "tags": [ + "last", + "loopiterator.last" + ], + "title": "LoopIterator.last" + }, + { + "id": "script-api:dw/web/LoopIterator#length", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.length", + "tags": [ + "length", + "loopiterator.length" + ], + "title": "LoopIterator.length" + }, + { + "id": "script-api:dw/web/LoopIterator#odd", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.odd", + "tags": [ + "odd", + "loopiterator.odd" + ], + "title": "LoopIterator.odd" + }, + { + "id": "script-api:dw/web/LoopIterator#step", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/LoopIterator", + "qualifiedName": "dw.web.LoopIterator.step", + "tags": [ + "step", + "loopiterator.step" + ], + "title": "LoopIterator.step" + }, + { + "id": "script-api:dw/web/PageMetaData", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.PageMetaData", + "tags": [ + "pagemetadata", + "dw.web.pagemetadata", + "dw/web" + ], + "title": "PageMetaData" + }, + { + "id": "script-api:dw/web/PageMetaData#addPageMetaTag", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.addPageMetaTag", + "tags": [ + "addpagemetatag", + "pagemetadata.addpagemetatag" + ], + "title": "PageMetaData.addPageMetaTag" + }, + { + "id": "script-api:dw/web/PageMetaData#addPageMetaTags", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.addPageMetaTags", + "tags": [ + "addpagemetatags", + "pagemetadata.addpagemetatags" + ], + "title": "PageMetaData.addPageMetaTags" + }, + { + "id": "script-api:dw/web/PageMetaData#description", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.description", + "tags": [ + "description", + "pagemetadata.description" + ], + "title": "PageMetaData.description" + }, + { + "id": "script-api:dw/web/PageMetaData#getDescription", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.getDescription", + "tags": [ + "getdescription", + "pagemetadata.getdescription" + ], + "title": "PageMetaData.getDescription" + }, + { + "id": "script-api:dw/web/PageMetaData#getKeywords", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.getKeywords", + "tags": [ + "getkeywords", + "pagemetadata.getkeywords" + ], + "title": "PageMetaData.getKeywords" + }, + { + "id": "script-api:dw/web/PageMetaData#getPageMetaTags", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.getPageMetaTags", + "tags": [ + "getpagemetatags", + "pagemetadata.getpagemetatags" + ], + "title": "PageMetaData.getPageMetaTags" + }, + { + "id": "script-api:dw/web/PageMetaData#getTitle", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.getTitle", + "tags": [ + "gettitle", + "pagemetadata.gettitle" + ], + "title": "PageMetaData.getTitle" + }, + { + "id": "script-api:dw/web/PageMetaData#isPageMetaTagSet", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.isPageMetaTagSet", + "tags": [ + "ispagemetatagset", + "pagemetadata.ispagemetatagset" + ], + "title": "PageMetaData.isPageMetaTagSet" + }, + { + "id": "script-api:dw/web/PageMetaData#keywords", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.keywords", + "tags": [ + "keywords", + "pagemetadata.keywords" + ], + "title": "PageMetaData.keywords" + }, + { + "id": "script-api:dw/web/PageMetaData#pageMetaTags", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.pageMetaTags", + "tags": [ + "pagemetatags", + "pagemetadata.pagemetatags" + ], + "title": "PageMetaData.pageMetaTags" + }, + { + "id": "script-api:dw/web/PageMetaData#setDescription", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.setDescription", + "tags": [ + "setdescription", + "pagemetadata.setdescription" + ], + "title": "PageMetaData.setDescription" + }, + { + "id": "script-api:dw/web/PageMetaData#setKeywords", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.setKeywords", + "tags": [ + "setkeywords", + "pagemetadata.setkeywords" + ], + "title": "PageMetaData.setKeywords" + }, + { + "id": "script-api:dw/web/PageMetaData#setTitle", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.setTitle", + "tags": [ + "settitle", + "pagemetadata.settitle" + ], + "title": "PageMetaData.setTitle" + }, + { + "id": "script-api:dw/web/PageMetaData#title", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaData", + "qualifiedName": "dw.web.PageMetaData.title", + "tags": [ + "title", + "pagemetadata.title" + ], + "title": "PageMetaData.title" + }, + { + "id": "script-api:dw/web/PageMetaTag", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.PageMetaTag", + "tags": [ + "pagemetatag", + "dw.web.pagemetatag", + "dw/web" + ], + "title": "PageMetaTag" + }, + { + "id": "script-api:dw/web/PageMetaTag#ID", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.ID", + "tags": [ + "id", + "pagemetatag.id" + ], + "title": "PageMetaTag.ID" + }, + { + "id": "script-api:dw/web/PageMetaTag#content", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.content", + "tags": [ + "content", + "pagemetatag.content" + ], + "title": "PageMetaTag.content" + }, + { + "id": "script-api:dw/web/PageMetaTag#getContent", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.getContent", + "tags": [ + "getcontent", + "pagemetatag.getcontent" + ], + "title": "PageMetaTag.getContent" + }, + { + "id": "script-api:dw/web/PageMetaTag#getID", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.getID", + "tags": [ + "getid", + "pagemetatag.getid" + ], + "title": "PageMetaTag.getID" + }, + { + "id": "script-api:dw/web/PageMetaTag#isJsonLd", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.isJsonLd", + "tags": [ + "isjsonld", + "pagemetatag.isjsonld" + ], + "title": "PageMetaTag.isJsonLd" + }, + { + "id": "script-api:dw/web/PageMetaTag#isName", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.isName", + "tags": [ + "isname", + "pagemetatag.isname" + ], + "title": "PageMetaTag.isName" + }, + { + "id": "script-api:dw/web/PageMetaTag#isProperty", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.isProperty", + "tags": [ + "isproperty", + "pagemetatag.isproperty" + ], + "title": "PageMetaTag.isProperty" + }, + { + "id": "script-api:dw/web/PageMetaTag#isTitle", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.isTitle", + "tags": [ + "istitle", + "pagemetatag.istitle" + ], + "title": "PageMetaTag.isTitle" + }, + { + "id": "script-api:dw/web/PageMetaTag#jsonLd", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.jsonLd", + "tags": [ + "jsonld", + "pagemetatag.jsonld" + ], + "title": "PageMetaTag.jsonLd" + }, + { + "id": "script-api:dw/web/PageMetaTag#name", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.name", + "tags": [ + "name", + "pagemetatag.name" + ], + "title": "PageMetaTag.name" + }, + { + "id": "script-api:dw/web/PageMetaTag#property", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.property", + "tags": [ + "property", + "pagemetatag.property" + ], + "title": "PageMetaTag.property" + }, + { + "id": "script-api:dw/web/PageMetaTag#title", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PageMetaTag", + "qualifiedName": "dw.web.PageMetaTag.title", + "tags": [ + "title", + "pagemetatag.title" + ], + "title": "PageMetaTag.title" + }, + { + "id": "script-api:dw/web/PagingModel", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.PagingModel", + "tags": [ + "pagingmodel", + "dw.web.pagingmodel", + "dw/web" + ], + "title": "PagingModel" + }, + { + "id": "script-api:dw/web/PagingModel#DEFAULT_PAGE_SIZE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.DEFAULT_PAGE_SIZE", + "tags": [ + "default_page_size", + "pagingmodel.default_page_size" + ], + "title": "PagingModel.DEFAULT_PAGE_SIZE" + }, + { + "id": "script-api:dw/web/PagingModel#DEFAULT_PAGE_SIZE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.DEFAULT_PAGE_SIZE", + "tags": [ + "default_page_size", + "pagingmodel.default_page_size" + ], + "title": "PagingModel.DEFAULT_PAGE_SIZE" + }, + { + "id": "script-api:dw/web/PagingModel#MAX_PAGE_SIZE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.MAX_PAGE_SIZE", + "tags": [ + "max_page_size", + "pagingmodel.max_page_size" + ], + "title": "PagingModel.MAX_PAGE_SIZE" + }, + { + "id": "script-api:dw/web/PagingModel#MAX_PAGE_SIZE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.MAX_PAGE_SIZE", + "tags": [ + "max_page_size", + "pagingmodel.max_page_size" + ], + "title": "PagingModel.MAX_PAGE_SIZE" + }, + { + "id": "script-api:dw/web/PagingModel#PAGING_SIZE_PARAMETER", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.PAGING_SIZE_PARAMETER", + "tags": [ + "paging_size_parameter", + "pagingmodel.paging_size_parameter" + ], + "title": "PagingModel.PAGING_SIZE_PARAMETER" + }, + { + "id": "script-api:dw/web/PagingModel#PAGING_SIZE_PARAMETER", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.PAGING_SIZE_PARAMETER", + "tags": [ + "paging_size_parameter", + "pagingmodel.paging_size_parameter" + ], + "title": "PagingModel.PAGING_SIZE_PARAMETER" + }, + { + "id": "script-api:dw/web/PagingModel#PAGING_START_PARAMETER", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.PAGING_START_PARAMETER", + "tags": [ + "paging_start_parameter", + "pagingmodel.paging_start_parameter" + ], + "title": "PagingModel.PAGING_START_PARAMETER" + }, + { + "id": "script-api:dw/web/PagingModel#PAGING_START_PARAMETER", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.PAGING_START_PARAMETER", + "tags": [ + "paging_start_parameter", + "pagingmodel.paging_start_parameter" + ], + "title": "PagingModel.PAGING_START_PARAMETER" + }, + { + "id": "script-api:dw/web/PagingModel#appendPageSize", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.appendPageSize", + "tags": [ + "appendpagesize", + "pagingmodel.appendpagesize" + ], + "title": "PagingModel.appendPageSize" + }, + { + "id": "script-api:dw/web/PagingModel#appendPageSize", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.appendPageSize", + "tags": [ + "appendpagesize", + "pagingmodel.appendpagesize" + ], + "title": "PagingModel.appendPageSize" + }, + { + "id": "script-api:dw/web/PagingModel#appendPaging", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.appendPaging", + "tags": [ + "appendpaging", + "pagingmodel.appendpaging" + ], + "title": "PagingModel.appendPaging" + }, + { + "id": "script-api:dw/web/PagingModel#appendPaging", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.appendPaging", + "tags": [ + "appendpaging", + "pagingmodel.appendpaging" + ], + "title": "PagingModel.appendPaging" + }, + { + "id": "script-api:dw/web/PagingModel#count", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.count", + "tags": [ + "count", + "pagingmodel.count" + ], + "title": "PagingModel.count" + }, + { + "id": "script-api:dw/web/PagingModel#currentPage", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.currentPage", + "tags": [ + "currentpage", + "pagingmodel.currentpage" + ], + "title": "PagingModel.currentPage" + }, + { + "id": "script-api:dw/web/PagingModel#empty", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.empty", + "tags": [ + "empty", + "pagingmodel.empty" + ], + "title": "PagingModel.empty" + }, + { + "id": "script-api:dw/web/PagingModel#end", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.end", + "tags": [ + "end", + "pagingmodel.end" + ], + "title": "PagingModel.end" + }, + { + "id": "script-api:dw/web/PagingModel#getCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getCount", + "tags": [ + "getcount", + "pagingmodel.getcount" + ], + "title": "PagingModel.getCount" + }, + { + "id": "script-api:dw/web/PagingModel#getCurrentPage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getCurrentPage", + "tags": [ + "getcurrentpage", + "pagingmodel.getcurrentpage" + ], + "title": "PagingModel.getCurrentPage" + }, + { + "id": "script-api:dw/web/PagingModel#getEnd", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getEnd", + "tags": [ + "getend", + "pagingmodel.getend" + ], + "title": "PagingModel.getEnd" + }, + { + "id": "script-api:dw/web/PagingModel#getMaxPage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getMaxPage", + "tags": [ + "getmaxpage", + "pagingmodel.getmaxpage" + ], + "title": "PagingModel.getMaxPage" + }, + { + "id": "script-api:dw/web/PagingModel#getPageCount", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getPageCount", + "tags": [ + "getpagecount", + "pagingmodel.getpagecount" + ], + "title": "PagingModel.getPageCount" + }, + { + "id": "script-api:dw/web/PagingModel#getPageElements", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getPageElements", + "tags": [ + "getpageelements", + "pagingmodel.getpageelements" + ], + "title": "PagingModel.getPageElements" + }, + { + "id": "script-api:dw/web/PagingModel#getPageSize", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getPageSize", + "tags": [ + "getpagesize", + "pagingmodel.getpagesize" + ], + "title": "PagingModel.getPageSize" + }, + { + "id": "script-api:dw/web/PagingModel#getStart", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.getStart", + "tags": [ + "getstart", + "pagingmodel.getstart" + ], + "title": "PagingModel.getStart" + }, + { + "id": "script-api:dw/web/PagingModel#isEmpty", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.isEmpty", + "tags": [ + "isempty", + "pagingmodel.isempty" + ], + "title": "PagingModel.isEmpty" + }, + { + "id": "script-api:dw/web/PagingModel#maxPage", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.maxPage", + "tags": [ + "maxpage", + "pagingmodel.maxpage" + ], + "title": "PagingModel.maxPage" + }, + { + "id": "script-api:dw/web/PagingModel#pageCount", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.pageCount", + "tags": [ + "pagecount", + "pagingmodel.pagecount" + ], + "title": "PagingModel.pageCount" + }, + { + "id": "script-api:dw/web/PagingModel#pageElements", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.pageElements", + "tags": [ + "pageelements", + "pagingmodel.pageelements" + ], + "title": "PagingModel.pageElements" + }, + { + "id": "script-api:dw/web/PagingModel#pageSize", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.pageSize", + "tags": [ + "pagesize", + "pagingmodel.pagesize" + ], + "title": "PagingModel.pageSize" + }, + { + "id": "script-api:dw/web/PagingModel#setPageSize", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.setPageSize", + "tags": [ + "setpagesize", + "pagingmodel.setpagesize" + ], + "title": "PagingModel.setPageSize" + }, + { + "id": "script-api:dw/web/PagingModel#setStart", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.setStart", + "tags": [ + "setstart", + "pagingmodel.setstart" + ], + "title": "PagingModel.setStart" + }, + { + "id": "script-api:dw/web/PagingModel#start", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/PagingModel", + "qualifiedName": "dw.web.PagingModel.start", + "tags": [ + "start", + "pagingmodel.start" + ], + "title": "PagingModel.start" + }, + { + "id": "script-api:dw/web/Resource", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.Resource", + "tags": [ + "resource", + "dw.web.resource", + "dw/web" + ], + "title": "Resource" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msg", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msg", + "tags": [ + "msg", + "resource.msg" + ], + "title": "Resource.msg" + }, + { + "id": "script-api:dw/web/Resource#msgf", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msgf", + "tags": [ + "msgf", + "resource.msgf" + ], + "title": "Resource.msgf" + }, + { + "id": "script-api:dw/web/Resource#msgf", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/Resource", + "qualifiedName": "dw.web.Resource.msgf", + "tags": [ + "msgf", + "resource.msgf" + ], + "title": "Resource.msgf" + }, + { + "id": "script-api:dw/web/URL", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URL", + "tags": [ + "url", + "dw.web.url", + "dw/web" + ], + "title": "URL" + }, + { + "id": "script-api:dw/web/URL#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.abs", + "tags": [ + "abs", + "url.abs" + ], + "title": "URL.abs" + }, + { + "id": "script-api:dw/web/URL#append", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.append", + "tags": [ + "append", + "url.append" + ], + "title": "URL.append" + }, + { + "id": "script-api:dw/web/URL#appendCSRFTokenBM", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.appendCSRFTokenBM", + "tags": [ + "appendcsrftokenbm", + "url.appendcsrftokenbm" + ], + "title": "URL.appendCSRFTokenBM" + }, + { + "id": "script-api:dw/web/URL#host", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.host", + "tags": [ + "host", + "url.host" + ], + "title": "URL.host" + }, + { + "id": "script-api:dw/web/URL#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.http", + "tags": [ + "http", + "url.http" + ], + "title": "URL.http" + }, + { + "id": "script-api:dw/web/URL#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.https", + "tags": [ + "https", + "url.https" + ], + "title": "URL.https" + }, + { + "id": "script-api:dw/web/URL#relative", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.relative", + "tags": [ + "relative", + "url.relative" + ], + "title": "URL.relative" + }, + { + "id": "script-api:dw/web/URL#remove", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.remove", + "tags": [ + "remove", + "url.remove" + ], + "title": "URL.remove" + }, + { + "id": "script-api:dw/web/URL#siteHost", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.siteHost", + "tags": [ + "sitehost", + "url.sitehost" + ], + "title": "URL.siteHost" + }, + { + "id": "script-api:dw/web/URL#toString", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URL", + "qualifiedName": "dw.web.URL.toString", + "tags": [ + "tostring", + "url.tostring" + ], + "title": "URL.toString" + }, + { + "id": "script-api:dw/web/URLAction", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URLAction", + "tags": [ + "urlaction", + "dw.web.urlaction", + "dw/web" + ], + "title": "URLAction" + }, + { + "id": "script-api:dw/web/URLParameter", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URLParameter", + "tags": [ + "urlparameter", + "dw.web.urlparameter", + "dw/web" + ], + "title": "URLParameter" + }, + { + "id": "script-api:dw/web/URLRedirect", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URLRedirect", + "tags": [ + "urlredirect", + "dw.web.urlredirect", + "dw/web" + ], + "title": "URLRedirect" + }, + { + "id": "script-api:dw/web/URLRedirect#getLocation", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirect", + "qualifiedName": "dw.web.URLRedirect.getLocation", + "tags": [ + "getlocation", + "urlredirect.getlocation" + ], + "title": "URLRedirect.getLocation" + }, + { + "id": "script-api:dw/web/URLRedirect#getStatus", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirect", + "qualifiedName": "dw.web.URLRedirect.getStatus", + "tags": [ + "getstatus", + "urlredirect.getstatus" + ], + "title": "URLRedirect.getStatus" + }, + { + "id": "script-api:dw/web/URLRedirect#location", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirect", + "qualifiedName": "dw.web.URLRedirect.location", + "tags": [ + "location", + "urlredirect.location" + ], + "title": "URLRedirect.location" + }, + { + "id": "script-api:dw/web/URLRedirect#status", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirect", + "qualifiedName": "dw.web.URLRedirect.status", + "tags": [ + "status", + "urlredirect.status" + ], + "title": "URLRedirect.status" + }, + { + "id": "script-api:dw/web/URLRedirectMgr", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URLRedirectMgr", + "tags": [ + "urlredirectmgr", + "dw.web.urlredirectmgr", + "dw/web" + ], + "title": "URLRedirectMgr" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#getRedirect", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.getRedirect", + "tags": [ + "getredirect", + "urlredirectmgr.getredirect" + ], + "title": "URLRedirectMgr.getRedirect" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#getRedirect", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.getRedirect", + "tags": [ + "getredirect", + "urlredirectmgr.getredirect" + ], + "title": "URLRedirectMgr.getRedirect" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#getRedirectOrigin", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.getRedirectOrigin", + "tags": [ + "getredirectorigin", + "urlredirectmgr.getredirectorigin" + ], + "title": "URLRedirectMgr.getRedirectOrigin" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#getRedirectOrigin", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.getRedirectOrigin", + "tags": [ + "getredirectorigin", + "urlredirectmgr.getredirectorigin" + ], + "title": "URLRedirectMgr.getRedirectOrigin" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#redirect", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.redirect", + "tags": [ + "redirect", + "urlredirectmgr.redirect" + ], + "title": "URLRedirectMgr.redirect" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#redirect", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.redirect", + "tags": [ + "redirect", + "urlredirectmgr.redirect" + ], + "title": "URLRedirectMgr.redirect" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#redirectOrigin", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.redirectOrigin", + "tags": [ + "redirectorigin", + "urlredirectmgr.redirectorigin" + ], + "title": "URLRedirectMgr.redirectOrigin" + }, + { + "id": "script-api:dw/web/URLRedirectMgr#redirectOrigin", + "kind": "property", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLRedirectMgr", + "qualifiedName": "dw.web.URLRedirectMgr.redirectOrigin", + "tags": [ + "redirectorigin", + "urlredirectmgr.redirectorigin" + ], + "title": "URLRedirectMgr.redirectOrigin" + }, + { + "id": "script-api:dw/web/URLUtils", + "kind": "class", + "packagePath": "dw/web", + "parentId": "script-api:dw/web", + "qualifiedName": "dw.web.URLUtils", + "tags": [ + "urlutils", + "dw.web.urlutils", + "dw/web" + ], + "title": "URLUtils" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_CATALOG", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_CATALOG", + "tags": [ + "context_catalog", + "urlutils.context_catalog" + ], + "title": "URLUtils.CONTEXT_CATALOG" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_CATALOG", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_CATALOG", + "tags": [ + "context_catalog", + "urlutils.context_catalog" + ], + "title": "URLUtils.CONTEXT_CATALOG" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_LIBRARY", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_LIBRARY", + "tags": [ + "context_library", + "urlutils.context_library" + ], + "title": "URLUtils.CONTEXT_LIBRARY" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_LIBRARY", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_LIBRARY", + "tags": [ + "context_library", + "urlutils.context_library" + ], + "title": "URLUtils.CONTEXT_LIBRARY" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_SITE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_SITE", + "tags": [ + "context_site", + "urlutils.context_site" + ], + "title": "URLUtils.CONTEXT_SITE" + }, + { + "id": "script-api:dw/web/URLUtils#CONTEXT_SITE", + "kind": "constant", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.CONTEXT_SITE", + "tags": [ + "context_site", + "urlutils.context_site" + ], + "title": "URLUtils.CONTEXT_SITE" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#abs", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.abs", + "tags": [ + "abs", + "urlutils.abs" + ], + "title": "URLUtils.abs" + }, + { + "id": "script-api:dw/web/URLUtils#absImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absImage", + "tags": [ + "absimage", + "urlutils.absimage" + ], + "title": "URLUtils.absImage" + }, + { + "id": "script-api:dw/web/URLUtils#absImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absImage", + "tags": [ + "absimage", + "urlutils.absimage" + ], + "title": "URLUtils.absImage" + }, + { + "id": "script-api:dw/web/URLUtils#absImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absImage", + "tags": [ + "absimage", + "urlutils.absimage" + ], + "title": "URLUtils.absImage" + }, + { + "id": "script-api:dw/web/URLUtils#absImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absImage", + "tags": [ + "absimage", + "urlutils.absimage" + ], + "title": "URLUtils.absImage" + }, + { + "id": "script-api:dw/web/URLUtils#absStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absStatic", + "tags": [ + "absstatic", + "urlutils.absstatic" + ], + "title": "URLUtils.absStatic" + }, + { + "id": "script-api:dw/web/URLUtils#absStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absStatic", + "tags": [ + "absstatic", + "urlutils.absstatic" + ], + "title": "URLUtils.absStatic" + }, + { + "id": "script-api:dw/web/URLUtils#absStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absStatic", + "tags": [ + "absstatic", + "urlutils.absstatic" + ], + "title": "URLUtils.absStatic" + }, + { + "id": "script-api:dw/web/URLUtils#absStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absStatic", + "tags": [ + "absstatic", + "urlutils.absstatic" + ], + "title": "URLUtils.absStatic" + }, + { + "id": "script-api:dw/web/URLUtils#absWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absWebRoot", + "tags": [ + "abswebroot", + "urlutils.abswebroot" + ], + "title": "URLUtils.absWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#absWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.absWebRoot", + "tags": [ + "abswebroot", + "urlutils.abswebroot" + ], + "title": "URLUtils.absWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#continueURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.continueURL", + "tags": [ + "continueurl", + "urlutils.continueurl" + ], + "title": "URLUtils.continueURL" + }, + { + "id": "script-api:dw/web/URLUtils#continueURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.continueURL", + "tags": [ + "continueurl", + "urlutils.continueurl" + ], + "title": "URLUtils.continueURL" + }, + { + "id": "script-api:dw/web/URLUtils#home", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.home", + "tags": [ + "home", + "urlutils.home" + ], + "title": "URLUtils.home" + }, + { + "id": "script-api:dw/web/URLUtils#home", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.home", + "tags": [ + "home", + "urlutils.home" + ], + "title": "URLUtils.home" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#http", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.http", + "tags": [ + "http", + "urlutils.http" + ], + "title": "URLUtils.http" + }, + { + "id": "script-api:dw/web/URLUtils#httpContinue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpContinue", + "tags": [ + "httpcontinue", + "urlutils.httpcontinue" + ], + "title": "URLUtils.httpContinue" + }, + { + "id": "script-api:dw/web/URLUtils#httpContinue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpContinue", + "tags": [ + "httpcontinue", + "urlutils.httpcontinue" + ], + "title": "URLUtils.httpContinue" + }, + { + "id": "script-api:dw/web/URLUtils#httpHome", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpHome", + "tags": [ + "httphome", + "urlutils.httphome" + ], + "title": "URLUtils.httpHome" + }, + { + "id": "script-api:dw/web/URLUtils#httpHome", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpHome", + "tags": [ + "httphome", + "urlutils.httphome" + ], + "title": "URLUtils.httpHome" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpImage", + "tags": [ + "httpimage", + "urlutils.httpimage" + ], + "title": "URLUtils.httpImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpStatic", + "tags": [ + "httpstatic", + "urlutils.httpstatic" + ], + "title": "URLUtils.httpStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpWebRoot", + "tags": [ + "httpwebroot", + "urlutils.httpwebroot" + ], + "title": "URLUtils.httpWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#httpWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpWebRoot", + "tags": [ + "httpwebroot", + "urlutils.httpwebroot" + ], + "title": "URLUtils.httpWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#https", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.https", + "tags": [ + "https", + "urlutils.https" + ], + "title": "URLUtils.https" + }, + { + "id": "script-api:dw/web/URLUtils#httpsContinue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsContinue", + "tags": [ + "httpscontinue", + "urlutils.httpscontinue" + ], + "title": "URLUtils.httpsContinue" + }, + { + "id": "script-api:dw/web/URLUtils#httpsContinue", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsContinue", + "tags": [ + "httpscontinue", + "urlutils.httpscontinue" + ], + "title": "URLUtils.httpsContinue" + }, + { + "id": "script-api:dw/web/URLUtils#httpsHome", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsHome", + "tags": [ + "httpshome", + "urlutils.httpshome" + ], + "title": "URLUtils.httpsHome" + }, + { + "id": "script-api:dw/web/URLUtils#httpsHome", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsHome", + "tags": [ + "httpshome", + "urlutils.httpshome" + ], + "title": "URLUtils.httpsHome" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsImage", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsImage", + "tags": [ + "httpsimage", + "urlutils.httpsimage" + ], + "title": "URLUtils.httpsImage" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsStatic", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsStatic", + "tags": [ + "httpsstatic", + "urlutils.httpsstatic" + ], + "title": "URLUtils.httpsStatic" + }, + { + "id": "script-api:dw/web/URLUtils#httpsWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsWebRoot", + "tags": [ + "httpswebroot", + "urlutils.httpswebroot" + ], + "title": "URLUtils.httpsWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#httpsWebRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.httpsWebRoot", + "tags": [ + "httpswebroot", + "urlutils.httpswebroot" + ], + "title": "URLUtils.httpsWebRoot" + }, + { + "id": "script-api:dw/web/URLUtils#imageURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.imageURL", + "tags": [ + "imageurl", + "urlutils.imageurl" + ], + "title": "URLUtils.imageURL" + }, + { + "id": "script-api:dw/web/URLUtils#imageURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.imageURL", + "tags": [ + "imageurl", + "urlutils.imageurl" + ], + "title": "URLUtils.imageURL" + }, + { + "id": "script-api:dw/web/URLUtils#imageURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.imageURL", + "tags": [ + "imageurl", + "urlutils.imageurl" + ], + "title": "URLUtils.imageURL" + }, + { + "id": "script-api:dw/web/URLUtils#imageURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.imageURL", + "tags": [ + "imageurl", + "urlutils.imageurl" + ], + "title": "URLUtils.imageURL" + }, + { + "id": "script-api:dw/web/URLUtils#sessionRedirect", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.sessionRedirect", + "tags": [ + "sessionredirect", + "urlutils.sessionredirect" + ], + "title": "URLUtils.sessionRedirect" + }, + { + "id": "script-api:dw/web/URLUtils#sessionRedirect", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.sessionRedirect", + "tags": [ + "sessionredirect", + "urlutils.sessionredirect" + ], + "title": "URLUtils.sessionRedirect" + }, + { + "id": "script-api:dw/web/URLUtils#sessionRedirectHttpOnly", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.sessionRedirectHttpOnly", + "tags": [ + "sessionredirecthttponly", + "urlutils.sessionredirecthttponly" + ], + "title": "URLUtils.sessionRedirectHttpOnly" + }, + { + "id": "script-api:dw/web/URLUtils#sessionRedirectHttpOnly", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.sessionRedirectHttpOnly", + "tags": [ + "sessionredirecthttponly", + "urlutils.sessionredirecthttponly" + ], + "title": "URLUtils.sessionRedirectHttpOnly" + }, + { + "id": "script-api:dw/web/URLUtils#staticURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.staticURL", + "tags": [ + "staticurl", + "urlutils.staticurl" + ], + "title": "URLUtils.staticURL" + }, + { + "id": "script-api:dw/web/URLUtils#staticURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.staticURL", + "tags": [ + "staticurl", + "urlutils.staticurl" + ], + "title": "URLUtils.staticURL" + }, + { + "id": "script-api:dw/web/URLUtils#staticURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.staticURL", + "tags": [ + "staticurl", + "urlutils.staticurl" + ], + "title": "URLUtils.staticURL" + }, + { + "id": "script-api:dw/web/URLUtils#staticURL", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.staticURL", + "tags": [ + "staticurl", + "urlutils.staticurl" + ], + "title": "URLUtils.staticURL" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#url", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.url", + "tags": [ + "url", + "urlutils.url" + ], + "title": "URLUtils.url" + }, + { + "id": "script-api:dw/web/URLUtils#webRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.webRoot", + "tags": [ + "webroot", + "urlutils.webroot" + ], + "title": "URLUtils.webRoot" + }, + { + "id": "script-api:dw/web/URLUtils#webRoot", + "kind": "method", + "packagePath": "dw/web", + "parentId": "script-api:dw/web/URLUtils", + "qualifiedName": "dw.web.URLUtils.webRoot", + "tags": [ + "webroot", + "urlutils.webroot" + ], + "title": "URLUtils.webRoot" + }, + { + "id": "script-api:dw/ws", + "kind": "package", + "packagePath": "dw/ws", + "qualifiedName": "dw.ws", + "tags": [ + "dw/ws", + "dw.ws" + ], + "title": "dw.ws" + }, + { + "id": "script-api:dw/ws/Port", + "kind": "class", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws", + "qualifiedName": "dw.ws.Port", + "tags": [ + "port", + "dw.ws.port", + "dw/ws" + ], + "title": "Port" + }, + { + "id": "script-api:dw/ws/Port#ENCODING", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.ENCODING", + "tags": [ + "encoding", + "port.encoding" + ], + "title": "Port.ENCODING" + }, + { + "id": "script-api:dw/ws/Port#ENCODING", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.ENCODING", + "tags": [ + "encoding", + "port.encoding" + ], + "title": "Port.ENCODING" + }, + { + "id": "script-api:dw/ws/Port#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.ENDPOINT_ADDRESS_PROPERTY", + "tags": [ + "endpoint_address_property", + "port.endpoint_address_property" + ], + "title": "Port.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.ENDPOINT_ADDRESS_PROPERTY", + "tags": [ + "endpoint_address_property", + "port.endpoint_address_property" + ], + "title": "Port.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.PASSWORD_PROPERTY", + "tags": [ + "password_property", + "port.password_property" + ], + "title": "Port.PASSWORD_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.PASSWORD_PROPERTY", + "tags": [ + "password_property", + "port.password_property" + ], + "title": "Port.PASSWORD_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.SESSION_MAINTAIN_PROPERTY", + "tags": [ + "session_maintain_property", + "port.session_maintain_property" + ], + "title": "Port.SESSION_MAINTAIN_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.SESSION_MAINTAIN_PROPERTY", + "tags": [ + "session_maintain_property", + "port.session_maintain_property" + ], + "title": "Port.SESSION_MAINTAIN_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.USERNAME_PROPERTY", + "tags": [ + "username_property", + "port.username_property" + ], + "title": "Port.USERNAME_PROPERTY" + }, + { + "id": "script-api:dw/ws/Port#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/Port", + "qualifiedName": "dw.ws.Port.USERNAME_PROPERTY", + "tags": [ + "username_property", + "port.username_property" + ], + "title": "Port.USERNAME_PROPERTY" + }, + { + "id": "script-api:dw/ws/WSUtil", + "kind": "class", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws", + "qualifiedName": "dw.ws.WSUtil", + "tags": [ + "wsutil", + "dw.ws.wsutil", + "dw/ws" + ], + "title": "WSUtil" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_DIRECT_REFERENCE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_DIRECT_REFERENCE", + "tags": [ + "key_id_type_direct_reference", + "wsutil.key_id_type_direct_reference" + ], + "title": "WSUtil.KEY_ID_TYPE_DIRECT_REFERENCE" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_DIRECT_REFERENCE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_DIRECT_REFERENCE", + "tags": [ + "key_id_type_direct_reference", + "wsutil.key_id_type_direct_reference" + ], + "title": "WSUtil.KEY_ID_TYPE_DIRECT_REFERENCE" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_ENC_KEY_SHA1", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_ENC_KEY_SHA1", + "tags": [ + "key_id_type_enc_key_sha1", + "wsutil.key_id_type_enc_key_sha1" + ], + "title": "WSUtil.KEY_ID_TYPE_ENC_KEY_SHA1" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_ENC_KEY_SHA1", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_ENC_KEY_SHA1", + "tags": [ + "key_id_type_enc_key_sha1", + "wsutil.key_id_type_enc_key_sha1" + ], + "title": "WSUtil.KEY_ID_TYPE_ENC_KEY_SHA1" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_ISSUE_SERIAL", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_ISSUE_SERIAL", + "tags": [ + "key_id_type_issue_serial", + "wsutil.key_id_type_issue_serial" + ], + "title": "WSUtil.KEY_ID_TYPE_ISSUE_SERIAL" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_ISSUE_SERIAL", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_ISSUE_SERIAL", + "tags": [ + "key_id_type_issue_serial", + "wsutil.key_id_type_issue_serial" + ], + "title": "WSUtil.KEY_ID_TYPE_ISSUE_SERIAL" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_SKI_IDENTIFIER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_SKI_IDENTIFIER", + "tags": [ + "key_id_type_ski_identifier", + "wsutil.key_id_type_ski_identifier" + ], + "title": "WSUtil.KEY_ID_TYPE_SKI_IDENTIFIER" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_SKI_IDENTIFIER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_SKI_IDENTIFIER", + "tags": [ + "key_id_type_ski_identifier", + "wsutil.key_id_type_ski_identifier" + ], + "title": "WSUtil.KEY_ID_TYPE_SKI_IDENTIFIER" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_THUMBPRINT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_THUMBPRINT", + "tags": [ + "key_id_type_thumbprint", + "wsutil.key_id_type_thumbprint" + ], + "title": "WSUtil.KEY_ID_TYPE_THUMBPRINT" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_THUMBPRINT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_THUMBPRINT", + "tags": [ + "key_id_type_thumbprint", + "wsutil.key_id_type_thumbprint" + ], + "title": "WSUtil.KEY_ID_TYPE_THUMBPRINT" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_X509_KEY_IDENTIFIER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_X509_KEY_IDENTIFIER", + "tags": [ + "key_id_type_x509_key_identifier", + "wsutil.key_id_type_x509_key_identifier" + ], + "title": "WSUtil.KEY_ID_TYPE_X509_KEY_IDENTIFIER" + }, + { + "id": "script-api:dw/ws/WSUtil#KEY_ID_TYPE_X509_KEY_IDENTIFIER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.KEY_ID_TYPE_X509_KEY_IDENTIFIER", + "tags": [ + "key_id_type_x509_key_identifier", + "wsutil.key_id_type_x509_key_identifier" + ], + "title": "WSUtil.KEY_ID_TYPE_X509_KEY_IDENTIFIER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ACTION", + "tags": [ + "ws_action", + "wsutil.ws_action" + ], + "title": "WSUtil.WS_ACTION" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ACTION", + "tags": [ + "ws_action", + "wsutil.ws_action" + ], + "title": "WSUtil.WS_ACTION" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPT", + "tags": [ + "ws_encrypt", + "wsutil.ws_encrypt" + ], + "title": "WSUtil.WS_ENCRYPT" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPT", + "tags": [ + "ws_encrypt", + "wsutil.ws_encrypt" + ], + "title": "WSUtil.WS_ENCRYPT" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPTION_PARTS", + "tags": [ + "ws_encryption_parts", + "wsutil.ws_encryption_parts" + ], + "title": "WSUtil.WS_ENCRYPTION_PARTS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPTION_PARTS", + "tags": [ + "ws_encryption_parts", + "wsutil.ws_encryption_parts" + ], + "title": "WSUtil.WS_ENCRYPTION_PARTS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPTION_USER", + "tags": [ + "ws_encryption_user", + "wsutil.ws_encryption_user" + ], + "title": "WSUtil.WS_ENCRYPTION_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENCRYPTION_USER", + "tags": [ + "ws_encryption_user", + "wsutil.ws_encryption_user" + ], + "title": "WSUtil.WS_ENCRYPTION_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_KEY_ID", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_KEY_ID", + "tags": [ + "ws_enc_key_id", + "wsutil.ws_enc_key_id" + ], + "title": "WSUtil.WS_ENC_KEY_ID" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_KEY_ID", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_KEY_ID", + "tags": [ + "ws_enc_key_id", + "wsutil.ws_enc_key_id" + ], + "title": "WSUtil.WS_ENC_KEY_ID" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_enc_prop_keystore_alias", + "wsutil.ws_enc_prop_keystore_alias" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_enc_prop_keystore_alias", + "wsutil.ws_enc_prop_keystore_alias" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_PW", + "tags": [ + "ws_enc_prop_keystore_pw", + "wsutil.ws_enc_prop_keystore_pw" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_PW", + "tags": [ + "ws_enc_prop_keystore_pw", + "wsutil.ws_enc_prop_keystore_pw" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_enc_prop_keystore_type", + "wsutil.ws_enc_prop_keystore_type" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_enc_prop_keystore_type", + "wsutil.ws_enc_prop_keystore_type" + ], + "title": "WSUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_NO_SECURITY", + "tags": [ + "ws_no_security", + "wsutil.ws_no_security" + ], + "title": "WSUtil.WS_NO_SECURITY" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_NO_SECURITY", + "tags": [ + "ws_no_security", + "wsutil.ws_no_security" + ], + "title": "WSUtil.WS_NO_SECURITY" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PASSWORD_TYPE", + "tags": [ + "ws_password_type", + "wsutil.ws_password_type" + ], + "title": "WSUtil.WS_PASSWORD_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PASSWORD_TYPE", + "tags": [ + "ws_password_type", + "wsutil.ws_password_type" + ], + "title": "WSUtil.WS_PASSWORD_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PW_DIGEST", + "tags": [ + "ws_pw_digest", + "wsutil.ws_pw_digest" + ], + "title": "WSUtil.WS_PW_DIGEST" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PW_DIGEST", + "tags": [ + "ws_pw_digest", + "wsutil.ws_pw_digest" + ], + "title": "WSUtil.WS_PW_DIGEST" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PW_TEXT", + "tags": [ + "ws_pw_text", + "wsutil.ws_pw_text" + ], + "title": "WSUtil.WS_PW_TEXT" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_PW_TEXT", + "tags": [ + "ws_pw_text", + "wsutil.ws_pw_text" + ], + "title": "WSUtil.WS_PW_TEXT" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SECRETS_MAP", + "tags": [ + "ws_secrets_map", + "wsutil.ws_secrets_map" + ], + "title": "WSUtil.WS_SECRETS_MAP" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SECRETS_MAP", + "tags": [ + "ws_secrets_map", + "wsutil.ws_secrets_map" + ], + "title": "WSUtil.WS_SECRETS_MAP" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE", + "tags": [ + "ws_signature", + "wsutil.ws_signature" + ], + "title": "WSUtil.WS_SIGNATURE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE", + "tags": [ + "ws_signature", + "wsutil.ws_signature" + ], + "title": "WSUtil.WS_SIGNATURE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE_PARTS", + "tags": [ + "ws_signature_parts", + "wsutil.ws_signature_parts" + ], + "title": "WSUtil.WS_SIGNATURE_PARTS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE_PARTS", + "tags": [ + "ws_signature_parts", + "wsutil.ws_signature_parts" + ], + "title": "WSUtil.WS_SIGNATURE_PARTS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE_USER", + "tags": [ + "ws_signature_user", + "wsutil.ws_signature_user" + ], + "title": "WSUtil.WS_SIGNATURE_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIGNATURE_USER", + "tags": [ + "ws_signature_user", + "wsutil.ws_signature_user" + ], + "title": "WSUtil.WS_SIGNATURE_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_DIGEST_ALGO", + "tags": [ + "ws_sig_digest_algo", + "wsutil.ws_sig_digest_algo" + ], + "title": "WSUtil.WS_SIG_DIGEST_ALGO" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_DIGEST_ALGO", + "tags": [ + "ws_sig_digest_algo", + "wsutil.ws_sig_digest_algo" + ], + "title": "WSUtil.WS_SIG_DIGEST_ALGO" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_KEY_ID", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_KEY_ID", + "tags": [ + "ws_sig_key_id", + "wsutil.ws_sig_key_id" + ], + "title": "WSUtil.WS_SIG_KEY_ID" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_KEY_ID", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_KEY_ID", + "tags": [ + "ws_sig_key_id", + "wsutil.ws_sig_key_id" + ], + "title": "WSUtil.WS_SIG_KEY_ID" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_sig_prop_keystore_alias", + "wsutil.ws_sig_prop_keystore_alias" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "tags": [ + "ws_sig_prop_keystore_alias", + "wsutil.ws_sig_prop_keystore_alias" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_PW", + "tags": [ + "ws_sig_prop_keystore_pw", + "wsutil.ws_sig_prop_keystore_pw" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_PW", + "tags": [ + "ws_sig_prop_keystore_pw", + "wsutil.ws_sig_prop_keystore_pw" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_sig_prop_keystore_type", + "wsutil.ws_sig_prop_keystore_type" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "tags": [ + "ws_sig_prop_keystore_type", + "wsutil.ws_sig_prop_keystore_type" + ], + "title": "WSUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_TIMESTAMP", + "tags": [ + "ws_timestamp", + "wsutil.ws_timestamp" + ], + "title": "WSUtil.WS_TIMESTAMP" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_TIMESTAMP", + "tags": [ + "ws_timestamp", + "wsutil.ws_timestamp" + ], + "title": "WSUtil.WS_TIMESTAMP" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_USER", + "tags": [ + "ws_user", + "wsutil.ws_user" + ], + "title": "WSUtil.WS_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_USER", + "tags": [ + "ws_user", + "wsutil.ws_user" + ], + "title": "WSUtil.WS_USER" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_USERNAME_TOKEN", + "tags": [ + "ws_username_token", + "wsutil.ws_username_token" + ], + "title": "WSUtil.WS_USERNAME_TOKEN" + }, + { + "id": "script-api:dw/ws/WSUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.WS_USERNAME_TOKEN", + "tags": [ + "ws_username_token", + "wsutil.ws_username_token" + ], + "title": "WSUtil.WS_USERNAME_TOKEN" + }, + { + "id": "script-api:dw/ws/WSUtil#addSOAPHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.addSOAPHeader", + "tags": [ + "addsoapheader", + "wsutil.addsoapheader" + ], + "title": "WSUtil.addSOAPHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#addSOAPHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.addSOAPHeader", + "tags": [ + "addsoapheader", + "wsutil.addsoapheader" + ], + "title": "WSUtil.addSOAPHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#addSOAPHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.addSOAPHeader", + "tags": [ + "addsoapheader", + "wsutil.addsoapheader" + ], + "title": "WSUtil.addSOAPHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#addSOAPHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.addSOAPHeader", + "tags": [ + "addsoapheader", + "wsutil.addsoapheader" + ], + "title": "WSUtil.addSOAPHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#clearSOAPHeaders", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.clearSOAPHeaders", + "tags": [ + "clearsoapheaders", + "wsutil.clearsoapheaders" + ], + "title": "WSUtil.clearSOAPHeaders" + }, + { + "id": "script-api:dw/ws/WSUtil#clearSOAPHeaders", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.clearSOAPHeaders", + "tags": [ + "clearsoapheaders", + "wsutil.clearsoapheaders" + ], + "title": "WSUtil.clearSOAPHeaders" + }, + { + "id": "script-api:dw/ws/WSUtil#createHolder", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.createHolder", + "tags": [ + "createholder", + "wsutil.createholder" + ], + "title": "WSUtil.createHolder" + }, + { + "id": "script-api:dw/ws/WSUtil#createHolder", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.createHolder", + "tags": [ + "createholder", + "wsutil.createholder" + ], + "title": "WSUtil.createHolder" + }, + { + "id": "script-api:dw/ws/WSUtil#getConnectionTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getConnectionTimeout", + "tags": [ + "getconnectiontimeout", + "wsutil.getconnectiontimeout" + ], + "title": "WSUtil.getConnectionTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#getConnectionTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getConnectionTimeout", + "tags": [ + "getconnectiontimeout", + "wsutil.getconnectiontimeout" + ], + "title": "WSUtil.getConnectionTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getHTTPRequestHeader", + "tags": [ + "gethttprequestheader", + "wsutil.gethttprequestheader" + ], + "title": "WSUtil.getHTTPRequestHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getHTTPRequestHeader", + "tags": [ + "gethttprequestheader", + "wsutil.gethttprequestheader" + ], + "title": "WSUtil.getHTTPRequestHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#getProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getProperty", + "tags": [ + "getproperty", + "wsutil.getproperty" + ], + "title": "WSUtil.getProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#getProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getProperty", + "tags": [ + "getproperty", + "wsutil.getproperty" + ], + "title": "WSUtil.getProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#getRequestTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getRequestTimeout", + "tags": [ + "getrequesttimeout", + "wsutil.getrequesttimeout" + ], + "title": "WSUtil.getRequestTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#getRequestTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getRequestTimeout", + "tags": [ + "getrequesttimeout", + "wsutil.getrequesttimeout" + ], + "title": "WSUtil.getRequestTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#getResponseProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getResponseProperty", + "tags": [ + "getresponseproperty", + "wsutil.getresponseproperty" + ], + "title": "WSUtil.getResponseProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#getResponseProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.getResponseProperty", + "tags": [ + "getresponseproperty", + "wsutil.getresponseproperty" + ], + "title": "WSUtil.getResponseProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#isAllowChunking", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.isAllowChunking", + "tags": [ + "isallowchunking", + "wsutil.isallowchunking" + ], + "title": "WSUtil.isAllowChunking" + }, + { + "id": "script-api:dw/ws/WSUtil#isAllowChunking", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.isAllowChunking", + "tags": [ + "isallowchunking", + "wsutil.isallowchunking" + ], + "title": "WSUtil.isAllowChunking" + }, + { + "id": "script-api:dw/ws/WSUtil#setAllowChunking", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setAllowChunking", + "tags": [ + "setallowchunking", + "wsutil.setallowchunking" + ], + "title": "WSUtil.setAllowChunking" + }, + { + "id": "script-api:dw/ws/WSUtil#setAllowChunking", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setAllowChunking", + "tags": [ + "setallowchunking", + "wsutil.setallowchunking" + ], + "title": "WSUtil.setAllowChunking" + }, + { + "id": "script-api:dw/ws/WSUtil#setConnectionTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setConnectionTimeout", + "tags": [ + "setconnectiontimeout", + "wsutil.setconnectiontimeout" + ], + "title": "WSUtil.setConnectionTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#setConnectionTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setConnectionTimeout", + "tags": [ + "setconnectiontimeout", + "wsutil.setconnectiontimeout" + ], + "title": "WSUtil.setConnectionTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setHTTPRequestHeader", + "tags": [ + "sethttprequestheader", + "wsutil.sethttprequestheader" + ], + "title": "WSUtil.setHTTPRequestHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setHTTPRequestHeader", + "tags": [ + "sethttprequestheader", + "wsutil.sethttprequestheader" + ], + "title": "WSUtil.setHTTPRequestHeader" + }, + { + "id": "script-api:dw/ws/WSUtil#setProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setProperty", + "tags": [ + "setproperty", + "wsutil.setproperty" + ], + "title": "WSUtil.setProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#setProperty", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setProperty", + "tags": [ + "setproperty", + "wsutil.setproperty" + ], + "title": "WSUtil.setProperty" + }, + { + "id": "script-api:dw/ws/WSUtil#setRequestTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setRequestTimeout", + "tags": [ + "setrequesttimeout", + "wsutil.setrequesttimeout" + ], + "title": "WSUtil.setRequestTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#setRequestTimeout", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setRequestTimeout", + "tags": [ + "setrequesttimeout", + "wsutil.setrequesttimeout" + ], + "title": "WSUtil.setRequestTimeout" + }, + { + "id": "script-api:dw/ws/WSUtil#setUserNamePassword", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setUserNamePassword", + "tags": [ + "setusernamepassword", + "wsutil.setusernamepassword" + ], + "title": "WSUtil.setUserNamePassword" + }, + { + "id": "script-api:dw/ws/WSUtil#setUserNamePassword", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setUserNamePassword", + "tags": [ + "setusernamepassword", + "wsutil.setusernamepassword" + ], + "title": "WSUtil.setUserNamePassword" + }, + { + "id": "script-api:dw/ws/WSUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setWSSecurityConfig", + "tags": [ + "setwssecurityconfig", + "wsutil.setwssecurityconfig" + ], + "title": "WSUtil.setWSSecurityConfig" + }, + { + "id": "script-api:dw/ws/WSUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WSUtil", + "qualifiedName": "dw.ws.WSUtil.setWSSecurityConfig", + "tags": [ + "setwssecurityconfig", + "wsutil.setwssecurityconfig" + ], + "title": "WSUtil.setWSSecurityConfig" + }, + { + "id": "script-api:dw/ws/WebReference2", + "kind": "class", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws", + "qualifiedName": "dw.ws.WebReference2", + "tags": [ + "webreference2", + "dw.ws.webreference2", + "dw/ws" + ], + "title": "WebReference2" + }, + { + "id": "script-api:dw/ws/WebReference2#defaultService", + "kind": "property", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WebReference2", + "qualifiedName": "dw.ws.WebReference2.defaultService", + "tags": [ + "defaultservice", + "webreference2.defaultservice" + ], + "title": "WebReference2.defaultService" + }, + { + "id": "script-api:dw/ws/WebReference2#getDefaultService", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WebReference2", + "qualifiedName": "dw.ws.WebReference2.getDefaultService", + "tags": [ + "getdefaultservice", + "webreference2.getdefaultservice" + ], + "title": "WebReference2.getDefaultService" + }, + { + "id": "script-api:dw/ws/WebReference2#getService", + "kind": "method", + "packagePath": "dw/ws", + "parentId": "script-api:dw/ws/WebReference2", + "qualifiedName": "dw.ws.WebReference2.getService", + "tags": [ + "getservice", + "webreference2.getservice" + ], + "title": "WebReference2.getService" + } +] diff --git a/packages/b2c-vs-extension/resources/docs/script-api.json b/packages/b2c-vs-extension/resources/docs/script-api.json new file mode 100644 index 000000000..c1ec24533 --- /dev/null +++ b/packages/b2c-vs-extension/resources/docs/script-api.json @@ -0,0 +1,217337 @@ +[ + { + "description": "2 declarations", + "id": "script-api:dw/alert", + "kind": "package", + "packagePath": "dw/alert", + "qualifiedName": "dw.alert", + "source": "script-api", + "tags": [ + "dw/alert", + "dw.alert" + ], + "title": "dw.alert" + }, + { + "description": "This class represents a single system alert to be shown to a Business Manager user.", + "id": "script-api:dw/alert/Alert", + "kind": "class", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert", + "qualifiedName": "dw.alert.Alert", + "sections": [ + { + "body": "This class represents a single system alert to be shown to a Business Manager user.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "alert", + "dw.alert.alert", + "dw/alert" + ], + "title": "Alert" + }, + { + "description": "String constant to denote the 'action required' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_ACTION", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_ACTION", + "sections": [ + { + "body": "String constant to denote the 'action required' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_ACTION = \"ACTION\"", + "source": "script-api", + "tags": [ + "priority_action", + "alert.priority_action" + ], + "title": "Alert.PRIORITY_ACTION" + }, + { + "description": "String constant to denote the 'action required' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_ACTION", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_ACTION", + "sections": [ + { + "body": "String constant to denote the 'action required' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_ACTION = \"ACTION\"", + "source": "script-api", + "tags": [ + "priority_action", + "alert.priority_action" + ], + "title": "Alert.PRIORITY_ACTION" + }, + { + "description": "String constant to denote the 'informational' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_INFO", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_INFO", + "sections": [ + { + "body": "String constant to denote the 'informational' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_INFO = \"INFO\"", + "source": "script-api", + "tags": [ + "priority_info", + "alert.priority_info" + ], + "title": "Alert.PRIORITY_INFO" + }, + { + "description": "String constant to denote the 'informational' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_INFO", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_INFO", + "sections": [ + { + "body": "String constant to denote the 'informational' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_INFO = \"INFO\"", + "source": "script-api", + "tags": [ + "priority_info", + "alert.priority_info" + ], + "title": "Alert.PRIORITY_INFO" + }, + { + "description": "String constant to denote the 'warning' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_WARN", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_WARN", + "sections": [ + { + "body": "String constant to denote the 'warning' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_WARN = \"WARN\"", + "source": "script-api", + "tags": [ + "priority_warn", + "alert.priority_warn" + ], + "title": "Alert.PRIORITY_WARN" + }, + { + "description": "String constant to denote the 'warning' priority.", + "id": "script-api:dw/alert/Alert#PRIORITY_WARN", + "kind": "constant", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.PRIORITY_WARN", + "sections": [ + { + "body": "String constant to denote the 'warning' priority.", + "heading": "Description" + } + ], + "signature": "static readonly PRIORITY_WARN = \"WARN\"", + "source": "script-api", + "tags": [ + "priority_warn", + "alert.priority_warn" + ], + "title": "Alert.PRIORITY_WARN" + }, + { + "description": "Returns the ID of the referenced alert description.", + "id": "script-api:dw/alert/Alert#alertDescriptorID", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.alertDescriptorID", + "sections": [ + { + "body": "Returns the ID of the referenced alert description.", + "heading": "Description" + } + ], + "signature": "readonly alertDescriptorID: string", + "source": "script-api", + "tags": [ + "alertdescriptorid", + "alert.alertdescriptorid" + ], + "title": "Alert.alertDescriptorID" + }, + { + "description": "Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).", + "id": "script-api:dw/alert/Alert#contextObjectID", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.contextObjectID", + "sections": [ + { + "body": "Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).", + "heading": "Description" + } + ], + "signature": "readonly contextObjectID: string | null", + "source": "script-api", + "tags": [ + "contextobjectid", + "alert.contextobjectid" + ], + "title": "Alert.contextObjectID" + }, + { + "description": "Resolves the display message to be shown. It refers to the message resource ID specified in the alert descriptor file (\"message-resource-id\") and the message provided by the 'alerts.properties' resource bundle. When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.", + "id": "script-api:dw/alert/Alert#displayMessage", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.displayMessage", + "sections": [ + { + "body": "Resolves the display message to be shown.\nIt refers to the message resource ID specified in the alert descriptor file (\"message-resource-id\") and the message provided\nby the 'alerts.properties' resource bundle.\nWhen the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.", + "heading": "Description" + } + ], + "signature": "readonly displayMessage: string", + "source": "script-api", + "tags": [ + "displaymessage", + "alert.displaymessage" + ], + "title": "Alert.displayMessage" + }, + { + "description": "Returns the ID of the referenced alert description.", + "id": "script-api:dw/alert/Alert#getAlertDescriptorID", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getAlertDescriptorID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the referenced alert description.", + "heading": "Description" + } + ], + "signature": "getAlertDescriptorID(): string", + "source": "script-api", + "tags": [ + "getalertdescriptorid", + "alert.getalertdescriptorid" + ], + "title": "Alert.getAlertDescriptorID" + }, + { + "description": "Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).", + "id": "script-api:dw/alert/Alert#getContextObjectID", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getContextObjectID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).", + "heading": "Description" + } + ], + "signature": "getContextObjectID(): string | null", + "source": "script-api", + "tags": [ + "getcontextobjectid", + "alert.getcontextobjectid" + ], + "title": "Alert.getContextObjectID" + }, + { + "description": "Resolves the display message to be shown. It refers to the message resource ID specified in the alert descriptor file (\"message-resource-id\") and the message provided by the 'alerts.properties' resource bundle. When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.", + "id": "script-api:dw/alert/Alert#getDisplayMessage", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getDisplayMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Resolves the display message to be shown.\nIt refers to the message resource ID specified in the alert descriptor file (\"message-resource-id\") and the message provided\nby the 'alerts.properties' resource bundle.\nWhen the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.", + "heading": "Description" + } + ], + "signature": "getDisplayMessage(): string", + "source": "script-api", + "tags": [ + "getdisplaymessage", + "alert.getdisplaymessage" + ], + "title": "Alert.getDisplayMessage" + }, + { + "description": "Returns the priority assigned to the message. One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).", + "id": "script-api:dw/alert/Alert#getPriority", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getPriority", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the priority assigned to the message.\nOne of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).", + "heading": "Description" + } + ], + "signature": "getPriority(): string", + "source": "script-api", + "tags": [ + "getpriority", + "alert.getpriority" + ], + "title": "Alert.getPriority" + }, + { + "description": "The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file.", + "id": "script-api:dw/alert/Alert#getRemediationURL", + "kind": "method", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.getRemediationURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The URL of the page where the user can resolve the alert, as provided in the\n'alerts.json' descriptor file.", + "heading": "Description" + } + ], + "signature": "getRemediationURL(): string", + "source": "script-api", + "tags": [ + "getremediationurl", + "alert.getremediationurl" + ], + "title": "Alert.getRemediationURL" + }, + { + "description": "Returns the priority assigned to the message. One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).", + "id": "script-api:dw/alert/Alert#priority", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.priority", + "sections": [ + { + "body": "Returns the priority assigned to the message.\nOne of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).", + "heading": "Description" + } + ], + "signature": "readonly priority: string", + "source": "script-api", + "tags": [ + "priority", + "alert.priority" + ], + "title": "Alert.priority" + }, + { + "description": "The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file.", + "id": "script-api:dw/alert/Alert#remediationURL", + "kind": "property", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert/Alert", + "qualifiedName": "dw.alert.Alert.remediationURL", + "sections": [ + { + "body": "The URL of the page where the user can resolve the alert, as provided in the\n'alerts.json' descriptor file.", + "heading": "Description" + } + ], + "signature": "readonly remediationURL: string", + "source": "script-api", + "tags": [ + "remediationurl", + "alert.remediationurl" + ], + "title": "Alert.remediationURL" + }, + { + "description": "Allow creation, removal, re-validation and retrieval of alerts that might get visible to Business Manager users.", + "examples": [ + "{\n\"alerts\": [\n{\n\"alert-id\": \"missing_org_config\",\n\"menu-action\": \"global-prefs_custom_prefs\",\n\"message-resource-id\": \"global.missing_org_config\",\n\"priority\": \"ACTION\",\n\"remediation\": {\n\"pipeline\":\"GlobalCustomPreferences\",\n\"start-node\":\"View\"\n}\n},\n{\n\"alert-id\":\"promo_in_past\",\n\"menu-action\":\"marketing_promotions\",\n\"context-object-type\":\"Promotion\",\n\"message-resource-id\":\"promotion.in_the_past\",\n\"priority\":\"WARN\",\n\"remediation\": {\n\"pipeline\":\"ViewApplication\",\n\"start-node\":\"BM\",\n\"parameter\":\"screen=Promotion\"\n}\n}\n]\n}" + ], + "id": "script-api:dw/alert/Alerts", + "kind": "class", + "packagePath": "dw/alert", + "parentId": "script-api:dw/alert", + "qualifiedName": "dw.alert.Alerts", + "sections": [ + { + "body": "Allow creation, removal, re-validation and retrieval of alerts that might get visible to Business Manager users.\n\nThe alerts have to be registered by the 'alerts.json' descriptor file in a cartridge assigned to the Business Manager site.\nThe descriptor file itself has to be defined in 'package.json' of that cartridge using a property 'alerts' and providing its path\nthat is relative to the 'package.json'.\nThe 'alert.json' descriptor files contain the 'alert descriptions', which are referenced by their ID throughout the API.\n\nFor example, the 'alerts.json' file could have the following content:\n\n\nThe referenced menu actions can be found in the 'bm_extensions.xml' file of a Business manager extension cartridge\n(a sample file containing all current menu entries is provided when creating a new extension cartridge in Studio).", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "alerts", + "dw.alert.alerts", + "dw/alert" + ], + "title": "Alerts" + }, + { + "description": "Creates a new alert for the given ID. If such an alert already exists, no new one is created, and the existing one is not modified.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID.\nIf such an alert already exists, no new one is created, and the existing one is not modified.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Creates a new alert for the given ID and context object. If such an alert already exists, no new one is created, and the existing one is not modified. Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects. To refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID and context object.\nIf such an alert already exists, no new one is created, and the existing one is not modified.\nMultiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.\nTo refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, contextObject: PersistentObject, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Creates a new alert for the given ID and ID of the context object. If such an alert already exists, no new one is created, and the existing one is not modified. Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects. To refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID and ID of the context object.\nIf such an alert already exists, no new one is created, and the existing one is not modified.\nMultiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.\nTo refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.\n\nUse this method when the alerts refers to an object which is not a PersistentObject.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, contextObjectID: string, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Creates a new alert for the given ID. If such an alert already exists, no new one is created, and the existing one is not modified.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID.\nIf such an alert already exists, no new one is created, and the existing one is not modified.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Creates a new alert for the given ID and context object. If such an alert already exists, no new one is created, and the existing one is not modified. Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects. To refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID and context object.\nIf such an alert already exists, no new one is created, and the existing one is not modified.\nMultiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.\nTo refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, contextObject: PersistentObject, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Creates a new alert for the given ID and ID of the context object. If such an alert already exists, no new one is created, and the existing one is not modified. Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects. To refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.", + "id": "script-api:dw/alert/Alerts#addAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.addAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new alert for the given ID and ID of the context object.\nIf such an alert already exists, no new one is created, and the existing one is not modified.\nMultiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.\nTo refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.\n\nUse this method when the alerts refers to an object which is not a PersistentObject.", + "heading": "Description" + } + ], + "signature": "static addAlert(alertDescriptorID: string, contextObjectID: string, params: string[]): void", + "source": "script-api", + "tags": [ + "addalert", + "alerts.addalert" + ], + "title": "Alerts.addAlert" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID.", + "id": "script-api:dw/alert/Alerts#getAlerts", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlerts", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID.", + "heading": "Description" + } + ], + "signature": "static getAlerts(alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalerts", + "alerts.getalerts" + ], + "title": "Alerts.getAlerts" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID.", + "id": "script-api:dw/alert/Alerts#getAlerts", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlerts", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID.", + "heading": "Description" + } + ], + "signature": "static getAlerts(alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalerts", + "alerts.getalerts" + ], + "title": "Alerts.getAlerts" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID and the given context object ID.", + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID and the given context object ID.", + "heading": "Description" + } + ], + "signature": "static getAlertsForContextObject(contextObjectID: string, alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID and the given context object.", + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID and the given context object.", + "heading": "Description" + } + ], + "signature": "static getAlertsForContextObject(contextObject: PersistentObject, alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID and the given context object ID.", + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID and the given context object ID.", + "heading": "Description" + } + ], + "signature": "static getAlertsForContextObject(contextObjectID: string, alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "description": "Retrieves all alerts for a set of alert descriptor ID and the given context object.", + "id": "script-api:dw/alert/Alerts#getAlertsForContextObject", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "alertDescriptorIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.getAlertsForContextObject", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieves all alerts for a set of alert descriptor ID and the given context object.", + "heading": "Description" + } + ], + "signature": "static getAlertsForContextObject(contextObject: PersistentObject, alertDescriptorIDs?: string[]): List", + "source": "script-api", + "tags": [ + "getalertsforcontextobject", + "alerts.getalertsforcontextobject" + ], + "title": "Alerts.getAlertsForContextObject" + }, + { + "description": "Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing context objects, as long as they reference the same alert description.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing\ncontext objects, as long as they reference the same alert description.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Removes the alert for the given alert description and context object.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the alert for the given alert description and context object.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string, contextObject: PersistentObject): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Removes the alert for the given alert description and context object ID.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObjectID", + "type": "string" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the alert for the given alert description and context object ID.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string, contextObjectID: string): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing context objects, as long as they reference the same alert description.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing\ncontext objects, as long as they reference the same alert description.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Removes the alert for the given alert description and context object.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the alert for the given alert description and context object.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string, contextObject: PersistentObject): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Removes the alert for the given alert description and context object ID.", + "id": "script-api:dw/alert/Alerts#removeAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObjectID", + "type": "string" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.removeAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the alert for the given alert description and context object ID.", + "heading": "Description" + } + ], + "signature": "static removeAlert(alertDescriptorID: string, contextObjectID: string): void", + "source": "script-api", + "tags": [ + "removealert", + "alerts.removealert" + ], + "title": "Alerts.removeAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters.", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert.\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function. The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters.", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function.\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, contextObject: PersistentObject, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. When the optional context object is supplied, it is handed as the only parameter to the process function (if its not supplied, no parameter is given to the function). The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters. Use this variant of the function when the context object is not a persistent object. In this case the ID to be assigned to the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "any" + }, + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert. When the optional\ncontext object is supplied, it is handed as the only parameter to the process function (if its not supplied,\nno parameter is given to the function).\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.\nUse this variant of the function when the context object is not a persistent object. In this case the ID to be assigned\nto the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, contextObject: any, contextObjectID: string, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters.", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert.\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function. The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters.", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "PersistentObject" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function.\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, contextObject: PersistentObject, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "Re-evaluates the process function, and creates or removes the respective alert. When the optional context object is supplied, it is handed as the only parameter to the process function (if its not supplied, no parameter is given to the function). The process function must return true when the alert should be created, and false when it should be removed. When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing alert is updated with the supplied parameters. Use this variant of the function when the context object is not a persistent object. In this case the ID to be assigned to the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)", + "id": "script-api:dw/alert/Alerts#revalidateAlert", + "kind": "method", + "packagePath": "dw/alert", + "params": [ + { + "name": "alertDescriptorID", + "type": "string" + }, + { + "name": "contextObject", + "type": "any" + }, + { + "name": "contextObjectID", + "type": "string" + }, + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "params", + "type": "string[]" + } + ], + "parentId": "script-api:dw/alert/Alerts", + "qualifiedName": "dw.alert.Alerts.revalidateAlert", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Re-evaluates the process function, and creates or removes the respective alert. When the optional\ncontext object is supplied, it is handed as the only parameter to the process function (if its not supplied,\nno parameter is given to the function).\nThe process function must return true when the alert should be created, and false when it should be removed.\nWhen the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing\nalert is updated with the supplied parameters.\nUse this variant of the function when the context object is not a persistent object. In this case the ID to be assigned\nto the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)", + "heading": "Description" + } + ], + "signature": "static revalidateAlert(alertDescriptorID: string, contextObject: any, contextObjectID: string, processFunction: Function, params: string[]): void", + "source": "script-api", + "tags": [ + "revalidatealert", + "alerts.revalidatealert" + ], + "title": "Alerts.revalidateAlert" + }, + { + "description": "31 declarations", + "id": "script-api:dw/campaign", + "kind": "package", + "packagePath": "dw/campaign", + "qualifiedName": "dw.campaign", + "source": "script-api", + "tags": [ + "dw/campaign", + "dw.campaign" + ], + "title": "dw.campaign" + }, + { + "description": "Object representing an AB-test in Commerce Cloud Digital.", + "id": "script-api:dw/campaign/ABTest", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTest", + "sections": [ + { + "body": "Object representing an AB-test in Commerce Cloud Digital.\n\nAB-tests provide the merchant the ability to compare one set of storefront\n\"experiences\" - promotions, sorting rules, and slot configurations in\nparticular - against another set. The merchant configures different AB-test\nsegments which define the sets of experiences that the merchant wishes to\ntest. AB-tests run for a configured period of time, and customers are\nrandomly assigned by the platform to the test segments according to\nallocation percentages defined by the merchant.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "abtest", + "dw.campaign.abtest", + "dw/campaign" + ], + "title": "ABTest" + }, + { + "description": "Get the test ID for this AB-test.", + "id": "script-api:dw/campaign/ABTest#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTest", + "qualifiedName": "dw.campaign.ABTest.ID", + "sections": [ + { + "body": "Get the test ID for this AB-test.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "abtest.id" + ], + "title": "ABTest.ID" + }, + { + "description": "Get the test ID for this AB-test.", + "id": "script-api:dw/campaign/ABTest#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTest", + "qualifiedName": "dw.campaign.ABTest.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the test ID for this AB-test.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "abtest.getid" + ], + "title": "ABTest.getID" + }, + { + "description": "Manager class used to access AB-test information in the storefront.", + "id": "script-api:dw/campaign/ABTestMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTestMgr", + "sections": [ + { + "body": "Manager class used to access AB-test information in the storefront.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "abtestmgr", + "dw.campaign.abtestmgr", + "dw/campaign" + ], + "title": "ABTestMgr" + }, + { + "description": "Return the AB-test segments to which the current customer is assigned. AB-test segments deleted in the meantime will not be returned.", + "id": "script-api:dw/campaign/ABTestMgr#assignedTestSegments", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.assignedTestSegments", + "sections": [ + { + "body": "Return the AB-test segments to which the current customer is assigned.\nAB-test segments deleted in the meantime will not be returned.", + "heading": "Description" + } + ], + "signature": "static readonly assignedTestSegments: Collection", + "source": "script-api", + "tags": [ + "assignedtestsegments", + "abtestmgr.assignedtestsegments" + ], + "title": "ABTestMgr.assignedTestSegments" + }, + { + "description": "Return the AB-test segments to which the current customer is assigned. AB-test segments deleted in the meantime will not be returned.", + "id": "script-api:dw/campaign/ABTestMgr#assignedTestSegments", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.assignedTestSegments", + "sections": [ + { + "body": "Return the AB-test segments to which the current customer is assigned.\nAB-test segments deleted in the meantime will not be returned.", + "heading": "Description" + } + ], + "signature": "static readonly assignedTestSegments: Collection", + "source": "script-api", + "tags": [ + "assignedtestsegments", + "abtestmgr.assignedtestsegments" + ], + "title": "ABTestMgr.assignedTestSegments" + }, + { + "description": "Return the AB-test segments to which the current customer is assigned. AB-test segments deleted in the meantime will not be returned.", + "id": "script-api:dw/campaign/ABTestMgr#getAssignedTestSegments", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.getAssignedTestSegments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Return the AB-test segments to which the current customer is assigned.\nAB-test segments deleted in the meantime will not be returned.", + "heading": "Description" + } + ], + "signature": "static getAssignedTestSegments(): Collection", + "source": "script-api", + "tags": [ + "getassignedtestsegments", + "abtestmgr.getassignedtestsegments" + ], + "title": "ABTestMgr.getAssignedTestSegments" + }, + { + "description": "Return the AB-test segments to which the current customer is assigned. AB-test segments deleted in the meantime will not be returned.", + "id": "script-api:dw/campaign/ABTestMgr#getAssignedTestSegments", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.getAssignedTestSegments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Return the AB-test segments to which the current customer is assigned.\nAB-test segments deleted in the meantime will not be returned.", + "heading": "Description" + } + ], + "signature": "static getAssignedTestSegments(): Collection", + "source": "script-api", + "tags": [ + "getassignedtestsegments", + "abtestmgr.getassignedtestsegments" + ], + "title": "ABTestMgr.getAssignedTestSegments" + }, + { + "description": "Test whether the current customer is a member of the specified AB-test segment. This method can be used to customize the storefront experience in ways that are not supported using Business Manager configuration alone.", + "id": "script-api:dw/campaign/ABTestMgr#isParticipant", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "testID", + "type": "string" + }, + { + "name": "segmentID", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.isParticipant", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Test whether the current customer is a member of the specified AB-test\nsegment. This method can be used to customize the storefront experience\nin ways that are not supported using Business Manager configuration\nalone.", + "heading": "Description" + } + ], + "signature": "static isParticipant(testID: string, segmentID: string): boolean", + "source": "script-api", + "tags": [ + "isparticipant", + "abtestmgr.isparticipant" + ], + "title": "ABTestMgr.isParticipant" + }, + { + "description": "Test whether the current customer is a member of the specified AB-test segment. This method can be used to customize the storefront experience in ways that are not supported using Business Manager configuration alone.", + "id": "script-api:dw/campaign/ABTestMgr#isParticipant", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "testID", + "type": "string" + }, + { + "name": "segmentID", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/ABTestMgr", + "qualifiedName": "dw.campaign.ABTestMgr.isParticipant", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Test whether the current customer is a member of the specified AB-test\nsegment. This method can be used to customize the storefront experience\nin ways that are not supported using Business Manager configuration\nalone.", + "heading": "Description" + } + ], + "signature": "static isParticipant(testID: string, segmentID: string): boolean", + "source": "script-api", + "tags": [ + "isparticipant", + "abtestmgr.isparticipant" + ], + "title": "ABTestMgr.isParticipant" + }, + { + "description": "Object representing an AB-test segment in the Commerce Cloud Digital.", + "id": "script-api:dw/campaign/ABTestSegment", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ABTestSegment", + "sections": [ + { + "body": "Object representing an AB-test segment in the Commerce Cloud Digital.\n\nEach AB-test defines 1 or more segments to which customers are randomly\nassigned by the platform when they qualify for the AB-test. Customers are\nassigned to segments according to allocation percentages controlled by the\nmerchant. Each AB-test segment defines a set of \"experiences\" that the\nmerchant is testing and which which apply only to the customers in that\nsegment. There is always one \"control\" segment which contains only the\ndefault set of experiences for that site.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "abtestsegment", + "dw.campaign.abtestsegment", + "dw/campaign" + ], + "title": "ABTestSegment" + }, + { + "description": "Get the AB-test to which this segment belongs.", + "id": "script-api:dw/campaign/ABTestSegment#ABTest", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.ABTest", + "sections": [ + { + "body": "Get the AB-test to which this segment belongs.", + "heading": "Description" + } + ], + "signature": "readonly ABTest: ABTest", + "source": "script-api", + "tags": [ + "abtest", + "abtestsegment.abtest" + ], + "title": "ABTestSegment.ABTest" + }, + { + "description": "Get the ID of the AB-test segment.", + "id": "script-api:dw/campaign/ABTestSegment#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.ID", + "sections": [ + { + "body": "Get the ID of the AB-test segment.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "abtestsegment.id" + ], + "title": "ABTestSegment.ID" + }, + { + "description": "Returns true if this is the \"control segment\" for the AB-test, meaning the segment that has no experiences associated with it.", + "id": "script-api:dw/campaign/ABTestSegment#controlSegment", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.controlSegment", + "sections": [ + { + "body": "Returns true if this is the \"control segment\" for the AB-test, meaning\nthe segment that has no experiences associated with it.", + "heading": "Description" + } + ], + "signature": "readonly controlSegment: boolean", + "source": "script-api", + "tags": [ + "controlsegment", + "abtestsegment.controlsegment" + ], + "title": "ABTestSegment.controlSegment" + }, + { + "description": "Get the AB-test to which this segment belongs.", + "id": "script-api:dw/campaign/ABTestSegment#getABTest", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.getABTest", + "returns": { + "type": "ABTest" + }, + "sections": [ + { + "body": "Get the AB-test to which this segment belongs.", + "heading": "Description" + } + ], + "signature": "getABTest(): ABTest", + "source": "script-api", + "tags": [ + "getabtest", + "abtestsegment.getabtest" + ], + "title": "ABTestSegment.getABTest" + }, + { + "description": "Get the ID of the AB-test segment.", + "id": "script-api:dw/campaign/ABTestSegment#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the ID of the AB-test segment.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "abtestsegment.getid" + ], + "title": "ABTestSegment.getID" + }, + { + "description": "Returns true if this is the \"control segment\" for the AB-test, meaning the segment that has no experiences associated with it.", + "id": "script-api:dw/campaign/ABTestSegment#isControlSegment", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ABTestSegment", + "qualifiedName": "dw.campaign.ABTestSegment.isControlSegment", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this is the \"control segment\" for the AB-test, meaning\nthe segment that has no experiences associated with it.", + "heading": "Description" + } + ], + "signature": "isControlSegment(): boolean", + "source": "script-api", + "tags": [ + "iscontrolsegment", + "abtestsegment.iscontrolsegment" + ], + "title": "ABTestSegment.isControlSegment" + }, + { + "description": "Represents an amount-off discount in the discount plan, for example \"$10 off all orders $100 or more\".", + "id": "script-api:dw/campaign/AmountDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.AmountDiscount", + "sections": [ + { + "body": "Represents an amount-off discount in the discount plan, for example\n\"$10 off all orders $100 or more\".", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "amountdiscount", + "dw.campaign.amountdiscount", + "dw/campaign" + ], + "title": "AmountDiscount" + }, + { + "description": "Returns the discount amount, for example 10.00 for a \"$10 off\" discount.", + "id": "script-api:dw/campaign/AmountDiscount#amount", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/AmountDiscount", + "qualifiedName": "dw.campaign.AmountDiscount.amount", + "sections": [ + { + "body": "Returns the discount amount, for example 10.00 for a \"$10 off\" discount.", + "heading": "Description" + } + ], + "signature": "readonly amount: number", + "source": "script-api", + "tags": [ + "amount", + "amountdiscount.amount" + ], + "title": "AmountDiscount.amount" + }, + { + "description": "Returns the discount amount, for example 10.00 for a \"$10 off\" discount.", + "id": "script-api:dw/campaign/AmountDiscount#getAmount", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/AmountDiscount", + "qualifiedName": "dw.campaign.AmountDiscount.getAmount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the discount amount, for example 10.00 for a \"$10 off\" discount.", + "heading": "Description" + } + ], + "signature": "getAmount(): number", + "source": "script-api", + "tags": [ + "getamount", + "amountdiscount.getamount" + ], + "title": "AmountDiscount.getAmount" + }, + { + "description": "Transient class representing a discount that a dw.order.LineItemCtnr \"almost\" qualifies for based on the amount of merchandise in it. Storefronts can display information about approaching discounts to customers in order to entice them to buy more merchandise.", + "id": "script-api:dw/campaign/ApproachingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.ApproachingDiscount", + "sections": [ + { + "body": "Transient class representing a discount that a dw.order.LineItemCtnr\n\"almost\" qualifies for based on the amount of merchandise in it. Storefronts\ncan display information about approaching discounts to customers in order to\nentice them to buy more merchandise.\n\nApproaching discounts are calculated on the basis of a\ndw.campaign.DiscountPlan instead of a LineItemCtnr itself. When one\nof dw.campaign.PromotionMgr.getDiscounts or\ndw.campaign.PromotionMgr.getDiscounts is\ncalled, the promotions engine calculates the discounts the LineItemCtnr\nreceives based on the promotions in context, and also tries to determine the\ndiscounts the LineItemCtnr would receive if additional merchandise were\nadded. DiscountPlan provides different methods to retrieve this approaching\ndiscount info. Merchants can use these fine-grained methods to display\ninformation about approaching order discounts on the cart page, and\napproaching shipping discounts on the shipping method page during checkout,\nfor example.\n\nThe merchant may include or exclude individual promotions from being included\nin this list, and define distance thresholds when configuring their\npromotions.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "approachingdiscount", + "dw.campaign.approachingdiscount", + "dw/campaign" + ], + "title": "ApproachingDiscount" + }, + { + "description": "The amount of merchandise required in the cart in order to receive the discount. For an order promotion \"Get 15% off orders of $100 or more\", the condition threshold is $100.00.", + "id": "script-api:dw/campaign/ApproachingDiscount#conditionThreshold", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.conditionThreshold", + "sections": [ + { + "body": "The amount of merchandise required in the cart in order to receive the\ndiscount. For an order promotion \"Get 15% off orders of $100 or more\",\nthe condition threshold is $100.00.", + "heading": "Description" + } + ], + "signature": "readonly conditionThreshold: Money", + "source": "script-api", + "tags": [ + "conditionthreshold", + "approachingdiscount.conditionthreshold" + ], + "title": "ApproachingDiscount.conditionThreshold" + }, + { + "description": "The discount that the customer will receive if he adds more merchandise to the cart. For an order promotion \"Get 15% off orders of $100 or more\", the discount is a PercentageDiscount object.", + "id": "script-api:dw/campaign/ApproachingDiscount#discount", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.discount", + "sections": [ + { + "body": "The discount that the customer will receive if he adds more merchandise\nto the cart. For an order promotion \"Get 15% off orders of $100 or more\",\nthe discount is a PercentageDiscount object.", + "heading": "Description" + } + ], + "signature": "readonly discount: Discount", + "source": "script-api", + "tags": [ + "discount", + "approachingdiscount.discount" + ], + "title": "ApproachingDiscount.discount" + }, + { + "description": "Convenience method that returns `getConditionThreshold().subtract(getMerchandiseValue())`", + "id": "script-api:dw/campaign/ApproachingDiscount#distanceFromConditionThreshold", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.distanceFromConditionThreshold", + "sections": [ + { + "body": "Convenience method that returns\n`getConditionThreshold().subtract(getMerchandiseValue())`", + "heading": "Description" + } + ], + "signature": "readonly distanceFromConditionThreshold: Money", + "source": "script-api", + "tags": [ + "distancefromconditionthreshold", + "approachingdiscount.distancefromconditionthreshold" + ], + "title": "ApproachingDiscount.distanceFromConditionThreshold" + }, + { + "description": "The amount of merchandise required in the cart in order to receive the discount. For an order promotion \"Get 15% off orders of $100 or more\", the condition threshold is $100.00.", + "id": "script-api:dw/campaign/ApproachingDiscount#getConditionThreshold", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getConditionThreshold", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "The amount of merchandise required in the cart in order to receive the\ndiscount. For an order promotion \"Get 15% off orders of $100 or more\",\nthe condition threshold is $100.00.", + "heading": "Description" + } + ], + "signature": "getConditionThreshold(): Money", + "source": "script-api", + "tags": [ + "getconditionthreshold", + "approachingdiscount.getconditionthreshold" + ], + "title": "ApproachingDiscount.getConditionThreshold" + }, + { + "description": "The discount that the customer will receive if he adds more merchandise to the cart. For an order promotion \"Get 15% off orders of $100 or more\", the discount is a PercentageDiscount object.", + "id": "script-api:dw/campaign/ApproachingDiscount#getDiscount", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getDiscount", + "returns": { + "type": "Discount" + }, + "sections": [ + { + "body": "The discount that the customer will receive if he adds more merchandise\nto the cart. For an order promotion \"Get 15% off orders of $100 or more\",\nthe discount is a PercentageDiscount object.", + "heading": "Description" + } + ], + "signature": "getDiscount(): Discount", + "source": "script-api", + "tags": [ + "getdiscount", + "approachingdiscount.getdiscount" + ], + "title": "ApproachingDiscount.getDiscount" + }, + { + "description": "Convenience method that returns `getConditionThreshold().subtract(getMerchandiseValue())`", + "id": "script-api:dw/campaign/ApproachingDiscount#getDistanceFromConditionThreshold", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getDistanceFromConditionThreshold", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Convenience method that returns\n`getConditionThreshold().subtract(getMerchandiseValue())`", + "heading": "Description" + } + ], + "signature": "getDistanceFromConditionThreshold(): Money", + "source": "script-api", + "tags": [ + "getdistancefromconditionthreshold", + "approachingdiscount.getdistancefromconditionthreshold" + ], + "title": "ApproachingDiscount.getDistanceFromConditionThreshold" + }, + { + "description": "The amount of merchandise in the cart contributing towards the condition threshold. This will always be less than the condition threshold.", + "id": "script-api:dw/campaign/ApproachingDiscount#getMerchandiseTotal", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.getMerchandiseTotal", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "The amount of merchandise in the cart contributing towards the condition\nthreshold. This will always be less than the condition threshold.", + "heading": "Description" + } + ], + "signature": "getMerchandiseTotal(): Money", + "source": "script-api", + "tags": [ + "getmerchandisetotal", + "approachingdiscount.getmerchandisetotal" + ], + "title": "ApproachingDiscount.getMerchandiseTotal" + }, + { + "description": "The amount of merchandise in the cart contributing towards the condition threshold. This will always be less than the condition threshold.", + "id": "script-api:dw/campaign/ApproachingDiscount#merchandiseTotal", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/ApproachingDiscount", + "qualifiedName": "dw.campaign.ApproachingDiscount.merchandiseTotal", + "sections": [ + { + "body": "The amount of merchandise in the cart contributing towards the condition\nthreshold. This will always be less than the condition threshold.", + "heading": "Description" + } + ], + "signature": "readonly merchandiseTotal: Money", + "source": "script-api", + "tags": [ + "merchandisetotal", + "approachingdiscount.merchandisetotal" + ], + "title": "ApproachingDiscount.merchandiseTotal" + }, + { + "description": "Represents a choice of bonus products discount in the discount plan, for example \"Choose 3 DVDs from a list of 20 options with your purchase of any DVD player.\"", + "id": "script-api:dw/campaign/BonusChoiceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.BonusChoiceDiscount", + "sections": [ + { + "body": "Represents a choice of bonus products discount in the discount plan,\nfor example \"Choose 3 DVDs from a list of 20 options with your purchase of\nany DVD player.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "bonuschoicediscount", + "dw.campaign.bonuschoicediscount", + "dw/campaign" + ], + "title": "BonusChoiceDiscount" + }, + { + "description": "Get the list of bonus products which the customer is allowed to choose from for this discount. This list is configured by a merchant entering a list of SKUs for the discount. Products which do not exist in the system, or are offline, or are not assigned to a category in the site catalog are filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered out. This allows merchants to display out-of-stock bonus products with appropriate messaging.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#bonusProducts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.bonusProducts", + "sections": [ + { + "body": "Get the list of bonus products which the customer is allowed to choose\nfrom for this discount. This list is configured by a merchant entering a\nlist of SKUs for the discount. Products which do not exist in the system,\nor are offline, or are not assigned to a category in the site catalog are\nfiltered out. Unavailable (i.e. out-of-stock) products are NOT filtered\nout. This allows merchants to display out-of-stock bonus products with\nappropriate messaging.\n\nIf a returned product is a master product, the customer is entitled to\nchoose from any variant. If the product is an option product, the\ncustomer is entitled to choose any value for each option. Since the\npromotions engine does not touch the value of the product option line\nitems, it is the responsibility of custom code to set option prices.\n\nIf the promotion is rule based, then this method will return an empty list.\nA ProductSearchModel should be used to return the bonus products the\ncustomer may choose from instead. See\ndw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and\ndw.catalog.ProductSearchModel.setPromotionID", + "heading": "Description" + } + ], + "signature": "readonly bonusProducts: List>", + "source": "script-api", + "tags": [ + "bonusproducts", + "bonuschoicediscount.bonusproducts" + ], + "title": "BonusChoiceDiscount.bonusProducts" + }, + { + "description": "Get the effective price for the passed bonus product. This is expected to be one of the products returned by getBonusProducts with one exception: If a master product is configured as a bonus product, this implies that a customer may choose from any of its variants. In this case, it is allowed to pass in a variant to this method and a price will be returned. If the passed product is not a valid bonus product, this method throws an exception.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#getBonusProductPrice", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getBonusProductPrice", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Get the effective price for the passed bonus product. This is expected to\nbe one of the products returned by getBonusProducts with one\nexception: If a master product is configured as a bonus product, this\nimplies that a customer may choose from any of its variants. In this\ncase, it is allowed to pass in a variant to this method and a price will\nbe returned. If the passed product is not a valid bonus product, this\nmethod throws an exception.", + "heading": "Description" + } + ], + "signature": "getBonusProductPrice(product: Product): number", + "source": "script-api", + "tags": [ + "getbonusproductprice", + "bonuschoicediscount.getbonusproductprice" + ], + "title": "BonusChoiceDiscount.getBonusProductPrice" + }, + { + "description": "Get the list of bonus products which the customer is allowed to choose from for this discount. This list is configured by a merchant entering a list of SKUs for the discount. Products which do not exist in the system, or are offline, or are not assigned to a category in the site catalog are filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered out. This allows merchants to display out-of-stock bonus products with appropriate messaging.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#getBonusProducts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getBonusProducts", + "returns": { + "type": "List>" + }, + "sections": [ + { + "body": "Get the list of bonus products which the customer is allowed to choose\nfrom for this discount. This list is configured by a merchant entering a\nlist of SKUs for the discount. Products which do not exist in the system,\nor are offline, or are not assigned to a category in the site catalog are\nfiltered out. Unavailable (i.e. out-of-stock) products are NOT filtered\nout. This allows merchants to display out-of-stock bonus products with\nappropriate messaging.\n\nIf a returned product is a master product, the customer is entitled to\nchoose from any variant. If the product is an option product, the\ncustomer is entitled to choose any value for each option. Since the\npromotions engine does not touch the value of the product option line\nitems, it is the responsibility of custom code to set option prices.\n\nIf the promotion is rule based, then this method will return an empty list.\nA ProductSearchModel should be used to return the bonus products the\ncustomer may choose from instead. See\ndw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and\ndw.catalog.ProductSearchModel.setPromotionID", + "heading": "Description" + } + ], + "signature": "getBonusProducts(): List>", + "source": "script-api", + "tags": [ + "getbonusproducts", + "bonuschoicediscount.getbonusproducts" + ], + "title": "BonusChoiceDiscount.getBonusProducts" + }, + { + "description": "Returns the maximum number of bonus items that a customer is entitled to select for this discount.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#getMaxBonusItems", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.getMaxBonusItems", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum number of bonus items that a customer is entitled to\nselect for this discount.", + "heading": "Description" + } + ], + "signature": "getMaxBonusItems(): number", + "source": "script-api", + "tags": [ + "getmaxbonusitems", + "bonuschoicediscount.getmaxbonusitems" + ], + "title": "BonusChoiceDiscount.getMaxBonusItems" + }, + { + "description": "Returns true if this is a \"rule based\" bonus choice discount. For such discounts, there is no static list of bonus products associated with the discount but rather a discounted product rule associated with the promotion which defines the bonus products. To retrieve the list of selectable bonus products for display in the storefront, it is necessary to search for the bonus products using the dw.catalog.ProductSearchModel API since the method getBonusProducts in this class will always return an empty list. Furthermore, for rule based bonus-choice discounts, getBonusProductPrice will always return a price of 0.00 for bonus products.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#isRuleBased", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.isRuleBased", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this is a \"rule based\" bonus choice discount.\nFor such discounts, there is no static list of bonus products\nassociated with the discount but rather a discounted product\nrule associated with the promotion which defines the bonus\nproducts. To retrieve the list of selectable bonus products for\ndisplay in the storefront, it is necessary to search for the\nbonus products using the dw.catalog.ProductSearchModel\nAPI since the method getBonusProducts in this class\nwill always return an empty list. Furthermore, for rule based\nbonus-choice discounts, getBonusProductPrice\nwill always return a price of 0.00 for bonus products.", + "heading": "Description" + } + ], + "signature": "isRuleBased(): boolean", + "source": "script-api", + "tags": [ + "isrulebased", + "bonuschoicediscount.isrulebased" + ], + "title": "BonusChoiceDiscount.isRuleBased" + }, + { + "description": "Returns the maximum number of bonus items that a customer is entitled to select for this discount.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#maxBonusItems", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.maxBonusItems", + "sections": [ + { + "body": "Returns the maximum number of bonus items that a customer is entitled to\nselect for this discount.", + "heading": "Description" + } + ], + "signature": "readonly maxBonusItems: number", + "source": "script-api", + "tags": [ + "maxbonusitems", + "bonuschoicediscount.maxbonusitems" + ], + "title": "BonusChoiceDiscount.maxBonusItems" + }, + { + "description": "Returns true if this is a \"rule based\" bonus choice discount. For such discounts, there is no static list of bonus products associated with the discount but rather a discounted product rule associated with the promotion which defines the bonus products. To retrieve the list of selectable bonus products for display in the storefront, it is necessary to search for the bonus products using the dw.catalog.ProductSearchModel API since the method getBonusProducts in this class will always return an empty list. Furthermore, for rule based bonus-choice discounts, getBonusProductPrice will always return a price of 0.00 for bonus products.", + "id": "script-api:dw/campaign/BonusChoiceDiscount#ruleBased", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusChoiceDiscount", + "qualifiedName": "dw.campaign.BonusChoiceDiscount.ruleBased", + "sections": [ + { + "body": "Returns true if this is a \"rule based\" bonus choice discount.\nFor such discounts, there is no static list of bonus products\nassociated with the discount but rather a discounted product\nrule associated with the promotion which defines the bonus\nproducts. To retrieve the list of selectable bonus products for\ndisplay in the storefront, it is necessary to search for the\nbonus products using the dw.catalog.ProductSearchModel\nAPI since the method getBonusProducts in this class\nwill always return an empty list. Furthermore, for rule based\nbonus-choice discounts, getBonusProductPrice\nwill always return a price of 0.00 for bonus products.", + "heading": "Description" + } + ], + "signature": "readonly ruleBased: boolean", + "source": "script-api", + "tags": [ + "rulebased", + "bonuschoicediscount.rulebased" + ], + "title": "BonusChoiceDiscount.ruleBased" + }, + { + "description": "Represents a bonus discount in the discount plan, for example \"Get a free DVD with your purchase of any DVD player.\"", + "id": "script-api:dw/campaign/BonusDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.BonusDiscount", + "sections": [ + { + "body": "Represents a bonus discount in the discount plan, for example\n\"Get a free DVD with your purchase of any DVD player.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "bonusdiscount", + "dw.campaign.bonusdiscount", + "dw/campaign" + ], + "title": "BonusDiscount" + }, + { + "description": "Returns the bonus products associated with this discount that are in stock, online and assigned to site catalog.", + "id": "script-api:dw/campaign/BonusDiscount#bonusProducts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusDiscount", + "qualifiedName": "dw.campaign.BonusDiscount.bonusProducts", + "sections": [ + { + "body": "Returns the bonus products associated with this discount that are in\nstock, online and assigned to site catalog.", + "heading": "Description" + } + ], + "signature": "readonly bonusProducts: Collection>", + "source": "script-api", + "tags": [ + "bonusproducts", + "bonusdiscount.bonusproducts" + ], + "title": "BonusDiscount.bonusProducts" + }, + { + "description": "Returns the bonus products associated with this discount that are in stock, online and assigned to site catalog.", + "id": "script-api:dw/campaign/BonusDiscount#getBonusProducts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/BonusDiscount", + "qualifiedName": "dw.campaign.BonusDiscount.getBonusProducts", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns the bonus products associated with this discount that are in\nstock, online and assigned to site catalog.", + "heading": "Description" + } + ], + "signature": "getBonusProducts(): Collection>", + "source": "script-api", + "tags": [ + "getbonusproducts", + "bonusdiscount.getbonusproducts" + ], + "title": "BonusDiscount.getBonusProducts" + }, + { + "description": "A Campaign is a set of experiences (or site configurations) which may be deployed as a single unit for a given time frame. The system currently supports 3 types of experience that may be assigned to a campaign:", + "id": "script-api:dw/campaign/Campaign", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Campaign", + "sections": [ + { + "body": "A Campaign is a set of experiences (or site configurations) which may be\ndeployed as a single unit for a given time frame. The system currently\nsupports 3 types of experience that may be assigned to a campaign:\n\n- Promotions\n- Slot Configurations\n- Sorting Rules\n\nThis list may be extended in the future.\n\nA campaign can have a start and end date or be open-ended. It may also have\n\"qualifiers\" which determine which customers the campaign applies to.\nThe currently supported qualifiers are:\n\n- Customer groups (where \"Everyone\" is a possible customer group)\n- Source codes\n- Coupons\n\nA campaign can have list of stores or store groups where it can be applicable to.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "campaign", + "dw.campaign.campaign", + "dw/campaign" + ], + "title": "Campaign" + }, + { + "description": "Returns the unique campaign ID.", + "id": "script-api:dw/campaign/Campaign#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.ID", + "sections": [ + { + "body": "Returns the unique campaign ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "campaign.id" + ], + "title": "Campaign.ID" + }, + { + "description": "Returns 'true' if the campaign is currently active, otherwise 'false'.", + "id": "script-api:dw/campaign/Campaign#active", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.active", + "sections": [ + { + "body": "Returns 'true' if the campaign is currently active, otherwise\n'false'.\n\nA campaign is active if it is enabled and scheduled for now.", + "heading": "Description" + } + ], + "signature": "readonly active: boolean", + "source": "script-api", + "tags": [ + "active", + "campaign.active" + ], + "title": "Campaign.active" + }, + { + "description": "Returns true if campaign is applicable to store, otherwise false.", + "id": "script-api:dw/campaign/Campaign#applicableInStore", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.applicableInStore", + "sections": [ + { + "body": "Returns true if campaign is applicable to store, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly applicableInStore: boolean", + "source": "script-api", + "tags": [ + "applicableinstore", + "campaign.applicableinstore" + ], + "title": "Campaign.applicableInStore" + }, + { + "description": "Returns true if campaign is applicable to online site, otherwise false.", + "id": "script-api:dw/campaign/Campaign#applicableOnline", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.applicableOnline", + "sections": [ + { + "body": "Returns true if campaign is applicable to online site, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly applicableOnline: boolean", + "source": "script-api", + "tags": [ + "applicableonline", + "campaign.applicableonline" + ], + "title": "Campaign.applicableOnline" + }, + { + "description": "Returns the coupons assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.coupons", + "sections": [ + { + "body": "Returns the coupons assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "readonly coupons: Collection", + "source": "script-api", + "tags": [ + "coupons", + "campaign.coupons" + ], + "title": "Campaign.coupons" + }, + { + "description": "Returns the customer groups assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#customerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.customerGroups", + "sections": [ + { + "body": "Returns the customer groups assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "campaign.customergroups" + ], + "title": "Campaign.customerGroups" + }, + { + "description": "Returns the internal description of the campaign.", + "id": "script-api:dw/campaign/Campaign#description", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.description", + "sections": [ + { + "body": "Returns the internal description of the campaign.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "campaign.description" + ], + "title": "Campaign.description" + }, + { + "description": "Returns true if campaign is enabled, otherwise false.", + "id": "script-api:dw/campaign/Campaign#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.enabled", + "sections": [ + { + "body": "Returns true if campaign is enabled, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "campaign.enabled" + ], + "title": "Campaign.enabled" + }, + { + "description": "Returns the end date of the campaign. If no end date is defined for the campaign, null is returned. A campaign w/o end date will run forever.", + "id": "script-api:dw/campaign/Campaign#endDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.endDate", + "sections": [ + { + "body": "Returns the end date of the campaign. If no end date is defined for the\ncampaign, null is returned. A campaign w/o end date will run forever.", + "heading": "Description" + } + ], + "signature": "readonly endDate: Date | null", + "source": "script-api", + "tags": [ + "enddate", + "campaign.enddate" + ], + "title": "Campaign.endDate" + }, + { + "description": "Returns the coupons assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getCoupons", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the coupons assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "getCoupons(): Collection", + "source": "script-api", + "tags": [ + "getcoupons", + "campaign.getcoupons" + ], + "title": "Campaign.getCoupons" + }, + { + "description": "Returns the customer groups assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#getCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "campaign.getcustomergroups" + ], + "title": "Campaign.getCustomerGroups" + }, + { + "description": "Returns the internal description of the campaign.", + "id": "script-api:dw/campaign/Campaign#getDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the internal description of the campaign.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "campaign.getdescription" + ], + "title": "Campaign.getDescription" + }, + { + "description": "Returns the end date of the campaign. If no end date is defined for the campaign, null is returned. A campaign w/o end date will run forever.", + "id": "script-api:dw/campaign/Campaign#getEndDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getEndDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the end date of the campaign. If no end date is defined for the\ncampaign, null is returned. A campaign w/o end date will run forever.", + "heading": "Description" + } + ], + "signature": "getEndDate(): Date | null", + "source": "script-api", + "tags": [ + "getenddate", + "campaign.getenddate" + ], + "title": "Campaign.getEndDate" + }, + { + "description": "Returns the unique campaign ID.", + "id": "script-api:dw/campaign/Campaign#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique campaign ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "campaign.getid" + ], + "title": "Campaign.getID" + }, + { + "description": "Returns promotions defined in this campaign in no particular order.", + "id": "script-api:dw/campaign/Campaign#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns promotions defined in this campaign in no particular order.", + "heading": "Description" + } + ], + "signature": "getPromotions(): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "campaign.getpromotions" + ], + "title": "Campaign.getPromotions" + }, + { + "description": "Returns the source codes assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#getSourceCodeGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getSourceCodeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the source codes assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "getSourceCodeGroups(): Collection", + "source": "script-api", + "tags": [ + "getsourcecodegroups", + "campaign.getsourcecodegroups" + ], + "title": "Campaign.getSourceCodeGroups" + }, + { + "description": "Returns the start date of the campaign. If no start date is defined for the campaign, null is returned. A campaign w/o start date is immediately effective.", + "id": "script-api:dw/campaign/Campaign#getStartDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStartDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the start date of the campaign. If no start date is defined for the\ncampaign, null is returned. A campaign w/o start date is immediately\neffective.", + "heading": "Description" + } + ], + "signature": "getStartDate(): Date | null", + "source": "script-api", + "tags": [ + "getstartdate", + "campaign.getstartdate" + ], + "title": "Campaign.getStartDate" + }, + { + "description": "Returns store groups assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#getStoreGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStoreGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns store groups assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "getStoreGroups(): Collection", + "source": "script-api", + "tags": [ + "getstoregroups", + "campaign.getstoregroups" + ], + "title": "Campaign.getStoreGroups" + }, + { + "description": "Returns stores assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#getStores", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.getStores", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns stores assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "getStores(): Collection", + "source": "script-api", + "tags": [ + "getstores", + "campaign.getstores" + ], + "title": "Campaign.getStores" + }, + { + "description": "Returns 'true' if the campaign is currently active, otherwise 'false'.", + "id": "script-api:dw/campaign/Campaign#isActive", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isActive", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the campaign is currently active, otherwise\n'false'.\n\nA campaign is active if it is enabled and scheduled for now.", + "heading": "Description" + } + ], + "signature": "isActive(): boolean", + "source": "script-api", + "tags": [ + "isactive", + "campaign.isactive" + ], + "title": "Campaign.isActive" + }, + { + "description": "Returns true if campaign is applicable to store, otherwise false.", + "id": "script-api:dw/campaign/Campaign#isApplicableInStore", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isApplicableInStore", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if campaign is applicable to store, otherwise false.", + "heading": "Description" + } + ], + "signature": "isApplicableInStore(): boolean", + "source": "script-api", + "tags": [ + "isapplicableinstore", + "campaign.isapplicableinstore" + ], + "title": "Campaign.isApplicableInStore" + }, + { + "description": "Returns true if campaign is applicable to online site, otherwise false.", + "id": "script-api:dw/campaign/Campaign#isApplicableOnline", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isApplicableOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if campaign is applicable to online site, otherwise false.", + "heading": "Description" + } + ], + "signature": "isApplicableOnline(): boolean", + "source": "script-api", + "tags": [ + "isapplicableonline", + "campaign.isapplicableonline" + ], + "title": "Campaign.isApplicableOnline" + }, + { + "description": "Returns true if campaign is enabled, otherwise false.", + "id": "script-api:dw/campaign/Campaign#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if campaign is enabled, otherwise false.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "campaign.isenabled" + ], + "title": "Campaign.isEnabled" + }, + { + "description": "Returns promotions defined in this campaign in no particular order.", + "id": "script-api:dw/campaign/Campaign#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.promotions", + "sections": [ + { + "body": "Returns promotions defined in this campaign in no particular order.", + "heading": "Description" + } + ], + "signature": "readonly promotions: Collection", + "source": "script-api", + "tags": [ + "promotions", + "campaign.promotions" + ], + "title": "Campaign.promotions" + }, + { + "description": "Returns the source codes assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#sourceCodeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.sourceCodeGroups", + "sections": [ + { + "body": "Returns the source codes assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeGroups: Collection", + "source": "script-api", + "tags": [ + "sourcecodegroups", + "campaign.sourcecodegroups" + ], + "title": "Campaign.sourceCodeGroups" + }, + { + "description": "Returns the start date of the campaign. If no start date is defined for the campaign, null is returned. A campaign w/o start date is immediately effective.", + "id": "script-api:dw/campaign/Campaign#startDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.startDate", + "sections": [ + { + "body": "Returns the start date of the campaign. If no start date is defined for the\ncampaign, null is returned. A campaign w/o start date is immediately\neffective.", + "heading": "Description" + } + ], + "signature": "readonly startDate: Date | null", + "source": "script-api", + "tags": [ + "startdate", + "campaign.startdate" + ], + "title": "Campaign.startDate" + }, + { + "description": "Returns store groups assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#storeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.storeGroups", + "sections": [ + { + "body": "Returns store groups assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "readonly storeGroups: Collection", + "source": "script-api", + "tags": [ + "storegroups", + "campaign.storegroups" + ], + "title": "Campaign.storeGroups" + }, + { + "description": "Returns stores assigned to the campaign.", + "id": "script-api:dw/campaign/Campaign#stores", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Campaign", + "qualifiedName": "dw.campaign.Campaign.stores", + "sections": [ + { + "body": "Returns stores assigned to the campaign.", + "heading": "Description" + } + ], + "signature": "readonly stores: Collection", + "source": "script-api", + "tags": [ + "stores", + "campaign.stores" + ], + "title": "Campaign.stores" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr instead." + }, + "description": "CampaignMgr provides static methods for managing campaign-specific operations such as accessing promotions or updating promotion line items.", + "id": "script-api:dw/campaign/CampaignMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CampaignMgr", + "sections": [ + { + "body": "CampaignMgr provides static methods for managing campaign-specific operations\nsuch as accessing promotions or updating promotion line items.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "campaignmgr", + "dw.campaign.campaignmgr", + "dw/campaign" + ], + "title": "CampaignMgr" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code.", + "id": "script-api:dw/campaign/CampaignMgr#applicablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applicablePromotions", + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code.\n\nNote that this method does not return any coupon-based promotions.", + "heading": "Description" + } + ], + "signature": "static readonly applicablePromotions: Collection", + "source": "script-api", + "tags": [ + "applicablepromotions", + "campaignmgr.applicablepromotions" + ], + "title": "CampaignMgr.applicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code.", + "id": "script-api:dw/campaign/CampaignMgr#applicablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applicablePromotions", + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code.\n\nNote that this method does not return any coupon-based promotions.", + "heading": "Description" + } + ], + "signature": "static readonly applicablePromotions: Collection", + "source": "script-api", + "tags": [ + "applicablepromotions", + "campaignmgr.applicablepromotions" + ], + "title": "CampaignMgr.applicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr instead." + }, + "description": "This method has been deprecated and should not be used anymore. Instead, use dw.campaign.PromotionMgr to apply promotions to line item containers.", + "id": "script-api:dw/campaign/CampaignMgr#applyBonusPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyBonusPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nThe method does nothing, since bonus promotions are applied as product\nor order promotions using methods\napplyProductPromotions and\napplyOrderPromotions.\n\nThe method returns 'true' if any the line item container contains\nany bonus product line items, and otherwise false.", + "heading": "Description" + } + ], + "signature": "static applyBonusPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applybonuspromotions", + "campaignmgr.applybonuspromotions" + ], + "title": "CampaignMgr.applyBonusPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr instead." + }, + "description": "This method has been deprecated and should not be used anymore. Instead, use dw.campaign.PromotionMgr to apply promotions to line item containers.", + "id": "script-api:dw/campaign/CampaignMgr#applyBonusPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyBonusPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nThe method does nothing, since bonus promotions are applied as product\nor order promotions using methods\napplyProductPromotions and\napplyOrderPromotions.\n\nThe method returns 'true' if any the line item container contains\nany bonus product line items, and otherwise false.", + "heading": "Description" + } + ], + "signature": "static applyBonusPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applybonuspromotions", + "campaignmgr.applybonuspromotions" + ], + "title": "CampaignMgr.applyBonusPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies the applicable order promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyOrderPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies the applicable order promotions in the specified collection to the\nspecified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nNote that the method does also apply any bonus discounts defined\nas order promotions (see also applyBonusPromotions).", + "heading": "Description" + } + ], + "signature": "static applyOrderPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyorderpromotions", + "campaignmgr.applyorderpromotions" + ], + "title": "CampaignMgr.applyOrderPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies the applicable order promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyOrderPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies the applicable order promotions in the specified collection to the\nspecified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nNote that the method does also apply any bonus discounts defined\nas order promotions (see also applyBonusPromotions).", + "heading": "Description" + } + ], + "signature": "static applyOrderPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyorderpromotions", + "campaignmgr.applyorderpromotions" + ], + "title": "CampaignMgr.applyOrderPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies all applicable product promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyProductPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies all applicable product promotions in the specified collection to the\nspecified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nNote that the method does also apply any bonus discounts defined\nas product promotions (see also applyBonusPromotions).", + "heading": "Description" + } + ], + "signature": "static applyProductPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyproductpromotions", + "campaignmgr.applyproductpromotions" + ], + "title": "CampaignMgr.applyProductPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies all applicable product promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyProductPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies all applicable product promotions in the specified collection to the\nspecified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.\n\nNote that the method does also apply any bonus discounts defined\nas product promotions (see also applyBonusPromotions).", + "heading": "Description" + } + ], + "signature": "static applyProductPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyproductpromotions", + "campaignmgr.applyproductpromotions" + ], + "title": "CampaignMgr.applyProductPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies all applicable shipping promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyShippingPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies all applicable shipping promotions in the specified collection to\nthe specified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.", + "heading": "Description" + } + ], + "signature": "static applyShippingPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyshippingpromotions", + "campaignmgr.applyshippingpromotions" + ], + "title": "CampaignMgr.applyShippingPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr" + }, + "description": "Applies all applicable shipping promotions in the specified collection to the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#applyShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotions", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.applyShippingPromotions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Applies all applicable shipping promotions in the specified collection to\nthe specified line item container.\n\nThis method has been deprecated and should not be used anymore.\nInstead, use dw.campaign.PromotionMgr to apply promotions to\nline item containers.", + "heading": "Description" + } + ], + "signature": "static applyShippingPromotions(lineItemCtnr: LineItemCtnr, promotions: Collection): boolean", + "source": "script-api", + "tags": [ + "applyshippingpromotions", + "campaignmgr.applyshippingpromotions" + ], + "title": "CampaignMgr.applyShippingPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a qualifiying product.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicableConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicableConditionalPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code for which the specified product\nis a qualifiying product.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getApplicableConditionalPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getApplicableConditionalPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getapplicableconditionalpromotions", + "campaignmgr.getapplicableconditionalpromotions" + ], + "title": "CampaignMgr.getApplicableConditionalPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a qualifiying product.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicableConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicableConditionalPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code for which the specified product\nis a qualifiying product.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getApplicableConditionalPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getApplicableConditionalPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getapplicableconditionalpromotions", + "campaignmgr.getapplicableconditionalpromotions" + ], + "title": "CampaignMgr.getApplicableConditionalPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a discounted product.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code for which the specified product is\na discounted product.\n\nNote that this method does not return any coupon-based promotions.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getApplicablePromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "There is no replacement for this method." + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer, source code and any coupon contained in the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer, source code and any coupon contained in the specified\nline item container.\n\nNote that although the method has been deprecated, no replacement\nmethod is provided.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(lineItemCtnr: LineItemCtnr): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code.\n\nNote that this method does not return any coupon-based promotions.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a discounted product.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code for which the specified product is\na discounted product.\n\nNote that this method does not return any coupon-based promotions.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getApplicablePromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "There is no replacement for this method." + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer, source code and any coupon contained in the specified line item container.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer, source code and any coupon contained in the specified\nline item container.\n\nNote that although the method has been deprecated, no replacement\nmethod is provided.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(lineItemCtnr: LineItemCtnr): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getPromotions" + }, + "description": "Returns the enabled promotions of active campaigns applicable for the current customer and source code.", + "id": "script-api:dw/campaign/CampaignMgr#getApplicablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getApplicablePromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns applicable for the\ncurrent customer and source code.\n\nNote that this method does not return any coupon-based promotions.", + "heading": "Description" + } + ], + "signature": "static getApplicablePromotions(): Collection", + "source": "script-api", + "tags": [ + "getapplicablepromotions", + "campaignmgr.getapplicablepromotions" + ], + "title": "CampaignMgr.getApplicablePromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getCampaign" + }, + "description": "Returns the campaign identified by the specified ID.", + "id": "script-api:dw/campaign/CampaignMgr#getCampaignByID", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getCampaignByID", + "returns": { + "type": "Campaign | null" + }, + "sections": [ + { + "body": "Returns the campaign identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCampaignByID(id: string): Campaign | null", + "source": "script-api", + "tags": [ + "getcampaignbyid", + "campaignmgr.getcampaignbyid" + ], + "title": "CampaignMgr.getCampaignByID" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getCampaign" + }, + "description": "Returns the campaign identified by the specified ID.", + "id": "script-api:dw/campaign/CampaignMgr#getCampaignByID", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getCampaignByID", + "returns": { + "type": "Campaign | null" + }, + "sections": [ + { + "body": "Returns the campaign identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCampaignByID(id: string): Campaign | null", + "source": "script-api", + "tags": [ + "getcampaignbyid", + "campaignmgr.getcampaignbyid" + ], + "title": "CampaignMgr.getCampaignByID" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActivePromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns for which the specified product is a qualifiying product.", + "id": "script-api:dw/campaign/CampaignMgr#getConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getConditionalPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns for which the\nspecified product is a qualifiying product.\n\nNote that the method also returns coupon-based promotions.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getConditionalPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getConditionalPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getconditionalpromotions", + "campaignmgr.getconditionalpromotions" + ], + "title": "CampaignMgr.getConditionalPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActivePromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns for which the specified product is a qualifiying product.", + "id": "script-api:dw/campaign/CampaignMgr#getConditionalPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getConditionalPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns for which the\nspecified product is a qualifiying product.\n\nNote that the method also returns coupon-based promotions.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getConditionalPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getConditionalPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getconditionalpromotions", + "campaignmgr.getconditionalpromotions" + ], + "title": "CampaignMgr.getConditionalPromotions" + }, + { + "deprecated": { + "message": "Coupons are now related to multiple promotions. Method\nreturns the first promotion associated with the coupon\ncode in case of multiple assigned promotions." + }, + "description": "Returns the promotion associated with the specified coupon code.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion associated with the specified coupon code.", + "heading": "Description" + } + ], + "signature": "static getPromotion(couponCode: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "campaignmgr.getpromotion" + ], + "title": "CampaignMgr.getPromotion" + }, + { + "deprecated": { + "message": "Coupons are now related to multiple promotions. Method\nreturns the first promotion associated with the coupon\ncode in case of multiple assigned promotions." + }, + "description": "Returns the promotion associated with the specified coupon code.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion associated with the specified coupon code.", + "heading": "Description" + } + ], + "signature": "static getPromotion(couponCode: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "campaignmgr.getpromotion" + ], + "title": "CampaignMgr.getPromotion" + }, + { + "deprecated": { + "message": "Coupons are now related to multiple promotions. Method\nreturns the first promotion associated with the coupon\nin case of multiple assigned promotions" + }, + "description": "Returns the promotion associated with the specified coupon code.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByCouponCode", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion associated with the specified coupon code.", + "heading": "Description" + } + ], + "signature": "static getPromotionByCouponCode(couponCode: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotionbycouponcode", + "campaignmgr.getpromotionbycouponcode" + ], + "title": "CampaignMgr.getPromotionByCouponCode" + }, + { + "deprecated": { + "message": "Coupons are now related to multiple promotions. Method\nreturns the first promotion associated with the coupon\nin case of multiple assigned promotions" + }, + "description": "Returns the promotion associated with the specified coupon code.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByCouponCode", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion associated with the specified coupon code.", + "heading": "Description" + } + ], + "signature": "static getPromotionByCouponCode(couponCode: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotionbycouponcode", + "campaignmgr.getpromotionbycouponcode" + ], + "title": "CampaignMgr.getPromotionByCouponCode" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getPromotion" + }, + "description": "Returns the promotion identified by the specified ID.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByID", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByID", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getPromotionByID(id: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotionbyid", + "campaignmgr.getpromotionbyid" + ], + "title": "CampaignMgr.getPromotionByID" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getPromotion" + }, + "description": "Returns the promotion identified by the specified ID.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotionByID", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotionByID", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getPromotionByID(id: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotionbyid", + "campaignmgr.getpromotionbyid" + ], + "title": "CampaignMgr.getPromotionByID" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActivePromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns for which the specified product is a discounted product.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns for which the\nspecified product is a discounted product.\n\nNote that method does only return promotions based on customer groups\nor source codes.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "campaignmgr.getpromotions" + ], + "title": "CampaignMgr.getPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.PromotionMgr.getActivePromotions and\ndw.campaign.PromotionPlan.getProductPromotions" + }, + "description": "Returns the enabled promotions of active campaigns for which the specified product is a discounted product.", + "id": "script-api:dw/campaign/CampaignMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/CampaignMgr", + "qualifiedName": "dw.campaign.CampaignMgr.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the enabled promotions of active campaigns for which the\nspecified product is a discounted product.\n\nNote that method does only return promotions based on customer groups\nor source codes.\n\nAs a replacement of this deprecated method, use\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionPlan.getProductPromotions.\nUnlike getPromotions,\ndw.campaign.PromotionPlan.getProductPromotions\nreturns all promotions related to the specified product, regardless\nof whether the product is qualifying, discounted, or both, and\nalso returns promotions where the product is a bonus product.", + "heading": "Description" + } + ], + "signature": "static getPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "campaignmgr.getpromotions" + ], + "title": "CampaignMgr.getPromotions" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes instead." + }, + "description": "Deprecated. Formerly used to contain the various statuses that a coupon may be in.", + "id": "script-api:dw/campaign/CampaignStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CampaignStatusCodes", + "sections": [ + { + "body": "Deprecated. Formerly used to contain the various statuses that a coupon may\nbe in.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "campaignstatuscodes", + "dw.campaign.campaignstatuscodes", + "dw/campaign" + ], + "title": "CampaignStatusCodes" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET,\ndw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET instead." + }, + "description": "Indicates that the coupon has already been applied to the basket.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_APPLIED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_APPLIED", + "sections": [ + { + "body": "Indicates that the coupon has already been applied to the basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_APPLIED = \"COUPON_ALREADY_APPLIED\"", + "source": "script-api", + "tags": [ + "coupon_already_applied", + "campaignstatuscodes.coupon_already_applied" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_APPLIED" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET,\ndw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET instead." + }, + "description": "Indicates that the coupon has already been applied to the basket.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_APPLIED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_APPLIED", + "sections": [ + { + "body": "Indicates that the coupon has already been applied to the basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_APPLIED = \"COUPON_ALREADY_APPLIED\"", + "source": "script-api", + "tags": [ + "coupon_already_applied", + "campaignstatuscodes.coupon_already_applied" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_APPLIED" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED instead." + }, + "description": "Indicates that the coupon has already been redeemed.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_REDEEMED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_REDEEMED", + "sections": [ + { + "body": "Indicates that the coupon has already been redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_REDEEMED = \"COUPON_ALREADY_REDEEMED\"", + "source": "script-api", + "tags": [ + "coupon_already_redeemed", + "campaignstatuscodes.coupon_already_redeemed" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_REDEEMED" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED instead." + }, + "description": "Indicates that the coupon has already been redeemed.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_ALREADY_REDEEMED", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_ALREADY_REDEEMED", + "sections": [ + { + "body": "Indicates that the coupon has already been redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_REDEEMED = \"COUPON_ALREADY_REDEEMED\"", + "source": "script-api", + "tags": [ + "coupon_already_redeemed", + "campaignstatuscodes.coupon_already_redeemed" + ], + "title": "CampaignStatusCodes.COUPON_ALREADY_REDEEMED" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_DISABLED,\ndw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN,\ndw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED,\ndw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED,\ndw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED or\ndw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + "description": "Indicates that the coupon is not currently redeemable.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_NOT_REDEEMABLE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_NOT_REDEEMABLE", + "sections": [ + { + "body": "Indicates that the coupon is not currently redeemable.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_NOT_REDEEMABLE = \"COUPON_NOT_REDEEMABLE\"", + "source": "script-api", + "tags": [ + "coupon_not_redeemable", + "campaignstatuscodes.coupon_not_redeemable" + ], + "title": "CampaignStatusCodes.COUPON_NOT_REDEEMABLE" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_DISABLED,\ndw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN,\ndw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED,\ndw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED,\ndw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED or\ndw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + "description": "Indicates that the coupon is not currently redeemable.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_NOT_REDEEMABLE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_NOT_REDEEMABLE", + "sections": [ + { + "body": "Indicates that the coupon is not currently redeemable.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_NOT_REDEEMABLE = \"COUPON_NOT_REDEEMABLE\"", + "source": "script-api", + "tags": [ + "coupon_not_redeemable", + "campaignstatuscodes.coupon_not_redeemable" + ], + "title": "CampaignStatusCodes.COUPON_NOT_REDEEMABLE" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN instead" + }, + "description": "Indicates that the coupon code is not valid.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_UNKNOWN", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_UNKNOWN", + "sections": [ + { + "body": "Indicates that the coupon code is not valid.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_UNKNOWN = \"COUPON_UNKNOWN\"", + "source": "script-api", + "tags": [ + "coupon_unknown", + "campaignstatuscodes.coupon_unknown" + ], + "title": "CampaignStatusCodes.COUPON_UNKNOWN" + }, + { + "deprecated": { + "message": "Use dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN instead" + }, + "description": "Indicates that the coupon code is not valid.", + "id": "script-api:dw/campaign/CampaignStatusCodes#COUPON_UNKNOWN", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CampaignStatusCodes", + "qualifiedName": "dw.campaign.CampaignStatusCodes.COUPON_UNKNOWN", + "sections": [ + { + "body": "Indicates that the coupon code is not valid.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_UNKNOWN = \"COUPON_UNKNOWN\"", + "source": "script-api", + "tags": [ + "coupon_unknown", + "campaignstatuscodes.coupon_unknown" + ], + "title": "CampaignStatusCodes.COUPON_UNKNOWN" + }, + { + "description": "Represents a coupon in Commerce Cloud Digital.", + "id": "script-api:dw/campaign/Coupon", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Coupon", + "sections": [ + { + "body": "Represents a coupon in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "coupon", + "dw.campaign.coupon", + "dw/campaign" + ], + "title": "Coupon" + }, + { + "description": "Returns the ID of the coupon.", + "id": "script-api:dw/campaign/Coupon#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.ID", + "sections": [ + { + "body": "Returns the ID of the coupon.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "coupon.id" + ], + "title": "Coupon.ID" + }, + { + "description": "Constant representing coupon type multiple-codes.", + "id": "script-api:dw/campaign/Coupon#TYPE_MULTIPLE_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_MULTIPLE_CODES", + "sections": [ + { + "body": "Constant representing coupon type multiple-codes.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_MULTIPLE_CODES: string", + "source": "script-api", + "tags": [ + "type_multiple_codes", + "coupon.type_multiple_codes" + ], + "title": "Coupon.TYPE_MULTIPLE_CODES" + }, + { + "description": "Constant representing coupon type multiple-codes.", + "id": "script-api:dw/campaign/Coupon#TYPE_MULTIPLE_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_MULTIPLE_CODES", + "sections": [ + { + "body": "Constant representing coupon type multiple-codes.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_MULTIPLE_CODES: string", + "source": "script-api", + "tags": [ + "type_multiple_codes", + "coupon.type_multiple_codes" + ], + "title": "Coupon.TYPE_MULTIPLE_CODES" + }, + { + "description": "Constant representing coupon type single-code.", + "id": "script-api:dw/campaign/Coupon#TYPE_SINGLE_CODE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SINGLE_CODE", + "sections": [ + { + "body": "Constant representing coupon type single-code.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SINGLE_CODE: string", + "source": "script-api", + "tags": [ + "type_single_code", + "coupon.type_single_code" + ], + "title": "Coupon.TYPE_SINGLE_CODE" + }, + { + "description": "Constant representing coupon type single-code.", + "id": "script-api:dw/campaign/Coupon#TYPE_SINGLE_CODE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SINGLE_CODE", + "sections": [ + { + "body": "Constant representing coupon type single-code.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SINGLE_CODE: string", + "source": "script-api", + "tags": [ + "type_single_code", + "coupon.type_single_code" + ], + "title": "Coupon.TYPE_SINGLE_CODE" + }, + { + "description": "Constant representing coupon type system-codes.", + "id": "script-api:dw/campaign/Coupon#TYPE_SYSTEM_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SYSTEM_CODES", + "sections": [ + { + "body": "Constant representing coupon type system-codes.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SYSTEM_CODES: string", + "source": "script-api", + "tags": [ + "type_system_codes", + "coupon.type_system_codes" + ], + "title": "Coupon.TYPE_SYSTEM_CODES" + }, + { + "description": "Constant representing coupon type system-codes.", + "id": "script-api:dw/campaign/Coupon#TYPE_SYSTEM_CODES", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.TYPE_SYSTEM_CODES", + "sections": [ + { + "body": "Constant representing coupon type system-codes.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SYSTEM_CODES: string", + "source": "script-api", + "tags": [ + "type_system_codes", + "coupon.type_system_codes" + ], + "title": "Coupon.TYPE_SYSTEM_CODES" + }, + { + "description": "Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES If no prefix is defined, or coupon is of type TYPE_SINGLE_CODE or TYPE_MULTIPLE_CODES, null is returned.", + "id": "script-api:dw/campaign/Coupon#codePrefix", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.codePrefix", + "sections": [ + { + "body": "Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES\nIf no prefix is defined, or coupon is of type TYPE_SINGLE_CODE\nor TYPE_MULTIPLE_CODES, null is returned.", + "heading": "Description" + } + ], + "signature": "readonly codePrefix: string | null", + "source": "script-api", + "tags": [ + "codeprefix", + "coupon.codeprefix" + ], + "title": "Coupon.codePrefix" + }, + { + "description": "Returns true if coupon is enabled, else false.", + "id": "script-api:dw/campaign/Coupon#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.enabled", + "sections": [ + { + "body": "Returns true if coupon is enabled, else false.", + "heading": "Description" + } + ], + "signature": "readonly enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "coupon.enabled" + ], + "title": "Coupon.enabled" + }, + { + "description": "Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES If no prefix is defined, or coupon is of type TYPE_SINGLE_CODE or TYPE_MULTIPLE_CODES, null is returned.", + "id": "script-api:dw/campaign/Coupon#getCodePrefix", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getCodePrefix", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES\nIf no prefix is defined, or coupon is of type TYPE_SINGLE_CODE\nor TYPE_MULTIPLE_CODES, null is returned.", + "heading": "Description" + } + ], + "signature": "getCodePrefix(): string | null", + "source": "script-api", + "tags": [ + "getcodeprefix", + "coupon.getcodeprefix" + ], + "title": "Coupon.getCodePrefix" + }, + { + "description": "Returns the ID of the coupon.", + "id": "script-api:dw/campaign/Coupon#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the coupon.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "coupon.getid" + ], + "title": "Coupon.getID" + }, + { + "description": "Returns the next unissued code of this coupon. For single-code coupons, the single fixed coupon code is returned. For all multi-code coupons, the next available, unissued coupon code is returned. If all codes of the coupon have been issued, then there is no next code, and null is returned.", + "id": "script-api:dw/campaign/Coupon#getNextCouponCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getNextCouponCode", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the next unissued code of this coupon.\nFor single-code coupons, the single fixed coupon code is returned.\nFor all multi-code coupons, the next available, unissued coupon code is returned.\nIf all codes of the coupon have been issued, then there is no next code, and null is returned.\n\nA transaction is required when calling this method. This needs to be ensured by the calling script.", + "heading": "Description" + } + ], + "signature": "getNextCouponCode(): string | null", + "source": "script-api", + "tags": [ + "getnextcouponcode", + "coupon.getnextcouponcode" + ], + "title": "Coupon.getNextCouponCode" + }, + { + "description": "Returns the coupon-based promotions directly or indirectly (through campaigns) assigned to this coupon.", + "id": "script-api:dw/campaign/Coupon#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the coupon-based promotions directly or indirectly (through\ncampaigns) assigned to this coupon.", + "heading": "Description" + } + ], + "signature": "getPromotions(): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "coupon.getpromotions" + ], + "title": "Coupon.getPromotions" + }, + { + "description": "Returns the defined limit on redemption per coupon code. Null is returned if no limit is defined, which means that each code can be redeemed an unlimited number of times.", + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the defined limit on redemption per coupon code. Null is\nreturned if no limit is defined, which means that each code can be\nredeemed an unlimited number of times.", + "heading": "Description" + } + ], + "signature": "getRedemptionLimitPerCode(): number", + "source": "script-api", + "tags": [ + "getredemptionlimitpercode", + "coupon.getredemptionlimitpercode" + ], + "title": "Coupon.getRedemptionLimitPerCode" + }, + { + "description": "Returns the defined limit on redemption of this coupon per customer. Null is returned if no limit is defined, which means that customers can redeem this coupon an unlimited number of times.", + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerCustomer", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerCustomer", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the defined limit on redemption of this coupon per customer.\nNull is returned if no limit is defined, which means that customers can\nredeem this coupon an unlimited number of times.", + "heading": "Description" + } + ], + "signature": "getRedemptionLimitPerCustomer(): number", + "source": "script-api", + "tags": [ + "getredemptionlimitpercustomer", + "coupon.getredemptionlimitpercustomer" + ], + "title": "Coupon.getRedemptionLimitPerCustomer" + }, + { + "description": "Returns the defined limit on redemption per customer per time-frame (see getRedemptionLimitTimeFrame. Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.", + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitPerTimeFrame", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitPerTimeFrame", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the defined limit on redemption per customer per time-frame (see\ngetRedemptionLimitTimeFrame. Null is returned if no limit is\ndefined, which means that there is no time-specific redemption limit for\ncustomers.", + "heading": "Description" + } + ], + "signature": "getRedemptionLimitPerTimeFrame(): number", + "source": "script-api", + "tags": [ + "getredemptionlimitpertimeframe", + "coupon.getredemptionlimitpertimeframe" + ], + "title": "Coupon.getRedemptionLimitPerTimeFrame" + }, + { + "description": "Returns the time-frame (in days) of the defined limit on redemption per customer per time-frame. Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.", + "id": "script-api:dw/campaign/Coupon#getRedemptionLimitTimeFrame", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getRedemptionLimitTimeFrame", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the time-frame (in days) of the defined limit on redemption per\ncustomer per time-frame. Null is returned if no limit is defined, which\nmeans that there is no time-specific redemption limit for customers.", + "heading": "Description" + } + ], + "signature": "getRedemptionLimitTimeFrame(): number", + "source": "script-api", + "tags": [ + "getredemptionlimittimeframe", + "coupon.getredemptionlimittimeframe" + ], + "title": "Coupon.getRedemptionLimitTimeFrame" + }, + { + "description": "Returns the coupon type. Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES and TYPE_SYSTEM_CODES.", + "id": "script-api:dw/campaign/Coupon#getType", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the coupon type.\nPossible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES\nand TYPE_SYSTEM_CODES.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "coupon.gettype" + ], + "title": "Coupon.getType" + }, + { + "description": "Returns true if coupon is enabled, else false.", + "id": "script-api:dw/campaign/Coupon#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if coupon is enabled, else false.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "coupon.isenabled" + ], + "title": "Coupon.isEnabled" + }, + { + "description": "Returns the next unissued code of this coupon. For single-code coupons, the single fixed coupon code is returned. For all multi-code coupons, the next available, unissued coupon code is returned. If all codes of the coupon have been issued, then there is no next code, and null is returned.", + "id": "script-api:dw/campaign/Coupon#nextCouponCode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.nextCouponCode", + "sections": [ + { + "body": "Returns the next unissued code of this coupon.\nFor single-code coupons, the single fixed coupon code is returned.\nFor all multi-code coupons, the next available, unissued coupon code is returned.\nIf all codes of the coupon have been issued, then there is no next code, and null is returned.\n\nA transaction is required when calling this method. This needs to be ensured by the calling script.", + "heading": "Description" + } + ], + "signature": "readonly nextCouponCode: string | null", + "source": "script-api", + "tags": [ + "nextcouponcode", + "coupon.nextcouponcode" + ], + "title": "Coupon.nextCouponCode" + }, + { + "description": "Returns the coupon-based promotions directly or indirectly (through campaigns) assigned to this coupon.", + "id": "script-api:dw/campaign/Coupon#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.promotions", + "sections": [ + { + "body": "Returns the coupon-based promotions directly or indirectly (through\ncampaigns) assigned to this coupon.", + "heading": "Description" + } + ], + "signature": "readonly promotions: Collection", + "source": "script-api", + "tags": [ + "promotions", + "coupon.promotions" + ], + "title": "Coupon.promotions" + }, + { + "description": "Returns the defined limit on redemption per coupon code. Null is returned if no limit is defined, which means that each code can be redeemed an unlimited number of times.", + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerCode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerCode", + "sections": [ + { + "body": "Returns the defined limit on redemption per coupon code. Null is\nreturned if no limit is defined, which means that each code can be\nredeemed an unlimited number of times.", + "heading": "Description" + } + ], + "signature": "readonly redemptionLimitPerCode: number", + "source": "script-api", + "tags": [ + "redemptionlimitpercode", + "coupon.redemptionlimitpercode" + ], + "title": "Coupon.redemptionLimitPerCode" + }, + { + "description": "Returns the defined limit on redemption of this coupon per customer. Null is returned if no limit is defined, which means that customers can redeem this coupon an unlimited number of times.", + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerCustomer", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerCustomer", + "sections": [ + { + "body": "Returns the defined limit on redemption of this coupon per customer.\nNull is returned if no limit is defined, which means that customers can\nredeem this coupon an unlimited number of times.", + "heading": "Description" + } + ], + "signature": "readonly redemptionLimitPerCustomer: number", + "source": "script-api", + "tags": [ + "redemptionlimitpercustomer", + "coupon.redemptionlimitpercustomer" + ], + "title": "Coupon.redemptionLimitPerCustomer" + }, + { + "description": "Returns the defined limit on redemption per customer per time-frame (see getRedemptionLimitTimeFrame. Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.", + "id": "script-api:dw/campaign/Coupon#redemptionLimitPerTimeFrame", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitPerTimeFrame", + "sections": [ + { + "body": "Returns the defined limit on redemption per customer per time-frame (see\ngetRedemptionLimitTimeFrame. Null is returned if no limit is\ndefined, which means that there is no time-specific redemption limit for\ncustomers.", + "heading": "Description" + } + ], + "signature": "readonly redemptionLimitPerTimeFrame: number", + "source": "script-api", + "tags": [ + "redemptionlimitpertimeframe", + "coupon.redemptionlimitpertimeframe" + ], + "title": "Coupon.redemptionLimitPerTimeFrame" + }, + { + "description": "Returns the time-frame (in days) of the defined limit on redemption per customer per time-frame. Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.", + "id": "script-api:dw/campaign/Coupon#redemptionLimitTimeFrame", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.redemptionLimitTimeFrame", + "sections": [ + { + "body": "Returns the time-frame (in days) of the defined limit on redemption per\ncustomer per time-frame. Null is returned if no limit is defined, which\nmeans that there is no time-specific redemption limit for customers.", + "heading": "Description" + } + ], + "signature": "readonly redemptionLimitTimeFrame: number", + "source": "script-api", + "tags": [ + "redemptionlimittimeframe", + "coupon.redemptionlimittimeframe" + ], + "title": "Coupon.redemptionLimitTimeFrame" + }, + { + "description": "Returns the coupon type. Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES and TYPE_SYSTEM_CODES.", + "id": "script-api:dw/campaign/Coupon#type", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Coupon", + "qualifiedName": "dw.campaign.Coupon.type", + "sections": [ + { + "body": "Returns the coupon type.\nPossible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES\nand TYPE_SYSTEM_CODES.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "coupon.type" + ], + "title": "Coupon.type" + }, + { + "description": "Manager to access coupons.", + "id": "script-api:dw/campaign/CouponMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponMgr", + "sections": [ + { + "body": "Manager to access coupons.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "couponmgr", + "dw.campaign.couponmgr", + "dw/campaign" + ], + "title": "CouponMgr" + }, + { + "description": "Indicates that an error occurred because a valid data domain cannot be found for given siteID.", + "id": "script-api:dw/campaign/CouponMgr#MR_ERROR_INVALID_SITE_ID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.MR_ERROR_INVALID_SITE_ID", + "sections": [ + { + "body": "Indicates that an error occurred because a valid data domain cannot be found for given siteID.", + "heading": "Description" + } + ], + "signature": "static readonly MR_ERROR_INVALID_SITE_ID = \"MASKREDEMPTIONS_SITE_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "mr_error_invalid_site_id", + "couponmgr.mr_error_invalid_site_id" + ], + "title": "CouponMgr.MR_ERROR_INVALID_SITE_ID" + }, + { + "description": "Indicates that an error occurred because a valid data domain cannot be found for given siteID.", + "id": "script-api:dw/campaign/CouponMgr#MR_ERROR_INVALID_SITE_ID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.MR_ERROR_INVALID_SITE_ID", + "sections": [ + { + "body": "Indicates that an error occurred because a valid data domain cannot be found for given siteID.", + "heading": "Description" + } + ], + "signature": "static readonly MR_ERROR_INVALID_SITE_ID = \"MASKREDEMPTIONS_SITE_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "mr_error_invalid_site_id", + "couponmgr.mr_error_invalid_site_id" + ], + "title": "CouponMgr.MR_ERROR_INVALID_SITE_ID" + }, + { + "description": "Returns all coupons in the current site in no specific order.", + "id": "script-api:dw/campaign/CouponMgr#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.coupons", + "sections": [ + { + "body": "Returns all coupons in the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly coupons: Collection", + "source": "script-api", + "tags": [ + "coupons", + "couponmgr.coupons" + ], + "title": "CouponMgr.coupons" + }, + { + "description": "Returns all coupons in the current site in no specific order.", + "id": "script-api:dw/campaign/CouponMgr#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.coupons", + "sections": [ + { + "body": "Returns all coupons in the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly coupons: Collection", + "source": "script-api", + "tags": [ + "coupons", + "couponmgr.coupons" + ], + "title": "CouponMgr.coupons" + }, + { + "description": "Returns the coupon with the specified ID.", + "id": "script-api:dw/campaign/CouponMgr#getCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponID", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupon", + "returns": { + "type": "Coupon | null" + }, + "sections": [ + { + "body": "Returns the coupon with the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCoupon(couponID: string): Coupon | null", + "source": "script-api", + "tags": [ + "getcoupon", + "couponmgr.getcoupon" + ], + "title": "CouponMgr.getCoupon" + }, + { + "description": "Returns the coupon with the specified ID.", + "id": "script-api:dw/campaign/CouponMgr#getCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponID", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupon", + "returns": { + "type": "Coupon | null" + }, + "sections": [ + { + "body": "Returns the coupon with the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCoupon(couponID: string): Coupon | null", + "source": "script-api", + "tags": [ + "getcoupon", + "couponmgr.getcoupon" + ], + "title": "CouponMgr.getCoupon" + }, + { + "description": "Tries to find a coupon for the given coupon code. The method first searches for a coupon with a fixed code matching the passed value. If no such fixed coupon is found, it searches for a coupon with a system-generated code matching the passed value. If found, the coupon is returned. Otherwise, the method returns null.", + "id": "script-api:dw/campaign/CouponMgr#getCouponByCode", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCouponByCode", + "returns": { + "type": "Coupon | null" + }, + "sections": [ + { + "body": "Tries to find a coupon for the given coupon code. The method first\nsearches for a coupon with a fixed code matching the passed value. If no\nsuch fixed coupon is found, it searches for a coupon with a\nsystem-generated code matching the passed value. If found, the coupon is\nreturned. Otherwise, the method returns null.", + "heading": "Description" + } + ], + "signature": "static getCouponByCode(couponCode: string): Coupon | null", + "source": "script-api", + "tags": [ + "getcouponbycode", + "couponmgr.getcouponbycode" + ], + "title": "CouponMgr.getCouponByCode" + }, + { + "description": "Tries to find a coupon for the given coupon code. The method first searches for a coupon with a fixed code matching the passed value. If no such fixed coupon is found, it searches for a coupon with a system-generated code matching the passed value. If found, the coupon is returned. Otherwise, the method returns null.", + "id": "script-api:dw/campaign/CouponMgr#getCouponByCode", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCouponByCode", + "returns": { + "type": "Coupon | null" + }, + "sections": [ + { + "body": "Tries to find a coupon for the given coupon code. The method first\nsearches for a coupon with a fixed code matching the passed value. If no\nsuch fixed coupon is found, it searches for a coupon with a\nsystem-generated code matching the passed value. If found, the coupon is\nreturned. Otherwise, the method returns null.", + "heading": "Description" + } + ], + "signature": "static getCouponByCode(couponCode: string): Coupon | null", + "source": "script-api", + "tags": [ + "getcouponbycode", + "couponmgr.getcouponbycode" + ], + "title": "CouponMgr.getCouponByCode" + }, + { + "description": "Returns all coupons in the current site in no specific order.", + "id": "script-api:dw/campaign/CouponMgr#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupons", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all coupons in the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getCoupons(): Collection", + "source": "script-api", + "tags": [ + "getcoupons", + "couponmgr.getcoupons" + ], + "title": "CouponMgr.getCoupons" + }, + { + "description": "Returns all coupons in the current site in no specific order.", + "id": "script-api:dw/campaign/CouponMgr#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getCoupons", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all coupons in the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getCoupons(): Collection", + "source": "script-api", + "tags": [ + "getcoupons", + "couponmgr.getcoupons" + ], + "title": "CouponMgr.getCoupons" + }, + { + "description": "Returns list of CouponRedemptions for the specified coupon and coupon code, sorted by redemption date descending (i.e. last redemption first). Usually, there should only either be 0 or 1 redemption. But if a coupon and code is removed and recreated and re-issued later, there might be multiple such redemption records. Returns an empty list if no redemption record exists in system for the specified coupon and code.", + "id": "script-api:dw/campaign/CouponMgr#getRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponID", + "type": "string" + }, + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getRedemptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns list of CouponRedemptions for the specified coupon and coupon code,\nsorted by redemption date descending (i.e. last redemption first).\nUsually, there should only either be 0 or 1 redemption. But if a coupon and code\nis removed and recreated and re-issued later, there might be multiple such redemption records.\nReturns an empty list if no redemption record exists in system for the specified coupon and code.", + "heading": "Description" + } + ], + "signature": "static getRedemptions(couponID: string, couponCode: string): Collection", + "source": "script-api", + "tags": [ + "getredemptions", + "couponmgr.getredemptions" + ], + "title": "CouponMgr.getRedemptions" + }, + { + "description": "Returns list of CouponRedemptions for the specified coupon and coupon code, sorted by redemption date descending (i.e. last redemption first). Usually, there should only either be 0 or 1 redemption. But if a coupon and code is removed and recreated and re-issued later, there might be multiple such redemption records. Returns an empty list if no redemption record exists in system for the specified coupon and code.", + "id": "script-api:dw/campaign/CouponMgr#getRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "couponID", + "type": "string" + }, + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.getRedemptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns list of CouponRedemptions for the specified coupon and coupon code,\nsorted by redemption date descending (i.e. last redemption first).\nUsually, there should only either be 0 or 1 redemption. But if a coupon and code\nis removed and recreated and re-issued later, there might be multiple such redemption records.\nReturns an empty list if no redemption record exists in system for the specified coupon and code.", + "heading": "Description" + } + ], + "signature": "static getRedemptions(couponID: string, couponCode: string): Collection", + "source": "script-api", + "tags": [ + "getredemptions", + "couponmgr.getredemptions" + ], + "title": "CouponMgr.getRedemptions" + }, + { + "description": "Mask customer email address in coupon redemptions for the given siteID and email address", + "id": "script-api:dw/campaign/CouponMgr#maskRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "siteID", + "type": "string" + }, + { + "name": "email", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.maskRedemptions", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Mask customer email address in coupon redemptions for the given siteID and email address", + "heading": "Description" + } + ], + "signature": "static maskRedemptions(siteID: string, email: string): Status", + "source": "script-api", + "tags": [ + "maskredemptions", + "couponmgr.maskredemptions" + ], + "title": "CouponMgr.maskRedemptions" + }, + { + "description": "Mask customer email address in coupon redemptions for the given siteID and email address", + "id": "script-api:dw/campaign/CouponMgr#maskRedemptions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "siteID", + "type": "string" + }, + { + "name": "email", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/CouponMgr", + "qualifiedName": "dw.campaign.CouponMgr.maskRedemptions", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Mask customer email address in coupon redemptions for the given siteID and email address", + "heading": "Description" + } + ], + "signature": "static maskRedemptions(siteID: string, email: string): Status", + "source": "script-api", + "tags": [ + "maskredemptions", + "couponmgr.maskredemptions" + ], + "title": "CouponMgr.maskRedemptions" + }, + { + "description": "Represents a redeemed coupon.", + "id": "script-api:dw/campaign/CouponRedemption", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponRedemption", + "sections": [ + { + "body": "Represents a redeemed coupon.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "couponredemption", + "dw.campaign.couponredemption", + "dw/campaign" + ], + "title": "CouponRedemption" + }, + { + "description": "Returns email of redeeming customer.", + "id": "script-api:dw/campaign/CouponRedemption#customerEmail", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.customerEmail", + "sections": [ + { + "body": "Returns email of redeeming customer.", + "heading": "Description" + } + ], + "signature": "readonly customerEmail: string", + "source": "script-api", + "tags": [ + "customeremail", + "couponredemption.customeremail" + ], + "title": "CouponRedemption.customerEmail" + }, + { + "description": "Returns email of redeeming customer.", + "id": "script-api:dw/campaign/CouponRedemption#getCustomerEmail", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getCustomerEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns email of redeeming customer.", + "heading": "Description" + } + ], + "signature": "getCustomerEmail(): string", + "source": "script-api", + "tags": [ + "getcustomeremail", + "couponredemption.getcustomeremail" + ], + "title": "CouponRedemption.getCustomerEmail" + }, + { + "description": "Returns number of the order the code was redeemed with.", + "id": "script-api:dw/campaign/CouponRedemption#getOrderNo", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns number of the order the code was redeemed with.", + "heading": "Description" + } + ], + "signature": "getOrderNo(): string", + "source": "script-api", + "tags": [ + "getorderno", + "couponredemption.getorderno" + ], + "title": "CouponRedemption.getOrderNo" + }, + { + "description": "Returns date of redemption.", + "id": "script-api:dw/campaign/CouponRedemption#getRedemptionDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.getRedemptionDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns date of redemption.", + "heading": "Description" + } + ], + "signature": "getRedemptionDate(): Date", + "source": "script-api", + "tags": [ + "getredemptiondate", + "couponredemption.getredemptiondate" + ], + "title": "CouponRedemption.getRedemptionDate" + }, + { + "description": "Returns number of the order the code was redeemed with.", + "id": "script-api:dw/campaign/CouponRedemption#orderNo", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.orderNo", + "sections": [ + { + "body": "Returns number of the order the code was redeemed with.", + "heading": "Description" + } + ], + "signature": "readonly orderNo: string", + "source": "script-api", + "tags": [ + "orderno", + "couponredemption.orderno" + ], + "title": "CouponRedemption.orderNo" + }, + { + "description": "Returns date of redemption.", + "id": "script-api:dw/campaign/CouponRedemption#redemptionDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponRedemption", + "qualifiedName": "dw.campaign.CouponRedemption.redemptionDate", + "sections": [ + { + "body": "Returns date of redemption.", + "heading": "Description" + } + ], + "signature": "readonly redemptionDate: Date", + "source": "script-api", + "tags": [ + "redemptiondate", + "couponredemption.redemptiondate" + ], + "title": "CouponRedemption.redemptionDate" + }, + { + "description": "Helper class containing status codes for why a coupon code cannot be added to cart or why a coupon code already in cart is not longer valid for redemption.", + "id": "script-api:dw/campaign/CouponStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.CouponStatusCodes", + "sections": [ + { + "body": "Helper class containing status codes for why a coupon code cannot be added\nto cart or why a coupon code already in cart is not longer valid for redemption.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "couponstatuscodes", + "dw.campaign.couponstatuscodes", + "dw/campaign" + ], + "title": "CouponStatusCodes" + }, + { + "description": "Coupon is currently applied in basket = Coupon code is valid for redemption and Coupon is assigned to one or multiple applicable promotions.", + "id": "script-api:dw/campaign/CouponStatusCodes#APPLIED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.APPLIED", + "sections": [ + { + "body": "Coupon is currently applied in basket = Coupon code is valid for redemption and\nCoupon is assigned to one or multiple applicable promotions.", + "heading": "Description" + } + ], + "signature": "static readonly APPLIED: string", + "source": "script-api", + "tags": [ + "applied", + "couponstatuscodes.applied" + ], + "title": "CouponStatusCodes.APPLIED" + }, + { + "description": "Coupon is currently applied in basket = Coupon code is valid for redemption and Coupon is assigned to one or multiple applicable promotions.", + "id": "script-api:dw/campaign/CouponStatusCodes#APPLIED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.APPLIED", + "sections": [ + { + "body": "Coupon is currently applied in basket = Coupon code is valid for redemption and\nCoupon is assigned to one or multiple applicable promotions.", + "heading": "Description" + } + ], + "signature": "static readonly APPLIED: string", + "source": "script-api", + "tags": [ + "applied", + "couponstatuscodes.applied" + ], + "title": "CouponStatusCodes.APPLIED" + }, + { + "description": "Indicates that another code of the same MultiCode/System coupon has already been added to basket.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET", + "sections": [ + { + "body": "Indicates that another code of the same MultiCode/System coupon has already been added to basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_IN_BASKET: string", + "source": "script-api", + "tags": [ + "coupon_already_in_basket", + "couponstatuscodes.coupon_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_ALREADY_IN_BASKET" + }, + { + "description": "Indicates that another code of the same MultiCode/System coupon has already been added to basket.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET", + "sections": [ + { + "body": "Indicates that another code of the same MultiCode/System coupon has already been added to basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_ALREADY_IN_BASKET: string", + "source": "script-api", + "tags": [ + "coupon_already_in_basket", + "couponstatuscodes.coupon_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_ALREADY_IN_BASKET" + }, + { + "description": "Indicates that coupon code has already been added to basket.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET", + "sections": [ + { + "body": "Indicates that coupon code has already been added to basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_ALREADY_IN_BASKET: string", + "source": "script-api", + "tags": [ + "coupon_code_already_in_basket", + "couponstatuscodes.coupon_code_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET" + }, + { + "description": "Indicates that coupon code has already been added to basket.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_IN_BASKET", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET", + "sections": [ + { + "body": "Indicates that coupon code has already been added to basket.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_ALREADY_IN_BASKET: string", + "source": "script-api", + "tags": [ + "coupon_code_already_in_basket", + "couponstatuscodes.coupon_code_already_in_basket" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET" + }, + { + "description": "Indicates that code of MultiCode/System coupon has already been redeemed.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_REDEEMED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED", + "sections": [ + { + "body": "Indicates that code of MultiCode/System coupon has already been redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_ALREADY_REDEEMED: string", + "source": "script-api", + "tags": [ + "coupon_code_already_redeemed", + "couponstatuscodes.coupon_code_already_redeemed" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED" + }, + { + "description": "Indicates that code of MultiCode/System coupon has already been redeemed.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_ALREADY_REDEEMED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED", + "sections": [ + { + "body": "Indicates that code of MultiCode/System coupon has already been redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_ALREADY_REDEEMED: string", + "source": "script-api", + "tags": [ + "coupon_code_already_redeemed", + "couponstatuscodes.coupon_code_already_redeemed" + ], + "title": "CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED" + }, + { + "description": "Indicates that coupon not found for given coupon code or that the code itself was not found.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_UNKNOWN", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN", + "sections": [ + { + "body": "Indicates that coupon not found for given coupon code or that the code itself was not found.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_UNKNOWN: string", + "source": "script-api", + "tags": [ + "coupon_code_unknown", + "couponstatuscodes.coupon_code_unknown" + ], + "title": "CouponStatusCodes.COUPON_CODE_UNKNOWN" + }, + { + "description": "Indicates that coupon not found for given coupon code or that the code itself was not found.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_CODE_UNKNOWN", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN", + "sections": [ + { + "body": "Indicates that coupon not found for given coupon code or that the code itself was not found.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODE_UNKNOWN: string", + "source": "script-api", + "tags": [ + "coupon_code_unknown", + "couponstatuscodes.coupon_code_unknown" + ], + "title": "CouponStatusCodes.COUPON_CODE_UNKNOWN" + }, + { + "description": "Indicates that coupon is not enabled.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_DISABLED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_DISABLED", + "sections": [ + { + "body": "Indicates that coupon is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_DISABLED: string", + "source": "script-api", + "tags": [ + "coupon_disabled", + "couponstatuscodes.coupon_disabled" + ], + "title": "CouponStatusCodes.COUPON_DISABLED" + }, + { + "description": "Indicates that coupon is not enabled.", + "id": "script-api:dw/campaign/CouponStatusCodes#COUPON_DISABLED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.COUPON_DISABLED", + "sections": [ + { + "body": "Indicates that coupon is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_DISABLED: string", + "source": "script-api", + "tags": [ + "coupon_disabled", + "couponstatuscodes.coupon_disabled" + ], + "title": "CouponStatusCodes.COUPON_DISABLED" + }, + { + "description": "Indicates that No. of redemptions per code & customer exceeded.", + "id": "script-api:dw/campaign/CouponStatusCodes#CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that No. of redemptions per code & customer exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "customer_redemption_limit_exceeded", + "couponstatuscodes.customer_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that No. of redemptions per code & customer exceeded.", + "id": "script-api:dw/campaign/CouponStatusCodes#CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that No. of redemptions per code & customer exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "customer_redemption_limit_exceeded", + "couponstatuscodes.customer_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that coupon is not assigned to an active promotion.", + "id": "script-api:dw/campaign/CouponStatusCodes#NO_ACTIVE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION", + "sections": [ + { + "body": "Indicates that coupon is not assigned to an active promotion.", + "heading": "Description" + } + ], + "signature": "static readonly NO_ACTIVE_PROMOTION: string", + "source": "script-api", + "tags": [ + "no_active_promotion", + "couponstatuscodes.no_active_promotion" + ], + "title": "CouponStatusCodes.NO_ACTIVE_PROMOTION" + }, + { + "description": "Indicates that coupon is not assigned to an active promotion.", + "id": "script-api:dw/campaign/CouponStatusCodes#NO_ACTIVE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION", + "sections": [ + { + "body": "Indicates that coupon is not assigned to an active promotion.", + "heading": "Description" + } + ], + "signature": "static readonly NO_ACTIVE_PROMOTION: string", + "source": "script-api", + "tags": [ + "no_active_promotion", + "couponstatuscodes.no_active_promotion" + ], + "title": "CouponStatusCodes.NO_ACTIVE_PROMOTION" + }, + { + "description": "Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.", + "id": "script-api:dw/campaign/CouponStatusCodes#NO_APPLICABLE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "sections": [ + { + "body": "Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.", + "heading": "Description" + } + ], + "signature": "static readonly NO_APPLICABLE_PROMOTION: string", + "source": "script-api", + "tags": [ + "no_applicable_promotion", + "couponstatuscodes.no_applicable_promotion" + ], + "title": "CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + { + "description": "Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.", + "id": "script-api:dw/campaign/CouponStatusCodes#NO_APPLICABLE_PROMOTION", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "sections": [ + { + "body": "Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.", + "heading": "Description" + } + ], + "signature": "static readonly NO_APPLICABLE_PROMOTION: string", + "source": "script-api", + "tags": [ + "no_applicable_promotion", + "couponstatuscodes.no_applicable_promotion" + ], + "title": "CouponStatusCodes.NO_APPLICABLE_PROMOTION" + }, + { + "description": "Indicates that no. of redemptions per code exceeded. Usually happens for single code coupons", + "id": "script-api:dw/campaign/CouponStatusCodes#REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that no. of redemptions per code exceeded.\nUsually happens for single code coupons", + "heading": "Description" + } + ], + "signature": "static readonly REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "redemption_limit_exceeded", + "couponstatuscodes.redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that no. of redemptions per code exceeded. Usually happens for single code coupons", + "id": "script-api:dw/campaign/CouponStatusCodes#REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that no. of redemptions per code exceeded.\nUsually happens for single code coupons", + "heading": "Description" + } + ], + "signature": "static readonly REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "redemption_limit_exceeded", + "couponstatuscodes.redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that No. of redemptions per code,customer & time exceeded.", + "id": "script-api:dw/campaign/CouponStatusCodes#TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that No. of redemptions per code,customer & time exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "timeframe_redemption_limit_exceeded", + "couponstatuscodes.timeframe_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that No. of redemptions per code,customer & time exceeded.", + "id": "script-api:dw/campaign/CouponStatusCodes#TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/CouponStatusCodes", + "qualifiedName": "dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that No. of redemptions per code,customer & time exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED: string", + "source": "script-api", + "tags": [ + "timeframe_redemption_limit_exceeded", + "couponstatuscodes.timeframe_redemption_limit_exceeded" + ], + "title": "CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED" + }, + { + "description": "Superclass of all specific discount classes.", + "id": "script-api:dw/campaign/Discount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Discount", + "sections": [ + { + "body": "Superclass of all specific discount classes.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "discount", + "dw.campaign.discount", + "dw/campaign" + ], + "title": "Discount" + }, + { + "description": "Constant representing discounts of type amount.", + "id": "script-api:dw/campaign/Discount#TYPE_AMOUNT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_AMOUNT", + "sections": [ + { + "body": "Constant representing discounts of type amount.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AMOUNT: string", + "source": "script-api", + "tags": [ + "type_amount", + "discount.type_amount" + ], + "title": "Discount.TYPE_AMOUNT" + }, + { + "description": "Constant representing discounts of type amount.", + "id": "script-api:dw/campaign/Discount#TYPE_AMOUNT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_AMOUNT", + "sections": [ + { + "body": "Constant representing discounts of type amount.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AMOUNT: string", + "source": "script-api", + "tags": [ + "type_amount", + "discount.type_amount" + ], + "title": "Discount.TYPE_AMOUNT" + }, + { + "description": "Constant representing discounts of type bonus.", + "id": "script-api:dw/campaign/Discount#TYPE_BONUS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS", + "sections": [ + { + "body": "Constant representing discounts of type bonus.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BONUS: string", + "source": "script-api", + "tags": [ + "type_bonus", + "discount.type_bonus" + ], + "title": "Discount.TYPE_BONUS" + }, + { + "description": "Constant representing discounts of type bonus.", + "id": "script-api:dw/campaign/Discount#TYPE_BONUS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS", + "sections": [ + { + "body": "Constant representing discounts of type bonus.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BONUS: string", + "source": "script-api", + "tags": [ + "type_bonus", + "discount.type_bonus" + ], + "title": "Discount.TYPE_BONUS" + }, + { + "description": "Constant representing discounts of type bonus choice.", + "id": "script-api:dw/campaign/Discount#TYPE_BONUS_CHOICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS_CHOICE", + "sections": [ + { + "body": "Constant representing discounts of type bonus choice.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BONUS_CHOICE: string", + "source": "script-api", + "tags": [ + "type_bonus_choice", + "discount.type_bonus_choice" + ], + "title": "Discount.TYPE_BONUS_CHOICE" + }, + { + "description": "Constant representing discounts of type bonus choice.", + "id": "script-api:dw/campaign/Discount#TYPE_BONUS_CHOICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_BONUS_CHOICE", + "sections": [ + { + "body": "Constant representing discounts of type bonus choice.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BONUS_CHOICE: string", + "source": "script-api", + "tags": [ + "type_bonus_choice", + "discount.type_bonus_choice" + ], + "title": "Discount.TYPE_BONUS_CHOICE" + }, + { + "description": "Constant representing discounts of type fixed-price.", + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type fixed-price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FIXED_PRICE: string", + "source": "script-api", + "tags": [ + "type_fixed_price", + "discount.type_fixed_price" + ], + "title": "Discount.TYPE_FIXED_PRICE" + }, + { + "description": "Constant representing discounts of type fixed-price.", + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type fixed-price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FIXED_PRICE: string", + "source": "script-api", + "tags": [ + "type_fixed_price", + "discount.type_fixed_price" + ], + "title": "Discount.TYPE_FIXED_PRICE" + }, + { + "description": "Constant representing discounts of type fixed price shipping.", + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE_SHIPPING", + "sections": [ + { + "body": "Constant representing discounts of type fixed price shipping.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FIXED_PRICE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_fixed_price_shipping", + "discount.type_fixed_price_shipping" + ], + "title": "Discount.TYPE_FIXED_PRICE_SHIPPING" + }, + { + "description": "Constant representing discounts of type fixed price shipping.", + "id": "script-api:dw/campaign/Discount#TYPE_FIXED_PRICE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FIXED_PRICE_SHIPPING", + "sections": [ + { + "body": "Constant representing discounts of type fixed price shipping.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FIXED_PRICE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_fixed_price_shipping", + "discount.type_fixed_price_shipping" + ], + "title": "Discount.TYPE_FIXED_PRICE_SHIPPING" + }, + { + "description": "Constant representing discounts of type free.", + "id": "script-api:dw/campaign/Discount#TYPE_FREE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE", + "sections": [ + { + "body": "Constant representing discounts of type free.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FREE: string", + "source": "script-api", + "tags": [ + "type_free", + "discount.type_free" + ], + "title": "Discount.TYPE_FREE" + }, + { + "description": "Constant representing discounts of type free.", + "id": "script-api:dw/campaign/Discount#TYPE_FREE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE", + "sections": [ + { + "body": "Constant representing discounts of type free.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FREE: string", + "source": "script-api", + "tags": [ + "type_free", + "discount.type_free" + ], + "title": "Discount.TYPE_FREE" + }, + { + "description": "Constant representing discounts of type free shipping.", + "id": "script-api:dw/campaign/Discount#TYPE_FREE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE_SHIPPING", + "sections": [ + { + "body": "Constant representing discounts of type free shipping.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FREE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_free_shipping", + "discount.type_free_shipping" + ], + "title": "Discount.TYPE_FREE_SHIPPING" + }, + { + "description": "Constant representing discounts of type free shipping.", + "id": "script-api:dw/campaign/Discount#TYPE_FREE_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_FREE_SHIPPING", + "sections": [ + { + "body": "Constant representing discounts of type free shipping.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_FREE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_free_shipping", + "discount.type_free_shipping" + ], + "title": "Discount.TYPE_FREE_SHIPPING" + }, + { + "description": "Constant representing discounts of type percentage.", + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE", + "sections": [ + { + "body": "Constant representing discounts of type percentage.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PERCENTAGE: string", + "source": "script-api", + "tags": [ + "type_percentage", + "discount.type_percentage" + ], + "title": "Discount.TYPE_PERCENTAGE" + }, + { + "description": "Constant representing discounts of type percentage.", + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE", + "sections": [ + { + "body": "Constant representing discounts of type percentage.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PERCENTAGE: string", + "source": "script-api", + "tags": [ + "type_percentage", + "discount.type_percentage" + ], + "title": "Discount.TYPE_PERCENTAGE" + }, + { + "description": "Constant representing discounts of type percent off options.", + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE_OFF_OPTIONS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE_OFF_OPTIONS", + "sections": [ + { + "body": "Constant representing discounts of type percent off options.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PERCENTAGE_OFF_OPTIONS: string", + "source": "script-api", + "tags": [ + "type_percentage_off_options", + "discount.type_percentage_off_options" + ], + "title": "Discount.TYPE_PERCENTAGE_OFF_OPTIONS" + }, + { + "description": "Constant representing discounts of type percent off options.", + "id": "script-api:dw/campaign/Discount#TYPE_PERCENTAGE_OFF_OPTIONS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PERCENTAGE_OFF_OPTIONS", + "sections": [ + { + "body": "Constant representing discounts of type percent off options.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PERCENTAGE_OFF_OPTIONS: string", + "source": "script-api", + "tags": [ + "type_percentage_off_options", + "discount.type_percentage_off_options" + ], + "title": "Discount.TYPE_PERCENTAGE_OFF_OPTIONS" + }, + { + "description": "Constant representing discounts of type price book price.", + "id": "script-api:dw/campaign/Discount#TYPE_PRICEBOOK_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PRICEBOOK_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type price book price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRICEBOOK_PRICE: string", + "source": "script-api", + "tags": [ + "type_pricebook_price", + "discount.type_pricebook_price" + ], + "title": "Discount.TYPE_PRICEBOOK_PRICE" + }, + { + "description": "Constant representing discounts of type price book price.", + "id": "script-api:dw/campaign/Discount#TYPE_PRICEBOOK_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_PRICEBOOK_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type price book price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRICEBOOK_PRICE: string", + "source": "script-api", + "tags": [ + "type_pricebook_price", + "discount.type_pricebook_price" + ], + "title": "Discount.TYPE_PRICEBOOK_PRICE" + }, + { + "description": "Constant representing discounts of type total fixed price.", + "id": "script-api:dw/campaign/Discount#TYPE_TOTAL_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_TOTAL_FIXED_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type total fixed price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_TOTAL_FIXED_PRICE: string", + "source": "script-api", + "tags": [ + "type_total_fixed_price", + "discount.type_total_fixed_price" + ], + "title": "Discount.TYPE_TOTAL_FIXED_PRICE" + }, + { + "description": "Constant representing discounts of type total fixed price.", + "id": "script-api:dw/campaign/Discount#TYPE_TOTAL_FIXED_PRICE", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.TYPE_TOTAL_FIXED_PRICE", + "sections": [ + { + "body": "Constant representing discounts of type total fixed price.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_TOTAL_FIXED_PRICE: string", + "source": "script-api", + "tags": [ + "type_total_fixed_price", + "discount.type_total_fixed_price" + ], + "title": "Discount.TYPE_TOTAL_FIXED_PRICE" + }, + { + "description": "Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but not all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is indexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that quantity index to the index of tier of the promotion that item received. For more information about tier indexes, see getPromotionTier method.", + "id": "script-api:dw/campaign/Discount#getItemPromotionTiers", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getItemPromotionTiers", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but\nnot all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is\nindexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that\nquantity index to the index of tier of the promotion that item received. For more information about tier indexes,\nsee getPromotionTier method.", + "heading": "Description" + } + ], + "signature": "getItemPromotionTiers(): utilMap", + "source": "script-api", + "tags": [ + "getitempromotiontiers", + "discount.getitempromotiontiers" + ], + "title": "Discount.getItemPromotionTiers" + }, + { + "description": "Returns the promotion this discount is based on.", + "id": "script-api:dw/campaign/Discount#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getPromotion", + "returns": { + "type": "Promotion" + }, + "sections": [ + { + "body": "Returns the promotion this discount is based on.", + "heading": "Description" + } + ], + "signature": "getPromotion(): Promotion", + "source": "script-api", + "tags": [ + "getpromotion", + "discount.getpromotion" + ], + "title": "Discount.getPromotion" + }, + { + "description": "Returns the tier index for promotion at order level or bonus product. Promotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount) to the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0, the next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.", + "id": "script-api:dw/campaign/Discount#getPromotionTier", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getPromotionTier", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the tier index for promotion at order level or bonus product.\nPromotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount)\nto the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0,\nthe next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.", + "heading": "Description" + } + ], + "signature": "getPromotionTier(): number", + "source": "script-api", + "tags": [ + "getpromotiontier", + "discount.getpromotiontier" + ], + "title": "Discount.getPromotionTier" + }, + { + "description": "Returns the quantity of the discount. This quantity specifies how often this discount applies to its target object. For example, a 10% off discount with quantity 2 associated to a product line item with quantity 3 is applied to two items of the product line item.", + "id": "script-api:dw/campaign/Discount#getQuantity", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getQuantity", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the quantity of the discount. This quantity specifies how often\nthis discount applies to its target object. For example, a 10% off\ndiscount with quantity 2 associated to a product line item with\nquantity 3 is applied to two items of the product line item.\n\nDiscounts of order and shipping promotions, and bonus discounts\nhave a fix quantity of 1.", + "heading": "Description" + } + ], + "signature": "getQuantity(): number", + "source": "script-api", + "tags": [ + "getquantity", + "discount.getquantity" + ], + "title": "Discount.getQuantity" + }, + { + "description": "Returns the type of the discount.", + "id": "script-api:dw/campaign/Discount#getType", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the discount.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "discount.gettype" + ], + "title": "Discount.getType" + }, + { + "description": "Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but not all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is indexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that quantity index to the index of tier of the promotion that item received. For more information about tier indexes, see getPromotionTier method.", + "id": "script-api:dw/campaign/Discount#itemPromotionTiers", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.itemPromotionTiers", + "sections": [ + { + "body": "Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but\nnot all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is\nindexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that\nquantity index to the index of tier of the promotion that item received. For more information about tier indexes,\nsee getPromotionTier method.", + "heading": "Description" + } + ], + "signature": "readonly itemPromotionTiers: utilMap", + "source": "script-api", + "tags": [ + "itempromotiontiers", + "discount.itempromotiontiers" + ], + "title": "Discount.itemPromotionTiers" + }, + { + "description": "Returns the promotion this discount is based on.", + "id": "script-api:dw/campaign/Discount#promotion", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.promotion", + "sections": [ + { + "body": "Returns the promotion this discount is based on.", + "heading": "Description" + } + ], + "signature": "readonly promotion: Promotion", + "source": "script-api", + "tags": [ + "promotion", + "discount.promotion" + ], + "title": "Discount.promotion" + }, + { + "description": "Returns the tier index for promotion at order level or bonus product. Promotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount) to the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0, the next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.", + "id": "script-api:dw/campaign/Discount#promotionTier", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.promotionTier", + "sections": [ + { + "body": "Returns the tier index for promotion at order level or bonus product.\nPromotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount)\nto the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0,\nthe next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.", + "heading": "Description" + } + ], + "signature": "readonly promotionTier: number", + "source": "script-api", + "tags": [ + "promotiontier", + "discount.promotiontier" + ], + "title": "Discount.promotionTier" + }, + { + "description": "Returns the quantity of the discount. This quantity specifies how often this discount applies to its target object. For example, a 10% off discount with quantity 2 associated to a product line item with quantity 3 is applied to two items of the product line item.", + "id": "script-api:dw/campaign/Discount#quantity", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.quantity", + "sections": [ + { + "body": "Returns the quantity of the discount. This quantity specifies how often\nthis discount applies to its target object. For example, a 10% off\ndiscount with quantity 2 associated to a product line item with\nquantity 3 is applied to two items of the product line item.\n\nDiscounts of order and shipping promotions, and bonus discounts\nhave a fix quantity of 1.", + "heading": "Description" + } + ], + "signature": "readonly quantity: number", + "source": "script-api", + "tags": [ + "quantity", + "discount.quantity" + ], + "title": "Discount.quantity" + }, + { + "description": "Returns the type of the discount.", + "id": "script-api:dw/campaign/Discount#type", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Discount", + "qualifiedName": "dw.campaign.Discount.type", + "sections": [ + { + "body": "Returns the type of the discount.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "discount.type" + ], + "title": "Discount.type" + }, + { + "description": "DiscountPlan represents a set of dw.campaign.Discounts. Instances of the class are returned by the dw.campaign.PromotionMgr when requesting applicable discounts for a specified set of promotions and a line item container (see dw.campaign.PromotionMgr.getDiscounts).", + "id": "script-api:dw/campaign/DiscountPlan", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.DiscountPlan", + "sections": [ + { + "body": "DiscountPlan represents a set of dw.campaign.Discounts. Instances of the class are\nreturned by the dw.campaign.PromotionMgr when requesting applicable discounts\nfor a specified set of promotions and a line item container\n(see dw.campaign.PromotionMgr.getDiscounts).\n\nDiscountPlan provides methods to access the discounts contained in the plan,\nadd additional discounts to the plan (future) or remove discounts from the plan.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "discountplan", + "dw.campaign.discountplan", + "dw/campaign" + ], + "title": "DiscountPlan" + }, + { + "description": "Get the collection of order discounts that the LineItemCtnr \"almost\" qualifies for based on the merchandise total in the cart. Nearness is controlled by thresholds configured at the promotion level.", + "id": "script-api:dw/campaign/DiscountPlan#approachingOrderDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.approachingOrderDiscounts", + "sections": [ + { + "body": "Get the collection of order discounts that the LineItemCtnr \"almost\"\nqualifies for based on the merchandise total in the cart. Nearness is\ncontrolled by thresholds configured at the promotion level.\n\nThe collection of returned approaching discounts is ordered by the\ncondition threshold of the promotion (e.g. \"spend $100 and get 10% off\"\ndiscount is returned before \"spend $150 and get 15% off\" discount.) A\ndiscount is not returned if it would be prevented from applying (because\nof compatibility rules) by an order discount already in the DiscountPlan\nor an approaching order discount with a lower condition threshold.", + "heading": "Description" + } + ], + "signature": "readonly approachingOrderDiscounts: Collection", + "source": "script-api", + "tags": [ + "approachingorderdiscounts", + "discountplan.approachingorderdiscounts" + ], + "title": "DiscountPlan.approachingOrderDiscounts" + }, + { + "description": "Returns all bonus discounts contained in the discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#bonusDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.bonusDiscounts", + "sections": [ + { + "body": "Returns all bonus discounts contained in the discount plan.", + "heading": "Description" + } + ], + "signature": "readonly bonusDiscounts: Collection", + "source": "script-api", + "tags": [ + "bonusdiscounts", + "discountplan.bonusdiscounts" + ], + "title": "DiscountPlan.bonusDiscounts" + }, + { + "description": "Get the collection of order discounts that the LineItemCtnr \"almost\" qualifies for based on the merchandise total in the cart. Nearness is controlled by thresholds configured at the promotion level.", + "id": "script-api:dw/campaign/DiscountPlan#getApproachingOrderDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingOrderDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Get the collection of order discounts that the LineItemCtnr \"almost\"\nqualifies for based on the merchandise total in the cart. Nearness is\ncontrolled by thresholds configured at the promotion level.\n\nThe collection of returned approaching discounts is ordered by the\ncondition threshold of the promotion (e.g. \"spend $100 and get 10% off\"\ndiscount is returned before \"spend $150 and get 15% off\" discount.) A\ndiscount is not returned if it would be prevented from applying (because\nof compatibility rules) by an order discount already in the DiscountPlan\nor an approaching order discount with a lower condition threshold.", + "heading": "Description" + } + ], + "signature": "getApproachingOrderDiscounts(): Collection", + "source": "script-api", + "tags": [ + "getapproachingorderdiscounts", + "discountplan.getapproachingorderdiscounts" + ], + "title": "DiscountPlan.getApproachingOrderDiscounts" + }, + { + "description": "Get the collection of shipping discounts that the passed shipment \"almost\" qualifies for based on the merchandise total in the shipment. Nearness is controlled by thresholds configured at the promotion level.", + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Get the collection of shipping discounts that the passed shipment\n\"almost\" qualifies for based on the merchandise total in the shipment.\nNearness is controlled by thresholds configured at the promotion level.\n\nThe collection of returned approaching discounts is ordered by the\ncondition threshold of the promotion (e.g.\n\"spend $100 and get free standard shipping\" discount is returned before\n\"spend $150 and get free standard shipping\" discount.) A discount is not\nreturned if it would be prevented from applying (because of compatibility\nrules) by a shipping discount already in the DiscountPlan or an\napproaching shipping discount with a lower condition threshold.", + "heading": "Description" + } + ], + "signature": "getApproachingShippingDiscounts(shipment: Shipment): Collection", + "source": "script-api", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "description": "Get the collection of shipping discounts that the passed shipment \"almost\" qualifies for based on the merchandise total in the shipment. Here \"almost\" is controlled by thresholds configured at the promotion level.", + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "shippingMethod", + "type": "ShippingMethod" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Get the collection of shipping discounts that the passed shipment\n\"almost\" qualifies for based on the merchandise total in the shipment.\nHere \"almost\" is controlled by thresholds configured at the promotion\nlevel.\n\nThis method only returns discounts for shipping promotions which apply to\nthe passed shipping method.\n\nThe collection of returned approaching discounts is ordered by the\ncondition threshold of the promotion (e.g.\n\"spend $100 and get free standard shipping\" discount is returned before\n\"spend $150 and get free standard shipping\" discount.) A discount is not\nreturned if it would be prevented from applying (because of compatibility\nrules) by a shipping discount already in the DiscountPlan or an\napproaching shipping discount with a lower condition threshold.", + "heading": "Description" + } + ], + "signature": "getApproachingShippingDiscounts(shipment: Shipment, shippingMethod: ShippingMethod): Collection", + "source": "script-api", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "description": "Get the collection of shipping discounts that the passed shipment \"almost\" qualifies for based on the merchandise total in the shipment. Here \"almost\" is controlled by thresholds configured at the promotion level.", + "id": "script-api:dw/campaign/DiscountPlan#getApproachingShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "shippingMethods", + "type": "Collection" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getApproachingShippingDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Get the collection of shipping discounts that the passed shipment\n\"almost\" qualifies for based on the merchandise total in the shipment.\nHere \"almost\" is controlled by thresholds configured at the promotion\nlevel.\n\nThis method only returns discounts for shipping promotions which apply to\none of the passed shipping methods.\n\nThe collection of returned approaching discounts is ordered by the\ncondition threshold of the promotion (e.g.\n\"spend $100 and get free standard shipping\" discount is returned before\n\"spend $150 and get free standard shipping\" discount.) A discount is not\nreturned if it would be prevented from applying (because of compatibility\nrules) by a shipping discount already in the DiscountPlan or an\napproaching shipping discount with a lower condition threshold.", + "heading": "Description" + } + ], + "signature": "getApproachingShippingDiscounts(shipment: Shipment, shippingMethods: Collection): Collection", + "source": "script-api", + "tags": [ + "getapproachingshippingdiscounts", + "discountplan.getapproachingshippingdiscounts" + ], + "title": "DiscountPlan.getApproachingShippingDiscounts" + }, + { + "description": "Returns all bonus discounts contained in the discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#getBonusDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getBonusDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all bonus discounts contained in the discount plan.", + "heading": "Description" + } + ], + "signature": "getBonusDiscounts(): Collection", + "source": "script-api", + "tags": [ + "getbonusdiscounts", + "discountplan.getbonusdiscounts" + ], + "title": "DiscountPlan.getBonusDiscounts" + }, + { + "description": "Returns line item container associated with discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#getLineItemCtnr", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getLineItemCtnr", + "returns": { + "type": "LineItemCtnr" + }, + "sections": [ + { + "body": "Returns line item container associated with discount plan.\n\nA discount plan is created from and associated with a line item container.\nThis method returns the line item container associated with this discount plan.", + "heading": "Description" + } + ], + "signature": "getLineItemCtnr(): LineItemCtnr", + "source": "script-api", + "tags": [ + "getlineitemctnr", + "discountplan.getlineitemctnr" + ], + "title": "DiscountPlan.getLineItemCtnr" + }, + { + "description": "Returns the percentage and amount order discounts contained in the discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#getOrderDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getOrderDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the percentage and amount order discounts contained in the\ndiscount plan.", + "heading": "Description" + } + ], + "signature": "getOrderDiscounts(): Collection", + "source": "script-api", + "tags": [ + "getorderdiscounts", + "discountplan.getorderdiscounts" + ], + "title": "DiscountPlan.getOrderDiscounts" + }, + { + "description": "Returns the percentage, amount and fix price discounts associated with the specified product line item. If the specified product line item is not contained in the discount plan, an empty collection is returned.", + "id": "script-api:dw/campaign/DiscountPlan#getProductDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "productLineItem", + "type": "ProductLineItem" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getProductDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the percentage, amount and fix price discounts associated\nwith the specified product line item. If the specified product line\nitem is not contained in the discount plan, an empty collection is\nreturned.", + "heading": "Description" + } + ], + "signature": "getProductDiscounts(productLineItem: ProductLineItem): Collection", + "source": "script-api", + "tags": [ + "getproductdiscounts", + "discountplan.getproductdiscounts" + ], + "title": "DiscountPlan.getProductDiscounts" + }, + { + "description": "Returns the product-shipping discounts associated with the specified product line item. If the specified product line item is not contained in the discount plan, an empty collection is returned.", + "id": "script-api:dw/campaign/DiscountPlan#getProductShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "productLineItem", + "type": "ProductLineItem" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getProductShippingDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product-shipping discounts associated with the specified\nproduct line item. If the specified product line item is not contained in\nthe discount plan, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getProductShippingDiscounts(productLineItem: ProductLineItem): Collection", + "source": "script-api", + "tags": [ + "getproductshippingdiscounts", + "discountplan.getproductshippingdiscounts" + ], + "title": "DiscountPlan.getProductShippingDiscounts" + }, + { + "description": "Returns the percentage, amount and fix price discounts associated with the specified shipment. If the specified shipment is not contained in the discount plan, an empty collection is returned.", + "id": "script-api:dw/campaign/DiscountPlan#getShippingDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.getShippingDiscounts", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the percentage, amount and fix price discounts associated with\nthe specified shipment. If the specified shipment is not contained in\nthe discount plan, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getShippingDiscounts(shipment: Shipment): Collection", + "source": "script-api", + "tags": [ + "getshippingdiscounts", + "discountplan.getshippingdiscounts" + ], + "title": "DiscountPlan.getShippingDiscounts" + }, + { + "description": "Returns line item container associated with discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#lineItemCtnr", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.lineItemCtnr", + "sections": [ + { + "body": "Returns line item container associated with discount plan.\n\nA discount plan is created from and associated with a line item container.\nThis method returns the line item container associated with this discount plan.", + "heading": "Description" + } + ], + "signature": "readonly lineItemCtnr: LineItemCtnr", + "source": "script-api", + "tags": [ + "lineitemctnr", + "discountplan.lineitemctnr" + ], + "title": "DiscountPlan.lineItemCtnr" + }, + { + "description": "Returns the percentage and amount order discounts contained in the discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#orderDiscounts", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.orderDiscounts", + "sections": [ + { + "body": "Returns the percentage and amount order discounts contained in the\ndiscount plan.", + "heading": "Description" + } + ], + "signature": "readonly orderDiscounts: Collection", + "source": "script-api", + "tags": [ + "orderdiscounts", + "discountplan.orderdiscounts" + ], + "title": "DiscountPlan.orderDiscounts" + }, + { + "description": "Removes the specified discount from the discount plan.", + "id": "script-api:dw/campaign/DiscountPlan#removeDiscount", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "discount", + "type": "Discount" + } + ], + "parentId": "script-api:dw/campaign/DiscountPlan", + "qualifiedName": "dw.campaign.DiscountPlan.removeDiscount", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified discount from the discount plan.\n\nThis method should only be used for very simple discount scenarios. It\nis not recommended to use the method in case of stacked discounts\n(i.e. multiple order or product discounts), or complex discount types\nlike Buy X Get Y or Total Fixed Price, since correct re-calculation of the\ndiscount plan based on the promotion rules is not guaranteed.", + "heading": "Description" + } + ], + "signature": "removeDiscount(discount: Discount): void", + "source": "script-api", + "tags": [ + "removediscount", + "discountplan.removediscount" + ], + "title": "DiscountPlan.removeDiscount" + }, + { + "description": "Represents a fix price discount in the discount plan, for example \"Shipping only 0.99 all orders $25 or more.\"", + "id": "script-api:dw/campaign/FixedPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FixedPriceDiscount", + "sections": [ + { + "body": "Represents a fix price discount in the discount plan, for example\n\"Shipping only 0.99 all orders $25 or more.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "fixedpricediscount", + "dw.campaign.fixedpricediscount", + "dw/campaign" + ], + "title": "FixedPriceDiscount" + }, + { + "description": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\" discount.", + "id": "script-api:dw/campaign/FixedPriceDiscount#fixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceDiscount", + "qualifiedName": "dw.campaign.FixedPriceDiscount.fixedPrice", + "sections": [ + { + "body": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "readonly fixedPrice: number", + "source": "script-api", + "tags": [ + "fixedprice", + "fixedpricediscount.fixedprice" + ], + "title": "FixedPriceDiscount.fixedPrice" + }, + { + "description": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\" discount.", + "id": "script-api:dw/campaign/FixedPriceDiscount#getFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceDiscount", + "qualifiedName": "dw.campaign.FixedPriceDiscount.getFixedPrice", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "getFixedPrice(): number", + "source": "script-api", + "tags": [ + "getfixedprice", + "fixedpricediscount.getfixedprice" + ], + "title": "FixedPriceDiscount.getFixedPrice" + }, + { + "description": "Represents a fixed price shipping discount in the discount plan, for example \"Shipping only 0.99 for iPods.\"", + "id": "script-api:dw/campaign/FixedPriceShippingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount", + "sections": [ + { + "body": "Represents a fixed price shipping discount in the discount plan, for\nexample \"Shipping only 0.99 for iPods.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "fixedpriceshippingdiscount", + "dw.campaign.fixedpriceshippingdiscount", + "dw/campaign" + ], + "title": "FixedPriceShippingDiscount" + }, + { + "description": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\" discount.", + "id": "script-api:dw/campaign/FixedPriceShippingDiscount#fixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceShippingDiscount", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount.fixedPrice", + "sections": [ + { + "body": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "readonly fixedPrice: number", + "source": "script-api", + "tags": [ + "fixedprice", + "fixedpriceshippingdiscount.fixedprice" + ], + "title": "FixedPriceShippingDiscount.fixedPrice" + }, + { + "description": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\" discount.", + "id": "script-api:dw/campaign/FixedPriceShippingDiscount#getFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/FixedPriceShippingDiscount", + "qualifiedName": "dw.campaign.FixedPriceShippingDiscount.getFixedPrice", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the fixed price amount, for example 0.99 for a \"Shipping only $0.99\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "getFixedPrice(): number", + "source": "script-api", + "tags": [ + "getfixedprice", + "fixedpriceshippingdiscount.getfixedprice" + ], + "title": "FixedPriceShippingDiscount.getFixedPrice" + }, + { + "description": "Represents a free discount in the discount plan, for example \"Free shipping on all orders $25 or more.\"", + "id": "script-api:dw/campaign/FreeDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FreeDiscount", + "sections": [ + { + "body": "Represents a free discount in the discount plan, for example\n\"Free shipping on all orders $25 or more.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "freediscount", + "dw.campaign.freediscount", + "dw/campaign" + ], + "title": "FreeDiscount" + }, + { + "description": "Represents a free shipping discount in the discount plan, for example \"Free shipping on all iPods.\"", + "id": "script-api:dw/campaign/FreeShippingDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.FreeShippingDiscount", + "sections": [ + { + "body": "Represents a free shipping discount in the discount plan, for example\n\"Free shipping on all iPods.\"", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "freeshippingdiscount", + "dw.campaign.freeshippingdiscount", + "dw/campaign" + ], + "title": "FreeShippingDiscount" + }, + { + "description": "Represents a percentage-off discount in the discount plan, for example \"10% off all T-Shirts\".", + "id": "script-api:dw/campaign/PercentageDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PercentageDiscount", + "sections": [ + { + "body": "Represents a percentage-off discount in the discount plan, for example\n\"10% off all T-Shirts\".", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "percentagediscount", + "dw.campaign.percentagediscount", + "dw/campaign" + ], + "title": "PercentageDiscount" + }, + { + "description": "Returns the percentage discount value, for example 10.00 for a \"10% off\" discount.", + "id": "script-api:dw/campaign/PercentageDiscount#getPercentage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageDiscount", + "qualifiedName": "dw.campaign.PercentageDiscount.getPercentage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the percentage discount value, for example 10.00 for a \"10% off\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "getPercentage(): number", + "source": "script-api", + "tags": [ + "getpercentage", + "percentagediscount.getpercentage" + ], + "title": "PercentageDiscount.getPercentage" + }, + { + "description": "Returns the percentage discount value, for example 10.00 for a \"10% off\" discount.", + "id": "script-api:dw/campaign/PercentageDiscount#percentage", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageDiscount", + "qualifiedName": "dw.campaign.PercentageDiscount.percentage", + "sections": [ + { + "body": "Returns the percentage discount value, for example 10.00 for a \"10% off\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "readonly percentage: number", + "source": "script-api", + "tags": [ + "percentage", + "percentagediscount.percentage" + ], + "title": "PercentageDiscount.percentage" + }, + { + "description": "Represents a percentage-off options discount in the discount plan, for example \"50% off monogramming on shirts\".", + "id": "script-api:dw/campaign/PercentageOptionDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PercentageOptionDiscount", + "sections": [ + { + "body": "Represents a percentage-off options discount in the discount plan, for\nexample \"50% off monogramming on shirts\".", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "percentageoptiondiscount", + "dw.campaign.percentageoptiondiscount", + "dw/campaign" + ], + "title": "PercentageOptionDiscount" + }, + { + "description": "Returns the percentage discount value, for example 10.00 for a \"10% off\" discount.", + "id": "script-api:dw/campaign/PercentageOptionDiscount#getPercentage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageOptionDiscount", + "qualifiedName": "dw.campaign.PercentageOptionDiscount.getPercentage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the percentage discount value, for example 10.00 for a \"10% off\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "getPercentage(): number", + "source": "script-api", + "tags": [ + "getpercentage", + "percentageoptiondiscount.getpercentage" + ], + "title": "PercentageOptionDiscount.getPercentage" + }, + { + "description": "Returns the percentage discount value, for example 10.00 for a \"10% off\" discount.", + "id": "script-api:dw/campaign/PercentageOptionDiscount#percentage", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PercentageOptionDiscount", + "qualifiedName": "dw.campaign.PercentageOptionDiscount.percentage", + "sections": [ + { + "body": "Returns the percentage discount value, for example 10.00 for a \"10% off\"\ndiscount.", + "heading": "Description" + } + ], + "signature": "readonly percentage: number", + "source": "script-api", + "tags": [ + "percentage", + "percentageoptiondiscount.percentage" + ], + "title": "PercentageOptionDiscount.percentage" + }, + { + "description": "Discount representing that a product's price has been calculated from a separate sales price book other than the standard price book assigned to the site.", + "id": "script-api:dw/campaign/PriceBookPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount", + "sections": [ + { + "body": "Discount representing that a product's price has been calculated from a\nseparate sales price book other than the standard price book assigned to the\nsite.", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "pricebookpricediscount", + "dw.campaign.pricebookpricediscount", + "dw/campaign" + ], + "title": "PriceBookPriceDiscount" + }, + { + "description": "Returns the price book identifier.", + "id": "script-api:dw/campaign/PriceBookPriceDiscount#getPriceBookID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PriceBookPriceDiscount", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount.getPriceBookID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the price book identifier.", + "heading": "Description" + } + ], + "signature": "getPriceBookID(): string", + "source": "script-api", + "tags": [ + "getpricebookid", + "pricebookpricediscount.getpricebookid" + ], + "title": "PriceBookPriceDiscount.getPriceBookID" + }, + { + "description": "Returns the price book identifier.", + "id": "script-api:dw/campaign/PriceBookPriceDiscount#priceBookID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PriceBookPriceDiscount", + "qualifiedName": "dw.campaign.PriceBookPriceDiscount.priceBookID", + "sections": [ + { + "body": "Returns the price book identifier.", + "heading": "Description" + } + ], + "signature": "readonly priceBookID: string", + "source": "script-api", + "tags": [ + "pricebookid", + "pricebookpricediscount.pricebookid" + ], + "title": "PriceBookPriceDiscount.priceBookID" + }, + { + "description": "This class represents a promotion in Commerce Cloud Digital. Examples of promotions include:", + "id": "script-api:dw/campaign/Promotion", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.Promotion", + "sections": [ + { + "body": "This class represents a promotion in Commerce Cloud Digital. Examples of\npromotions include:\n\n- \"Get 20% off your order\"\n- \"$15 off a given product\"\n- \"free shipping for all orders over $50\"\n- Get a bonus product with purchase of another product\n\nThe Promotion class provides access to the basic attributes of the promotion\nsuch as name, callout message, and description, but the details of the\npromotion rules are not available in the API due to their complexity.\n\nCommerce Cloud Digital allows merchants to create a single logical \"promotion\nrule\" (e.g. \"Get 20% off your order\") and then assign it to one or more\n\"containers\" where the supported container types are campaigns or AB-tests. A\nPromotion represents a specific instance of a promotion rule assigned to a\ncontainer. Promotion rules themselves that are not assigned to any container\nare inaccessible through the API. Each instance (i.e. assignment) can have\nseparate \"qualifiers\". Qualifiers are the customer groups, source code\ngroups, or coupons that trigger a given promotion for a customer.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "promotion", + "dw.campaign.promotion", + "dw/campaign" + ], + "title": "Promotion" + }, + { + "description": "Constant representing promotion exclusivity of type class.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_CLASS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_CLASS", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type class.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_CLASS: string", + "source": "script-api", + "tags": [ + "exclusivity_class", + "promotion.exclusivity_class" + ], + "title": "Promotion.EXCLUSIVITY_CLASS" + }, + { + "description": "Constant representing promotion exclusivity of type class.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_CLASS", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_CLASS", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type class.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_CLASS: string", + "source": "script-api", + "tags": [ + "exclusivity_class", + "promotion.exclusivity_class" + ], + "title": "Promotion.EXCLUSIVITY_CLASS" + }, + { + "description": "Constant representing promotion exclusivity of type global.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_GLOBAL", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_GLOBAL", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type global.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_GLOBAL: string", + "source": "script-api", + "tags": [ + "exclusivity_global", + "promotion.exclusivity_global" + ], + "title": "Promotion.EXCLUSIVITY_GLOBAL" + }, + { + "description": "Constant representing promotion exclusivity of type global.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_GLOBAL", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_GLOBAL", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type global.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_GLOBAL: string", + "source": "script-api", + "tags": [ + "exclusivity_global", + "promotion.exclusivity_global" + ], + "title": "Promotion.EXCLUSIVITY_GLOBAL" + }, + { + "description": "Constant representing promotion exclusivity of type no.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_NO", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_NO", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type no.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_NO: string", + "source": "script-api", + "tags": [ + "exclusivity_no", + "promotion.exclusivity_no" + ], + "title": "Promotion.EXCLUSIVITY_NO" + }, + { + "description": "Constant representing promotion exclusivity of type no.", + "id": "script-api:dw/campaign/Promotion#EXCLUSIVITY_NO", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.EXCLUSIVITY_NO", + "sections": [ + { + "body": "Constant representing promotion exclusivity of type no.", + "heading": "Description" + } + ], + "signature": "static readonly EXCLUSIVITY_NO: string", + "source": "script-api", + "tags": [ + "exclusivity_no", + "promotion.exclusivity_no" + ], + "title": "Promotion.EXCLUSIVITY_NO" + }, + { + "description": "Returns the unique ID of the promotion.", + "id": "script-api:dw/campaign/Promotion#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.ID", + "sections": [ + { + "body": "Returns the unique ID of the promotion.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "promotion.id" + ], + "title": "Promotion.ID" + }, + { + "description": "Constant representing promotion class of type order.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_ORDER", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_ORDER", + "sections": [ + { + "body": "Constant representing promotion class of type order.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_ORDER: string", + "source": "script-api", + "tags": [ + "promotion_class_order", + "promotion.promotion_class_order" + ], + "title": "Promotion.PROMOTION_CLASS_ORDER" + }, + { + "description": "Constant representing promotion class of type order.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_ORDER", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_ORDER", + "sections": [ + { + "body": "Constant representing promotion class of type order.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_ORDER: string", + "source": "script-api", + "tags": [ + "promotion_class_order", + "promotion.promotion_class_order" + ], + "title": "Promotion.PROMOTION_CLASS_ORDER" + }, + { + "description": "Constant representing promotion class of type product.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_PRODUCT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_PRODUCT", + "sections": [ + { + "body": "Constant representing promotion class of type product.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_PRODUCT: string", + "source": "script-api", + "tags": [ + "promotion_class_product", + "promotion.promotion_class_product" + ], + "title": "Promotion.PROMOTION_CLASS_PRODUCT" + }, + { + "description": "Constant representing promotion class of type product.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_PRODUCT", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_PRODUCT", + "sections": [ + { + "body": "Constant representing promotion class of type product.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_PRODUCT: string", + "source": "script-api", + "tags": [ + "promotion_class_product", + "promotion.promotion_class_product" + ], + "title": "Promotion.PROMOTION_CLASS_PRODUCT" + }, + { + "description": "Constant representing promotion class of type shipping.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_SHIPPING", + "sections": [ + { + "body": "Constant representing promotion class of type shipping.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_SHIPPING: string", + "source": "script-api", + "tags": [ + "promotion_class_shipping", + "promotion.promotion_class_shipping" + ], + "title": "Promotion.PROMOTION_CLASS_SHIPPING" + }, + { + "description": "Constant representing promotion class of type shipping.", + "id": "script-api:dw/campaign/Promotion#PROMOTION_CLASS_SHIPPING", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.PROMOTION_CLASS_SHIPPING", + "sections": [ + { + "body": "Constant representing promotion class of type shipping.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_CLASS_SHIPPING: string", + "source": "script-api", + "tags": [ + "promotion_class_shipping", + "promotion.promotion_class_shipping" + ], + "title": "Promotion.PROMOTION_CLASS_SHIPPING" + }, + { + "description": "Constant indicating that that all qualifier conditions must be met in order for this promotion to apply for a given customer.", + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ALL", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ALL", + "sections": [ + { + "body": "Constant indicating that that all qualifier conditions must be met in\norder for this promotion to apply for a given customer.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_MATCH_MODE_ALL = \"all\"", + "source": "script-api", + "tags": [ + "qualifier_match_mode_all", + "promotion.qualifier_match_mode_all" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ALL" + }, + { + "description": "Constant indicating that that all qualifier conditions must be met in order for this promotion to apply for a given customer.", + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ALL", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ALL", + "sections": [ + { + "body": "Constant indicating that that all qualifier conditions must be met in\norder for this promotion to apply for a given customer.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_MATCH_MODE_ALL = \"all\"", + "source": "script-api", + "tags": [ + "qualifier_match_mode_all", + "promotion.qualifier_match_mode_all" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ALL" + }, + { + "description": "Constant indicating that that at least one qualifier condition must be met in order for this promotion to apply for a given customer.", + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ANY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ANY", + "sections": [ + { + "body": "Constant indicating that that at least one qualifier condition must be\nmet in order for this promotion to apply for a given customer.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_MATCH_MODE_ANY = \"any\"", + "source": "script-api", + "tags": [ + "qualifier_match_mode_any", + "promotion.qualifier_match_mode_any" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ANY" + }, + { + "description": "Constant indicating that that at least one qualifier condition must be met in order for this promotion to apply for a given customer.", + "id": "script-api:dw/campaign/Promotion#QUALIFIER_MATCH_MODE_ANY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.QUALIFIER_MATCH_MODE_ANY", + "sections": [ + { + "body": "Constant indicating that that at least one qualifier condition must be\nmet in order for this promotion to apply for a given customer.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_MATCH_MODE_ANY = \"any\"", + "source": "script-api", + "tags": [ + "qualifier_match_mode_any", + "promotion.qualifier_match_mode_any" + ], + "title": "Promotion.QUALIFIER_MATCH_MODE_ANY" + }, + { + "description": "Returns 'true' if promotion is active, otherwise 'false'.", + "id": "script-api:dw/campaign/Promotion#active", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.active", + "sections": [ + { + "body": "Returns 'true' if promotion is active, otherwise 'false'.\n\nA promotion is active if its campaign is active, and the promotion\nis enabled, and it is scheduled for now.", + "heading": "Description" + } + ], + "signature": "readonly active: boolean", + "source": "script-api", + "tags": [ + "active", + "promotion.active" + ], + "title": "Promotion.active" + }, + { + "deprecated": { + "message": "Use isBasedOnCoupons" + }, + "description": "Returns 'true' if the promotion is triggered by a coupon, false otherwise.", + "id": "script-api:dw/campaign/Promotion#basedOnCoupon", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCoupon", + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by a coupon,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCoupon: boolean", + "source": "script-api", + "tags": [ + "basedoncoupon", + "promotion.basedoncoupon" + ], + "title": "Promotion.basedOnCoupon" + }, + { + "description": "Returns 'true' if the promotion is triggered by coupons, false otherwise.", + "id": "script-api:dw/campaign/Promotion#basedOnCoupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCoupons", + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by coupons,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCoupons: boolean", + "source": "script-api", + "tags": [ + "basedoncoupons", + "promotion.basedoncoupons" + ], + "title": "Promotion.basedOnCoupons" + }, + { + "description": "Returns 'true' if the promotion is triggered by customer groups, false otherwise.", + "id": "script-api:dw/campaign/Promotion#basedOnCustomerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnCustomerGroups", + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by customer groups,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCustomerGroups: boolean", + "source": "script-api", + "tags": [ + "basedoncustomergroups", + "promotion.basedoncustomergroups" + ], + "title": "Promotion.basedOnCustomerGroups" + }, + { + "description": "Returns 'true' if the promotion is triggered by source codes, false otherwise.", + "id": "script-api:dw/campaign/Promotion#basedOnSourceCodes", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.basedOnSourceCodes", + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by source codes,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "readonly basedOnSourceCodes: boolean", + "source": "script-api", + "tags": [ + "basedonsourcecodes", + "promotion.basedonsourcecodes" + ], + "title": "Promotion.basedOnSourceCodes" + }, + { + "description": "Returns the callout message of the promotion.", + "id": "script-api:dw/campaign/Promotion#calloutMsg", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.calloutMsg", + "sections": [ + { + "body": "Returns the callout message of the promotion.", + "heading": "Description" + } + ], + "signature": "readonly calloutMsg: MarkupText", + "source": "script-api", + "tags": [ + "calloutmsg", + "promotion.calloutmsg" + ], + "title": "Promotion.calloutMsg" + }, + { + "description": "Returns the campaign this particular instance of the promotion is defined in.", + "id": "script-api:dw/campaign/Promotion#campaign", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.campaign", + "sections": [ + { + "body": "Returns the campaign this particular instance of the promotion is defined\nin.\n\nNote: If this promotion is defined as part of an AB-test, then a Campaign\nobject will be returned, but it is a mock implementation, and not a true\nCampaign. This behavior is required for backwards compatibility and\nshould not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "readonly campaign: Campaign", + "source": "script-api", + "tags": [ + "campaign", + "promotion.campaign" + ], + "title": "Promotion.campaign" + }, + { + "description": "Returns the promotion's combinable promotions. Combinable promotions is a set of promotions or groups this promotion can be combined with.", + "id": "script-api:dw/campaign/Promotion#combinablePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.combinablePromotions", + "sections": [ + { + "body": "Returns the promotion's combinable promotions. Combinable promotions is a set of promotions or groups this\npromotion can be combined with.", + "heading": "Description" + } + ], + "signature": "readonly combinablePromotions: string[]", + "source": "script-api", + "tags": [ + "combinablepromotions", + "promotion.combinablepromotions" + ], + "title": "Promotion.combinablePromotions" + }, + { + "deprecated": { + "message": "Use getDetails" + }, + "description": "Returns a description of the condition that must be met for this promotion to be applicable.", + "id": "script-api:dw/campaign/Promotion#conditionalDescription", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.conditionalDescription", + "sections": [ + { + "body": "Returns a description of the condition that must be met for this\npromotion to be applicable.\n\nThe method and the related attribute have been deprecated. Use the\ngetDetails method instead.", + "heading": "Description" + } + ], + "signature": "readonly conditionalDescription: MarkupText", + "source": "script-api", + "tags": [ + "conditionaldescription", + "promotion.conditionaldescription" + ], + "title": "Promotion.conditionalDescription" + }, + { + "description": "Returns the coupons directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#coupons", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.coupons", + "sections": [ + { + "body": "Returns the coupons directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on coupons (see isBasedOnCoupons), or no coupons is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "readonly coupons: Collection", + "source": "script-api", + "tags": [ + "coupons", + "promotion.coupons" + ], + "title": "Promotion.coupons" + }, + { + "description": "Returns the customer groups directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#customerGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.customerGroups", + "sections": [ + { + "body": "Returns the customer groups directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on customer groups (see isBasedOnCustomerGroups), or no customer group is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "promotion.customergroups" + ], + "title": "Promotion.customerGroups" + }, + { + "deprecated": { + "message": "Use getCalloutMsg" + }, + "description": "Returns the description of the promotion.", + "id": "script-api:dw/campaign/Promotion#description", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.description", + "sections": [ + { + "body": "Returns the description of the promotion.\n\nMethod is deprecated and returns the same value as getCalloutMsg.", + "heading": "Description" + } + ], + "signature": "readonly description: MarkupText", + "source": "script-api", + "tags": [ + "description", + "promotion.description" + ], + "title": "Promotion.description" + }, + { + "description": "Returns the detailed description of the promotion.", + "id": "script-api:dw/campaign/Promotion#details", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.details", + "sections": [ + { + "body": "Returns the detailed description of the promotion.", + "heading": "Description" + } + ], + "signature": "readonly details: MarkupText", + "source": "script-api", + "tags": [ + "details", + "promotion.details" + ], + "title": "Promotion.details" + }, + { + "description": "Returns true if promotion is enabled, otherwise false.", + "id": "script-api:dw/campaign/Promotion#enabled", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.enabled", + "sections": [ + { + "body": "Returns true if promotion is enabled, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "promotion.enabled" + ], + "title": "Promotion.enabled" + }, + { + "description": "Returns the effective end date of this instance of the promotion. If no explicit end date is defined for the promotion, the end date of the containing Campaign or AB-test is returned.", + "id": "script-api:dw/campaign/Promotion#endDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.endDate", + "sections": [ + { + "body": "Returns the effective end date of this instance of the promotion. If no\nexplicit end date is defined for the promotion, the end date of the\ncontaining Campaign or AB-test is returned.", + "heading": "Description" + } + ], + "signature": "readonly endDate: Date | null", + "source": "script-api", + "tags": [ + "enddate", + "promotion.enddate" + ], + "title": "Promotion.endDate" + }, + { + "description": "Returns the promotion's exclusivity specifying how the promotion can be combined with other promotions. Possible values are EXCLUSIVITY_NO, EXCLUSIVITY_CLASS and EXCLUSIVITY_GLOBAL.", + "id": "script-api:dw/campaign/Promotion#exclusivity", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.exclusivity", + "sections": [ + { + "body": "Returns the promotion's exclusivity specifying how the promotion can be\ncombined with other promotions.\nPossible values are EXCLUSIVITY_NO, EXCLUSIVITY_CLASS\nand EXCLUSIVITY_GLOBAL.", + "heading": "Description" + } + ], + "signature": "readonly exclusivity: string", + "source": "script-api", + "tags": [ + "exclusivity", + "promotion.exclusivity" + ], + "title": "Promotion.exclusivity" + }, + { + "description": "Returns the callout message of the promotion.", + "id": "script-api:dw/campaign/Promotion#getCalloutMsg", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCalloutMsg", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the callout message of the promotion.", + "heading": "Description" + } + ], + "signature": "getCalloutMsg(): MarkupText", + "source": "script-api", + "tags": [ + "getcalloutmsg", + "promotion.getcalloutmsg" + ], + "title": "Promotion.getCalloutMsg" + }, + { + "description": "Returns the campaign this particular instance of the promotion is defined in.", + "id": "script-api:dw/campaign/Promotion#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCampaign", + "returns": { + "type": "Campaign" + }, + "sections": [ + { + "body": "Returns the campaign this particular instance of the promotion is defined\nin.\n\nNote: If this promotion is defined as part of an AB-test, then a Campaign\nobject will be returned, but it is a mock implementation, and not a true\nCampaign. This behavior is required for backwards compatibility and\nshould not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "getCampaign(): Campaign", + "source": "script-api", + "tags": [ + "getcampaign", + "promotion.getcampaign" + ], + "title": "Promotion.getCampaign" + }, + { + "description": "Returns the promotion's combinable promotions. Combinable promotions is a set of promotions or groups this promotion can be combined with.", + "id": "script-api:dw/campaign/Promotion#getCombinablePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCombinablePromotions", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns the promotion's combinable promotions. Combinable promotions is a set of promotions or groups this\npromotion can be combined with.", + "heading": "Description" + } + ], + "signature": "getCombinablePromotions(): string[]", + "source": "script-api", + "tags": [ + "getcombinablepromotions", + "promotion.getcombinablepromotions" + ], + "title": "Promotion.getCombinablePromotions" + }, + { + "deprecated": { + "message": "Use getDetails" + }, + "description": "Returns a description of the condition that must be met for this promotion to be applicable.", + "id": "script-api:dw/campaign/Promotion#getConditionalDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getConditionalDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns a description of the condition that must be met for this\npromotion to be applicable.\n\nThe method and the related attribute have been deprecated. Use the\ngetDetails method instead.", + "heading": "Description" + } + ], + "signature": "getConditionalDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getconditionaldescription", + "promotion.getconditionaldescription" + ], + "title": "Promotion.getConditionalDescription" + }, + { + "description": "Returns the coupons directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#getCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCoupons", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the coupons directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on coupons (see isBasedOnCoupons), or no coupons is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getCoupons(): Collection", + "source": "script-api", + "tags": [ + "getcoupons", + "promotion.getcoupons" + ], + "title": "Promotion.getCoupons" + }, + { + "description": "Returns the customer groups directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#getCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on customer groups (see isBasedOnCustomerGroups), or no customer group is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "promotion.getcustomergroups" + ], + "title": "Promotion.getCustomerGroups" + }, + { + "deprecated": { + "message": "Use getCalloutMsg" + }, + "description": "Returns the description of the promotion.", + "id": "script-api:dw/campaign/Promotion#getDescription", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the description of the promotion.\n\nMethod is deprecated and returns the same value as getCalloutMsg.", + "heading": "Description" + } + ], + "signature": "getDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getdescription", + "promotion.getdescription" + ], + "title": "Promotion.getDescription" + }, + { + "description": "Returns the detailed description of the promotion.", + "id": "script-api:dw/campaign/Promotion#getDetails", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getDetails", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the detailed description of the promotion.", + "heading": "Description" + } + ], + "signature": "getDetails(): MarkupText", + "source": "script-api", + "tags": [ + "getdetails", + "promotion.getdetails" + ], + "title": "Promotion.getDetails" + }, + { + "description": "Returns the effective end date of this instance of the promotion. If no explicit end date is defined for the promotion, the end date of the containing Campaign or AB-test is returned.", + "id": "script-api:dw/campaign/Promotion#getEndDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getEndDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the effective end date of this instance of the promotion. If no\nexplicit end date is defined for the promotion, the end date of the\ncontaining Campaign or AB-test is returned.", + "heading": "Description" + } + ], + "signature": "getEndDate(): Date | null", + "source": "script-api", + "tags": [ + "getenddate", + "promotion.getenddate" + ], + "title": "Promotion.getEndDate" + }, + { + "description": "Returns the promotion's exclusivity specifying how the promotion can be combined with other promotions. Possible values are EXCLUSIVITY_NO, EXCLUSIVITY_CLASS and EXCLUSIVITY_GLOBAL.", + "id": "script-api:dw/campaign/Promotion#getExclusivity", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getExclusivity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the promotion's exclusivity specifying how the promotion can be\ncombined with other promotions.\nPossible values are EXCLUSIVITY_NO, EXCLUSIVITY_CLASS\nand EXCLUSIVITY_GLOBAL.", + "heading": "Description" + } + ], + "signature": "getExclusivity(): string", + "source": "script-api", + "tags": [ + "getexclusivity", + "promotion.getexclusivity" + ], + "title": "Promotion.getExclusivity" + }, + { + "description": "Returns the unique ID of the promotion.", + "id": "script-api:dw/campaign/Promotion#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique ID of the promotion.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "promotion.getid" + ], + "title": "Promotion.getID" + }, + { + "description": "Returns the reference to the promotion image.", + "id": "script-api:dw/campaign/Promotion#getImage", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the reference to the promotion image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "promotion.getimage" + ], + "title": "Promotion.getImage" + }, + { + "description": "Returns the date that this object was last modified.", + "id": "script-api:dw/campaign/Promotion#getLastModified", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getLastModified", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date that this object was last modified.", + "heading": "Description" + } + ], + "signature": "getLastModified(): Date", + "source": "script-api", + "tags": [ + "getlastmodified", + "promotion.getlastmodified" + ], + "title": "Promotion.getLastModified" + }, + { + "description": "Returns the promotion's mutually exclusive Promotions. Mutually exclusive Promotions is a set of promotions or groups this promotion cannot be combined with.", + "id": "script-api:dw/campaign/Promotion#getMutuallyExclusivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getMutuallyExclusivePromotions", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns the promotion's mutually exclusive Promotions. Mutually exclusive Promotions is a set of promotions or\ngroups this promotion cannot be combined with.", + "heading": "Description" + } + ], + "signature": "getMutuallyExclusivePromotions(): string[]", + "source": "script-api", + "tags": [ + "getmutuallyexclusivepromotions", + "promotion.getmutuallyexclusivepromotions" + ], + "title": "Promotion.getMutuallyExclusivePromotions" + }, + { + "description": "Returns the name of the promotion.", + "id": "script-api:dw/campaign/Promotion#getName", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the promotion.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "promotion.getname" + ], + "title": "Promotion.getName" + }, + { + "description": "Returns the promotion class indicating the general type of the promotion. Possible values are PROMOTION_CLASS_PRODUCT, PROMOTION_CLASS_ORDER, and PROMOTION_CLASS_SHIPPING.", + "id": "script-api:dw/campaign/Promotion#getPromotionClass", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionClass", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the promotion class indicating the general type of the promotion.\nPossible values are PROMOTION_CLASS_PRODUCT,\nPROMOTION_CLASS_ORDER, and PROMOTION_CLASS_SHIPPING.", + "heading": "Description" + } + ], + "signature": "getPromotionClass(): string | null", + "source": "script-api", + "tags": [ + "getpromotionclass", + "promotion.getpromotionclass" + ], + "title": "Promotion.getPromotionClass" + }, + { + "description": "Returns the promotional price for the specified product. The promotional price is only returned if the following conditions are met:", + "id": "script-api:dw/campaign/Promotion#getPromotionalPrice", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the promotional price for the specified product. The promotional\nprice is only returned if the following conditions are met:\n\n- this promotion is a product promotion without purchase conditions,\ni.e. is of type 'Without qualifying products'.\n- this promotion's discount is Discount.TYPE_AMOUNT,\nDiscount.TYPE_PERCENTAGE, Discount.TYPE_FIXED_PRICE, or\nDiscount.TYPE_PRICEBOOK_PRICE.\n- specified product is one of the discounted products of the\npromotion.\n- the product has a valid sales price for quantity 1.0.\n\nIn all other cases, the method will return Money.NOT_AVAILABLE. It is\nnot required that this promotion be an active customer\npromotion.\n\nNOTE: the method might be extended in the future to support more\npromotion types.\n\nTo calculate the promotional price, the method uses the current sales\nprice of the product for quantity 1.0, and applies the discount\nassociated with the promotion to this price. For example, if the product\nprice is $14.99, and the promotion discount is 10%, the method will\nreturn $13.49. If the discount is $2 off, the method will return $12.99.\nIf the discount is $10.00 fixed price, the method will return $10.00.", + "heading": "Description" + } + ], + "signature": "getPromotionalPrice(product: Product): Money", + "source": "script-api", + "tags": [ + "getpromotionalprice", + "promotion.getpromotionalprice" + ], + "title": "Promotion.getPromotionalPrice" + }, + { + "description": "This method follows the same logic as getPromotionalPrice but prices are calculated based on the option values selected in the specified option model.", + "id": "script-api:dw/campaign/Promotion#getPromotionalPrice", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "optionModel", + "type": "ProductOptionModel" + } + ], + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getPromotionalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "This method follows the same logic as\ngetPromotionalPrice but prices are calculated based\non the option values selected in the specified option model.", + "heading": "Description" + } + ], + "signature": "getPromotionalPrice(product: Product, optionModel: ProductOptionModel): Money", + "source": "script-api", + "tags": [ + "getpromotionalprice", + "promotion.getpromotionalprice" + ], + "title": "Promotion.getPromotionalPrice" + }, + { + "description": "Returns the qualifier matching mode specified by this promotion. A promotion may have up to 3 qualifier conditions based on whether it is customer-group based, coupon based, and/or source-code based. A promotion may require for example that a customer belong to a certain customer group and also have a certain coupon in the cart in order for the promotion to apply. This method returns QUALIFIER_MATCH_MODE_ALL if it is necessary that all the qualifier conditions are satisfied in order for this promotion to apply for a given customer. Otherwise, this method returns QUALIFIER_MATCH_MODE_ANY indicating that at least of the qualifier conditions must be satisfied.", + "id": "script-api:dw/campaign/Promotion#getQualifierMatchMode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getQualifierMatchMode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the qualifier matching mode specified by this promotion. A\npromotion may have up to 3 qualifier conditions based on whether it is\ncustomer-group based, coupon based, and/or source-code based. A promotion\nmay require for example that a customer belong to a certain customer\ngroup and also have a certain coupon in the cart in order for the\npromotion to apply. This method returns QUALIFIER_MATCH_MODE_ALL if it is\nnecessary that all the qualifier conditions are satisfied in order for\nthis promotion to apply for a given customer. Otherwise, this method\nreturns QUALIFIER_MATCH_MODE_ANY indicating that at least of the\nqualifier conditions must be satisfied.\n\nNote: currently QUALIFIER_MATCH_MODE_ALL is only supported for promotions\nassigned to campaigns, and not those assigned to AB-tests.", + "heading": "Description" + } + ], + "signature": "getQualifierMatchMode(): string", + "source": "script-api", + "tags": [ + "getqualifiermatchmode", + "promotion.getqualifiermatchmode" + ], + "title": "Promotion.getQualifierMatchMode" + }, + { + "description": "Returns the promotion's rank. Rank is a numeric attribute that you can specify. Promotions with a defined rank are calculated before promotions without a defined rank. If two promotions have a rank, the one with the lowest rank is calculated first. For example, a promotion with rank 10 is calculated before one with rank 30.", + "id": "script-api:dw/campaign/Promotion#getRank", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getRank", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the promotion's rank. Rank is a numeric attribute that you can specify.\nPromotions with a defined rank are calculated before promotions without a defined rank.\nIf two promotions have a rank, the one with the lowest rank is calculated first.\nFor example, a promotion with rank 10 is calculated before one with rank 30.", + "heading": "Description" + } + ], + "signature": "getRank(): number", + "source": "script-api", + "tags": [ + "getrank", + "promotion.getrank" + ], + "title": "Promotion.getRank" + }, + { + "description": "Returns the source code groups directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#getSourceCodeGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getSourceCodeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the source code groups directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on source code groups (see isBasedOnSourceCodes), or no source code group is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getSourceCodeGroups(): Collection", + "source": "script-api", + "tags": [ + "getsourcecodegroups", + "promotion.getsourcecodegroups" + ], + "title": "Promotion.getSourceCodeGroups" + }, + { + "description": "Returns the effective start date of this instance of the promotion. If no explicit start date is defined for this instance, the start date of the containing Campaign or AB-test is returned.", + "id": "script-api:dw/campaign/Promotion#getStartDate", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getStartDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the effective start date of this instance of the promotion. If no\nexplicit start date is defined for this instance, the start date of the\ncontaining Campaign or AB-test is returned.", + "heading": "Description" + } + ], + "signature": "getStartDate(): Date | null", + "source": "script-api", + "tags": [ + "getstartdate", + "promotion.getstartdate" + ], + "title": "Promotion.getStartDate" + }, + { + "description": "Returns the promotion's tags. Tags are a way of categorizing and organizing promotions. A promotion can have many tags. Tags will be returned in alphabetical order.", + "id": "script-api:dw/campaign/Promotion#getTags", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.getTags", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns the promotion's tags. Tags are a way of categorizing and organizing promotions. A promotion can have many\ntags. Tags will be returned in alphabetical order.", + "heading": "Description" + } + ], + "signature": "getTags(): string[]", + "source": "script-api", + "tags": [ + "gettags", + "promotion.gettags" + ], + "title": "Promotion.getTags" + }, + { + "description": "Returns the reference to the promotion image.", + "id": "script-api:dw/campaign/Promotion#image", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.image", + "sections": [ + { + "body": "Returns the reference to the promotion image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "promotion.image" + ], + "title": "Promotion.image" + }, + { + "description": "Returns 'true' if promotion is active, otherwise 'false'.", + "id": "script-api:dw/campaign/Promotion#isActive", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isActive", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if promotion is active, otherwise 'false'.\n\nA promotion is active if its campaign is active, and the promotion\nis enabled, and it is scheduled for now.", + "heading": "Description" + } + ], + "signature": "isActive(): boolean", + "source": "script-api", + "tags": [ + "isactive", + "promotion.isactive" + ], + "title": "Promotion.isActive" + }, + { + "deprecated": { + "message": "Use isBasedOnCoupons" + }, + "description": "Returns 'true' if the promotion is triggered by a coupon, false otherwise.", + "id": "script-api:dw/campaign/Promotion#isBasedOnCoupon", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCoupon", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by a coupon,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "isBasedOnCoupon(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncoupon", + "promotion.isbasedoncoupon" + ], + "title": "Promotion.isBasedOnCoupon" + }, + { + "description": "Returns 'true' if the promotion is triggered by coupons, false otherwise.", + "id": "script-api:dw/campaign/Promotion#isBasedOnCoupons", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCoupons", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by coupons,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "isBasedOnCoupons(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncoupons", + "promotion.isbasedoncoupons" + ], + "title": "Promotion.isBasedOnCoupons" + }, + { + "description": "Returns 'true' if the promotion is triggered by customer groups, false otherwise.", + "id": "script-api:dw/campaign/Promotion#isBasedOnCustomerGroups", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnCustomerGroups", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by customer groups,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "isBasedOnCustomerGroups(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncustomergroups", + "promotion.isbasedoncustomergroups" + ], + "title": "Promotion.isBasedOnCustomerGroups" + }, + { + "description": "Returns 'true' if the promotion is triggered by source codes, false otherwise.", + "id": "script-api:dw/campaign/Promotion#isBasedOnSourceCodes", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isBasedOnSourceCodes", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the promotion is triggered by source codes,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "isBasedOnSourceCodes(): boolean", + "source": "script-api", + "tags": [ + "isbasedonsourcecodes", + "promotion.isbasedonsourcecodes" + ], + "title": "Promotion.isBasedOnSourceCodes" + }, + { + "description": "Returns true if promotion is enabled, otherwise false.", + "id": "script-api:dw/campaign/Promotion#isEnabled", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if promotion is enabled, otherwise false.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "promotion.isenabled" + ], + "title": "Promotion.isEnabled" + }, + { + "description": "Returns true if promotion is refinable, otherwise false.", + "id": "script-api:dw/campaign/Promotion#isRefinable", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.isRefinable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if promotion is refinable, otherwise false.", + "heading": "Description" + } + ], + "signature": "isRefinable(): boolean", + "source": "script-api", + "tags": [ + "isrefinable", + "promotion.isrefinable" + ], + "title": "Promotion.isRefinable" + }, + { + "description": "Returns the date that this object was last modified.", + "id": "script-api:dw/campaign/Promotion#lastModified", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.lastModified", + "sections": [ + { + "body": "Returns the date that this object was last modified.", + "heading": "Description" + } + ], + "signature": "readonly lastModified: Date", + "source": "script-api", + "tags": [ + "lastmodified", + "promotion.lastmodified" + ], + "title": "Promotion.lastModified" + }, + { + "description": "Returns the promotion's mutually exclusive Promotions. Mutually exclusive Promotions is a set of promotions or groups this promotion cannot be combined with.", + "id": "script-api:dw/campaign/Promotion#mutuallyExclusivePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.mutuallyExclusivePromotions", + "sections": [ + { + "body": "Returns the promotion's mutually exclusive Promotions. Mutually exclusive Promotions is a set of promotions or\ngroups this promotion cannot be combined with.", + "heading": "Description" + } + ], + "signature": "readonly mutuallyExclusivePromotions: string[]", + "source": "script-api", + "tags": [ + "mutuallyexclusivepromotions", + "promotion.mutuallyexclusivepromotions" + ], + "title": "Promotion.mutuallyExclusivePromotions" + }, + { + "description": "Returns the name of the promotion.", + "id": "script-api:dw/campaign/Promotion#name", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.name", + "sections": [ + { + "body": "Returns the name of the promotion.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "promotion.name" + ], + "title": "Promotion.name" + }, + { + "description": "Returns the promotion class indicating the general type of the promotion. Possible values are PROMOTION_CLASS_PRODUCT, PROMOTION_CLASS_ORDER, and PROMOTION_CLASS_SHIPPING.", + "id": "script-api:dw/campaign/Promotion#promotionClass", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.promotionClass", + "sections": [ + { + "body": "Returns the promotion class indicating the general type of the promotion.\nPossible values are PROMOTION_CLASS_PRODUCT,\nPROMOTION_CLASS_ORDER, and PROMOTION_CLASS_SHIPPING.", + "heading": "Description" + } + ], + "signature": "readonly promotionClass: string | null", + "source": "script-api", + "tags": [ + "promotionclass", + "promotion.promotionclass" + ], + "title": "Promotion.promotionClass" + }, + { + "description": "Returns the qualifier matching mode specified by this promotion. A promotion may have up to 3 qualifier conditions based on whether it is customer-group based, coupon based, and/or source-code based. A promotion may require for example that a customer belong to a certain customer group and also have a certain coupon in the cart in order for the promotion to apply. This method returns QUALIFIER_MATCH_MODE_ALL if it is necessary that all the qualifier conditions are satisfied in order for this promotion to apply for a given customer. Otherwise, this method returns QUALIFIER_MATCH_MODE_ANY indicating that at least of the qualifier conditions must be satisfied.", + "id": "script-api:dw/campaign/Promotion#qualifierMatchMode", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.qualifierMatchMode", + "sections": [ + { + "body": "Returns the qualifier matching mode specified by this promotion. A\npromotion may have up to 3 qualifier conditions based on whether it is\ncustomer-group based, coupon based, and/or source-code based. A promotion\nmay require for example that a customer belong to a certain customer\ngroup and also have a certain coupon in the cart in order for the\npromotion to apply. This method returns QUALIFIER_MATCH_MODE_ALL if it is\nnecessary that all the qualifier conditions are satisfied in order for\nthis promotion to apply for a given customer. Otherwise, this method\nreturns QUALIFIER_MATCH_MODE_ANY indicating that at least of the\nqualifier conditions must be satisfied.\n\nNote: currently QUALIFIER_MATCH_MODE_ALL is only supported for promotions\nassigned to campaigns, and not those assigned to AB-tests.", + "heading": "Description" + } + ], + "signature": "readonly qualifierMatchMode: string", + "source": "script-api", + "tags": [ + "qualifiermatchmode", + "promotion.qualifiermatchmode" + ], + "title": "Promotion.qualifierMatchMode" + }, + { + "description": "Returns the promotion's rank. Rank is a numeric attribute that you can specify. Promotions with a defined rank are calculated before promotions without a defined rank. If two promotions have a rank, the one with the lowest rank is calculated first. For example, a promotion with rank 10 is calculated before one with rank 30.", + "id": "script-api:dw/campaign/Promotion#rank", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.rank", + "sections": [ + { + "body": "Returns the promotion's rank. Rank is a numeric attribute that you can specify.\nPromotions with a defined rank are calculated before promotions without a defined rank.\nIf two promotions have a rank, the one with the lowest rank is calculated first.\nFor example, a promotion with rank 10 is calculated before one with rank 30.", + "heading": "Description" + } + ], + "signature": "readonly rank: number", + "source": "script-api", + "tags": [ + "rank", + "promotion.rank" + ], + "title": "Promotion.rank" + }, + { + "description": "Returns true if promotion is refinable, otherwise false.", + "id": "script-api:dw/campaign/Promotion#refinable", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.refinable", + "sections": [ + { + "body": "Returns true if promotion is refinable, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly refinable: boolean", + "source": "script-api", + "tags": [ + "refinable", + "promotion.refinable" + ], + "title": "Promotion.refinable" + }, + { + "description": "Returns the source code groups directly assigned to the promotion or assigned to the campaign of the promotion.", + "id": "script-api:dw/campaign/Promotion#sourceCodeGroups", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.sourceCodeGroups", + "sections": [ + { + "body": "Returns the source code groups directly assigned to the promotion or assigned to the campaign of the promotion.\n\nIf the promotion is not based on source code groups (see isBasedOnSourceCodes), or no source code group is assigned to the\npromotion or its campaign, an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeGroups: Collection", + "source": "script-api", + "tags": [ + "sourcecodegroups", + "promotion.sourcecodegroups" + ], + "title": "Promotion.sourceCodeGroups" + }, + { + "description": "Returns the effective start date of this instance of the promotion. If no explicit start date is defined for this instance, the start date of the containing Campaign or AB-test is returned.", + "id": "script-api:dw/campaign/Promotion#startDate", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.startDate", + "sections": [ + { + "body": "Returns the effective start date of this instance of the promotion. If no\nexplicit start date is defined for this instance, the start date of the\ncontaining Campaign or AB-test is returned.", + "heading": "Description" + } + ], + "signature": "readonly startDate: Date | null", + "source": "script-api", + "tags": [ + "startdate", + "promotion.startdate" + ], + "title": "Promotion.startDate" + }, + { + "description": "Returns the promotion's tags. Tags are a way of categorizing and organizing promotions. A promotion can have many tags. Tags will be returned in alphabetical order.", + "id": "script-api:dw/campaign/Promotion#tags", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/Promotion", + "qualifiedName": "dw.campaign.Promotion.tags", + "sections": [ + { + "body": "Returns the promotion's tags. Tags are a way of categorizing and organizing promotions. A promotion can have many\ntags. Tags will be returned in alphabetical order.", + "heading": "Description" + } + ], + "signature": "readonly tags: string[]", + "source": "script-api", + "tags": [ + "tags", + "promotion.tags" + ], + "title": "Promotion.tags" + }, + { + "description": "dw.campaign.PromotionMgr is used to access campaigns and promotion definitions, display active or upcoming promotions in a storefront, and to calculate and apply promotional discounts to line item containers.", + "id": "script-api:dw/campaign/PromotionMgr", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PromotionMgr", + "sections": [ + { + "body": "dw.campaign.PromotionMgr is used to access campaigns and promotion\ndefinitions, display active or upcoming promotions in a storefront, and to\ncalculate and apply promotional discounts to line item containers.\n\nTo access campaign and promotion definitions, use methods\ngetCampaigns, getCampaign,\ngetPromotions and getPromotion.\n\nTo display active or upcoming promotions in the storefront, e.g. on product\npages, various methods are provided. getActivePromotions returns\na dw.campaign.PromotionPlan with all enabled promotions scheduled for now.\ngetActiveCustomerPromotions returns a dw.campaign.PromotionPlan with\nall enabled promotions scheduled for now and applicable for the\nsession currency, current customer and active source code.\ngetUpcomingPromotions returns a dw.campaign.PromotionPlan with all\npromotions that are enabled, not scheduled for now, but scheduled for\nany time between now and now + previewTime(hours).\n\nApplying promotions to line item containers is a 3-step process, and\ndw.campaign.PromotionMgr provides methods supporting each of these steps.\nConvenience methods can be used that execute all three steps at once,\nor the steps can be executed individually if you need to customize\nthe output of the steps due to specific business rules.\n\n- Step 1 - calculate active customer promotions: Determine the active\npromotions for the session currency, current customer, source code and redeemed coupons.\n- Step 2 - calculate applicable discounts: Based on the active promotions\ndetermined in step 1, applicable discounts are calculated.\n- Step 3 - apply discounts: applicable discounts are applied to a line\nitem container by creating price adjustment line items.\n\nThe simpliest way to execute steps 1-3 is to use method\napplyDiscounts. The method identifies all active\ncustomer promotions, calculates and applies applicable discounts.\n\nDue to specific business rules it might be necessary to manipulate\nthe set of applicable discounts calculated by the promotion engine\nbefore applying them to the line item container. To implement such a scenario,\nyou want to use method getDiscounts, which\nidentifies all active customer promotions, and calculates and returns\napplicable discounts in an instance of dw.campaign.DiscountPlan. The discount\nplan contains a description for all applicable discounts for the specified line\nitem container, and you can remove discounts from it if necessary.\nThe customized discount plan can then be passed on for application by\nusing method applyDiscounts.\n\nDue to specific business rules it might be necessary to manipulate the\nset of active customer promotions before calculating applicable discounts\nfrom it. For example, you might want to add promotions to the\nplan or remove promotions from it.\nYou want to use method getActiveCustomerPromotions and\ngetActiveCustomerPromotions, which\nidentifies all active customer promotions and returns an instance of\ndw.campaign.PromotionPlan. You can add promotions to the promotion plan\nor remove promotions from the plan. The customized promotion plan can then be\npassed on to calculate applicable discounts by using method\ngetDiscounts.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "promotionmgr", + "dw.campaign.promotionmgr", + "dw/campaign" + ], + "title": "PromotionMgr" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#activeCustomerPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activeCustomerPromotions", + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static readonly activeCustomerPromotions: PromotionPlan", + "source": "script-api", + "tags": [ + "activecustomerpromotions", + "promotionmgr.activecustomerpromotions" + ], + "title": "PromotionMgr.activeCustomerPromotions" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#activeCustomerPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activeCustomerPromotions", + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static readonly activeCustomerPromotions: PromotionPlan", + "source": "script-api", + "tags": [ + "activecustomerpromotions", + "promotionmgr.activecustomerpromotions" + ], + "title": "PromotionMgr.activeCustomerPromotions" + }, + { + "description": "Returns all promotions scheduled for now, and applicable for the session currency but regardless of current customer or source code.", + "id": "script-api:dw/campaign/PromotionMgr#activePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activePromotions", + "sections": [ + { + "body": "Returns all promotions scheduled for now, and applicable for the\nsession currency but regardless of current customer or source code.\n\nThe active promotions are returned in an instance of dw.campaign.PromotionPlan.", + "heading": "Description" + } + ], + "signature": "static readonly activePromotions: PromotionPlan", + "source": "script-api", + "tags": [ + "activepromotions", + "promotionmgr.activepromotions" + ], + "title": "PromotionMgr.activePromotions" + }, + { + "description": "Returns all promotions scheduled for now, and applicable for the session currency but regardless of current customer or source code.", + "id": "script-api:dw/campaign/PromotionMgr#activePromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.activePromotions", + "sections": [ + { + "body": "Returns all promotions scheduled for now, and applicable for the\nsession currency but regardless of current customer or source code.\n\nThe active promotions are returned in an instance of dw.campaign.PromotionPlan.", + "heading": "Description" + } + ], + "signature": "static readonly activePromotions: PromotionPlan", + "source": "script-api", + "tags": [ + "activepromotions", + "promotionmgr.activepromotions" + ], + "title": "PromotionMgr.activePromotions" + }, + { + "description": "Identifies active promotions, calculates the applicable discounts from these promotions and applies these discounts to the specified line item container.", + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Identifies active promotions, calculates the applicable\ndiscounts from these promotions and applies these discounts to the\nspecified line item container.\n\nAs a result of this method, the specified line item container\ncontains price adjustments and/or bonus product line items for\nall applicable discounts. The method also removes price\nadjustment and/or bonus product line items from the line item\ncontainer if the related to promotions/discounts are no longer\napplicable.", + "heading": "Description" + } + ], + "signature": "static applyDiscounts(lineItemCtnr: LineItemCtnr): void", + "source": "script-api", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "description": "Applies the discounts contained in the specified discount plan to the line item container associated with the discount plan.", + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "discountPlan", + "type": "DiscountPlan" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies the discounts contained in the specified discount plan\nto the line item container associated with the discount\nplan.\n\nAs a result of this method, the specified line item container\ncontains price adjustments and/or bonus product line items for\nall discounts contained in the specified discount plan.\nThe method also removes price adjustment and/or bonus product line items\nfrom the line item container if the specified discount plan does not\ncontain the related discount.\n\nNote that the method does not evaluate if the discounts in the specified\ndiscount plan are applicable nor that the promotions related to these\ndiscounts are active.", + "heading": "Description" + } + ], + "signature": "static applyDiscounts(discountPlan: DiscountPlan): void", + "source": "script-api", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "description": "Identifies active promotions, calculates the applicable discounts from these promotions and applies these discounts to the specified line item container.", + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Identifies active promotions, calculates the applicable\ndiscounts from these promotions and applies these discounts to the\nspecified line item container.\n\nAs a result of this method, the specified line item container\ncontains price adjustments and/or bonus product line items for\nall applicable discounts. The method also removes price\nadjustment and/or bonus product line items from the line item\ncontainer if the related to promotions/discounts are no longer\napplicable.", + "heading": "Description" + } + ], + "signature": "static applyDiscounts(lineItemCtnr: LineItemCtnr): void", + "source": "script-api", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "description": "Applies the discounts contained in the specified discount plan to the line item container associated with the discount plan.", + "id": "script-api:dw/campaign/PromotionMgr#applyDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "discountPlan", + "type": "DiscountPlan" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.applyDiscounts", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies the discounts contained in the specified discount plan\nto the line item container associated with the discount\nplan.\n\nAs a result of this method, the specified line item container\ncontains price adjustments and/or bonus product line items for\nall discounts contained in the specified discount plan.\nThe method also removes price adjustment and/or bonus product line items\nfrom the line item container if the specified discount plan does not\ncontain the related discount.\n\nNote that the method does not evaluate if the discounts in the specified\ndiscount plan are applicable nor that the promotions related to these\ndiscounts are active.", + "heading": "Description" + } + ], + "signature": "static applyDiscounts(discountPlan: DiscountPlan): void", + "source": "script-api", + "tags": [ + "applydiscounts", + "promotionmgr.applydiscounts" + ], + "title": "PromotionMgr.applyDiscounts" + }, + { + "description": "Returns all campaigns of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#campaigns", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.campaigns", + "sections": [ + { + "body": "Returns all campaigns of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly campaigns: Collection", + "source": "script-api", + "tags": [ + "campaigns", + "promotionmgr.campaigns" + ], + "title": "PromotionMgr.campaigns" + }, + { + "description": "Returns all campaigns of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#campaigns", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.campaigns", + "sections": [ + { + "body": "Returns all campaigns of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly campaigns: Collection", + "source": "script-api", + "tags": [ + "campaigns", + "promotionmgr.campaigns" + ], + "title": "PromotionMgr.campaigns" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotions(): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "ignoreCouponCondition", + "type": "boolean" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotions(ignoreCouponCondition: boolean): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotions(): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "description": "Returns all promotions scheduled for now and applicable for the session currency, current customer, source code, or presented coupons.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "ignoreCouponCondition", + "type": "boolean" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now and applicable for the\nsession currency, current customer, source code, or presented coupons.\n\nThe active promotions are returned in an instance of\ndw.campaign.PromotionPlan. The promotion plan contains all\npromotions assigned to any customer group of the current customer, the\ncurrent source code, or coupons in the current session basket.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotions(ignoreCouponCondition: boolean): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivecustomerpromotions", + "promotionmgr.getactivecustomerpromotions" + ], + "title": "PromotionMgr.getActiveCustomerPromotions" + }, + { + "description": "Returns all promotions assigned to the passed campaign, which are active at some point within the specified date range, and are applicable for the current customer, source code, or presented coupons. A promotion must be active for an actual time period within the passed date range, and not just a single point.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "campaign", + "type": "Campaign | null" + }, + { + "name": "from", + "type": "Date" + }, + { + "name": "to", + "type": "Date" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotionsForCampaign", + "returns": { + "type": "PromotionPlan | null" + }, + "sections": [ + { + "body": "Returns all promotions assigned to the passed campaign, which are active\nat some point within the specified date range, and are applicable for the\ncurrent customer, source code, or presented coupons. A promotion must be\nactive for an actual time period within the passed date range, and not\njust a single point.\n\nThe passed campaign and dates must not be null or an exception is thrown.\nIt is valid for the from and to dates to be in the past. If an invalid\ntime range is specified (i.e. from is after to), the returned\nPromotionPlan will be empty.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotionsForCampaign(campaign: Campaign | null, from: Date, to: Date): PromotionPlan | null", + "source": "script-api", + "tags": [ + "getactivecustomerpromotionsforcampaign", + "promotionmgr.getactivecustomerpromotionsforcampaign" + ], + "title": "PromotionMgr.getActiveCustomerPromotionsForCampaign" + }, + { + "description": "Returns all promotions assigned to the passed campaign, which are active at some point within the specified date range, and are applicable for the current customer, source code, or presented coupons. A promotion must be active for an actual time period within the passed date range, and not just a single point.", + "id": "script-api:dw/campaign/PromotionMgr#getActiveCustomerPromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "campaign", + "type": "Campaign | null" + }, + { + "name": "from", + "type": "Date" + }, + { + "name": "to", + "type": "Date" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActiveCustomerPromotionsForCampaign", + "returns": { + "type": "PromotionPlan | null" + }, + "sections": [ + { + "body": "Returns all promotions assigned to the passed campaign, which are active\nat some point within the specified date range, and are applicable for the\ncurrent customer, source code, or presented coupons. A promotion must be\nactive for an actual time period within the passed date range, and not\njust a single point.\n\nThe passed campaign and dates must not be null or an exception is thrown.\nIt is valid for the from and to dates to be in the past. If an invalid\ntime range is specified (i.e. from is after to), the returned\nPromotionPlan will be empty.", + "heading": "Description" + } + ], + "signature": "static getActiveCustomerPromotionsForCampaign(campaign: Campaign | null, from: Date, to: Date): PromotionPlan | null", + "source": "script-api", + "tags": [ + "getactivecustomerpromotionsforcampaign", + "promotionmgr.getactivecustomerpromotionsforcampaign" + ], + "title": "PromotionMgr.getActiveCustomerPromotionsForCampaign" + }, + { + "description": "Returns all promotions scheduled for now, and applicable for the session currency but regardless of current customer or source code.", + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now, and applicable for the\nsession currency but regardless of current customer or source code.\n\nThe active promotions are returned in an instance of dw.campaign.PromotionPlan.", + "heading": "Description" + } + ], + "signature": "static getActivePromotions(): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivepromotions", + "promotionmgr.getactivepromotions" + ], + "title": "PromotionMgr.getActivePromotions" + }, + { + "description": "Returns all promotions scheduled for now, and applicable for the session currency but regardless of current customer or source code.", + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions scheduled for now, and applicable for the\nsession currency but regardless of current customer or source code.\n\nThe active promotions are returned in an instance of dw.campaign.PromotionPlan.", + "heading": "Description" + } + ], + "signature": "static getActivePromotions(): PromotionPlan", + "source": "script-api", + "tags": [ + "getactivepromotions", + "promotionmgr.getactivepromotions" + ], + "title": "PromotionMgr.getActivePromotions" + }, + { + "description": "Returns all promotions assigned to the passed campaign which are active at some point within the specified date range. A promotion must be active for an actual time period within the passed date range, and not just a single point. A promotion must be applicable for the session currency.", + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "campaign", + "type": "Campaign" + }, + { + "name": "from", + "type": "Date" + }, + { + "name": "to", + "type": "Date" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotionsForCampaign", + "returns": { + "type": "PromotionPlan | null" + }, + "sections": [ + { + "body": "Returns all promotions assigned to the passed campaign which are active\nat some point within the specified date range. A promotion must be active\nfor an actual time period within the passed date range, and not just a\nsingle point. A promotion must be applicable for the session currency.\n\nThis method considers only the enabled flags and time conditions of the\npromotion and campaign. It does not consider whether the current customer\nsatisfies the qualifiers of the promotion (customer group, source code,\nor coupon).\n\nThe passed campaign and dates must not be null or an exception is thrown.\nIt is valid for the from and/or to dates to be in the past. If an invalid\ntime range is specified (i.e. from is after to), the returned\nPromotionPlan will be empty.", + "heading": "Description" + } + ], + "signature": "static getActivePromotionsForCampaign(campaign: Campaign, from: Date, to: Date): PromotionPlan | null", + "source": "script-api", + "tags": [ + "getactivepromotionsforcampaign", + "promotionmgr.getactivepromotionsforcampaign" + ], + "title": "PromotionMgr.getActivePromotionsForCampaign" + }, + { + "description": "Returns all promotions assigned to the passed campaign which are active at some point within the specified date range. A promotion must be active for an actual time period within the passed date range, and not just a single point. A promotion must be applicable for the session currency.", + "id": "script-api:dw/campaign/PromotionMgr#getActivePromotionsForCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "campaign", + "type": "Campaign" + }, + { + "name": "from", + "type": "Date" + }, + { + "name": "to", + "type": "Date" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getActivePromotionsForCampaign", + "returns": { + "type": "PromotionPlan | null" + }, + "sections": [ + { + "body": "Returns all promotions assigned to the passed campaign which are active\nat some point within the specified date range. A promotion must be active\nfor an actual time period within the passed date range, and not just a\nsingle point. A promotion must be applicable for the session currency.\n\nThis method considers only the enabled flags and time conditions of the\npromotion and campaign. It does not consider whether the current customer\nsatisfies the qualifiers of the promotion (customer group, source code,\nor coupon).\n\nThe passed campaign and dates must not be null or an exception is thrown.\nIt is valid for the from and/or to dates to be in the past. If an invalid\ntime range is specified (i.e. from is after to), the returned\nPromotionPlan will be empty.", + "heading": "Description" + } + ], + "signature": "static getActivePromotionsForCampaign(campaign: Campaign, from: Date, to: Date): PromotionPlan | null", + "source": "script-api", + "tags": [ + "getactivepromotionsforcampaign", + "promotionmgr.getactivepromotionsforcampaign" + ], + "title": "PromotionMgr.getActivePromotionsForCampaign" + }, + { + "description": "Returns the campaign identified by the specified ID.", + "id": "script-api:dw/campaign/PromotionMgr#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaign", + "returns": { + "type": "Campaign | null" + }, + "sections": [ + { + "body": "Returns the campaign identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCampaign(id: string): Campaign | null", + "source": "script-api", + "tags": [ + "getcampaign", + "promotionmgr.getcampaign" + ], + "title": "PromotionMgr.getCampaign" + }, + { + "description": "Returns the campaign identified by the specified ID.", + "id": "script-api:dw/campaign/PromotionMgr#getCampaign", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaign", + "returns": { + "type": "Campaign | null" + }, + "sections": [ + { + "body": "Returns the campaign identified by the specified ID.", + "heading": "Description" + } + ], + "signature": "static getCampaign(id: string): Campaign | null", + "source": "script-api", + "tags": [ + "getcampaign", + "promotionmgr.getcampaign" + ], + "title": "PromotionMgr.getCampaign" + }, + { + "description": "Returns all campaigns of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#getCampaigns", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaigns", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all campaigns of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getCampaigns(): Collection", + "source": "script-api", + "tags": [ + "getcampaigns", + "promotionmgr.getcampaigns" + ], + "title": "PromotionMgr.getCampaigns" + }, + { + "description": "Returns all campaigns of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#getCampaigns", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getCampaigns", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all campaigns of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getCampaigns(): Collection", + "source": "script-api", + "tags": [ + "getcampaigns", + "promotionmgr.getcampaigns" + ], + "title": "PromotionMgr.getCampaigns" + }, + { + "description": "Returns the discounts applicable for the current customer, active source code and specified line item container.", + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "returns": { + "type": "DiscountPlan" + }, + "sections": [ + { + "body": "Returns the discounts applicable for the current customer, active\nsource code and specified line item container.\n\nThis method identifies all active promotions assigned to the customer\ngroups of the current customer, the active source code and any coupon\ncontained in the specified line item container, and calculates applicable\ndiscounts from these promotions.\n\nThe applicable discounts are contained in the returned instance of\ndw.campaign.DiscountPlan.", + "heading": "Description" + } + ], + "signature": "static getDiscounts(lineItemCtnr: LineItemCtnr): DiscountPlan", + "source": "script-api", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "description": "Returns the discounts applicable for the current customer, active source code and specified line item container, based on the specified promotion plan.", + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotionPlan", + "type": "PromotionPlan" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "returns": { + "type": "DiscountPlan" + }, + "sections": [ + { + "body": "Returns the discounts applicable for the current customer, active\nsource code and specified line item container, based on the specified\npromotion plan.\n\nThis method calculates applicable discounts from the promotions in the\nspecified promotion plan. Note that any promotion in the promotion\nplan that is inactive, or not applicable for the current customer\nor source code, is being ignored.\n\nThe applicable discounts are contained in the returned instance of\ndw.campaign.DiscountPlan.", + "heading": "Description" + } + ], + "signature": "static getDiscounts(lineItemCtnr: LineItemCtnr, promotionPlan: PromotionPlan): DiscountPlan", + "source": "script-api", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "description": "Returns the discounts applicable for the current customer, active source code and specified line item container.", + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "returns": { + "type": "DiscountPlan" + }, + "sections": [ + { + "body": "Returns the discounts applicable for the current customer, active\nsource code and specified line item container.\n\nThis method identifies all active promotions assigned to the customer\ngroups of the current customer, the active source code and any coupon\ncontained in the specified line item container, and calculates applicable\ndiscounts from these promotions.\n\nThe applicable discounts are contained in the returned instance of\ndw.campaign.DiscountPlan.", + "heading": "Description" + } + ], + "signature": "static getDiscounts(lineItemCtnr: LineItemCtnr): DiscountPlan", + "source": "script-api", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "description": "Returns the discounts applicable for the current customer, active source code and specified line item container, based on the specified promotion plan.", + "id": "script-api:dw/campaign/PromotionMgr#getDiscounts", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + }, + { + "name": "promotionPlan", + "type": "PromotionPlan" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getDiscounts", + "returns": { + "type": "DiscountPlan" + }, + "sections": [ + { + "body": "Returns the discounts applicable for the current customer, active\nsource code and specified line item container, based on the specified\npromotion plan.\n\nThis method calculates applicable discounts from the promotions in the\nspecified promotion plan. Note that any promotion in the promotion\nplan that is inactive, or not applicable for the current customer\nor source code, is being ignored.\n\nThe applicable discounts are contained in the returned instance of\ndw.campaign.DiscountPlan.", + "heading": "Description" + } + ], + "signature": "static getDiscounts(lineItemCtnr: LineItemCtnr, promotionPlan: PromotionPlan): DiscountPlan", + "source": "script-api", + "tags": [ + "getdiscounts", + "promotionmgr.getdiscounts" + ], + "title": "PromotionMgr.getDiscounts" + }, + { + "description": "Returns the promotion identified by the specified ID. The same logical promotion may be assigned to multiple campaigns or AB-tests. In this case, the system returns the instance of highest rank. Some attributes of the returned Promotion may vary based on exactly which instance is returned. This method returns null if there is no promotion in the system with the given ID, or if a promotion with the given ID exists but it is not assigned to any campaign or AB-test.", + "id": "script-api:dw/campaign/PromotionMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion identified by the specified ID. The same logical\npromotion may be assigned to multiple campaigns or AB-tests. In this\ncase, the system returns the instance of highest rank. Some attributes of\nthe returned Promotion may vary based on exactly which instance is\nreturned. This method returns null if there is no promotion in the system\nwith the given ID, or if a promotion with the given ID exists but it is\nnot assigned to any campaign or AB-test.", + "heading": "Description" + } + ], + "signature": "static getPromotion(id: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "promotionmgr.getpromotion" + ], + "title": "PromotionMgr.getPromotion" + }, + { + "description": "Returns the promotion identified by the specified ID. The same logical promotion may be assigned to multiple campaigns or AB-tests. In this case, the system returns the instance of highest rank. Some attributes of the returned Promotion may vary based on exactly which instance is returned. This method returns null if there is no promotion in the system with the given ID, or if a promotion with the given ID exists but it is not assigned to any campaign or AB-test.", + "id": "script-api:dw/campaign/PromotionMgr#getPromotion", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion identified by the specified ID. The same logical\npromotion may be assigned to multiple campaigns or AB-tests. In this\ncase, the system returns the instance of highest rank. Some attributes of\nthe returned Promotion may vary based on exactly which instance is\nreturned. This method returns null if there is no promotion in the system\nwith the given ID, or if a promotion with the given ID exists but it is\nnot assigned to any campaign or AB-test.", + "heading": "Description" + } + ], + "signature": "static getPromotion(id: string): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "promotionmgr.getpromotion" + ], + "title": "PromotionMgr.getPromotion" + }, + { + "description": "Returns all promotions of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all promotions of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getPromotions(): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "promotionmgr.getpromotions" + ], + "title": "PromotionMgr.getPromotions" + }, + { + "description": "Returns all promotions of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all promotions of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static getPromotions(): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "promotionmgr.getpromotions" + ], + "title": "PromotionMgr.getPromotions" + }, + { + "description": "Returns all promotions currently inactive, but scheduled for any time between now and now + previewTime(hours), and which are applicable based on the current customer, source code, and coupons in the current basket.", + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "previewTime", + "type": "number" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions currently inactive, but scheduled\nfor any time between now and now + previewTime(hours),\nand which are applicable based on the current customer, source code, and\ncoupons in the current basket.\n\nThe parameter previewTime specifies for how many hours promotions\nshould be previewed.", + "heading": "Description" + } + ], + "signature": "static getUpcomingCustomerPromotions(previewTime: number): PromotionPlan", + "source": "script-api", + "tags": [ + "getupcomingcustomerpromotions", + "promotionmgr.getupcomingcustomerpromotions" + ], + "title": "PromotionMgr.getUpcomingCustomerPromotions" + }, + { + "description": "Returns all promotions currently inactive, but scheduled for any time between now and now + previewTime(hours), and which are applicable based on the current customer, source code, and coupons in the current basket.", + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingCustomerPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "previewTime", + "type": "number" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingCustomerPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions currently inactive, but scheduled\nfor any time between now and now + previewTime(hours),\nand which are applicable based on the current customer, source code, and\ncoupons in the current basket.\n\nThe parameter previewTime specifies for how many hours promotions\nshould be previewed.", + "heading": "Description" + } + ], + "signature": "static getUpcomingCustomerPromotions(previewTime: number): PromotionPlan", + "source": "script-api", + "tags": [ + "getupcomingcustomerpromotions", + "promotionmgr.getupcomingcustomerpromotions" + ], + "title": "PromotionMgr.getUpcomingCustomerPromotions" + }, + { + "description": "Returns all promotions currently inactive, but scheduled for any time between now and now + previewTime(hours).", + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "previewTime", + "type": "number" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions currently inactive, but scheduled\nfor any time between now and now + previewTime(hours).\n\nThe upcoming promotions are returned in an instance of\ndw.campaign.PromotionPlan and might not necessarily be applicable for\nthe current customer or source code.\n\nThe parameter previewTime specifies for how many hours promotions\nshould be previewed.", + "heading": "Description" + } + ], + "signature": "static getUpcomingPromotions(previewTime: number): PromotionPlan", + "source": "script-api", + "tags": [ + "getupcomingpromotions", + "promotionmgr.getupcomingpromotions" + ], + "title": "PromotionMgr.getUpcomingPromotions" + }, + { + "description": "Returns all promotions currently inactive, but scheduled for any time between now and now + previewTime(hours).", + "id": "script-api:dw/campaign/PromotionMgr#getUpcomingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "previewTime", + "type": "number" + } + ], + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.getUpcomingPromotions", + "returns": { + "type": "PromotionPlan" + }, + "sections": [ + { + "body": "Returns all promotions currently inactive, but scheduled\nfor any time between now and now + previewTime(hours).\n\nThe upcoming promotions are returned in an instance of\ndw.campaign.PromotionPlan and might not necessarily be applicable for\nthe current customer or source code.\n\nThe parameter previewTime specifies for how many hours promotions\nshould be previewed.", + "heading": "Description" + } + ], + "signature": "static getUpcomingPromotions(previewTime: number): PromotionPlan", + "source": "script-api", + "tags": [ + "getupcomingpromotions", + "promotionmgr.getupcomingpromotions" + ], + "title": "PromotionMgr.getUpcomingPromotions" + }, + { + "description": "Returns all promotions of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.promotions", + "sections": [ + { + "body": "Returns all promotions of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly promotions: Collection", + "source": "script-api", + "tags": [ + "promotions", + "promotionmgr.promotions" + ], + "title": "PromotionMgr.promotions" + }, + { + "description": "Returns all promotions of the current site in no specific order.", + "id": "script-api:dw/campaign/PromotionMgr#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionMgr", + "qualifiedName": "dw.campaign.PromotionMgr.promotions", + "sections": [ + { + "body": "Returns all promotions of the current site in no specific order.", + "heading": "Description" + } + ], + "signature": "static readonly promotions: Collection", + "source": "script-api", + "tags": [ + "promotions", + "promotionmgr.promotions" + ], + "title": "PromotionMgr.promotions" + }, + { + "description": "PromotionPlan represents a set of dw.campaign.Promotion instances and is used to display active or upcoming promotions on storefront pages, or to pass it to the dw.campaign.PromotionMgr to calculate a dw.campaign.DiscountPlan and subsequently apply discounts to a line item container. Instances of the class are returned by the dw.campaign.PromotionMgr.getActivePromotions, dw.campaign.PromotionMgr.getActiveCustomerPromotions and dw.campaign.PromotionMgr.getUpcomingPromotions.", + "id": "script-api:dw/campaign/PromotionPlan", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.PromotionPlan", + "sections": [ + { + "body": "PromotionPlan represents a set of dw.campaign.Promotion instances and\nis used to display active or upcoming promotions on storefront pages, or to\npass it to the dw.campaign.PromotionMgr to calculate a\ndw.campaign.DiscountPlan and subsequently apply discounts to a line\nitem container. Instances of the class are returned by the\ndw.campaign.PromotionMgr.getActivePromotions,\ndw.campaign.PromotionMgr.getActiveCustomerPromotions and\ndw.campaign.PromotionMgr.getUpcomingPromotions.\n\nPromotionPlan provides methods to access the promotions in the plan and to\nremove promotions from the plan. All methods which return a collection of\npromotions sort them by the following ordered criteria:\n\n- Exclusivity: GLOBAL exclusive promotions first, followed by CLASS\nexclusive promotions, and NO exclusive promotions last.\n- Rank: sorted ascending\n- Promotion Class: PRODUCT promotions first, followed by ORDER promotions,\nand SHIPPING promotions last.\n- Discount type: Fixed price promotions first, followed by free,\namount-off, percentage-off, and bonus product promotions last.\n- Best discount: Sorted descending. For example, 30% off comes before 20%\noff.\n- ID: alphanumeric ascending.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "promotionplan", + "dw.campaign.promotionplan", + "dw/campaign" + ], + "title": "PromotionPlan" + }, + { + "description": "Constant indicating that a collection of promotions should be sorted first by exclusivity, then rank, promotion class, etc. See class-level javadoc for details. This is the default sort order for methods that return a collection of promotions.", + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_EXCLUSIVITY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_EXCLUSIVITY", + "sections": [ + { + "body": "Constant indicating that a collection of promotions should be sorted\nfirst by exclusivity, then rank, promotion class, etc. See class-level\njavadoc for details. This is the default sort order for methods that\nreturn a collection of promotions.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_EXCLUSIVITY = 1", + "source": "script-api", + "tags": [ + "sort_by_exclusivity", + "promotionplan.sort_by_exclusivity" + ], + "title": "PromotionPlan.SORT_BY_EXCLUSIVITY" + }, + { + "description": "Constant indicating that a collection of promotions should be sorted first by exclusivity, then rank, promotion class, etc. See class-level javadoc for details. This is the default sort order for methods that return a collection of promotions.", + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_EXCLUSIVITY", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_EXCLUSIVITY", + "sections": [ + { + "body": "Constant indicating that a collection of promotions should be sorted\nfirst by exclusivity, then rank, promotion class, etc. See class-level\njavadoc for details. This is the default sort order for methods that\nreturn a collection of promotions.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_EXCLUSIVITY = 1", + "source": "script-api", + "tags": [ + "sort_by_exclusivity", + "promotionplan.sort_by_exclusivity" + ], + "title": "PromotionPlan.SORT_BY_EXCLUSIVITY" + }, + { + "description": "Constant indicating that a collection of promotions should be sorted by start date ascending. If there is no explicit start date for a promotion the start date of its containing Campaign or AB-test is used instead. Promotions without a start date are sorted before promotions with a start date in the future and after promotions with a start date in the past. In case two promotion assignments have the same start date, they are sorted by their ID.", + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_START_DATE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_START_DATE", + "sections": [ + { + "body": "Constant indicating that a collection of promotions should be sorted by\nstart date ascending. If there is no explicit start date for a promotion\nthe start date of its containing Campaign or AB-test is used instead.\nPromotions without a start date are sorted before promotions with a start\ndate in the future and after promotions with a start date in the past. In\ncase two promotion assignments have the same start date, they are sorted\nby their ID.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_START_DATE = 2", + "source": "script-api", + "tags": [ + "sort_by_start_date", + "promotionplan.sort_by_start_date" + ], + "title": "PromotionPlan.SORT_BY_START_DATE" + }, + { + "description": "Constant indicating that a collection of promotions should be sorted by start date ascending. If there is no explicit start date for a promotion the start date of its containing Campaign or AB-test is used instead. Promotions without a start date are sorted before promotions with a start date in the future and after promotions with a start date in the past. In case two promotion assignments have the same start date, they are sorted by their ID.", + "id": "script-api:dw/campaign/PromotionPlan#SORT_BY_START_DATE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.SORT_BY_START_DATE", + "sections": [ + { + "body": "Constant indicating that a collection of promotions should be sorted by\nstart date ascending. If there is no explicit start date for a promotion\nthe start date of its containing Campaign or AB-test is used instead.\nPromotions without a start date are sorted before promotions with a start\ndate in the future and after promotions with a start date in the past. In\ncase two promotion assignments have the same start date, they are sorted\nby their ID.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_START_DATE = 2", + "source": "script-api", + "tags": [ + "sort_by_start_date", + "promotionplan.sort_by_start_date" + ], + "title": "PromotionPlan.SORT_BY_START_DATE" + }, + { + "description": "Returns all order promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#getOrderPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getOrderPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all order promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "getOrderPromotions(): Collection", + "source": "script-api", + "tags": [ + "getorderpromotions", + "promotionplan.getorderpromotions" + ], + "title": "PromotionPlan.getOrderPromotions" + }, + { + "description": "Returns the order promotions explicitly associated to the specified discounted payment card.", + "id": "script-api:dw/campaign/PromotionPlan#getPaymentCardPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "paymentCard", + "type": "PaymentCard" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPaymentCardPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the order promotions explicitly associated to the specified\ndiscounted payment card.\n\nThis method is usually used to display order promotions along with\npayment card choices.", + "heading": "Description" + } + ], + "signature": "getPaymentCardPromotions(paymentCard: PaymentCard): Collection", + "source": "script-api", + "tags": [ + "getpaymentcardpromotions", + "promotionplan.getpaymentcardpromotions" + ], + "title": "PromotionPlan.getPaymentCardPromotions" + }, + { + "description": "Returns the order promotions explicitly associated to the specified discounted payment method.", + "id": "script-api:dw/campaign/PromotionPlan#getPaymentMethodPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "paymentMethod", + "type": "PaymentMethod" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPaymentMethodPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the order promotions explicitly associated to the specified\ndiscounted payment method.\n\nThis method is usually used to display order promotions along with\npayment method choices.", + "heading": "Description" + } + ], + "signature": "getPaymentMethodPromotions(paymentMethod: PaymentMethod): Collection", + "source": "script-api", + "tags": [ + "getpaymentmethodpromotions", + "promotionplan.getpaymentmethodpromotions" + ], + "title": "PromotionPlan.getPaymentMethodPromotions" + }, + { + "description": "Returns all product promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "getProductPromotions(): Collection", + "source": "script-api", + "tags": [ + "getproductpromotions", + "promotionplan.getproductpromotions" + ], + "title": "PromotionPlan.getProductPromotions" + }, + { + "description": "Returns the promotions related to the specified product.", + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the promotions related to the specified product.\n\nThe method returns all promotions where the product is either a\nqualifying product, or a discounted product, or both. It also returns\npromotions where the specified product is a bonus product.\n\nThis method is usually used to display product promotions on a product\ndetails page.\n\nIf a master product is passed, then this method will return promotions\nwhich are relevant for the master itself or at least one of its variants.", + "heading": "Description" + } + ], + "signature": "getProductPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getproductpromotions", + "promotionplan.getproductpromotions" + ], + "title": "PromotionPlan.getProductPromotions" + }, + { + "description": "Returns the product promotions for which the specified product is a discounted (and possibly also a qualifying) product. It also returns promotions where the specified product is a bonus product.", + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotionsForDiscountedProduct", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotionsForDiscountedProduct", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product promotions for which the specified product is a\ndiscounted (and possibly also a qualifying) product. It also returns\npromotions where the specified product is a bonus product.\n\nThis method is usually used to display product promotions on a product\ndetails page when separate callout messages are defined depending on if\nthe product is a qualifying or discounted product for the promotion.\n\nIf a master product is passed, then this method will return promotions\nfor which the master product itself or at least one of its product's\nvariants is a discounted product.", + "heading": "Description" + } + ], + "signature": "getProductPromotionsForDiscountedProduct(product: Product): Collection", + "source": "script-api", + "tags": [ + "getproductpromotionsfordiscountedproduct", + "promotionplan.getproductpromotionsfordiscountedproduct" + ], + "title": "PromotionPlan.getProductPromotionsForDiscountedProduct" + }, + { + "description": "Returns the product promotions for which the specified product is a qualifying but NOT a discounted product.", + "id": "script-api:dw/campaign/PromotionPlan#getProductPromotionsForQualifyingProduct", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getProductPromotionsForQualifyingProduct", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product promotions for which the specified product is a\nqualifying but NOT a discounted product.\n\nThis method is usually used to display product promotions on a product\ndetails page when separate callout messages are defined depending on if\nthe product is a qualifying or discounted product for the promotion.\n\nIf a master product is passed, then this method will return promotions\nfor which the master product itself or at least one of its product's\nvariants is a qualifying product.", + "heading": "Description" + } + ], + "signature": "getProductPromotionsForQualifyingProduct(product: Product): Collection", + "source": "script-api", + "tags": [ + "getproductpromotionsforqualifyingproduct", + "promotionplan.getproductpromotionsforqualifyingproduct" + ], + "title": "PromotionPlan.getProductPromotionsForQualifyingProduct" + }, + { + "description": "Returns all promotions contained in this plan sorted by exclusivity.", + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all promotions contained in this plan sorted by exclusivity.", + "heading": "Description" + } + ], + "signature": "getPromotions(): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "description": "Returns all promotions contained in this plan sorted according to the specified sort order. If the passed sort order is invalid, then the returned promotions will be sorted by exclusivity.", + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "sortOrder", + "type": "number" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all promotions contained in this plan sorted according to the\nspecified sort order. If the passed sort order is invalid, then the\nreturned promotions will be sorted by exclusivity.", + "heading": "Description" + } + ], + "signature": "getPromotions(sortOrder: number): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "deprecated": { + "message": "Use getProductPromotions" + }, + "description": "Returns the promotions related to the specified product.", + "id": "script-api:dw/campaign/PromotionPlan#getPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the promotions related to the specified product.\n\nThe method returns all promotions where the product is either\na qualifying product, or a discounted product, or both. It also\nreturns promotions where the specified product is a bonus product.\n\nThis method is usually used to display product promotions on a\nproduct details page.", + "heading": "Description" + } + ], + "signature": "getPromotions(product: Product): Collection", + "source": "script-api", + "tags": [ + "getpromotions", + "promotionplan.getpromotions" + ], + "title": "PromotionPlan.getPromotions" + }, + { + "description": "Returns all shipping promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#getShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getShippingPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all shipping promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "getShippingPromotions(): Collection", + "source": "script-api", + "tags": [ + "getshippingpromotions", + "promotionplan.getshippingpromotions" + ], + "title": "PromotionPlan.getShippingPromotions" + }, + { + "description": "Returns the shipping promotions related to the specified discounted shipping method, i.e. the returned promotions apply a discount on the specified shipping method.", + "id": "script-api:dw/campaign/PromotionPlan#getShippingPromotions", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "shippingMethod", + "type": "ShippingMethod" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.getShippingPromotions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the shipping promotions related to the specified discounted\nshipping method, i.e. the returned promotions apply a discount on\nthe specified shipping method.\n\nThis method is usually used to display shipping promotions along with\nshipping methods.", + "heading": "Description" + } + ], + "signature": "getShippingPromotions(shippingMethod: ShippingMethod): Collection", + "source": "script-api", + "tags": [ + "getshippingpromotions", + "promotionplan.getshippingpromotions" + ], + "title": "PromotionPlan.getShippingPromotions" + }, + { + "description": "Returns all order promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#orderPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.orderPromotions", + "sections": [ + { + "body": "Returns all order promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "readonly orderPromotions: Collection", + "source": "script-api", + "tags": [ + "orderpromotions", + "promotionplan.orderpromotions" + ], + "title": "PromotionPlan.orderPromotions" + }, + { + "description": "Returns all product promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#productPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.productPromotions", + "sections": [ + { + "body": "Returns all product promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "readonly productPromotions: Collection", + "source": "script-api", + "tags": [ + "productpromotions", + "promotionplan.productpromotions" + ], + "title": "PromotionPlan.productPromotions" + }, + { + "description": "Returns all promotions contained in this plan sorted by exclusivity.", + "id": "script-api:dw/campaign/PromotionPlan#promotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.promotions", + "sections": [ + { + "body": "Returns all promotions contained in this plan sorted by exclusivity.", + "heading": "Description" + } + ], + "signature": "readonly promotions: Collection", + "source": "script-api", + "tags": [ + "promotions", + "promotionplan.promotions" + ], + "title": "PromotionPlan.promotions" + }, + { + "description": "Remove promotion from promotion plan.", + "id": "script-api:dw/campaign/PromotionPlan#removePromotion", + "kind": "method", + "packagePath": "dw/campaign", + "params": [ + { + "name": "promotion", + "type": "Promotion" + } + ], + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.removePromotion", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove promotion from promotion plan.\n\nPlease note that this is the only way to remove promotions from the\nplan, i.e. removing promotions from the collections returned\nby methods such as getProductPromotions has no effect\non the promotion plan.", + "heading": "Description" + } + ], + "signature": "removePromotion(promotion: Promotion): void", + "source": "script-api", + "tags": [ + "removepromotion", + "promotionplan.removepromotion" + ], + "title": "PromotionPlan.removePromotion" + }, + { + "description": "Returns all shipping promotions contained in this plan.", + "id": "script-api:dw/campaign/PromotionPlan#shippingPromotions", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/PromotionPlan", + "qualifiedName": "dw.campaign.PromotionPlan.shippingPromotions", + "sections": [ + { + "body": "Returns all shipping promotions contained in this plan.", + "heading": "Description" + } + ], + "signature": "readonly shippingPromotions: Collection", + "source": "script-api", + "tags": [ + "shippingpromotions", + "promotionplan.shippingpromotions" + ], + "title": "PromotionPlan.shippingPromotions" + }, + { + "description": "Represents content for a slot.", + "id": "script-api:dw/campaign/SlotContent", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SlotContent", + "sections": [ + { + "body": "Represents content for a slot.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "slotcontent", + "dw.campaign.slotcontent", + "dw/campaign" + ], + "title": "SlotContent" + }, + { + "description": "Returns the callout message for the slot.", + "id": "script-api:dw/campaign/SlotContent#calloutMsg", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.calloutMsg", + "sections": [ + { + "body": "Returns the callout message for the slot.", + "heading": "Description" + } + ], + "signature": "readonly calloutMsg: MarkupText", + "source": "script-api", + "tags": [ + "calloutmsg", + "slotcontent.calloutmsg" + ], + "title": "SlotContent.calloutMsg" + }, + { + "description": "Returns a collection of content based on the content type for the slot. The collection will include one of the following types: dw.catalog.Product, dw.content.Content, dw.catalog.Category, or dw.content.MarkupText.", + "id": "script-api:dw/campaign/SlotContent#content", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.content", + "sections": [ + { + "body": "Returns a collection of content based on the content type\nfor the slot. The collection will include one of the following\ntypes: dw.catalog.Product, dw.content.Content, dw.catalog.Category, or dw.content.MarkupText.", + "heading": "Description" + } + ], + "signature": "readonly content: Collection", + "source": "script-api", + "tags": [ + "content", + "slotcontent.content" + ], + "title": "SlotContent.content" + }, + { + "description": "Returns the custom attributes for the slot.", + "id": "script-api:dw/campaign/SlotContent#custom", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.custom", + "sections": [ + { + "body": "Returns the custom attributes for the slot.", + "heading": "Description" + } + ], + "signature": "readonly custom: utilMap", + "source": "script-api", + "tags": [ + "custom", + "slotcontent.custom" + ], + "title": "SlotContent.custom" + }, + { + "description": "Returns the callout message for the slot.", + "id": "script-api:dw/campaign/SlotContent#getCalloutMsg", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getCalloutMsg", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the callout message for the slot.", + "heading": "Description" + } + ], + "signature": "getCalloutMsg(): MarkupText", + "source": "script-api", + "tags": [ + "getcalloutmsg", + "slotcontent.getcalloutmsg" + ], + "title": "SlotContent.getCalloutMsg" + }, + { + "description": "Returns a collection of content based on the content type for the slot. The collection will include one of the following types: dw.catalog.Product, dw.content.Content, dw.catalog.Category, or dw.content.MarkupText.", + "id": "script-api:dw/campaign/SlotContent#getContent", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getContent", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of content based on the content type\nfor the slot. The collection will include one of the following\ntypes: dw.catalog.Product, dw.content.Content, dw.catalog.Category, or dw.content.MarkupText.", + "heading": "Description" + } + ], + "signature": "getContent(): Collection", + "source": "script-api", + "tags": [ + "getcontent", + "slotcontent.getcontent" + ], + "title": "SlotContent.getContent" + }, + { + "description": "Returns the custom attributes for the slot.", + "id": "script-api:dw/campaign/SlotContent#getCustom", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getCustom", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the custom attributes for the slot.", + "heading": "Description" + } + ], + "signature": "getCustom(): utilMap", + "source": "script-api", + "tags": [ + "getcustom", + "slotcontent.getcustom" + ], + "title": "SlotContent.getCustom" + }, + { + "description": "Returns the recommender name for slot configurations of type 'Recommendation'", + "id": "script-api:dw/campaign/SlotContent#getRecommenderName", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getRecommenderName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the recommender name for slot configurations of type 'Recommendation'", + "heading": "Description" + } + ], + "signature": "getRecommenderName(): string", + "source": "script-api", + "tags": [ + "getrecommendername", + "slotcontent.getrecommendername" + ], + "title": "SlotContent.getRecommenderName" + }, + { + "description": "Returns the unique slot ID.", + "id": "script-api:dw/campaign/SlotContent#getSlotID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.getSlotID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique slot ID.", + "heading": "Description" + } + ], + "signature": "getSlotID(): string", + "source": "script-api", + "tags": [ + "getslotid", + "slotcontent.getslotid" + ], + "title": "SlotContent.getSlotID" + }, + { + "description": "Returns the recommender name for slot configurations of type 'Recommendation'", + "id": "script-api:dw/campaign/SlotContent#recommenderName", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.recommenderName", + "sections": [ + { + "body": "Returns the recommender name for slot configurations of type 'Recommendation'", + "heading": "Description" + } + ], + "signature": "readonly recommenderName: string", + "source": "script-api", + "tags": [ + "recommendername", + "slotcontent.recommendername" + ], + "title": "SlotContent.recommenderName" + }, + { + "description": "Returns the unique slot ID.", + "id": "script-api:dw/campaign/SlotContent#slotID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SlotContent", + "qualifiedName": "dw.campaign.SlotContent.slotID", + "sections": [ + { + "body": "Returns the unique slot ID.", + "heading": "Description" + } + ], + "signature": "readonly slotID: string", + "source": "script-api", + "tags": [ + "slotid", + "slotcontent.slotid" + ], + "title": "SlotContent.slotID" + }, + { + "description": "A source code group defines a collection of source codes. Source code groups are generally pattern based and any source code satisfying the pattern belongs to the group. In this way, merchants may define a large set of source codes which qualify a customer for site experiences (different prices, for example), which customers without that source code do not receive. The class dw.campaign.SourceCodeInfo represents an individual source code.", + "id": "script-api:dw/campaign/SourceCodeGroup", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeGroup", + "sections": [ + { + "body": "A source code group defines a collection of source codes. Source code groups\nare generally pattern based and any source code satisfying the pattern\nbelongs to the group. In this way, merchants may define a large set of source\ncodes which qualify a customer for site experiences (different prices, for\nexample), which customers without that source code do not receive.\nThe class dw.campaign.SourceCodeInfo represents an individual source\ncode.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "sourcecodegroup", + "dw.campaign.sourcecodegroup", + "dw/campaign" + ], + "title": "SourceCodeGroup" + }, + { + "description": "The ID of the SourceCodeGroup.", + "id": "script-api:dw/campaign/SourceCodeGroup#ID", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.ID", + "sections": [ + { + "body": "The ID of the SourceCodeGroup.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "sourcecodegroup.id" + ], + "title": "SourceCodeGroup.ID" + }, + { + "description": "The ID of the SourceCodeGroup.", + "id": "script-api:dw/campaign/SourceCodeGroup#getID", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The ID of the SourceCodeGroup.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "sourcecodegroup.getid" + ], + "title": "SourceCodeGroup.getID" + }, + { + "description": "Returns a Collection of PriceBooks the SourceCodeGroup is assigned to.", + "id": "script-api:dw/campaign/SourceCodeGroup#getPriceBooks", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.getPriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a Collection of PriceBooks the SourceCodeGroup is assigned to.", + "heading": "Description" + } + ], + "signature": "getPriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getpricebooks", + "sourcecodegroup.getpricebooks" + ], + "title": "SourceCodeGroup.getPriceBooks" + }, + { + "description": "Returns a Collection of PriceBooks the SourceCodeGroup is assigned to.", + "id": "script-api:dw/campaign/SourceCodeGroup#priceBooks", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeGroup", + "qualifiedName": "dw.campaign.SourceCodeGroup.priceBooks", + "sections": [ + { + "body": "Returns a Collection of PriceBooks the SourceCodeGroup is assigned to.", + "heading": "Description" + } + ], + "signature": "readonly priceBooks: Collection", + "source": "script-api", + "tags": [ + "pricebooks", + "sourcecodegroup.pricebooks" + ], + "title": "SourceCodeGroup.priceBooks" + }, + { + "description": "Class representing a code (i.e. a \"source code\") that has been applied to a customer's session. Source codes can qualify customers for different campaigns, promotions, and other site experiences from those that the typical customer sees. Codes are organized into source code groups.", + "id": "script-api:dw/campaign/SourceCodeInfo", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeInfo", + "sections": [ + { + "body": "Class representing a code (i.e. a \"source code\") that has been applied to a\ncustomer's session. Source codes can qualify customers for different\ncampaigns, promotions, and other site experiences from those that the typical\ncustomer sees. Codes are organized into source code groups.\n\nTypically, a code is applied to a customer's session automatically by\nCommerce Cloud Digital when a customer accesses a Digital URL with a well\nknown request parameter in the querystring. A code may also be explicitly\napplied to a customer session using the `SetSourceCode`\npipelet.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sourcecodeinfo", + "dw.campaign.sourcecodeinfo", + "dw/campaign" + ], + "title": "SourceCodeInfo" + }, + { + "description": "The literal source-code is found and currently active.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_ACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_ACTIVE", + "sections": [ + { + "body": "The literal source-code is found and currently active.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_ACTIVE = 2", + "source": "script-api", + "tags": [ + "status_active", + "sourcecodeinfo.status_active" + ], + "title": "SourceCodeInfo.STATUS_ACTIVE" + }, + { + "description": "The literal source-code is found and currently active.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_ACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_ACTIVE", + "sections": [ + { + "body": "The literal source-code is found and currently active.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_ACTIVE = 2", + "source": "script-api", + "tags": [ + "status_active", + "sourcecodeinfo.status_active" + ], + "title": "SourceCodeInfo.STATUS_ACTIVE" + }, + { + "description": "The literal source-code is found but not active.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INACTIVE", + "sections": [ + { + "body": "The literal source-code is found but not active.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_INACTIVE = 1", + "source": "script-api", + "tags": [ + "status_inactive", + "sourcecodeinfo.status_inactive" + ], + "title": "SourceCodeInfo.STATUS_INACTIVE" + }, + { + "description": "The literal source-code is found but not active.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INACTIVE", + "sections": [ + { + "body": "The literal source-code is found but not active.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_INACTIVE = 1", + "source": "script-api", + "tags": [ + "status_inactive", + "sourcecodeinfo.status_inactive" + ], + "title": "SourceCodeInfo.STATUS_INACTIVE" + }, + { + "description": "The literal source-code is not found in the system.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INVALID", + "sections": [ + { + "body": "The literal source-code is not found in the system.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_INVALID = 0", + "source": "script-api", + "tags": [ + "status_invalid", + "sourcecodeinfo.status_invalid" + ], + "title": "SourceCodeInfo.STATUS_INVALID" + }, + { + "description": "The literal source-code is not found in the system.", + "id": "script-api:dw/campaign/SourceCodeInfo#STATUS_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.STATUS_INVALID", + "sections": [ + { + "body": "The literal source-code is not found in the system.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_INVALID = 0", + "source": "script-api", + "tags": [ + "status_invalid", + "sourcecodeinfo.status_invalid" + ], + "title": "SourceCodeInfo.STATUS_INVALID" + }, + { + "description": "The literal source-code.", + "id": "script-api:dw/campaign/SourceCodeInfo#code", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.code", + "sections": [ + { + "body": "The literal source-code.", + "heading": "Description" + } + ], + "signature": "readonly code: string", + "source": "script-api", + "tags": [ + "code", + "sourcecodeinfo.code" + ], + "title": "SourceCodeInfo.code" + }, + { + "description": "The literal source-code.", + "id": "script-api:dw/campaign/SourceCodeInfo#getCode", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The literal source-code.", + "heading": "Description" + } + ], + "signature": "getCode(): string", + "source": "script-api", + "tags": [ + "getcode", + "sourcecodeinfo.getcode" + ], + "title": "SourceCodeInfo.getCode" + }, + { + "description": "The associated source-code group.", + "id": "script-api:dw/campaign/SourceCodeInfo#getGroup", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getGroup", + "returns": { + "type": "SourceCodeGroup" + }, + "sections": [ + { + "body": "The associated source-code group.", + "heading": "Description" + } + ], + "signature": "getGroup(): SourceCodeGroup", + "source": "script-api", + "tags": [ + "getgroup", + "sourcecodeinfo.getgroup" + ], + "title": "SourceCodeInfo.getGroup" + }, + { + "description": "Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists, then the redirect information is retrieved from the source-code preferences, based on the active/inactive status of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.", + "id": "script-api:dw/campaign/SourceCodeInfo#getRedirect", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getRedirect", + "returns": { + "type": "URLRedirect | null" + }, + "sections": [ + { + "body": "Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists,\nthen the redirect information is retrieved from the source-code preferences, based on the active/inactive status\nof the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information\ncannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.", + "heading": "Description" + } + ], + "signature": "getRedirect(): URLRedirect | null", + "source": "script-api", + "tags": [ + "getredirect", + "sourcecodeinfo.getredirect" + ], + "title": "SourceCodeInfo.getRedirect" + }, + { + "description": "The status of the source-code. One of the following: STATUS_INVALID - The source code is not found in the system. STATUS_INACTIVE - The source code is found but not active. STATUS_INACTIVE - The source code is found and active.", + "id": "script-api:dw/campaign/SourceCodeInfo#getStatus", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.getStatus", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "The status of the source-code. One of the following:\nSTATUS_INVALID - The source code is not found in the system.\nSTATUS_INACTIVE - The source code is found but not active.\nSTATUS_INACTIVE - The source code is found and active.", + "heading": "Description" + } + ], + "signature": "getStatus(): number", + "source": "script-api", + "tags": [ + "getstatus", + "sourcecodeinfo.getstatus" + ], + "title": "SourceCodeInfo.getStatus" + }, + { + "description": "The associated source-code group.", + "id": "script-api:dw/campaign/SourceCodeInfo#group", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.group", + "sections": [ + { + "body": "The associated source-code group.", + "heading": "Description" + } + ], + "signature": "readonly group: SourceCodeGroup", + "source": "script-api", + "tags": [ + "group", + "sourcecodeinfo.group" + ], + "title": "SourceCodeInfo.group" + }, + { + "description": "Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists, then the redirect information is retrieved from the source-code preferences, based on the active/inactive status of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.", + "id": "script-api:dw/campaign/SourceCodeInfo#redirect", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.redirect", + "sections": [ + { + "body": "Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists,\nthen the redirect information is retrieved from the source-code preferences, based on the active/inactive status\nof the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information\ncannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.", + "heading": "Description" + } + ], + "signature": "readonly redirect: URLRedirect | null", + "source": "script-api", + "tags": [ + "redirect", + "sourcecodeinfo.redirect" + ], + "title": "SourceCodeInfo.redirect" + }, + { + "description": "The status of the source-code. One of the following: STATUS_INVALID - The source code is not found in the system. STATUS_INACTIVE - The source code is found but not active. STATUS_INACTIVE - The source code is found and active.", + "id": "script-api:dw/campaign/SourceCodeInfo#status", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeInfo", + "qualifiedName": "dw.campaign.SourceCodeInfo.status", + "sections": [ + { + "body": "The status of the source-code. One of the following:\nSTATUS_INVALID - The source code is not found in the system.\nSTATUS_INACTIVE - The source code is found but not active.\nSTATUS_INACTIVE - The source code is found and active.", + "heading": "Description" + } + ], + "signature": "readonly status: number", + "source": "script-api", + "tags": [ + "status", + "sourcecodeinfo.status" + ], + "title": "SourceCodeInfo.status" + }, + { + "description": "Helper class which contains error result codes returned by the SetSourceCode pipelet.", + "id": "script-api:dw/campaign/SourceCodeStatusCodes", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes", + "sections": [ + { + "body": "Helper class which contains error result codes returned by the SetSourceCode\npipelet.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sourcecodestatuscodes", + "dw.campaign.sourcecodestatuscodes", + "dw/campaign" + ], + "title": "SourceCodeStatusCodes" + }, + { + "description": "Indicates that the specified source code was found in one or more source-code groups, none of which are active.", + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INACTIVE", + "sections": [ + { + "body": "Indicates that the specified source code was found in one or more\nsource-code groups, none of which are active.", + "heading": "Description" + } + ], + "signature": "static readonly CODE_INACTIVE = \"CODE_INACTIVE\"", + "source": "script-api", + "tags": [ + "code_inactive", + "sourcecodestatuscodes.code_inactive" + ], + "title": "SourceCodeStatusCodes.CODE_INACTIVE" + }, + { + "description": "Indicates that the specified source code was found in one or more source-code groups, none of which are active.", + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INACTIVE", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INACTIVE", + "sections": [ + { + "body": "Indicates that the specified source code was found in one or more\nsource-code groups, none of which are active.", + "heading": "Description" + } + ], + "signature": "static readonly CODE_INACTIVE = \"CODE_INACTIVE\"", + "source": "script-api", + "tags": [ + "code_inactive", + "sourcecodestatuscodes.code_inactive" + ], + "title": "SourceCodeStatusCodes.CODE_INACTIVE" + }, + { + "description": "Indicates that the specified source code is not contained in any source-code group.", + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INVALID", + "sections": [ + { + "body": "Indicates that the specified source code is not contained\nin any source-code group.", + "heading": "Description" + } + ], + "signature": "static readonly CODE_INVALID = \"CODE_INVALID\"", + "source": "script-api", + "tags": [ + "code_invalid", + "sourcecodestatuscodes.code_invalid" + ], + "title": "SourceCodeStatusCodes.CODE_INVALID" + }, + { + "description": "Indicates that the specified source code is not contained in any source-code group.", + "id": "script-api:dw/campaign/SourceCodeStatusCodes#CODE_INVALID", + "kind": "constant", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/SourceCodeStatusCodes", + "qualifiedName": "dw.campaign.SourceCodeStatusCodes.CODE_INVALID", + "sections": [ + { + "body": "Indicates that the specified source code is not contained\nin any source-code group.", + "heading": "Description" + } + ], + "signature": "static readonly CODE_INVALID = \"CODE_INVALID\"", + "source": "script-api", + "tags": [ + "code_invalid", + "sourcecodestatuscodes.code_invalid" + ], + "title": "SourceCodeStatusCodes.CODE_INVALID" + }, + { + "description": "Represents a total fix price discount on a group of products in the discount plan. For example: \"buy 3 products of type X for a total price of $29.99\".", + "id": "script-api:dw/campaign/TotalFixedPriceDiscount", + "kind": "class", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount", + "sections": [ + { + "body": "Represents a total fix price discount on a group of products in the\ndiscount plan. For example: \"buy 3 products of type X for a total price\nof $29.99\".", + "heading": "Description" + }, + { + "body": "Extends `Discount`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "totalfixedpricediscount", + "dw.campaign.totalfixedpricediscount", + "dw/campaign" + ], + "title": "TotalFixedPriceDiscount" + }, + { + "description": "Returns the total fixed price amount.", + "id": "script-api:dw/campaign/TotalFixedPriceDiscount#getTotalFixedPrice", + "kind": "method", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/TotalFixedPriceDiscount", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount.getTotalFixedPrice", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the total fixed price amount.", + "heading": "Description" + } + ], + "signature": "getTotalFixedPrice(): number", + "source": "script-api", + "tags": [ + "gettotalfixedprice", + "totalfixedpricediscount.gettotalfixedprice" + ], + "title": "TotalFixedPriceDiscount.getTotalFixedPrice" + }, + { + "description": "Returns the total fixed price amount.", + "id": "script-api:dw/campaign/TotalFixedPriceDiscount#totalFixedPrice", + "kind": "property", + "packagePath": "dw/campaign", + "parentId": "script-api:dw/campaign/TotalFixedPriceDiscount", + "qualifiedName": "dw.campaign.TotalFixedPriceDiscount.totalFixedPrice", + "sections": [ + { + "body": "Returns the total fixed price amount.", + "heading": "Description" + } + ], + "signature": "readonly totalFixedPrice: number", + "source": "script-api", + "tags": [ + "totalfixedprice", + "totalfixedpricediscount.totalfixedprice" + ], + "title": "TotalFixedPriceDiscount.totalFixedPrice" + }, + { + "description": "45 declarations", + "id": "script-api:dw/catalog", + "kind": "package", + "packagePath": "dw/catalog", + "qualifiedName": "dw.catalog", + "source": "script-api", + "tags": [ + "dw/catalog", + "dw.catalog" + ], + "title": "dw.catalog" + }, + { + "description": "Represents a Commerce Cloud Digital Catalog. Catalogs are containers of products and other product-related information and can be shared between sites. Every product in the system is contained in (or \"owned by\") exactly one catalog. Every site has a single \"site catalog\" which defines the products that are available to purchase on that site. The static method dw.catalog.CatalogMgr.getSiteCatalog returns the site catalog for the current site.", + "id": "script-api:dw/catalog/Catalog", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Catalog", + "sections": [ + { + "body": "Represents a Commerce Cloud Digital Catalog. Catalogs are containers of products\nand other product-related information and can be shared between sites. Every\nproduct in the system is contained in (or \"owned by\") exactly one catalog.\nEvery site has a single \"site catalog\" which defines the products that are\navailable to purchase on that site. The static method\ndw.catalog.CatalogMgr.getSiteCatalog returns the site catalog for\nthe current site.\n\nCatalogs are organized into a tree of categories with a single top-level root\ncategory. Products are assigned to categories within catalogs. They can be\nassigned to categories in their owning catalog, or other catalogs. They can\nbe assigned to multiple categories within the same catalog. Products that are\nnot assigned to any categories are considered \"uncategorized.\" A product has\na single \"classification category\" in some catalog, and one\n\"primary category\" per catalog. The classification category defines the\nattribute set of the product. The primary category is used as standard\npresentation context within that catalog in the storefront.\n\nWhile Commerce Cloud Digital does not currently distinguish different\ncatalog types, it is common practice to have two general types of catalog:\n\n- \"Product catalogs\" typically contain detailed product information and are\nfrequently generated from some backend PIM system.\n- \"Site Catalogs\" define the category structure of the storefront and\ncontain primarily the assignments of these categories to the products defined\nin the product catalogs. The site catalog is assigned to the site.\n\nIn addition to products and categories, catalogs contain recommendations,\nshared variation attributes which can be used by multiple master products,\nand shared product options which can be used by multiple option products.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "catalog", + "dw.catalog.catalog", + "dw/catalog" + ], + "title": "Catalog" + }, + { + "description": "Returns the value of attribute 'id'.", + "id": "script-api:dw/catalog/Catalog#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.ID", + "sections": [ + { + "body": "Returns the value of attribute 'id'.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "catalog.id" + ], + "title": "Catalog.ID" + }, + { + "description": "Returns the value of the localized extensible object attribute \"shortDescription\" for the current locale.", + "id": "script-api:dw/catalog/Catalog#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.description", + "sections": [ + { + "body": "Returns the value of the localized extensible object attribute\n\"shortDescription\" for the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "catalog.description" + ], + "title": "Catalog.description" + }, + { + "description": "Returns the value of the localized extensible object attribute \"displayName\" for the current locale.", + "id": "script-api:dw/catalog/Catalog#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.displayName", + "sections": [ + { + "body": "Returns the value of the localized extensible object attribute\n\"displayName\" for the current locale.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "catalog.displayname" + ], + "title": "Catalog.displayName" + }, + { + "description": "Returns the value of the localized extensible object attribute \"shortDescription\" for the current locale.", + "id": "script-api:dw/catalog/Catalog#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value of the localized extensible object attribute\n\"shortDescription\" for the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "catalog.getdescription" + ], + "title": "Catalog.getDescription" + }, + { + "description": "Returns the value of the localized extensible object attribute \"displayName\" for the current locale.", + "id": "script-api:dw/catalog/Catalog#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value of the localized extensible object attribute\n\"displayName\" for the current locale.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "catalog.getdisplayname" + ], + "title": "Catalog.getDisplayName" + }, + { + "description": "Returns the value of attribute 'id'.", + "id": "script-api:dw/catalog/Catalog#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the value of attribute 'id'.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "catalog.getid" + ], + "title": "Catalog.getID" + }, + { + "description": "Returns the object for the relation 'root'.", + "id": "script-api:dw/catalog/Catalog#getRoot", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.getRoot", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the object for the relation 'root'.", + "heading": "Description" + } + ], + "signature": "getRoot(): Category", + "source": "script-api", + "tags": [ + "getroot", + "catalog.getroot" + ], + "title": "Catalog.getRoot" + }, + { + "description": "Returns the object for the relation 'root'.", + "id": "script-api:dw/catalog/Catalog#root", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Catalog", + "qualifiedName": "dw.catalog.Catalog.root", + "sections": [ + { + "body": "Returns the object for the relation 'root'.", + "heading": "Description" + } + ], + "signature": "readonly root: Category", + "source": "script-api", + "tags": [ + "root", + "catalog.root" + ], + "title": "Catalog.root" + }, + { + "description": "Provides helper methods for getting categories.", + "id": "script-api:dw/catalog/CatalogMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CatalogMgr", + "sections": [ + { + "body": "Provides helper methods for getting categories.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "catalogmgr", + "dw.catalog.catalogmgr", + "dw/catalog" + ], + "title": "CatalogMgr" + }, + { + "description": "Returns the catalog identified by the specified catalog id. Returns null if no catalog with the specified id exists in the current organization context.", + "id": "script-api:dw/catalog/CatalogMgr#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCatalog", + "returns": { + "type": "Catalog | null" + }, + "sections": [ + { + "body": "Returns the catalog identified by the specified catalog id.\nReturns null if no catalog with the specified id exists in the\ncurrent organization context.", + "heading": "Description" + } + ], + "signature": "static getCatalog(id: string): Catalog | null", + "source": "script-api", + "tags": [ + "getcatalog", + "catalogmgr.getcatalog" + ], + "title": "CatalogMgr.getCatalog" + }, + { + "description": "Returns the catalog identified by the specified catalog id. Returns null if no catalog with the specified id exists in the current organization context.", + "id": "script-api:dw/catalog/CatalogMgr#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCatalog", + "returns": { + "type": "Catalog | null" + }, + "sections": [ + { + "body": "Returns the catalog identified by the specified catalog id.\nReturns null if no catalog with the specified id exists in the\ncurrent organization context.", + "heading": "Description" + } + ], + "signature": "static getCatalog(id: string): Catalog | null", + "source": "script-api", + "tags": [ + "getcatalog", + "catalogmgr.getcatalog" + ], + "title": "CatalogMgr.getCatalog" + }, + { + "description": "Returns the category of the site catalog identified by the specified category id. Returns null if no site catalog is defined, or no category with the specified id is found in the site catalog.", + "id": "script-api:dw/catalog/CatalogMgr#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCategory", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the category of the site catalog identified by the specified\ncategory id. Returns null if no site catalog is defined, or no category\nwith the specified id is found in the site catalog.", + "heading": "Description" + } + ], + "signature": "static getCategory(id: string): Category | null", + "source": "script-api", + "tags": [ + "getcategory", + "catalogmgr.getcategory" + ], + "title": "CatalogMgr.getCategory" + }, + { + "description": "Returns the category of the site catalog identified by the specified category id. Returns null if no site catalog is defined, or no category with the specified id is found in the site catalog.", + "id": "script-api:dw/catalog/CatalogMgr#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getCategory", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the category of the site catalog identified by the specified\ncategory id. Returns null if no site catalog is defined, or no category\nwith the specified id is found in the site catalog.", + "heading": "Description" + } + ], + "signature": "static getCategory(id: string): Category | null", + "source": "script-api", + "tags": [ + "getcategory", + "catalogmgr.getcategory" + ], + "title": "CatalogMgr.getCategory" + }, + { + "description": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "id": "script-api:dw/catalog/CatalogMgr#getSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSiteCatalog", + "returns": { + "type": "Catalog | null" + }, + "sections": [ + { + "body": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "heading": "Description" + } + ], + "signature": "static getSiteCatalog(): Catalog | null", + "source": "script-api", + "tags": [ + "getsitecatalog", + "catalogmgr.getsitecatalog" + ], + "title": "CatalogMgr.getSiteCatalog" + }, + { + "description": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "id": "script-api:dw/catalog/CatalogMgr#getSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSiteCatalog", + "returns": { + "type": "Catalog | null" + }, + "sections": [ + { + "body": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "heading": "Description" + } + ], + "signature": "static getSiteCatalog(): Catalog | null", + "source": "script-api", + "tags": [ + "getsitecatalog", + "catalogmgr.getsitecatalog" + ], + "title": "CatalogMgr.getSiteCatalog" + }, + { + "description": "Returns the sorting option with the given ID for this site, or `null` if there is no such option.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOption", + "returns": { + "type": "SortingOption | null" + }, + "sections": [ + { + "body": "Returns the sorting option with the given ID for this site, or\n`null` if there is no such option.", + "heading": "Description" + } + ], + "signature": "static getSortingOption(id: string): SortingOption | null", + "source": "script-api", + "tags": [ + "getsortingoption", + "catalogmgr.getsortingoption" + ], + "title": "CatalogMgr.getSortingOption" + }, + { + "description": "Returns the sorting option with the given ID for this site, or `null` if there is no such option.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOption", + "returns": { + "type": "SortingOption | null" + }, + "sections": [ + { + "body": "Returns the sorting option with the given ID for this site, or\n`null` if there is no such option.", + "heading": "Description" + } + ], + "signature": "static getSortingOption(id: string): SortingOption | null", + "source": "script-api", + "tags": [ + "getsortingoption", + "catalogmgr.getsortingoption" + ], + "title": "CatalogMgr.getSortingOption" + }, + { + "description": "Returns a list containing the sorting options configured for this site.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOptions", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list containing the sorting options configured for this site.", + "heading": "Description" + } + ], + "signature": "static getSortingOptions(): List", + "source": "script-api", + "tags": [ + "getsortingoptions", + "catalogmgr.getsortingoptions" + ], + "title": "CatalogMgr.getSortingOptions" + }, + { + "description": "Returns a list containing the sorting options configured for this site.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingOptions", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list containing the sorting options configured for this site.", + "heading": "Description" + } + ], + "signature": "static getSortingOptions(): List", + "source": "script-api", + "tags": [ + "getsortingoptions", + "catalogmgr.getsortingoptions" + ], + "title": "CatalogMgr.getSortingOptions" + }, + { + "description": "Returns the sorting rule with the given ID for this site, or `null` if there is no such rule.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the sorting rule with the given ID for this site,\nor `null` if there is no such rule.", + "heading": "Description" + } + ], + "signature": "static getSortingRule(id: string): SortingRule | null", + "source": "script-api", + "tags": [ + "getsortingrule", + "catalogmgr.getsortingrule" + ], + "title": "CatalogMgr.getSortingRule" + }, + { + "description": "Returns the sorting rule with the given ID for this site, or `null` if there is no such rule.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the sorting rule with the given ID for this site,\nor `null` if there is no such rule.", + "heading": "Description" + } + ], + "signature": "static getSortingRule(id: string): SortingRule | null", + "source": "script-api", + "tags": [ + "getsortingrule", + "catalogmgr.getsortingrule" + ], + "title": "CatalogMgr.getSortingRule" + }, + { + "description": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingRules", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRules", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "heading": "Description" + } + ], + "signature": "static getSortingRules(): Collection", + "source": "script-api", + "tags": [ + "getsortingrules", + "catalogmgr.getsortingrules" + ], + "title": "CatalogMgr.getSortingRules" + }, + { + "description": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "id": "script-api:dw/catalog/CatalogMgr#getSortingRules", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.getSortingRules", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "heading": "Description" + } + ], + "signature": "static getSortingRules(): Collection", + "source": "script-api", + "tags": [ + "getsortingrules", + "catalogmgr.getsortingrules" + ], + "title": "CatalogMgr.getSortingRules" + }, + { + "description": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "id": "script-api:dw/catalog/CatalogMgr#siteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.siteCatalog", + "sections": [ + { + "body": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "heading": "Description" + } + ], + "signature": "static readonly siteCatalog: Catalog | null", + "source": "script-api", + "tags": [ + "sitecatalog", + "catalogmgr.sitecatalog" + ], + "title": "CatalogMgr.siteCatalog" + }, + { + "description": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "id": "script-api:dw/catalog/CatalogMgr#siteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.siteCatalog", + "sections": [ + { + "body": "Returns the catalog of the current site or null if no catalog is assigned to the site.", + "heading": "Description" + } + ], + "signature": "static readonly siteCatalog: Catalog | null", + "source": "script-api", + "tags": [ + "sitecatalog", + "catalogmgr.sitecatalog" + ], + "title": "CatalogMgr.siteCatalog" + }, + { + "description": "Returns a list containing the sorting options configured for this site.", + "id": "script-api:dw/catalog/CatalogMgr#sortingOptions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingOptions", + "sections": [ + { + "body": "Returns a list containing the sorting options configured for this site.", + "heading": "Description" + } + ], + "signature": "static readonly sortingOptions: List", + "source": "script-api", + "tags": [ + "sortingoptions", + "catalogmgr.sortingoptions" + ], + "title": "CatalogMgr.sortingOptions" + }, + { + "description": "Returns a list containing the sorting options configured for this site.", + "id": "script-api:dw/catalog/CatalogMgr#sortingOptions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingOptions", + "sections": [ + { + "body": "Returns a list containing the sorting options configured for this site.", + "heading": "Description" + } + ], + "signature": "static readonly sortingOptions: List", + "source": "script-api", + "tags": [ + "sortingoptions", + "catalogmgr.sortingoptions" + ], + "title": "CatalogMgr.sortingOptions" + }, + { + "description": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "id": "script-api:dw/catalog/CatalogMgr#sortingRules", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingRules", + "sections": [ + { + "body": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "heading": "Description" + } + ], + "signature": "static readonly sortingRules: Collection", + "source": "script-api", + "tags": [ + "sortingrules", + "catalogmgr.sortingrules" + ], + "title": "CatalogMgr.sortingRules" + }, + { + "description": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "id": "script-api:dw/catalog/CatalogMgr#sortingRules", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CatalogMgr", + "qualifiedName": "dw.catalog.CatalogMgr.sortingRules", + "sections": [ + { + "body": "Returns a collection containing all of the sorting rules for this site, including global sorting rules.", + "heading": "Description" + } + ], + "signature": "static readonly sortingRules: Collection", + "source": "script-api", + "tags": [ + "sortingrules", + "catalogmgr.sortingrules" + ], + "title": "CatalogMgr.sortingRules" + }, + { + "description": "Represents a category in a product catalog.", + "id": "script-api:dw/catalog/Category", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Category", + "sections": [ + { + "body": "Represents a category in a product catalog.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "category", + "dw.catalog.category", + "dw/catalog" + ], + "title": "Category" + }, + { + "description": "Constant representing the Variation Group Display Mode individual setting.", + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_INDIVIDUAL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_INDIVIDUAL", + "sections": [ + { + "body": "Constant representing the Variation Group Display Mode individual setting.", + "heading": "Description" + } + ], + "signature": "static readonly DISPLAY_MODE_INDIVIDUAL: number", + "source": "script-api", + "tags": [ + "display_mode_individual", + "category.display_mode_individual" + ], + "title": "Category.DISPLAY_MODE_INDIVIDUAL" + }, + { + "description": "Constant representing the Variation Group Display Mode individual setting.", + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_INDIVIDUAL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_INDIVIDUAL", + "sections": [ + { + "body": "Constant representing the Variation Group Display Mode individual setting.", + "heading": "Description" + } + ], + "signature": "static readonly DISPLAY_MODE_INDIVIDUAL: number", + "source": "script-api", + "tags": [ + "display_mode_individual", + "category.display_mode_individual" + ], + "title": "Category.DISPLAY_MODE_INDIVIDUAL" + }, + { + "description": "Constant representing the Variation Group Display Mode merged setting.", + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_MERGED", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_MERGED", + "sections": [ + { + "body": "Constant representing the Variation Group Display Mode merged setting.", + "heading": "Description" + } + ], + "signature": "static readonly DISPLAY_MODE_MERGED: number", + "source": "script-api", + "tags": [ + "display_mode_merged", + "category.display_mode_merged" + ], + "title": "Category.DISPLAY_MODE_MERGED" + }, + { + "description": "Constant representing the Variation Group Display Mode merged setting.", + "id": "script-api:dw/catalog/Category#DISPLAY_MODE_MERGED", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.DISPLAY_MODE_MERGED", + "sections": [ + { + "body": "Constant representing the Variation Group Display Mode merged setting.", + "heading": "Description" + } + ], + "signature": "static readonly DISPLAY_MODE_MERGED: number", + "source": "script-api", + "tags": [ + "display_mode_merged", + "category.display_mode_merged" + ], + "title": "Category.DISPLAY_MODE_MERGED" + }, + { + "description": "Returns the id of the category.", + "id": "script-api:dw/catalog/Category#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.ID", + "sections": [ + { + "body": "Returns the id of the category.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "category.id" + ], + "title": "Category.ID" + }, + { + "description": "Returns all outgoing recommendations for this category. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Category#allRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.allRecommendations", + "sections": [ + { + "body": "Returns all outgoing recommendations for this category. The\nrecommendations are sorted by their explicitly set order.", + "heading": "Description" + } + ], + "signature": "readonly allRecommendations: Collection", + "source": "script-api", + "tags": [ + "allrecommendations", + "category.allrecommendations" + ], + "title": "Category.allRecommendations" + }, + { + "description": "Returns a collection of category assignments of the category.", + "id": "script-api:dw/catalog/Category#categoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.categoryAssignments", + "sections": [ + { + "body": "Returns a collection of category assignments of the category.", + "heading": "Description" + } + ], + "signature": "readonly categoryAssignments: Collection", + "source": "script-api", + "tags": [ + "categoryassignments", + "category.categoryassignments" + ], + "title": "Category.categoryAssignments" + }, + { + "description": "Returns the default sorting rule configured for this category, or `null` if there is no default rule to be applied for it.", + "id": "script-api:dw/catalog/Category#defaultSortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.defaultSortingRule", + "sections": [ + { + "body": "Returns the default sorting rule configured for this category,\nor `null` if there is no default rule to be applied for it.\n\nThis method returns the default rule for the parent category if this\ncategory inherits one. The parent category may inherit its default\nrule from its parent, and so on, up to the root category.\n\nThis method returns `null` if no ancestor category for this\ncategory has a default rule.", + "heading": "Description" + } + ], + "signature": "readonly defaultSortingRule: SortingRule | null", + "source": "script-api", + "tags": [ + "defaultsortingrule", + "category.defaultsortingrule" + ], + "title": "Category.defaultSortingRule" + }, + { + "description": "Returns the description of the catalog category for the current locale.", + "id": "script-api:dw/catalog/Category#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.description", + "sections": [ + { + "body": "Returns the description of the catalog category for the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "category.description" + ], + "title": "Category.description" + }, + { + "description": "Returns the Variation Groups Display Mode of the category or null if no display mode is defined.", + "id": "script-api:dw/catalog/Category#displayMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.displayMode", + "sections": [ + { + "body": "Returns the Variation Groups Display Mode of the category or null if no display mode is defined.", + "heading": "Description" + } + ], + "signature": "displayMode: number", + "source": "script-api", + "tags": [ + "displaymode", + "category.displaymode" + ], + "title": "Category.displayMode" + }, + { + "description": "Returns the display name of the of the catalog category for the current locale.", + "id": "script-api:dw/catalog/Category#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.displayName", + "sections": [ + { + "body": "Returns the display name of the of the catalog category for the current locale.\n\nThis value is intended to be used as the\nexternal visible name of the catalog category.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "category.displayname" + ], + "title": "Category.displayName" + }, + { + "description": "Returns all outgoing recommendations for this category. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Category#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getAllRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing recommendations for this category. The\nrecommendations are sorted by their explicitly set order.", + "heading": "Description" + } + ], + "signature": "getAllRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getallrecommendations", + "category.getallrecommendations" + ], + "title": "Category.getAllRecommendations" + }, + { + "description": "Returns all outgoing recommendations for this category which are of the specified type. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Category#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getAllRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing recommendations for this category which are of the\nspecified type. The recommendations are sorted by their explicitly set\norder.", + "heading": "Description" + } + ], + "signature": "getAllRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getallrecommendations", + "category.getallrecommendations" + ], + "title": "Category.getAllRecommendations" + }, + { + "description": "Returns a collection of category assignments of the category.", + "id": "script-api:dw/catalog/Category#getCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getCategoryAssignments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of category assignments of the category.", + "heading": "Description" + } + ], + "signature": "getCategoryAssignments(): Collection", + "source": "script-api", + "tags": [ + "getcategoryassignments", + "category.getcategoryassignments" + ], + "title": "Category.getCategoryAssignments" + }, + { + "description": "Returns the default sorting rule configured for this category, or `null` if there is no default rule to be applied for it.", + "id": "script-api:dw/catalog/Category#getDefaultSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDefaultSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the default sorting rule configured for this category,\nor `null` if there is no default rule to be applied for it.\n\nThis method returns the default rule for the parent category if this\ncategory inherits one. The parent category may inherit its default\nrule from its parent, and so on, up to the root category.\n\nThis method returns `null` if no ancestor category for this\ncategory has a default rule.", + "heading": "Description" + } + ], + "signature": "getDefaultSortingRule(): SortingRule | null", + "source": "script-api", + "tags": [ + "getdefaultsortingrule", + "category.getdefaultsortingrule" + ], + "title": "Category.getDefaultSortingRule" + }, + { + "description": "Returns the description of the catalog category for the current locale.", + "id": "script-api:dw/catalog/Category#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description of the catalog category for the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "category.getdescription" + ], + "title": "Category.getDescription" + }, + { + "description": "Returns the Variation Groups Display Mode of the category or null if no display mode is defined.", + "id": "script-api:dw/catalog/Category#getDisplayMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDisplayMode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the Variation Groups Display Mode of the category or null if no display mode is defined.", + "heading": "Description" + } + ], + "signature": "getDisplayMode(): number", + "source": "script-api", + "tags": [ + "getdisplaymode", + "category.getdisplaymode" + ], + "title": "Category.getDisplayMode" + }, + { + "description": "Returns the display name of the of the catalog category for the current locale.", + "id": "script-api:dw/catalog/Category#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the display name of the of the catalog category for the current locale.\n\nThis value is intended to be used as the\nexternal visible name of the catalog category.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "category.getdisplayname" + ], + "title": "Category.getDisplayName" + }, + { + "description": "Returns the id of the category.", + "id": "script-api:dw/catalog/Category#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of the category.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "category.getid" + ], + "title": "Category.getID" + }, + { + "description": "Returns the image reference of this catalog category.", + "id": "script-api:dw/catalog/Category#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the image reference of this catalog category.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "category.getimage" + ], + "title": "Category.getImage" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.", + "id": "script-api:dw/catalog/Category#getIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getIncomingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the target. If the source category of a link belongs to a different\ncatalog than the catalog owning this category, it is not returned.", + "heading": "Description" + } + ], + "signature": "getIncomingCategoryLinks(): Collection", + "source": "script-api", + "tags": [ + "getincomingcategorylinks", + "category.getincomingcategorylinks" + ], + "title": "Category.getIncomingCategoryLinks" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the target and which are of the specified type. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.", + "id": "script-api:dw/catalog/Category#getIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getIncomingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the target and which are of the specified type. If the source\ncategory of a link belongs to a different catalog than the catalog owning\nthis category, it is not returned.", + "heading": "Description" + } + ], + "signature": "getIncomingCategoryLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getincomingcategorylinks", + "category.getincomingcategorylinks" + ], + "title": "Category.getIncomingCategoryLinks" + }, + { + "description": "Returns a collection of category assignments of the category where the referenced product is currently online. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.", + "id": "script-api:dw/catalog/Category#getOnlineCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineCategoryAssignments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of category assignments of the category where the\nreferenced product is currently online. When checking the online status\nof the product, the online flag and the online from & to dates are taken\ninto account. Online flag, online from & to dates set for the current site\ntakes precedence over the default values.", + "heading": "Description" + } + ], + "signature": "getOnlineCategoryAssignments(): Collection", + "source": "script-api", + "tags": [ + "getonlinecategoryassignments", + "category.getonlinecategoryassignments" + ], + "title": "Category.getOnlineCategoryAssignments" + }, + { + "description": "Returns the online status flag of the category.", + "id": "script-api:dw/catalog/Category#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status flag of the category.", + "heading": "Description" + } + ], + "signature": "getOnlineFlag(): boolean", + "source": "script-api", + "tags": [ + "getonlineflag", + "category.getonlineflag" + ], + "title": "Category.getOnlineFlag" + }, + { + "description": "Returns the date from which the category is online or valid.", + "id": "script-api:dw/catalog/Category#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineFrom", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date from which the category is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date", + "source": "script-api", + "tags": [ + "getonlinefrom", + "category.getonlinefrom" + ], + "title": "Category.getOnlineFrom" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the source category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#getOnlineIncomingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineIncomingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for\nwhich this category is the target. If the source category of a link\nbelongs to a different catalog than the catalog owning this category, it\nis not returned. Additionally, this method will only return a link if the\nsource category is currently online. A category is currently online if\nits online flag equals true and the current site date is within the date\nrange defined by the onlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "getOnlineIncomingCategoryLinks(): Collection", + "source": "script-api", + "tags": [ + "getonlineincomingcategorylinks", + "category.getonlineincomingcategorylinks" + ], + "title": "Category.getOnlineIncomingCategoryLinks" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the target category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#getOnlineOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineOutgoingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for\nwhich this category is the source. If the target category of a link\nbelongs to a different catalog than the catalog owning this category, it\nis not returned. Additionally, this method will only return a link if the\ntarget category is currently online. A category is currently online if\nits online flag equals true and the current site date is within the date\nrange defined by the onlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "getOnlineOutgoingCategoryLinks(): Collection", + "source": "script-api", + "tags": [ + "getonlineoutgoingcategorylinks", + "category.getonlineoutgoingcategorylinks" + ], + "title": "Category.getOnlineOutgoingCategoryLinks" + }, + { + "description": "Returns online products assigned to this category. Offline products are not included in the returned collection. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.", + "id": "script-api:dw/catalog/Category#getOnlineProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineProducts", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns online products assigned to this category.\nOffline products are not included in the returned collection.\nWhen checking the online status of the product,\nthe online flag and the online from & to dates are taken into account.\nOnline flag, online from & to dates set for the current site takes precedence\nover the default values.\n\nThe order of products in the returned collection corresponds to the\ndefined explicit sorting of products in this category.", + "heading": "Description" + } + ], + "signature": "getOnlineProducts(): Collection>", + "source": "script-api", + "tags": [ + "getonlineproducts", + "category.getonlineproducts" + ], + "title": "Category.getOnlineProducts" + }, + { + "description": "Returns a sorted collection of currently online subcategories of this catalog category.", + "id": "script-api:dw/catalog/Category#getOnlineSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineSubCategories", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of currently online subcategories of this\ncatalog category.\n\n-\nA category is currently online if its online flag\nequals true and the current site date is within the date range defined by\nthe onlineFrom and onlineTo attributes.\n\n-\nThe returned collection is sorted by position. Subcategories marked as\n\"unsorted\" always appear after those marked as \"sorted\" but are otherwise\nnot in any guaranteed order.\n\n-\nThe returned collection contains direct subcategories only.", + "heading": "Description" + } + ], + "signature": "getOnlineSubCategories(): Collection", + "source": "script-api", + "tags": [ + "getonlinesubcategories", + "category.getonlinesubcategories" + ], + "title": "Category.getOnlineSubCategories" + }, + { + "description": "Returns the date until which the category is online or valid.", + "id": "script-api:dw/catalog/Category#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOnlineTo", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date until which the category is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date", + "source": "script-api", + "tags": [ + "getonlineto", + "category.getonlineto" + ], + "title": "Category.getOnlineTo" + }, + { + "description": "Returns a list of outgoing recommendations for this category. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Category#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOrderableRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this category. This method\nbehaves similarly to getRecommendations but additionally filters out\nrecommendations for which the target product is unorderable according to\nits product availability model.", + "heading": "Description" + } + ], + "signature": "getOrderableRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getorderablerecommendations", + "category.getorderablerecommendations" + ], + "title": "Category.getOrderableRecommendations" + }, + { + "description": "Returns a list of outgoing recommendations for this category. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Category#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOrderableRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this category. This method\nbehaves similarly to getRecommendations but additionally\nfilters out recommendations for which the target product is unorderable\naccording to its product availability model.", + "heading": "Description" + } + ], + "signature": "getOrderableRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getorderablerecommendations", + "category.getorderablerecommendations" + ], + "title": "Category.getOrderableRecommendations" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.", + "id": "script-api:dw/catalog/Category#getOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOutgoingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the source. If the target category of a link belongs to a different\ncatalog than the catalog owning this category, it is not returned.\nThe collection of links is sorted by the explicitly defined order\nfor this category with unsorted links appearing at the end.", + "heading": "Description" + } + ], + "signature": "getOutgoingCategoryLinks(): Collection", + "source": "script-api", + "tags": [ + "getoutgoingcategorylinks", + "category.getoutgoingcategorylinks" + ], + "title": "Category.getOutgoingCategoryLinks" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the source and which are of the specified type. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.", + "id": "script-api:dw/catalog/Category#getOutgoingCategoryLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getOutgoingCategoryLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the source and which are of the specified type. If the target\ncategory of a link belongs to a different catalog than the catalog owning\nthis category, it is not returned. The collection of links is sorted by\nthe explicitly defined order for this category with unsorted links\nappearing at the end.", + "heading": "Description" + } + ], + "signature": "getOutgoingCategoryLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getoutgoingcategorylinks", + "category.getoutgoingcategorylinks" + ], + "title": "Category.getOutgoingCategoryLinks" + }, + { + "description": "Returns the page description of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page description of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string | null", + "source": "script-api", + "tags": [ + "getpagedescription", + "category.getpagedescription" + ], + "title": "Category.getPageDescription" + }, + { + "description": "Returns the page keywords of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageKeywords", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page keywords of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string | null", + "source": "script-api", + "tags": [ + "getpagekeywords", + "category.getpagekeywords" + ], + "title": "Category.getPageKeywords" + }, + { + "description": "Returns the page title of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageTitle", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page title of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string | null", + "source": "script-api", + "tags": [ + "getpagetitle", + "category.getpagetitle" + ], + "title": "Category.getPageTitle" + }, + { + "description": "Returns the page URL property of this category or null if not defined.", + "id": "script-api:dw/catalog/Category#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getPageURL", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page URL property of this category or null if not defined.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string | null", + "source": "script-api", + "tags": [ + "getpageurl", + "category.getpageurl" + ], + "title": "Category.getPageURL" + }, + { + "description": "Returns the parent of this category.", + "id": "script-api:dw/catalog/Category#getParent", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getParent", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the parent of this category.", + "heading": "Description" + } + ], + "signature": "getParent(): Category | null", + "source": "script-api", + "tags": [ + "getparent", + "category.getparent" + ], + "title": "Category.getParent" + }, + { + "description": "Returns this category's ProductAttributeModel, which makes access to the category's attribute information convenient. The model is calculated based on the attribute definitions assigned to this category and the global attribute definitions for the object type 'Product'.", + "id": "script-api:dw/catalog/Category#getProductAttributeModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getProductAttributeModel", + "returns": { + "type": "ProductAttributeModel" + }, + "sections": [ + { + "body": "Returns this category's ProductAttributeModel, which makes access to the\ncategory's attribute information convenient. The model is calculated\nbased on the attribute definitions assigned to this category and the\nglobal attribute definitions for the object type 'Product'.", + "heading": "Description" + } + ], + "signature": "getProductAttributeModel(): ProductAttributeModel", + "source": "script-api", + "tags": [ + "getproductattributemodel", + "category.getproductattributemodel" + ], + "title": "Category.getProductAttributeModel" + }, + { + "description": "Returns all products assigned to this category. The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.", + "id": "script-api:dw/catalog/Category#getProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getProducts", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns all products assigned to this category.\nThe order of products in the returned collection corresponds to the\ndefined explicit sorting of products in this category.", + "heading": "Description" + } + ], + "signature": "getProducts(): Collection>", + "source": "script-api", + "tags": [ + "getproducts", + "category.getproducts" + ], + "title": "Category.getProducts" + }, + { + "description": "Returns the outgoing recommendations for this category. If this category is not in the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Category#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this category. If this category\nis not in the site catalog, or there is no site catalog, an empty\ncollection is returned. Only recommendations for which the target\nproduct exists and is assigned to the site catalog are returned. The\nrecommendations are sorted by their explicitly set order.", + "heading": "Description" + } + ], + "signature": "getRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "category.getrecommendations" + ], + "title": "Category.getRecommendations" + }, + { + "description": "Returns the outgoing recommendations for this category which are of the specified type. Behaves the same as getRecommendations but additionally filters by recommendation type.", + "id": "script-api:dw/catalog/Category#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this category which are of the\nspecified type. Behaves the same as getRecommendations but\nadditionally filters by recommendation type.", + "heading": "Description" + } + ], + "signature": "getRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "category.getrecommendations" + ], + "title": "Category.getRecommendations" + }, + { + "description": "Returns the search placement of the category or null of no search placement is defined.", + "id": "script-api:dw/catalog/Category#getSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSearchPlacement", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the search placement of the category or null of no search placement is defined.", + "heading": "Description" + } + ], + "signature": "getSearchPlacement(): number", + "source": "script-api", + "tags": [ + "getsearchplacement", + "category.getsearchplacement" + ], + "title": "Category.getSearchPlacement" + }, + { + "description": "Returns the search rank of the category or null of no search rank is defined.", + "id": "script-api:dw/catalog/Category#getSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSearchRank", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the search rank of the category or null of no search rank is defined.", + "heading": "Description" + } + ], + "signature": "getSearchRank(): number", + "source": "script-api", + "tags": [ + "getsearchrank", + "category.getsearchrank" + ], + "title": "Category.getSearchRank" + }, + { + "description": "Returns the category's sitemap change frequency.", + "id": "script-api:dw/catalog/Category#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapChangeFrequency", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the category's sitemap change frequency.", + "heading": "Description" + } + ], + "signature": "getSiteMapChangeFrequency(): string", + "source": "script-api", + "tags": [ + "getsitemapchangefrequency", + "category.getsitemapchangefrequency" + ], + "title": "Category.getSiteMapChangeFrequency" + }, + { + "description": "Returns the category's sitemap inclusion.", + "id": "script-api:dw/catalog/Category#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapIncluded", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the category's sitemap inclusion.", + "heading": "Description" + } + ], + "signature": "getSiteMapIncluded(): number", + "source": "script-api", + "tags": [ + "getsitemapincluded", + "category.getsitemapincluded" + ], + "title": "Category.getSiteMapIncluded" + }, + { + "description": "Returns the category's sitemap priority.", + "id": "script-api:dw/catalog/Category#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSiteMapPriority", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the category's sitemap priority.", + "heading": "Description" + } + ], + "signature": "getSiteMapPriority(): number", + "source": "script-api", + "tags": [ + "getsitemappriority", + "category.getsitemappriority" + ], + "title": "Category.getSiteMapPriority" + }, + { + "description": "Returns a sorted collection of the subcategories of this catalog category, including both online and offline subcategories.", + "id": "script-api:dw/catalog/Category#getSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getSubCategories", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of the subcategories of this catalog category,\nincluding both online and offline subcategories.\n\n-\nThe returned collection is sorted by position. Subcategories marked as\n\"unsorted\" always appear after those marked as \"sorted\" but are otherwise\nnot in any guaranteed order.\n\n-\nThe returned collection contains direct subcategories only.", + "heading": "Description" + } + ], + "signature": "getSubCategories(): Collection", + "source": "script-api", + "tags": [ + "getsubcategories", + "category.getsubcategories" + ], + "title": "Category.getSubCategories" + }, + { + "description": "Returns the template property value , which is the file name of the template used to display the catalog category.", + "id": "script-api:dw/catalog/Category#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the template property value , which is the file name of the template\nused to display the catalog category.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "category.gettemplate" + ], + "title": "Category.getTemplate" + }, + { + "description": "Returns the thumbnail image reference of this catalog category.", + "id": "script-api:dw/catalog/Category#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.getThumbnail", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the thumbnail image reference of this catalog category.", + "heading": "Description" + } + ], + "signature": "getThumbnail(): MediaFile", + "source": "script-api", + "tags": [ + "getthumbnail", + "category.getthumbnail" + ], + "title": "Category.getThumbnail" + }, + { + "description": "Returns true if this catalog category has any online products assigned. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.", + "id": "script-api:dw/catalog/Category#hasOnlineProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.hasOnlineProducts", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this catalog category has any online products assigned.\nWhen checking the online status of the product,\nthe online flag and the online from & to dates are taken into account.\nOnline flag, online from & to dates set for the current site takes precedence\nover the default values.", + "heading": "Description" + } + ], + "signature": "hasOnlineProducts(): boolean", + "source": "script-api", + "tags": [ + "hasonlineproducts", + "category.hasonlineproducts" + ], + "title": "Category.hasOnlineProducts" + }, + { + "description": "Returns true if this catalog category has any online subcategories.", + "id": "script-api:dw/catalog/Category#hasOnlineSubCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.hasOnlineSubCategories", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this catalog category has any online subcategories.\n\n-\nA category is currently online if its online flag\nequals true and the current site date is within the date range defined by\nthe onlineFrom and onlineTo attributes.\n\n-\nOnly direct subcategories are considered.", + "heading": "Description" + } + ], + "signature": "hasOnlineSubCategories(): boolean", + "source": "script-api", + "tags": [ + "hasonlinesubcategories", + "category.hasonlinesubcategories" + ], + "title": "Category.hasOnlineSubCategories" + }, + { + "description": "Returns the image reference of this catalog category.", + "id": "script-api:dw/catalog/Category#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.image", + "sections": [ + { + "body": "Returns the image reference of this catalog category.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "category.image" + ], + "title": "Category.image" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.", + "id": "script-api:dw/catalog/Category#incomingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.incomingCategoryLinks", + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the target. If the source category of a link belongs to a different\ncatalog than the catalog owning this category, it is not returned.", + "heading": "Description" + } + ], + "signature": "readonly incomingCategoryLinks: Collection", + "source": "script-api", + "tags": [ + "incomingcategorylinks", + "category.incomingcategorylinks" + ], + "title": "Category.incomingCategoryLinks" + }, + { + "description": "Returns true if this category is a direct sub-category of the provided category.", + "id": "script-api:dw/catalog/Category#isDirectSubCategoryOf", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "parent", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isDirectSubCategoryOf", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this category is a direct sub-category of the provided\ncategory.", + "heading": "Description" + } + ], + "signature": "isDirectSubCategoryOf(parent: Category): boolean", + "source": "script-api", + "tags": [ + "isdirectsubcategoryof", + "category.isdirectsubcategoryof" + ], + "title": "Category.isDirectSubCategoryOf" + }, + { + "description": "Returns the value indicating whether the catalog category is \"currently online\". A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the value indicating whether the catalog category is \"currently\nonline\". A category is currently online if its online flag equals true\nand the current site date is within the date range defined by the\nonlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "category.isonline" + ], + "title": "Category.isOnline" + }, + { + "description": "Identifies if the category is the root category of its catalog.", + "id": "script-api:dw/catalog/Category#isRoot", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isRoot", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the category is the root category of its catalog.", + "heading": "Description" + } + ], + "signature": "isRoot(): boolean", + "source": "script-api", + "tags": [ + "isroot", + "category.isroot" + ], + "title": "Category.isRoot" + }, + { + "description": "Returns true if this category is a sub-category of the provided category. This can be either a direct or an indirect sub-category.", + "id": "script-api:dw/catalog/Category#isSubCategoryOf", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "ancestor", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isSubCategoryOf", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this category is a sub-category of the provided category.\nThis can be either a direct or an indirect sub-category.", + "heading": "Description" + } + ], + "signature": "isSubCategoryOf(ancestor: Category): boolean", + "source": "script-api", + "tags": [ + "issubcategoryof", + "category.issubcategoryof" + ], + "title": "Category.isSubCategoryOf" + }, + { + "description": "Returns true if the category is a top level category, but not the root category.", + "id": "script-api:dw/catalog/Category#isTopLevel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.isTopLevel", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the category is a top level category, but not the root\ncategory.", + "heading": "Description" + } + ], + "signature": "isTopLevel(): boolean", + "source": "script-api", + "tags": [ + "istoplevel", + "category.istoplevel" + ], + "title": "Category.isTopLevel" + }, + { + "description": "Returns the value indicating whether the catalog category is \"currently online\". A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.online", + "sections": [ + { + "body": "Returns the value indicating whether the catalog category is \"currently\nonline\". A category is currently online if its online flag equals true\nand the current site date is within the date range defined by the\nonlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "category.online" + ], + "title": "Category.online" + }, + { + "description": "Returns a collection of category assignments of the category where the referenced product is currently online. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.", + "id": "script-api:dw/catalog/Category#onlineCategoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineCategoryAssignments", + "sections": [ + { + "body": "Returns a collection of category assignments of the category where the\nreferenced product is currently online. When checking the online status\nof the product, the online flag and the online from & to dates are taken\ninto account. Online flag, online from & to dates set for the current site\ntakes precedence over the default values.", + "heading": "Description" + } + ], + "signature": "readonly onlineCategoryAssignments: Collection", + "source": "script-api", + "tags": [ + "onlinecategoryassignments", + "category.onlinecategoryassignments" + ], + "title": "Category.onlineCategoryAssignments" + }, + { + "description": "Returns the online status flag of the category.", + "id": "script-api:dw/catalog/Category#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineFlag", + "sections": [ + { + "body": "Returns the online status flag of the category.", + "heading": "Description" + } + ], + "signature": "readonly onlineFlag: boolean", + "source": "script-api", + "tags": [ + "onlineflag", + "category.onlineflag" + ], + "title": "Category.onlineFlag" + }, + { + "description": "Returns the date from which the category is online or valid.", + "id": "script-api:dw/catalog/Category#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineFrom", + "sections": [ + { + "body": "Returns the date from which the category is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date", + "source": "script-api", + "tags": [ + "onlinefrom", + "category.onlinefrom" + ], + "title": "Category.onlineFrom" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the source category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#onlineIncomingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineIncomingCategoryLinks", + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for\nwhich this category is the target. If the source category of a link\nbelongs to a different catalog than the catalog owning this category, it\nis not returned. Additionally, this method will only return a link if the\nsource category is currently online. A category is currently online if\nits online flag equals true and the current site date is within the date\nrange defined by the onlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "readonly onlineIncomingCategoryLinks: Collection", + "source": "script-api", + "tags": [ + "onlineincomingcategorylinks", + "category.onlineincomingcategorylinks" + ], + "title": "Category.onlineIncomingCategoryLinks" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the target category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Category#onlineOutgoingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineOutgoingCategoryLinks", + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for\nwhich this category is the source. If the target category of a link\nbelongs to a different catalog than the catalog owning this category, it\nis not returned. Additionally, this method will only return a link if the\ntarget category is currently online. A category is currently online if\nits online flag equals true and the current site date is within the date\nrange defined by the onlineFrom and onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "readonly onlineOutgoingCategoryLinks: Collection", + "source": "script-api", + "tags": [ + "onlineoutgoingcategorylinks", + "category.onlineoutgoingcategorylinks" + ], + "title": "Category.onlineOutgoingCategoryLinks" + }, + { + "description": "Returns online products assigned to this category. Offline products are not included in the returned collection. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.", + "id": "script-api:dw/catalog/Category#onlineProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineProducts", + "sections": [ + { + "body": "Returns online products assigned to this category.\nOffline products are not included in the returned collection.\nWhen checking the online status of the product,\nthe online flag and the online from & to dates are taken into account.\nOnline flag, online from & to dates set for the current site takes precedence\nover the default values.\n\nThe order of products in the returned collection corresponds to the\ndefined explicit sorting of products in this category.", + "heading": "Description" + } + ], + "signature": "readonly onlineProducts: Collection>", + "source": "script-api", + "tags": [ + "onlineproducts", + "category.onlineproducts" + ], + "title": "Category.onlineProducts" + }, + { + "description": "Returns a sorted collection of currently online subcategories of this catalog category.", + "id": "script-api:dw/catalog/Category#onlineSubCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineSubCategories", + "sections": [ + { + "body": "Returns a sorted collection of currently online subcategories of this\ncatalog category.\n\n-\nA category is currently online if its online flag\nequals true and the current site date is within the date range defined by\nthe onlineFrom and onlineTo attributes.\n\n-\nThe returned collection is sorted by position. Subcategories marked as\n\"unsorted\" always appear after those marked as \"sorted\" but are otherwise\nnot in any guaranteed order.\n\n-\nThe returned collection contains direct subcategories only.", + "heading": "Description" + } + ], + "signature": "readonly onlineSubCategories: Collection", + "source": "script-api", + "tags": [ + "onlinesubcategories", + "category.onlinesubcategories" + ], + "title": "Category.onlineSubCategories" + }, + { + "description": "Returns the date until which the category is online or valid.", + "id": "script-api:dw/catalog/Category#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.onlineTo", + "sections": [ + { + "body": "Returns the date until which the category is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date", + "source": "script-api", + "tags": [ + "onlineto", + "category.onlineto" + ], + "title": "Category.onlineTo" + }, + { + "description": "Returns a list of outgoing recommendations for this category. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Category#orderableRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.orderableRecommendations", + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this category. This method\nbehaves similarly to getRecommendations but additionally filters out\nrecommendations for which the target product is unorderable according to\nits product availability model.", + "heading": "Description" + } + ], + "signature": "readonly orderableRecommendations: Collection", + "source": "script-api", + "tags": [ + "orderablerecommendations", + "category.orderablerecommendations" + ], + "title": "Category.orderableRecommendations" + }, + { + "description": "Returns the collection of dw.catalog.CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.", + "id": "script-api:dw/catalog/Category#outgoingCategoryLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.outgoingCategoryLinks", + "sections": [ + { + "body": "Returns the collection of dw.catalog.CategoryLink objects for which this category\nis the source. If the target category of a link belongs to a different\ncatalog than the catalog owning this category, it is not returned.\nThe collection of links is sorted by the explicitly defined order\nfor this category with unsorted links appearing at the end.", + "heading": "Description" + } + ], + "signature": "readonly outgoingCategoryLinks: Collection", + "source": "script-api", + "tags": [ + "outgoingcategorylinks", + "category.outgoingcategorylinks" + ], + "title": "Category.outgoingCategoryLinks" + }, + { + "description": "Returns the page description of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageDescription", + "sections": [ + { + "body": "Returns the page description of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string | null", + "source": "script-api", + "tags": [ + "pagedescription", + "category.pagedescription" + ], + "title": "Category.pageDescription" + }, + { + "description": "Returns the page keywords of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageKeywords", + "sections": [ + { + "body": "Returns the page keywords of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string | null", + "source": "script-api", + "tags": [ + "pagekeywords", + "category.pagekeywords" + ], + "title": "Category.pageKeywords" + }, + { + "description": "Returns the page title of this category for the default locale or null if not defined.", + "id": "script-api:dw/catalog/Category#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageTitle", + "sections": [ + { + "body": "Returns the page title of this category for the default locale or null if not defined.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string | null", + "source": "script-api", + "tags": [ + "pagetitle", + "category.pagetitle" + ], + "title": "Category.pageTitle" + }, + { + "description": "Returns the page URL property of this category or null if not defined.", + "id": "script-api:dw/catalog/Category#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.pageURL", + "sections": [ + { + "body": "Returns the page URL property of this category or null if not defined.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string | null", + "source": "script-api", + "tags": [ + "pageurl", + "category.pageurl" + ], + "title": "Category.pageURL" + }, + { + "description": "Returns the parent of this category.", + "id": "script-api:dw/catalog/Category#parent", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.parent", + "sections": [ + { + "body": "Returns the parent of this category.", + "heading": "Description" + } + ], + "signature": "readonly parent: Category | null", + "source": "script-api", + "tags": [ + "parent", + "category.parent" + ], + "title": "Category.parent" + }, + { + "description": "Returns this category's ProductAttributeModel, which makes access to the category's attribute information convenient. The model is calculated based on the attribute definitions assigned to this category and the global attribute definitions for the object type 'Product'.", + "id": "script-api:dw/catalog/Category#productAttributeModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.productAttributeModel", + "sections": [ + { + "body": "Returns this category's ProductAttributeModel, which makes access to the\ncategory's attribute information convenient. The model is calculated\nbased on the attribute definitions assigned to this category and the\nglobal attribute definitions for the object type 'Product'.", + "heading": "Description" + } + ], + "signature": "readonly productAttributeModel: ProductAttributeModel", + "source": "script-api", + "tags": [ + "productattributemodel", + "category.productattributemodel" + ], + "title": "Category.productAttributeModel" + }, + { + "description": "Returns all products assigned to this category. The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.", + "id": "script-api:dw/catalog/Category#products", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.products", + "sections": [ + { + "body": "Returns all products assigned to this category.\nThe order of products in the returned collection corresponds to the\ndefined explicit sorting of products in this category.", + "heading": "Description" + } + ], + "signature": "readonly products: Collection>", + "source": "script-api", + "tags": [ + "products", + "category.products" + ], + "title": "Category.products" + }, + { + "description": "Returns the outgoing recommendations for this category. If this category is not in the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Category#recommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.recommendations", + "sections": [ + { + "body": "Returns the outgoing recommendations for this category. If this category\nis not in the site catalog, or there is no site catalog, an empty\ncollection is returned. Only recommendations for which the target\nproduct exists and is assigned to the site catalog are returned. The\nrecommendations are sorted by their explicitly set order.", + "heading": "Description" + } + ], + "signature": "readonly recommendations: Collection", + "source": "script-api", + "tags": [ + "recommendations", + "category.recommendations" + ], + "title": "Category.recommendations" + }, + { + "description": "Identifies if the category is the root category of its catalog.", + "id": "script-api:dw/catalog/Category#root", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.root", + "sections": [ + { + "body": "Identifies if the category is the root category of its catalog.", + "heading": "Description" + } + ], + "signature": "readonly root: boolean", + "source": "script-api", + "tags": [ + "root", + "category.root" + ], + "title": "Category.root" + }, + { + "description": "Returns the search placement of the category or null of no search placement is defined.", + "id": "script-api:dw/catalog/Category#searchPlacement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.searchPlacement", + "sections": [ + { + "body": "Returns the search placement of the category or null of no search placement is defined.", + "heading": "Description" + } + ], + "signature": "searchPlacement: number", + "source": "script-api", + "tags": [ + "searchplacement", + "category.searchplacement" + ], + "title": "Category.searchPlacement" + }, + { + "description": "Returns the search rank of the category or null of no search rank is defined.", + "id": "script-api:dw/catalog/Category#searchRank", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.searchRank", + "sections": [ + { + "body": "Returns the search rank of the category or null of no search rank is defined.", + "heading": "Description" + } + ], + "signature": "searchRank: number", + "source": "script-api", + "tags": [ + "searchrank", + "category.searchrank" + ], + "title": "Category.searchRank" + }, + { + "description": "Set the category's Variation Groups Display Mode.", + "id": "script-api:dw/catalog/Category#setDisplayMode", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "displayMode", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setDisplayMode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the category's Variation Groups Display Mode.", + "heading": "Description" + } + ], + "signature": "setDisplayMode(displayMode: number): void", + "source": "script-api", + "tags": [ + "setdisplaymode", + "category.setdisplaymode" + ], + "title": "Category.setDisplayMode" + }, + { + "description": "Set the category's search placement.", + "id": "script-api:dw/catalog/Category#setSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "placement", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setSearchPlacement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the category's search placement.", + "heading": "Description" + } + ], + "signature": "setSearchPlacement(placement: number): void", + "source": "script-api", + "tags": [ + "setsearchplacement", + "category.setsearchplacement" + ], + "title": "Category.setSearchPlacement" + }, + { + "description": "Set the category's search rank.", + "id": "script-api:dw/catalog/Category#setSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "rank", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.setSearchRank", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the category's search rank.", + "heading": "Description" + } + ], + "signature": "setSearchRank(rank: number): void", + "source": "script-api", + "tags": [ + "setsearchrank", + "category.setsearchrank" + ], + "title": "Category.setSearchRank" + }, + { + "description": "Returns the category's sitemap change frequency.", + "id": "script-api:dw/catalog/Category#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapChangeFrequency", + "sections": [ + { + "body": "Returns the category's sitemap change frequency.", + "heading": "Description" + } + ], + "signature": "readonly siteMapChangeFrequency: string", + "source": "script-api", + "tags": [ + "sitemapchangefrequency", + "category.sitemapchangefrequency" + ], + "title": "Category.siteMapChangeFrequency" + }, + { + "description": "Returns the category's sitemap inclusion.", + "id": "script-api:dw/catalog/Category#siteMapIncluded", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapIncluded", + "sections": [ + { + "body": "Returns the category's sitemap inclusion.", + "heading": "Description" + } + ], + "signature": "readonly siteMapIncluded: number", + "source": "script-api", + "tags": [ + "sitemapincluded", + "category.sitemapincluded" + ], + "title": "Category.siteMapIncluded" + }, + { + "description": "Returns the category's sitemap priority.", + "id": "script-api:dw/catalog/Category#siteMapPriority", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.siteMapPriority", + "sections": [ + { + "body": "Returns the category's sitemap priority.", + "heading": "Description" + } + ], + "signature": "readonly siteMapPriority: number", + "source": "script-api", + "tags": [ + "sitemappriority", + "category.sitemappriority" + ], + "title": "Category.siteMapPriority" + }, + { + "description": "Returns a sorted collection of the subcategories of this catalog category, including both online and offline subcategories.", + "id": "script-api:dw/catalog/Category#subCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.subCategories", + "sections": [ + { + "body": "Returns a sorted collection of the subcategories of this catalog category,\nincluding both online and offline subcategories.\n\n-\nThe returned collection is sorted by position. Subcategories marked as\n\"unsorted\" always appear after those marked as \"sorted\" but are otherwise\nnot in any guaranteed order.\n\n-\nThe returned collection contains direct subcategories only.", + "heading": "Description" + } + ], + "signature": "readonly subCategories: Collection", + "source": "script-api", + "tags": [ + "subcategories", + "category.subcategories" + ], + "title": "Category.subCategories" + }, + { + "description": "Returns the template property value , which is the file name of the template used to display the catalog category.", + "id": "script-api:dw/catalog/Category#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.template", + "sections": [ + { + "body": "Returns the template property value , which is the file name of the template\nused to display the catalog category.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "category.template" + ], + "title": "Category.template" + }, + { + "description": "Returns the thumbnail image reference of this catalog category.", + "id": "script-api:dw/catalog/Category#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.thumbnail", + "sections": [ + { + "body": "Returns the thumbnail image reference of this catalog category.", + "heading": "Description" + } + ], + "signature": "readonly thumbnail: MediaFile", + "source": "script-api", + "tags": [ + "thumbnail", + "category.thumbnail" + ], + "title": "Category.thumbnail" + }, + { + "description": "Returns true if the category is a top level category, but not the root category.", + "id": "script-api:dw/catalog/Category#topLevel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Category", + "qualifiedName": "dw.catalog.Category.topLevel", + "sections": [ + { + "body": "Returns true if the category is a top level category, but not the root\ncategory.", + "heading": "Description" + } + ], + "signature": "readonly topLevel: boolean", + "source": "script-api", + "tags": [ + "toplevel", + "category.toplevel" + ], + "title": "Category.topLevel" + }, + { + "description": "Represents a category assignment in Commerce Cloud Digital.", + "id": "script-api:dw/catalog/CategoryAssignment", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CategoryAssignment", + "sections": [ + { + "body": "Represents a category assignment in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "categoryassignment", + "dw.catalog.categoryassignment", + "dw/catalog" + ], + "title": "CategoryAssignment" + }, + { + "description": "Returns the category assignment's callout message in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#calloutMsg", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.calloutMsg", + "sections": [ + { + "body": "Returns the category assignment's callout message in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly calloutMsg: MarkupText | null", + "source": "script-api", + "tags": [ + "calloutmsg", + "categoryassignment.calloutmsg" + ], + "title": "CategoryAssignment.calloutMsg" + }, + { + "description": "Returns the category to which this category assignment is bound.", + "id": "script-api:dw/catalog/CategoryAssignment#category", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.category", + "sections": [ + { + "body": "Returns the category to which this category assignment is bound.", + "heading": "Description" + } + ], + "signature": "readonly category: Category", + "source": "script-api", + "tags": [ + "category", + "categoryassignment.category" + ], + "title": "CategoryAssignment.category" + }, + { + "description": "Returns the category assignment's callout message in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#getCalloutMsg", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getCalloutMsg", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the category assignment's callout message in the current locale.", + "heading": "Description" + } + ], + "signature": "getCalloutMsg(): MarkupText | null", + "source": "script-api", + "tags": [ + "getcalloutmsg", + "categoryassignment.getcalloutmsg" + ], + "title": "CategoryAssignment.getCalloutMsg" + }, + { + "description": "Returns the category to which this category assignment is bound.", + "id": "script-api:dw/catalog/CategoryAssignment#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the category to which this category assignment is bound.", + "heading": "Description" + } + ], + "signature": "getCategory(): Category", + "source": "script-api", + "tags": [ + "getcategory", + "categoryassignment.getcategory" + ], + "title": "CategoryAssignment.getCategory" + }, + { + "description": "Returns the category assignment's image.", + "id": "script-api:dw/catalog/CategoryAssignment#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the category assignment's image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "categoryassignment.getimage" + ], + "title": "CategoryAssignment.getImage" + }, + { + "description": "Returns the category assignment's long description in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getLongDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the category assignment's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "getLongDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getlongdescription", + "categoryassignment.getlongdescription" + ], + "title": "CategoryAssignment.getLongDescription" + }, + { + "description": "Returns the name of the category assignment in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the name of the category assignment in the current locale.", + "heading": "Description" + } + ], + "signature": "getName(): string | null", + "source": "script-api", + "tags": [ + "getname", + "categoryassignment.getname" + ], + "title": "CategoryAssignment.getName" + }, + { + "description": "Returns the product to which this category assignment is bound.", + "id": "script-api:dw/catalog/CategoryAssignment#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the product to which this category assignment is bound.", + "heading": "Description" + } + ], + "signature": "getProduct(): Product", + "source": "script-api", + "tags": [ + "getproduct", + "categoryassignment.getproduct" + ], + "title": "CategoryAssignment.getProduct" + }, + { + "description": "Returns the category assignment's short description in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.getShortDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the category assignment's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "getShortDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getshortdescription", + "categoryassignment.getshortdescription" + ], + "title": "CategoryAssignment.getShortDescription" + }, + { + "description": "Returns the category assignment's image.", + "id": "script-api:dw/catalog/CategoryAssignment#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.image", + "sections": [ + { + "body": "Returns the category assignment's image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "categoryassignment.image" + ], + "title": "CategoryAssignment.image" + }, + { + "description": "Returns the category assignment's long description in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.longDescription", + "sections": [ + { + "body": "Returns the category assignment's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly longDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "longdescription", + "categoryassignment.longdescription" + ], + "title": "CategoryAssignment.longDescription" + }, + { + "description": "Returns the name of the category assignment in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.name", + "sections": [ + { + "body": "Returns the name of the category assignment in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly name: string | null", + "source": "script-api", + "tags": [ + "name", + "categoryassignment.name" + ], + "title": "CategoryAssignment.name" + }, + { + "description": "Returns the product to which this category assignment is bound.", + "id": "script-api:dw/catalog/CategoryAssignment#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.product", + "sections": [ + { + "body": "Returns the product to which this category assignment is bound.", + "heading": "Description" + } + ], + "signature": "readonly product: Product", + "source": "script-api", + "tags": [ + "product", + "categoryassignment.product" + ], + "title": "CategoryAssignment.product" + }, + { + "description": "Returns the category assignment's short description in the current locale.", + "id": "script-api:dw/catalog/CategoryAssignment#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryAssignment", + "qualifiedName": "dw.catalog.CategoryAssignment.shortDescription", + "sections": [ + { + "body": "Returns the category assignment's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly shortDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "shortdescription", + "categoryassignment.shortdescription" + ], + "title": "CategoryAssignment.shortDescription" + }, + { + "description": "A CategoryLink represents a directed relationship between two catalog categories. Merchants create category links in order to market similar or related groups of products.", + "id": "script-api:dw/catalog/CategoryLink", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.CategoryLink", + "sections": [ + { + "body": "A CategoryLink represents a directed relationship between two catalog\ncategories. Merchants create category links in order to market similar or\nrelated groups of products.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "categorylink", + "dw.catalog.categorylink", + "dw/catalog" + ], + "title": "CategoryLink" + }, + { + "description": "Represents an accessory category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_ACCESSORY", + "sections": [ + { + "body": "Represents an accessory category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ACCESSORY = 2", + "source": "script-api", + "tags": [ + "linktype_accessory", + "categorylink.linktype_accessory" + ], + "title": "CategoryLink.LINKTYPE_ACCESSORY" + }, + { + "description": "Represents an accessory category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_ACCESSORY", + "sections": [ + { + "body": "Represents an accessory category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ACCESSORY = 2", + "source": "script-api", + "tags": [ + "linktype_accessory", + "categorylink.linktype_accessory" + ], + "title": "CategoryLink.LINKTYPE_ACCESSORY" + }, + { + "description": "Represents a cross-sell category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_CROSS_SELL = 4", + "source": "script-api", + "tags": [ + "linktype_cross_sell", + "categorylink.linktype_cross_sell" + ], + "title": "CategoryLink.LINKTYPE_CROSS_SELL" + }, + { + "description": "Represents a cross-sell category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_CROSS_SELL = 4", + "source": "script-api", + "tags": [ + "linktype_cross_sell", + "categorylink.linktype_cross_sell" + ], + "title": "CategoryLink.LINKTYPE_CROSS_SELL" + }, + { + "description": "Represents a miscellaneous category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_OTHER", + "sections": [ + { + "body": "Represents a miscellaneous category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_OTHER = 1", + "source": "script-api", + "tags": [ + "linktype_other", + "categorylink.linktype_other" + ], + "title": "CategoryLink.LINKTYPE_OTHER" + }, + { + "description": "Represents a miscellaneous category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_OTHER", + "sections": [ + { + "body": "Represents a miscellaneous category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_OTHER = 1", + "source": "script-api", + "tags": [ + "linktype_other", + "categorylink.linktype_other" + ], + "title": "CategoryLink.LINKTYPE_OTHER" + }, + { + "description": "Represents a spare part category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_SPARE_PART", + "sections": [ + { + "body": "Represents a spare part category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_SPARE_PART = 6", + "source": "script-api", + "tags": [ + "linktype_spare_part", + "categorylink.linktype_spare_part" + ], + "title": "CategoryLink.LINKTYPE_SPARE_PART" + }, + { + "description": "Represents a spare part category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_SPARE_PART", + "sections": [ + { + "body": "Represents a spare part category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_SPARE_PART = 6", + "source": "script-api", + "tags": [ + "linktype_spare_part", + "categorylink.linktype_spare_part" + ], + "title": "CategoryLink.LINKTYPE_SPARE_PART" + }, + { + "description": "Represents an up-sell category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_UP_SELL = 5", + "source": "script-api", + "tags": [ + "linktype_up_sell", + "categorylink.linktype_up_sell" + ], + "title": "CategoryLink.LINKTYPE_UP_SELL" + }, + { + "description": "Represents an up-sell category link.", + "id": "script-api:dw/catalog/CategoryLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.LINKTYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell category link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_UP_SELL = 5", + "source": "script-api", + "tags": [ + "linktype_up_sell", + "categorylink.linktype_up_sell" + ], + "title": "CategoryLink.LINKTYPE_UP_SELL" + }, + { + "description": "Returns the object for the relation 'sourceCategory'.", + "id": "script-api:dw/catalog/CategoryLink#getSourceCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getSourceCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the object for the relation 'sourceCategory'.", + "heading": "Description" + } + ], + "signature": "getSourceCategory(): Category", + "source": "script-api", + "tags": [ + "getsourcecategory", + "categorylink.getsourcecategory" + ], + "title": "CategoryLink.getSourceCategory" + }, + { + "description": "Returns the object for the relation 'targetCategory'.", + "id": "script-api:dw/catalog/CategoryLink#getTargetCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getTargetCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the object for the relation 'targetCategory'.", + "heading": "Description" + } + ], + "signature": "getTargetCategory(): Category", + "source": "script-api", + "tags": [ + "gettargetcategory", + "categorylink.gettargetcategory" + ], + "title": "CategoryLink.getTargetCategory" + }, + { + "description": "Returns the type of this category link (see constants).", + "id": "script-api:dw/catalog/CategoryLink#getTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.getTypeCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of this category link (see constants).", + "heading": "Description" + } + ], + "signature": "getTypeCode(): number", + "source": "script-api", + "tags": [ + "gettypecode", + "categorylink.gettypecode" + ], + "title": "CategoryLink.getTypeCode" + }, + { + "description": "Returns the object for the relation 'sourceCategory'.", + "id": "script-api:dw/catalog/CategoryLink#sourceCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.sourceCategory", + "sections": [ + { + "body": "Returns the object for the relation 'sourceCategory'.", + "heading": "Description" + } + ], + "signature": "readonly sourceCategory: Category", + "source": "script-api", + "tags": [ + "sourcecategory", + "categorylink.sourcecategory" + ], + "title": "CategoryLink.sourceCategory" + }, + { + "description": "Returns the object for the relation 'targetCategory'.", + "id": "script-api:dw/catalog/CategoryLink#targetCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.targetCategory", + "sections": [ + { + "body": "Returns the object for the relation 'targetCategory'.", + "heading": "Description" + } + ], + "signature": "readonly targetCategory: Category", + "source": "script-api", + "tags": [ + "targetcategory", + "categorylink.targetcategory" + ], + "title": "CategoryLink.targetCategory" + }, + { + "description": "Returns the type of this category link (see constants).", + "id": "script-api:dw/catalog/CategoryLink#typeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/CategoryLink", + "qualifiedName": "dw.catalog.CategoryLink.typeCode", + "sections": [ + { + "body": "Returns the type of this category link (see constants).", + "heading": "Description" + } + ], + "signature": "readonly typeCode: number", + "source": "script-api", + "tags": [ + "typecode", + "categorylink.typecode" + ], + "title": "CategoryLink.typeCode" + }, + { + "description": "Represents a price book.", + "id": "script-api:dw/catalog/PriceBook", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.PriceBook", + "sections": [ + { + "body": "Represents a price book.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "pricebook", + "dw.catalog.pricebook", + "dw/catalog" + ], + "title": "PriceBook" + }, + { + "description": "Returns the ID of the price book.", + "id": "script-api:dw/catalog/PriceBook#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.ID", + "sections": [ + { + "body": "Returns the ID of the price book.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "pricebook.id" + ], + "title": "PriceBook.ID" + }, + { + "description": "Returns the currency code of the price book.", + "id": "script-api:dw/catalog/PriceBook#currencyCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.currencyCode", + "sections": [ + { + "body": "Returns the currency code of the price book.", + "heading": "Description" + } + ], + "signature": "readonly currencyCode: string", + "source": "script-api", + "tags": [ + "currencycode", + "pricebook.currencycode" + ], + "title": "PriceBook.currencyCode" + }, + { + "description": "Returns the description of the price book.", + "id": "script-api:dw/catalog/PriceBook#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.description", + "sections": [ + { + "body": "Returns the description of the price book.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "pricebook.description" + ], + "title": "PriceBook.description" + }, + { + "description": "Returns the display name of the price book.", + "id": "script-api:dw/catalog/PriceBook#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.displayName", + "sections": [ + { + "body": "Returns the display name of the price book.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "pricebook.displayname" + ], + "title": "PriceBook.displayName" + }, + { + "description": "Returns the currency code of the price book.", + "id": "script-api:dw/catalog/PriceBook#getCurrencyCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getCurrencyCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the currency code of the price book.", + "heading": "Description" + } + ], + "signature": "getCurrencyCode(): string", + "source": "script-api", + "tags": [ + "getcurrencycode", + "pricebook.getcurrencycode" + ], + "title": "PriceBook.getCurrencyCode" + }, + { + "description": "Returns the description of the price book.", + "id": "script-api:dw/catalog/PriceBook#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description of the price book.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "pricebook.getdescription" + ], + "title": "PriceBook.getDescription" + }, + { + "description": "Returns the display name of the price book.", + "id": "script-api:dw/catalog/PriceBook#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of the price book.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "pricebook.getdisplayname" + ], + "title": "PriceBook.getDisplayName" + }, + { + "description": "Returns the ID of the price book.", + "id": "script-api:dw/catalog/PriceBook#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the price book.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "pricebook.getid" + ], + "title": "PriceBook.getID" + }, + { + "description": "Returns the online status flag of the price book.", + "id": "script-api:dw/catalog/PriceBook#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status flag of the price book.", + "heading": "Description" + } + ], + "signature": "getOnlineFlag(): boolean", + "source": "script-api", + "tags": [ + "getonlineflag", + "pricebook.getonlineflag" + ], + "title": "PriceBook.getOnlineFlag" + }, + { + "description": "Returns the date from which the price book is online or valid.", + "id": "script-api:dw/catalog/PriceBook#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineFrom", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date from which the price book is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date", + "source": "script-api", + "tags": [ + "getonlinefrom", + "pricebook.getonlinefrom" + ], + "title": "PriceBook.getOnlineFrom" + }, + { + "description": "Returns the date until which the price book is online or valid.", + "id": "script-api:dw/catalog/PriceBook#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getOnlineTo", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date until which the price book is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date", + "source": "script-api", + "tags": [ + "getonlineto", + "pricebook.getonlineto" + ], + "title": "PriceBook.getOnlineTo" + }, + { + "description": "Returns the parent price book.", + "id": "script-api:dw/catalog/PriceBook#getParentPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.getParentPriceBook", + "returns": { + "type": "PriceBook" + }, + "sections": [ + { + "body": "Returns the parent price book.", + "heading": "Description" + } + ], + "signature": "getParentPriceBook(): PriceBook", + "source": "script-api", + "tags": [ + "getparentpricebook", + "pricebook.getparentpricebook" + ], + "title": "PriceBook.getParentPriceBook" + }, + { + "description": "Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.", + "id": "script-api:dw/catalog/PriceBook#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status of the price book. The online status\nis calculated from the online status flag and the onlineFrom\nonlineTo dates defined for the price book.", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "pricebook.isonline" + ], + "title": "PriceBook.isOnline" + }, + { + "description": "Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.", + "id": "script-api:dw/catalog/PriceBook#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.online", + "sections": [ + { + "body": "Returns the online status of the price book. The online status\nis calculated from the online status flag and the onlineFrom\nonlineTo dates defined for the price book.", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "pricebook.online" + ], + "title": "PriceBook.online" + }, + { + "description": "Returns the online status flag of the price book.", + "id": "script-api:dw/catalog/PriceBook#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineFlag", + "sections": [ + { + "body": "Returns the online status flag of the price book.", + "heading": "Description" + } + ], + "signature": "readonly onlineFlag: boolean", + "source": "script-api", + "tags": [ + "onlineflag", + "pricebook.onlineflag" + ], + "title": "PriceBook.onlineFlag" + }, + { + "description": "Returns the date from which the price book is online or valid.", + "id": "script-api:dw/catalog/PriceBook#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineFrom", + "sections": [ + { + "body": "Returns the date from which the price book is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date", + "source": "script-api", + "tags": [ + "onlinefrom", + "pricebook.onlinefrom" + ], + "title": "PriceBook.onlineFrom" + }, + { + "description": "Returns the date until which the price book is online or valid.", + "id": "script-api:dw/catalog/PriceBook#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.onlineTo", + "sections": [ + { + "body": "Returns the date until which the price book is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date", + "source": "script-api", + "tags": [ + "onlineto", + "pricebook.onlineto" + ], + "title": "PriceBook.onlineTo" + }, + { + "description": "Returns the parent price book.", + "id": "script-api:dw/catalog/PriceBook#parentPriceBook", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBook", + "qualifiedName": "dw.catalog.PriceBook.parentPriceBook", + "sections": [ + { + "body": "Returns the parent price book.", + "heading": "Description" + } + ], + "signature": "readonly parentPriceBook: PriceBook", + "source": "script-api", + "tags": [ + "parentpricebook", + "pricebook.parentpricebook" + ], + "title": "PriceBook.parentPriceBook" + }, + { + "description": "Price book manager provides methods to access price books.", + "id": "script-api:dw/catalog/PriceBookMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.PriceBookMgr", + "sections": [ + { + "body": "Price book manager provides methods to access price books.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pricebookmgr", + "dw.catalog.pricebookmgr", + "dw/catalog" + ], + "title": "PriceBookMgr" + }, + { + "description": "Returns all price books defined for the organization.", + "id": "script-api:dw/catalog/PriceBookMgr#allPriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.allPriceBooks", + "sections": [ + { + "body": "Returns all price books defined for the organization.", + "heading": "Description" + } + ], + "signature": "static readonly allPriceBooks: Collection", + "source": "script-api", + "tags": [ + "allpricebooks", + "pricebookmgr.allpricebooks" + ], + "title": "PriceBookMgr.allPriceBooks" + }, + { + "description": "Returns all price books defined for the organization.", + "id": "script-api:dw/catalog/PriceBookMgr#allPriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.allPriceBooks", + "sections": [ + { + "body": "Returns all price books defined for the organization.", + "heading": "Description" + } + ], + "signature": "static readonly allPriceBooks: Collection", + "source": "script-api", + "tags": [ + "allpricebooks", + "pricebookmgr.allpricebooks" + ], + "title": "PriceBookMgr.allPriceBooks" + }, + { + "description": "Returns a collection of price books that are set in the user session.", + "id": "script-api:dw/catalog/PriceBookMgr#applicablePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.applicablePriceBooks", + "sections": [ + { + "body": "Returns a collection of price books that are set in the user session.", + "heading": "Description" + } + ], + "signature": "static applicablePriceBooks: Collection", + "source": "script-api", + "tags": [ + "applicablepricebooks", + "pricebookmgr.applicablepricebooks" + ], + "title": "PriceBookMgr.applicablePriceBooks" + }, + { + "description": "Returns a collection of price books that are set in the user session.", + "id": "script-api:dw/catalog/PriceBookMgr#applicablePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.applicablePriceBooks", + "sections": [ + { + "body": "Returns a collection of price books that are set in the user session.", + "heading": "Description" + } + ], + "signature": "static applicablePriceBooks: Collection", + "source": "script-api", + "tags": [ + "applicablepricebooks", + "pricebookmgr.applicablepricebooks" + ], + "title": "PriceBookMgr.applicablePriceBooks" + }, + { + "description": "Assign a price book to a site. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#assignPriceBookToSite", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + }, + { + "name": "siteId", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.assignPriceBookToSite", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Assign a price book to a site. This requires a transaction, see dw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static assignPriceBookToSite(priceBook: PriceBook, siteId: string): boolean", + "source": "script-api", + "tags": [ + "assignpricebooktosite", + "pricebookmgr.assignpricebooktosite" + ], + "title": "PriceBookMgr.assignPriceBookToSite" + }, + { + "description": "Assign a price book to a site. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#assignPriceBookToSite", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + }, + { + "name": "siteId", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.assignPriceBookToSite", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Assign a price book to a site. This requires a transaction, see dw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static assignPriceBookToSite(priceBook: PriceBook, siteId: string): boolean", + "source": "script-api", + "tags": [ + "assignpricebooktosite", + "pricebookmgr.assignpricebooktosite" + ], + "title": "PriceBookMgr.assignPriceBookToSite" + }, + { + "description": "Returns all price books defined for the organization.", + "id": "script-api:dw/catalog/PriceBookMgr#getAllPriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getAllPriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all price books defined for the organization.", + "heading": "Description" + } + ], + "signature": "static getAllPriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getallpricebooks", + "pricebookmgr.getallpricebooks" + ], + "title": "PriceBookMgr.getAllPriceBooks" + }, + { + "description": "Returns all price books defined for the organization.", + "id": "script-api:dw/catalog/PriceBookMgr#getAllPriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getAllPriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all price books defined for the organization.", + "heading": "Description" + } + ], + "signature": "static getAllPriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getallpricebooks", + "pricebookmgr.getallpricebooks" + ], + "title": "PriceBookMgr.getAllPriceBooks" + }, + { + "description": "Returns a collection of price books that are set in the user session.", + "id": "script-api:dw/catalog/PriceBookMgr#getApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getApplicablePriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of price books that are set in the user session.", + "heading": "Description" + } + ], + "signature": "static getApplicablePriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getapplicablepricebooks", + "pricebookmgr.getapplicablepricebooks" + ], + "title": "PriceBookMgr.getApplicablePriceBooks" + }, + { + "description": "Returns a collection of price books that are set in the user session.", + "id": "script-api:dw/catalog/PriceBookMgr#getApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getApplicablePriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of price books that are set in the user session.", + "heading": "Description" + } + ], + "signature": "static getApplicablePriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getapplicablepricebooks", + "pricebookmgr.getapplicablepricebooks" + ], + "title": "PriceBookMgr.getApplicablePriceBooks" + }, + { + "description": "Returns the price book of the current organization matching the specified ID.", + "id": "script-api:dw/catalog/PriceBookMgr#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getPriceBook", + "returns": { + "type": "PriceBook | null" + }, + "sections": [ + { + "body": "Returns the price book of the current organization matching the specified ID.", + "heading": "Description" + } + ], + "signature": "static getPriceBook(priceBookID: string): PriceBook | null", + "source": "script-api", + "tags": [ + "getpricebook", + "pricebookmgr.getpricebook" + ], + "title": "PriceBookMgr.getPriceBook" + }, + { + "description": "Returns the price book of the current organization matching the specified ID.", + "id": "script-api:dw/catalog/PriceBookMgr#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getPriceBook", + "returns": { + "type": "PriceBook | null" + }, + "sections": [ + { + "body": "Returns the price book of the current organization matching the specified ID.", + "heading": "Description" + } + ], + "signature": "static getPriceBook(priceBookID: string): PriceBook | null", + "source": "script-api", + "tags": [ + "getpricebook", + "pricebookmgr.getpricebook" + ], + "title": "PriceBookMgr.getPriceBook" + }, + { + "description": "Returns all price books assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#getSitePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getSitePriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all price books assigned to the current site.\n\nPlease note that this doesn't include parent price books not assigned to the site, but considered by the price\nlookup.", + "heading": "Description" + } + ], + "signature": "static getSitePriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getsitepricebooks", + "pricebookmgr.getsitepricebooks" + ], + "title": "PriceBookMgr.getSitePriceBooks" + }, + { + "description": "Returns all price books assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#getSitePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.getSitePriceBooks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all price books assigned to the current site.\n\nPlease note that this doesn't include parent price books not assigned to the site, but considered by the price\nlookup.", + "heading": "Description" + } + ], + "signature": "static getSitePriceBooks(): Collection", + "source": "script-api", + "tags": [ + "getsitepricebooks", + "pricebookmgr.getsitepricebooks" + ], + "title": "PriceBookMgr.getSitePriceBooks" + }, + { + "description": "Sets one or more price books to be considered by the product price lookup. The information is stored in the user session. If no price book is set in the user session, all active and valid price books assigned to the site are used for the price lookup. If price books are set, only those price books are considered by the price lookup. Note that the system does not assure that a price book set by this API is assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#setApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBooks", + "optional": true, + "type": "PriceBook[]" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.setApplicablePriceBooks", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets one or more price books to be considered by the product price lookup. The information is stored in the user\nsession. If no price book is set in the user session, all active and valid price books assigned to the site are\nused for the price lookup. If price books are set, only those price books are considered by the price lookup.\nNote that the system does not assure that a price book set by this API is assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static setApplicablePriceBooks(priceBooks?: PriceBook[]): void", + "source": "script-api", + "tags": [ + "setapplicablepricebooks", + "pricebookmgr.setapplicablepricebooks" + ], + "title": "PriceBookMgr.setApplicablePriceBooks" + }, + { + "description": "Sets one or more price books to be considered by the product price lookup. The information is stored in the user session. If no price book is set in the user session, all active and valid price books assigned to the site are used for the price lookup. If price books are set, only those price books are considered by the price lookup. Note that the system does not assure that a price book set by this API is assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#setApplicablePriceBooks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBooks", + "optional": true, + "type": "PriceBook[]" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.setApplicablePriceBooks", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets one or more price books to be considered by the product price lookup. The information is stored in the user\nsession. If no price book is set in the user session, all active and valid price books assigned to the site are\nused for the price lookup. If price books are set, only those price books are considered by the price lookup.\nNote that the system does not assure that a price book set by this API is assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static setApplicablePriceBooks(priceBooks?: PriceBook[]): void", + "source": "script-api", + "tags": [ + "setapplicablepricebooks", + "pricebookmgr.setapplicablepricebooks" + ], + "title": "PriceBookMgr.setApplicablePriceBooks" + }, + { + "description": "Returns all price books assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#sitePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.sitePriceBooks", + "sections": [ + { + "body": "Returns all price books assigned to the current site.\n\nPlease note that this doesn't include parent price books not assigned to the site, but considered by the price\nlookup.", + "heading": "Description" + } + ], + "signature": "static readonly sitePriceBooks: Collection", + "source": "script-api", + "tags": [ + "sitepricebooks", + "pricebookmgr.sitepricebooks" + ], + "title": "PriceBookMgr.sitePriceBooks" + }, + { + "description": "Returns all price books assigned to the current site.", + "id": "script-api:dw/catalog/PriceBookMgr#sitePriceBooks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.sitePriceBooks", + "sections": [ + { + "body": "Returns all price books assigned to the current site.\n\nPlease note that this doesn't include parent price books not assigned to the site, but considered by the price\nlookup.", + "heading": "Description" + } + ], + "signature": "static readonly sitePriceBooks: Collection", + "source": "script-api", + "tags": [ + "sitepricebooks", + "pricebookmgr.sitepricebooks" + ], + "title": "PriceBookMgr.sitePriceBooks" + }, + { + "description": "Unassign a price book from all sites. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromAllSites", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromAllSites", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Unassign a price book from all sites. This requires a transaction, see\ndw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static unassignPriceBookFromAllSites(priceBook: PriceBook): boolean", + "source": "script-api", + "tags": [ + "unassignpricebookfromallsites", + "pricebookmgr.unassignpricebookfromallsites" + ], + "title": "PriceBookMgr.unassignPriceBookFromAllSites" + }, + { + "description": "Unassign a price book from all sites. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromAllSites", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromAllSites", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Unassign a price book from all sites. This requires a transaction, see\ndw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static unassignPriceBookFromAllSites(priceBook: PriceBook): boolean", + "source": "script-api", + "tags": [ + "unassignpricebookfromallsites", + "pricebookmgr.unassignpricebookfromallsites" + ], + "title": "PriceBookMgr.unassignPriceBookFromAllSites" + }, + { + "description": "Unassign a price book from a site. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromSite", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + }, + { + "name": "siteId", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromSite", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Unassign a price book from a site. This requires a transaction, see\ndw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static unassignPriceBookFromSite(priceBook: PriceBook, siteId: string): boolean", + "source": "script-api", + "tags": [ + "unassignpricebookfromsite", + "pricebookmgr.unassignpricebookfromsite" + ], + "title": "PriceBookMgr.unassignPriceBookFromSite" + }, + { + "description": "Unassign a price book from a site. This requires a transaction, see dw.system.Transaction.wrap", + "id": "script-api:dw/catalog/PriceBookMgr#unassignPriceBookFromSite", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBook", + "type": "PriceBook" + }, + { + "name": "siteId", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/PriceBookMgr", + "qualifiedName": "dw.catalog.PriceBookMgr.unassignPriceBookFromSite", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Unassign a price book from a site. This requires a transaction, see\ndw.system.Transaction.wrap", + "heading": "Description" + } + ], + "signature": "static unassignPriceBookFromSite(priceBook: PriceBook, siteId: string): boolean", + "source": "script-api", + "tags": [ + "unassignpricebookfromsite", + "pricebookmgr.unassignpricebookfromsite" + ], + "title": "PriceBookMgr.unassignPriceBookFromSite" + }, + { + "description": "Represents a product in Commerce Cloud Digital. Products are identified by a unique product ID, sometimes called the SKU. There are several different types of product:", + "id": "script-api:dw/catalog/Product", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Product", + "sections": [ + { + "body": "Represents a product in Commerce Cloud Digital. Products are identified by\na unique product ID, sometimes called the SKU. There are several different\ntypes of product:\n\n- Simple product\n- Master products: This type of product defines a template for a set\nof related products which differ only by a set of defined\n\"variation attributes\", such as size or color. Master products are not\norderable themselves. The variation information for a master product is\navailable through its dw.catalog.ProductVariationModel.\n- Variant: Variants are the actual orderable products that are\nrelated to a master product. Each variant of a master product has a unique\nset of values for the defined variation attributes. Variants are said to be\n\"mastered\" by the corresponding master product.\n- Option products: Option products define additional options, such\nas a warranty, which can be purchased for a defined price at the time the\nproduct is purchased. The option information for an option product is\navailable through its dw.catalog.ProductOptionModel.\n- Product-sets: A product-set is a set of products which the\nmerchant can sell as a collection in the storefront, for example an outfit of\nclothes. Product-sets are not orderable and therefore do not define prices.\nThey exist only to group the products together in the storefront UI. Members\nof the set are called \"product-set-products\".\n- Products bundles: A collection of products which can be ordered as\na single unit and therefore can define its own price and inventory record.\n\nProduct price and availability information are retrievable through\ngetPriceModel and getAvailabilityModel respectively.\nAttribute information is retrievable through getAttributeModel.\nProducts may reference other products, either as recommendations or product\nlinks. This class provides the methods for retrieving these referenced\nproducts.\n\nProducts belong to a catalog (the \"owning\" catalog) and are assigned to\ncategories in other catalogs. Products assigned to categories in the site\ncatalog are typically orderable on the site.\n\nAny API method which returns products will return an instance of a\ndw.catalog.Variant for variant products. This subclass contains\nmethods which are specific to this type of product.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "product", + "dw.catalog.product", + "dw/catalog" + ], + "title": "Product" + }, + { + "description": "Returns the European Article Number of the product.", + "id": "script-api:dw/catalog/Product#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.EAN", + "sections": [ + { + "body": "Returns the European Article Number of the product.", + "heading": "Description" + } + ], + "signature": "readonly EAN: string", + "source": "script-api", + "tags": [ + "ean", + "product.ean" + ], + "title": "Product.EAN" + }, + { + "description": "Returns the ID of the product.", + "id": "script-api:dw/catalog/Product#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.ID", + "sections": [ + { + "body": "Returns the ID of the product.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "product.id" + ], + "title": "Product.ID" + }, + { + "description": "Returns the Universal Product Code of the product.", + "id": "script-api:dw/catalog/Product#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.UPC", + "sections": [ + { + "body": "Returns the Universal Product Code of the product.", + "heading": "Description" + } + ], + "signature": "readonly UPC: string", + "source": "script-api", + "tags": [ + "upc", + "product.upc" + ], + "title": "Product.UPC" + }, + { + "description": "Returns the active data for this product, for the current site.", + "id": "script-api:dw/catalog/Product#activeData", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.activeData", + "sections": [ + { + "body": "Returns the active data for this product, for the current site.", + "heading": "Description" + } + ], + "signature": "readonly activeData: ProductActiveData", + "source": "script-api", + "tags": [ + "activedata", + "product.activedata" + ], + "title": "Product.activeData" + }, + { + "description": "Returns a collection of all categories to which this product is assigned.", + "id": "script-api:dw/catalog/Product#allCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allCategories", + "sections": [ + { + "body": "Returns a collection of all categories to which this product is assigned.", + "heading": "Description" + } + ], + "signature": "readonly allCategories: Collection", + "source": "script-api", + "tags": [ + "allcategories", + "product.allcategories" + ], + "title": "Product.allCategories" + }, + { + "description": "Returns all category assignments for this product in any catalog.", + "id": "script-api:dw/catalog/Product#allCategoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allCategoryAssignments", + "sections": [ + { + "body": "Returns all category assignments for this product in any catalog.", + "heading": "Description" + } + ], + "signature": "readonly allCategoryAssignments: Collection", + "source": "script-api", + "tags": [ + "allcategoryassignments", + "product.allcategoryassignments" + ], + "title": "Product.allCategoryAssignments" + }, + { + "description": "Returns all incoming ProductLinks.", + "id": "script-api:dw/catalog/Product#allIncomingProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allIncomingProductLinks", + "sections": [ + { + "body": "Returns all incoming ProductLinks.", + "heading": "Description" + } + ], + "signature": "readonly allIncomingProductLinks: Collection", + "source": "script-api", + "tags": [ + "allincomingproductlinks", + "product.allincomingproductlinks" + ], + "title": "Product.allIncomingProductLinks" + }, + { + "description": "Returns all outgoing ProductLinks.", + "id": "script-api:dw/catalog/Product#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.allProductLinks", + "sections": [ + { + "body": "Returns all outgoing ProductLinks.", + "heading": "Description" + } + ], + "signature": "readonly allProductLinks: Collection", + "source": "script-api", + "tags": [ + "allproductlinks", + "product.allproductlinks" + ], + "title": "Product.allProductLinks" + }, + { + "deprecated": { + "message": "Use isAssignedToCategory" + }, + "description": "Identifies if this product is bound to the specified catalog category.", + "id": "script-api:dw/catalog/Product#assignedToCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "category", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.assignedToCategory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product is bound to the specified catalog category.", + "heading": "Description" + } + ], + "signature": "assignedToCategory(category: Category): boolean", + "source": "script-api", + "tags": [ + "assignedtocategory", + "product.assignedtocategory" + ], + "title": "Product.assignedToCategory" + }, + { + "description": "Returns `true` if the product is assigned to the current site (via the site catalog), otherwise `false` is returned.", + "id": "script-api:dw/catalog/Product#assignedToSiteCatalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.assignedToSiteCatalog", + "sections": [ + { + "body": "Returns `true` if the product is assigned to the current site (via the site catalog), otherwise\n`false` is returned.\n\nIn case of the product being a variant, the variant will be considered as assigned if its master, one of the\nvariation groups it is in or itself is assigned to the site catalog. In case this is triggered for a variation\ngroup the variation group is considered as assigned if its master or itself is assigned.", + "heading": "Description" + } + ], + "signature": "readonly assignedToSiteCatalog: boolean", + "source": "script-api", + "tags": [ + "assignedtositecatalog", + "product.assignedtositecatalog" + ], + "title": "Product.assignedToSiteCatalog" + }, + { + "description": "Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient. The model is calculated based on the product attributes assigned to this product's classification category (or any of it's ancestors) and the global attribute definitions for the system object type 'Product'. If this product has no classification category, the attribute model is calculated on the global attribute definitions only. If this product is a variant, then the attribute model is calculated based on the classification category of its corresponding master product.", + "id": "script-api:dw/catalog/Product#attributeModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.attributeModel", + "sections": [ + { + "body": "Returns this product's ProductAttributeModel, which makes access to the\nproduct attribute information convenient. The model is calculated based\non the product attributes assigned to this product's classification\ncategory (or any of it's ancestors) and the global attribute definitions\nfor the system object type 'Product'. If this product has no\nclassification category, the attribute model is calculated on the global\nattribute definitions only. If this product is a variant, then the\nattribute model is calculated based on the classification category of its\ncorresponding master product.", + "heading": "Description" + } + ], + "signature": "readonly attributeModel: ProductAttributeModel", + "source": "script-api", + "tags": [ + "attributemodel", + "product.attributemodel" + ], + "title": "Product.attributeModel" + }, + { + "description": "Returns the availability model, which can be used to determine availability information for a product.", + "id": "script-api:dw/catalog/Product#availabilityModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.availabilityModel", + "sections": [ + { + "body": "Returns the availability model, which can be used to determine availability\ninformation for a product.", + "heading": "Description" + } + ], + "signature": "readonly availabilityModel: ProductAvailabilityModel", + "source": "script-api", + "tags": [ + "availabilitymodel", + "product.availabilitymodel" + ], + "title": "Product.availabilityModel" + }, + { + "deprecated": { + "message": "Use getAvailabilityModel.isInStock() instead" + }, + "description": "Identifies if the product is available.", + "id": "script-api:dw/catalog/Product#available", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.available", + "sections": [ + { + "body": "Identifies if the product is available.", + "heading": "Description" + } + ], + "signature": "readonly available: boolean", + "source": "script-api", + "tags": [ + "available", + "product.available" + ], + "title": "Product.available" + }, + { + "deprecated": { + "message": "Use getAvailabilityModel instead." + }, + "description": "Identifies if the product is available.", + "id": "script-api:dw/catalog/Product#availableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.availableFlag", + "sections": [ + { + "body": "Identifies if the product is available.", + "heading": "Description" + } + ], + "signature": "availableFlag: boolean", + "source": "script-api", + "tags": [ + "availableflag", + "product.availableflag" + ], + "title": "Product.availableFlag" + }, + { + "description": "Returns the Brand of the product.", + "id": "script-api:dw/catalog/Product#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.brand", + "sections": [ + { + "body": "Returns the Brand of the product.", + "heading": "Description" + } + ], + "signature": "readonly brand: string", + "source": "script-api", + "tags": [ + "brand", + "product.brand" + ], + "title": "Product.brand" + }, + { + "description": "Identifies if this product instance is a product bundle.", + "id": "script-api:dw/catalog/Product#bundle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundle", + "sections": [ + { + "body": "Identifies if this product instance is a product bundle.", + "heading": "Description" + } + ], + "signature": "readonly bundle: boolean", + "source": "script-api", + "tags": [ + "bundle", + "product.bundle" + ], + "title": "Product.bundle" + }, + { + "description": "Identifies if this product instance is bundled within at least one product bundle.", + "id": "script-api:dw/catalog/Product#bundled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundled", + "sections": [ + { + "body": "Identifies if this product instance is bundled within at least one\nproduct bundle.", + "heading": "Description" + } + ], + "signature": "readonly bundled: boolean", + "source": "script-api", + "tags": [ + "bundled", + "product.bundled" + ], + "title": "Product.bundled" + }, + { + "description": "Returns a collection containing all products that participate in the product bundle.", + "id": "script-api:dw/catalog/Product#bundledProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundledProducts", + "sections": [ + { + "body": "Returns a collection containing all products that participate in the\nproduct bundle.", + "heading": "Description" + } + ], + "signature": "readonly bundledProducts: Collection>", + "source": "script-api", + "tags": [ + "bundledproducts", + "product.bundledproducts" + ], + "title": "Product.bundledProducts" + }, + { + "description": "Returns a collection of all bundles in which this product is included. The method only returns bundles assigned to the current site.", + "id": "script-api:dw/catalog/Product#bundles", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.bundles", + "sections": [ + { + "body": "Returns a collection of all bundles in which this product is included.\nThe method only returns bundles assigned to the current site.", + "heading": "Description" + } + ], + "signature": "readonly bundles: Collection>", + "source": "script-api", + "tags": [ + "bundles", + "product.bundles" + ], + "title": "Product.bundles" + }, + { + "description": "Returns a collection of all categories to which this product is assigned and which are also available through the current site.", + "id": "script-api:dw/catalog/Product#categories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categories", + "sections": [ + { + "body": "Returns a collection of all categories to which this product is assigned\nand which are also available through the current site.", + "heading": "Description" + } + ], + "signature": "readonly categories: Collection", + "source": "script-api", + "tags": [ + "categories", + "product.categories" + ], + "title": "Product.categories" + }, + { + "description": "Identifies if this product is bound to at least one catalog category.", + "id": "script-api:dw/catalog/Product#categorized", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categorized", + "sections": [ + { + "body": "Identifies if this product is bound to at least one catalog category.", + "heading": "Description" + } + ], + "signature": "readonly categorized: boolean", + "source": "script-api", + "tags": [ + "categorized", + "product.categorized" + ], + "title": "Product.categorized" + }, + { + "description": "Returns a collection of category assignments for this product in the current site catalog.", + "id": "script-api:dw/catalog/Product#categoryAssignments", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.categoryAssignments", + "sections": [ + { + "body": "Returns a collection of category assignments for this product in\nthe current site catalog.", + "heading": "Description" + } + ], + "signature": "readonly categoryAssignments: Collection", + "source": "script-api", + "tags": [ + "categoryassignments", + "product.categoryassignments" + ], + "title": "Product.categoryAssignments" + }, + { + "description": "Returns the classification category associated with this Product. A product has a single classification category which may or may not be in the site catalog. The classification category defines the attribute set of the product. See dw.catalog.Product.getAttributeModel for how the classification category is used.", + "id": "script-api:dw/catalog/Product#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.classificationCategory", + "sections": [ + { + "body": "Returns the classification category associated with this Product. A\nproduct has a single classification category which may or may not be in\nthe site catalog. The classification category defines the attribute set\nof the product. See dw.catalog.Product.getAttributeModel for\nhow the classification category is used.", + "heading": "Description" + } + ], + "signature": "readonly classificationCategory: Category | null", + "source": "script-api", + "tags": [ + "classificationcategory", + "product.classificationcategory" + ], + "title": "Product.classificationCategory" + }, + { + "description": "Identifies if the product is Facebook enabled.", + "id": "script-api:dw/catalog/Product#facebookEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.facebookEnabled", + "sections": [ + { + "body": "Identifies if the product is Facebook enabled.", + "heading": "Description" + } + ], + "signature": "readonly facebookEnabled: boolean", + "source": "script-api", + "tags": [ + "facebookenabled", + "product.facebookenabled" + ], + "title": "Product.facebookEnabled" + }, + { + "description": "Returns the active data for this product, for the current site.", + "id": "script-api:dw/catalog/Product#getActiveData", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getActiveData", + "returns": { + "type": "ProductActiveData" + }, + "sections": [ + { + "body": "Returns the active data for this product, for the current site.", + "heading": "Description" + } + ], + "signature": "getActiveData(): ProductActiveData", + "source": "script-api", + "tags": [ + "getactivedata", + "product.getactivedata" + ], + "title": "Product.getActiveData" + }, + { + "description": "Returns a collection of all categories to which this product is assigned.", + "id": "script-api:dw/catalog/Product#getAllCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllCategories", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all categories to which this product is assigned.", + "heading": "Description" + } + ], + "signature": "getAllCategories(): Collection", + "source": "script-api", + "tags": [ + "getallcategories", + "product.getallcategories" + ], + "title": "Product.getAllCategories" + }, + { + "description": "Returns all category assignments for this product in any catalog.", + "id": "script-api:dw/catalog/Product#getAllCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllCategoryAssignments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all category assignments for this product in any catalog.", + "heading": "Description" + } + ], + "signature": "getAllCategoryAssignments(): Collection", + "source": "script-api", + "tags": [ + "getallcategoryassignments", + "product.getallcategoryassignments" + ], + "title": "Product.getAllCategoryAssignments" + }, + { + "description": "Returns all incoming ProductLinks.", + "id": "script-api:dw/catalog/Product#getAllIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllIncomingProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all incoming ProductLinks.", + "heading": "Description" + } + ], + "signature": "getAllIncomingProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallincomingproductlinks", + "product.getallincomingproductlinks" + ], + "title": "Product.getAllIncomingProductLinks" + }, + { + "description": "Returns all incoming ProductLinks of a specific type.", + "id": "script-api:dw/catalog/Product#getAllIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllIncomingProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all incoming ProductLinks of a specific type.", + "heading": "Description" + } + ], + "signature": "getAllIncomingProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallincomingproductlinks", + "product.getallincomingproductlinks" + ], + "title": "Product.getAllIncomingProductLinks" + }, + { + "description": "Returns all outgoing ProductLinks.", + "id": "script-api:dw/catalog/Product#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing ProductLinks.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "product.getallproductlinks" + ], + "title": "Product.getAllProductLinks" + }, + { + "description": "Returns all outgoing ProductLinks of a specific type.", + "id": "script-api:dw/catalog/Product#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing ProductLinks of a specific type.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "product.getallproductlinks" + ], + "title": "Product.getAllProductLinks" + }, + { + "description": "Returns the outgoing recommendations for this product which belong to the specified catalog. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Product#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this product which belong to the\nspecified catalog. The recommendations are sorted by their explicitly set\norder.", + "heading": "Description" + } + ], + "signature": "getAllRecommendations(catalog: Catalog): Collection", + "source": "script-api", + "tags": [ + "getallrecommendations", + "product.getallrecommendations" + ], + "title": "Product.getAllRecommendations" + }, + { + "description": "Returns the outgoing recommendations for this product which are of the specified type and which belong to the specified catalog. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Product#getAllRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAllRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this product which are of the\nspecified type and which belong to the specified catalog.\nThe recommendations are sorted by their explicitly set order.", + "heading": "Description" + } + ], + "signature": "getAllRecommendations(catalog: Catalog, type: number): Collection", + "source": "script-api", + "tags": [ + "getallrecommendations", + "product.getallrecommendations" + ], + "title": "Product.getAllRecommendations" + }, + { + "description": "Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient. The model is calculated based on the product attributes assigned to this product's classification category (or any of it's ancestors) and the global attribute definitions for the system object type 'Product'. If this product has no classification category, the attribute model is calculated on the global attribute definitions only. If this product is a variant, then the attribute model is calculated based on the classification category of its corresponding master product.", + "id": "script-api:dw/catalog/Product#getAttributeModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAttributeModel", + "returns": { + "type": "ProductAttributeModel" + }, + "sections": [ + { + "body": "Returns this product's ProductAttributeModel, which makes access to the\nproduct attribute information convenient. The model is calculated based\non the product attributes assigned to this product's classification\ncategory (or any of it's ancestors) and the global attribute definitions\nfor the system object type 'Product'. If this product has no\nclassification category, the attribute model is calculated on the global\nattribute definitions only. If this product is a variant, then the\nattribute model is calculated based on the classification category of its\ncorresponding master product.", + "heading": "Description" + } + ], + "signature": "getAttributeModel(): ProductAttributeModel", + "source": "script-api", + "tags": [ + "getattributemodel", + "product.getattributemodel" + ], + "title": "Product.getAttributeModel" + }, + { + "description": "Returns the availability model, which can be used to determine availability information for a product.", + "id": "script-api:dw/catalog/Product#getAvailabilityModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailabilityModel", + "returns": { + "type": "ProductAvailabilityModel" + }, + "sections": [ + { + "body": "Returns the availability model, which can be used to determine availability\ninformation for a product.", + "heading": "Description" + } + ], + "signature": "getAvailabilityModel(): ProductAvailabilityModel", + "source": "script-api", + "tags": [ + "getavailabilitymodel", + "product.getavailabilitymodel" + ], + "title": "Product.getAvailabilityModel" + }, + { + "description": "Returns the availability model of the given inventory list, which can be used to determine availability information for a product.", + "id": "script-api:dw/catalog/Product#getAvailabilityModel", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "list", + "type": "ProductInventoryList | null" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailabilityModel", + "returns": { + "type": "ProductAvailabilityModel" + }, + "sections": [ + { + "body": "Returns the availability model of the given inventory list, which can be\nused to determine availability information for a product.", + "heading": "Description" + } + ], + "signature": "getAvailabilityModel(list: ProductInventoryList | null): ProductAvailabilityModel", + "source": "script-api", + "tags": [ + "getavailabilitymodel", + "product.getavailabilitymodel" + ], + "title": "Product.getAvailabilityModel" + }, + { + "deprecated": { + "message": "Use getAvailabilityModel instead." + }, + "description": "Identifies if the product is available.", + "id": "script-api:dw/catalog/Product#getAvailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getAvailableFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product is available.", + "heading": "Description" + } + ], + "signature": "getAvailableFlag(): boolean", + "source": "script-api", + "tags": [ + "getavailableflag", + "product.getavailableflag" + ], + "title": "Product.getAvailableFlag" + }, + { + "description": "Returns the Brand of the product.", + "id": "script-api:dw/catalog/Product#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBrand", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Brand of the product.", + "heading": "Description" + } + ], + "signature": "getBrand(): string", + "source": "script-api", + "tags": [ + "getbrand", + "product.getbrand" + ], + "title": "Product.getBrand" + }, + { + "description": "Returns the quantity of the specified product within the bundle. If the specified product is not part of the bundle, a 0 quantity is returned.", + "id": "script-api:dw/catalog/Product#getBundledProductQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "aProduct", + "type": "Product" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundledProductQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of the specified product within the bundle. If the\nspecified product is not part of the bundle, a 0 quantity is returned.", + "heading": "Description" + } + ], + "signature": "getBundledProductQuantity(aProduct: Product): Quantity", + "source": "script-api", + "tags": [ + "getbundledproductquantity", + "product.getbundledproductquantity" + ], + "title": "Product.getBundledProductQuantity" + }, + { + "description": "Returns a collection containing all products that participate in the product bundle.", + "id": "script-api:dw/catalog/Product#getBundledProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundledProducts", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a collection containing all products that participate in the\nproduct bundle.", + "heading": "Description" + } + ], + "signature": "getBundledProducts(): Collection>", + "source": "script-api", + "tags": [ + "getbundledproducts", + "product.getbundledproducts" + ], + "title": "Product.getBundledProducts" + }, + { + "description": "Returns a collection of all bundles in which this product is included. The method only returns bundles assigned to the current site.", + "id": "script-api:dw/catalog/Product#getBundles", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getBundles", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a collection of all bundles in which this product is included.\nThe method only returns bundles assigned to the current site.", + "heading": "Description" + } + ], + "signature": "getBundles(): Collection>", + "source": "script-api", + "tags": [ + "getbundles", + "product.getbundles" + ], + "title": "Product.getBundles" + }, + { + "description": "Returns a collection of all categories to which this product is assigned and which are also available through the current site.", + "id": "script-api:dw/catalog/Product#getCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategories", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all categories to which this product is assigned\nand which are also available through the current site.", + "heading": "Description" + } + ], + "signature": "getCategories(): Collection", + "source": "script-api", + "tags": [ + "getcategories", + "product.getcategories" + ], + "title": "Product.getCategories" + }, + { + "description": "Returns the category assignment for a specific category.", + "id": "script-api:dw/catalog/Product#getCategoryAssignment", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "category", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategoryAssignment", + "returns": { + "type": "CategoryAssignment" + }, + "sections": [ + { + "body": "Returns the category assignment for a specific category.", + "heading": "Description" + } + ], + "signature": "getCategoryAssignment(category: Category): CategoryAssignment", + "source": "script-api", + "tags": [ + "getcategoryassignment", + "product.getcategoryassignment" + ], + "title": "Product.getCategoryAssignment" + }, + { + "description": "Returns a collection of category assignments for this product in the current site catalog.", + "id": "script-api:dw/catalog/Product#getCategoryAssignments", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getCategoryAssignments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of category assignments for this product in\nthe current site catalog.", + "heading": "Description" + } + ], + "signature": "getCategoryAssignments(): Collection", + "source": "script-api", + "tags": [ + "getcategoryassignments", + "product.getcategoryassignments" + ], + "title": "Product.getCategoryAssignments" + }, + { + "description": "Returns the classification category associated with this Product. A product has a single classification category which may or may not be in the site catalog. The classification category defines the attribute set of the product. See dw.catalog.Product.getAttributeModel for how the classification category is used.", + "id": "script-api:dw/catalog/Product#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getClassificationCategory", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the classification category associated with this Product. A\nproduct has a single classification category which may or may not be in\nthe site catalog. The classification category defines the attribute set\nof the product. See dw.catalog.Product.getAttributeModel for\nhow the classification category is used.", + "heading": "Description" + } + ], + "signature": "getClassificationCategory(): Category | null", + "source": "script-api", + "tags": [ + "getclassificationcategory", + "product.getclassificationcategory" + ], + "title": "Product.getClassificationCategory" + }, + { + "description": "Returns the European Article Number of the product.", + "id": "script-api:dw/catalog/Product#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getEAN", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the European Article Number of the product.", + "heading": "Description" + } + ], + "signature": "getEAN(): string", + "source": "script-api", + "tags": [ + "getean", + "product.getean" + ], + "title": "Product.getEAN" + }, + { + "description": "Returns the ID of the product.", + "id": "script-api:dw/catalog/Product#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "product.getid" + ], + "title": "Product.getID" + }, + { + "deprecated": { + "message": "Commerce Cloud Digital introduces a new more powerful product\nimage management. It allows to group product images by self-defined view types\n(e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute\ncolor 'red', 'blue'). Images can be annotated with pattern based title and\nalt. Product images can be accessed from Digital locations or external storage\nlocations.\n\nPlease use the new product image management. Therefore you have to set\nup the common product image settings like view types, image location,\ndefault image alt and title for your catalogs first. After that you can\ngroup your product images by the previously defined view types in context\nof a product. Finally use getImages and\ngetImage to access your images." + }, + "description": "Returns the product's image.", + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the product's image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "product.getimage" + ], + "title": "Product.getImage" + }, + { + "description": "The method calls getImages and returns the image at the specific index. If no image for specified index is available the method returns null.", + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method calls getImages and returns the image at\nthe specific index. If no image for specified index is available the\nmethod returns null.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string, index: number): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "product.getimage" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "Product.getImage" + }, + { + "description": "The method calls getImages and returns the first image. If no image is available the method returns null.", + "id": "script-api:dw/catalog/Product#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method calls getImages and returns the first image.\nIf no image is available the method returns null.\n\nWhen called for a variant with defined images for specified view type the\nmethod returns the first image.\n\nWhen called for a variant without defined images for specified view type\nthe method returns the first master product image. If no master product\nimages are defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "product.getimage" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "Product.getImage" + }, + { + "description": "Returns all images assigned to this product for a specific view type, e.g. all 'thumbnail' images. The images are returned in the order of their index number ascending.", + "id": "script-api:dw/catalog/Product#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getImages", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all images assigned to this product for a specific view type,\ne.g. all 'thumbnail' images. The images are returned in the order of\ntheir index number ascending.\n\nWhen called for a master the method returns the images specific to the\nmaster, which are typically the fall back images.", + "heading": "Description" + } + ], + "signature": "getImages(viewtype: string): List", + "source": "script-api", + "tags": [ + "getimages", + "product.getimages" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "Product.getImages" + }, + { + "description": "Returns incoming ProductLinks, where the source product is a site product.", + "id": "script-api:dw/catalog/Product#getIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getIncomingProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns incoming ProductLinks, where the source product is a site product.", + "heading": "Description" + } + ], + "signature": "getIncomingProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getincomingproductlinks", + "product.getincomingproductlinks" + ], + "title": "Product.getIncomingProductLinks" + }, + { + "description": "Returns incoming ProductLinks, where the source product is a site product of a specific type.", + "id": "script-api:dw/catalog/Product#getIncomingProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getIncomingProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns incoming ProductLinks, where the source product is a site product\nof a specific type.", + "heading": "Description" + } + ], + "signature": "getIncomingProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getincomingproductlinks", + "product.getincomingproductlinks" + ], + "title": "Product.getIncomingProductLinks" + }, + { + "description": "Returns the product's long description in the current locale.", + "id": "script-api:dw/catalog/Product#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getLongDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the product's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "getLongDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getlongdescription", + "product.getlongdescription" + ], + "title": "Product.getLongDescription" + }, + { + "description": "Returns the name of the product manufacturer.", + "id": "script-api:dw/catalog/Product#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getManufacturerName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the product manufacturer.", + "heading": "Description" + } + ], + "signature": "getManufacturerName(): string", + "source": "script-api", + "tags": [ + "getmanufacturername", + "product.getmanufacturername" + ], + "title": "Product.getManufacturerName" + }, + { + "description": "Returns the value of the manufacturer's stock keeping unit.", + "id": "script-api:dw/catalog/Product#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getManufacturerSKU", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the value of the manufacturer's stock keeping unit.", + "heading": "Description" + } + ], + "signature": "getManufacturerSKU(): string", + "source": "script-api", + "tags": [ + "getmanufacturersku", + "product.getmanufacturersku" + ], + "title": "Product.getManufacturerSKU" + }, + { + "description": "Returns the minimum order quantity for this product.", + "id": "script-api:dw/catalog/Product#getMinOrderQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getMinOrderQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the minimum order quantity for this product.", + "heading": "Description" + } + ], + "signature": "getMinOrderQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getminorderquantity", + "product.getminorderquantity" + ], + "title": "Product.getMinOrderQuantity" + }, + { + "description": "Returns the name of the product in the current locale.", + "id": "script-api:dw/catalog/Product#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the name of the product in the current locale.", + "heading": "Description" + } + ], + "signature": "getName(): string | null", + "source": "script-api", + "tags": [ + "getname", + "product.getname" + ], + "title": "Product.getName" + }, + { + "description": "Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Product#getOnlineCategories", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineCategories", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all currently online categories to which this\nproduct is assigned and which are also available through the current\nsite. A category is currently online if its online flag equals true and\nthe current site date is within the date range defined by the onlineFrom\nand onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "getOnlineCategories(): Collection", + "source": "script-api", + "tags": [ + "getonlinecategories", + "product.getonlinecategories" + ], + "title": "Product.getOnlineCategories" + }, + { + "description": "Returns the online status flag of the product.", + "id": "script-api:dw/catalog/Product#getOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status flag of the product.", + "heading": "Description" + } + ], + "signature": "getOnlineFlag(): boolean", + "source": "script-api", + "tags": [ + "getonlineflag", + "product.getonlineflag" + ], + "title": "Product.getOnlineFlag" + }, + { + "description": "Returns the date from which the product is online or valid.", + "id": "script-api:dw/catalog/Product#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineFrom", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date from which the product is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date", + "source": "script-api", + "tags": [ + "getonlinefrom", + "product.getonlinefrom" + ], + "title": "Product.getOnlineFrom" + }, + { + "description": "Returns the date until which the product is online or valid.", + "id": "script-api:dw/catalog/Product#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOnlineTo", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date until which the product is online or valid.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date", + "source": "script-api", + "tags": [ + "getonlineto", + "product.getonlineto" + ], + "title": "Product.getOnlineTo" + }, + { + "description": "Returns the product's option model. The option values selections are initialized with the values defined for the product, or the default values defined for the option.", + "id": "script-api:dw/catalog/Product#getOptionModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOptionModel", + "returns": { + "type": "ProductOptionModel" + }, + "sections": [ + { + "body": "Returns the product's option model. The option values selections are\ninitialized with the values defined for the product, or the default values\ndefined for the option.", + "heading": "Description" + } + ], + "signature": "getOptionModel(): ProductOptionModel", + "source": "script-api", + "tags": [ + "getoptionmodel", + "product.getoptionmodel" + ], + "title": "Product.getOptionModel" + }, + { + "description": "Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Product#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOrderableRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this product. This method\nbehaves similarly to getRecommendations but additionally filters out\nrecommendations for which the target product is unorderable according to\nits product availability model.", + "heading": "Description" + } + ], + "signature": "getOrderableRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getorderablerecommendations", + "product.getorderablerecommendations" + ], + "title": "Product.getOrderableRecommendations" + }, + { + "description": "Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Product#getOrderableRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getOrderableRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this product. This method\nbehaves similarly to getRecommendations but additionally\nfilters out recommendations for which the target product is unorderable\naccording to its product availability model.", + "heading": "Description" + } + ], + "signature": "getOrderableRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getorderablerecommendations", + "product.getorderablerecommendations" + ], + "title": "Product.getOrderableRecommendations" + }, + { + "description": "Returns product's page description in the default locale.", + "id": "script-api:dw/catalog/Product#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns product's page description in the default locale.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string | null", + "source": "script-api", + "tags": [ + "getpagedescription", + "product.getpagedescription" + ], + "title": "Product.getPageDescription" + }, + { + "description": "Returns the product's page keywords in the default locale.", + "id": "script-api:dw/catalog/Product#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageKeywords", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the product's page keywords in the default locale.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string | null", + "source": "script-api", + "tags": [ + "getpagekeywords", + "product.getpagekeywords" + ], + "title": "Product.getPageKeywords" + }, + { + "description": "Returns the page meta tag for the specified id.", + "id": "script-api:dw/catalog/Product#getPageMetaTag", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageMetaTag", + "returns": { + "type": "PageMetaTag | null" + }, + "sections": [ + { + "body": "Returns the page meta tag for the specified id.\n\nThe meta tag content is generated based on the product detail page meta tag context and rule. The rule is\nobtained from the current product context or inherited from variation groups, master product, the primary\ncategory, up to the root category.\n\nNull will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the\ncurrent context, or if the rule resolves to an empty string.", + "heading": "Description" + } + ], + "signature": "getPageMetaTag(id: string): PageMetaTag | null", + "source": "script-api", + "tags": [ + "getpagemetatag", + "product.getpagemetatag" + ], + "title": "Product.getPageMetaTag" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/catalog/Product#getPageMetaTags", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageMetaTags", + "returns": { + "type": "Array" + }, + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the product detail page meta tag context and rules. The rules are\nobtained from the current product context or inherited from variation groups, master product, the primary\ncategory, up to the root category.", + "heading": "Description" + } + ], + "signature": "getPageMetaTags(): Array", + "source": "script-api", + "tags": [ + "getpagemetatags", + "product.getpagemetatags" + ], + "title": "Product.getPageMetaTags" + }, + { + "description": "Returns the product's page title in the default locale.", + "id": "script-api:dw/catalog/Product#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageTitle", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the product's page title in the default locale.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string | null", + "source": "script-api", + "tags": [ + "getpagetitle", + "product.getpagetitle" + ], + "title": "Product.getPageTitle" + }, + { + "description": "Returns the product's page URL in the default locale.", + "id": "script-api:dw/catalog/Product#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPageURL", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the product's page URL in the default locale.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string | null", + "source": "script-api", + "tags": [ + "getpageurl", + "product.getpageurl" + ], + "title": "Product.getPageURL" + }, + { + "description": "Returns the price model, which can be used to retrieve a price for this product.", + "id": "script-api:dw/catalog/Product#getPriceModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPriceModel", + "returns": { + "type": "ProductPriceModel" + }, + "sections": [ + { + "body": "Returns the price model, which can be used to retrieve a price\nfor this product.", + "heading": "Description" + } + ], + "signature": "getPriceModel(): ProductPriceModel", + "source": "script-api", + "tags": [ + "getpricemodel", + "product.getpricemodel" + ], + "title": "Product.getPriceModel" + }, + { + "description": "Returns the price model based on the specified optionModel. The price model can be used to retrieve a price for this product. Prices are calculated based on the option values selected in the specified option model.", + "id": "script-api:dw/catalog/Product#getPriceModel", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "optionModel", + "type": "ProductOptionModel" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPriceModel", + "returns": { + "type": "ProductPriceModel" + }, + "sections": [ + { + "body": "Returns the price model based on the specified optionModel. The\nprice model can be used to retrieve a price\nfor this product. Prices are calculated based on the option values\nselected in the specified option model.", + "heading": "Description" + } + ], + "signature": "getPriceModel(optionModel: ProductOptionModel): ProductPriceModel", + "source": "script-api", + "tags": [ + "getpricemodel", + "product.getpricemodel" + ], + "title": "Product.getPriceModel" + }, + { + "description": "Returns the primary category of the product within the current site catalog.", + "id": "script-api:dw/catalog/Product#getPrimaryCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPrimaryCategory", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the primary category of the product within the current site catalog.", + "heading": "Description" + } + ], + "signature": "getPrimaryCategory(): Category | null", + "source": "script-api", + "tags": [ + "getprimarycategory", + "product.getprimarycategory" + ], + "title": "Product.getPrimaryCategory" + }, + { + "description": "Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.", + "id": "script-api:dw/catalog/Product#getPrimaryCategoryAssignment", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getPrimaryCategoryAssignment", + "returns": { + "type": "CategoryAssignment | null" + }, + "sections": [ + { + "body": "Returns the category assignment to the primary category in the current site\ncatalog or null if no primary category is defined within the current site\ncatalog.", + "heading": "Description" + } + ], + "signature": "getPrimaryCategoryAssignment(): CategoryAssignment | null", + "source": "script-api", + "tags": [ + "getprimarycategoryassignment", + "product.getprimarycategoryassignment" + ], + "title": "Product.getPrimaryCategoryAssignment" + }, + { + "description": "Returns all outgoing ProductLinks, where the target product is also available in the current site. The ProductLinks are unsorted.", + "id": "script-api:dw/catalog/Product#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing ProductLinks, where the target product is also\navailable in the current site. The ProductLinks are unsorted.", + "heading": "Description" + } + ], + "signature": "getProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "product.getproductlinks" + ], + "title": "Product.getProductLinks" + }, + { + "description": "Returns all outgoing ProductLinks of a specific type, where the target product is also available in the current site. The ProductLinks are sorted.", + "id": "script-api:dw/catalog/Product#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all outgoing ProductLinks of a specific type, where the target\nproduct is also available in the current site. The ProductLinks are\nsorted.", + "heading": "Description" + } + ], + "signature": "getProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "product.getproductlinks" + ], + "title": "Product.getProductLinks" + }, + { + "description": "Returns a collection of all products which are assigned to this product and which are also available through the current site. If this product does not represent a product set then an empty collection will be returned.", + "id": "script-api:dw/catalog/Product#getProductSetProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductSetProducts", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a collection of all products which are assigned to this product\nand which are also available through the current site. If this product\ndoes not represent a product set then an empty collection will be\nreturned.", + "heading": "Description" + } + ], + "signature": "getProductSetProducts(): Collection>", + "source": "script-api", + "tags": [ + "getproductsetproducts", + "product.getproductsetproducts" + ], + "title": "Product.getProductSetProducts" + }, + { + "description": "Returns a collection of all product sets in which this product is included. The method only returns product sets assigned to the current site.", + "id": "script-api:dw/catalog/Product#getProductSets", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getProductSets", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a collection of all product sets in which this product is included.\nThe method only returns product sets assigned to the current site.", + "heading": "Description" + } + ], + "signature": "getProductSets(): Collection>", + "source": "script-api", + "tags": [ + "getproductsets", + "product.getproductsets" + ], + "title": "Product.getProductSets" + }, + { + "description": "Returns the outgoing recommendations for this product which belong to the site catalog. If this product is not assigned to the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Product#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this product which\nbelong to the site catalog. If this product is not assigned to the site\ncatalog, or there is no site catalog, an empty collection is returned.\nOnly recommendations for which the target product exists and is assigned\nto the site catalog are returned. The recommendations are sorted by\ntheir explicitly set order.", + "heading": "Description" + } + ], + "signature": "getRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "product.getrecommendations" + ], + "title": "Product.getRecommendations" + }, + { + "description": "Returns the outgoing recommendations for this product which are of the specified type and which belong to the site catalog. Behaves the same as getRecommendations but additionally filters by recommendation type.", + "id": "script-api:dw/catalog/Product#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the outgoing recommendations for this product which are of the\nspecified type and which belong to the site catalog. Behaves the same as\ngetRecommendations but additionally filters by recommendation\ntype.", + "heading": "Description" + } + ], + "signature": "getRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "product.getrecommendations" + ], + "title": "Product.getRecommendations" + }, + { + "description": "Returns the product's search placement classification. The higher the numeric product placement value, the more relevant is the product when sorting search results. The range of numeric placement values is defined in the meta data of object type 'Product' and can therefore be customized.", + "id": "script-api:dw/catalog/Product#getSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchPlacement", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the product's search placement classification. The higher the\nnumeric product placement value, the more relevant is the product when\nsorting search results. The range of numeric placement values is\ndefined in the meta data of object type 'Product' and can therefore be\ncustomized.", + "heading": "Description" + } + ], + "signature": "getSearchPlacement(): number", + "source": "script-api", + "tags": [ + "getsearchplacement", + "product.getsearchplacement" + ], + "title": "Product.getSearchPlacement" + }, + { + "description": "Returns the product's search rank. The higher the numeric product rank, the more relevant is the product when sorting search results. The range of numeric rank values is defined in the meta data of object type 'Product' and can therefore be customized.", + "id": "script-api:dw/catalog/Product#getSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchRank", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the product's search rank. The higher the numeric product rank,\nthe more relevant is the product when sorting search results. The range of\nnumeric rank values is defined in the meta data of object type 'Product'\nand can therefore be customized.", + "heading": "Description" + } + ], + "signature": "getSearchRank(): number", + "source": "script-api", + "tags": [ + "getsearchrank", + "product.getsearchrank" + ], + "title": "Product.getSearchRank" + }, + { + "description": "Returns, whether the product is currently searchable.", + "id": "script-api:dw/catalog/Product#getSearchableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchableFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns, whether the product is currently searchable.", + "heading": "Description" + } + ], + "signature": "getSearchableFlag(): boolean", + "source": "script-api", + "tags": [ + "getsearchableflag", + "product.getsearchableflag" + ], + "title": "Product.getSearchableFlag" + }, + { + "description": "Returns the searchable status of the Product if unavailable.", + "id": "script-api:dw/catalog/Product#getSearchableIfUnavailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSearchableIfUnavailableFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the searchable status of the Product if unavailable.\n\nBesides `true` or `false`, the return value `null` indicates that the value is not set.", + "heading": "Description" + } + ], + "signature": "getSearchableIfUnavailableFlag(): boolean", + "source": "script-api", + "tags": [ + "getsearchableifunavailableflag", + "product.getsearchableifunavailableflag" + ], + "title": "Product.getSearchableIfUnavailableFlag" + }, + { + "description": "Returns the product's short description in the current locale.", + "id": "script-api:dw/catalog/Product#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getShortDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the product's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "getShortDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getshortdescription", + "product.getshortdescription" + ], + "title": "Product.getShortDescription" + }, + { + "description": "Returns the product's change frequency needed for the sitemap creation.", + "id": "script-api:dw/catalog/Product#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapChangeFrequency", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product's change frequency needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "getSiteMapChangeFrequency(): string", + "source": "script-api", + "tags": [ + "getsitemapchangefrequency", + "product.getsitemapchangefrequency" + ], + "title": "Product.getSiteMapChangeFrequency" + }, + { + "description": "Returns the status if the product is included into the sitemap.", + "id": "script-api:dw/catalog/Product#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapIncluded", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status if the product is included into the sitemap.", + "heading": "Description" + } + ], + "signature": "getSiteMapIncluded(): number", + "source": "script-api", + "tags": [ + "getsitemapincluded", + "product.getsitemapincluded" + ], + "title": "Product.getSiteMapIncluded" + }, + { + "description": "Returns the product's priority needed for the sitemap creation.", + "id": "script-api:dw/catalog/Product#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getSiteMapPriority", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the product's priority needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "getSiteMapPriority(): number", + "source": "script-api", + "tags": [ + "getsitemappriority", + "product.getsitemappriority" + ], + "title": "Product.getSiteMapPriority" + }, + { + "description": "Returns the steps in which the order amount of the product can be increased.", + "id": "script-api:dw/catalog/Product#getStepQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStepQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the steps in which the order amount of the product can be\nincreased.", + "heading": "Description" + } + ], + "signature": "getStepQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getstepquantity", + "product.getstepquantity" + ], + "title": "Product.getStepQuantity" + }, + { + "description": "Returns the store receipt name of the product in the current locale.", + "id": "script-api:dw/catalog/Product#getStoreReceiptName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStoreReceiptName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the store receipt name of the product in the current locale.", + "heading": "Description" + } + ], + "signature": "getStoreReceiptName(): string | null", + "source": "script-api", + "tags": [ + "getstorereceiptname", + "product.getstorereceiptname" + ], + "title": "Product.getStoreReceiptName" + }, + { + "description": "Returns the store tax class ID.", + "id": "script-api:dw/catalog/Product#getStoreTaxClass", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getStoreTaxClass", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the store tax class ID.\n\nThis is an optional override for in-store tax calculation.", + "heading": "Description" + } + ], + "signature": "getStoreTaxClass(): string", + "source": "script-api", + "tags": [ + "getstoretaxclass", + "product.getstoretaxclass" + ], + "title": "Product.getStoreTaxClass" + }, + { + "description": "Returns the ID of the product's tax class, by resolving the Global Preference setting selected. If the Localized Tax Class setting under Global Preferences -> Products is selected, the localizedTaxClassID attribute value will be returned, else the legacy taxClassID attribute value will be returned.", + "id": "script-api:dw/catalog/Product#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product's tax class, by resolving\nthe Global Preference setting selected. If the Localized\nTax Class setting under Global Preferences -> Products is\nselected, the localizedTaxClassID attribute value will be\nreturned, else the legacy taxClassID attribute value will\nbe returned.", + "heading": "Description" + } + ], + "signature": "getTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxclassid", + "product.gettaxclassid" + ], + "title": "Product.getTaxClassID" + }, + { + "description": "Returns the name of the product's rendering template.", + "id": "script-api:dw/catalog/Product#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the product's rendering template.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "product.gettemplate" + ], + "title": "Product.getTemplate" + }, + { + "deprecated": { + "message": "Commerce Cloud Digital introduces a new more powerful product\nimage management. It allows to group product images by self-defined view types\n(e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute\ncolor 'red', 'blue'). Images can be annotated with pattern based title and\nalt. Product images can be accessed from Digital locations or external storage\nlocations.\n\nPlease use the new product image management. Therefore you have to set\nup the common product image settings like view types, image location,\ndefault image alt and title for your catalogs first. After that you can\ngroup your product images by the previously defined view types in context\nof a product. Finally use getImages and\ngetImage to access your images." + }, + "description": "Returns the product's thumbnail image.", + "id": "script-api:dw/catalog/Product#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getThumbnail", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the product's thumbnail image.", + "heading": "Description" + } + ], + "signature": "getThumbnail(): MediaFile", + "source": "script-api", + "tags": [ + "getthumbnail", + "product.getthumbnail" + ], + "title": "Product.getThumbnail" + }, + { + "description": "Returns the Universal Product Code of the product.", + "id": "script-api:dw/catalog/Product#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUPC", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Universal Product Code of the product.", + "heading": "Description" + } + ], + "signature": "getUPC(): string", + "source": "script-api", + "tags": [ + "getupc", + "product.getupc" + ], + "title": "Product.getUPC" + }, + { + "description": "Returns the product's sales unit.", + "id": "script-api:dw/catalog/Product#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUnit", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product's sales unit.", + "heading": "Description" + } + ], + "signature": "getUnit(): string", + "source": "script-api", + "tags": [ + "getunit", + "product.getunit" + ], + "title": "Product.getUnit" + }, + { + "description": "Returns the product's unit quantity.", + "id": "script-api:dw/catalog/Product#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getUnitQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the product's unit quantity.", + "heading": "Description" + } + ], + "signature": "getUnitQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getunitquantity", + "product.getunitquantity" + ], + "title": "Product.getUnitQuantity" + }, + { + "description": "Returns a collection of all variants assigned to this variation master or variation group product. All variants are returned regardless of whether they are online or offline.", + "id": "script-api:dw/catalog/Product#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariants", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all variants assigned to this variation master\nor variation group product. All variants are returned regardless of whether\nthey are online or offline.\n\nIf this product does not represent a variation master or variation group\nproduct then an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "getVariants(): Collection", + "source": "script-api", + "tags": [ + "getvariants", + "product.getvariants" + ], + "title": "Product.getVariants" + }, + { + "description": "Returns a collection of all variation groups assigned to this variation master product. All variation groups are returned regardless of whether they are online or offline.", + "id": "script-api:dw/catalog/Product#getVariationGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariationGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all variation groups assigned to this variation\nmaster product. All variation groups are returned regardless of whether\nthey are online or offline.\n\nIf this product does not represent a variation master product then an\nempty collection is returned.", + "heading": "Description" + } + ], + "signature": "getVariationGroups(): Collection", + "source": "script-api", + "tags": [ + "getvariationgroups", + "product.getvariationgroups" + ], + "title": "Product.getVariationGroups" + }, + { + "description": "Returns the variation model of this product. If this product is a master product, then the returned model will encapsulate all the information about its variation attributes and variants. If this product is a variant product, then the returned model will encapsulate all the same information, but additionally pre-select all the variation attribute values of this variant. (See dw.catalog.ProductVariationModel for details on what \"selected\" means.) If this product is neither a master product or a variation product, then a model will be returned but will be essentially empty and not useful for any particular purpose.", + "id": "script-api:dw/catalog/Product#getVariationModel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.getVariationModel", + "returns": { + "type": "ProductVariationModel" + }, + "sections": [ + { + "body": "Returns the variation model of this product. If this product is a master\nproduct, then the returned model will encapsulate all the information\nabout its variation attributes and variants. If this product is a variant\nproduct, then the returned model will encapsulate all the same\ninformation, but additionally pre-select all the variation attribute\nvalues of this variant. (See dw.catalog.ProductVariationModel for\ndetails on what \"selected\" means.) If this product is neither a master\nproduct or a variation product, then a model will be returned but will be\nessentially empty and not useful for any particular purpose.", + "heading": "Description" + } + ], + "signature": "getVariationModel(): ProductVariationModel", + "source": "script-api", + "tags": [ + "getvariationmodel", + "product.getvariationmodel" + ], + "title": "Product.getVariationModel" + }, + { + "deprecated": { + "message": "Commerce Cloud Digital introduces a new more powerful product\nimage management. It allows to group product images by self-defined view types\n(e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute\ncolor 'red', 'blue'). Images can be annotated with pattern based title and\nalt. Product images can be accessed from Digital locations or external storage\nlocations.\n\nPlease use the new product image management. Therefore you have to set\nup the common product image settings like view types, image location,\ndefault image alt and title for your catalogs first. After that you can\ngroup your product images by the previously defined view types in context\nof a product. Finally use getImages and\ngetImage to access your images." + }, + "description": "Returns the product's image.", + "id": "script-api:dw/catalog/Product#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.image", + "sections": [ + { + "body": "Returns the product's image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "product.image" + ], + "title": "Product.image" + }, + { + "description": "Identifies if the specified product participates in this product bundle. If this product does not represent a bundle at all, then false will always be returned.", + "id": "script-api:dw/catalog/Product#includedInBundle", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.includedInBundle", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the specified product participates in this product bundle.\nIf this product does not represent a bundle at all, then false will\nalways be returned.", + "heading": "Description" + } + ], + "signature": "includedInBundle(product: Product): boolean", + "source": "script-api", + "tags": [ + "includedinbundle", + "product.includedinbundle" + ], + "title": "Product.includedInBundle" + }, + { + "description": "Returns incoming ProductLinks, where the source product is a site product.", + "id": "script-api:dw/catalog/Product#incomingProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.incomingProductLinks", + "sections": [ + { + "body": "Returns incoming ProductLinks, where the source product is a site product.", + "heading": "Description" + } + ], + "signature": "readonly incomingProductLinks: Collection", + "source": "script-api", + "tags": [ + "incomingproductlinks", + "product.incomingproductlinks" + ], + "title": "Product.incomingProductLinks" + }, + { + "description": "Returns 'true' if item is assigned to the specified category.", + "id": "script-api:dw/catalog/Product#isAssignedToCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "category", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAssignedToCategory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if item is assigned to the specified\ncategory.", + "heading": "Description" + } + ], + "signature": "isAssignedToCategory(category: Category): boolean", + "source": "script-api", + "tags": [ + "isassignedtocategory", + "product.isassignedtocategory" + ], + "title": "Product.isAssignedToCategory" + }, + { + "description": "Returns `true` if the product is assigned to the current site (via the site catalog), otherwise `false` is returned.", + "id": "script-api:dw/catalog/Product#isAssignedToSiteCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAssignedToSiteCatalog", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the product is assigned to the current site (via the site catalog), otherwise\n`false` is returned.\n\nIn case of the product being a variant, the variant will be considered as assigned if its master, one of the\nvariation groups it is in or itself is assigned to the site catalog. In case this is triggered for a variation\ngroup the variation group is considered as assigned if its master or itself is assigned.", + "heading": "Description" + } + ], + "signature": "isAssignedToSiteCatalog(): boolean", + "source": "script-api", + "tags": [ + "isassignedtositecatalog", + "product.isassignedtositecatalog" + ], + "title": "Product.isAssignedToSiteCatalog" + }, + { + "deprecated": { + "message": "Use getAvailabilityModel.isInStock() instead" + }, + "description": "Identifies if the product is available.", + "id": "script-api:dw/catalog/Product#isAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isAvailable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product is available.", + "heading": "Description" + } + ], + "signature": "isAvailable(): boolean", + "source": "script-api", + "tags": [ + "isavailable", + "product.isavailable" + ], + "title": "Product.isAvailable" + }, + { + "description": "Identifies if this product instance is a product bundle.", + "id": "script-api:dw/catalog/Product#isBundle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isBundle", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is a product bundle.", + "heading": "Description" + } + ], + "signature": "isBundle(): boolean", + "source": "script-api", + "tags": [ + "isbundle", + "product.isbundle" + ], + "title": "Product.isBundle" + }, + { + "description": "Identifies if this product instance is bundled within at least one product bundle.", + "id": "script-api:dw/catalog/Product#isBundled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isBundled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is bundled within at least one\nproduct bundle.", + "heading": "Description" + } + ], + "signature": "isBundled(): boolean", + "source": "script-api", + "tags": [ + "isbundled", + "product.isbundled" + ], + "title": "Product.isBundled" + }, + { + "description": "Identifies if this product is bound to at least one catalog category.", + "id": "script-api:dw/catalog/Product#isCategorized", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isCategorized", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product is bound to at least one catalog category.", + "heading": "Description" + } + ], + "signature": "isCategorized(): boolean", + "source": "script-api", + "tags": [ + "iscategorized", + "product.iscategorized" + ], + "title": "Product.isCategorized" + }, + { + "description": "Identifies if the product is Facebook enabled.", + "id": "script-api:dw/catalog/Product#isFacebookEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isFacebookEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product is Facebook enabled.", + "heading": "Description" + } + ], + "signature": "isFacebookEnabled(): boolean", + "source": "script-api", + "tags": [ + "isfacebookenabled", + "product.isfacebookenabled" + ], + "title": "Product.isFacebookEnabled" + }, + { + "description": "Identifies if this product instance is a product master.", + "id": "script-api:dw/catalog/Product#isMaster", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isMaster", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is a product master.", + "heading": "Description" + } + ], + "signature": "isMaster(): boolean", + "source": "script-api", + "tags": [ + "ismaster", + "product.ismaster" + ], + "title": "Product.isMaster" + }, + { + "description": "Returns the online status of the product. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the product.", + "id": "script-api:dw/catalog/Product#isOnline", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status of the product. The online status\nis calculated from the online status flag and the onlineFrom\nonlineTo dates defined for the product.", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "product.isonline" + ], + "title": "Product.isOnline" + }, + { + "description": "Identifies if the product has options.", + "id": "script-api:dw/catalog/Product#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isOptionProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product has options.", + "heading": "Description" + } + ], + "signature": "isOptionProduct(): boolean", + "source": "script-api", + "tags": [ + "isoptionproduct", + "product.isoptionproduct" + ], + "title": "Product.isOptionProduct" + }, + { + "description": "Identifies if the product is Pinterest enabled.", + "id": "script-api:dw/catalog/Product#isPinterestEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isPinterestEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product is Pinterest enabled.", + "heading": "Description" + } + ], + "signature": "isPinterestEnabled(): boolean", + "source": "script-api", + "tags": [ + "ispinterestenabled", + "product.ispinterestenabled" + ], + "title": "Product.isPinterestEnabled" + }, + { + "description": "Returns 'true' if the instance represents a product. Returns 'false' if the instance represents a product set.", + "id": "script-api:dw/catalog/Product#isProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the instance represents a product. Returns 'false' if\nthe instance represents a product set.", + "heading": "Description" + } + ], + "signature": "isProduct(): boolean", + "source": "script-api", + "tags": [ + "isproduct", + "product.isproduct" + ], + "title": "Product.isProduct" + }, + { + "description": "Returns 'true' if the instance represents a product set, otherwise 'false'.", + "id": "script-api:dw/catalog/Product#isProductSet", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProductSet", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the instance represents a product set, otherwise 'false'.", + "heading": "Description" + } + ], + "signature": "isProductSet(): boolean", + "source": "script-api", + "tags": [ + "isproductset", + "product.isproductset" + ], + "title": "Product.isProductSet" + }, + { + "description": "Returns true if this product is part of any product set, otherwise false.", + "id": "script-api:dw/catalog/Product#isProductSetProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isProductSetProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this product is part of any product set, otherwise false.", + "heading": "Description" + } + ], + "signature": "isProductSetProduct(): boolean", + "source": "script-api", + "tags": [ + "isproductsetproduct", + "product.isproductsetproduct" + ], + "title": "Product.isProductSetProduct" + }, + { + "deprecated": { + "message": "Use isProductSet instead" + }, + "description": "Identifies if this product instance is part of a retail set.", + "id": "script-api:dw/catalog/Product#isRetailSet", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isRetailSet", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is part of a retail set.", + "heading": "Description" + } + ], + "signature": "isRetailSet(): boolean", + "source": "script-api", + "tags": [ + "isretailset", + "product.isretailset" + ], + "title": "Product.isRetailSet" + }, + { + "description": "Identifies if the product is searchable.", + "id": "script-api:dw/catalog/Product#isSearchable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isSearchable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product is searchable.", + "heading": "Description" + } + ], + "signature": "isSearchable(): boolean", + "source": "script-api", + "tags": [ + "issearchable", + "product.issearchable" + ], + "title": "Product.isSearchable" + }, + { + "deprecated": { + "message": "Use isAssignedToSiteCatalog instead" + }, + "description": "Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.", + "id": "script-api:dw/catalog/Product#isSiteProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isSiteProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the product is assigned to the current site (via the\nsite catalog), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "isSiteProduct(): boolean", + "source": "script-api", + "tags": [ + "issiteproduct", + "product.issiteproduct" + ], + "title": "Product.isSiteProduct" + }, + { + "description": "Identifies if this product instance is mastered by a product master.", + "id": "script-api:dw/catalog/Product#isVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isVariant", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is mastered by a product master.", + "heading": "Description" + } + ], + "signature": "isVariant(): boolean", + "source": "script-api", + "tags": [ + "isvariant", + "product.isvariant" + ], + "title": "Product.isVariant" + }, + { + "description": "Identifies if this product instance is a variation group product.", + "id": "script-api:dw/catalog/Product#isVariationGroup", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.isVariationGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this product instance is a variation group product.", + "heading": "Description" + } + ], + "signature": "isVariationGroup(): boolean", + "source": "script-api", + "tags": [ + "isvariationgroup", + "product.isvariationgroup" + ], + "title": "Product.isVariationGroup" + }, + { + "description": "Returns the product's long description in the current locale.", + "id": "script-api:dw/catalog/Product#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.longDescription", + "sections": [ + { + "body": "Returns the product's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly longDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "longdescription", + "product.longdescription" + ], + "title": "Product.longDescription" + }, + { + "description": "Returns the name of the product manufacturer.", + "id": "script-api:dw/catalog/Product#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.manufacturerName", + "sections": [ + { + "body": "Returns the name of the product manufacturer.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerName: string", + "source": "script-api", + "tags": [ + "manufacturername", + "product.manufacturername" + ], + "title": "Product.manufacturerName" + }, + { + "description": "Returns the value of the manufacturer's stock keeping unit.", + "id": "script-api:dw/catalog/Product#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.manufacturerSKU", + "sections": [ + { + "body": "Returns the value of the manufacturer's stock keeping unit.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerSKU: string", + "source": "script-api", + "tags": [ + "manufacturersku", + "product.manufacturersku" + ], + "title": "Product.manufacturerSKU" + }, + { + "description": "Identifies if this product instance is a product master.", + "id": "script-api:dw/catalog/Product#master", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.master", + "sections": [ + { + "body": "Identifies if this product instance is a product master.", + "heading": "Description" + } + ], + "signature": "readonly master: boolean", + "source": "script-api", + "tags": [ + "master", + "product.master" + ], + "title": "Product.master" + }, + { + "description": "Returns the minimum order quantity for this product.", + "id": "script-api:dw/catalog/Product#minOrderQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.minOrderQuantity", + "sections": [ + { + "body": "Returns the minimum order quantity for this product.", + "heading": "Description" + } + ], + "signature": "readonly minOrderQuantity: Quantity", + "source": "script-api", + "tags": [ + "minorderquantity", + "product.minorderquantity" + ], + "title": "Product.minOrderQuantity" + }, + { + "description": "Returns the name of the product in the current locale.", + "id": "script-api:dw/catalog/Product#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.name", + "sections": [ + { + "body": "Returns the name of the product in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly name: string | null", + "source": "script-api", + "tags": [ + "name", + "product.name" + ], + "title": "Product.name" + }, + { + "description": "Returns the online status of the product. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the product.", + "id": "script-api:dw/catalog/Product#online", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.online", + "sections": [ + { + "body": "Returns the online status of the product. The online status\nis calculated from the online status flag and the onlineFrom\nonlineTo dates defined for the product.", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "product.online" + ], + "title": "Product.online" + }, + { + "description": "Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.", + "id": "script-api:dw/catalog/Product#onlineCategories", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineCategories", + "sections": [ + { + "body": "Returns a collection of all currently online categories to which this\nproduct is assigned and which are also available through the current\nsite. A category is currently online if its online flag equals true and\nthe current site date is within the date range defined by the onlineFrom\nand onlineTo attributes.", + "heading": "Description" + } + ], + "signature": "readonly onlineCategories: Collection", + "source": "script-api", + "tags": [ + "onlinecategories", + "product.onlinecategories" + ], + "title": "Product.onlineCategories" + }, + { + "description": "Returns the online status flag of the product.", + "id": "script-api:dw/catalog/Product#onlineFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineFlag", + "sections": [ + { + "body": "Returns the online status flag of the product.", + "heading": "Description" + } + ], + "signature": "readonly onlineFlag: boolean", + "source": "script-api", + "tags": [ + "onlineflag", + "product.onlineflag" + ], + "title": "Product.onlineFlag" + }, + { + "description": "Returns the date from which the product is online or valid.", + "id": "script-api:dw/catalog/Product#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineFrom", + "sections": [ + { + "body": "Returns the date from which the product is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date", + "source": "script-api", + "tags": [ + "onlinefrom", + "product.onlinefrom" + ], + "title": "Product.onlineFrom" + }, + { + "description": "Returns the date until which the product is online or valid.", + "id": "script-api:dw/catalog/Product#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.onlineTo", + "sections": [ + { + "body": "Returns the date until which the product is online or valid.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date", + "source": "script-api", + "tags": [ + "onlineto", + "product.onlineto" + ], + "title": "Product.onlineTo" + }, + { + "description": "Returns the product's option model. The option values selections are initialized with the values defined for the product, or the default values defined for the option.", + "id": "script-api:dw/catalog/Product#optionModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.optionModel", + "sections": [ + { + "body": "Returns the product's option model. The option values selections are\ninitialized with the values defined for the product, or the default values\ndefined for the option.", + "heading": "Description" + } + ], + "signature": "readonly optionModel: ProductOptionModel", + "source": "script-api", + "tags": [ + "optionmodel", + "product.optionmodel" + ], + "title": "Product.optionModel" + }, + { + "description": "Identifies if the product has options.", + "id": "script-api:dw/catalog/Product#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.optionProduct", + "sections": [ + { + "body": "Identifies if the product has options.", + "heading": "Description" + } + ], + "signature": "readonly optionProduct: boolean", + "source": "script-api", + "tags": [ + "optionproduct", + "product.optionproduct" + ], + "title": "Product.optionProduct" + }, + { + "description": "Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations but additionally filters out recommendations for which the target product is unorderable according to its product availability model.", + "id": "script-api:dw/catalog/Product#orderableRecommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.orderableRecommendations", + "sections": [ + { + "body": "Returns a list of outgoing recommendations for this product. This method\nbehaves similarly to getRecommendations but additionally filters out\nrecommendations for which the target product is unorderable according to\nits product availability model.", + "heading": "Description" + } + ], + "signature": "readonly orderableRecommendations: Collection", + "source": "script-api", + "tags": [ + "orderablerecommendations", + "product.orderablerecommendations" + ], + "title": "Product.orderableRecommendations" + }, + { + "description": "Returns product's page description in the default locale.", + "id": "script-api:dw/catalog/Product#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageDescription", + "sections": [ + { + "body": "Returns product's page description in the default locale.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string | null", + "source": "script-api", + "tags": [ + "pagedescription", + "product.pagedescription" + ], + "title": "Product.pageDescription" + }, + { + "description": "Returns the product's page keywords in the default locale.", + "id": "script-api:dw/catalog/Product#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageKeywords", + "sections": [ + { + "body": "Returns the product's page keywords in the default locale.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string | null", + "source": "script-api", + "tags": [ + "pagekeywords", + "product.pagekeywords" + ], + "title": "Product.pageKeywords" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/catalog/Product#pageMetaTags", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageMetaTags", + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the product detail page meta tag context and rules. The rules are\nobtained from the current product context or inherited from variation groups, master product, the primary\ncategory, up to the root category.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaTags: Array", + "source": "script-api", + "tags": [ + "pagemetatags", + "product.pagemetatags" + ], + "title": "Product.pageMetaTags" + }, + { + "description": "Returns the product's page title in the default locale.", + "id": "script-api:dw/catalog/Product#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageTitle", + "sections": [ + { + "body": "Returns the product's page title in the default locale.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string | null", + "source": "script-api", + "tags": [ + "pagetitle", + "product.pagetitle" + ], + "title": "Product.pageTitle" + }, + { + "description": "Returns the product's page URL in the default locale.", + "id": "script-api:dw/catalog/Product#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pageURL", + "sections": [ + { + "body": "Returns the product's page URL in the default locale.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string | null", + "source": "script-api", + "tags": [ + "pageurl", + "product.pageurl" + ], + "title": "Product.pageURL" + }, + { + "description": "Identifies if the product is Pinterest enabled.", + "id": "script-api:dw/catalog/Product#pinterestEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.pinterestEnabled", + "sections": [ + { + "body": "Identifies if the product is Pinterest enabled.", + "heading": "Description" + } + ], + "signature": "readonly pinterestEnabled: boolean", + "source": "script-api", + "tags": [ + "pinterestenabled", + "product.pinterestenabled" + ], + "title": "Product.pinterestEnabled" + }, + { + "description": "Returns the price model, which can be used to retrieve a price for this product.", + "id": "script-api:dw/catalog/Product#priceModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.priceModel", + "sections": [ + { + "body": "Returns the price model, which can be used to retrieve a price\nfor this product.", + "heading": "Description" + } + ], + "signature": "readonly priceModel: ProductPriceModel", + "source": "script-api", + "tags": [ + "pricemodel", + "product.pricemodel" + ], + "title": "Product.priceModel" + }, + { + "description": "Returns the primary category of the product within the current site catalog.", + "id": "script-api:dw/catalog/Product#primaryCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.primaryCategory", + "sections": [ + { + "body": "Returns the primary category of the product within the current site catalog.", + "heading": "Description" + } + ], + "signature": "readonly primaryCategory: Category | null", + "source": "script-api", + "tags": [ + "primarycategory", + "product.primarycategory" + ], + "title": "Product.primaryCategory" + }, + { + "description": "Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.", + "id": "script-api:dw/catalog/Product#primaryCategoryAssignment", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.primaryCategoryAssignment", + "sections": [ + { + "body": "Returns the category assignment to the primary category in the current site\ncatalog or null if no primary category is defined within the current site\ncatalog.", + "heading": "Description" + } + ], + "signature": "readonly primaryCategoryAssignment: CategoryAssignment | null", + "source": "script-api", + "tags": [ + "primarycategoryassignment", + "product.primarycategoryassignment" + ], + "title": "Product.primaryCategoryAssignment" + }, + { + "description": "Returns 'true' if the instance represents a product. Returns 'false' if the instance represents a product set.", + "id": "script-api:dw/catalog/Product#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.product", + "sections": [ + { + "body": "Returns 'true' if the instance represents a product. Returns 'false' if\nthe instance represents a product set.", + "heading": "Description" + } + ], + "signature": "readonly product: boolean", + "source": "script-api", + "tags": [ + "product", + "product.product" + ], + "title": "Product.product" + }, + { + "description": "Returns all outgoing ProductLinks, where the target product is also available in the current site. The ProductLinks are unsorted.", + "id": "script-api:dw/catalog/Product#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productLinks", + "sections": [ + { + "body": "Returns all outgoing ProductLinks, where the target product is also\navailable in the current site. The ProductLinks are unsorted.", + "heading": "Description" + } + ], + "signature": "readonly productLinks: Collection", + "source": "script-api", + "tags": [ + "productlinks", + "product.productlinks" + ], + "title": "Product.productLinks" + }, + { + "description": "Returns 'true' if the instance represents a product set, otherwise 'false'.", + "id": "script-api:dw/catalog/Product#productSet", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSet", + "sections": [ + { + "body": "Returns 'true' if the instance represents a product set, otherwise 'false'.", + "heading": "Description" + } + ], + "signature": "readonly productSet: boolean", + "source": "script-api", + "tags": [ + "productset", + "product.productset" + ], + "title": "Product.productSet" + }, + { + "description": "Returns true if this product is part of any product set, otherwise false.", + "id": "script-api:dw/catalog/Product#productSetProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSetProduct", + "sections": [ + { + "body": "Returns true if this product is part of any product set, otherwise false.", + "heading": "Description" + } + ], + "signature": "readonly productSetProduct: boolean", + "source": "script-api", + "tags": [ + "productsetproduct", + "product.productsetproduct" + ], + "title": "Product.productSetProduct" + }, + { + "description": "Returns a collection of all products which are assigned to this product and which are also available through the current site. If this product does not represent a product set then an empty collection will be returned.", + "id": "script-api:dw/catalog/Product#productSetProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSetProducts", + "sections": [ + { + "body": "Returns a collection of all products which are assigned to this product\nand which are also available through the current site. If this product\ndoes not represent a product set then an empty collection will be\nreturned.", + "heading": "Description" + } + ], + "signature": "readonly productSetProducts: Collection>", + "source": "script-api", + "tags": [ + "productsetproducts", + "product.productsetproducts" + ], + "title": "Product.productSetProducts" + }, + { + "description": "Returns a collection of all product sets in which this product is included. The method only returns product sets assigned to the current site.", + "id": "script-api:dw/catalog/Product#productSets", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.productSets", + "sections": [ + { + "body": "Returns a collection of all product sets in which this product is included.\nThe method only returns product sets assigned to the current site.", + "heading": "Description" + } + ], + "signature": "readonly productSets: Collection>", + "source": "script-api", + "tags": [ + "productsets", + "product.productsets" + ], + "title": "Product.productSets" + }, + { + "description": "Returns the outgoing recommendations for this product which belong to the site catalog. If this product is not assigned to the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.", + "id": "script-api:dw/catalog/Product#recommendations", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.recommendations", + "sections": [ + { + "body": "Returns the outgoing recommendations for this product which\nbelong to the site catalog. If this product is not assigned to the site\ncatalog, or there is no site catalog, an empty collection is returned.\nOnly recommendations for which the target product exists and is assigned\nto the site catalog are returned. The recommendations are sorted by\ntheir explicitly set order.", + "heading": "Description" + } + ], + "signature": "readonly recommendations: Collection", + "source": "script-api", + "tags": [ + "recommendations", + "product.recommendations" + ], + "title": "Product.recommendations" + }, + { + "deprecated": { + "message": "Use isProductSet instead" + }, + "description": "Identifies if this product instance is part of a retail set.", + "id": "script-api:dw/catalog/Product#retailSet", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.retailSet", + "sections": [ + { + "body": "Identifies if this product instance is part of a retail set.", + "heading": "Description" + } + ], + "signature": "readonly retailSet: boolean", + "source": "script-api", + "tags": [ + "retailset", + "product.retailset" + ], + "title": "Product.retailSet" + }, + { + "description": "Returns the product's search placement classification. The higher the numeric product placement value, the more relevant is the product when sorting search results. The range of numeric placement values is defined in the meta data of object type 'Product' and can therefore be customized.", + "id": "script-api:dw/catalog/Product#searchPlacement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchPlacement", + "sections": [ + { + "body": "Returns the product's search placement classification. The higher the\nnumeric product placement value, the more relevant is the product when\nsorting search results. The range of numeric placement values is\ndefined in the meta data of object type 'Product' and can therefore be\ncustomized.", + "heading": "Description" + } + ], + "signature": "readonly searchPlacement: number", + "source": "script-api", + "tags": [ + "searchplacement", + "product.searchplacement" + ], + "title": "Product.searchPlacement" + }, + { + "description": "Returns the product's search rank. The higher the numeric product rank, the more relevant is the product when sorting search results. The range of numeric rank values is defined in the meta data of object type 'Product' and can therefore be customized.", + "id": "script-api:dw/catalog/Product#searchRank", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchRank", + "sections": [ + { + "body": "Returns the product's search rank. The higher the numeric product rank,\nthe more relevant is the product when sorting search results. The range of\nnumeric rank values is defined in the meta data of object type 'Product'\nand can therefore be customized.", + "heading": "Description" + } + ], + "signature": "readonly searchRank: number", + "source": "script-api", + "tags": [ + "searchrank", + "product.searchrank" + ], + "title": "Product.searchRank" + }, + { + "description": "Identifies if the product is searchable.", + "id": "script-api:dw/catalog/Product#searchable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchable", + "sections": [ + { + "body": "Identifies if the product is searchable.", + "heading": "Description" + } + ], + "signature": "readonly searchable: boolean", + "source": "script-api", + "tags": [ + "searchable", + "product.searchable" + ], + "title": "Product.searchable" + }, + { + "description": "Returns, whether the product is currently searchable.", + "id": "script-api:dw/catalog/Product#searchableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchableFlag", + "sections": [ + { + "body": "Returns, whether the product is currently searchable.", + "heading": "Description" + } + ], + "signature": "readonly searchableFlag: boolean", + "source": "script-api", + "tags": [ + "searchableflag", + "product.searchableflag" + ], + "title": "Product.searchableFlag" + }, + { + "description": "Returns the searchable status of the Product if unavailable.", + "id": "script-api:dw/catalog/Product#searchableIfUnavailableFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.searchableIfUnavailableFlag", + "sections": [ + { + "body": "Returns the searchable status of the Product if unavailable.\n\nBesides `true` or `false`, the return value `null` indicates that the value is not set.", + "heading": "Description" + } + ], + "signature": "readonly searchableIfUnavailableFlag: boolean", + "source": "script-api", + "tags": [ + "searchableifunavailableflag", + "product.searchableifunavailableflag" + ], + "title": "Product.searchableIfUnavailableFlag" + }, + { + "deprecated": { + "message": "Don't use this method anymore." + }, + "description": "Set the availability status flag of the product.", + "id": "script-api:dw/catalog/Product#setAvailableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "available", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setAvailableFlag", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the availability status flag of the product.", + "heading": "Description" + } + ], + "signature": "setAvailableFlag(available: boolean): void", + "source": "script-api", + "tags": [ + "setavailableflag", + "product.setavailableflag" + ], + "title": "Product.setAvailableFlag" + }, + { + "description": "Set the online status flag of the product.", + "id": "script-api:dw/catalog/Product#setOnlineFlag", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "online", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setOnlineFlag", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the online status flag of the product.", + "heading": "Description" + } + ], + "signature": "setOnlineFlag(online: boolean): void", + "source": "script-api", + "tags": [ + "setonlineflag", + "product.setonlineflag" + ], + "title": "Product.setOnlineFlag" + }, + { + "description": "Set the product's search placement.", + "id": "script-api:dw/catalog/Product#setSearchPlacement", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "placement", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchPlacement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the product's search placement.", + "heading": "Description" + } + ], + "signature": "setSearchPlacement(placement: number): void", + "source": "script-api", + "tags": [ + "setsearchplacement", + "product.setsearchplacement" + ], + "title": "Product.setSearchPlacement" + }, + { + "description": "Set the product's search rank.", + "id": "script-api:dw/catalog/Product#setSearchRank", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "rank", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchRank", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the product's search rank.", + "heading": "Description" + } + ], + "signature": "setSearchRank(rank: number): void", + "source": "script-api", + "tags": [ + "setsearchrank", + "product.setsearchrank" + ], + "title": "Product.setSearchRank" + }, + { + "description": "Set the flag indicating whether the product is searchable or not.", + "id": "script-api:dw/catalog/Product#setSearchableFlag", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "searchable", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.setSearchableFlag", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the flag indicating whether the product is searchable or not.", + "heading": "Description" + } + ], + "signature": "setSearchableFlag(searchable: boolean): void", + "source": "script-api", + "tags": [ + "setsearchableflag", + "product.setsearchableflag" + ], + "title": "Product.setSearchableFlag" + }, + { + "description": "Returns the product's short description in the current locale.", + "id": "script-api:dw/catalog/Product#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.shortDescription", + "sections": [ + { + "body": "Returns the product's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly shortDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "shortdescription", + "product.shortdescription" + ], + "title": "Product.shortDescription" + }, + { + "description": "Returns the product's change frequency needed for the sitemap creation.", + "id": "script-api:dw/catalog/Product#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapChangeFrequency", + "sections": [ + { + "body": "Returns the product's change frequency needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "readonly siteMapChangeFrequency: string", + "source": "script-api", + "tags": [ + "sitemapchangefrequency", + "product.sitemapchangefrequency" + ], + "title": "Product.siteMapChangeFrequency" + }, + { + "description": "Returns the status if the product is included into the sitemap.", + "id": "script-api:dw/catalog/Product#siteMapIncluded", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapIncluded", + "sections": [ + { + "body": "Returns the status if the product is included into the sitemap.", + "heading": "Description" + } + ], + "signature": "readonly siteMapIncluded: number", + "source": "script-api", + "tags": [ + "sitemapincluded", + "product.sitemapincluded" + ], + "title": "Product.siteMapIncluded" + }, + { + "description": "Returns the product's priority needed for the sitemap creation.", + "id": "script-api:dw/catalog/Product#siteMapPriority", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteMapPriority", + "sections": [ + { + "body": "Returns the product's priority needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "readonly siteMapPriority: number", + "source": "script-api", + "tags": [ + "sitemappriority", + "product.sitemappriority" + ], + "title": "Product.siteMapPriority" + }, + { + "deprecated": { + "message": "Use isAssignedToSiteCatalog instead" + }, + "description": "Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.", + "id": "script-api:dw/catalog/Product#siteProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.siteProduct", + "sections": [ + { + "body": "Returns 'true' if the product is assigned to the current site (via the\nsite catalog), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "readonly siteProduct: boolean", + "source": "script-api", + "tags": [ + "siteproduct", + "product.siteproduct" + ], + "title": "Product.siteProduct" + }, + { + "description": "Returns the steps in which the order amount of the product can be increased.", + "id": "script-api:dw/catalog/Product#stepQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.stepQuantity", + "sections": [ + { + "body": "Returns the steps in which the order amount of the product can be\nincreased.", + "heading": "Description" + } + ], + "signature": "readonly stepQuantity: Quantity", + "source": "script-api", + "tags": [ + "stepquantity", + "product.stepquantity" + ], + "title": "Product.stepQuantity" + }, + { + "description": "Returns the store receipt name of the product in the current locale.", + "id": "script-api:dw/catalog/Product#storeReceiptName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.storeReceiptName", + "sections": [ + { + "body": "Returns the store receipt name of the product in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly storeReceiptName: string | null", + "source": "script-api", + "tags": [ + "storereceiptname", + "product.storereceiptname" + ], + "title": "Product.storeReceiptName" + }, + { + "description": "Returns the store tax class ID.", + "id": "script-api:dw/catalog/Product#storeTaxClass", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.storeTaxClass", + "sections": [ + { + "body": "Returns the store tax class ID.\n\nThis is an optional override for in-store tax calculation.", + "heading": "Description" + } + ], + "signature": "readonly storeTaxClass: string", + "source": "script-api", + "tags": [ + "storetaxclass", + "product.storetaxclass" + ], + "title": "Product.storeTaxClass" + }, + { + "description": "Returns the ID of the product's tax class, by resolving the Global Preference setting selected. If the Localized Tax Class setting under Global Preferences -> Products is selected, the localizedTaxClassID attribute value will be returned, else the legacy taxClassID attribute value will be returned.", + "id": "script-api:dw/catalog/Product#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.taxClassID", + "sections": [ + { + "body": "Returns the ID of the product's tax class, by resolving\nthe Global Preference setting selected. If the Localized\nTax Class setting under Global Preferences -> Products is\nselected, the localizedTaxClassID attribute value will be\nreturned, else the legacy taxClassID attribute value will\nbe returned.", + "heading": "Description" + } + ], + "signature": "readonly taxClassID: string", + "source": "script-api", + "tags": [ + "taxclassid", + "product.taxclassid" + ], + "title": "Product.taxClassID" + }, + { + "description": "Returns the name of the product's rendering template.", + "id": "script-api:dw/catalog/Product#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.template", + "sections": [ + { + "body": "Returns the name of the product's rendering template.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "product.template" + ], + "title": "Product.template" + }, + { + "deprecated": { + "message": "Commerce Cloud Digital introduces a new more powerful product\nimage management. It allows to group product images by self-defined view types\n(e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute\ncolor 'red', 'blue'). Images can be annotated with pattern based title and\nalt. Product images can be accessed from Digital locations or external storage\nlocations.\n\nPlease use the new product image management. Therefore you have to set\nup the common product image settings like view types, image location,\ndefault image alt and title for your catalogs first. After that you can\ngroup your product images by the previously defined view types in context\nof a product. Finally use getImages and\ngetImage to access your images." + }, + "description": "Returns the product's thumbnail image.", + "id": "script-api:dw/catalog/Product#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.thumbnail", + "sections": [ + { + "body": "Returns the product's thumbnail image.", + "heading": "Description" + } + ], + "signature": "readonly thumbnail: MediaFile", + "source": "script-api", + "tags": [ + "thumbnail", + "product.thumbnail" + ], + "title": "Product.thumbnail" + }, + { + "description": "Returns the product's sales unit.", + "id": "script-api:dw/catalog/Product#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.unit", + "sections": [ + { + "body": "Returns the product's sales unit.", + "heading": "Description" + } + ], + "signature": "readonly unit: string", + "source": "script-api", + "tags": [ + "unit", + "product.unit" + ], + "title": "Product.unit" + }, + { + "description": "Returns the product's unit quantity.", + "id": "script-api:dw/catalog/Product#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.unitQuantity", + "sections": [ + { + "body": "Returns the product's unit quantity.", + "heading": "Description" + } + ], + "signature": "readonly unitQuantity: Quantity", + "source": "script-api", + "tags": [ + "unitquantity", + "product.unitquantity" + ], + "title": "Product.unitQuantity" + }, + { + "description": "Identifies if this product instance is mastered by a product master.", + "id": "script-api:dw/catalog/Product#variant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variant", + "sections": [ + { + "body": "Identifies if this product instance is mastered by a product master.", + "heading": "Description" + } + ], + "signature": "readonly variant: boolean", + "source": "script-api", + "tags": [ + "variant", + "product.variant" + ], + "title": "Product.variant" + }, + { + "description": "Returns a collection of all variants assigned to this variation master or variation group product. All variants are returned regardless of whether they are online or offline.", + "id": "script-api:dw/catalog/Product#variants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variants", + "sections": [ + { + "body": "Returns a collection of all variants assigned to this variation master\nor variation group product. All variants are returned regardless of whether\nthey are online or offline.\n\nIf this product does not represent a variation master or variation group\nproduct then an empty collection is returned.", + "heading": "Description" + } + ], + "signature": "readonly variants: Collection", + "source": "script-api", + "tags": [ + "variants", + "product.variants" + ], + "title": "Product.variants" + }, + { + "description": "Identifies if this product instance is a variation group product.", + "id": "script-api:dw/catalog/Product#variationGroup", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationGroup", + "sections": [ + { + "body": "Identifies if this product instance is a variation group product.", + "heading": "Description" + } + ], + "signature": "readonly variationGroup: boolean", + "source": "script-api", + "tags": [ + "variationgroup", + "product.variationgroup" + ], + "title": "Product.variationGroup" + }, + { + "description": "Returns a collection of all variation groups assigned to this variation master product. All variation groups are returned regardless of whether they are online or offline.", + "id": "script-api:dw/catalog/Product#variationGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationGroups", + "sections": [ + { + "body": "Returns a collection of all variation groups assigned to this variation\nmaster product. All variation groups are returned regardless of whether\nthey are online or offline.\n\nIf this product does not represent a variation master product then an\nempty collection is returned.", + "heading": "Description" + } + ], + "signature": "readonly variationGroups: Collection", + "source": "script-api", + "tags": [ + "variationgroups", + "product.variationgroups" + ], + "title": "Product.variationGroups" + }, + { + "description": "Returns the variation model of this product. If this product is a master product, then the returned model will encapsulate all the information about its variation attributes and variants. If this product is a variant product, then the returned model will encapsulate all the same information, but additionally pre-select all the variation attribute values of this variant. (See dw.catalog.ProductVariationModel for details on what \"selected\" means.) If this product is neither a master product or a variation product, then a model will be returned but will be essentially empty and not useful for any particular purpose.", + "id": "script-api:dw/catalog/Product#variationModel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Product", + "qualifiedName": "dw.catalog.Product.variationModel", + "sections": [ + { + "body": "Returns the variation model of this product. If this product is a master\nproduct, then the returned model will encapsulate all the information\nabout its variation attributes and variants. If this product is a variant\nproduct, then the returned model will encapsulate all the same\ninformation, but additionally pre-select all the variation attribute\nvalues of this variant. (See dw.catalog.ProductVariationModel for\ndetails on what \"selected\" means.) If this product is neither a master\nproduct or a variation product, then a model will be returned but will be\nessentially empty and not useful for any particular purpose.", + "heading": "Description" + } + ], + "signature": "readonly variationModel: ProductVariationModel", + "source": "script-api", + "tags": [ + "variationmodel", + "product.variationmodel" + ], + "title": "Product.variationModel" + }, + { + "description": "Represents the active data for a dw.catalog.Product in Commerce Cloud Digital.", + "id": "script-api:dw/catalog/ProductActiveData", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductActiveData", + "sections": [ + { + "body": "Represents the active data for a dw.catalog.Product in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ActiveData`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productactivedata", + "dw.catalog.productactivedata", + "dw/catalog" + ], + "title": "ProductActiveData" + }, + { + "description": "Returns the date the product became available on the site, or `null` if none has been set.", + "id": "script-api:dw/catalog/ProductActiveData#availableDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.availableDate", + "sections": [ + { + "body": "Returns the date the product became available on the site, or\n`null` if none has been set.", + "heading": "Description" + } + ], + "signature": "readonly availableDate: Date | null", + "source": "script-api", + "tags": [ + "availabledate", + "productactivedata.availabledate" + ], + "title": "ProductActiveData.availableDate" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentDay", + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent day for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginPercentDay: number", + "source": "script-api", + "tags": [ + "avggrossmarginpercentday", + "productactivedata.avggrossmarginpercentday" + ], + "title": "ProductActiveData.avgGrossMarginPercentDay" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentMonth", + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 30 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginPercentMonth: number", + "source": "script-api", + "tags": [ + "avggrossmarginpercentmonth", + "productactivedata.avggrossmarginpercentmonth" + ], + "title": "ProductActiveData.avgGrossMarginPercentMonth" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentWeek", + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 7 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginPercentWeek: number", + "source": "script-api", + "tags": [ + "avggrossmarginpercentweek", + "productactivedata.avggrossmarginpercentweek" + ], + "title": "ProductActiveData.avgGrossMarginPercentWeek" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginPercentYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginPercentYear", + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 365 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginPercentYear: number", + "source": "script-api", + "tags": [ + "avggrossmarginpercentyear", + "productactivedata.avggrossmarginpercentyear" + ], + "title": "ProductActiveData.avgGrossMarginPercentYear" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueDay", + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent day for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginValueDay: number", + "source": "script-api", + "tags": [ + "avggrossmarginvalueday", + "productactivedata.avggrossmarginvalueday" + ], + "title": "ProductActiveData.avgGrossMarginValueDay" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueMonth", + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 30 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginValueMonth: number", + "source": "script-api", + "tags": [ + "avggrossmarginvaluemonth", + "productactivedata.avggrossmarginvaluemonth" + ], + "title": "ProductActiveData.avgGrossMarginValueMonth" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueWeek", + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 7 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginValueWeek: number", + "source": "script-api", + "tags": [ + "avggrossmarginvalueweek", + "productactivedata.avggrossmarginvalueweek" + ], + "title": "ProductActiveData.avgGrossMarginValueWeek" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgGrossMarginValueYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgGrossMarginValueYear", + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 365 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgGrossMarginValueYear: number", + "source": "script-api", + "tags": [ + "avggrossmarginvalueyear", + "productactivedata.avggrossmarginvalueyear" + ], + "title": "ProductActiveData.avgGrossMarginValueYear" + }, + { + "description": "Returns the average sales price for the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceDay", + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgSalesPriceDay: number", + "source": "script-api", + "tags": [ + "avgsalespriceday", + "productactivedata.avgsalespriceday" + ], + "title": "ProductActiveData.avgSalesPriceDay" + }, + { + "description": "Returns the average sales price for the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceMonth", + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgSalesPriceMonth: number", + "source": "script-api", + "tags": [ + "avgsalespricemonth", + "productactivedata.avgsalespricemonth" + ], + "title": "ProductActiveData.avgSalesPriceMonth" + }, + { + "description": "Returns the average sales price for the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceWeek", + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgSalesPriceWeek: number", + "source": "script-api", + "tags": [ + "avgsalespriceweek", + "productactivedata.avgsalespriceweek" + ], + "title": "ProductActiveData.avgSalesPriceWeek" + }, + { + "description": "Returns the average sales price for the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#avgSalesPriceYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.avgSalesPriceYear", + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgSalesPriceYear: number", + "source": "script-api", + "tags": [ + "avgsalespriceyear", + "productactivedata.avgsalespriceyear" + ], + "title": "ProductActiveData.avgSalesPriceYear" + }, + { + "description": "Returns the conversion rate of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#conversionDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionDay", + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly conversionDay: number", + "source": "script-api", + "tags": [ + "conversionday", + "productactivedata.conversionday" + ], + "title": "ProductActiveData.conversionDay" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#conversionMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionMonth", + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly conversionMonth: number", + "source": "script-api", + "tags": [ + "conversionmonth", + "productactivedata.conversionmonth" + ], + "title": "ProductActiveData.conversionMonth" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#conversionWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionWeek", + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly conversionWeek: number", + "source": "script-api", + "tags": [ + "conversionweek", + "productactivedata.conversionweek" + ], + "title": "ProductActiveData.conversionWeek" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#conversionYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.conversionYear", + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly conversionYear: number", + "source": "script-api", + "tags": [ + "conversionyear", + "productactivedata.conversionyear" + ], + "title": "ProductActiveData.conversionYear" + }, + { + "description": "Returns the cost price for the product for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#costPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.costPrice", + "sections": [ + { + "body": "Returns the cost price for the product for the site,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly costPrice: number", + "source": "script-api", + "tags": [ + "costprice", + "productactivedata.costprice" + ], + "title": "ProductActiveData.costPrice" + }, + { + "description": "Returns the number of days the product has been available on the site. The number is calculated based on the current date and the date the product became available on the site, or if that date has not been set, the date the product was created in the system.", + "id": "script-api:dw/catalog/ProductActiveData#daysAvailable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.daysAvailable", + "sections": [ + { + "body": "Returns the number of days the product has been available on the site.\nThe number is calculated based on the current date and the date the\nproduct became available on the site, or if that date has not been set,\nthe date the product was created in the system.", + "heading": "Description" + } + ], + "signature": "readonly daysAvailable: number", + "source": "script-api", + "tags": [ + "daysavailable", + "productactivedata.daysavailable" + ], + "title": "ProductActiveData.daysAvailable" + }, + { + "description": "Returns the date the product became available on the site, or `null` if none has been set.", + "id": "script-api:dw/catalog/ProductActiveData#getAvailableDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvailableDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the date the product became available on the site, or\n`null` if none has been set.", + "heading": "Description" + } + ], + "signature": "getAvailableDate(): Date | null", + "source": "script-api", + "tags": [ + "getavailabledate", + "productactivedata.getavailabledate" + ], + "title": "ProductActiveData.getAvailableDate" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent day for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginPercentDay(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginpercentday", + "productactivedata.getavggrossmarginpercentday" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentDay" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 30 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginPercentMonth(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginpercentmonth", + "productactivedata.getavggrossmarginpercentmonth" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentMonth" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 7 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginPercentWeek(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginpercentweek", + "productactivedata.getavggrossmarginpercentweek" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentWeek" + }, + { + "description": "Returns the average gross margin percentage of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginPercentYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginPercentYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin percentage of the product,\nover the most recent 365 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginPercentYear(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginpercentyear", + "productactivedata.getavggrossmarginpercentyear" + ], + "title": "ProductActiveData.getAvgGrossMarginPercentYear" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent day for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginValueDay(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginvalueday", + "productactivedata.getavggrossmarginvalueday" + ], + "title": "ProductActiveData.getAvgGrossMarginValueDay" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 30 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginValueMonth(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginvaluemonth", + "productactivedata.getavggrossmarginvaluemonth" + ], + "title": "ProductActiveData.getAvgGrossMarginValueMonth" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 7 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginValueWeek(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginvalueweek", + "productactivedata.getavggrossmarginvalueweek" + ], + "title": "ProductActiveData.getAvgGrossMarginValueWeek" + }, + { + "description": "Returns the average gross margin value of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgGrossMarginValueYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgGrossMarginValueYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average gross margin value of the product,\nover the most recent 365 days for the site, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgGrossMarginValueYear(): number", + "source": "script-api", + "tags": [ + "getavggrossmarginvalueyear", + "productactivedata.getavggrossmarginvalueyear" + ], + "title": "ProductActiveData.getAvgGrossMarginValueYear" + }, + { + "description": "Returns the average sales price for the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgSalesPriceDay(): number", + "source": "script-api", + "tags": [ + "getavgsalespriceday", + "productactivedata.getavgsalespriceday" + ], + "title": "ProductActiveData.getAvgSalesPriceDay" + }, + { + "description": "Returns the average sales price for the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgSalesPriceMonth(): number", + "source": "script-api", + "tags": [ + "getavgsalespricemonth", + "productactivedata.getavgsalespricemonth" + ], + "title": "ProductActiveData.getAvgSalesPriceMonth" + }, + { + "description": "Returns the average sales price for the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgSalesPriceWeek(): number", + "source": "script-api", + "tags": [ + "getavgsalespriceweek", + "productactivedata.getavgsalespriceweek" + ], + "title": "ProductActiveData.getAvgSalesPriceWeek" + }, + { + "description": "Returns the average sales price for the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getAvgSalesPriceYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getAvgSalesPriceYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average sales price for the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgSalesPriceYear(): number", + "source": "script-api", + "tags": [ + "getavgsalespriceyear", + "productactivedata.getavgsalespriceyear" + ], + "title": "ProductActiveData.getAvgSalesPriceYear" + }, + { + "description": "Returns the conversion rate of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getConversionDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getConversionDay(): number", + "source": "script-api", + "tags": [ + "getconversionday", + "productactivedata.getconversionday" + ], + "title": "ProductActiveData.getConversionDay" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getConversionMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getConversionMonth(): number", + "source": "script-api", + "tags": [ + "getconversionmonth", + "productactivedata.getconversionmonth" + ], + "title": "ProductActiveData.getConversionMonth" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getConversionWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getConversionWeek(): number", + "source": "script-api", + "tags": [ + "getconversionweek", + "productactivedata.getconversionweek" + ], + "title": "ProductActiveData.getConversionWeek" + }, + { + "description": "Returns the conversion rate of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getConversionYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getConversionYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the conversion rate of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getConversionYear(): number", + "source": "script-api", + "tags": [ + "getconversionyear", + "productactivedata.getconversionyear" + ], + "title": "ProductActiveData.getConversionYear" + }, + { + "description": "Returns the cost price for the product for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getCostPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getCostPrice", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the cost price for the product for the site,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getCostPrice(): number", + "source": "script-api", + "tags": [ + "getcostprice", + "productactivedata.getcostprice" + ], + "title": "ProductActiveData.getCostPrice" + }, + { + "description": "Returns the number of days the product has been available on the site. The number is calculated based on the current date and the date the product became available on the site, or if that date has not been set, the date the product was created in the system.", + "id": "script-api:dw/catalog/ProductActiveData#getDaysAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getDaysAvailable", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of days the product has been available on the site.\nThe number is calculated based on the current date and the date the\nproduct became available on the site, or if that date has not been set,\nthe date the product was created in the system.", + "heading": "Description" + } + ], + "signature": "getDaysAvailable(): number", + "source": "script-api", + "tags": [ + "getdaysavailable", + "productactivedata.getdaysavailable" + ], + "title": "ProductActiveData.getDaysAvailable" + }, + { + "description": "Returns the impressions of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getImpressionsDay(): number", + "source": "script-api", + "tags": [ + "getimpressionsday", + "productactivedata.getimpressionsday" + ], + "title": "ProductActiveData.getImpressionsDay" + }, + { + "description": "Returns the impressions of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getImpressionsMonth(): number", + "source": "script-api", + "tags": [ + "getimpressionsmonth", + "productactivedata.getimpressionsmonth" + ], + "title": "ProductActiveData.getImpressionsMonth" + }, + { + "description": "Returns the impressions of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getImpressionsWeek(): number", + "source": "script-api", + "tags": [ + "getimpressionsweek", + "productactivedata.getimpressionsweek" + ], + "title": "ProductActiveData.getImpressionsWeek" + }, + { + "description": "Returns the impressions of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getImpressionsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getImpressionsYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getImpressionsYear(): number", + "source": "script-api", + "tags": [ + "getimpressionsyear", + "productactivedata.getimpressionsyear" + ], + "title": "ProductActiveData.getImpressionsYear" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getLookToBookRatioDay(): number", + "source": "script-api", + "tags": [ + "getlooktobookratioday", + "productactivedata.getlooktobookratioday" + ], + "title": "ProductActiveData.getLookToBookRatioDay" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getLookToBookRatioMonth(): number", + "source": "script-api", + "tags": [ + "getlooktobookratiomonth", + "productactivedata.getlooktobookratiomonth" + ], + "title": "ProductActiveData.getLookToBookRatioMonth" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getLookToBookRatioWeek(): number", + "source": "script-api", + "tags": [ + "getlooktobookratioweek", + "productactivedata.getlooktobookratioweek" + ], + "title": "ProductActiveData.getLookToBookRatioWeek" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getLookToBookRatioYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getLookToBookRatioYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getLookToBookRatioYear(): number", + "source": "script-api", + "tags": [ + "getlooktobookratioyear", + "productactivedata.getlooktobookratioyear" + ], + "title": "ProductActiveData.getLookToBookRatioYear" + }, + { + "description": "Returns the number of orders containing the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getOrdersDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent day for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrdersDay(): number", + "source": "script-api", + "tags": [ + "getordersday", + "productactivedata.getordersday" + ], + "title": "ProductActiveData.getOrdersDay" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getOrdersMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 30 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrdersMonth(): number", + "source": "script-api", + "tags": [ + "getordersmonth", + "productactivedata.getordersmonth" + ], + "title": "ProductActiveData.getOrdersMonth" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getOrdersWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 7 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrdersWeek(): number", + "source": "script-api", + "tags": [ + "getordersweek", + "productactivedata.getordersweek" + ], + "title": "ProductActiveData.getOrdersWeek" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getOrdersYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getOrdersYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 365 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrdersYear(): number", + "source": "script-api", + "tags": [ + "getordersyear", + "productactivedata.getordersyear" + ], + "title": "ProductActiveData.getOrdersYear" + }, + { + "description": "Returns the return rate for the product for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getReturnRate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getReturnRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the return rate for the product for the site,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getReturnRate(): number", + "source": "script-api", + "tags": [ + "getreturnrate", + "productactivedata.getreturnrate" + ], + "title": "ProductActiveData.getReturnRate" + }, + { + "description": "Returns the revenue of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getRevenueDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getRevenueDay(): number", + "source": "script-api", + "tags": [ + "getrevenueday", + "productactivedata.getrevenueday" + ], + "title": "ProductActiveData.getRevenueDay" + }, + { + "description": "Returns the revenue of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getRevenueMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getRevenueMonth(): number", + "source": "script-api", + "tags": [ + "getrevenuemonth", + "productactivedata.getrevenuemonth" + ], + "title": "ProductActiveData.getRevenueMonth" + }, + { + "description": "Returns the revenue of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getRevenueWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getRevenueWeek(): number", + "source": "script-api", + "tags": [ + "getrevenueweek", + "productactivedata.getrevenueweek" + ], + "title": "ProductActiveData.getRevenueWeek" + }, + { + "description": "Returns the revenue of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getRevenueYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getRevenueYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getRevenueYear(): number", + "source": "script-api", + "tags": [ + "getrevenueyear", + "productactivedata.getrevenueyear" + ], + "title": "ProductActiveData.getRevenueYear" + }, + { + "description": "Returns the sales velocity of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getSalesVelocityDay(): number", + "source": "script-api", + "tags": [ + "getsalesvelocityday", + "productactivedata.getsalesvelocityday" + ], + "title": "ProductActiveData.getSalesVelocityDay" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getSalesVelocityMonth(): number", + "source": "script-api", + "tags": [ + "getsalesvelocitymonth", + "productactivedata.getsalesvelocitymonth" + ], + "title": "ProductActiveData.getSalesVelocityMonth" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getSalesVelocityWeek(): number", + "source": "script-api", + "tags": [ + "getsalesvelocityweek", + "productactivedata.getsalesvelocityweek" + ], + "title": "ProductActiveData.getSalesVelocityWeek" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getSalesVelocityYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getSalesVelocityYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getSalesVelocityYear(): number", + "source": "script-api", + "tags": [ + "getsalesvelocityyear", + "productactivedata.getsalesvelocityyear" + ], + "title": "ProductActiveData.getSalesVelocityYear" + }, + { + "description": "Returns the units of the product ordered over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getUnitsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getUnitsDay(): number", + "source": "script-api", + "tags": [ + "getunitsday", + "productactivedata.getunitsday" + ], + "title": "ProductActiveData.getUnitsDay" + }, + { + "description": "Returns the units of the product ordered over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getUnitsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getUnitsMonth(): number", + "source": "script-api", + "tags": [ + "getunitsmonth", + "productactivedata.getunitsmonth" + ], + "title": "ProductActiveData.getUnitsMonth" + }, + { + "description": "Returns the units of the product ordered over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getUnitsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getUnitsWeek(): number", + "source": "script-api", + "tags": [ + "getunitsweek", + "productactivedata.getunitsweek" + ], + "title": "ProductActiveData.getUnitsWeek" + }, + { + "description": "Returns the units of the product ordered over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getUnitsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getUnitsYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getUnitsYear(): number", + "source": "script-api", + "tags": [ + "getunitsyear", + "productactivedata.getunitsyear" + ], + "title": "ProductActiveData.getUnitsYear" + }, + { + "description": "Returns the views of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getViewsDay", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsDay", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the views of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getViewsDay(): number", + "source": "script-api", + "tags": [ + "getviewsday", + "productactivedata.getviewsday" + ], + "title": "ProductActiveData.getViewsDay" + }, + { + "description": "Returns the views of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getViewsMonth", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the views of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getViewsMonth(): number", + "source": "script-api", + "tags": [ + "getviewsmonth", + "productactivedata.getviewsmonth" + ], + "title": "ProductActiveData.getViewsMonth" + }, + { + "description": "Returns the views of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getViewsWeek", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the views of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getViewsWeek(): number", + "source": "script-api", + "tags": [ + "getviewsweek", + "productactivedata.getviewsweek" + ], + "title": "ProductActiveData.getViewsWeek" + }, + { + "description": "Returns the views of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#getViewsYear", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.getViewsYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the views of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getViewsYear(): number", + "source": "script-api", + "tags": [ + "getviewsyear", + "productactivedata.getviewsyear" + ], + "title": "ProductActiveData.getViewsYear" + }, + { + "description": "Returns the impressions of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#impressionsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsDay", + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly impressionsDay: number", + "source": "script-api", + "tags": [ + "impressionsday", + "productactivedata.impressionsday" + ], + "title": "ProductActiveData.impressionsDay" + }, + { + "description": "Returns the impressions of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#impressionsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsMonth", + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly impressionsMonth: number", + "source": "script-api", + "tags": [ + "impressionsmonth", + "productactivedata.impressionsmonth" + ], + "title": "ProductActiveData.impressionsMonth" + }, + { + "description": "Returns the impressions of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#impressionsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsWeek", + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly impressionsWeek: number", + "source": "script-api", + "tags": [ + "impressionsweek", + "productactivedata.impressionsweek" + ], + "title": "ProductActiveData.impressionsWeek" + }, + { + "description": "Returns the impressions of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#impressionsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.impressionsYear", + "sections": [ + { + "body": "Returns the impressions of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly impressionsYear: number", + "source": "script-api", + "tags": [ + "impressionsyear", + "productactivedata.impressionsyear" + ], + "title": "ProductActiveData.impressionsYear" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioDay", + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly lookToBookRatioDay: number", + "source": "script-api", + "tags": [ + "looktobookratioday", + "productactivedata.looktobookratioday" + ], + "title": "ProductActiveData.lookToBookRatioDay" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioMonth", + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly lookToBookRatioMonth: number", + "source": "script-api", + "tags": [ + "looktobookratiomonth", + "productactivedata.looktobookratiomonth" + ], + "title": "ProductActiveData.lookToBookRatioMonth" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioWeek", + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly lookToBookRatioWeek: number", + "source": "script-api", + "tags": [ + "looktobookratioweek", + "productactivedata.looktobookratioweek" + ], + "title": "ProductActiveData.lookToBookRatioWeek" + }, + { + "description": "Returns the look to book ratio of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#lookToBookRatioYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.lookToBookRatioYear", + "sections": [ + { + "body": "Returns the look to book ratio of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly lookToBookRatioYear: number", + "source": "script-api", + "tags": [ + "looktobookratioyear", + "productactivedata.looktobookratioyear" + ], + "title": "ProductActiveData.lookToBookRatioYear" + }, + { + "description": "Returns the number of orders containing the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#ordersDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersDay", + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent day for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly ordersDay: number", + "source": "script-api", + "tags": [ + "ordersday", + "productactivedata.ordersday" + ], + "title": "ProductActiveData.ordersDay" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#ordersMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersMonth", + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 30 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly ordersMonth: number", + "source": "script-api", + "tags": [ + "ordersmonth", + "productactivedata.ordersmonth" + ], + "title": "ProductActiveData.ordersMonth" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#ordersWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersWeek", + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 7 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly ordersWeek: number", + "source": "script-api", + "tags": [ + "ordersweek", + "productactivedata.ordersweek" + ], + "title": "ProductActiveData.ordersWeek" + }, + { + "description": "Returns the number of orders containing the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#ordersYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.ordersYear", + "sections": [ + { + "body": "Returns the number of orders containing the product, over the most\nrecent 365 days for the site, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly ordersYear: number", + "source": "script-api", + "tags": [ + "ordersyear", + "productactivedata.ordersyear" + ], + "title": "ProductActiveData.ordersYear" + }, + { + "description": "Returns the return rate for the product for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#returnRate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.returnRate", + "sections": [ + { + "body": "Returns the return rate for the product for the site,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly returnRate: number", + "source": "script-api", + "tags": [ + "returnrate", + "productactivedata.returnrate" + ], + "title": "ProductActiveData.returnRate" + }, + { + "description": "Returns the revenue of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#revenueDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueDay", + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly revenueDay: number", + "source": "script-api", + "tags": [ + "revenueday", + "productactivedata.revenueday" + ], + "title": "ProductActiveData.revenueDay" + }, + { + "description": "Returns the revenue of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#revenueMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueMonth", + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly revenueMonth: number", + "source": "script-api", + "tags": [ + "revenuemonth", + "productactivedata.revenuemonth" + ], + "title": "ProductActiveData.revenueMonth" + }, + { + "description": "Returns the revenue of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#revenueWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueWeek", + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly revenueWeek: number", + "source": "script-api", + "tags": [ + "revenueweek", + "productactivedata.revenueweek" + ], + "title": "ProductActiveData.revenueWeek" + }, + { + "description": "Returns the revenue of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#revenueYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.revenueYear", + "sections": [ + { + "body": "Returns the revenue of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly revenueYear: number", + "source": "script-api", + "tags": [ + "revenueyear", + "productactivedata.revenueyear" + ], + "title": "ProductActiveData.revenueYear" + }, + { + "description": "Returns the sales velocity of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityDay", + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly salesVelocityDay: number", + "source": "script-api", + "tags": [ + "salesvelocityday", + "productactivedata.salesvelocityday" + ], + "title": "ProductActiveData.salesVelocityDay" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityMonth", + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly salesVelocityMonth: number", + "source": "script-api", + "tags": [ + "salesvelocitymonth", + "productactivedata.salesvelocitymonth" + ], + "title": "ProductActiveData.salesVelocityMonth" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityWeek", + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly salesVelocityWeek: number", + "source": "script-api", + "tags": [ + "salesvelocityweek", + "productactivedata.salesvelocityweek" + ], + "title": "ProductActiveData.salesVelocityWeek" + }, + { + "description": "Returns the sales velocity of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#salesVelocityYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.salesVelocityYear", + "sections": [ + { + "body": "Returns the sales velocity of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly salesVelocityYear: number", + "source": "script-api", + "tags": [ + "salesvelocityyear", + "productactivedata.salesvelocityyear" + ], + "title": "ProductActiveData.salesVelocityYear" + }, + { + "description": "Returns the units of the product ordered over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#unitsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsDay", + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly unitsDay: number", + "source": "script-api", + "tags": [ + "unitsday", + "productactivedata.unitsday" + ], + "title": "ProductActiveData.unitsDay" + }, + { + "description": "Returns the units of the product ordered over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#unitsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsMonth", + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly unitsMonth: number", + "source": "script-api", + "tags": [ + "unitsmonth", + "productactivedata.unitsmonth" + ], + "title": "ProductActiveData.unitsMonth" + }, + { + "description": "Returns the units of the product ordered over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#unitsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsWeek", + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly unitsWeek: number", + "source": "script-api", + "tags": [ + "unitsweek", + "productactivedata.unitsweek" + ], + "title": "ProductActiveData.unitsWeek" + }, + { + "description": "Returns the units of the product ordered over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#unitsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.unitsYear", + "sections": [ + { + "body": "Returns the units of the product ordered over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly unitsYear: number", + "source": "script-api", + "tags": [ + "unitsyear", + "productactivedata.unitsyear" + ], + "title": "ProductActiveData.unitsYear" + }, + { + "description": "Returns the views of the product, over the most recent day for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#viewsDay", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsDay", + "sections": [ + { + "body": "Returns the views of the product, over the most recent day\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly viewsDay: number", + "source": "script-api", + "tags": [ + "viewsday", + "productactivedata.viewsday" + ], + "title": "ProductActiveData.viewsDay" + }, + { + "description": "Returns the views of the product, over the most recent 30 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#viewsMonth", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsMonth", + "sections": [ + { + "body": "Returns the views of the product, over the most recent 30 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly viewsMonth: number", + "source": "script-api", + "tags": [ + "viewsmonth", + "productactivedata.viewsmonth" + ], + "title": "ProductActiveData.viewsMonth" + }, + { + "description": "Returns the views of the product, over the most recent 7 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#viewsWeek", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsWeek", + "sections": [ + { + "body": "Returns the views of the product, over the most recent 7 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly viewsWeek: number", + "source": "script-api", + "tags": [ + "viewsweek", + "productactivedata.viewsweek" + ], + "title": "ProductActiveData.viewsWeek" + }, + { + "description": "Returns the views of the product, over the most recent 365 days for the site, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/catalog/ProductActiveData#viewsYear", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductActiveData", + "qualifiedName": "dw.catalog.ProductActiveData.viewsYear", + "sections": [ + { + "body": "Returns the views of the product, over the most recent 365 days\nfor the site, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly viewsYear: number", + "source": "script-api", + "tags": [ + "viewsyear", + "productactivedata.viewsyear" + ], + "title": "ProductActiveData.viewsYear" + }, + { + "description": "Class representing the complete attribute model for products in the system. An instance of this class provides methods to access the attribute definitions and groups for the system object type 'Product' and perhaps additional information depending on how the instance is obtained. A ProductAttributeModel can be obtained in one of three ways:", + "id": "script-api:dw/catalog/ProductAttributeModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAttributeModel", + "sections": [ + { + "body": "Class representing the complete attribute model for products in the system.\nAn instance of this class provides methods to access the attribute\ndefinitions and groups for the system object type 'Product' and perhaps\nadditional information depending on how the instance is obtained.\nA ProductAttributeModel can be obtained in one of three ways:\n\n- ProductAttributeModel: When the no-arg constructor is\nused the model represents:\n\n- the attribute groups of the system object type 'Product' (i.e. the\nglobal product attribute groups) and their bound attributes\n\n- dw.catalog.Category.getProductAttributeModel: When the\nattribute model for a Category is retrieved, the model represents:\n\n- the global product attribute groups\n- product attribute groups of the calling category\n- product attribute groups of any parent categories of the calling category\n\n- dw.catalog.Product.getAttributeModel: When the attribute\nmodel for a Product is retrieved, the model represents:\n\n- the global product attribute groups\n- product attribute groups of the product's classification category\n- product attribute groups of any parent categories of the product's classification category\n\nIn this case, the model additionally provides access to the attribute values\nof the product. If the product lacks a classification category, then only\nthe global product attribute group is considered by the model.\n\nThe ProductAttributeModel provides a generic way to display the attribute\nvalues of a product on a product detail page organized into appropriate\nvisual groups. This is typically done as follows:\n\n- On the product detail page, call\ndw.catalog.Product.getAttributeModel to get the attribute model for\nthe product.\n- Call getVisibleAttributeGroups to get the groups that are\nappropriate for this product and all other products assigned to the same\nclassification category.\n- Iterate the groups, and display each as a \"group\" in the UI.\n- Call getVisibleAttributeDefinitions for\neach group. Iterate and display the attribute names using\ndw.object.ObjectAttributeDefinition.getDisplayName.\n- For each attribute, get the product's display value(s) for that\nattribute, using `getDisplayValue()`. This might require custom\ndisplay logic based on the type of attribute (strings, dates, multi-value\nattributes, etc).", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productattributemodel", + "dw.catalog.productattributemodel", + "dw/catalog" + ], + "title": "ProductAttributeModel" + }, + { + "description": "Returns a sorted collection of attribute groups of this model. The groups returned depends on how this model is constructed and what it represents. (See class-level documentation for details).", + "id": "script-api:dw/catalog/ProductAttributeModel#attributeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.attributeGroups", + "sections": [ + { + "body": "Returns a sorted collection of attribute groups of this model. The groups\nreturned depends on how this model is constructed and what it represents.\n(See class-level documentation for details).\n\nThe collection of returned groups is sorted first by scope and secondly\nby explicit sort order. Global groups always appear before\ncategory-specific groups in the list. Groups of parent categories always\nappear before groups belonging to subcategories. At each scope, groups\nhave an explicit sort order which can be managed within the Business\nManager.\n\nWhen there are multiple attribute groups with the same ID, the following\nrules apply:\n\n- If this model represents the global product attribute group only\n(e.g. the no-arg constructor was used), duplicates cannot occur since\nonly one group can be defined with a given ID at that scope.\n- If this model is associated with specific categories (e.g. it is\nconstructed from a product with a classification category), then a\ncategory product attribute group might have the same ID as a global\nproduct attribute group. In this case, the category group overrides the\nglobal one.\n- If a category and one of its ancestor categories both define a\nproduct attribute group with the same ID, the sub-category group\noverrides the parent group.\n\nAs a result of these rules, this method will never return two attribute\ngroups with the same ID.", + "heading": "Description" + } + ], + "signature": "readonly attributeGroups: Collection", + "source": "script-api", + "tags": [ + "attributegroups", + "productattributemodel.attributegroups" + ], + "title": "ProductAttributeModel.attributeGroups" + }, + { + "description": "Returns the attribute definition with the given id from the product attribute model. If attribute definition does not exist, null is returned.", + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeDefinition", + "returns": { + "type": "ObjectAttributeDefinition | null" + }, + "sections": [ + { + "body": "Returns the attribute definition with the given id from the product attribute\nmodel. If attribute definition does not exist, null is returned.", + "heading": "Description" + } + ], + "signature": "getAttributeDefinition(id: string): ObjectAttributeDefinition | null", + "source": "script-api", + "tags": [ + "getattributedefinition", + "productattributemodel.getattributedefinition" + ], + "title": "ProductAttributeModel.getAttributeDefinition" + }, + { + "description": "Returns a sorted collection of attribute definitions for the given attribute group. If no attribute definition exist for the group, an empty collection is returned.", + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "group", + "type": "ObjectAttributeGroup" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of attribute definitions for the given attribute\ngroup. If no attribute definition exist for the group, an empty collection\nis returned.\n\nThe returned attribute definitions are sorted according to the explicit\nsort order defined for the attributes in the group. This is managed\nby merchant in the Business Manager.", + "heading": "Description" + } + ], + "signature": "getAttributeDefinitions(group: ObjectAttributeGroup): Collection", + "source": "script-api", + "tags": [ + "getattributedefinitions", + "productattributemodel.getattributedefinitions" + ], + "title": "ProductAttributeModel.getAttributeDefinitions" + }, + { + "description": "Returns the attribute group with the given id from the product attribute model. If attribute group does not exist, null is returned.", + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeGroup", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeGroup", + "returns": { + "type": "ObjectAttributeGroup | null" + }, + "sections": [ + { + "body": "Returns the attribute group with the given id from the product attribute\nmodel. If attribute group does not exist, null is returned.", + "heading": "Description" + } + ], + "signature": "getAttributeGroup(id: string): ObjectAttributeGroup | null", + "source": "script-api", + "tags": [ + "getattributegroup", + "productattributemodel.getattributegroup" + ], + "title": "ProductAttributeModel.getAttributeGroup" + }, + { + "description": "Returns a sorted collection of attribute groups of this model. The groups returned depends on how this model is constructed and what it represents. (See class-level documentation for details).", + "id": "script-api:dw/catalog/ProductAttributeModel#getAttributeGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getAttributeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of attribute groups of this model. The groups\nreturned depends on how this model is constructed and what it represents.\n(See class-level documentation for details).\n\nThe collection of returned groups is sorted first by scope and secondly\nby explicit sort order. Global groups always appear before\ncategory-specific groups in the list. Groups of parent categories always\nappear before groups belonging to subcategories. At each scope, groups\nhave an explicit sort order which can be managed within the Business\nManager.\n\nWhen there are multiple attribute groups with the same ID, the following\nrules apply:\n\n- If this model represents the global product attribute group only\n(e.g. the no-arg constructor was used), duplicates cannot occur since\nonly one group can be defined with a given ID at that scope.\n- If this model is associated with specific categories (e.g. it is\nconstructed from a product with a classification category), then a\ncategory product attribute group might have the same ID as a global\nproduct attribute group. In this case, the category group overrides the\nglobal one.\n- If a category and one of its ancestor categories both define a\nproduct attribute group with the same ID, the sub-category group\noverrides the parent group.\n\nAs a result of these rules, this method will never return two attribute\ngroups with the same ID.", + "heading": "Description" + } + ], + "signature": "getAttributeGroups(): Collection", + "source": "script-api", + "tags": [ + "getattributegroups", + "productattributemodel.getattributegroups" + ], + "title": "ProductAttributeModel.getAttributeGroups" + }, + { + "description": "Returns the value that the underlying product defines for the given attribute definition in the current locale. In case the attribute definition defines localized attribute values, the product's value is used as an id to find the localized display value.", + "id": "script-api:dw/catalog/ProductAttributeModel#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "definition", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getDisplayValue", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the value that the underlying product defines for the given\nattribute definition in the current locale. In case the attribute\ndefinition defines localized attribute values, the product's value is\nused as an id to find the localized display value.", + "heading": "Description" + } + ], + "signature": "getDisplayValue(definition: ObjectAttributeDefinition): any", + "source": "script-api", + "tags": [ + "getdisplayvalue", + "productattributemodel.getdisplayvalue" + ], + "title": "ProductAttributeModel.getDisplayValue" + }, + { + "description": "Returns an unsorted collection of attribute definitions marked as order-required. Order-required attributes are usually copied into order line items.", + "id": "script-api:dw/catalog/ProductAttributeModel#getOrderRequiredAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getOrderRequiredAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an unsorted collection of attribute definitions marked as\norder-required. Order-required attributes are usually copied into order\nline items.\n\nThe returned attribute definitions are sorted according to the explicit\nsort order defined for the attributes in the group. This is managed by\nmerchant in the Business Manager.", + "heading": "Description" + } + ], + "signature": "getOrderRequiredAttributeDefinitions(): Collection", + "source": "script-api", + "tags": [ + "getorderrequiredattributedefinitions", + "productattributemodel.getorderrequiredattributedefinitions" + ], + "title": "ProductAttributeModel.getOrderRequiredAttributeDefinitions" + }, + { + "description": "Returns the attribute value for the specified attribute definition. If the product does not define a value, null is returned.", + "id": "script-api:dw/catalog/ProductAttributeModel#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "definition", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getValue", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Returns the attribute value for the specified attribute\ndefinition. If the product does not define a value, null is returned.\n\nNote: this method may only be used where the attribute model was created for\na specific product; otherwise it will always return null.\n\nIf the attribute is localized, the value for the current session locale\nis returned.", + "heading": "Description" + } + ], + "signature": "getValue(definition: ObjectAttributeDefinition): any | null", + "source": "script-api", + "tags": [ + "getvalue", + "productattributemodel.getvalue" + ], + "title": "ProductAttributeModel.getValue" + }, + { + "description": "Returns a sorted collection of all visible attribute definitions for the given attribute group. If no visible attribute definition exist for the group, an empty collection is returned.", + "id": "script-api:dw/catalog/ProductAttributeModel#getVisibleAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "group", + "type": "ObjectAttributeGroup" + } + ], + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getVisibleAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of all visible attribute definitions for the\ngiven attribute group. If no visible attribute definition exist for the\ngroup, an empty collection is returned.\n\nAn attribute definition is considered visible if is marked as visible. If\nthe product attribute model is created for a specific product, the\nproduct must also define a value for the attribute definition; else the\nattribute definition is considered as invisible.\n\nThe returned attribute definitions are sorted according to the explicit\nsort order defined for the attributes in the group. This is managed by\nmerchant in the Business Manager.", + "heading": "Description" + } + ], + "signature": "getVisibleAttributeDefinitions(group: ObjectAttributeGroup): Collection", + "source": "script-api", + "tags": [ + "getvisibleattributedefinitions", + "productattributemodel.getvisibleattributedefinitions" + ], + "title": "ProductAttributeModel.getVisibleAttributeDefinitions" + }, + { + "description": "Returns a sorted collection of visible attribute groups of this model. This method is similar to getAttributeGroups but only includes attribute groups containing at least one attribute definition that is visible. See getVisibleAttributeDefinitions.", + "id": "script-api:dw/catalog/ProductAttributeModel#getVisibleAttributeGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.getVisibleAttributeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of visible attribute groups of this model.\nThis method is similar to getAttributeGroups but only includes\nattribute groups containing at least one attribute definition that is\nvisible. See\ngetVisibleAttributeDefinitions.", + "heading": "Description" + } + ], + "signature": "getVisibleAttributeGroups(): Collection", + "source": "script-api", + "tags": [ + "getvisibleattributegroups", + "productattributemodel.getvisibleattributegroups" + ], + "title": "ProductAttributeModel.getVisibleAttributeGroups" + }, + { + "description": "Returns an unsorted collection of attribute definitions marked as order-required. Order-required attributes are usually copied into order line items.", + "id": "script-api:dw/catalog/ProductAttributeModel#orderRequiredAttributeDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.orderRequiredAttributeDefinitions", + "sections": [ + { + "body": "Returns an unsorted collection of attribute definitions marked as\norder-required. Order-required attributes are usually copied into order\nline items.\n\nThe returned attribute definitions are sorted according to the explicit\nsort order defined for the attributes in the group. This is managed by\nmerchant in the Business Manager.", + "heading": "Description" + } + ], + "signature": "readonly orderRequiredAttributeDefinitions: Collection", + "source": "script-api", + "tags": [ + "orderrequiredattributedefinitions", + "productattributemodel.orderrequiredattributedefinitions" + ], + "title": "ProductAttributeModel.orderRequiredAttributeDefinitions" + }, + { + "description": "Returns a sorted collection of visible attribute groups of this model. This method is similar to getAttributeGroups but only includes attribute groups containing at least one attribute definition that is visible. See getVisibleAttributeDefinitions.", + "id": "script-api:dw/catalog/ProductAttributeModel#visibleAttributeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAttributeModel", + "qualifiedName": "dw.catalog.ProductAttributeModel.visibleAttributeGroups", + "sections": [ + { + "body": "Returns a sorted collection of visible attribute groups of this model.\nThis method is similar to getAttributeGroups but only includes\nattribute groups containing at least one attribute definition that is\nvisible. See\ngetVisibleAttributeDefinitions.", + "heading": "Description" + } + ], + "signature": "readonly visibleAttributeGroups: Collection", + "source": "script-api", + "tags": [ + "visibleattributegroups", + "productattributemodel.visibleattributegroups" + ], + "title": "ProductAttributeModel.visibleAttributeGroups" + }, + { + "description": "Encapsulates the quantity of items available for each availability status.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels", + "sections": [ + { + "body": "Encapsulates the quantity of items available for each availability status.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productavailabilitylevels", + "dw.catalog.productavailabilitylevels", + "dw/catalog" + ], + "title": "ProductAvailabilityLevels" + }, + { + "description": "Returns the backorder quantity.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#backorder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.backorder", + "sections": [ + { + "body": "Returns the backorder quantity.", + "heading": "Description" + } + ], + "signature": "readonly backorder: Quantity", + "source": "script-api", + "tags": [ + "backorder", + "productavailabilitylevels.backorder" + ], + "title": "ProductAvailabilityLevels.backorder" + }, + { + "description": "Returns the number of attributes that contain non-zero quantities.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#count", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.count", + "sections": [ + { + "body": "Returns the number of attributes that contain non-zero quantities.", + "heading": "Description" + } + ], + "signature": "readonly count: number", + "source": "script-api", + "tags": [ + "count", + "productavailabilitylevels.count" + ], + "title": "ProductAvailabilityLevels.count" + }, + { + "description": "Returns the backorder quantity.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getBackorder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getBackorder", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the backorder quantity.", + "heading": "Description" + } + ], + "signature": "getBackorder(): Quantity", + "source": "script-api", + "tags": [ + "getbackorder", + "productavailabilitylevels.getbackorder" + ], + "title": "ProductAvailabilityLevels.getBackorder" + }, + { + "description": "Returns the number of attributes that contain non-zero quantities.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of attributes that contain non-zero quantities.", + "heading": "Description" + } + ], + "signature": "getCount(): number", + "source": "script-api", + "tags": [ + "getcount", + "productavailabilitylevels.getcount" + ], + "title": "ProductAvailabilityLevels.getCount" + }, + { + "description": "Returns the quantity in stock.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getInStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getInStock", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity in stock.", + "heading": "Description" + } + ], + "signature": "getInStock(): Quantity", + "source": "script-api", + "tags": [ + "getinstock", + "productavailabilitylevels.getinstock" + ], + "title": "ProductAvailabilityLevels.getInStock" + }, + { + "description": "Returns the quantity that is not available.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getNotAvailable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getNotAvailable", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity that is not available.", + "heading": "Description" + } + ], + "signature": "getNotAvailable(): Quantity", + "source": "script-api", + "tags": [ + "getnotavailable", + "productavailabilitylevels.getnotavailable" + ], + "title": "ProductAvailabilityLevels.getNotAvailable" + }, + { + "description": "Returns the pre-order quantity.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#getPreorder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.getPreorder", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the pre-order quantity.", + "heading": "Description" + } + ], + "signature": "getPreorder(): Quantity", + "source": "script-api", + "tags": [ + "getpreorder", + "productavailabilitylevels.getpreorder" + ], + "title": "ProductAvailabilityLevels.getPreorder" + }, + { + "description": "Returns the quantity in stock.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#inStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.inStock", + "sections": [ + { + "body": "Returns the quantity in stock.", + "heading": "Description" + } + ], + "signature": "readonly inStock: Quantity", + "source": "script-api", + "tags": [ + "instock", + "productavailabilitylevels.instock" + ], + "title": "ProductAvailabilityLevels.inStock" + }, + { + "description": "Returns the quantity that is not available.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#notAvailable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.notAvailable", + "sections": [ + { + "body": "Returns the quantity that is not available.", + "heading": "Description" + } + ], + "signature": "readonly notAvailable: Quantity", + "source": "script-api", + "tags": [ + "notavailable", + "productavailabilitylevels.notavailable" + ], + "title": "ProductAvailabilityLevels.notAvailable" + }, + { + "description": "Returns the pre-order quantity.", + "id": "script-api:dw/catalog/ProductAvailabilityLevels#preorder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityLevels", + "qualifiedName": "dw.catalog.ProductAvailabilityLevels.preorder", + "sections": [ + { + "body": "Returns the pre-order quantity.", + "heading": "Description" + } + ], + "signature": "readonly preorder: Quantity", + "source": "script-api", + "tags": [ + "preorder", + "productavailabilitylevels.preorder" + ], + "title": "ProductAvailabilityLevels.preorder" + }, + { + "description": "The ProductAvailabilityModel provides methods for retrieving all information on availability of a single product.", + "id": "script-api:dw/catalog/ProductAvailabilityModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductAvailabilityModel", + "sections": [ + { + "body": "The ProductAvailabilityModel provides methods for retrieving all information\non availability of a single product.\n\nWhen using Omnichannel Inventory (OCI):\n\n- OCI supports backorders, but does not support preorders or perpetual availability. OCI refers to expected\nrestocks as Future inventory.\n- OCI uses an eventual consistency model with asynchronous inventory data updates. Your code must not assume that\ninventory-affecting actions, such as placing orders, will immediately change inventory levels.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productavailabilitymodel", + "dw.catalog.productavailabilitymodel", + "dw/catalog" + ], + "title": "ProductAvailabilityModel" + }, + { + "description": "Indicates that the product stock has run out, but will be replenished, and is therefore available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER", + "sections": [ + { + "body": "Indicates that the product stock has run out, but will be replenished, and is therefore available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "availability_status_backorder", + "productavailabilitymodel.availability_status_backorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER" + }, + { + "description": "Indicates that the product stock has run out, but will be replenished, and is therefore available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER", + "sections": [ + { + "body": "Indicates that the product stock has run out, but will be replenished, and is therefore available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "availability_status_backorder", + "productavailabilitymodel.availability_status_backorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER" + }, + { + "description": "Indicates that the product is in stock and available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_IN_STOCK", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is in stock and available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_status_in_stock", + "productavailabilitymodel.availability_status_in_stock" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK" + }, + { + "description": "Indicates that the product is in stock and available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_IN_STOCK", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is in stock and available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_status_in_stock", + "productavailabilitymodel.availability_status_in_stock" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_IN_STOCK" + }, + { + "description": "Indicates that the product is not currently available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE", + "sections": [ + { + "body": "Indicates that the product is not currently available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_NOT_AVAILABLE: string", + "source": "script-api", + "tags": [ + "availability_status_not_available", + "productavailabilitymodel.availability_status_not_available" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE" + }, + { + "description": "Indicates that the product is not currently available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE", + "sections": [ + { + "body": "Indicates that the product is not currently available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_NOT_AVAILABLE: string", + "source": "script-api", + "tags": [ + "availability_status_not_available", + "productavailabilitymodel.availability_status_not_available" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_NOT_AVAILABLE" + }, + { + "description": "Indicates that the product is not yet in stock but is available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_PREORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER", + "sections": [ + { + "body": "Indicates that the product is not yet in stock but is available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_status_preorder", + "productavailabilitymodel.availability_status_preorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER" + }, + { + "description": "Indicates that the product is not yet in stock but is available for ordering.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#AVAILABILITY_STATUS_PREORDER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER", + "sections": [ + { + "body": "Indicates that the product is not yet in stock but is available for ordering.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_STATUS_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_status_preorder", + "productavailabilitymodel.availability_status_preorder" + ], + "title": "ProductAvailabilityModel.AVAILABILITY_STATUS_PREORDER" + }, + { + "description": "Returns the SKU coverage of the product. The basic formula for a master product is the ratio of online variations that are in stock to the total number of online variations. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#SKUCoverage", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.SKUCoverage", + "sections": [ + { + "body": "Returns the SKU coverage of the product. The basic formula for a\nmaster product is the ratio of online variations that are in stock\nto the total number of online variations. The following specific rules\napply for standard products:\n\n- If the product is in stock this method returns the availability of the product.\n- If the product is out of stock this method returns 0.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the average SKU coverage\nof its online variations.\n- For a master product with no online variations this method returns 0.\n- For a product set this method returns the ratio of orderable SKUs in the product set\nover the total number of online SKUs in the product set.\n- For a product set with no online products this method returns 0.\n- For a product bundle this method returns 1 if all of the bundled\nproducts are online, and 0 otherwise.\n- For a product bundle with no online bundled products this method\nreturns 0.", + "heading": "Description" + } + ], + "signature": "readonly SKUCoverage: number", + "source": "script-api", + "tags": [ + "skucoverage", + "productavailabilitymodel.skucoverage" + ], + "title": "ProductAvailabilityModel.SKUCoverage" + }, + { + "description": "Returns the availability of the product, which roughly defined is the ratio of the original stock that is still available to sell. The basic formula, if the current site uses an inventory list, is the ATS quantity divided by allocation amount. If the product is not orderable at all this method returns 0. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#availability", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.availability", + "sections": [ + { + "body": "Returns the availability of the product, which roughly defined is the\nratio of the original stock that is still available to sell. The basic\nformula, if the current site uses an\ninventory list, is the ATS quantity divided by allocation\namount. If the product is not orderable at all this method returns 0.\nThe following specific rules apply for standard products:\n\n- If inventory lists are in use:\n\n- If no inventory record exists and the inventory list default-in-stock flag is true this method returns 1.\n- If no inventory record exists the inventory list default-in-stock flag is false this method returns 0.\n- If the product is not available this method returns 0.\n- If the product is perpetually available this method returns 1.\n- Otherwise, this method returns ATS / (allocation + preorderBackorderAllocation). (Values from dw.catalog.ProductInventoryRecord.)\n\nIf inventory lists are not in use the method returns 0.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the average availability\nof its online variations.\n- For a master product with no online variations this method returns 0.\n- For a master product with own inventory record the rules of the standard\nproducts apply. Note: In this case the availability of the variations is not considered.\n- For a product set this method returns the greatest availability of\nthe online products in the set.\n- For a product set with no online products this method returns 0.\n- For a product set with an inventory record the rules of the standard\nproducts apply. Note: In this case the availability of the set products is not considered.\n- For a bundle, this method returns the least availability of the bundled\nproducts according to their bundled quantity and if it exist also from\nthe bundle inventory record.", + "heading": "Description" + } + ], + "signature": "readonly availability: number", + "source": "script-api", + "tags": [ + "availability", + "productavailabilitymodel.availability" + ], + "title": "ProductAvailabilityModel.availability" + }, + { + "description": "Returns the availability-status for the minimum-orderable-quantity (MOQ) of the product. The MOQ essentially represents a single orderable unit, and therefore can be represented by a single availability-status. This method is essentially a convenience method. The same information can be retrieved by calling getAvailabilityLevels with the MOQ of the product as the parameter and then retrieving the single status from the returned map.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#availabilityStatus", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.availabilityStatus", + "sections": [ + { + "body": "Returns the availability-status for the minimum-orderable-quantity (MOQ) of\nthe product. The MOQ essentially represents a single orderable unit, and\ntherefore can be represented by a single availability-status. This\nmethod is essentially a convenience method. The same information\ncan be retrieved by calling getAvailabilityLevels\nwith the MOQ of the product as the parameter and then retrieving the\nsingle status from the returned map.\n\nThis method is typically used to display a product's availability in\nthe catalog when the order quantity is not known.", + "heading": "Description" + } + ], + "signature": "readonly availabilityStatus: string", + "source": "script-api", + "tags": [ + "availabilitystatus", + "productavailabilitymodel.availabilitystatus" + ], + "title": "ProductAvailabilityModel.availabilityStatus" + }, + { + "description": "Returns the availability of the product, which roughly defined is the ratio of the original stock that is still available to sell. The basic formula, if the current site uses an inventory list, is the ATS quantity divided by allocation amount. If the product is not orderable at all this method returns 0. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailability", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailability", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the availability of the product, which roughly defined is the\nratio of the original stock that is still available to sell. The basic\nformula, if the current site uses an\ninventory list, is the ATS quantity divided by allocation\namount. If the product is not orderable at all this method returns 0.\nThe following specific rules apply for standard products:\n\n- If inventory lists are in use:\n\n- If no inventory record exists and the inventory list default-in-stock flag is true this method returns 1.\n- If no inventory record exists the inventory list default-in-stock flag is false this method returns 0.\n- If the product is not available this method returns 0.\n- If the product is perpetually available this method returns 1.\n- Otherwise, this method returns ATS / (allocation + preorderBackorderAllocation). (Values from dw.catalog.ProductInventoryRecord.)\n\nIf inventory lists are not in use the method returns 0.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the average availability\nof its online variations.\n- For a master product with no online variations this method returns 0.\n- For a master product with own inventory record the rules of the standard\nproducts apply. Note: In this case the availability of the variations is not considered.\n- For a product set this method returns the greatest availability of\nthe online products in the set.\n- For a product set with no online products this method returns 0.\n- For a product set with an inventory record the rules of the standard\nproducts apply. Note: In this case the availability of the set products is not considered.\n- For a bundle, this method returns the least availability of the bundled\nproducts according to their bundled quantity and if it exist also from\nthe bundle inventory record.", + "heading": "Description" + } + ], + "signature": "getAvailability(): number", + "source": "script-api", + "tags": [ + "getavailability", + "productavailabilitymodel.getavailability" + ], + "title": "ProductAvailabilityModel.getAvailability" + }, + { + "description": "Returns an instance of dw.catalog.ProductAvailabilityLevels, where each available quantity represents a part of the input quantity. This method is typically used to display availability information in the context of a known order quantity, e.g. a shopping cart.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailabilityLevels", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailabilityLevels", + "returns": { + "type": "ProductAvailabilityLevels" + }, + "sections": [ + { + "body": "Returns an instance of dw.catalog.ProductAvailabilityLevels,\nwhere each available quantity represents a part of the input quantity.\nThis method is typically used to display availability information in\nthe context of a known order quantity, e.g. a shopping cart.\n\nFor example, if for a given product\nthere are 3 pieces in stock with no pre/backorder handling specified,\nand the order quantity is 10, then the return instance would have the\nfollowing state:\n\n- dw.catalog.ProductAvailabilityLevels.getInStock - 3\n- dw.catalog.ProductAvailabilityLevels.getPreorder - 0\n- dw.catalog.ProductAvailabilityLevels.getBackorder - 0\n- dw.catalog.ProductAvailabilityLevels.getNotAvailable - 7\n\nThe following assertions can be made about the state of the returned instance.\n\n- Between 1 and 3 levels are non-zero.\n- The sum of the levels equals the input quantity.\n- dw.catalog.ProductAvailabilityLevels.getPreorder or dw.catalog.ProductAvailabilityLevels.getBackorder may be available, but not both.\n\nProduct bundles are handled specially: The availability of product\nbundles is calculated based on the availability of the bundled products.\nTherefore, if a bundle contains products that are not in stock, then\nthe bundle itself is not in stock. If all the products in the bundle\nare on backorder, then the bundle itself is backordered. If a product\nbundle has its own inventory record, then this record may\nfurther limit the availability. If a bundle has no record, then\nonly the records of the bundled products are considered.\n\nProduct masters and product sets without an own inventory record are\nhandled specially too: The availability is calculated based on the\navailability of the variants or set products. A product master or product\nset is in stock as soon as one of its variants or set products is in stock.\nEach product master or product set availability level reflects the sum of\nthe variant or set product availability levels up to the specified quantity.\n\nProduct masters or product sets with own inventory record are handled like\nstandard products. The availability of the variants or set products is not\nconsidered. (Such an inventory scenario should be avoided.)\n\nOffline products are always unavailable and will result in returned\nlevels that are all unavailable.\n\nWhen using Omnichannel Inventory (OCI), future restocks provided by OCI are mapped to\nProductAvailabilityModel.AVAILABILITY_STATUS_BACKORDER. For more information, see the comments for\ndw.catalog.ProductInventoryRecord.", + "heading": "Description" + } + ], + "signature": "getAvailabilityLevels(quantity: number): ProductAvailabilityLevels", + "source": "script-api", + "tags": [ + "getavailabilitylevels", + "productavailabilitymodel.getavailabilitylevels" + ], + "throws": [ + { + "description": "if the specified quantity is less or equal than zero", + "type": "IllegalArgumentException" + } + ], + "title": "ProductAvailabilityModel.getAvailabilityLevels" + }, + { + "description": "Returns the availability-status for the minimum-orderable-quantity (MOQ) of the product. The MOQ essentially represents a single orderable unit, and therefore can be represented by a single availability-status. This method is essentially a convenience method. The same information can be retrieved by calling getAvailabilityLevels with the MOQ of the product as the parameter and then retrieving the single status from the returned map.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getAvailabilityStatus", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getAvailabilityStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the availability-status for the minimum-orderable-quantity (MOQ) of\nthe product. The MOQ essentially represents a single orderable unit, and\ntherefore can be represented by a single availability-status. This\nmethod is essentially a convenience method. The same information\ncan be retrieved by calling getAvailabilityLevels\nwith the MOQ of the product as the parameter and then retrieving the\nsingle status from the returned map.\n\nThis method is typically used to display a product's availability in\nthe catalog when the order quantity is not known.", + "heading": "Description" + } + ], + "signature": "getAvailabilityStatus(): string", + "source": "script-api", + "tags": [ + "getavailabilitystatus", + "productavailabilitymodel.getavailabilitystatus" + ], + "title": "ProductAvailabilityModel.getAvailabilityStatus" + }, + { + "description": "Returns the ProductInventoryRecord for the Product associated with this model.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getInventoryRecord", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getInventoryRecord", + "returns": { + "type": "ProductInventoryRecord | null" + }, + "sections": [ + { + "body": "Returns the ProductInventoryRecord for the Product associated\nwith this model.", + "heading": "Description" + } + ], + "signature": "getInventoryRecord(): ProductInventoryRecord | null", + "source": "script-api", + "tags": [ + "getinventoryrecord", + "productavailabilitymodel.getinventoryrecord" + ], + "title": "ProductAvailabilityModel.getInventoryRecord" + }, + { + "description": "Returns the SKU coverage of the product. The basic formula for a master product is the ratio of online variations that are in stock to the total number of online variations. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getSKUCoverage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getSKUCoverage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the SKU coverage of the product. The basic formula for a\nmaster product is the ratio of online variations that are in stock\nto the total number of online variations. The following specific rules\napply for standard products:\n\n- If the product is in stock this method returns the availability of the product.\n- If the product is out of stock this method returns 0.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the average SKU coverage\nof its online variations.\n- For a master product with no online variations this method returns 0.\n- For a product set this method returns the ratio of orderable SKUs in the product set\nover the total number of online SKUs in the product set.\n- For a product set with no online products this method returns 0.\n- For a product bundle this method returns 1 if all of the bundled\nproducts are online, and 0 otherwise.\n- For a product bundle with no online bundled products this method\nreturns 0.", + "heading": "Description" + } + ], + "signature": "getSKUCoverage(): number", + "source": "script-api", + "tags": [ + "getskucoverage", + "productavailabilitymodel.getskucoverage" + ], + "title": "ProductAvailabilityModel.getSKUCoverage" + }, + { + "description": "Returns the number of hours before the product is expected to go out of stock. The basic formula is the ATS quantity divided by the sales velocity for the most recent day. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#getTimeToOutOfStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.getTimeToOutOfStock", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of hours before the product is expected to go out\nof stock. The basic formula is the ATS quantity divided by the\nsales velocity for the most recent day. The following specific rules\napply for standard products:\n\n- If the product is out of stock this method returns 0.\n- If the product is perpetually available this method returns 1.\n- If the sales velocity or ATS is not available this method returns 0.\n- Otherwise this method returns ATS / sales velocity.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the greatest time to out\nof stock of its online variations.\n- For a master product with no online variations this method returns 0.\n- For a product set this method returns the greatest time to out\nof stock of the online products in the set.\n- For a product set with no online products this method returns 0.\n- For a bundle with no product inventory record, this method returns\nthe least time to out of stock of the online bundled products.\n- For a bundle with no product inventory record, and no online\nbundled products, this method returns 0.", + "heading": "Description" + } + ], + "signature": "getTimeToOutOfStock(): number", + "source": "script-api", + "tags": [ + "gettimetooutofstock", + "productavailabilitymodel.gettimetooutofstock" + ], + "title": "ProductAvailabilityModel.getTimeToOutOfStock" + }, + { + "description": "Convenience method for isInStock. Returns true, if the Product is available in the minimum-order-quantity. If the product does not have a minimum-order-quantity defined, in-stock is checked for a quantity value 1.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#inStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.inStock", + "sections": [ + { + "body": "Convenience method for isInStock. Returns true, if the\nProduct is available in the minimum-order-quantity. If the product does\nnot have a minimum-order-quantity defined, in-stock is checked for a\nquantity value 1.", + "heading": "Description" + } + ], + "signature": "readonly inStock: boolean", + "source": "script-api", + "tags": [ + "instock", + "productavailabilitymodel.instock" + ], + "title": "ProductAvailabilityModel.inStock" + }, + { + "description": "Returns the ProductInventoryRecord for the Product associated with this model.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#inventoryRecord", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.inventoryRecord", + "sections": [ + { + "body": "Returns the ProductInventoryRecord for the Product associated\nwith this model.", + "heading": "Description" + } + ], + "signature": "readonly inventoryRecord: ProductInventoryRecord | null", + "source": "script-api", + "tags": [ + "inventoryrecord", + "productavailabilitymodel.inventoryrecord" + ], + "title": "ProductAvailabilityModel.inventoryRecord" + }, + { + "description": "Returns true if the Product is in-stock in the given quantity. This is determined as follows:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#isInStock", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isInStock", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the Product is in-stock in the given quantity. This is\ndetermined as follows:\n\n- If the product is not currently online (based on its online flag and\nonline dates), then return false.\n- If there is no inventory-list for the current site, then return\nfalse.\n- If there is no inventory-record for the product, then return the\ndefault setting on the inventory-list.\n- If there is no allocation-amount on the inventory-record, then return\nthe value of the perpetual-flag.\n- If there is an allocation-amount, but the perpetual-flag is true,\nthen return true.\n- If the quantity is less than or equal to the stock-level, then return\ntrue.\n- Otherwise return false.", + "heading": "Description" + } + ], + "signature": "isInStock(quantity: number): boolean", + "source": "script-api", + "tags": [ + "isinstock", + "productavailabilitymodel.isinstock" + ], + "throws": [ + { + "description": "if the specified quantity is less or equal than zero", + "type": "Exception" + } + ], + "title": "ProductAvailabilityModel.isInStock" + }, + { + "description": "Convenience method for isInStock. Returns true, if the Product is available in the minimum-order-quantity. If the product does not have a minimum-order-quantity defined, in-stock is checked for a quantity value 1.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#isInStock", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isInStock", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Convenience method for isInStock. Returns true, if the\nProduct is available in the minimum-order-quantity. If the product does\nnot have a minimum-order-quantity defined, in-stock is checked for a\nquantity value 1.", + "heading": "Description" + } + ], + "signature": "isInStock(): boolean", + "source": "script-api", + "tags": [ + "isinstock", + "productavailabilitymodel.isinstock" + ], + "title": "ProductAvailabilityModel.isInStock" + }, + { + "description": "Returns true if the Product is currently online (based on its online flag and online dates) and the specified quantity does not exceed the quantity available for sale, and returns false otherwise.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#isOrderable", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isOrderable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the Product is currently online (based on its online flag\nand online dates) and the specified quantity does not exceed the quantity\navailable for sale, and returns false otherwise.\n\nNote: Orderable status is more general than in-stock status. A product\nmay be out-of-stock but orderable because it is back-orderable or\npre-orderable.", + "heading": "Description" + } + ], + "signature": "isOrderable(quantity: number): boolean", + "source": "script-api", + "tags": [ + "isorderable", + "productavailabilitymodel.isorderable" + ], + "throws": [ + { + "description": "if the specified quantity is less or equal than zero", + "type": "Exception" + } + ], + "title": "ProductAvailabilityModel.isOrderable" + }, + { + "description": "Convenience method for isOrderable. Returns true if the Product is currently online (based on its online flag and online dates) and is orderable in its minimum-order-quantity. If the product does not have a minimum-order-quantity specified, then 1 is used. The method returns false otherwise.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#isOrderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.isOrderable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Convenience method for isOrderable. Returns true if the\nProduct is currently online (based on its online flag and online dates)\nand is orderable in its minimum-order-quantity. If the product does not\nhave a minimum-order-quantity specified, then 1 is used. The method\nreturns false otherwise.\n\nNote: Orderable status is more general than in-stock status. A product\nmay be out-of-stock but orderable because it is back-orderable or\npre-orderable.", + "heading": "Description" + } + ], + "signature": "isOrderable(): boolean", + "source": "script-api", + "tags": [ + "isorderable", + "productavailabilitymodel.isorderable" + ], + "title": "ProductAvailabilityModel.isOrderable" + }, + { + "description": "Convenience method for isOrderable. Returns true if the Product is currently online (based on its online flag and online dates) and is orderable in its minimum-order-quantity. If the product does not have a minimum-order-quantity specified, then 1 is used. The method returns false otherwise.", + "id": "script-api:dw/catalog/ProductAvailabilityModel#orderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.orderable", + "sections": [ + { + "body": "Convenience method for isOrderable. Returns true if the\nProduct is currently online (based on its online flag and online dates)\nand is orderable in its minimum-order-quantity. If the product does not\nhave a minimum-order-quantity specified, then 1 is used. The method\nreturns false otherwise.\n\nNote: Orderable status is more general than in-stock status. A product\nmay be out-of-stock but orderable because it is back-orderable or\npre-orderable.", + "heading": "Description" + } + ], + "signature": "readonly orderable: boolean", + "source": "script-api", + "tags": [ + "orderable", + "productavailabilitymodel.orderable" + ], + "title": "ProductAvailabilityModel.orderable" + }, + { + "description": "Returns the number of hours before the product is expected to go out of stock. The basic formula is the ATS quantity divided by the sales velocity for the most recent day. The following specific rules apply for standard products:", + "id": "script-api:dw/catalog/ProductAvailabilityModel#timeToOutOfStock", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductAvailabilityModel", + "qualifiedName": "dw.catalog.ProductAvailabilityModel.timeToOutOfStock", + "sections": [ + { + "body": "Returns the number of hours before the product is expected to go out\nof stock. The basic formula is the ATS quantity divided by the\nsales velocity for the most recent day. The following specific rules\napply for standard products:\n\n- If the product is out of stock this method returns 0.\n- If the product is perpetually available this method returns 1.\n- If the sales velocity or ATS is not available this method returns 0.\n- Otherwise this method returns ATS / sales velocity.\n\nThe following rules apply for special product types:\n\n- For a master product this method returns the greatest time to out\nof stock of its online variations.\n- For a master product with no online variations this method returns 0.\n- For a product set this method returns the greatest time to out\nof stock of the online products in the set.\n- For a product set with no online products this method returns 0.\n- For a bundle with no product inventory record, this method returns\nthe least time to out of stock of the online bundled products.\n- For a bundle with no product inventory record, and no online\nbundled products, this method returns 0.", + "heading": "Description" + } + ], + "signature": "readonly timeToOutOfStock: number", + "source": "script-api", + "tags": [ + "timetooutofstock", + "productavailabilitymodel.timetooutofstock" + ], + "title": "ProductAvailabilityModel.timeToOutOfStock" + }, + { + "description": "The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. Furthermore inventory records can be accessed by product or product ID.", + "id": "script-api:dw/catalog/ProductInventoryList", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryList", + "sections": [ + { + "body": "The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. Furthermore inventory\nrecords can be accessed by product or product ID.\n\nWhen using Omnichannel Inventory (OCI):\n\n- B2C Commerce uses ProductInventoryLists to reference and expose OCI Locations and Location Groups. They're\nrequired for synchronizing availability data and creating reservations.\n- Create a ProductInventoryList in B2C Commerce for each OCI Location and Location Group that B2C Commerce will\naccess. The ProductInventoryList ID must match the External Reference field on the corresponding Location or Location\nGroup.\n- A ProductInventoryList ID/External Reference must have between 2 and 128 characters (inclusive). It can include\nonly lowercase letters, uppercase letters, digits, hyphens, and underscores.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productinventorylist", + "dw.catalog.productinventorylist", + "dw/catalog" + ], + "title": "ProductInventoryList" + }, + { + "description": "Returns the ID of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.ID", + "sections": [ + { + "body": "Returns the ID of the inventory list.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productinventorylist.id" + ], + "title": "ProductInventoryList.ID" + }, + { + "description": "Returns the default in-stock flag of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#defaultInStockFlag", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.defaultInStockFlag", + "sections": [ + { + "body": "Returns the default in-stock flag of the inventory list.", + "heading": "Description" + } + ], + "signature": "readonly defaultInStockFlag: boolean", + "source": "script-api", + "tags": [ + "defaultinstockflag", + "productinventorylist.defaultinstockflag" + ], + "title": "ProductInventoryList.defaultInStockFlag" + }, + { + "description": "Returns the description of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.description", + "sections": [ + { + "body": "Returns the description of the inventory list.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "productinventorylist.description" + ], + "title": "ProductInventoryList.description" + }, + { + "description": "Returns the default in-stock flag of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#getDefaultInStockFlag", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getDefaultInStockFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the default in-stock flag of the inventory list.", + "heading": "Description" + } + ], + "signature": "getDefaultInStockFlag(): boolean", + "source": "script-api", + "tags": [ + "getdefaultinstockflag", + "productinventorylist.getdefaultinstockflag" + ], + "title": "ProductInventoryList.getDefaultInStockFlag" + }, + { + "description": "Returns the description of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description of the inventory list.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "productinventorylist.getdescription" + ], + "title": "ProductInventoryList.getDescription" + }, + { + "description": "Returns the ID of the inventory list.", + "id": "script-api:dw/catalog/ProductInventoryList#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the inventory list.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productinventorylist.getid" + ], + "title": "ProductInventoryList.getID" + }, + { + "description": "Returns the inventory record for the specified product or null if there is no record for the product in this list.", + "id": "script-api:dw/catalog/ProductInventoryList#getRecord", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getRecord", + "returns": { + "type": "ProductInventoryRecord | null" + }, + "sections": [ + { + "body": "Returns the inventory record for the specified product or null\nif there is no record for the product in this list.", + "heading": "Description" + } + ], + "signature": "getRecord(product: Product): ProductInventoryRecord | null", + "source": "script-api", + "tags": [ + "getrecord", + "productinventorylist.getrecord" + ], + "title": "ProductInventoryList.getRecord" + }, + { + "description": "Returns the inventory record for the specified product ID or null if there is no record for the product id in this list.", + "id": "script-api:dw/catalog/ProductInventoryList#getRecord", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryList", + "qualifiedName": "dw.catalog.ProductInventoryList.getRecord", + "returns": { + "type": "ProductInventoryRecord | null" + }, + "sections": [ + { + "body": "Returns the inventory record for the specified product ID or null\nif there is no record for the product id in this list.", + "heading": "Description" + } + ], + "signature": "getRecord(productID: string): ProductInventoryRecord | null", + "source": "script-api", + "tags": [ + "getrecord", + "productinventorylist.getrecord" + ], + "title": "ProductInventoryList.getRecord" + }, + { + "description": "This manager provides access to inventory-related objects.", + "id": "script-api:dw/catalog/ProductInventoryMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryMgr", + "sections": [ + { + "body": "This manager provides access to inventory-related objects.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productinventorymgr", + "dw.catalog.productinventorymgr", + "dw/catalog" + ], + "title": "ProductInventoryMgr" + }, + { + "description": "Integration mode 'B2C' - using B2C inventory, no integration with Omnichannel Inventory", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_B2C", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_B2C", + "sections": [ + { + "body": "Integration mode 'B2C' - using B2C inventory, no integration with Omnichannel Inventory", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_B2C = \"B2C\"", + "source": "script-api", + "tags": [ + "integrationmode_b2c", + "productinventorymgr.integrationmode_b2c" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_B2C" + }, + { + "description": "Integration mode 'B2C' - using B2C inventory, no integration with Omnichannel Inventory", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_B2C", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_B2C", + "sections": [ + { + "body": "Integration mode 'B2C' - using B2C inventory, no integration with Omnichannel Inventory", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_B2C = \"B2C\"", + "source": "script-api", + "tags": [ + "integrationmode_b2c", + "productinventorymgr.integrationmode_b2c" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_B2C" + }, + { + "description": "Integration mode 'OCI' - integration with Omnichannel Inventory enabled", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI", + "sections": [ + { + "body": "Integration mode 'OCI' - integration with Omnichannel Inventory enabled", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_OCI = \"OCI\"", + "source": "script-api", + "tags": [ + "integrationmode_oci", + "productinventorymgr.integrationmode_oci" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI" + }, + { + "description": "Integration mode 'OCI' - integration with Omnichannel Inventory enabled", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI", + "sections": [ + { + "body": "Integration mode 'OCI' - integration with Omnichannel Inventory enabled", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_OCI = \"OCI\"", + "source": "script-api", + "tags": [ + "integrationmode_oci", + "productinventorymgr.integrationmode_oci" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI" + }, + { + "description": "Integration mode 'OCI_CACHE' - using B2C inventory, initializing cache as preparation for integration with Omnichannel Inventory", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI_CACHE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE", + "sections": [ + { + "body": "Integration mode 'OCI_CACHE' - using B2C inventory, initializing cache as preparation for integration with\nOmnichannel Inventory", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_OCI_CACHE = \"OCI_CACHE\"", + "source": "script-api", + "tags": [ + "integrationmode_oci_cache", + "productinventorymgr.integrationmode_oci_cache" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE" + }, + { + "description": "Integration mode 'OCI_CACHE' - using B2C inventory, initializing cache as preparation for integration with Omnichannel Inventory", + "id": "script-api:dw/catalog/ProductInventoryMgr#INTEGRATIONMODE_OCI_CACHE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE", + "sections": [ + { + "body": "Integration mode 'OCI_CACHE' - using B2C inventory, initializing cache as preparation for integration with\nOmnichannel Inventory", + "heading": "Description" + } + ], + "signature": "static readonly INTEGRATIONMODE_OCI_CACHE = \"OCI_CACHE\"", + "source": "script-api", + "tags": [ + "integrationmode_oci_cache", + "productinventorymgr.integrationmode_oci_cache" + ], + "title": "ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE" + }, + { + "description": "Returns the current inventory integration mode as one of", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryIntegrationMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryIntegrationMode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current inventory integration mode as one of\n\n- ProductInventoryMgr.INTEGRATIONMODE_B2C\n- ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE\n- ProductInventoryMgr.INTEGRATIONMODE_OCI", + "heading": "Description" + } + ], + "signature": "static getInventoryIntegrationMode(): string", + "source": "script-api", + "tags": [ + "getinventoryintegrationmode", + "productinventorymgr.getinventoryintegrationmode" + ], + "title": "ProductInventoryMgr.getInventoryIntegrationMode" + }, + { + "description": "Returns the current inventory integration mode as one of", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryIntegrationMode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryIntegrationMode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current inventory integration mode as one of\n\n- ProductInventoryMgr.INTEGRATIONMODE_B2C\n- ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE\n- ProductInventoryMgr.INTEGRATIONMODE_OCI", + "heading": "Description" + } + ], + "signature": "static getInventoryIntegrationMode(): string", + "source": "script-api", + "tags": [ + "getinventoryintegrationmode", + "productinventorymgr.getinventoryintegrationmode" + ], + "title": "ProductInventoryMgr.getInventoryIntegrationMode" + }, + { + "description": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current site.", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current\nsite.", + "heading": "Description" + } + ], + "signature": "static getInventoryList(): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "description": "Returns the inventory list with the passed ID or null if no inventory list exists with that ID.", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "listID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list with the passed ID or null if no inventory list exists with that ID.", + "heading": "Description" + } + ], + "signature": "static getInventoryList(listID: string): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "description": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current site.", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current\nsite.", + "heading": "Description" + } + ], + "signature": "static getInventoryList(): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "description": "Returns the inventory list with the passed ID or null if no inventory list exists with that ID.", + "id": "script-api:dw/catalog/ProductInventoryMgr#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "listID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.getInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list with the passed ID or null if no inventory list exists with that ID.", + "heading": "Description" + } + ], + "signature": "static getInventoryList(listID: string): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getinventorylist", + "productinventorymgr.getinventorylist" + ], + "title": "ProductInventoryMgr.getInventoryList" + }, + { + "description": "Returns the current inventory integration mode as one of", + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryIntegrationMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryIntegrationMode", + "sections": [ + { + "body": "Returns the current inventory integration mode as one of\n\n- ProductInventoryMgr.INTEGRATIONMODE_B2C\n- ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE\n- ProductInventoryMgr.INTEGRATIONMODE_OCI", + "heading": "Description" + } + ], + "signature": "static readonly inventoryIntegrationMode: string", + "source": "script-api", + "tags": [ + "inventoryintegrationmode", + "productinventorymgr.inventoryintegrationmode" + ], + "title": "ProductInventoryMgr.inventoryIntegrationMode" + }, + { + "description": "Returns the current inventory integration mode as one of", + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryIntegrationMode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryIntegrationMode", + "sections": [ + { + "body": "Returns the current inventory integration mode as one of\n\n- ProductInventoryMgr.INTEGRATIONMODE_B2C\n- ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE\n- ProductInventoryMgr.INTEGRATIONMODE_OCI", + "heading": "Description" + } + ], + "signature": "static readonly inventoryIntegrationMode: string", + "source": "script-api", + "tags": [ + "inventoryintegrationmode", + "productinventorymgr.inventoryintegrationmode" + ], + "title": "ProductInventoryMgr.inventoryIntegrationMode" + }, + { + "description": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current site.", + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryList", + "sections": [ + { + "body": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current\nsite.", + "heading": "Description" + } + ], + "signature": "static readonly inventoryList: ProductInventoryList | null", + "source": "script-api", + "tags": [ + "inventorylist", + "productinventorymgr.inventorylist" + ], + "title": "ProductInventoryMgr.inventoryList" + }, + { + "description": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current site.", + "id": "script-api:dw/catalog/ProductInventoryMgr#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryMgr", + "qualifiedName": "dw.catalog.ProductInventoryMgr.inventoryList", + "sections": [ + { + "body": "Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current\nsite.", + "heading": "Description" + } + ], + "signature": "static readonly inventoryList: ProductInventoryList | null", + "source": "script-api", + "tags": [ + "inventorylist", + "productinventorymgr.inventorylist" + ], + "title": "ProductInventoryMgr.inventoryList" + }, + { + "description": "The ProductInventoryRecord holds information about a Product's inventory, and availability.", + "id": "script-api:dw/catalog/ProductInventoryRecord", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductInventoryRecord", + "sections": [ + { + "body": "The ProductInventoryRecord holds information about a Product's inventory, and availability.\n\nWhen using Omnichannel Inventory (OCI):\n\n- All ProductInventoryRecord properties are read-only. Calling any setter method throws an\nIllegalStateException.\n- The ProductInventoryRecord class does not support custom properties.\n- isPerpetual and isPreorderable always return false.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productinventoryrecord", + "dw.catalog.productinventoryrecord", + "dw/catalog" + ], + "title": "ProductInventoryRecord" + }, + { + "description": "Returns the quantity of items available to sell (ATS). This is calculated as the allocation (getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus the turnover (getTurnover) minus the on order quantity (getOnOrder).", + "id": "script-api:dw/catalog/ProductInventoryRecord#ATS", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.ATS", + "sections": [ + { + "body": "Returns the quantity of items available to sell (ATS). This is calculated as the allocation\n(getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus\nthe turnover (getTurnover) minus the on order quantity (getOnOrder).\n\nWhen using OCI, corresponds to the ATO (Available To Order) quantity in OCI.", + "heading": "Description" + } + ], + "signature": "readonly ATS: Quantity", + "source": "script-api", + "tags": [ + "ats", + "productinventoryrecord.ats" + ], + "title": "ProductInventoryRecord.ATS" + }, + { + "description": "Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.", + "id": "script-api:dw/catalog/ProductInventoryRecord#allocation", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.allocation", + "sections": [ + { + "body": "Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.\n\nWhen using OCI, returns the physically available quantity. Corresponds to the On Hand quantity in OCI.", + "heading": "Description" + } + ], + "signature": "allocation: Quantity", + "source": "script-api", + "tags": [ + "allocation", + "productinventoryrecord.allocation" + ], + "title": "ProductInventoryRecord.allocation" + }, + { + "description": "Returns the date the allocation quantity was initialized or reset.", + "id": "script-api:dw/catalog/ProductInventoryRecord#allocationResetDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.allocationResetDate", + "sections": [ + { + "body": "Returns the date the allocation quantity was initialized or reset.\n\nWhen using OCI, corresponds to the Effective Date in OCI. The value can be null.", + "heading": "Description" + } + ], + "signature": "readonly allocationResetDate: Date", + "source": "script-api", + "tags": [ + "allocationresetdate", + "productinventoryrecord.allocationresetdate" + ], + "title": "ProductInventoryRecord.allocationResetDate" + }, + { + "description": "Determines if the product is backorderable.", + "id": "script-api:dw/catalog/ProductInventoryRecord#backorderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.backorderable", + "sections": [ + { + "body": "Determines if the product is backorderable.\n\nWhen using OCI, returns true if the product has at least one Future quantity in OCI.", + "heading": "Description" + } + ], + "signature": "backorderable: boolean", + "source": "script-api", + "tags": [ + "backorderable", + "productinventoryrecord.backorderable" + ], + "title": "ProductInventoryRecord.backorderable" + }, + { + "description": "Returns the meta data of this object. If no meta data is available the method returns null. The returned ObjectTypeDefinition can be used to retrieve the metadata for any of the custom attributes.", + "id": "script-api:dw/catalog/ProductInventoryRecord#describe", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.describe", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data of this object. If no meta data is available the method returns null. The returned\nObjectTypeDefinition can be used to retrieve the metadata for any of the custom attributes.\n\nWhen using Omnichannel Inventory (OCI), this class doesn't support custom attributes. If OCI is enabled, then\nattempting to set or modify a custom attribute value throws an UnsupportedOperationException.", + "heading": "Description" + } + ], + "signature": "describe(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describe", + "productinventoryrecord.describe" + ], + "title": "ProductInventoryRecord.describe" + }, + { + "description": "Returns the quantity of items available to sell (ATS). This is calculated as the allocation (getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus the turnover (getTurnover) minus the on order quantity (getOnOrder).", + "id": "script-api:dw/catalog/ProductInventoryRecord#getATS", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getATS", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of items available to sell (ATS). This is calculated as the allocation\n(getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus\nthe turnover (getTurnover) minus the on order quantity (getOnOrder).\n\nWhen using OCI, corresponds to the ATO (Available To Order) quantity in OCI.", + "heading": "Description" + } + ], + "signature": "getATS(): Quantity", + "source": "script-api", + "tags": [ + "getats", + "productinventoryrecord.getats" + ], + "title": "ProductInventoryRecord.getATS" + }, + { + "description": "Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getAllocation", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.\n\nWhen using OCI, returns the physically available quantity. Corresponds to the On Hand quantity in OCI.", + "heading": "Description" + } + ], + "signature": "getAllocation(): Quantity", + "source": "script-api", + "tags": [ + "getallocation", + "productinventoryrecord.getallocation" + ], + "title": "ProductInventoryRecord.getAllocation" + }, + { + "description": "Returns the date the allocation quantity was initialized or reset.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getAllocationResetDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getAllocationResetDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date the allocation quantity was initialized or reset.\n\nWhen using OCI, corresponds to the Effective Date in OCI. The value can be null.", + "heading": "Description" + } + ], + "signature": "getAllocationResetDate(): Date", + "source": "script-api", + "tags": [ + "getallocationresetdate", + "productinventoryrecord.getallocationresetdate" + ], + "title": "ProductInventoryRecord.getAllocationResetDate" + }, + { + "description": "Returns the date that the item is expected to be in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getInStockDate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getInStockDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date that the item is expected to be in stock.\n\nWhen using OCI, returns the date of the earliest Future quantity. If the product has no Future quantities, it\nreturns null.", + "heading": "Description" + } + ], + "signature": "getInStockDate(): Date", + "source": "script-api", + "tags": [ + "getinstockdate", + "productinventoryrecord.getinstockdate" + ], + "title": "ProductInventoryRecord.getInStockDate" + }, + { + "deprecated": { + "message": "Use getStockLevel instead." + }, + "description": "Returns the on-hand quantity, the actual quantity of available (on-hand) items.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getOnHand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getOnHand", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the on-hand quantity, the actual quantity of available (on-hand) items.", + "heading": "Description" + } + ], + "signature": "getOnHand(): Quantity", + "source": "script-api", + "tags": [ + "getonhand", + "productinventoryrecord.getonhand" + ], + "title": "ProductInventoryRecord.getOnHand" + }, + { + "description": "Returns the quantity that is currently on order.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getOnOrder", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getOnOrder", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity that is currently on order.\n\nThis is only relevant when On Order Inventory is turned on for the related inventory list. On Order is a bucket\nof inventory used for the time between order creation and order export to external (warehouse) systems. On Order\nvalue is increased when an order is created. It will be decreased and with that turnover will be increased when\nthe order is exported, see getTurnover. Notice that dw.order.Order.setExportStatus and\ndw.order.OrderItem.allocateInventory will decrease the On Order value. On order will be included\nin the ATS calculation, see getATS.\n\nWhen using OCI, always returns zero. OCI doesn't support On Order inventory.", + "heading": "Description" + } + ], + "signature": "getOnOrder(): Quantity", + "source": "script-api", + "tags": [ + "getonorder", + "productinventoryrecord.getonorder" + ], + "title": "ProductInventoryRecord.getOnOrder" + }, + { + "description": "Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getPreorderBackorderAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getPreorderBackorderAllocation", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.\n\nWhen using OCI, returns the sum of all Future quantities. If the product has no Future quantities, it returns\nzero.", + "heading": "Description" + } + ], + "signature": "getPreorderBackorderAllocation(): Quantity", + "source": "script-api", + "tags": [ + "getpreorderbackorderallocation", + "productinventoryrecord.getpreorderbackorderallocation" + ], + "title": "ProductInventoryRecord.getPreorderBackorderAllocation" + }, + { + "description": "Returns the quantity of items that are reserved.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getReserved", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getReserved", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of items that are reserved.\n\nNote that for products with high velocity and concurrency, the return value is extremely volatile and the\nretrieval will be expensive.\n\nWhen using OCI, always returns zero.", + "heading": "Description" + } + ], + "signature": "getReserved(): Quantity", + "source": "script-api", + "tags": [ + "getreserved", + "productinventoryrecord.getreserved" + ], + "title": "ProductInventoryRecord.getReserved" + }, + { + "description": "Returns the current stock level. This is calculated as the allocation minus the turnover.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getStockLevel", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getStockLevel", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the current stock level. This is calculated as the allocation minus the turnover.\n\nWhen using OCI, corresponds to the ATF (Available To Fulfill) quantity in OCI.", + "heading": "Description" + } + ], + "signature": "getStockLevel(): Quantity", + "source": "script-api", + "tags": [ + "getstocklevel", + "productinventoryrecord.getstocklevel" + ], + "title": "ProductInventoryRecord.getStockLevel" + }, + { + "description": "Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset date. If the total decremented quantity is greater than the total incremented quantity, then this value is negative.", + "id": "script-api:dw/catalog/ProductInventoryRecord#getTurnover", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.getTurnover", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset\ndate. If the total decremented quantity is greater than the total incremented quantity, then this value is\nnegative.\n\nWhen using OCI, returns the total reserved quantity, including order, basket, and temporary reservations.", + "heading": "Description" + } + ], + "signature": "getTurnover(): Quantity", + "source": "script-api", + "tags": [ + "getturnover", + "productinventoryrecord.getturnover" + ], + "title": "ProductInventoryRecord.getTurnover" + }, + { + "description": "Returns the date that the item is expected to be in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#inStockDate", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.inStockDate", + "sections": [ + { + "body": "Returns the date that the item is expected to be in stock.\n\nWhen using OCI, returns the date of the earliest Future quantity. If the product has no Future quantities, it\nreturns null.", + "heading": "Description" + } + ], + "signature": "inStockDate: Date", + "source": "script-api", + "tags": [ + "instockdate", + "productinventoryrecord.instockdate" + ], + "title": "ProductInventoryRecord.inStockDate" + }, + { + "description": "Determines if the product is backorderable.", + "id": "script-api:dw/catalog/ProductInventoryRecord#isBackorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isBackorderable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines if the product is backorderable.\n\nWhen using OCI, returns true if the product has at least one Future quantity in OCI.", + "heading": "Description" + } + ], + "signature": "isBackorderable(): boolean", + "source": "script-api", + "tags": [ + "isbackorderable", + "productinventoryrecord.isbackorderable" + ], + "title": "ProductInventoryRecord.isBackorderable" + }, + { + "description": "Determines if the product is perpetually in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#isPerpetual", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isPerpetual", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines if the product is perpetually in stock.\n\nWhen using OCI, always returns false.", + "heading": "Description" + } + ], + "signature": "isPerpetual(): boolean", + "source": "script-api", + "tags": [ + "isperpetual", + "productinventoryrecord.isperpetual" + ], + "title": "ProductInventoryRecord.isPerpetual" + }, + { + "description": "Determines if the product is preorderable.", + "id": "script-api:dw/catalog/ProductInventoryRecord#isPreorderable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.isPreorderable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines if the product is preorderable.\n\nWhen using OCI, always returns false.", + "heading": "Description" + } + ], + "signature": "isPreorderable(): boolean", + "source": "script-api", + "tags": [ + "ispreorderable", + "productinventoryrecord.ispreorderable" + ], + "title": "ProductInventoryRecord.isPreorderable" + }, + { + "deprecated": { + "message": "Use getStockLevel instead." + }, + "description": "Returns the on-hand quantity, the actual quantity of available (on-hand) items.", + "id": "script-api:dw/catalog/ProductInventoryRecord#onHand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.onHand", + "sections": [ + { + "body": "Returns the on-hand quantity, the actual quantity of available (on-hand) items.", + "heading": "Description" + } + ], + "signature": "readonly onHand: Quantity", + "source": "script-api", + "tags": [ + "onhand", + "productinventoryrecord.onhand" + ], + "title": "ProductInventoryRecord.onHand" + }, + { + "description": "Returns the quantity that is currently on order.", + "id": "script-api:dw/catalog/ProductInventoryRecord#onOrder", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.onOrder", + "sections": [ + { + "body": "Returns the quantity that is currently on order.\n\nThis is only relevant when On Order Inventory is turned on for the related inventory list. On Order is a bucket\nof inventory used for the time between order creation and order export to external (warehouse) systems. On Order\nvalue is increased when an order is created. It will be decreased and with that turnover will be increased when\nthe order is exported, see getTurnover. Notice that dw.order.Order.setExportStatus and\ndw.order.OrderItem.allocateInventory will decrease the On Order value. On order will be included\nin the ATS calculation, see getATS.\n\nWhen using OCI, always returns zero. OCI doesn't support On Order inventory.", + "heading": "Description" + } + ], + "signature": "readonly onOrder: Quantity", + "source": "script-api", + "tags": [ + "onorder", + "productinventoryrecord.onorder" + ], + "title": "ProductInventoryRecord.onOrder" + }, + { + "description": "Determines if the product is perpetually in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#perpetual", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.perpetual", + "sections": [ + { + "body": "Determines if the product is perpetually in stock.\n\nWhen using OCI, always returns false.", + "heading": "Description" + } + ], + "signature": "perpetual: boolean", + "source": "script-api", + "tags": [ + "perpetual", + "productinventoryrecord.perpetual" + ], + "title": "ProductInventoryRecord.perpetual" + }, + { + "description": "Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.", + "id": "script-api:dw/catalog/ProductInventoryRecord#preorderBackorderAllocation", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.preorderBackorderAllocation", + "sections": [ + { + "body": "Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.\n\nWhen using OCI, returns the sum of all Future quantities. If the product has no Future quantities, it returns\nzero.", + "heading": "Description" + } + ], + "signature": "preorderBackorderAllocation: Quantity", + "source": "script-api", + "tags": [ + "preorderbackorderallocation", + "productinventoryrecord.preorderbackorderallocation" + ], + "title": "ProductInventoryRecord.preorderBackorderAllocation" + }, + { + "description": "Determines if the product is preorderable.", + "id": "script-api:dw/catalog/ProductInventoryRecord#preorderable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.preorderable", + "sections": [ + { + "body": "Determines if the product is preorderable.\n\nWhen using OCI, always returns false.", + "heading": "Description" + } + ], + "signature": "preorderable: boolean", + "source": "script-api", + "tags": [ + "preorderable", + "productinventoryrecord.preorderable" + ], + "title": "ProductInventoryRecord.preorderable" + }, + { + "description": "Returns the quantity of items that are reserved.", + "id": "script-api:dw/catalog/ProductInventoryRecord#reserved", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.reserved", + "sections": [ + { + "body": "Returns the quantity of items that are reserved.\n\nNote that for products with high velocity and concurrency, the return value is extremely volatile and the\nretrieval will be expensive.\n\nWhen using OCI, always returns zero.", + "heading": "Description" + } + ], + "signature": "readonly reserved: Quantity", + "source": "script-api", + "tags": [ + "reserved", + "productinventoryrecord.reserved" + ], + "title": "ProductInventoryRecord.reserved" + }, + { + "description": "Sets the allocation quantity. This also updates the allocation reset date.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setAllocation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the allocation quantity. This also updates the allocation reset date.\n\nAll final reservations will be considered as expired and will therefore no longer be considered for ATS.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.", + "heading": "Description" + } + ], + "signature": "setAllocation(quantity: number): void", + "source": "script-api", + "tags": [ + "setallocation", + "productinventoryrecord.setallocation" + ], + "title": "ProductInventoryRecord.setAllocation" + }, + { + "description": "Sets the allocation quantity. This also updates the allocation reset date.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + }, + { + "name": "allocationResetDate", + "type": "Date" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setAllocation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the allocation quantity. This also updates the allocation reset date.\n\nAny final reservations made prior to the allocation reset date will be considered as expired and will therefore\nno longer be considered for ATS.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method must not be called within a storefront request.", + "heading": "Description" + } + ], + "signature": "setAllocation(quantity: number, allocationResetDate: Date): void", + "source": "script-api", + "tags": [ + "setallocation", + "productinventoryrecord.setallocation" + ], + "title": "ProductInventoryRecord.setAllocation" + }, + { + "description": "The method is used to set whether the product is backorderable. Setting the backorderable flag to true will clear the preorderable flag. If the record's preorderable flag is set to true, calling this method with backorderableFlag==false will have no effect.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setBackorderable", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "backorderableFlag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setBackorderable", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method is used to set whether the product is backorderable. Setting the backorderable flag to true will clear\nthe preorderable flag. If the record's preorderable flag is set to true, calling this method with\nbackorderableFlag==false will have no effect.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.\n\nThis method must not be called within a storefront request when the API version is 21.7 or later.", + "heading": "Description" + } + ], + "signature": "setBackorderable(backorderableFlag: boolean): void", + "source": "script-api", + "tags": [ + "setbackorderable", + "productinventoryrecord.setbackorderable" + ], + "title": "ProductInventoryRecord.setBackorderable" + }, + { + "description": "Sets the date that the item is expected to be in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setInStockDate", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "inStockDate", + "type": "Date" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setInStockDate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the date that the item is expected to be in stock.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.\n\nThis method must not be called within a storefront request when the API version is 21.7 or later.", + "heading": "Description" + } + ], + "signature": "setInStockDate(inStockDate: Date): void", + "source": "script-api", + "tags": [ + "setinstockdate", + "productinventoryrecord.setinstockdate" + ], + "title": "ProductInventoryRecord.setInStockDate" + }, + { + "description": "Sets if the product is perpetually in stock.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setPerpetual", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "perpetualFlag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPerpetual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets if the product is perpetually in stock.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.\n\nThis method must not be called within a storefront request when the API version is 21.7 or later.", + "heading": "Description" + } + ], + "signature": "setPerpetual(perpetualFlag: boolean): void", + "source": "script-api", + "tags": [ + "setperpetual", + "productinventoryrecord.setperpetual" + ], + "title": "ProductInventoryRecord.setPerpetual" + }, + { + "description": "Sets the quantity of items that are allocated for sale, beyond the initial stock allocation.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setPreorderBackorderAllocation", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPreorderBackorderAllocation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the quantity of items that are allocated for sale, beyond the initial stock allocation.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.\n\nThis method must not be called within a storefront request when the API version is 21.7 or later.", + "heading": "Description" + } + ], + "signature": "setPreorderBackorderAllocation(quantity: number): void", + "source": "script-api", + "tags": [ + "setpreorderbackorderallocation", + "productinventoryrecord.setpreorderbackorderallocation" + ], + "title": "ProductInventoryRecord.setPreorderBackorderAllocation" + }, + { + "description": "The method is used to set whether the product is preorderable. Setting the preorderable flag to true will clear the backorderable flag. If the record's backorderable flag is set to true, calling this method with preorderableFlag==false will have no effect.", + "id": "script-api:dw/catalog/ProductInventoryRecord#setPreorderable", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "preorderableFlag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.setPreorderable", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method is used to set whether the product is preorderable. Setting the preorderable flag to true will clear\nthe backorderable flag. If the record's backorderable flag is set to true, calling this method with\npreorderableFlag==false will have no effect.\n\nWhen using OCI, throws an IllegalStateException.\n\nThis method should not be called within a storefront request.\n\nThis method must not be called within a storefront request when the API version is 21.7 or later.", + "heading": "Description" + } + ], + "signature": "setPreorderable(preorderableFlag: boolean): void", + "source": "script-api", + "tags": [ + "setpreorderable", + "productinventoryrecord.setpreorderable" + ], + "title": "ProductInventoryRecord.setPreorderable" + }, + { + "description": "Returns the current stock level. This is calculated as the allocation minus the turnover.", + "id": "script-api:dw/catalog/ProductInventoryRecord#stockLevel", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.stockLevel", + "sections": [ + { + "body": "Returns the current stock level. This is calculated as the allocation minus the turnover.\n\nWhen using OCI, corresponds to the ATF (Available To Fulfill) quantity in OCI.", + "heading": "Description" + } + ], + "signature": "readonly stockLevel: Quantity", + "source": "script-api", + "tags": [ + "stocklevel", + "productinventoryrecord.stocklevel" + ], + "title": "ProductInventoryRecord.stockLevel" + }, + { + "description": "Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset date. If the total decremented quantity is greater than the total incremented quantity, then this value is negative.", + "id": "script-api:dw/catalog/ProductInventoryRecord#turnover", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductInventoryRecord", + "qualifiedName": "dw.catalog.ProductInventoryRecord.turnover", + "sections": [ + { + "body": "Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset\ndate. If the total decremented quantity is greater than the total incremented quantity, then this value is\nnegative.\n\nWhen using OCI, returns the total reserved quantity, including order, basket, and temporary reservations.", + "heading": "Description" + } + ], + "signature": "readonly turnover: Quantity", + "source": "script-api", + "tags": [ + "turnover", + "productinventoryrecord.turnover" + ], + "title": "ProductInventoryRecord.turnover" + }, + { + "description": "The class represents a link between two products.", + "id": "script-api:dw/catalog/ProductLink", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductLink", + "sections": [ + { + "body": "The class represents a link between two products.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productlink", + "dw.catalog.productlink", + "dw/catalog" + ], + "title": "ProductLink" + }, + { + "description": "Represents an accessory product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ACCESSORY", + "sections": [ + { + "body": "Represents an accessory product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ACCESSORY = 4", + "source": "script-api", + "tags": [ + "linktype_accessory", + "productlink.linktype_accessory" + ], + "title": "ProductLink.LINKTYPE_ACCESSORY" + }, + { + "description": "Represents an accessory product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ACCESSORY", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ACCESSORY", + "sections": [ + { + "body": "Represents an accessory product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ACCESSORY = 4", + "source": "script-api", + "tags": [ + "linktype_accessory", + "productlink.linktype_accessory" + ], + "title": "ProductLink.LINKTYPE_ACCESSORY" + }, + { + "description": "Represents an alternative order unit product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ALT_ORDERUNIT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ALT_ORDERUNIT", + "sections": [ + { + "body": "Represents an alternative order unit product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ALT_ORDERUNIT = 6", + "source": "script-api", + "tags": [ + "linktype_alt_orderunit", + "productlink.linktype_alt_orderunit" + ], + "title": "ProductLink.LINKTYPE_ALT_ORDERUNIT" + }, + { + "description": "Represents an alternative order unit product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_ALT_ORDERUNIT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_ALT_ORDERUNIT", + "sections": [ + { + "body": "Represents an alternative order unit product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_ALT_ORDERUNIT = 6", + "source": "script-api", + "tags": [ + "linktype_alt_orderunit", + "productlink.linktype_alt_orderunit" + ], + "title": "ProductLink.LINKTYPE_ALT_ORDERUNIT" + }, + { + "description": "Represents a cross-sell product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_CROSS_SELL = 1", + "source": "script-api", + "tags": [ + "linktype_cross_sell", + "productlink.linktype_cross_sell" + ], + "title": "ProductLink.LINKTYPE_CROSS_SELL" + }, + { + "description": "Represents a cross-sell product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_CROSS_SELL = 1", + "source": "script-api", + "tags": [ + "linktype_cross_sell", + "productlink.linktype_cross_sell" + ], + "title": "ProductLink.LINKTYPE_CROSS_SELL" + }, + { + "description": "Represents a newer verion link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_NEWER_VERSION", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_NEWER_VERSION", + "sections": [ + { + "body": "Represents a newer verion link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_NEWER_VERSION = 5", + "source": "script-api", + "tags": [ + "linktype_newer_version", + "productlink.linktype_newer_version" + ], + "title": "ProductLink.LINKTYPE_NEWER_VERSION" + }, + { + "description": "Represents a newer verion link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_NEWER_VERSION", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_NEWER_VERSION", + "sections": [ + { + "body": "Represents a newer verion link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_NEWER_VERSION = 5", + "source": "script-api", + "tags": [ + "linktype_newer_version", + "productlink.linktype_newer_version" + ], + "title": "ProductLink.LINKTYPE_NEWER_VERSION" + }, + { + "description": "Represents a miscellaneous product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_OTHER", + "sections": [ + { + "body": "Represents a miscellaneous product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_OTHER = 8", + "source": "script-api", + "tags": [ + "linktype_other", + "productlink.linktype_other" + ], + "title": "ProductLink.LINKTYPE_OTHER" + }, + { + "description": "Represents a miscellaneous product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_OTHER", + "sections": [ + { + "body": "Represents a miscellaneous product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_OTHER = 8", + "source": "script-api", + "tags": [ + "linktype_other", + "productlink.linktype_other" + ], + "title": "ProductLink.LINKTYPE_OTHER" + }, + { + "description": "Represents a replacement product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_REPLACEMENT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_REPLACEMENT", + "sections": [ + { + "body": "Represents a replacement product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_REPLACEMENT = 2", + "source": "script-api", + "tags": [ + "linktype_replacement", + "productlink.linktype_replacement" + ], + "title": "ProductLink.LINKTYPE_REPLACEMENT" + }, + { + "description": "Represents a replacement product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_REPLACEMENT", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_REPLACEMENT", + "sections": [ + { + "body": "Represents a replacement product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_REPLACEMENT = 2", + "source": "script-api", + "tags": [ + "linktype_replacement", + "productlink.linktype_replacement" + ], + "title": "ProductLink.LINKTYPE_REPLACEMENT" + }, + { + "description": "Represents a spare part product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_SPARE_PART", + "sections": [ + { + "body": "Represents a spare part product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_SPARE_PART = 7", + "source": "script-api", + "tags": [ + "linktype_spare_part", + "productlink.linktype_spare_part" + ], + "title": "ProductLink.LINKTYPE_SPARE_PART" + }, + { + "description": "Represents a spare part product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_SPARE_PART", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_SPARE_PART", + "sections": [ + { + "body": "Represents a spare part product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_SPARE_PART = 7", + "source": "script-api", + "tags": [ + "linktype_spare_part", + "productlink.linktype_spare_part" + ], + "title": "ProductLink.LINKTYPE_SPARE_PART" + }, + { + "description": "Represents an up-sell product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_UP_SELL = 3", + "source": "script-api", + "tags": [ + "linktype_up_sell", + "productlink.linktype_up_sell" + ], + "title": "ProductLink.LINKTYPE_UP_SELL" + }, + { + "description": "Represents an up-sell product link.", + "id": "script-api:dw/catalog/ProductLink#LINKTYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.LINKTYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell product link.", + "heading": "Description" + } + ], + "signature": "static readonly LINKTYPE_UP_SELL = 3", + "source": "script-api", + "tags": [ + "linktype_up_sell", + "productlink.linktype_up_sell" + ], + "title": "ProductLink.LINKTYPE_UP_SELL" + }, + { + "description": "Returns the source product for this link.", + "id": "script-api:dw/catalog/ProductLink#getSourceProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getSourceProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the source product for this link.", + "heading": "Description" + } + ], + "signature": "getSourceProduct(): Product", + "source": "script-api", + "tags": [ + "getsourceproduct", + "productlink.getsourceproduct" + ], + "title": "ProductLink.getSourceProduct" + }, + { + "description": "Returns the target product for this link.", + "id": "script-api:dw/catalog/ProductLink#getTargetProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getTargetProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the target product for this link.", + "heading": "Description" + } + ], + "signature": "getTargetProduct(): Product", + "source": "script-api", + "tags": [ + "gettargetproduct", + "productlink.gettargetproduct" + ], + "title": "ProductLink.getTargetProduct" + }, + { + "description": "Returns the type of this link (see constants).", + "id": "script-api:dw/catalog/ProductLink#getTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.getTypeCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of this link (see constants).", + "heading": "Description" + } + ], + "signature": "getTypeCode(): number", + "source": "script-api", + "tags": [ + "gettypecode", + "productlink.gettypecode" + ], + "title": "ProductLink.getTypeCode" + }, + { + "description": "Returns the source product for this link.", + "id": "script-api:dw/catalog/ProductLink#sourceProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.sourceProduct", + "sections": [ + { + "body": "Returns the source product for this link.", + "heading": "Description" + } + ], + "signature": "readonly sourceProduct: Product", + "source": "script-api", + "tags": [ + "sourceproduct", + "productlink.sourceproduct" + ], + "title": "ProductLink.sourceProduct" + }, + { + "description": "Returns the target product for this link.", + "id": "script-api:dw/catalog/ProductLink#targetProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.targetProduct", + "sections": [ + { + "body": "Returns the target product for this link.", + "heading": "Description" + } + ], + "signature": "readonly targetProduct: Product", + "source": "script-api", + "tags": [ + "targetproduct", + "productlink.targetproduct" + ], + "title": "ProductLink.targetProduct" + }, + { + "description": "Returns the type of this link (see constants).", + "id": "script-api:dw/catalog/ProductLink#typeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductLink", + "qualifiedName": "dw.catalog.ProductLink.typeCode", + "sections": [ + { + "body": "Returns the type of this link (see constants).", + "heading": "Description" + } + ], + "signature": "readonly typeCode: number", + "source": "script-api", + "tags": [ + "typecode", + "productlink.typecode" + ], + "title": "ProductLink.typeCode" + }, + { + "description": "Provides helper methods for getting products based on Product ID or dw.catalog.Catalog.", + "id": "script-api:dw/catalog/ProductMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductMgr", + "sections": [ + { + "body": "Provides helper methods for getting products based on Product ID or dw.catalog.Catalog.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productmgr", + "dw.catalog.productmgr", + "dw/catalog" + ], + "title": "ProductMgr" + }, + { + "description": "Returns the product with the specified id.", + "id": "script-api:dw/catalog/ProductMgr#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.getProduct", + "returns": { + "type": "Product | null" + }, + "sections": [ + { + "body": "Returns the product with the specified id.", + "heading": "Description" + } + ], + "signature": "static getProduct(productID: string): Product | null", + "source": "script-api", + "tags": [ + "getproduct", + "productmgr.getproduct" + ], + "title": "ProductMgr.getProduct" + }, + { + "description": "Returns the product with the specified id.", + "id": "script-api:dw/catalog/ProductMgr#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.getProduct", + "returns": { + "type": "Product | null" + }, + "sections": [ + { + "body": "Returns the product with the specified id.", + "heading": "Description" + } + ], + "signature": "static getProduct(productID: string): Product | null", + "source": "script-api", + "tags": [ + "getproduct", + "productmgr.getproduct" + ], + "title": "ProductMgr.getProduct" + }, + { + "description": "Returns all products assigned to the current site.", + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProducts", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the current site.\n\nA product is assigned to a site if\n\n- it is assigned to at least one category of the site catalog or\n- it is a variant and it's master product is assigned to the current site\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryAllSiteProducts(): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryallsiteproducts", + "productmgr.queryallsiteproducts" + ], + "title": "ProductMgr.queryAllSiteProducts" + }, + { + "description": "Returns all products assigned to the current site.", + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProducts", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the current site.\n\nA product is assigned to a site if\n\n- it is assigned to at least one category of the site catalog or\n- it is a variant and it's master product is assigned to the current site\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryAllSiteProducts(): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryallsiteproducts", + "productmgr.queryallsiteproducts" + ], + "title": "ProductMgr.queryAllSiteProducts" + }, + { + "description": "Returns all products assigned to the current site.", + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProductsSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProductsSorted", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the current site.\n\nWorks like queryAllSiteProducts(), but additionally sorts the result set\nby product ID.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryAllSiteProductsSorted(): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryallsiteproductssorted", + "productmgr.queryallsiteproductssorted" + ], + "title": "ProductMgr.queryAllSiteProductsSorted" + }, + { + "description": "Returns all products assigned to the current site.", + "id": "script-api:dw/catalog/ProductMgr#queryAllSiteProductsSorted", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryAllSiteProductsSorted", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the current site.\n\nWorks like queryAllSiteProducts(), but additionally sorts the result set\nby product ID.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryAllSiteProductsSorted(): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryallsiteproductssorted", + "productmgr.queryallsiteproductssorted" + ], + "title": "ProductMgr.queryAllSiteProductsSorted" + }, + { + "description": "Returns all products assigned to the the specified catalog, where assignment has the same meaning as it does for queryAllSiteProducts().", + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalog", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the the specified catalog, where\nassignment has the same meaning as it does for queryAllSiteProducts().\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductsInCatalog(catalog: Catalog): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryproductsincatalog", + "productmgr.queryproductsincatalog" + ], + "title": "ProductMgr.queryProductsInCatalog" + }, + { + "description": "Returns all products assigned to the the specified catalog, where assignment has the same meaning as it does for queryAllSiteProducts().", + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalog", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the the specified catalog, where\nassignment has the same meaning as it does for queryAllSiteProducts().\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductsInCatalog(catalog: Catalog): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryproductsincatalog", + "productmgr.queryproductsincatalog" + ], + "title": "ProductMgr.queryProductsInCatalog" + }, + { + "description": "Returns all products assigned to the the specified catalog. Works like queryProductsInCatalog(), but additionally sorts the result set by product ID.", + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalogSorted", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalogSorted", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the the specified catalog.\nWorks like queryProductsInCatalog(), but additionally sorts the result\nset by product ID.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductsInCatalogSorted(catalog: Catalog): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryproductsincatalogsorted", + "productmgr.queryproductsincatalogsorted" + ], + "title": "ProductMgr.queryProductsInCatalogSorted" + }, + { + "description": "Returns all products assigned to the the specified catalog. Works like queryProductsInCatalog(), but additionally sorts the result set by product ID.", + "id": "script-api:dw/catalog/ProductMgr#queryProductsInCatalogSorted", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "catalog", + "type": "Catalog" + } + ], + "parentId": "script-api:dw/catalog/ProductMgr", + "qualifiedName": "dw.catalog.ProductMgr.queryProductsInCatalogSorted", + "returns": { + "type": "SeekableIterator>" + }, + "sections": [ + { + "body": "Returns all products assigned to the the specified catalog.\nWorks like queryProductsInCatalog(), but additionally sorts the result\nset by product ID.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductsInCatalogSorted(catalog: Catalog): SeekableIterator>", + "source": "script-api", + "tags": [ + "queryproductsincatalogsorted", + "productmgr.queryproductsincatalogsorted" + ], + "title": "ProductMgr.queryProductsInCatalogSorted" + }, + { + "description": "Represents a product option.", + "id": "script-api:dw/catalog/ProductOption", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOption", + "sections": [ + { + "body": "Represents a product option.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productoption", + "dw.catalog.productoption", + "dw/catalog" + ], + "title": "ProductOption" + }, + { + "description": "Returns the product option ID.", + "id": "script-api:dw/catalog/ProductOption#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.ID", + "sections": [ + { + "body": "Returns the product option ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productoption.id" + ], + "title": "ProductOption.ID" + }, + { + "description": "Returns the default value for the product option.", + "id": "script-api:dw/catalog/ProductOption#defaultValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.defaultValue", + "sections": [ + { + "body": "Returns the default value for the product option.", + "heading": "Description" + } + ], + "signature": "readonly defaultValue: ProductOptionValue", + "source": "script-api", + "tags": [ + "defaultvalue", + "productoption.defaultvalue" + ], + "title": "ProductOption.defaultValue" + }, + { + "description": "Returns the product option's short description in the current locale.", + "id": "script-api:dw/catalog/ProductOption#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.description", + "sections": [ + { + "body": "Returns the product option's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "productoption.description" + ], + "title": "ProductOption.description" + }, + { + "description": "Returns the product option's display name in the current locale.", + "id": "script-api:dw/catalog/ProductOption#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.displayName", + "sections": [ + { + "body": "Returns the product option's display name in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "productoption.displayname" + ], + "title": "ProductOption.displayName" + }, + { + "description": "Returns the default value for the product option.", + "id": "script-api:dw/catalog/ProductOption#getDefaultValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDefaultValue", + "returns": { + "type": "ProductOptionValue" + }, + "sections": [ + { + "body": "Returns the default value for the product option.", + "heading": "Description" + } + ], + "signature": "getDefaultValue(): ProductOptionValue", + "source": "script-api", + "tags": [ + "getdefaultvalue", + "productoption.getdefaultvalue" + ], + "title": "ProductOption.getDefaultValue" + }, + { + "description": "Returns the product option's short description in the current locale.", + "id": "script-api:dw/catalog/ProductOption#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the product option's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "productoption.getdescription" + ], + "title": "ProductOption.getDescription" + }, + { + "description": "Returns the product option's display name in the current locale.", + "id": "script-api:dw/catalog/ProductOption#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the product option's display name in the current locale.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "productoption.getdisplayname" + ], + "title": "ProductOption.getDisplayName" + }, + { + "description": "Returns an HTML representation of the option id.", + "id": "script-api:dw/catalog/ProductOption#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the option id.", + "heading": "Description" + } + ], + "signature": "getHtmlName(): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productoption.gethtmlname" + ], + "title": "ProductOption.getHtmlName" + }, + { + "description": "Returns an HTML representation of the option id with the custom prefix.", + "id": "script-api:dw/catalog/ProductOption#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "prefix", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the option id with the custom prefix.", + "heading": "Description" + } + ], + "signature": "getHtmlName(prefix: string): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productoption.gethtmlname" + ], + "title": "ProductOption.getHtmlName" + }, + { + "description": "Returns the product option ID.", + "id": "script-api:dw/catalog/ProductOption#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product option ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productoption.getid" + ], + "title": "ProductOption.getID" + }, + { + "description": "Returns the product option's image.", + "id": "script-api:dw/catalog/ProductOption#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the product option's image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "productoption.getimage" + ], + "title": "ProductOption.getImage" + }, + { + "description": "Returns a collection containing the product option values.", + "id": "script-api:dw/catalog/ProductOption#getOptionValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.getOptionValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the product option values.", + "heading": "Description" + } + ], + "signature": "getOptionValues(): Collection", + "source": "script-api", + "tags": [ + "getoptionvalues", + "productoption.getoptionvalues" + ], + "title": "ProductOption.getOptionValues" + }, + { + "description": "Returns an HTML representation of the option id.", + "id": "script-api:dw/catalog/ProductOption#htmlName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.htmlName", + "sections": [ + { + "body": "Returns an HTML representation of the option id.", + "heading": "Description" + } + ], + "signature": "readonly htmlName: string", + "source": "script-api", + "tags": [ + "htmlname", + "productoption.htmlname" + ], + "title": "ProductOption.htmlName" + }, + { + "description": "Returns the product option's image.", + "id": "script-api:dw/catalog/ProductOption#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.image", + "sections": [ + { + "body": "Returns the product option's image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "productoption.image" + ], + "title": "ProductOption.image" + }, + { + "description": "Returns a collection containing the product option values.", + "id": "script-api:dw/catalog/ProductOption#optionValues", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOption", + "qualifiedName": "dw.catalog.ProductOption.optionValues", + "sections": [ + { + "body": "Returns a collection containing the product option values.", + "heading": "Description" + } + ], + "signature": "readonly optionValues: Collection", + "source": "script-api", + "tags": [ + "optionvalues", + "productoption.optionvalues" + ], + "title": "ProductOption.optionValues" + }, + { + "description": "This class represents the option model of a specific product and for a specific currency. It provides accessor methods to the configured options and the values of those options. It has also methods to set a specific selection of option values.", + "id": "script-api:dw/catalog/ProductOptionModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOptionModel", + "sections": [ + { + "body": "This class represents the option model of a specific product and\nfor a specific currency. It provides accessor methods to the configured\noptions and the values of those options. It has also methods to set a\nspecific selection of option values.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productoptionmodel", + "dw.catalog.productoptionmodel", + "dw/catalog" + ], + "title": "ProductOptionModel" + }, + { + "description": "Returns the product option for the specified ID.", + "id": "script-api:dw/catalog/ProductOptionModel#getOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "optionID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOption", + "returns": { + "type": "ProductOption" + }, + "sections": [ + { + "body": "Returns the product option for the specified ID.", + "heading": "Description" + } + ], + "signature": "getOption(optionID: string): ProductOption", + "source": "script-api", + "tags": [ + "getoption", + "productoptionmodel.getoption" + ], + "title": "ProductOptionModel.getOption" + }, + { + "description": "Returns the product option value object for the passed value id and in the context of the passed option.", + "id": "script-api:dw/catalog/ProductOptionModel#getOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "ProductOption" + }, + { + "name": "valueID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptionValue", + "returns": { + "type": "ProductOptionValue" + }, + "sections": [ + { + "body": "Returns the product option value object for the passed value id and in\nthe context of the passed option.", + "heading": "Description" + } + ], + "signature": "getOptionValue(option: ProductOption, valueID: string): ProductOptionValue", + "source": "script-api", + "tags": [ + "getoptionvalue", + "productoptionmodel.getoptionvalue" + ], + "title": "ProductOptionModel.getOptionValue" + }, + { + "description": "Returns a collection of product option values for the specified product option.", + "id": "script-api:dw/catalog/ProductOptionModel#getOptionValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "ProductOption" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptionValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of product option values for the\nspecified product option.", + "heading": "Description" + } + ], + "signature": "getOptionValues(option: ProductOption): Collection", + "source": "script-api", + "tags": [ + "getoptionvalues", + "productoptionmodel.getoptionvalues" + ], + "title": "ProductOptionModel.getOptionValues" + }, + { + "description": "Returns the collection of product options.", + "id": "script-api:dw/catalog/ProductOptionModel#getOptions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getOptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of product options.", + "heading": "Description" + } + ], + "signature": "getOptions(): Collection", + "source": "script-api", + "tags": [ + "getoptions", + "productoptionmodel.getoptions" + ], + "title": "ProductOptionModel.getOptions" + }, + { + "description": "Returns the effective price of the specified option value.", + "id": "script-api:dw/catalog/ProductOptionModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "optionValue", + "type": "ProductOptionValue" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the effective price of the specified option value.", + "heading": "Description" + } + ], + "signature": "getPrice(optionValue: ProductOptionValue): Money", + "source": "script-api", + "tags": [ + "getprice", + "productoptionmodel.getprice" + ], + "title": "ProductOptionModel.getPrice" + }, + { + "description": "Returns the selected value for the specified product option. If no option values was set as selected option explicitly, the method returns the default option value for this option.", + "id": "script-api:dw/catalog/ProductOptionModel#getSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "ProductOption" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.getSelectedOptionValue", + "returns": { + "type": "ProductOptionValue" + }, + "sections": [ + { + "body": "Returns the selected value for the specified product option. If no\noption values was set as selected option explicitly, the method\nreturns the default option value for this option.", + "heading": "Description" + } + ], + "signature": "getSelectedOptionValue(option: ProductOption): ProductOptionValue", + "source": "script-api", + "tags": [ + "getselectedoptionvalue", + "productoptionmodel.getselectedoptionvalue" + ], + "title": "ProductOptionModel.getSelectedOptionValue" + }, + { + "description": "Returns true if the specified option value is the one currently selected, false otherwise.", + "id": "script-api:dw/catalog/ProductOptionModel#isSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "ProductOption" + }, + { + "name": "value", + "type": "ProductOptionValue" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.isSelectedOptionValue", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the specified option value is the one currently selected,\nfalse otherwise.", + "heading": "Description" + } + ], + "signature": "isSelectedOptionValue(option: ProductOption, value: ProductOptionValue): boolean", + "source": "script-api", + "tags": [ + "isselectedoptionvalue", + "productoptionmodel.isselectedoptionvalue" + ], + "title": "ProductOptionModel.isSelectedOptionValue" + }, + { + "description": "Returns the collection of product options.", + "id": "script-api:dw/catalog/ProductOptionModel#options", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.options", + "sections": [ + { + "body": "Returns the collection of product options.", + "heading": "Description" + } + ], + "signature": "readonly options: Collection", + "source": "script-api", + "tags": [ + "options", + "productoptionmodel.options" + ], + "title": "ProductOptionModel.options" + }, + { + "description": "Updates the selection of the specified option based on the specified value.", + "id": "script-api:dw/catalog/ProductOptionModel#setSelectedOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "ProductOption" + }, + { + "name": "value", + "type": "ProductOptionValue" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.setSelectedOptionValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the selection of the specified option based on the specified value.", + "heading": "Description" + } + ], + "signature": "setSelectedOptionValue(option: ProductOption, value: ProductOptionValue): void", + "source": "script-api", + "tags": [ + "setselectedoptionvalue", + "productoptionmodel.setselectedoptionvalue" + ], + "title": "ProductOptionModel.setSelectedOptionValue" + }, + { + "description": "Returns a URL that can be used to select one or more option values. The optional `varOptionAndValues` argument can be empty, or can contain one or more option / value pairs. This variable list must be even in length, with options and values alternating. If the list is odd in length, the last argument will be ignored. Options can be specified as instances of ProductOption, or String option ID. Values can be specified as instances of ProductOptionValue or as strings representing the value ID. If a parameter is invalid, then the parameter pair is not included in the generated URL. The returned URL will contain options and values already selected in the product option model, as well as options and values specified as method parameters. This includes option values explicitly selected and implicitly selected by default.", + "id": "script-api:dw/catalog/ProductOptionModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "varOptionAndValues", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.url", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns a URL that can be used to select one or more option values. The\noptional `varOptionAndValues` argument can be empty, or can\ncontain one or more option / value pairs. This variable list must be even\nin length, with options and values alternating. If the list is odd in\nlength, the last argument will be ignored. Options can be specified as\ninstances of ProductOption, or String option ID. Values can be specified\nas instances of ProductOptionValue or as strings representing the value\nID. If a parameter is invalid, then the parameter pair is not included in\nthe generated URL. The returned URL will contain options and values\nalready selected in the product option model, as well as options and\nvalues specified as method parameters. This includes option values\nexplicitly selected and implicitly selected by default.", + "heading": "Description" + } + ], + "signature": "url(action: string, varOptionAndValues?: any[]): URL", + "source": "script-api", + "tags": [ + "url", + "productoptionmodel.url" + ], + "title": "ProductOptionModel.url" + }, + { + "description": "Returns an URL that can be used to select a specific value of a specific option.", + "id": "script-api:dw/catalog/ProductOptionModel#urlSelectOptionValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "option", + "type": "ProductOption" + }, + { + "name": "value", + "type": "ProductOptionValue" + } + ], + "parentId": "script-api:dw/catalog/ProductOptionModel", + "qualifiedName": "dw.catalog.ProductOptionModel.urlSelectOptionValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an URL that can be used to select a specific value of a specific\noption.", + "heading": "Description" + } + ], + "signature": "urlSelectOptionValue(action: string, option: ProductOption, value: ProductOptionValue): string", + "source": "script-api", + "tags": [ + "urlselectoptionvalue", + "productoptionmodel.urlselectoptionvalue" + ], + "title": "ProductOptionModel.urlSelectOptionValue" + }, + { + "description": "Represents the value of a product option.", + "id": "script-api:dw/catalog/ProductOptionValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductOptionValue", + "sections": [ + { + "body": "Represents the value of a product option.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productoptionvalue", + "dw.catalog.productoptionvalue", + "dw/catalog" + ], + "title": "ProductOptionValue" + }, + { + "description": "Returns the product option value's ID.", + "id": "script-api:dw/catalog/ProductOptionValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.ID", + "sections": [ + { + "body": "Returns the product option value's ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productoptionvalue.id" + ], + "title": "ProductOptionValue.ID" + }, + { + "description": "Returns the the product option value's description in the current locale.", + "id": "script-api:dw/catalog/ProductOptionValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.description", + "sections": [ + { + "body": "Returns the the product option value's description\nin the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "productoptionvalue.description" + ], + "title": "ProductOptionValue.description" + }, + { + "description": "Returns the the product option value's display name in the current locale.", + "id": "script-api:dw/catalog/ProductOptionValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.displayValue", + "sections": [ + { + "body": "Returns the the product option value's display name\nin the current locale.", + "heading": "Description" + } + ], + "signature": "readonly displayValue: string | null", + "source": "script-api", + "tags": [ + "displayvalue", + "productoptionvalue.displayvalue" + ], + "title": "ProductOptionValue.displayValue" + }, + { + "description": "Returns the the product option value's description in the current locale.", + "id": "script-api:dw/catalog/ProductOptionValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the the product option value's description\nin the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "productoptionvalue.getdescription" + ], + "title": "ProductOptionValue.getDescription" + }, + { + "description": "Returns the the product option value's display name in the current locale.", + "id": "script-api:dw/catalog/ProductOptionValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getDisplayValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the the product option value's display name\nin the current locale.", + "heading": "Description" + } + ], + "signature": "getDisplayValue(): string | null", + "source": "script-api", + "tags": [ + "getdisplayvalue", + "productoptionvalue.getdisplayvalue" + ], + "title": "ProductOptionValue.getDisplayValue" + }, + { + "description": "Returns the product option value's ID.", + "id": "script-api:dw/catalog/ProductOptionValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product option value's ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productoptionvalue.getid" + ], + "title": "ProductOptionValue.getID" + }, + { + "description": "Returns the product option value's product ID modifier which can be used to build the SKU for the actual product.", + "id": "script-api:dw/catalog/ProductOptionValue#getProductIDModifier", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.getProductIDModifier", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product option value's product ID modifier which\ncan be used to build the SKU for the actual product.", + "heading": "Description" + } + ], + "signature": "getProductIDModifier(): string", + "source": "script-api", + "tags": [ + "getproductidmodifier", + "productoptionvalue.getproductidmodifier" + ], + "title": "ProductOptionValue.getProductIDModifier" + }, + { + "description": "Returns the product option value's product ID modifier which can be used to build the SKU for the actual product.", + "id": "script-api:dw/catalog/ProductOptionValue#productIDModifier", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductOptionValue", + "qualifiedName": "dw.catalog.ProductOptionValue.productIDModifier", + "sections": [ + { + "body": "Returns the product option value's product ID modifier which\ncan be used to build the SKU for the actual product.", + "heading": "Description" + } + ], + "signature": "readonly productIDModifier: string", + "source": "script-api", + "tags": [ + "productidmodifier", + "productoptionvalue.productidmodifier" + ], + "title": "ProductOptionValue.productIDModifier" + }, + { + "description": "Simple class representing a product price point. This class is useful because it provides additional information beyond just the price. Since the system calculates sales prices based on applicable price books, it is sometimes useful to know additional information such as which price book defined a price point, what percentage discount off the base price this value represents, and the date range for which this price point is active.", + "id": "script-api:dw/catalog/ProductPriceInfo", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceInfo", + "sections": [ + { + "body": "Simple class representing a product price point. This class is useful\nbecause it provides additional information beyond just the price. Since the\nsystem calculates sales prices based on applicable price books, it is\nsometimes useful to know additional information such as which price book\ndefined a price point, what percentage discount off the base price\nthis value represents, and the date range for which this price point is active.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productpriceinfo", + "dw.catalog.productpriceinfo", + "dw/catalog" + ], + "title": "ProductPriceInfo" + }, + { + "description": "Returns the date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the case of a continuous price point, null will be returned.", + "id": "script-api:dw/catalog/ProductPriceInfo#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getOnlineFrom", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the\ncase of a continuous price point, null will be returned.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date | null", + "source": "script-api", + "tags": [ + "getonlinefrom", + "productpriceinfo.getonlinefrom" + ], + "title": "ProductPriceInfo.getOnlineFrom" + }, + { + "description": "Returns the date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case of a continuous price point, null will be returned.", + "id": "script-api:dw/catalog/ProductPriceInfo#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getOnlineTo", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case\nof a continuous price point, null will be returned.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date | null", + "source": "script-api", + "tags": [ + "getonlineto", + "productpriceinfo.getonlineto" + ], + "title": "ProductPriceInfo.getOnlineTo" + }, + { + "description": "Returns the percentage off value of this price point related to the base price for the product's minimum order quantity.", + "id": "script-api:dw/catalog/ProductPriceInfo#getPercentage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPercentage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the percentage off value of this price point related to the base\nprice for the product's minimum order quantity.", + "heading": "Description" + } + ], + "signature": "getPercentage(): number", + "source": "script-api", + "tags": [ + "getpercentage", + "productpriceinfo.getpercentage" + ], + "title": "ProductPriceInfo.getPercentage" + }, + { + "description": "Returns the monetary price for this price point.", + "id": "script-api:dw/catalog/ProductPriceInfo#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the monetary price for this price point.", + "heading": "Description" + } + ], + "signature": "getPrice(): Money", + "source": "script-api", + "tags": [ + "getprice", + "productpriceinfo.getprice" + ], + "title": "ProductPriceInfo.getPrice" + }, + { + "description": "Returns the price book which defined this price point.", + "id": "script-api:dw/catalog/ProductPriceInfo#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPriceBook", + "returns": { + "type": "PriceBook" + }, + "sections": [ + { + "body": "Returns the price book which defined this price point.", + "heading": "Description" + } + ], + "signature": "getPriceBook(): PriceBook", + "source": "script-api", + "tags": [ + "getpricebook", + "productpriceinfo.getpricebook" + ], + "title": "ProductPriceInfo.getPriceBook" + }, + { + "description": "Returns the price info associated with this price point. This is an arbitrary string which a merchant can associate with a price entry. This can be used for example, to track which back-end system the price is derived from.", + "id": "script-api:dw/catalog/ProductPriceInfo#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.getPriceInfo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the price info associated with this price point. This is an\narbitrary string which a merchant can associate with a price entry. This\ncan be used for example, to track which back-end system the price is\nderived from.", + "heading": "Description" + } + ], + "signature": "getPriceInfo(): string", + "source": "script-api", + "tags": [ + "getpriceinfo", + "productpriceinfo.getpriceinfo" + ], + "title": "ProductPriceInfo.getPriceInfo" + }, + { + "description": "Returns the date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the case of a continuous price point, null will be returned.", + "id": "script-api:dw/catalog/ProductPriceInfo#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.onlineFrom", + "sections": [ + { + "body": "Returns the date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the\ncase of a continuous price point, null will be returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date | null", + "source": "script-api", + "tags": [ + "onlinefrom", + "productpriceinfo.onlinefrom" + ], + "title": "ProductPriceInfo.onlineFrom" + }, + { + "description": "Returns the date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case of a continuous price point, null will be returned.", + "id": "script-api:dw/catalog/ProductPriceInfo#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.onlineTo", + "sections": [ + { + "body": "Returns the date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case\nof a continuous price point, null will be returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date | null", + "source": "script-api", + "tags": [ + "onlineto", + "productpriceinfo.onlineto" + ], + "title": "ProductPriceInfo.onlineTo" + }, + { + "description": "Returns the percentage off value of this price point related to the base price for the product's minimum order quantity.", + "id": "script-api:dw/catalog/ProductPriceInfo#percentage", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.percentage", + "sections": [ + { + "body": "Returns the percentage off value of this price point related to the base\nprice for the product's minimum order quantity.", + "heading": "Description" + } + ], + "signature": "readonly percentage: number", + "source": "script-api", + "tags": [ + "percentage", + "productpriceinfo.percentage" + ], + "title": "ProductPriceInfo.percentage" + }, + { + "description": "Returns the monetary price for this price point.", + "id": "script-api:dw/catalog/ProductPriceInfo#price", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.price", + "sections": [ + { + "body": "Returns the monetary price for this price point.", + "heading": "Description" + } + ], + "signature": "readonly price: Money", + "source": "script-api", + "tags": [ + "price", + "productpriceinfo.price" + ], + "title": "ProductPriceInfo.price" + }, + { + "description": "Returns the price book which defined this price point.", + "id": "script-api:dw/catalog/ProductPriceInfo#priceBook", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.priceBook", + "sections": [ + { + "body": "Returns the price book which defined this price point.", + "heading": "Description" + } + ], + "signature": "readonly priceBook: PriceBook", + "source": "script-api", + "tags": [ + "pricebook", + "productpriceinfo.pricebook" + ], + "title": "ProductPriceInfo.priceBook" + }, + { + "description": "Returns the price info associated with this price point. This is an arbitrary string which a merchant can associate with a price entry. This can be used for example, to track which back-end system the price is derived from.", + "id": "script-api:dw/catalog/ProductPriceInfo#priceInfo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceInfo", + "qualifiedName": "dw.catalog.ProductPriceInfo.priceInfo", + "sections": [ + { + "body": "Returns the price info associated with this price point. This is an\narbitrary string which a merchant can associate with a price entry. This\ncan be used for example, to track which back-end system the price is\nderived from.", + "heading": "Description" + } + ], + "signature": "readonly priceInfo: string", + "source": "script-api", + "tags": [ + "priceinfo", + "productpriceinfo.priceinfo" + ], + "title": "ProductPriceInfo.priceInfo" + }, + { + "description": "ProductPriceModel provides methods to access all the dw.catalog.PriceBook information of a product. A ProductPriceModel instance is retrieved by calling dw.catalog.Product.getPriceModel or dw.catalog.Product.getPriceModel for a specific product. The latter method will return a model which also includes the additional option prices of an option product.", + "id": "script-api:dw/catalog/ProductPriceModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceModel", + "sections": [ + { + "body": "ProductPriceModel provides methods to access all the\ndw.catalog.PriceBook information of a product. A ProductPriceModel\ninstance is retrieved by calling dw.catalog.Product.getPriceModel\nor dw.catalog.Product.getPriceModel for a\nspecific product. The latter method will return a model which also includes\nthe additional option prices of an option product.\n\nWhen the current price of a product is accessed in the storefront via its\nprice model, a price lookup is performed. The high-level steps of this price\nlookup are:\n\n- Get all price books applicable in the context of the current site, time,\nsession, customer, source code.\n- Identify all prices in the applicable price books and for a requested\nquantity.\n- Calculate the best-price of all identified prices. The best-price is the\nlowest price.\n\nIn more detail:\n\nIdentify applicable price books\n\n- If any price books are explicitly registered in the session (see pipelet\nSetApplicablePriceBooks), use these price books and their direct parents for\nprice lookup. Ignore all inactive price books, price books not valid at the\ncurrent time, and price books with a currency other than the session currency.\n\nOtherwise:\n\n- If a valid source code is registered with the current session, get all\nprice books assigned to the source code and their parent price books. Ignore\nall inactive price books, price books not valid at the current time, and\nprice books with a currency other than the session currency.\n- Get all price books assigned to site and their parent price books. Ignore\nall inactive price books, price books not valid at the current time, and\nprice books with a currency other than the session currency.\n\nIdentify all prices:\n\n- Get all price definitions for the product from all applicable price\nbooks. Ignore price definitions not valid at the current time.\n- Convert any percentage price definition into a monetary amount. As the\nbase price for this calculation, the minimum product price for the minimum\norder quantity of the product, including product options, is used.\n- Compare all prices and identify the lowest (= best) price.\n- Calculate best price for each defined price cut in the price table and\nreturn price table.\n\nVariation Price Fallback:\n\n- If no applicable pricebooks for a variant is found, the price lookup gets\nthe price books from the variant's master product\n- A price books is also not applicable of the price definition for the\nvariant in the price book is not valid at the current time.\n\nTypically, in order to do a standard price lookup, it is only necessary to\ncall `Product.getPriceModel().getPrice()`. However, Commerce Cloud\nDigital also supports tiered prices, meaning that higher quantities receive\na lower price. In this case, the merchant typically wants to display a table\nof price points on product detail pages. Therefore, the ProductPriceModel\nprovides the method getPriceTable to retrieve a table of these prices.\n\nIf a merchant wants to know not only what the price of a given product is,\nbut what price book the price was derived from, this class provides the\nmethod getPriceInfo. This class also provides methods to lookup\nproduct prices in specific price books by name and quantity. See\ngetPriceBookPrice.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productpricemodel", + "dw.catalog.productpricemodel", + "dw/catalog" + ], + "title": "ProductPriceModel" + }, + { + "description": "Returns the quantity for which the base price is defined. This is typically 1.0.", + "id": "script-api:dw/catalog/ProductPriceModel#basePriceQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.basePriceQuantity", + "sections": [ + { + "body": "Returns the quantity for which the base price is defined. This\nis typically 1.0.", + "heading": "Description" + } + ], + "signature": "readonly basePriceQuantity: Quantity", + "source": "script-api", + "tags": [ + "basepricequantity", + "productpricemodel.basepricequantity" + ], + "title": "ProductPriceModel.basePriceQuantity" + }, + { + "description": "Returns the quantity for which the base price is defined. This is typically 1.0.", + "id": "script-api:dw/catalog/ProductPriceModel#getBasePriceQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getBasePriceQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity for which the base price is defined. This\nis typically 1.0.", + "heading": "Description" + } + ], + "signature": "getBasePriceQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getbasepricequantity", + "productpricemodel.getbasepricequantity" + ], + "title": "ProductPriceModel.getBasePriceQuantity" + }, + { + "description": "Calculates and returns the maximum price-book price of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPrice. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the maximum price-book price of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPrice.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "getMaxPrice(): Money", + "source": "script-api", + "tags": [ + "getmaxprice", + "productpricemodel.getmaxprice" + ], + "title": "ProductPriceModel.getMaxPrice" + }, + { + "description": "Calculates and returns the maximum price in a given price book of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPriceBookPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the maximum price in a given price book of all\nvariants (for master products) or set-products (for product sets) for\nbase quantity 1.00. This value can be used to display a range of prices\nin storefront.\n\nThis method follows the same rules as\ngetPriceBookPrice in determining the price book\nprice for each variant or set-product. If the product represented by this\nmodel is not a master product or product set, then this method behaves\nthe same as getPriceBookPrice.", + "heading": "Description" + } + ], + "signature": "getMaxPriceBookPrice(priceBookID: string): Money", + "source": "script-api", + "tags": [ + "getmaxpricebookprice", + "productpricemodel.getmaxpricebookprice" + ], + "title": "ProductPriceModel.getMaxPriceBookPrice" + }, + { + "description": "Calculates and returns the maximum price per unit in a given price book of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of price per units in storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPriceBookPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the maximum price per unit in a given price book of all\nvariants (for master products) or set-products (for product sets) for\nbase quantity 1.00. This value can be used to display a range of price per units\nin storefront.\n\nThis method follows the same rules as\ngetPriceBookPricePerUnit in determining the price book\nprice for each variant or set-product. If the product represented by this\nmodel is not a master product or product set, then this method behaves\nthe same as getPriceBookPricePerUnit.", + "heading": "Description" + } + ], + "signature": "getMaxPriceBookPricePerUnit(priceBookID: string): Money", + "source": "script-api", + "tags": [ + "getmaxpricebookpriceperunit", + "productpricemodel.getmaxpricebookpriceperunit" + ], + "title": "ProductPriceModel.getMaxPriceBookPricePerUnit" + }, + { + "description": "Calculates and returns the maximum price-book price per unit of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPricePerUnit. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#getMaxPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMaxPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the maximum price-book price per unit of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPricePerUnit.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\ne.g.\nsuppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:\nv1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).\nThe max price per unit of mp will be max($6/2, $5/5, $10/20) = $3", + "heading": "Description" + } + ], + "signature": "getMaxPricePerUnit(): Money", + "source": "script-api", + "tags": [ + "getmaxpriceperunit", + "productpricemodel.getmaxpriceperunit" + ], + "title": "ProductPriceModel.getMaxPricePerUnit" + }, + { + "description": "Calculates and returns the minimum price-book price of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPrice. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#getMinPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the minimum price-book price of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPrice.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "getMinPrice(): Money", + "source": "script-api", + "tags": [ + "getminprice", + "productpricemodel.getminprice" + ], + "title": "ProductPriceModel.getMinPrice" + }, + { + "description": "Calculates and returns the minimum price in a given price book of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#getMinPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPriceBookPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the minimum price in a given price book of all\nvariants (for master products) or set-products (for product sets) for\nbase quantity 1.00. This value can be used to display a range of prices\nin storefront.\n\nThis method follows the same rules as\ngetPriceBookPrice in determining the price book\nprice for each variant or set-product. If the product represented by this\nmodel is not a master product or product set, then this method behaves\nthe same as getPriceBookPrice.", + "heading": "Description" + } + ], + "signature": "getMinPriceBookPrice(priceBookID: string): Money", + "source": "script-api", + "tags": [ + "getminpricebookprice", + "productpricemodel.getminpricebookprice" + ], + "title": "ProductPriceModel.getMinPriceBookPrice" + }, + { + "description": "Calculates and returns the minimum price per unit in a given price book of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of price per units in storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#getMinPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPriceBookPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the minimum price per unit in a given price book of all\nvariants (for master products) or set-products (for product sets) for\nbase quantity 1.00. This value can be used to display a range of price per units\nin storefront.\n\nThis method follows the same rules as\ngetPriceBookPricePerUnit in determining the price book\nprice for each variant or set-product. If the product represented by this\nmodel is not a master product or product set, then this method behaves\nthe same as getPriceBookPricePerUnit.", + "heading": "Description" + } + ], + "signature": "getMinPriceBookPricePerUnit(priceBookID: string): Money", + "source": "script-api", + "tags": [ + "getminpricebookpriceperunit", + "productpricemodel.getminpricebookpriceperunit" + ], + "title": "ProductPriceModel.getMinPriceBookPricePerUnit" + }, + { + "description": "Calculates and returns the minimum price-book price per unit of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPricePerUnit. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#getMinPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getMinPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Calculates and returns the minimum price-book price per unit of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPricePerUnit.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\ne.g.\nsuppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:\nv1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).\nThe min price per unit of mp will be min($6/2, $5/5, $10/20) = $0.5", + "heading": "Description" + } + ], + "signature": "getMinPricePerUnit(): Money", + "source": "script-api", + "tags": [ + "getminpriceperunit", + "productpricemodel.getminpriceperunit" + ], + "title": "ProductPriceModel.getMinPricePerUnit" + }, + { + "description": "Returns the active price of a product, calculated based on base price quantity 1.00. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the active price of a product, calculated based on base price quantity\n1.00. The price is returned for the currency of the current session.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitly\nset as applicable in the current session.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf no price could be found, MONEY.NOT_AVAILABLE is returned.", + "heading": "Description" + } + ], + "signature": "getPrice(): Money", + "source": "script-api", + "tags": [ + "getprice", + "productpricemodel.getprice" + ], + "title": "ProductPriceModel.getPrice" + }, + { + "description": "Returns the active price of a product, calculated based on the passed order quantity. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the active price of a product, calculated based on the passed order\nquantity. The price is returned for the currency of the current session.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitly\nset as applicable in the current session.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf passed order quantity < 1 (and greater than zero), price for quantity\n1 is returned.\n\nIf no price could be found, MONEY.NOT_AVAILABLE is returned.", + "heading": "Description" + } + ], + "signature": "getPrice(quantity: Quantity): Money", + "source": "script-api", + "tags": [ + "getprice", + "productpricemodel.getprice" + ], + "title": "ProductPriceModel.getPrice" + }, + { + "description": "Returns the active price of the product in the specified price book for quantity 1.00.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPrice", + "returns": { + "type": "Money | null" + }, + "sections": [ + { + "body": "Returns the active price of the product in the specified price book for\nquantity 1.00.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nMoney.NOT_AVAILABLE will be returned in any of the following cases:\n\n- priceBookID is null or does not identify a valid price book.\n- The price book has no price for the product.\n- None of the prices for the product in the price book is currently\nactive.\n- The currently active price entry is a percentage.", + "heading": "Description" + } + ], + "signature": "getPriceBookPrice(priceBookID: string): Money | null", + "source": "script-api", + "tags": [ + "getpricebookprice", + "productpricemodel.getpricebookprice" + ], + "title": "ProductPriceModel.getPriceBookPrice" + }, + { + "description": "Returns the active price of the product in the specified price book for the specified quantity.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + }, + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPrice", + "returns": { + "type": "Money | null" + }, + "sections": [ + { + "body": "Returns the active price of the product in the specified price book for\nthe specified quantity.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nMoney.NOT_AVAILABLE will be returned in any of the following cases:\n\n- priceBookID is null or does not identify a valid price book.\n- quantity is null.\n- The price book has no price for the product.\n- None of the prices for the product in the price book is currently\nactive.\n- The currently active price entry is a percentage.", + "heading": "Description" + } + ], + "signature": "getPriceBookPrice(priceBookID: string, quantity: Quantity): Money | null", + "source": "script-api", + "tags": [ + "getpricebookprice", + "productpricemodel.getpricebookprice" + ], + "title": "ProductPriceModel.getPriceBookPrice" + }, + { + "description": "This method acts similarly to getPriceBookPrice but returns a ProductPriceInfo object wrapping the actual price with additional information.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPriceInfo", + "returns": { + "type": "ProductPriceInfo | null" + }, + "sections": [ + { + "body": "This method acts similarly to getPriceBookPrice but\nreturns a ProductPriceInfo object wrapping the actual price with\nadditional information.", + "heading": "Description" + } + ], + "signature": "getPriceBookPriceInfo(priceBookID: string): ProductPriceInfo | null", + "source": "script-api", + "tags": [ + "getpricebookpriceinfo", + "productpricemodel.getpricebookpriceinfo" + ], + "title": "ProductPriceModel.getPriceBookPriceInfo" + }, + { + "description": "This method acts similarly to getPriceBookPrice but returns a ProductPriceInfo object wrapping the actual price with additional information.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + }, + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPriceInfo", + "returns": { + "type": "ProductPriceInfo | null" + }, + "sections": [ + { + "body": "This method acts similarly to\ngetPriceBookPrice but returns a\nProductPriceInfo object wrapping the actual price with additional\ninformation.", + "heading": "Description" + } + ], + "signature": "getPriceBookPriceInfo(priceBookID: string, quantity: Quantity): ProductPriceInfo | null", + "source": "script-api", + "tags": [ + "getpricebookpriceinfo", + "productpricemodel.getpricebookpriceinfo" + ], + "title": "ProductPriceModel.getPriceBookPriceInfo" + }, + { + "description": "Returns the active price per unit of the product in the specified price book for quantity 1.00.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the active price per unit of the product in the specified price book for\nquantity 1.00.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nMoney.NOT_AVAILABLE will be returned in any of the following cases:\n\n- The priceBookID does not identify a valid price book.\n- The price book has no price for the product.\n- None of the prices for the product in the price book is currently\nactive.\n- The currently active price entry is a percentage.", + "heading": "Description" + } + ], + "signature": "getPriceBookPricePerUnit(priceBookID: string): Money", + "source": "script-api", + "tags": [ + "getpricebookpriceperunit", + "productpricemodel.getpricebookpriceperunit" + ], + "title": "ProductPriceModel.getPriceBookPricePerUnit" + }, + { + "description": "Returns the active price per unit of the product in the specified price book for the specified quantity.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceBookPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + }, + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceBookPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the active price per unit of the product in the specified price book for\nthe specified quantity.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nMoney.NOT_AVAILABLE will be returned in any of the following cases:\n\n- The priceBookID does not identify a valid price book.\n- The price book has no price for the product.\n- None of the prices for the product in the price book is currently\nactive.\n- The currently active price entry is a percentage.", + "heading": "Description" + } + ], + "signature": "getPriceBookPricePerUnit(priceBookID: string, quantity: Quantity): Money", + "source": "script-api", + "tags": [ + "getpricebookpriceperunit", + "productpricemodel.getpricebookpriceperunit" + ], + "title": "ProductPriceModel.getPriceBookPricePerUnit" + }, + { + "description": "Returns the active price info of a product, calculated based on base price quantity 1.00. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfo", + "returns": { + "type": "ProductPriceInfo | null" + }, + "sections": [ + { + "body": "Returns the active price info of a product, calculated based on base price\nquantity 1.00. The price is returned for the currency of the current\nsession.\n\nThis method is similar to `getPrice()` but instead of just\nreturning the price value, it returns a `ProductPriceInfo`\nwhich contains additional information such as the PriceBook which defined\nthe price and the percentage discount this price point represents.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf no price info could be found, null is returned.", + "heading": "Description" + } + ], + "signature": "getPriceInfo(): ProductPriceInfo | null", + "source": "script-api", + "tags": [ + "getpriceinfo", + "productpricemodel.getpriceinfo" + ], + "title": "ProductPriceModel.getPriceInfo" + }, + { + "description": "Returns the active price info of a product, calculated based on the passed order quantity. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfo", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfo", + "returns": { + "type": "ProductPriceInfo | null" + }, + "sections": [ + { + "body": "Returns the active price info of a product, calculated based on the passed order\nquantity. The price is returned for the currency of the current session.\n\nThis method is similar to `getPrice(Quantity)` but instead of\njust returning the price value, it returns a\n`ProductPriceInfo` which contains additional information such\nas the PriceBook which defined the price and the percentage discount this\nprice point represents.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf no price info could be found, null is returned.", + "heading": "Description" + } + ], + "signature": "getPriceInfo(quantity: Quantity): ProductPriceInfo | null", + "source": "script-api", + "tags": [ + "getpriceinfo", + "productpricemodel.getpriceinfo" + ], + "title": "ProductPriceModel.getPriceInfo" + }, + { + "description": "Returns all the eligible `ProductPriceInfo`(s), calculated based on base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is only one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos indicate that there are that many price books that meet the criteria for returning the price shown in the storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceInfos", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceInfos", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all the eligible `ProductPriceInfo`(s), calculated based\non base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is\nonly one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos\nindicate that there are that many price books that meet the criteria for returning the price shown in the\nstorefront.", + "heading": "Description" + } + ], + "signature": "getPriceInfos(): Collection", + "source": "script-api", + "tags": [ + "getpriceinfos", + "productpricemodel.getpriceinfos" + ], + "title": "ProductPriceModel.getPriceInfos" + }, + { + "description": "Returns the sales price per unit of a product, calculated based on base price quantity 1.00.", + "id": "script-api:dw/catalog/ProductPriceModel#getPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sales price per unit of a product, calculated based on base price\nquantity 1.00.\n\nThe product sales price per unit is returned for the current session currency.\nHence, the using this method is only useful in storefront processes.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitly\nset as applicable in the current session.\n\nIf no price could be found, MONEY.N_A is returned.", + "heading": "Description" + } + ], + "signature": "getPricePerUnit(): Money", + "source": "script-api", + "tags": [ + "getpriceperunit", + "productpricemodel.getpriceperunit" + ], + "title": "ProductPriceModel.getPricePerUnit" + }, + { + "description": "Returns the sales price per unit of a product, calculated based on the passed order quantity.", + "id": "script-api:dw/catalog/ProductPriceModel#getPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sales price per unit of a product, calculated based on the passed\norder quantity.\n\nThe product sales price per unit is returned for the current session currency.\nHence, the using this method is only useful in storefront processes.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitely\nset as applicable in the current session.\n\nIf no price could be found, MONEY.N_A is returned.", + "heading": "Description" + } + ], + "signature": "getPricePerUnit(quantity: Quantity): Money", + "source": "script-api", + "tags": [ + "getpriceperunit", + "productpricemodel.getpriceperunit" + ], + "title": "ProductPriceModel.getPricePerUnit" + }, + { + "deprecated": { + "message": "Use dw.value.Money.percentLessThan" + }, + "description": "Calculates and returns the percentage off amount of the passed comparePrice to the passed basePrice.", + "id": "script-api:dw/catalog/ProductPriceModel#getPricePercentage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "basePrice", + "type": "Money" + }, + { + "name": "comparePrice", + "type": "Money" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPricePercentage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Calculates and returns the percentage off amount of the passed\ncomparePrice to the passed basePrice.", + "heading": "Description" + } + ], + "signature": "getPricePercentage(basePrice: Money, comparePrice: Money): number", + "source": "script-api", + "tags": [ + "getpricepercentage", + "productpricemodel.getpricepercentage" + ], + "title": "ProductPriceModel.getPricePercentage" + }, + { + "description": "Returns the product price table object. The price table represents a map between order quantities and prices, and also provides % off information to be shown to storefront customers. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#getPriceTable", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.getPriceTable", + "returns": { + "type": "ProductPriceTable" + }, + "sections": [ + { + "body": "Returns the product price table object. The price table represents a map\nbetween order quantities and prices, and also provides % off information\nto be shown to storefront customers. The price is returned for the\ncurrency of the current session.\n\nUsually, the product price table is printed on product detail pages in\nthe storefront.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nAll other methods of this class are based on the information in the\nproduct price table.", + "heading": "Description" + } + ], + "signature": "getPriceTable(): ProductPriceTable", + "source": "script-api", + "tags": [ + "getpricetable", + "productpricemodel.getpricetable" + ], + "title": "ProductPriceModel.getPriceTable" + }, + { + "description": "Returns true if this product is a master product (or product set) and the collection of online variants (or set products respectively) contains products of different prices.", + "id": "script-api:dw/catalog/ProductPriceModel#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.isPriceRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this product is a master product (or product set) and the\ncollection of online variants (or set products respectively) contains\nproducts of different prices.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "isPriceRange(): boolean", + "source": "script-api", + "tags": [ + "ispricerange", + "productpricemodel.ispricerange" + ], + "title": "ProductPriceModel.isPriceRange" + }, + { + "description": "Returns true if this product is a master product (or product set) and the collection of online variants (or set products respectively) contains products of different prices in the specified price book.", + "id": "script-api:dw/catalog/ProductPriceModel#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceBookID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.isPriceRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this product is a master product (or product set) and the\ncollection of online variants (or set products respectively) contains\nproducts of different prices in the specified price book.", + "heading": "Description" + } + ], + "signature": "isPriceRange(priceBookID: string): boolean", + "source": "script-api", + "tags": [ + "ispricerange", + "productpricemodel.ispricerange" + ], + "title": "ProductPriceModel.isPriceRange" + }, + { + "description": "Calculates and returns the maximum price-book price of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPrice. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#maxPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.maxPrice", + "sections": [ + { + "body": "Calculates and returns the maximum price-book price of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPrice.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "readonly maxPrice: Money", + "source": "script-api", + "tags": [ + "maxprice", + "productpricemodel.maxprice" + ], + "title": "ProductPriceModel.maxPrice" + }, + { + "description": "Calculates and returns the maximum price-book price per unit of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPricePerUnit. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#maxPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.maxPricePerUnit", + "sections": [ + { + "body": "Calculates and returns the maximum price-book price per unit of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPricePerUnit.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\ne.g.\nsuppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:\nv1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).\nThe max price per unit of mp will be max($6/2, $5/5, $10/20) = $3", + "heading": "Description" + } + ], + "signature": "readonly maxPricePerUnit: Money", + "source": "script-api", + "tags": [ + "maxpriceperunit", + "productpricemodel.maxpriceperunit" + ], + "title": "ProductPriceModel.maxPricePerUnit" + }, + { + "description": "Calculates and returns the minimum price-book price of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPrice. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#minPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.minPrice", + "sections": [ + { + "body": "Calculates and returns the minimum price-book price of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPrice.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "readonly minPrice: Money", + "source": "script-api", + "tags": [ + "minprice", + "productpricemodel.minprice" + ], + "title": "ProductPriceModel.minPrice" + }, + { + "description": "Calculates and returns the minimum price-book price per unit of all variants (for master products) or set-products (for product sets) for base quantity 1.00. This value can be used to display a range of prices in storefront. If the product represented by this model is not a master product or product set, then this method behaves the same as getPricePerUnit. Only online products are considered. If the \"orderable products only\" search preference is enabled for the current site, then only orderable products are considered. For master products, only variants with all variation attributes configured are considered.", + "id": "script-api:dw/catalog/ProductPriceModel#minPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.minPricePerUnit", + "sections": [ + { + "body": "Calculates and returns the minimum price-book price per unit of all variants (for\nmaster products) or set-products (for product sets) for base quantity\n1.00. This value can be used to display a range of prices in storefront.\nIf the product represented by this model is not a master product or\nproduct set, then this method behaves the same as getPricePerUnit.\nOnly online products are considered. If the \"orderable products only\"\nsearch preference is enabled for the current site, then only orderable\nproducts are considered. For master products, only variants with all\nvariation attributes configured are considered.\n\ne.g.\nsuppose one master product mp (price = $6, unitQuantity = 2), it has 2 variants:\nv1(price = $5, unitQuantity = 5), v2(price = $10, unitQuantity = 20).\nThe min price per unit of mp will be min($6/2, $5/5, $10/20) = $0.5", + "heading": "Description" + } + ], + "signature": "readonly minPricePerUnit: Money", + "source": "script-api", + "tags": [ + "minpriceperunit", + "productpricemodel.minpriceperunit" + ], + "title": "ProductPriceModel.minPricePerUnit" + }, + { + "description": "Returns the active price of a product, calculated based on base price quantity 1.00. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#price", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.price", + "sections": [ + { + "body": "Returns the active price of a product, calculated based on base price quantity\n1.00. The price is returned for the currency of the current session.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitly\nset as applicable in the current session.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf no price could be found, MONEY.NOT_AVAILABLE is returned.", + "heading": "Description" + } + ], + "signature": "readonly price: Money", + "source": "script-api", + "tags": [ + "price", + "productpricemodel.price" + ], + "title": "ProductPriceModel.price" + }, + { + "description": "Returns the active price info of a product, calculated based on base price quantity 1.00. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#priceInfo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceInfo", + "sections": [ + { + "body": "Returns the active price info of a product, calculated based on base price\nquantity 1.00. The price is returned for the currency of the current\nsession.\n\nThis method is similar to `getPrice()` but instead of just\nreturning the price value, it returns a `ProductPriceInfo`\nwhich contains additional information such as the PriceBook which defined\nthe price and the percentage discount this price point represents.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nIf no price info could be found, null is returned.", + "heading": "Description" + } + ], + "signature": "readonly priceInfo: ProductPriceInfo | null", + "source": "script-api", + "tags": [ + "priceinfo", + "productpricemodel.priceinfo" + ], + "title": "ProductPriceModel.priceInfo" + }, + { + "description": "Returns all the eligible `ProductPriceInfo`(s), calculated based on base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is only one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos indicate that there are that many price books that meet the criteria for returning the price shown in the storefront.", + "id": "script-api:dw/catalog/ProductPriceModel#priceInfos", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceInfos", + "sections": [ + { + "body": "Returns all the eligible `ProductPriceInfo`(s), calculated based\non base price quantity 1.00. This will return an empty list if getPriceInfo() would return null, and if there is\nonly one price info in the collection it will be the same price info as getPriceInfo(). Two or more price infos\nindicate that there are that many price books that meet the criteria for returning the price shown in the\nstorefront.", + "heading": "Description" + } + ], + "signature": "readonly priceInfos: Collection", + "source": "script-api", + "tags": [ + "priceinfos", + "productpricemodel.priceinfos" + ], + "title": "ProductPriceModel.priceInfos" + }, + { + "description": "Returns the sales price per unit of a product, calculated based on base price quantity 1.00.", + "id": "script-api:dw/catalog/ProductPriceModel#pricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.pricePerUnit", + "sections": [ + { + "body": "Returns the sales price per unit of a product, calculated based on base price\nquantity 1.00.\n\nThe product sales price per unit is returned for the current session currency.\nHence, the using this method is only useful in storefront processes.\n\nThe price lookup is based on the configuration of price books. It depends\non various settings, such as which price books are active, or explicitly\nset as applicable in the current session.\n\nIf no price could be found, MONEY.N_A is returned.", + "heading": "Description" + } + ], + "signature": "readonly pricePerUnit: Money", + "source": "script-api", + "tags": [ + "priceperunit", + "productpricemodel.priceperunit" + ], + "title": "ProductPriceModel.pricePerUnit" + }, + { + "description": "Returns true if this product is a master product (or product set) and the collection of online variants (or set products respectively) contains products of different prices.", + "id": "script-api:dw/catalog/ProductPriceModel#priceRange", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceRange", + "sections": [ + { + "body": "Returns true if this product is a master product (or product set) and the\ncollection of online variants (or set products respectively) contains\nproducts of different prices.\n\nWarning: If the product represented by this model is a master\nproduct with numerous variants, this method can be very expensive and\nshould be avoided.", + "heading": "Description" + } + ], + "signature": "readonly priceRange: boolean", + "source": "script-api", + "tags": [ + "pricerange", + "productpricemodel.pricerange" + ], + "title": "ProductPriceModel.priceRange" + }, + { + "description": "Returns the product price table object. The price table represents a map between order quantities and prices, and also provides % off information to be shown to storefront customers. The price is returned for the currency of the current session.", + "id": "script-api:dw/catalog/ProductPriceModel#priceTable", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceModel", + "qualifiedName": "dw.catalog.ProductPriceModel.priceTable", + "sections": [ + { + "body": "Returns the product price table object. The price table represents a map\nbetween order quantities and prices, and also provides % off information\nto be shown to storefront customers. The price is returned for the\ncurrency of the current session.\n\nUsually, the product price table is printed on product detail pages in\nthe storefront.\n\nIf the product represented by this model is an option product, option\nprices will be added to the price book price if the price model was\ninitialized with an option model.\n\nAll other methods of this class are based on the information in the\nproduct price table.", + "heading": "Description" + } + ], + "signature": "readonly priceTable: ProductPriceTable", + "source": "script-api", + "tags": [ + "pricetable", + "productpricemodel.pricetable" + ], + "title": "ProductPriceModel.priceTable" + }, + { + "description": "A ProductPriceTable is a map of quantities to prices representing the potentially tiered prices of a product in Commerce Cloud Digital. The price of a product is the price associated with the largest quantity in the ProductPriceTable which does not exceed the purchase quantity.", + "id": "script-api:dw/catalog/ProductPriceTable", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductPriceTable", + "sections": [ + { + "body": "A ProductPriceTable is a map of quantities to prices representing the\npotentially tiered prices of a product in Commerce Cloud Digital. The price\nof a product is the price associated with the largest quantity in\nthe ProductPriceTable which does not exceed the purchase quantity.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productpricetable", + "dw.catalog.productpricetable", + "dw/catalog" + ], + "title": "ProductPriceTable" + }, + { + "description": "Returns the quantity following the passed quantity in the price table. If the passed quantity is the last entry in the price table, null is returned.", + "id": "script-api:dw/catalog/ProductPriceTable#getNextQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getNextQuantity", + "returns": { + "type": "Quantity | null" + }, + "sections": [ + { + "body": "Returns the quantity following the passed quantity in the price table.\nIf the passed quantity is the last entry in the price table, null is\nreturned.", + "heading": "Description" + } + ], + "signature": "getNextQuantity(quantity: Quantity): Quantity | null", + "source": "script-api", + "tags": [ + "getnextquantity", + "productpricetable.getnextquantity" + ], + "title": "ProductPriceTable.getNextQuantity" + }, + { + "description": "Returns the percentage off value of the price related to the passed quantity, calculated based on the price of the products minimum order quantity.", + "id": "script-api:dw/catalog/ProductPriceTable#getPercentage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPercentage", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the percentage off value of the price related to the passed quantity,\ncalculated based on the price of the products minimum order quantity.", + "heading": "Description" + } + ], + "signature": "getPercentage(quantity: Quantity): number", + "source": "script-api", + "tags": [ + "getpercentage", + "productpricetable.getpercentage" + ], + "title": "ProductPriceTable.getPercentage" + }, + { + "description": "Returns the monetary price for the passed order quantity. If no price is defined for the passed quantity, null is returned. This can happen if for example no price is defined for a single item.", + "id": "script-api:dw/catalog/ProductPriceTable#getPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPrice", + "returns": { + "type": "Money | null" + }, + "sections": [ + { + "body": "Returns the monetary price for the passed order quantity. If\nno price is defined for the passed quantity, null is returned. This\ncan happen if for example no price is defined for a single item.", + "heading": "Description" + } + ], + "signature": "getPrice(quantity: Quantity): Money | null", + "source": "script-api", + "tags": [ + "getprice", + "productpricetable.getprice" + ], + "title": "ProductPriceTable.getPrice" + }, + { + "description": "Returns the price book which defined the monetary price for the passed order quantity. If no price is defined for the passed quantity, null is returned. This can happen if for example no price is defined for a single item.", + "id": "script-api:dw/catalog/ProductPriceTable#getPriceBook", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getPriceBook", + "returns": { + "type": "PriceBook | null" + }, + "sections": [ + { + "body": "Returns the price book which defined the monetary price for the passed\norder quantity. If no price is defined for the passed quantity, null is\nreturned. This can happen if for example no price is defined for a single\nitem.", + "heading": "Description" + } + ], + "signature": "getPriceBook(quantity: Quantity): PriceBook | null", + "source": "script-api", + "tags": [ + "getpricebook", + "productpricetable.getpricebook" + ], + "title": "ProductPriceTable.getPriceBook" + }, + { + "description": "Returns all quantities stored in the price table.", + "id": "script-api:dw/catalog/ProductPriceTable#getQuantities", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.getQuantities", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all quantities stored in the price table.", + "heading": "Description" + } + ], + "signature": "getQuantities(): Collection", + "source": "script-api", + "tags": [ + "getquantities", + "productpricetable.getquantities" + ], + "title": "ProductPriceTable.getQuantities" + }, + { + "description": "Returns all quantities stored in the price table.", + "id": "script-api:dw/catalog/ProductPriceTable#quantities", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductPriceTable", + "qualifiedName": "dw.catalog.ProductPriceTable.quantities", + "sections": [ + { + "body": "Returns all quantities stored in the price table.", + "heading": "Description" + } + ], + "signature": "readonly quantities: Collection", + "source": "script-api", + "tags": [ + "quantities", + "productpricetable.quantities" + ], + "title": "ProductPriceTable.quantities" + }, + { + "description": "ProductSearchHit is the result of a executed search query and wraps the actual product found by the search.", + "id": "script-api:dw/catalog/ProductSearchHit", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchHit", + "sections": [ + { + "body": "ProductSearchHit is the result of a executed search query and wraps the actual product found by the search.\n\nThe method getRepresentedProducts returns the actual products that is conforming the query and is represented by the search hit.\nDepending on the hit typ, getRepresentedProducts returns:\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation product\n- HIT_TYPE_PRODUCT_SET -> a product part of set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product part of a bundle\n- HIT_TYPE_VARIATION_GROUP -> a variation product\n\nThe ProductSearchHit type can be retrieved by method getHitType and contains the following types:\n\n- HIT_TYPE_SIMPLE\n- HIT_TYPE_PRODUCT_MASTER\n- HIT_TYPE_PRODUCT_SET\n- HIT_TYPE_PRODUCT_BUNDLE\n- HIT_TYPE_VARIATION_GROUP\n\nThe method getProduct returns the presentation product corresponding to the ProductSearchHit type.\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation master product\n- HIT_TYPE_PRODUCT_SET -> a product set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation group\n\nExample:\n\nGiven a product master P1 called \"Sweater\" with attributes color and size that has the following variants:\n\n- V1 - color: red, size: small\n- V2 - color: red, size: large\n- V3 - color: blue, size: small\n- V4 - color: blue, size: large\n- V5 - color: yellow, size: small\n- V6 - color: yellow, size: large\n\nA search for \"red sweater\" should hit the first two variants, V1 and V2\nthat are both red. The ProductSearchHit for this result encompass the master and the red variants but not the other\nnon-relevant variants.\n\nThe variants hit by the query can be retrieved by getRepresentedProducts, returning a list that contains the two red sweater variants.\n\nThe master product \"Sweater\" is returned by getProduct.\n\nFurthermore, to get the first or last of that list of variants hit by the query we can call\ngetFirstRepresentedProduct or getLastRepresentedProduct. The product with the highest\nsort rank is returned first, and the product with the lowest sort rank is\nreturned last. The product sort rank depends on the sorting conditions\nused for the search query.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productsearchhit", + "dw.catalog.productsearchhit", + "dw/catalog" + ], + "title": "ProductSearchHit" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product bundles.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_BUNDLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product bundles.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_BUNDLE: string", + "source": "script-api", + "tags": [ + "hit_type_product_bundle", + "productsearchhit.hit_type_product_bundle" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product bundles.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_BUNDLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product bundles.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_BUNDLE: string", + "source": "script-api", + "tags": [ + "hit_type_product_bundle", + "productsearchhit.hit_type_product_bundle" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with master products.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_MASTER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with master products.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_MASTER: string", + "source": "script-api", + "tags": [ + "hit_type_product_master", + "productsearchhit.hit_type_product_master" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_MASTER" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with master products.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_MASTER", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with master products.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_MASTER: string", + "source": "script-api", + "tags": [ + "hit_type_product_master", + "productsearchhit.hit_type_product_master" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_MASTER" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product sets.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_SET", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product sets.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_SET: string", + "source": "script-api", + "tags": [ + "hit_type_product_set", + "productsearchhit.hit_type_product_set" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_SET" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product sets.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_PRODUCT_SET", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with product sets.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_PRODUCT_SET: string", + "source": "script-api", + "tags": [ + "hit_type_product_set", + "productsearchhit.hit_type_product_set" + ], + "title": "ProductSearchHit.HIT_TYPE_PRODUCT_SET" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with single, non-complex products, including product variants that are assigned to a category and are returned as the presentation product.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SIMPLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with single, non-complex products, including product variants that\nare assigned to a category and are returned as the presentation product.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_SIMPLE: string", + "source": "script-api", + "tags": [ + "hit_type_simple", + "productsearchhit.hit_type_simple" + ], + "title": "ProductSearchHit.HIT_TYPE_SIMPLE" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with single, non-complex products, including product variants that are assigned to a category and are returned as the presentation product.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SIMPLE", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with single, non-complex products, including product variants that\nare assigned to a category and are returned as the presentation product.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_SIMPLE: string", + "source": "script-api", + "tags": [ + "hit_type_simple", + "productsearchhit.hit_type_simple" + ], + "title": "ProductSearchHit.HIT_TYPE_SIMPLE" + }, + { + "deprecated": { + "message": "Please use HIT_TYPE_VARIATION_GROUP instead." + }, + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with slicing groups.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SLICING_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with slicing groups.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_SLICING_GROUP: string", + "source": "script-api", + "tags": [ + "hit_type_slicing_group", + "productsearchhit.hit_type_slicing_group" + ], + "title": "ProductSearchHit.HIT_TYPE_SLICING_GROUP" + }, + { + "deprecated": { + "message": "Please use HIT_TYPE_VARIATION_GROUP instead." + }, + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with slicing groups.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_SLICING_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with slicing groups.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_SLICING_GROUP: string", + "source": "script-api", + "tags": [ + "hit_type_slicing_group", + "productsearchhit.hit_type_slicing_group" + ], + "title": "ProductSearchHit.HIT_TYPE_SLICING_GROUP" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with variation groups.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_VARIATION_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with variation groups.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_VARIATION_GROUP: string", + "source": "script-api", + "tags": [ + "hit_type_variation_group", + "productsearchhit.hit_type_variation_group" + ], + "title": "ProductSearchHit.HIT_TYPE_VARIATION_GROUP" + }, + { + "description": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with variation groups.", + "id": "script-api:dw/catalog/ProductSearchHit#HIT_TYPE_VARIATION_GROUP", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "sections": [ + { + "body": "Constant representing a product search hit type based on the presentation product of a hit. This hit type is used with variation groups.", + "heading": "Description" + } + ], + "signature": "static readonly HIT_TYPE_VARIATION_GROUP: string", + "source": "script-api", + "tags": [ + "hit_type_variation_group", + "productsearchhit.hit_type_variation_group" + ], + "title": "ProductSearchHit.HIT_TYPE_VARIATION_GROUP" + }, + { + "description": "Returns the product that is actually hit by the search and has the highest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#firstRepresentedProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.firstRepresentedProduct", + "sections": [ + { + "body": "Returns the product that is actually hit by the search and has the highest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "readonly firstRepresentedProduct: Product", + "source": "script-api", + "tags": [ + "firstrepresentedproduct", + "productsearchhit.firstrepresentedproduct" + ], + "title": "ProductSearchHit.firstRepresentedProduct" + }, + { + "description": "Returns the ID of the product that is actually hit by the search and has the highest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#firstRepresentedProductID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.firstRepresentedProductID", + "sections": [ + { + "body": "Returns the ID of the product that is actually hit by the search and has the highest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "readonly firstRepresentedProductID: string", + "source": "script-api", + "tags": [ + "firstrepresentedproductid", + "productsearchhit.firstrepresentedproductid" + ], + "title": "ProductSearchHit.firstRepresentedProductID" + }, + { + "description": "Returns the product that is actually hit by the search and has the highest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#getFirstRepresentedProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getFirstRepresentedProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the product that is actually hit by the search and has the highest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "getFirstRepresentedProduct(): Product", + "source": "script-api", + "tags": [ + "getfirstrepresentedproduct", + "productsearchhit.getfirstrepresentedproduct" + ], + "title": "ProductSearchHit.getFirstRepresentedProduct" + }, + { + "description": "Returns the ID of the product that is actually hit by the search and has the highest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#getFirstRepresentedProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getFirstRepresentedProductID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product that is actually hit by the search and has the highest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "getFirstRepresentedProductID(): string", + "source": "script-api", + "tags": [ + "getfirstrepresentedproductid", + "productsearchhit.getfirstrepresentedproductid" + ], + "title": "ProductSearchHit.getFirstRepresentedProductID" + }, + { + "description": "Returns the type of the product wrapped by this search hit. The product type returned will be one of the hit types:", + "id": "script-api:dw/catalog/ProductSearchHit#getHitType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getHitType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the product wrapped by this search hit. The product type returned will be one of the hit types:\n\n- dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET\n- dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP\n- dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "heading": "Description" + } + ], + "signature": "getHitType(): string", + "source": "script-api", + "tags": [ + "gethittype", + "productsearchhit.gethittype" + ], + "title": "ProductSearchHit.getHitType" + }, + { + "description": "Returns the product that is actually hit by the search and has the lowest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#getLastRepresentedProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getLastRepresentedProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the product that is actually hit by the search and has the lowest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "getLastRepresentedProduct(): Product", + "source": "script-api", + "tags": [ + "getlastrepresentedproduct", + "productsearchhit.getlastrepresentedproduct" + ], + "title": "ProductSearchHit.getLastRepresentedProduct" + }, + { + "description": "Returns the ID of the product that is actually hit by the search and has the lowest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#getLastRepresentedProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getLastRepresentedProductID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product that is actually hit by the search and has the lowest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "getLastRepresentedProductID(): string", + "source": "script-api", + "tags": [ + "getlastrepresentedproductid", + "productsearchhit.getlastrepresentedproductid" + ], + "title": "ProductSearchHit.getLastRepresentedProductID" + }, + { + "description": "Returns the maximum price of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the maximum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#getMaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMaxPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the maximum price of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the maximum. The method returns\n`N/A` in case no price information can be found.\n\nNote: The method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "getMaxPrice(): Money", + "source": "script-api", + "tags": [ + "getmaxprice", + "productsearchhit.getmaxprice" + ], + "title": "ProductSearchHit.getMaxPrice" + }, + { + "description": "Returns the maximum price per unit of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the maximum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#getMaxPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMaxPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the maximum price per unit of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the maximum. The method returns\n`N/A` in case no price information can be found.\n\nNote: The method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "getMaxPricePerUnit(): Money", + "source": "script-api", + "tags": [ + "getmaxpriceperunit", + "productsearchhit.getmaxpriceperunit" + ], + "title": "ProductSearchHit.getMaxPricePerUnit" + }, + { + "description": "Returns the minimum price of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the minimum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#getMinPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMinPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the minimum price of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the minimum. The method returns\n`N/A` in case no price information can be found.\n\nNote: the method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "getMinPrice(): Money", + "source": "script-api", + "tags": [ + "getminprice", + "productsearchhit.getminprice" + ], + "title": "ProductSearchHit.getMinPrice" + }, + { + "description": "Returns the minimum price per unit of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the minimum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#getMinPricePerUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getMinPricePerUnit", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the minimum price per unit of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the minimum. The method returns\n`N/A` in case no price information can be found.\n\nNote: the method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "getMinPricePerUnit(): Money", + "source": "script-api", + "tags": [ + "getminpriceperunit", + "productsearchhit.getminpriceperunit" + ], + "title": "ProductSearchHit.getMinPricePerUnit" + }, + { + "description": "Returns the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.", + "id": "script-api:dw/catalog/ProductSearchHit#getProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation master product\n- HIT_TYPE_PRODUCT_SET -> a product set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation group\n\nTo retrieve the product(s) actually hit by the search use getRepresentedProducts.", + "heading": "Description" + } + ], + "signature": "getProduct(): Product", + "source": "script-api", + "tags": [ + "getproduct", + "productsearchhit.getproduct" + ], + "title": "ProductSearchHit.getProduct" + }, + { + "description": "Returns the ID of the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.", + "id": "script-api:dw/catalog/ProductSearchHit#getProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getProductID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation master product\n- HIT_TYPE_PRODUCT_SET -> a product set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation group\n\nTo retrieve the ID of the product actually hit by the search use getFirstRepresentedProductID or getLastRepresentedProductID.", + "heading": "Description" + } + ], + "signature": "getProductID(): string", + "source": "script-api", + "tags": [ + "getproductid", + "productsearchhit.getproductid" + ], + "title": "ProductSearchHit.getProductID" + }, + { + "description": "The method returns the actual ID of the product that is conforming the query and is represented by the search hit. Depending on the hit typ, it returns the ID of:", + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedProductIDs", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "The method returns the actual ID of the product that is conforming the query and is represented by the search hit.\nDepending on the hit typ, it returns the ID of:\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation product\n- HIT_TYPE_PRODUCT_SET -> a product part of set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product part of a bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation product\n\nIf the method returns multiple products, the product with the highest\nsort rank is returned first, and the product with the lowest sort rank is\nreturned last. The product sort rank depends on the sorting conditions\nused for the search query.", + "heading": "Description" + } + ], + "signature": "getRepresentedProductIDs(): List", + "source": "script-api", + "tags": [ + "getrepresentedproductids", + "productsearchhit.getrepresentedproductids" + ], + "title": "ProductSearchHit.getRepresentedProductIDs" + }, + { + "description": "The method returns the actual product that is conforming the query and is represented by the search hit. Depending on the hit typ, getRepresentedProducts returns:", + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedProducts", + "returns": { + "type": "List>" + }, + "sections": [ + { + "body": "The method returns the actual product that is conforming the query and is represented by the search hit.\nDepending on the hit typ, getRepresentedProducts returns:\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation product\n- HIT_TYPE_PRODUCT_SET -> a product part of set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product part of a bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation product\n\nIf the method returns multiple products, the product with the highest\nsort rank is returned first, and the product with the lowest sort rank is\nreturned last. The product sort rank depends on the sorting conditions\nused for the search query.", + "heading": "Description" + } + ], + "signature": "getRepresentedProducts(): List>", + "source": "script-api", + "tags": [ + "getrepresentedproducts", + "productsearchhit.getrepresentedproducts" + ], + "title": "ProductSearchHit.getRepresentedProducts" + }, + { + "description": "This method is only applicable if this ProductSearchHit represents a product variation (see getRepresentedProducts). It returns the distinct value set for the specified variation attribute for all variants represented by this ProductSearchHit. The values are returned in the same order as they are defined for the variation.", + "id": "script-api:dw/catalog/ProductSearchHit#getRepresentedVariationValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "va", + "type": "any" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.getRepresentedVariationValues", + "returns": { + "type": "List | null" + }, + "sections": [ + { + "body": "This method is only applicable if this ProductSearchHit represents a\nproduct variation (see getRepresentedProducts). It returns the\ndistinct value set for the specified variation attribute for all variants\nrepresented by this ProductSearchHit. The values are returned in the same\norder as they are defined for the variation.\n\nThis method will accept a ProductVariationAttribute parameter or a String\nwhich is the ID of a variation attribute. If any other object type is\npassed, or null is passed, an exception will be thrown. If this\nProductSearchHit does not represent a product variation, or the passed\nvariation attribute is not associated with this product, the method\nreturns an empty list.", + "heading": "Description" + } + ], + "signature": "getRepresentedVariationValues(va: any): List | null", + "source": "script-api", + "tags": [ + "getrepresentedvariationvalues", + "productsearchhit.getrepresentedvariationvalues" + ], + "title": "ProductSearchHit.getRepresentedVariationValues" + }, + { + "description": "Returns the type of the product wrapped by this search hit. The product type returned will be one of the hit types:", + "id": "script-api:dw/catalog/ProductSearchHit#hitType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.hitType", + "sections": [ + { + "body": "Returns the type of the product wrapped by this search hit. The product type returned will be one of the hit types:\n\n- dw.catalog.ProductSearchHit.HIT_TYPE_SIMPLE\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_MASTER\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_BUNDLE\n- dw.catalog.ProductSearchHit.HIT_TYPE_PRODUCT_SET\n- dw.catalog.ProductSearchHit.HIT_TYPE_SLICING_GROUP\n- dw.catalog.ProductSearchHit.HIT_TYPE_VARIATION_GROUP", + "heading": "Description" + } + ], + "signature": "readonly hitType: string", + "source": "script-api", + "tags": [ + "hittype", + "productsearchhit.hittype" + ], + "title": "ProductSearchHit.hitType" + }, + { + "description": "Convenience method to check whether this ProductSearchHit represents multiple products (see getRepresentedProducts) that have different prices.", + "id": "script-api:dw/catalog/ProductSearchHit#isPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.isPriceRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Convenience method to check whether this ProductSearchHit represents\nmultiple products (see getRepresentedProducts) that have\ndifferent prices.", + "heading": "Description" + } + ], + "signature": "isPriceRange(): boolean", + "source": "script-api", + "tags": [ + "ispricerange", + "productsearchhit.ispricerange" + ], + "title": "ProductSearchHit.isPriceRange" + }, + { + "description": "Returns the product that is actually hit by the search and has the lowest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#lastRepresentedProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.lastRepresentedProduct", + "sections": [ + { + "body": "Returns the product that is actually hit by the search and has the lowest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "readonly lastRepresentedProduct: Product", + "source": "script-api", + "tags": [ + "lastrepresentedproduct", + "productsearchhit.lastrepresentedproduct" + ], + "title": "ProductSearchHit.lastRepresentedProduct" + }, + { + "description": "Returns the ID of the product that is actually hit by the search and has the lowest sort rank according to the sorting conditions used for the search query.", + "id": "script-api:dw/catalog/ProductSearchHit#lastRepresentedProductID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.lastRepresentedProductID", + "sections": [ + { + "body": "Returns the ID of the product that is actually hit by the search and has the lowest\nsort rank according to the sorting conditions used for the search query.", + "heading": "Description" + } + ], + "signature": "readonly lastRepresentedProductID: string", + "source": "script-api", + "tags": [ + "lastrepresentedproductid", + "productsearchhit.lastrepresentedproductid" + ], + "title": "ProductSearchHit.lastRepresentedProductID" + }, + { + "description": "Returns the maximum price of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the maximum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#maxPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.maxPrice", + "sections": [ + { + "body": "Returns the maximum price of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the maximum. The method returns\n`N/A` in case no price information can be found.\n\nNote: The method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "readonly maxPrice: Money", + "source": "script-api", + "tags": [ + "maxprice", + "productsearchhit.maxprice" + ], + "title": "ProductSearchHit.maxPrice" + }, + { + "description": "Returns the maximum price per unit of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the maximum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#maxPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.maxPricePerUnit", + "sections": [ + { + "body": "Returns the maximum price per unit of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the maximum. The method returns\n`N/A` in case no price information can be found.\n\nNote: The method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "readonly maxPricePerUnit: Money", + "source": "script-api", + "tags": [ + "maxpriceperunit", + "productsearchhit.maxpriceperunit" + ], + "title": "ProductSearchHit.maxPricePerUnit" + }, + { + "description": "Returns the minimum price of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the minimum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#minPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.minPrice", + "sections": [ + { + "body": "Returns the minimum price of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the minimum. The method returns\n`N/A` in case no price information can be found.\n\nNote: the method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "readonly minPrice: Money", + "source": "script-api", + "tags": [ + "minprice", + "productsearchhit.minprice" + ], + "title": "ProductSearchHit.minPrice" + }, + { + "description": "Returns the minimum price per unit of all products represented by the product hit. See getRepresentedProducts for details on the set of products used for finding the minimum. The method returns `N/A` in case no price information can be found.", + "id": "script-api:dw/catalog/ProductSearchHit#minPricePerUnit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.minPricePerUnit", + "sections": [ + { + "body": "Returns the minimum price per unit of all products represented by the\nproduct hit. See getRepresentedProducts for details on\nthe set of products used for finding the minimum. The method returns\n`N/A` in case no price information can be found.\n\nNote: the method uses price information of the search index and therefore\nmight return different prices than the ProductPriceModel.", + "heading": "Description" + } + ], + "signature": "readonly minPricePerUnit: Money", + "source": "script-api", + "tags": [ + "minpriceperunit", + "productsearchhit.minpriceperunit" + ], + "title": "ProductSearchHit.minPricePerUnit" + }, + { + "description": "Convenience method to check whether this ProductSearchHit represents multiple products (see getRepresentedProducts) that have different prices.", + "id": "script-api:dw/catalog/ProductSearchHit#priceRange", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.priceRange", + "sections": [ + { + "body": "Convenience method to check whether this ProductSearchHit represents\nmultiple products (see getRepresentedProducts) that have\ndifferent prices.", + "heading": "Description" + } + ], + "signature": "readonly priceRange: boolean", + "source": "script-api", + "tags": [ + "pricerange", + "productsearchhit.pricerange" + ], + "title": "ProductSearchHit.priceRange" + }, + { + "description": "Returns the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.", + "id": "script-api:dw/catalog/ProductSearchHit#product", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.product", + "sections": [ + { + "body": "Returns the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation master product\n- HIT_TYPE_PRODUCT_SET -> a product set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation group\n\nTo retrieve the product(s) actually hit by the search use getRepresentedProducts.", + "heading": "Description" + } + ], + "signature": "readonly product: Product", + "source": "script-api", + "tags": [ + "product", + "productsearchhit.product" + ], + "title": "ProductSearchHit.product" + }, + { + "description": "Returns the ID of the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.", + "id": "script-api:dw/catalog/ProductSearchHit#productID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.productID", + "sections": [ + { + "body": "Returns the ID of the presentation product of this ProductSearchHit corresponding to the ProductSearchHit type.\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation master product\n- HIT_TYPE_PRODUCT_SET -> a product set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation group\n\nTo retrieve the ID of the product actually hit by the search use getFirstRepresentedProductID or getLastRepresentedProductID.", + "heading": "Description" + } + ], + "signature": "readonly productID: string", + "source": "script-api", + "tags": [ + "productid", + "productsearchhit.productid" + ], + "title": "ProductSearchHit.productID" + }, + { + "description": "The method returns the actual ID of the product that is conforming the query and is represented by the search hit. Depending on the hit typ, it returns the ID of:", + "id": "script-api:dw/catalog/ProductSearchHit#representedProductIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.representedProductIDs", + "sections": [ + { + "body": "The method returns the actual ID of the product that is conforming the query and is represented by the search hit.\nDepending on the hit typ, it returns the ID of:\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation product\n- HIT_TYPE_PRODUCT_SET -> a product part of set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product part of a bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation product\n\nIf the method returns multiple products, the product with the highest\nsort rank is returned first, and the product with the lowest sort rank is\nreturned last. The product sort rank depends on the sorting conditions\nused for the search query.", + "heading": "Description" + } + ], + "signature": "readonly representedProductIDs: List", + "source": "script-api", + "tags": [ + "representedproductids", + "productsearchhit.representedproductids" + ], + "title": "ProductSearchHit.representedProductIDs" + }, + { + "description": "The method returns the actual product that is conforming the query and is represented by the search hit. Depending on the hit typ, getRepresentedProducts returns:", + "id": "script-api:dw/catalog/ProductSearchHit#representedProducts", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchHit", + "qualifiedName": "dw.catalog.ProductSearchHit.representedProducts", + "sections": [ + { + "body": "The method returns the actual product that is conforming the query and is represented by the search hit.\nDepending on the hit typ, getRepresentedProducts returns:\n\n- HIT_TYPE_SIMPLE -> a simple product\n- HIT_TYPE_PRODUCT_MASTER -> a variation product\n- HIT_TYPE_PRODUCT_SET -> a product part of set\n- HIT_TYPE_PRODUCT_BUNDLE -> a product part of a bundle\n- HIT_TYPE_VARIATION_GROUP ->a variation product\n\nIf the method returns multiple products, the product with the highest\nsort rank is returned first, and the product with the lowest sort rank is\nreturned last. The product sort rank depends on the sorting conditions\nused for the search query.", + "heading": "Description" + } + ], + "signature": "readonly representedProducts: List>", + "source": "script-api", + "tags": [ + "representedproducts", + "productsearchhit.representedproducts" + ], + "title": "ProductSearchHit.representedProducts" + }, + { + "description": "The class is the central interface to a product search result and a product search refinement. It also provides utility methods to generate a search URL.", + "id": "script-api:dw/catalog/ProductSearchModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchModel", + "sections": [ + { + "body": "The class is the central interface to a product search result and a product\nsearch refinement. It also provides utility methods to generate a search URL.", + "heading": "Description" + }, + { + "body": "Extends `SearchModel`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productsearchmodel", + "dw.catalog.productsearchmodel", + "dw/catalog" + ], + "title": "ProductSearchModel" + }, + { + "description": "URL Parameter for the category ID", + "id": "script-api:dw/catalog/ProductSearchModel#CATEGORYID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.CATEGORYID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the category ID", + "heading": "Description" + } + ], + "signature": "static readonly CATEGORYID_PARAMETER = \"cgid\"", + "source": "script-api", + "tags": [ + "categoryid_parameter", + "productsearchmodel.categoryid_parameter" + ], + "title": "ProductSearchModel.CATEGORYID_PARAMETER" + }, + { + "description": "URL Parameter for the category ID", + "id": "script-api:dw/catalog/ProductSearchModel#CATEGORYID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.CATEGORYID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the category ID", + "heading": "Description" + } + ], + "signature": "static readonly CATEGORYID_PARAMETER = \"cgid\"", + "source": "script-api", + "tags": [ + "categoryid_parameter", + "productsearchmodel.categoryid_parameter" + ], + "title": "ProductSearchModel.CATEGORYID_PARAMETER" + }, + { + "description": "URL Parameter for the inventory list IDs", + "id": "script-api:dw/catalog/ProductSearchModel#INVENTORY_LIST_IDS_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the inventory list IDs", + "heading": "Description" + } + ], + "signature": "static readonly INVENTORY_LIST_IDS_PARAMETER = \"ilids\"", + "source": "script-api", + "tags": [ + "inventory_list_ids_parameter", + "productsearchmodel.inventory_list_ids_parameter" + ], + "title": "ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER" + }, + { + "description": "URL Parameter for the inventory list IDs", + "id": "script-api:dw/catalog/ProductSearchModel#INVENTORY_LIST_IDS_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the inventory list IDs", + "heading": "Description" + } + ], + "signature": "static readonly INVENTORY_LIST_IDS_PARAMETER = \"ilids\"", + "source": "script-api", + "tags": [ + "inventory_list_ids_parameter", + "productsearchmodel.inventory_list_ids_parameter" + ], + "title": "ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER" + }, + { + "description": "The maximum number of inventory list IDs that can be passed to setInventoryListIDs", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_INVENTORY_LIST_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS", + "sections": [ + { + "body": "The maximum number of inventory list IDs that can be passed to setInventoryListIDs", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_INVENTORY_LIST_IDS = 10", + "source": "script-api", + "tags": [ + "maximum_inventory_list_ids", + "productsearchmodel.maximum_inventory_list_ids" + ], + "title": "ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS" + }, + { + "description": "The maximum number of inventory list IDs that can be passed to setInventoryListIDs", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_INVENTORY_LIST_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS", + "sections": [ + { + "body": "The maximum number of inventory list IDs that can be passed to setInventoryListIDs", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_INVENTORY_LIST_IDS = 10", + "source": "script-api", + "tags": [ + "maximum_inventory_list_ids", + "productsearchmodel.maximum_inventory_list_ids" + ], + "title": "ProductSearchModel.MAXIMUM_INVENTORY_LIST_IDS" + }, + { + "description": "The maximum number of product IDs that can be passed to setProductIDs", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_PRODUCT_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_PRODUCT_IDS", + "sections": [ + { + "body": "The maximum number of product IDs that can be passed to setProductIDs", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_PRODUCT_IDS = 30", + "source": "script-api", + "tags": [ + "maximum_product_ids", + "productsearchmodel.maximum_product_ids" + ], + "title": "ProductSearchModel.MAXIMUM_PRODUCT_IDS" + }, + { + "description": "The maximum number of product IDs that can be passed to setProductIDs", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_PRODUCT_IDS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_PRODUCT_IDS", + "sections": [ + { + "body": "The maximum number of product IDs that can be passed to setProductIDs", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_PRODUCT_IDS = 30", + "source": "script-api", + "tags": [ + "maximum_product_ids", + "productsearchmodel.maximum_product_ids" + ], + "title": "ProductSearchModel.MAXIMUM_PRODUCT_IDS" + }, + { + "description": "The maximum number of store inventory values for a store inventory filter that can be passed to setStoreInventoryFilter", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "sections": [ + { + "body": "The maximum number of store inventory values for a store inventory filter that can be passed to\nsetStoreInventoryFilter", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_STORE_INVENTORY_FILTER_VALUES = 10", + "source": "script-api", + "tags": [ + "maximum_store_inventory_filter_values", + "productsearchmodel.maximum_store_inventory_filter_values" + ], + "title": "ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES" + }, + { + "description": "The maximum number of store inventory values for a store inventory filter that can be passed to setStoreInventoryFilter", + "id": "script-api:dw/catalog/ProductSearchModel#MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES", + "sections": [ + { + "body": "The maximum number of store inventory values for a store inventory filter that can be passed to\nsetStoreInventoryFilter", + "heading": "Description" + } + ], + "signature": "static readonly MAXIMUM_STORE_INVENTORY_FILTER_VALUES = 10", + "source": "script-api", + "tags": [ + "maximum_store_inventory_filter_values", + "productsearchmodel.maximum_store_inventory_filter_values" + ], + "title": "ProductSearchModel.MAXIMUM_STORE_INVENTORY_FILTER_VALUES" + }, + { + "description": "URL Parameter for the maximum price", + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MAX_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MAX_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the maximum price", + "heading": "Description" + } + ], + "signature": "static readonly PRICE_MAX_PARAMETER = \"pmax\"", + "source": "script-api", + "tags": [ + "price_max_parameter", + "productsearchmodel.price_max_parameter" + ], + "title": "ProductSearchModel.PRICE_MAX_PARAMETER" + }, + { + "description": "URL Parameter for the maximum price", + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MAX_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MAX_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the maximum price", + "heading": "Description" + } + ], + "signature": "static readonly PRICE_MAX_PARAMETER = \"pmax\"", + "source": "script-api", + "tags": [ + "price_max_parameter", + "productsearchmodel.price_max_parameter" + ], + "title": "ProductSearchModel.PRICE_MAX_PARAMETER" + }, + { + "description": "URL Parameter for the minimum price", + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MIN_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MIN_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the minimum price", + "heading": "Description" + } + ], + "signature": "static readonly PRICE_MIN_PARAMETER = \"pmin\"", + "source": "script-api", + "tags": [ + "price_min_parameter", + "productsearchmodel.price_min_parameter" + ], + "title": "ProductSearchModel.PRICE_MIN_PARAMETER" + }, + { + "description": "URL Parameter for the minimum price", + "id": "script-api:dw/catalog/ProductSearchModel#PRICE_MIN_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRICE_MIN_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the minimum price", + "heading": "Description" + } + ], + "signature": "static readonly PRICE_MIN_PARAMETER = \"pmin\"", + "source": "script-api", + "tags": [ + "price_min_parameter", + "productsearchmodel.price_min_parameter" + ], + "title": "ProductSearchModel.PRICE_MIN_PARAMETER" + }, + { + "description": "URL Parameter for the product ID", + "id": "script-api:dw/catalog/ProductSearchModel#PRODUCTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRODUCTID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the product ID", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCTID_PARAMETER = \"pid\"", + "source": "script-api", + "tags": [ + "productid_parameter", + "productsearchmodel.productid_parameter" + ], + "title": "ProductSearchModel.PRODUCTID_PARAMETER" + }, + { + "description": "URL Parameter for the product ID", + "id": "script-api:dw/catalog/ProductSearchModel#PRODUCTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PRODUCTID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the product ID", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCTID_PARAMETER = \"pid\"", + "source": "script-api", + "tags": [ + "productid_parameter", + "productsearchmodel.productid_parameter" + ], + "title": "ProductSearchModel.PRODUCTID_PARAMETER" + }, + { + "description": "URL Parameter for the promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTIONID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTIONID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTIONID_PARAMETER = \"pmid\"", + "source": "script-api", + "tags": [ + "promotionid_parameter", + "productsearchmodel.promotionid_parameter" + ], + "title": "ProductSearchModel.PROMOTIONID_PARAMETER" + }, + { + "description": "URL Parameter for the promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTIONID_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTIONID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTIONID_PARAMETER = \"pmid\"", + "source": "script-api", + "tags": [ + "promotionid_parameter", + "productsearchmodel.promotionid_parameter" + ], + "title": "ProductSearchModel.PROMOTIONID_PARAMETER" + }, + { + "description": "constant indicating that all related products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_ALL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL", + "sections": [ + { + "body": "constant indicating that all related products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_ALL = \"all\"", + "source": "script-api", + "tags": [ + "promotion_product_type_all", + "productsearchmodel.promotion_product_type_all" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL" + }, + { + "description": "constant indicating that all related products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_ALL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL", + "sections": [ + { + "body": "constant indicating that all related products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_ALL = \"all\"", + "source": "script-api", + "tags": [ + "promotion_product_type_all", + "productsearchmodel.promotion_product_type_all" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_ALL" + }, + { + "description": "constant indicating that only bonus products should be returned for the next product search by promotion ID. This constant should be set using setPromotionProductType when using the search model to find the available list of bonus products for a Choice of Bonus Product (Rule) promotion, along with setPromotionID.", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_BONUS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS", + "sections": [ + { + "body": "constant indicating that only bonus products should be returned for the next product search by promotion ID. This\nconstant should be set using setPromotionProductType when using the search model to find the\navailable list of bonus products for a Choice of Bonus Product (Rule) promotion, along with\nsetPromotionID.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_BONUS = \"bonus\"", + "source": "script-api", + "tags": [ + "promotion_product_type_bonus", + "productsearchmodel.promotion_product_type_bonus" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS" + }, + { + "description": "constant indicating that only bonus products should be returned for the next product search by promotion ID. This constant should be set using setPromotionProductType when using the search model to find the available list of bonus products for a Choice of Bonus Product (Rule) promotion, along with setPromotionID.", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_BONUS", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS", + "sections": [ + { + "body": "constant indicating that only bonus products should be returned for the next product search by promotion ID. This\nconstant should be set using setPromotionProductType when using the search model to find the\navailable list of bonus products for a Choice of Bonus Product (Rule) promotion, along with\nsetPromotionID.", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_BONUS = \"bonus\"", + "source": "script-api", + "tags": [ + "promotion_product_type_bonus", + "productsearchmodel.promotion_product_type_bonus" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS" + }, + { + "description": "constant indicating that only discounted products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "sections": [ + { + "body": "constant indicating that only discounted products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_DISCOUNTED = \"discounted\"", + "source": "script-api", + "tags": [ + "promotion_product_type_discounted", + "productsearchmodel.promotion_product_type_discounted" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED" + }, + { + "description": "constant indicating that only discounted products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED", + "sections": [ + { + "body": "constant indicating that only discounted products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_DISCOUNTED = \"discounted\"", + "source": "script-api", + "tags": [ + "promotion_product_type_discounted", + "productsearchmodel.promotion_product_type_discounted" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_DISCOUNTED" + }, + { + "description": "URL Parameter for the promotion product type", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the promotion product type", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_PARAMETER = \"pmpt\"", + "source": "script-api", + "tags": [ + "promotion_product_type_parameter", + "productsearchmodel.promotion_product_type_parameter" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER" + }, + { + "description": "URL Parameter for the promotion product type", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the promotion product type", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_PARAMETER = \"pmpt\"", + "source": "script-api", + "tags": [ + "promotion_product_type_parameter", + "productsearchmodel.promotion_product_type_parameter" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_PARAMETER" + }, + { + "description": "constant indicating that only qualifying products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_QUALIFYING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING", + "sections": [ + { + "body": "constant indicating that only qualifying products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_QUALIFYING = \"qualifying\"", + "source": "script-api", + "tags": [ + "promotion_product_type_qualifying", + "productsearchmodel.promotion_product_type_qualifying" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING" + }, + { + "description": "constant indicating that only qualifying products should be returned for the next product search by promotion ID", + "id": "script-api:dw/catalog/ProductSearchModel#PROMOTION_PRODUCT_TYPE_QUALIFYING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING", + "sections": [ + { + "body": "constant indicating that only qualifying products should be returned for the next product search by promotion ID", + "heading": "Description" + } + ], + "signature": "static readonly PROMOTION_PRODUCT_TYPE_QUALIFYING = \"qualifying\"", + "source": "script-api", + "tags": [ + "promotion_product_type_qualifying", + "productsearchmodel.promotion_product_type_qualifying" + ], + "title": "ProductSearchModel.PROMOTION_PRODUCT_TYPE_QUALIFYING" + }, + { + "description": "URL Parameter prefix for a refinement name", + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_NAME_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement name", + "heading": "Description" + } + ], + "signature": "static readonly REFINE_NAME_PARAMETER_PREFIX = \"prefn\"", + "source": "script-api", + "tags": [ + "refine_name_parameter_prefix", + "productsearchmodel.refine_name_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement name", + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_NAME_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement name", + "heading": "Description" + } + ], + "signature": "static readonly REFINE_NAME_PARAMETER_PREFIX = \"prefn\"", + "source": "script-api", + "tags": [ + "refine_name_parameter_prefix", + "productsearchmodel.refine_name_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_NAME_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_VALUE_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly REFINE_VALUE_PARAMETER_PREFIX = \"prefv\"", + "source": "script-api", + "tags": [ + "refine_value_parameter_prefix", + "productsearchmodel.refine_value_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#REFINE_VALUE_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly REFINE_VALUE_PARAMETER_PREFIX = \"prefv\"", + "source": "script-api", + "tags": [ + "refine_value_parameter_prefix", + "productsearchmodel.refine_value_parameter_prefix" + ], + "title": "ProductSearchModel.REFINE_VALUE_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a sorting option", + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_OPTION_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_OPTION_PARAMETER", + "sections": [ + { + "body": "URL Parameter prefix for a sorting option", + "heading": "Description" + } + ], + "signature": "static readonly SORTING_OPTION_PARAMETER = \"sopt\"", + "source": "script-api", + "tags": [ + "sorting_option_parameter", + "productsearchmodel.sorting_option_parameter" + ], + "title": "ProductSearchModel.SORTING_OPTION_PARAMETER" + }, + { + "description": "URL Parameter prefix for a sorting option", + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_OPTION_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_OPTION_PARAMETER", + "sections": [ + { + "body": "URL Parameter prefix for a sorting option", + "heading": "Description" + } + ], + "signature": "static readonly SORTING_OPTION_PARAMETER = \"sopt\"", + "source": "script-api", + "tags": [ + "sorting_option_parameter", + "productsearchmodel.sorting_option_parameter" + ], + "title": "ProductSearchModel.SORTING_OPTION_PARAMETER" + }, + { + "description": "URL Parameter prefix for a sorting rule", + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_RULE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_RULE_PARAMETER", + "sections": [ + { + "body": "URL Parameter prefix for a sorting rule", + "heading": "Description" + } + ], + "signature": "static readonly SORTING_RULE_PARAMETER = \"srule\"", + "source": "script-api", + "tags": [ + "sorting_rule_parameter", + "productsearchmodel.sorting_rule_parameter" + ], + "title": "ProductSearchModel.SORTING_RULE_PARAMETER" + }, + { + "description": "URL Parameter prefix for a sorting rule", + "id": "script-api:dw/catalog/ProductSearchModel#SORTING_RULE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORTING_RULE_PARAMETER", + "sections": [ + { + "body": "URL Parameter prefix for a sorting rule", + "heading": "Description" + } + ], + "signature": "static readonly SORTING_RULE_PARAMETER = \"srule\"", + "source": "script-api", + "tags": [ + "sorting_rule_parameter", + "productsearchmodel.sorting_rule_parameter" + ], + "title": "ProductSearchModel.SORTING_RULE_PARAMETER" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#SORT_BY_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_BY_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_PARAMETER_PREFIX = \"psortb\"", + "source": "script-api", + "tags": [ + "sort_by_parameter_prefix", + "productsearchmodel.sort_by_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_BY_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#SORT_BY_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_BY_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly SORT_BY_PARAMETER_PREFIX = \"psortb\"", + "source": "script-api", + "tags": [ + "sort_by_parameter_prefix", + "productsearchmodel.sort_by_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_BY_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#SORT_DIRECTION_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_PARAMETER_PREFIX = \"psortd\"", + "source": "script-api", + "tags": [ + "sort_direction_parameter_prefix", + "productsearchmodel.sort_direction_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX" + }, + { + "description": "URL Parameter prefix for a refinement value", + "id": "script-api:dw/catalog/ProductSearchModel#SORT_DIRECTION_PARAMETER_PREFIX", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX", + "sections": [ + { + "body": "URL Parameter prefix for a refinement value", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_PARAMETER_PREFIX = \"psortd\"", + "source": "script-api", + "tags": [ + "sort_direction_parameter_prefix", + "productsearchmodel.sort_direction_parameter_prefix" + ], + "title": "ProductSearchModel.SORT_DIRECTION_PARAMETER_PREFIX" + }, + { + "description": "Set the only search hit types to be included from the search. Values accepted are the 'hit type' constants exposed in the dw.catalog.ProductSearchHit class. Overwrites any hit type refinements set from prior calls to addHitTypeRefinement(String...) or excludeHitType(String...).", + "id": "script-api:dw/catalog/ProductSearchModel#addHitTypeRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "types", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.addHitTypeRefinement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the only search hit types to be included from the search. Values accepted are the 'hit type' constants\nexposed in the dw.catalog.ProductSearchHit class. Overwrites any hit type refinements set from prior calls to\naddHitTypeRefinement(String...) or excludeHitType(String...).", + "heading": "Description" + } + ], + "signature": "addHitTypeRefinement(types?: string[]): void", + "source": "script-api", + "tags": [ + "addhittyperefinement", + "productsearchmodel.addhittyperefinement" + ], + "title": "ProductSearchModel.addHitTypeRefinement" + }, + { + "description": "Returns the category object for the category id specified in the query. If a category with that id doesn't exist or if the category is offline this method returns null.", + "id": "script-api:dw/catalog/ProductSearchModel#category", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.category", + "sections": [ + { + "body": "Returns the category object for the category id specified in the query.\nIf a category with that id doesn't exist or if the category is offline\nthis method returns null.", + "heading": "Description" + } + ], + "signature": "readonly category: Category", + "source": "script-api", + "tags": [ + "category", + "productsearchmodel.category" + ], + "title": "ProductSearchModel.category" + }, + { + "description": "Returns the category id that was specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#categoryID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.categoryID", + "sections": [ + { + "body": "Returns the category id that was specified in the search query.", + "heading": "Description" + } + ], + "signature": "categoryID: string", + "source": "script-api", + "tags": [ + "categoryid", + "productsearchmodel.categoryid" + ], + "title": "ProductSearchModel.categoryID" + }, + { + "description": "The method returns true, if this is a pure search for a category. The method checks, that a category ID is specified and no search phrase is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#categorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.categorySearch", + "sections": [ + { + "body": "The method returns true, if this is a pure search for a category. The\nmethod checks, that a category ID is specified and no search phrase is\nspecified.", + "heading": "Description" + } + ], + "signature": "readonly categorySearch: boolean", + "source": "script-api", + "tags": [ + "categorysearch", + "productsearchmodel.categorysearch" + ], + "title": "ProductSearchModel.categorySearch" + }, + { + "description": "Returns the deepest common category of all products in the search result. In case of an empty search result the method returns the root category.", + "id": "script-api:dw/catalog/ProductSearchModel#deepestCommonCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.deepestCommonCategory", + "sections": [ + { + "body": "Returns the deepest common category of all products in the search result.\nIn case of an empty search result the method returns the root category.", + "heading": "Description" + } + ], + "signature": "readonly deepestCommonCategory: Category", + "source": "script-api", + "tags": [ + "deepestcommoncategory", + "productsearchmodel.deepestcommoncategory" + ], + "title": "ProductSearchModel.deepestCommonCategory" + }, + { + "description": "Returns the sorting rule used to order the products in the results of this query, or `null` if no search has been executed yet.", + "id": "script-api:dw/catalog/ProductSearchModel#effectiveSortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.effectiveSortingRule", + "sections": [ + { + "body": "Returns the sorting rule used to order the products in the results of this query,\nor `null` if no search has been executed yet.\n\nIn contrast to getSortingRule, this method respects explicit sorting rules and sorting options and rules determined implicitly\nbased on the refinement category, keyword sorting rule assignment, etc.", + "heading": "Description" + } + ], + "signature": "readonly effectiveSortingRule: SortingRule | null", + "source": "script-api", + "tags": [ + "effectivesortingrule", + "productsearchmodel.effectivesortingrule" + ], + "title": "ProductSearchModel.effectiveSortingRule" + }, + { + "description": "Set the search hit types to be excluded from the search. Values accepted are the 'hit type' constants exposed in the dw.catalog.ProductSearchHit class. Overwrites any hit type refinements set from prior calls to addHitTypeRefinement(String...) or excludeHitType(String...).", + "id": "script-api:dw/catalog/ProductSearchModel#excludeHitType", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "types", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.excludeHitType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the search hit types to be excluded from the search. Values accepted are the 'hit type' constants exposed in\nthe dw.catalog.ProductSearchHit class. Overwrites any hit type refinements set from prior calls to\naddHitTypeRefinement(String...) or excludeHitType(String...).", + "heading": "Description" + } + ], + "signature": "excludeHitType(types?: string[]): void", + "source": "script-api", + "tags": [ + "excludehittype", + "productsearchmodel.excludehittype" + ], + "title": "ProductSearchModel.excludeHitType" + }, + { + "description": "Returns the category object for the category id specified in the query. If a category with that id doesn't exist or if the category is offline this method returns null.", + "id": "script-api:dw/catalog/ProductSearchModel#getCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the category object for the category id specified in the query.\nIf a category with that id doesn't exist or if the category is offline\nthis method returns null.", + "heading": "Description" + } + ], + "signature": "getCategory(): Category", + "source": "script-api", + "tags": [ + "getcategory", + "productsearchmodel.getcategory" + ], + "title": "ProductSearchModel.getCategory" + }, + { + "description": "Returns the category id that was specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#getCategoryID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getCategoryID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the category id that was specified in the search query.", + "heading": "Description" + } + ], + "signature": "getCategoryID(): string", + "source": "script-api", + "tags": [ + "getcategoryid", + "productsearchmodel.getcategoryid" + ], + "title": "ProductSearchModel.getCategoryID" + }, + { + "description": "Returns the deepest common category of all products in the search result. In case of an empty search result the method returns the root category.", + "id": "script-api:dw/catalog/ProductSearchModel#getDeepestCommonCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getDeepestCommonCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the deepest common category of all products in the search result.\nIn case of an empty search result the method returns the root category.", + "heading": "Description" + } + ], + "signature": "getDeepestCommonCategory(): Category", + "source": "script-api", + "tags": [ + "getdeepestcommoncategory", + "productsearchmodel.getdeepestcommoncategory" + ], + "title": "ProductSearchModel.getDeepestCommonCategory" + }, + { + "description": "Returns the sorting rule used to order the products in the results of this query, or `null` if no search has been executed yet.", + "id": "script-api:dw/catalog/ProductSearchModel#getEffectiveSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getEffectiveSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the sorting rule used to order the products in the results of this query,\nor `null` if no search has been executed yet.\n\nIn contrast to getSortingRule, this method respects explicit sorting rules and sorting options and rules determined implicitly\nbased on the refinement category, keyword sorting rule assignment, etc.", + "heading": "Description" + } + ], + "signature": "getEffectiveSortingRule(): SortingRule | null", + "source": "script-api", + "tags": [ + "geteffectivesortingrule", + "productsearchmodel.geteffectivesortingrule" + ], + "title": "ProductSearchModel.getEffectiveSortingRule" + }, + { + "description": "Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.", + "id": "script-api:dw/catalog/ProductSearchModel#getInventoryIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getInventoryIDs", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.", + "heading": "Description" + } + ], + "signature": "getInventoryIDs(): List", + "source": "script-api", + "tags": [ + "getinventoryids", + "productsearchmodel.getinventoryids" + ], + "title": "ProductSearchModel.getInventoryIDs" + }, + { + "description": "Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. If this value has not been previously set, then the value returned will be based on the value of the search preference.", + "id": "script-api:dw/catalog/ProductSearchModel#getOrderableProductsOnly", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getOrderableProductsOnly", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Get the flag indicating whether unorderable products should be excluded\nwhen the next call to getProducts() is made. If this value has not been\npreviously set, then the value returned will be based on the value of the\nsearch preference.", + "heading": "Description" + } + ], + "signature": "getOrderableProductsOnly(): boolean", + "source": "script-api", + "tags": [ + "getorderableproductsonly", + "productsearchmodel.getorderableproductsonly" + ], + "title": "ProductSearchModel.getOrderableProductsOnly" + }, + { + "description": "Returns the page meta tag for the specified id.", + "id": "script-api:dw/catalog/ProductSearchModel#getPageMetaTag", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPageMetaTag", + "returns": { + "type": "PageMetaTag | null" + }, + "sections": [ + { + "body": "Returns the page meta tag for the specified id.\n\nThe meta tag content is generated based on the product listing page meta tag context and rule.\nThe rule is obtained from the current category context or inherited from the parent category,\nup to the root category.\n\nNull will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the\ncurrent context, or if the rule resolves to an empty string.", + "heading": "Description" + } + ], + "signature": "getPageMetaTag(id: string): PageMetaTag | null", + "source": "script-api", + "tags": [ + "getpagemetatag", + "productsearchmodel.getpagemetatag" + ], + "title": "ProductSearchModel.getPageMetaTag" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/catalog/ProductSearchModel#getPageMetaTags", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPageMetaTags", + "returns": { + "type": "Array" + }, + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the product listing page meta tag context and rules.\nThe rules are obtained from the current category context or inherited from the parent category,\nup to the root category.", + "heading": "Description" + } + ], + "signature": "getPageMetaTags(): Array", + "source": "script-api", + "tags": [ + "getpagemetatags", + "productsearchmodel.getpagemetatags" + ], + "title": "ProductSearchModel.getPageMetaTags" + }, + { + "description": "Returns the maximum price by which the search result is refined.", + "id": "script-api:dw/catalog/ProductSearchModel#getPriceMax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPriceMax", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum price by which the search result is refined.", + "heading": "Description" + } + ], + "signature": "getPriceMax(): number", + "source": "script-api", + "tags": [ + "getpricemax", + "productsearchmodel.getpricemax" + ], + "title": "ProductSearchModel.getPriceMax" + }, + { + "description": "Returns the minimum price by which the search result is refined.", + "id": "script-api:dw/catalog/ProductSearchModel#getPriceMin", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPriceMin", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum price by which the search result is refined.", + "heading": "Description" + } + ], + "signature": "getPriceMin(): number", + "source": "script-api", + "tags": [ + "getpricemin", + "productsearchmodel.getpricemin" + ], + "title": "ProductSearchModel.getPriceMin" + }, + { + "deprecated": { + "message": "Please use getProductIDs instead" + }, + "description": "Returns the product id that was specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#getProductID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the product id that was specified in the search query.", + "heading": "Description" + } + ], + "signature": "getProductID(): string", + "source": "script-api", + "tags": [ + "getproductid", + "productsearchmodel.getproductid" + ], + "title": "ProductSearchModel.getProductID" + }, + { + "description": "Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.", + "id": "script-api:dw/catalog/ProductSearchModel#getProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductIDs", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.", + "heading": "Description" + } + ], + "signature": "getProductIDs(): List", + "source": "script-api", + "tags": [ + "getproductids", + "productsearchmodel.getproductids" + ], + "title": "ProductSearchModel.getProductIDs" + }, + { + "description": "Returns the underlying ProductSearchHit for a product, or null if no ProductSearchHit found for this product.", + "id": "script-api:dw/catalog/ProductSearchModel#getProductSearchHit", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductSearchHit", + "returns": { + "type": "ProductSearchHit | null" + }, + "sections": [ + { + "body": "Returns the underlying ProductSearchHit for a product, or null if no\nProductSearchHit found for this product.", + "heading": "Description" + } + ], + "signature": "getProductSearchHit(product: Product): ProductSearchHit | null", + "source": "script-api", + "tags": [ + "getproductsearchhit", + "productsearchmodel.getproductsearchhit" + ], + "title": "ProductSearchModel.getProductSearchHit" + }, + { + "description": "Returns the product search hits in the search result.", + "id": "script-api:dw/catalog/ProductSearchModel#getProductSearchHits", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProductSearchHits", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns the product search hits in the search result.\n\nNote that method does also return search hits representing products that\nwere removed or went offline since the last index update, i.e. you must\nimplement appropriate checks before accessing the product related to the\nsearch hit instance (see dw.catalog.ProductSearchHit.getProduct)", + "heading": "Description" + } + ], + "signature": "getProductSearchHits(): utilIterator", + "source": "script-api", + "tags": [ + "getproductsearchhits", + "productsearchmodel.getproductsearchhits" + ], + "title": "ProductSearchModel.getProductSearchHits" + }, + { + "deprecated": { + "message": "This method should not be used because loading Products for each result of a product search is\nextremely expensive performance-wise. Please use getProductSearchHits to iterate\nProductSearchHits instead." + }, + "description": "Returns all products in the search result.", + "id": "script-api:dw/catalog/ProductSearchModel#getProducts", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getProducts", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns all products in the search result.\n\nNote that products that were removed or went offline since the last index\nupdate are not included in the returned set.", + "heading": "Description" + } + ], + "signature": "getProducts(): utilIterator", + "source": "script-api", + "tags": [ + "getproducts", + "productsearchmodel.getproducts" + ], + "title": "ProductSearchModel.getProducts" + }, + { + "description": "Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple promotion id's specified the method returns only the first id. See setPromotionIDs and getPromotionIDs.", + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple\npromotion id's specified the method returns only the first id. See setPromotionIDs and\ngetPromotionIDs.", + "heading": "Description" + } + ], + "signature": "getPromotionID(): string | null", + "source": "script-api", + "tags": [ + "getpromotionid", + "productsearchmodel.getpromotionid" + ], + "title": "ProductSearchModel.getPromotionID" + }, + { + "description": "Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.", + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionIDs", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionIDs", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.", + "heading": "Description" + } + ], + "signature": "getPromotionIDs(): List", + "source": "script-api", + "tags": [ + "getpromotionids", + "productsearchmodel.getpromotionids" + ], + "title": "ProductSearchModel.getPromotionIDs" + }, + { + "description": "Returns the promotion product type specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#getPromotionProductType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getPromotionProductType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the promotion product type specified in the search query.", + "heading": "Description" + } + ], + "signature": "getPromotionProductType(): string", + "source": "script-api", + "tags": [ + "getpromotionproducttype", + "productsearchmodel.getpromotionproducttype" + ], + "title": "ProductSearchModel.getPromotionProductType" + }, + { + "description": "Returns the category used to determine possible refinements for the search. If an explicit category was set for this purpose using setRefinementCategory, it is returned. Otherwise, the deepest common category of all search results will be returned.", + "id": "script-api:dw/catalog/ProductSearchModel#getRefinementCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getRefinementCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the category used to determine possible refinements for the search.\nIf an explicit category was set for this purpose using setRefinementCategory, it is returned.\nOtherwise, the deepest common category of all search results will be returned.", + "heading": "Description" + } + ], + "signature": "getRefinementCategory(): Category", + "source": "script-api", + "tags": [ + "getrefinementcategory", + "productsearchmodel.getrefinementcategory" + ], + "title": "ProductSearchModel.getRefinementCategory" + }, + { + "description": "Returns the ProductSearchRefinements associated with this search and filtered by session currency. If an explicit category was set for this purpose using setRefinementCategory, it will be used to determine the refinements. Otherwise, the refinements are determined based on the deepest common category of all products in the search result. Hint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory to avoid unnecessary calculation of the deepest common category.", + "id": "script-api:dw/catalog/ProductSearchModel#getRefinements", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getRefinements", + "returns": { + "type": "ProductSearchRefinements" + }, + "sections": [ + { + "body": "Returns the ProductSearchRefinements associated with this search and filtered by session currency.\nIf an explicit category was set for this purpose using setRefinementCategory, it will be used to determine the refinements.\nOtherwise, the refinements are determined based on the deepest common category of all products in the search result.\nHint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory to avoid unnecessary calculation of the deepest common category.", + "heading": "Description" + } + ], + "signature": "getRefinements(): ProductSearchRefinements", + "source": "script-api", + "tags": [ + "getrefinements", + "productsearchmodel.getrefinements" + ], + "title": "ProductSearchModel.getRefinements" + }, + { + "description": "Returns search phrase suggestions for the current search phrase. Search phrase suggestions may contain alternative search phrases as well as lists of corrected and completed search terms.", + "id": "script-api:dw/catalog/ProductSearchModel#getSearchPhraseSuggestions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSearchPhraseSuggestions", + "returns": { + "type": "SearchPhraseSuggestions" + }, + "sections": [ + { + "body": "Returns search phrase suggestions for the current search phrase.\nSearch phrase suggestions may contain alternative search phrases as well\nas lists of corrected and completed search terms.", + "heading": "Description" + } + ], + "signature": "getSearchPhraseSuggestions(): SearchPhraseSuggestions", + "source": "script-api", + "tags": [ + "getsearchphrasesuggestions", + "productsearchmodel.getsearchphrasesuggestions" + ], + "title": "ProductSearchModel.getSearchPhraseSuggestions" + }, + { + "description": "This method returns the URL of the endpoint where the merchants should upload their image for visual search.", + "id": "script-api:dw/catalog/ProductSearchModel#getSearchableImageUploadURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSearchableImageUploadURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "This method returns the URL of the endpoint where the merchants should upload their image for visual search.", + "heading": "Description" + } + ], + "signature": "getSearchableImageUploadURL(): string", + "source": "script-api", + "tags": [ + "getsearchableimageuploadurl", + "productsearchmodel.getsearchableimageuploadurl" + ], + "throws": [ + { + "type": "RuntimeException" + } + ], + "title": "ProductSearchModel.getSearchableImageUploadURL" + }, + { + "description": "Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or `null` if no rule has been explicitly set.", + "id": "script-api:dw/catalog/ProductSearchModel#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the sorting rule explicitly set on this model to be used\nto order the products in the results of this query, or `null`\nif no rule has been explicitly set.\n\nThis method does not return the sorting rule that will be used implicitly\nbased on the context of the search, such as the refinement category.", + "heading": "Description" + } + ], + "signature": "getSortingRule(): SortingRule | null", + "source": "script-api", + "tags": [ + "getsortingrule", + "productsearchmodel.getsortingrule" + ], + "title": "ProductSearchModel.getSortingRule" + }, + { + "description": "Returns the StoreInventoryFilter, which was specified for this search.", + "id": "script-api:dw/catalog/ProductSearchModel#getStoreInventoryFilter", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getStoreInventoryFilter", + "returns": { + "type": "StoreInventoryFilter" + }, + "sections": [ + { + "body": "Returns the StoreInventoryFilter, which was specified for this search.", + "heading": "Description" + } + ], + "signature": "getStoreInventoryFilter(): StoreInventoryFilter", + "source": "script-api", + "tags": [ + "getstoreinventoryfilter", + "productsearchmodel.getstoreinventoryfilter" + ], + "title": "ProductSearchModel.getStoreInventoryFilter" + }, + { + "deprecated": { + "message": "Please use getSearchPhraseSuggestions instead" + }, + "description": "Returns the suggested search phrase with the highest accuracy provided for the current search phrase.", + "id": "script-api:dw/catalog/ProductSearchModel#getSuggestedSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSuggestedSearchPhrase", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the suggested search phrase with the highest accuracy provided\nfor the current search phrase.", + "heading": "Description" + } + ], + "signature": "getSuggestedSearchPhrase(): string", + "source": "script-api", + "tags": [ + "getsuggestedsearchphrase", + "productsearchmodel.getsuggestedsearchphrase" + ], + "title": "ProductSearchModel.getSuggestedSearchPhrase" + }, + { + "deprecated": { + "message": "Please use getSearchPhraseSuggestions instead" + }, + "description": "Returns a list with up to 5 suggested search phrases provided for the current search phrase. It is possible that less than 5 suggestions or even no suggestions are returned.", + "id": "script-api:dw/catalog/ProductSearchModel#getSuggestedSearchPhrases", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.getSuggestedSearchPhrases", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list with up to 5 suggested search phrases provided for the\ncurrent search phrase. It is possible that less than 5 suggestions\nor even no suggestions are returned.", + "heading": "Description" + } + ], + "signature": "getSuggestedSearchPhrases(): List", + "source": "script-api", + "tags": [ + "getsuggestedsearchphrases", + "productsearchmodel.getsuggestedsearchphrases" + ], + "title": "ProductSearchModel.getSuggestedSearchPhrases" + }, + { + "description": "Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.", + "id": "script-api:dw/catalog/ProductSearchModel#inventoryIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.inventoryIDs", + "sections": [ + { + "body": "Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.", + "heading": "Description" + } + ], + "signature": "readonly inventoryIDs: List", + "source": "script-api", + "tags": [ + "inventoryids", + "productsearchmodel.inventoryids" + ], + "title": "ProductSearchModel.inventoryIDs" + }, + { + "description": "The method returns true, if this is a pure search for a category. The method checks, that a category ID is specified and no search phrase is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#isCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isCategorySearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if this is a pure search for a category. The\nmethod checks, that a category ID is specified and no search phrase is\nspecified.", + "heading": "Description" + } + ], + "signature": "isCategorySearch(): boolean", + "source": "script-api", + "tags": [ + "iscategorysearch", + "productsearchmodel.iscategorysearch" + ], + "title": "ProductSearchModel.isCategorySearch" + }, + { + "description": "The method indicates if the search result is ordered by a personalized sorting rule.", + "id": "script-api:dw/catalog/ProductSearchModel#isPersonalizedSort", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isPersonalizedSort", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method indicates if the search result is ordered by a personalized sorting rule.", + "heading": "Description" + } + ], + "signature": "isPersonalizedSort(): boolean", + "source": "script-api", + "tags": [ + "ispersonalizedsort", + "productsearchmodel.ispersonalizedsort" + ], + "title": "ProductSearchModel.isPersonalizedSort" + }, + { + "description": "Get the flag that determines if the category search will be recursive.", + "id": "script-api:dw/catalog/ProductSearchModel#isRecursiveCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRecursiveCategorySearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Get the flag that determines if the category search will\nbe recursive.", + "heading": "Description" + } + ], + "signature": "isRecursiveCategorySearch(): boolean", + "source": "script-api", + "tags": [ + "isrecursivecategorysearch", + "productsearchmodel.isrecursivecategorysearch" + ], + "title": "ProductSearchModel.isRecursiveCategorySearch" + }, + { + "description": "The method returns true, if the search is refined by a category. The method checks, that a category ID is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByCategory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if the search is refined by a category.\nThe method checks, that a category ID is specified.", + "heading": "Description" + } + ], + "signature": "isRefinedByCategory(): boolean", + "source": "script-api", + "tags": [ + "isrefinedbycategory", + "productsearchmodel.isrefinedbycategory" + ], + "title": "ProductSearchModel.isRefinedByCategory" + }, + { + "description": "Identifies if this search has been refined by price.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPrice", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPrice", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined by price.", + "heading": "Description" + } + ], + "signature": "isRefinedByPrice(): boolean", + "source": "script-api", + "tags": [ + "isrefinedbyprice", + "productsearchmodel.isrefinedbyprice" + ], + "title": "ProductSearchModel.isRefinedByPrice" + }, + { + "description": "Identifies if this search has been refined by the given price range. Either range parameters may be null to represent open ranges.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPriceRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceMin", + "type": "number" + }, + { + "name": "priceMax", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPriceRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined by the given price range.\nEither range parameters may be null to represent open ranges.", + "heading": "Description" + } + ], + "signature": "isRefinedByPriceRange(priceMin: number, priceMax: number): boolean", + "source": "script-api", + "tags": [ + "isrefinedbypricerange", + "productsearchmodel.isrefinedbypricerange" + ], + "title": "ProductSearchModel.isRefinedByPriceRange" + }, + { + "description": "Identifies if this search has been refined by promotion.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPromotion", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined by promotion.", + "heading": "Description" + } + ], + "signature": "isRefinedByPromotion(): boolean", + "source": "script-api", + "tags": [ + "isrefinedbypromotion", + "productsearchmodel.isrefinedbypromotion" + ], + "title": "ProductSearchModel.isRefinedByPromotion" + }, + { + "description": "Identifies if this search has been refined by a given promotion.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedByPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedByPromotion", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined by a given promotion.", + "heading": "Description" + } + ], + "signature": "isRefinedByPromotion(promotionID: string): boolean", + "source": "script-api", + "tags": [ + "isrefinedbypromotion", + "productsearchmodel.isrefinedbypromotion" + ], + "title": "ProductSearchModel.isRefinedByPromotion" + }, + { + "description": "Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.", + "id": "script-api:dw/catalog/ProductSearchModel#isRefinedCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isRefinedCategorySearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a category search and is refined with further\ncriteria, like a brand refinement or an attribute refinement.", + "heading": "Description" + } + ], + "signature": "isRefinedCategorySearch(): boolean", + "source": "script-api", + "tags": [ + "isrefinedcategorysearch", + "productsearchmodel.isrefinedcategorysearch" + ], + "title": "ProductSearchModel.isRefinedCategorySearch" + }, + { + "description": "The method indicates if no-hits search should be tracked for predictive intelligence use.", + "id": "script-api:dw/catalog/ProductSearchModel#isTrackingEmptySearchesEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isTrackingEmptySearchesEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method indicates if no-hits search should be tracked for predictive intelligence use.", + "heading": "Description" + } + ], + "signature": "isTrackingEmptySearchesEnabled(): boolean", + "source": "script-api", + "tags": [ + "istrackingemptysearchesenabled", + "productsearchmodel.istrackingemptysearchesenabled" + ], + "title": "ProductSearchModel.isTrackingEmptySearchesEnabled" + }, + { + "description": "The method returns true, if this is a visual search. The method checks that a image UUID is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#isVisualSearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.isVisualSearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if this is a visual search. The\nmethod checks that a image UUID is specified.", + "heading": "Description" + } + ], + "signature": "isVisualSearch(): boolean", + "source": "script-api", + "tags": [ + "isvisualsearch", + "productsearchmodel.isvisualsearch" + ], + "title": "ProductSearchModel.isVisualSearch" + }, + { + "description": "Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. If this value has not been previously set, then the value returned will be based on the value of the search preference.", + "id": "script-api:dw/catalog/ProductSearchModel#orderableProductsOnly", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.orderableProductsOnly", + "sections": [ + { + "body": "Get the flag indicating whether unorderable products should be excluded\nwhen the next call to getProducts() is made. If this value has not been\npreviously set, then the value returned will be based on the value of the\nsearch preference.", + "heading": "Description" + } + ], + "signature": "orderableProductsOnly: boolean", + "source": "script-api", + "tags": [ + "orderableproductsonly", + "productsearchmodel.orderableproductsonly" + ], + "title": "ProductSearchModel.orderableProductsOnly" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/catalog/ProductSearchModel#pageMetaTags", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.pageMetaTags", + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the product listing page meta tag context and rules.\nThe rules are obtained from the current category context or inherited from the parent category,\nup to the root category.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaTags: Array", + "source": "script-api", + "tags": [ + "pagemetatags", + "productsearchmodel.pagemetatags" + ], + "title": "ProductSearchModel.pageMetaTags" + }, + { + "description": "The method indicates if the search result is ordered by a personalized sorting rule.", + "id": "script-api:dw/catalog/ProductSearchModel#personalizedSort", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.personalizedSort", + "sections": [ + { + "body": "The method indicates if the search result is ordered by a personalized sorting rule.", + "heading": "Description" + } + ], + "signature": "readonly personalizedSort: boolean", + "source": "script-api", + "tags": [ + "personalizedsort", + "productsearchmodel.personalizedsort" + ], + "title": "ProductSearchModel.personalizedSort" + }, + { + "description": "Returns the maximum price by which the search result is refined.", + "id": "script-api:dw/catalog/ProductSearchModel#priceMax", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.priceMax", + "sections": [ + { + "body": "Returns the maximum price by which the search result is refined.", + "heading": "Description" + } + ], + "signature": "priceMax: number", + "source": "script-api", + "tags": [ + "pricemax", + "productsearchmodel.pricemax" + ], + "title": "ProductSearchModel.priceMax" + }, + { + "description": "Returns the minimum price by which the search result is refined.", + "id": "script-api:dw/catalog/ProductSearchModel#priceMin", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.priceMin", + "sections": [ + { + "body": "Returns the minimum price by which the search result is refined.", + "heading": "Description" + } + ], + "signature": "priceMin: number", + "source": "script-api", + "tags": [ + "pricemin", + "productsearchmodel.pricemin" + ], + "title": "ProductSearchModel.priceMin" + }, + { + "deprecated": { + "message": "Please use getProductIDs instead" + }, + "description": "Returns the product id that was specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#productID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productID", + "sections": [ + { + "body": "Returns the product id that was specified in the search query.", + "heading": "Description" + } + ], + "signature": "productID: string", + "source": "script-api", + "tags": [ + "productid", + "productsearchmodel.productid" + ], + "title": "ProductSearchModel.productID" + }, + { + "description": "Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.", + "id": "script-api:dw/catalog/ProductSearchModel#productIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productIDs", + "sections": [ + { + "body": "Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.", + "heading": "Description" + } + ], + "signature": "productIDs: List", + "source": "script-api", + "tags": [ + "productids", + "productsearchmodel.productids" + ], + "title": "ProductSearchModel.productIDs" + }, + { + "description": "Returns the product search hits in the search result.", + "id": "script-api:dw/catalog/ProductSearchModel#productSearchHits", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.productSearchHits", + "sections": [ + { + "body": "Returns the product search hits in the search result.\n\nNote that method does also return search hits representing products that\nwere removed or went offline since the last index update, i.e. you must\nimplement appropriate checks before accessing the product related to the\nsearch hit instance (see dw.catalog.ProductSearchHit.getProduct)", + "heading": "Description" + } + ], + "signature": "readonly productSearchHits: utilIterator", + "source": "script-api", + "tags": [ + "productsearchhits", + "productsearchmodel.productsearchhits" + ], + "title": "ProductSearchModel.productSearchHits" + }, + { + "deprecated": { + "message": "This method should not be used because loading Products for each result of a product search is\nextremely expensive performance-wise. Please use getProductSearchHits to iterate\nProductSearchHits instead." + }, + "description": "Returns all products in the search result.", + "id": "script-api:dw/catalog/ProductSearchModel#products", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.products", + "sections": [ + { + "body": "Returns all products in the search result.\n\nNote that products that were removed or went offline since the last index\nupdate are not included in the returned set.", + "heading": "Description" + } + ], + "signature": "readonly products: utilIterator", + "source": "script-api", + "tags": [ + "products", + "productsearchmodel.products" + ], + "title": "ProductSearchModel.products" + }, + { + "description": "Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple promotion id's specified the method returns only the first id. See setPromotionIDs and getPromotionIDs.", + "id": "script-api:dw/catalog/ProductSearchModel#promotionID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionID", + "sections": [ + { + "body": "Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple\npromotion id's specified the method returns only the first id. See setPromotionIDs and\ngetPromotionIDs.", + "heading": "Description" + } + ], + "signature": "promotionID: string | null", + "source": "script-api", + "tags": [ + "promotionid", + "productsearchmodel.promotionid" + ], + "title": "ProductSearchModel.promotionID" + }, + { + "description": "Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.", + "id": "script-api:dw/catalog/ProductSearchModel#promotionIDs", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionIDs", + "sections": [ + { + "body": "Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.", + "heading": "Description" + } + ], + "signature": "promotionIDs: List", + "source": "script-api", + "tags": [ + "promotionids", + "productsearchmodel.promotionids" + ], + "title": "ProductSearchModel.promotionIDs" + }, + { + "description": "Returns the promotion product type specified in the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#promotionProductType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.promotionProductType", + "sections": [ + { + "body": "Returns the promotion product type specified in the search query.", + "heading": "Description" + } + ], + "signature": "promotionProductType: string", + "source": "script-api", + "tags": [ + "promotionproducttype", + "productsearchmodel.promotionproducttype" + ], + "title": "ProductSearchModel.promotionProductType" + }, + { + "description": "Get the flag that determines if the category search will be recursive.", + "id": "script-api:dw/catalog/ProductSearchModel#recursiveCategorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.recursiveCategorySearch", + "sections": [ + { + "body": "Get the flag that determines if the category search will\nbe recursive.", + "heading": "Description" + } + ], + "signature": "recursiveCategorySearch: boolean", + "source": "script-api", + "tags": [ + "recursivecategorysearch", + "productsearchmodel.recursivecategorysearch" + ], + "title": "ProductSearchModel.recursiveCategorySearch" + }, + { + "description": "The method returns true, if the search is refined by a category. The method checks, that a category ID is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#refinedByCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByCategory", + "sections": [ + { + "body": "The method returns true, if the search is refined by a category.\nThe method checks, that a category ID is specified.", + "heading": "Description" + } + ], + "signature": "readonly refinedByCategory: boolean", + "source": "script-api", + "tags": [ + "refinedbycategory", + "productsearchmodel.refinedbycategory" + ], + "title": "ProductSearchModel.refinedByCategory" + }, + { + "description": "Identifies if this search has been refined by price.", + "id": "script-api:dw/catalog/ProductSearchModel#refinedByPrice", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByPrice", + "sections": [ + { + "body": "Identifies if this search has been refined by price.", + "heading": "Description" + } + ], + "signature": "readonly refinedByPrice: boolean", + "source": "script-api", + "tags": [ + "refinedbyprice", + "productsearchmodel.refinedbyprice" + ], + "title": "ProductSearchModel.refinedByPrice" + }, + { + "description": "Identifies if this search has been refined by promotion.", + "id": "script-api:dw/catalog/ProductSearchModel#refinedByPromotion", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedByPromotion", + "sections": [ + { + "body": "Identifies if this search has been refined by promotion.", + "heading": "Description" + } + ], + "signature": "readonly refinedByPromotion: boolean", + "source": "script-api", + "tags": [ + "refinedbypromotion", + "productsearchmodel.refinedbypromotion" + ], + "title": "ProductSearchModel.refinedByPromotion" + }, + { + "description": "Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.", + "id": "script-api:dw/catalog/ProductSearchModel#refinedCategorySearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinedCategorySearch", + "sections": [ + { + "body": "Identifies if this is a category search and is refined with further\ncriteria, like a brand refinement or an attribute refinement.", + "heading": "Description" + } + ], + "signature": "readonly refinedCategorySearch: boolean", + "source": "script-api", + "tags": [ + "refinedcategorysearch", + "productsearchmodel.refinedcategorysearch" + ], + "title": "ProductSearchModel.refinedCategorySearch" + }, + { + "description": "Returns the category used to determine possible refinements for the search. If an explicit category was set for this purpose using setRefinementCategory, it is returned. Otherwise, the deepest common category of all search results will be returned.", + "id": "script-api:dw/catalog/ProductSearchModel#refinementCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinementCategory", + "sections": [ + { + "body": "Returns the category used to determine possible refinements for the search.\nIf an explicit category was set for this purpose using setRefinementCategory, it is returned.\nOtherwise, the deepest common category of all search results will be returned.", + "heading": "Description" + } + ], + "signature": "refinementCategory: Category", + "source": "script-api", + "tags": [ + "refinementcategory", + "productsearchmodel.refinementcategory" + ], + "title": "ProductSearchModel.refinementCategory" + }, + { + "description": "Returns the ProductSearchRefinements associated with this search and filtered by session currency. If an explicit category was set for this purpose using setRefinementCategory, it will be used to determine the refinements. Otherwise, the refinements are determined based on the deepest common category of all products in the search result. Hint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory to avoid unnecessary calculation of the deepest common category.", + "id": "script-api:dw/catalog/ProductSearchModel#refinements", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.refinements", + "sections": [ + { + "body": "Returns the ProductSearchRefinements associated with this search and filtered by session currency.\nIf an explicit category was set for this purpose using setRefinementCategory, it will be used to determine the refinements.\nOtherwise, the refinements are determined based on the deepest common category of all products in the search result.\nHint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory to avoid unnecessary calculation of the deepest common category.", + "heading": "Description" + } + ], + "signature": "readonly refinements: ProductSearchRefinements", + "source": "script-api", + "tags": [ + "refinements", + "productsearchmodel.refinements" + ], + "title": "ProductSearchModel.refinements" + }, + { + "description": "Execute the search based on the configured search term, category and filter conditions (price, attribute, promotion, product type) and return the execution status. The execution of an empty ProductSearchModel without any search term or filter criteria will not be supported and the search status dw.system.SearchStatus.EMPTY_QUERY will be returned. A usage of the internal category id 'root' as category filter is not recommended, could cause performance issues and will be potentially deprecated in a future release. A successful execution will be indicated by dw.system.SearchStatus.SUCCESSFUL or dw.system.SearchStatus.LIMITED. For other possible search statuses see dw.system.SearchStatus. The sorted and grouped search result of a successful execution can be fetched via getProductSearchHits and the refinement options based on the search result can be obtained via getRefinements and dw.catalog.SearchModel.getRefinementValues.", + "id": "script-api:dw/catalog/ProductSearchModel#search", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.search", + "returns": { + "type": "SearchStatus" + }, + "sections": [ + { + "body": "Execute the search based on the configured search term, category and filter conditions (price, attribute,\npromotion, product type) and return the execution status. The execution of an empty ProductSearchModel without\nany search term or filter criteria will not be supported and the search status dw.system.SearchStatus.EMPTY_QUERY\nwill be returned. A usage of the internal category id 'root' as category filter is not recommended, could cause\nperformance issues and will be potentially deprecated in a future release. A successful execution will be\nindicated by dw.system.SearchStatus.SUCCESSFUL or dw.system.SearchStatus.LIMITED. For other possible search\nstatuses see dw.system.SearchStatus. The sorted and grouped search result of a successful execution can be fetched\nvia getProductSearchHits and the refinement options based on the search result can be obtained via\ngetRefinements and dw.catalog.SearchModel.getRefinementValues.", + "heading": "Description" + } + ], + "signature": "search(): SearchStatus", + "source": "script-api", + "tags": [ + "search", + "productsearchmodel.search" + ], + "title": "ProductSearchModel.search" + }, + { + "description": "Returns search phrase suggestions for the current search phrase. Search phrase suggestions may contain alternative search phrases as well as lists of corrected and completed search terms.", + "id": "script-api:dw/catalog/ProductSearchModel#searchPhraseSuggestions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.searchPhraseSuggestions", + "sections": [ + { + "body": "Returns search phrase suggestions for the current search phrase.\nSearch phrase suggestions may contain alternative search phrases as well\nas lists of corrected and completed search terms.", + "heading": "Description" + } + ], + "signature": "readonly searchPhraseSuggestions: SearchPhraseSuggestions", + "source": "script-api", + "tags": [ + "searchphrasesuggestions", + "productsearchmodel.searchphrasesuggestions" + ], + "title": "ProductSearchModel.searchPhraseSuggestions" + }, + { + "description": "This method returns the URL of the endpoint where the merchants should upload their image for visual search.", + "id": "script-api:dw/catalog/ProductSearchModel#searchableImageUploadURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.searchableImageUploadURL", + "sections": [ + { + "body": "This method returns the URL of the endpoint where the merchants should upload their image for visual search.", + "heading": "Description" + } + ], + "signature": "readonly searchableImageUploadURL: string", + "source": "script-api", + "tags": [ + "searchableimageuploadurl", + "productsearchmodel.searchableimageuploadurl" + ], + "throws": [ + { + "type": "RuntimeException" + } + ], + "title": "ProductSearchModel.searchableImageUploadURL" + }, + { + "description": "Specifies the category id used for the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#setCategoryID", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "categoryID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setCategoryID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies the category id used for the search query.", + "heading": "Description" + } + ], + "signature": "setCategoryID(categoryID: string): void", + "source": "script-api", + "tags": [ + "setcategoryid", + "productsearchmodel.setcategoryid" + ], + "title": "ProductSearchModel.setCategoryID" + }, + { + "description": "Set a flag indicating whether no-hits search should be tracked for predictive intelligence use.", + "id": "script-api:dw/catalog/ProductSearchModel#setEnableTrackingEmptySearches", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "trackingEmptySearches", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setEnableTrackingEmptySearches", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag indicating whether no-hits search should be tracked for predictive intelligence use.", + "heading": "Description" + } + ], + "signature": "setEnableTrackingEmptySearches(trackingEmptySearches: boolean): void", + "source": "script-api", + "tags": [ + "setenabletrackingemptysearches", + "productsearchmodel.setenabletrackingemptysearches" + ], + "title": "ProductSearchModel.setEnableTrackingEmptySearches" + }, + { + "description": "Specifies multiple inventory list IDs used for the search query. The method supports up to MAXIMUM_INVENTORY_LIST_IDS inventory IDs. If more than MAXIMUM_INVENTORY_LIST_IDS inventory IDs used the method throws an IllegalArgumentException.", + "id": "script-api:dw/catalog/ProductSearchModel#setInventoryListIDs", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "inventoryListIDs", + "type": "List" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setInventoryListIDs", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies multiple inventory list IDs used for the search query. The method supports up to\nMAXIMUM_INVENTORY_LIST_IDS inventory IDs. If more than MAXIMUM_INVENTORY_LIST_IDS inventory IDs\nused the method throws an IllegalArgumentException.", + "heading": "Description" + } + ], + "signature": "setInventoryListIDs(inventoryListIDs: List): void", + "source": "script-api", + "tags": [ + "setinventorylistids", + "productsearchmodel.setinventorylistids" + ], + "throws": [ + { + "description": "if more than MAXIMUM_INVENTORY_LIST_IDS inventory IDs used", + "type": "IllegalArgumentException" + } + ], + "title": "ProductSearchModel.setInventoryListIDs" + }, + { + "description": "Set a flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. This method overrides the default behavior which is controlled by the search preference.", + "id": "script-api:dw/catalog/ProductSearchModel#setOrderableProductsOnly", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "orderableOnly", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setOrderableProductsOnly", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag indicating whether unorderable products should be excluded\nwhen the next call to getProducts() is made. This method overrides the\ndefault behavior which is controlled by the search preference.", + "heading": "Description" + } + ], + "signature": "setOrderableProductsOnly(orderableOnly: boolean): void", + "source": "script-api", + "tags": [ + "setorderableproductsonly", + "productsearchmodel.setorderableproductsonly" + ], + "title": "ProductSearchModel.setOrderableProductsOnly" + }, + { + "description": "Sets the maximum price by which the search result is to be refined.", + "id": "script-api:dw/catalog/ProductSearchModel#setPriceMax", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceMax", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPriceMax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the maximum price by which the search result is to be refined.", + "heading": "Description" + } + ], + "signature": "setPriceMax(priceMax: number): void", + "source": "script-api", + "tags": [ + "setpricemax", + "productsearchmodel.setpricemax" + ], + "title": "ProductSearchModel.setPriceMax" + }, + { + "description": "Sets the minimum price by which the search result is to be refined.", + "id": "script-api:dw/catalog/ProductSearchModel#setPriceMin", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "priceMin", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPriceMin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the minimum price by which the search result is to be refined.", + "heading": "Description" + } + ], + "signature": "setPriceMin(priceMin: number): void", + "source": "script-api", + "tags": [ + "setpricemin", + "productsearchmodel.setpricemin" + ], + "title": "ProductSearchModel.setPriceMin" + }, + { + "deprecated": { + "message": "Please use setProductIDs instead" + }, + "description": "Specifies the product id used for the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#setProductID", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setProductID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies the product id used for the search query.", + "heading": "Description" + } + ], + "signature": "setProductID(productID: string): void", + "source": "script-api", + "tags": [ + "setproductid", + "productsearchmodel.setproductid" + ], + "title": "ProductSearchModel.setProductID" + }, + { + "description": "Specifies multiple product IDs used for the search query. The specified product IDs include, but not limited to, variant product IDs, product master IDs, variation group IDs, product set IDs, or product bundle IDs. For example, this API could be used in high-traffic pages where developers need to be able to filter quickly for only available child products of a specified master product, instead of looping through all variants of a set products and checking their availabilities. The method supports up to MAXIMUM_PRODUCT_IDS product IDs. If more than MAXIMUM_PRODUCT_IDS products IDs are passed, the method throws an IllegalArgumentException.", + "id": "script-api:dw/catalog/ProductSearchModel#setProductIDs", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "productIDs", + "type": "List" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setProductIDs", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies multiple product IDs used for the search query. The specified product IDs include, but not limited to,\nvariant product IDs, product master IDs, variation group IDs, product set IDs, or product bundle IDs. For\nexample, this API could be used in high-traffic pages where developers need to be able to filter quickly for only\navailable child products of a specified master product, instead of looping through all variants of a set products\nand checking their availabilities. The method supports up to MAXIMUM_PRODUCT_IDS product IDs. If more\nthan MAXIMUM_PRODUCT_IDS products IDs are passed, the method throws an IllegalArgumentException.", + "heading": "Description" + } + ], + "signature": "setProductIDs(productIDs: List): void", + "source": "script-api", + "tags": [ + "setproductids", + "productsearchmodel.setproductids" + ], + "throws": [ + { + "description": "if more than MAXIMUM_PRODUCT_IDS product IDs used", + "type": "IllegalArgumentException" + } + ], + "title": "ProductSearchModel.setProductIDs" + }, + { + "description": "Specifies the promotion id used for the search query.", + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionID", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies the promotion id used for the search query.", + "heading": "Description" + } + ], + "signature": "setPromotionID(promotionID: string): void", + "source": "script-api", + "tags": [ + "setpromotionid", + "productsearchmodel.setpromotionid" + ], + "title": "ProductSearchModel.setPromotionID" + }, + { + "description": "Specifies multiple promotion id's used for the search query. The method supports up to 30 promotion id's. If more than 30 promotion id's used the method throws an IllegalArgumentException.", + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionIDs", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "promotionIDs", + "type": "List" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionIDs", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies multiple promotion id's used for the search query. The method supports up to 30 promotion id's. If more\nthan 30 promotion id's used the method throws an IllegalArgumentException.", + "heading": "Description" + } + ], + "signature": "setPromotionIDs(promotionIDs: List): void", + "source": "script-api", + "tags": [ + "setpromotionids", + "productsearchmodel.setpromotionids" + ], + "throws": [ + { + "description": "if more than 30 promotion id's used", + "type": "IllegalArgumentException" + } + ], + "title": "ProductSearchModel.setPromotionIDs" + }, + { + "description": "Specifies the promotion product type used for the search query. This value is only relevant for searches by promotion ID.", + "id": "script-api:dw/catalog/ProductSearchModel#setPromotionProductType", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "promotionProductType", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setPromotionProductType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies the promotion product type used for the search query. This\nvalue is only relevant for searches by promotion ID.", + "heading": "Description" + } + ], + "signature": "setPromotionProductType(promotionProductType: string): void", + "source": "script-api", + "tags": [ + "setpromotionproducttype", + "productsearchmodel.setpromotionproducttype" + ], + "title": "ProductSearchModel.setPromotionProductType" + }, + { + "description": "Set a flag to indicate if the search in category should be recursive.", + "id": "script-api:dw/catalog/ProductSearchModel#setRecursiveCategorySearch", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "recurse", + "type": "boolean" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setRecursiveCategorySearch", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag to indicate if the search in category should be recursive.", + "heading": "Description" + } + ], + "signature": "setRecursiveCategorySearch(recurse: boolean): void", + "source": "script-api", + "tags": [ + "setrecursivecategorysearch", + "productsearchmodel.setrecursivecategorysearch" + ], + "title": "ProductSearchModel.setRecursiveCategorySearch" + }, + { + "description": "Sets an explicit category to be used when determining refinements. If this is not done, they will be determined based on the deepest common category of all search results. The explicit category must be in the site's storefront catalog, otherwise the method fails with an IllegalArgumentException.", + "id": "script-api:dw/catalog/ProductSearchModel#setRefinementCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "refinementCategory", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setRefinementCategory", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets an explicit category to be used when determining refinements. If this is not done, they will be determined based on the deepest common category of all search results.\nThe explicit category must be in the site's storefront catalog, otherwise the method fails with an IllegalArgumentException.", + "heading": "Description" + } + ], + "signature": "setRefinementCategory(refinementCategory: Category): void", + "source": "script-api", + "tags": [ + "setrefinementcategory", + "productsearchmodel.setrefinementcategory" + ], + "throws": [ + { + "description": "if the refinement category does not reside in the storefront catalog", + "type": "IllegalArgumentException" + } + ], + "title": "ProductSearchModel.setRefinementCategory" + }, + { + "description": "An image ID can be retrieved by uploading an image with a multipart/form-data POST request to 'https://api.cquotient.com/v3/image/search/upload/{siteID}'. This method sets product IDs retrieved from the image ID to the ProductSearchModel. If using setProductIDs in addition to this method, the ProductSearchModel will take the intersection of these sets of product IDs. If the image ID provided is invalid or expired, product IDs will not be set onto the product search model.", + "id": "script-api:dw/catalog/ProductSearchModel#setSearchableImageID", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "imageID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSearchableImageID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "An image ID can be retrieved by uploading an image with a multipart/form-data POST\nrequest to 'https://api.cquotient.com/v3/image/search/upload/{siteID}'. This method sets product IDs retrieved\nfrom the image ID to the ProductSearchModel. If using setProductIDs in addition to this method,\nthe ProductSearchModel will take the intersection of these sets of product IDs. If the image ID provided is\ninvalid or expired, product IDs will not be set onto the product search model.", + "heading": "Description" + } + ], + "signature": "setSearchableImageID(imageID: string): void", + "source": "script-api", + "tags": [ + "setsearchableimageid", + "productsearchmodel.setsearchableimageid" + ], + "throws": [ + { + "description": "if product IDs for the provided image could not be set.", + "type": "RuntimeException" + } + ], + "title": "ProductSearchModel.setSearchableImageID" + }, + { + "deprecated": { + "message": "This method is subject to removal. Use setSortingRule instead." + }, + "description": "Sets or removes a sorting condition for the specified attribute. Specify either SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a sorting condition. Specify SORT_DIRECTION_NONE to remove a sorting condition from the attribute.", + "id": "script-api:dw/catalog/ProductSearchModel#setSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "direction", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingCondition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets or removes a sorting condition for the specified attribute. Specify\neither SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a\nsorting condition. Specify SORT_DIRECTION_NONE to remove a sorting\ncondition from the attribute.", + "heading": "Description" + } + ], + "signature": "setSortingCondition(attributeID: string, direction: number): void", + "source": "script-api", + "tags": [ + "setsortingcondition", + "productsearchmodel.setsortingcondition" + ], + "title": "ProductSearchModel.setSortingCondition" + }, + { + "description": "Sets the sorting option to be used to order the products in the results of this query. If a sorting rule is also set, the sorting option is ignored.", + "id": "script-api:dw/catalog/ProductSearchModel#setSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "option", + "type": "SortingOption" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingOption", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sorting option to be used to order the products in the results of this query.\nIf a sorting rule is also set, the sorting option is ignored.", + "heading": "Description" + } + ], + "signature": "setSortingOption(option: SortingOption): void", + "source": "script-api", + "tags": [ + "setsortingoption", + "productsearchmodel.setsortingoption" + ], + "title": "ProductSearchModel.setSortingOption" + }, + { + "description": "Sets the sorting rule to be used to order the products in the results of this query. Setting the rule in this way overrides the default behavior of choosing the sorting rule based on the context of the search, such as the refinement category.", + "id": "script-api:dw/catalog/ProductSearchModel#setSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "rule", + "type": "SortingRule" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setSortingRule", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sorting rule to be used to order the products in the\nresults of this query. Setting the rule in this way overrides the\ndefault behavior of choosing the sorting rule based on the context of the\nsearch, such as the refinement category.", + "heading": "Description" + } + ], + "signature": "setSortingRule(rule: SortingRule): void", + "source": "script-api", + "tags": [ + "setsortingrule", + "productsearchmodel.setsortingrule" + ], + "title": "ProductSearchModel.setSortingRule" + }, + { + "description": "Filters the search result by one or more inventory list IDs provided by the class StoreInventoryFilter which supports a semantic URL parameter like zip, city, store ... and a list of StoreInventoryFilterValue which maps the semantic inventory list id value like Burlington, Boston, ... to a real inventory list id like 'Burlington -> inventory1', 'Boston -> inventory2'. The search will filter the result by the real inventory list id(s) but will use the semantic URL parameter and semantic inventory list id values for URL generation via all URLRefine and URLRelax methods e.g. for urlRefineCategory, urlRelaxPrice, SearchModel.urlRefineAttribute.", + "id": "script-api:dw/catalog/ProductSearchModel#setStoreInventoryFilter", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeInventoryFilter", + "type": "StoreInventoryFilter" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.setStoreInventoryFilter", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Filters the search result by one or more inventory list IDs provided by the class StoreInventoryFilter\nwhich supports a semantic URL parameter like zip, city, store ... and a list of StoreInventoryFilterValue\nwhich maps the semantic inventory list id value like Burlington, Boston, ... to a real inventory list id like\n'Burlington -> inventory1', 'Boston -> inventory2'. The search will filter the result by the real inventory list\nid(s) but will use the semantic URL parameter and semantic inventory list id values for URL generation via all\nURLRefine and URLRelax methods e.g. for urlRefineCategory, urlRelaxPrice,\nSearchModel.urlRefineAttribute.\n\nExample custom URL: city=Burlington|Boston", + "heading": "Description" + } + ], + "signature": "setStoreInventoryFilter(storeInventoryFilter: StoreInventoryFilter): void", + "source": "script-api", + "tags": [ + "setstoreinventoryfilter", + "productsearchmodel.setstoreinventoryfilter" + ], + "throws": [ + { + "description": "if more than MAXIMUM_STORE_INVENTORY_FILTER_VALUES filter values used", + "type": "IllegalArgumentException" + } + ], + "title": "ProductSearchModel.setStoreInventoryFilter" + }, + { + "description": "Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or `null` if no rule has been explicitly set.", + "id": "script-api:dw/catalog/ProductSearchModel#sortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.sortingRule", + "sections": [ + { + "body": "Returns the sorting rule explicitly set on this model to be used\nto order the products in the results of this query, or `null`\nif no rule has been explicitly set.\n\nThis method does not return the sorting rule that will be used implicitly\nbased on the context of the search, such as the refinement category.", + "heading": "Description" + } + ], + "signature": "sortingRule: SortingRule | null", + "source": "script-api", + "tags": [ + "sortingrule", + "productsearchmodel.sortingrule" + ], + "title": "ProductSearchModel.sortingRule" + }, + { + "description": "Returns the StoreInventoryFilter, which was specified for this search.", + "id": "script-api:dw/catalog/ProductSearchModel#storeInventoryFilter", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.storeInventoryFilter", + "sections": [ + { + "body": "Returns the StoreInventoryFilter, which was specified for this search.", + "heading": "Description" + } + ], + "signature": "storeInventoryFilter: StoreInventoryFilter", + "source": "script-api", + "tags": [ + "storeinventoryfilter", + "productsearchmodel.storeinventoryfilter" + ], + "title": "ProductSearchModel.storeInventoryFilter" + }, + { + "deprecated": { + "message": "Please use getSearchPhraseSuggestions instead" + }, + "description": "Returns the suggested search phrase with the highest accuracy provided for the current search phrase.", + "id": "script-api:dw/catalog/ProductSearchModel#suggestedSearchPhrase", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.suggestedSearchPhrase", + "sections": [ + { + "body": "Returns the suggested search phrase with the highest accuracy provided\nfor the current search phrase.", + "heading": "Description" + } + ], + "signature": "readonly suggestedSearchPhrase: string", + "source": "script-api", + "tags": [ + "suggestedsearchphrase", + "productsearchmodel.suggestedsearchphrase" + ], + "title": "ProductSearchModel.suggestedSearchPhrase" + }, + { + "deprecated": { + "message": "Please use getSearchPhraseSuggestions instead" + }, + "description": "Returns a list with up to 5 suggested search phrases provided for the current search phrase. It is possible that less than 5 suggestions or even no suggestions are returned.", + "id": "script-api:dw/catalog/ProductSearchModel#suggestedSearchPhrases", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.suggestedSearchPhrases", + "sections": [ + { + "body": "Returns a list with up to 5 suggested search phrases provided for the\ncurrent search phrase. It is possible that less than 5 suggestions\nor even no suggestions are returned.", + "heading": "Description" + } + ], + "signature": "readonly suggestedSearchPhrases: List", + "source": "script-api", + "tags": [ + "suggestedsearchphrases", + "productsearchmodel.suggestedsearchphrases" + ], + "title": "ProductSearchModel.suggestedSearchPhrases" + }, + { + "description": "The method indicates if no-hits search should be tracked for predictive intelligence use.", + "id": "script-api:dw/catalog/ProductSearchModel#trackingEmptySearchesEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.trackingEmptySearchesEnabled", + "sections": [ + { + "body": "The method indicates if no-hits search should be tracked for predictive intelligence use.", + "heading": "Description" + } + ], + "signature": "readonly trackingEmptySearchesEnabled: boolean", + "source": "script-api", + "tags": [ + "trackingemptysearchesenabled", + "productsearchmodel.trackingemptysearchesenabled" + ], + "title": "ProductSearchModel.trackingEmptySearchesEnabled" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Category.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cgid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nCategory.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForCategory(action: string, cgid: string): URL", + "source": "script-api", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Category. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cgid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nCategory. The search specific parameters are appended to the provided\nURL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "static urlForCategory(url: URL, cgid: string): URL", + "source": "script-api", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Category.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cgid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nCategory.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForCategory(action: string, cgid: string): URL", + "source": "script-api", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Category. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cgid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nCategory. The search specific parameters are appended to the provided\nURL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "static urlForCategory(url: URL, cgid: string): URL", + "source": "script-api", + "tags": [ + "urlforcategory", + "productsearchmodel.urlforcategory" + ], + "title": "ProductSearchModel.urlForCategory" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Product. The passed action is used to build an initial url. All search specific attributes are appended.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cgid", + "type": "string | null" + }, + { + "name": "pid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nProduct. The passed action is used to build an initial url. All search\nspecific attributes are appended.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForProduct(action: string, cgid: string | null, pid: string): URL", + "source": "script-api", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Product. The passed url can be either a full url or just the name for a pipeline. In the later case a relative URL is created.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cgid", + "type": "string | null" + }, + { + "name": "pid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nProduct. The passed url can be either a full url or just the name for a\npipeline. In the later case a relative URL is created.", + "heading": "Description" + } + ], + "signature": "static urlForProduct(url: URL, cgid: string | null, pid: string): URL", + "source": "script-api", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Product. The passed action is used to build an initial url. All search specific attributes are appended.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cgid", + "type": "string | null" + }, + { + "name": "pid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nProduct. The passed action is used to build an initial url. All search\nspecific attributes are appended.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForProduct(action: string, cgid: string | null, pid: string): URL", + "source": "script-api", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific Product. The passed url can be either a full url or just the name for a pipeline. In the later case a relative URL is created.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForProduct", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cgid", + "type": "string | null" + }, + { + "name": "pid", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForProduct", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nProduct. The passed url can be either a full url or just the name for a\npipeline. In the later case a relative URL is created.", + "heading": "Description" + } + ], + "signature": "static urlForProduct(url: URL, cgid: string | null, pid: string): URL", + "source": "script-api", + "tags": [ + "urlforproduct", + "productsearchmodel.urlforproduct" + ], + "title": "ProductSearchModel.urlForProduct" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nattribute name-value pair.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(action: string, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific attribute name-value pair. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nattribute name-value pair. The search specific parameters are appended to\nthe provided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(url: URL, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nattribute name-value pair.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(action: string, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "description": "Constructs a URL that you can use to execute a query for a specific attribute name-value pair. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to execute a query for a specific\nattribute name-value pair. The search specific parameters are appended to\nthe provided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(url: URL, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "productsearchmodel.urlforrefine" + ], + "title": "ProductSearchModel.urlForRefine" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with a category refinement.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefineCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "refineCategoryID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefineCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with a\ncategory refinement.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlRefineCategory(action: string, refineCategoryID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinecategory", + "productsearchmodel.urlrefinecategory" + ], + "title": "ProductSearchModel.urlRefineCategory" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with a category refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefineCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "refineCategoryID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefineCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with a\ncategory refinement. The search specific parameters are appended to the\nprovided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "urlRefineCategory(url: URL, refineCategoryID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinecategory", + "productsearchmodel.urlrefinecategory" + ], + "title": "ProductSearchModel.urlRefineCategory" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with an additional price filter.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "min", + "type": "number" + }, + { + "name": "max", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePrice", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with an\nadditional price filter.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlRefinePrice(action: string, min: number, max: number): URL", + "source": "script-api", + "tags": [ + "urlrefineprice", + "productsearchmodel.urlrefineprice" + ], + "title": "ProductSearchModel.urlRefinePrice" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with an additional price filter. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "min", + "type": "number" + }, + { + "name": "max", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePrice", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with an\nadditional price filter. The search specific parameters are appended to\nthe provided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "urlRefinePrice(url: URL, min: number, max: number): URL", + "source": "script-api", + "tags": [ + "urlrefineprice", + "productsearchmodel.urlrefineprice" + ], + "title": "ProductSearchModel.urlRefinePrice" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with a promotion refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePromotion", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "refinePromotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePromotion", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with a promotion refinement. The search specific\nparameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRefinePromotion(url: URL, refinePromotionID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinepromotion", + "productsearchmodel.urlrefinepromotion" + ], + "title": "ProductSearchModel.urlRefinePromotion" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with a promotion refinement. The generated URL will be an absolute URL which uses the protocol of the current request.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRefinePromotion", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "refinePromotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRefinePromotion", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with a promotion refinement. The generated URL will be\nan absolute URL which uses the protocol of the current request.", + "heading": "Description" + } + ], + "signature": "urlRefinePromotion(action: string, refinePromotionID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinepromotion", + "productsearchmodel.urlrefinepromotion" + ], + "title": "ProductSearchModel.urlRefinePromotion" + }, + { + "description": "Constructs a URL that you can use to re-execute the query without any category refinement.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query without any\ncategory refinement.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlRelaxCategory(action: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxcategory", + "productsearchmodel.urlrelaxcategory" + ], + "title": "ProductSearchModel.urlRelaxCategory" + }, + { + "description": "Constructs a URL that you can use to re-execute the query without any category refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxCategory", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxCategory", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query without any\ncategory refinement. The search specific parameters are appended to the\nprovided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "urlRelaxCategory(url: URL): URL", + "source": "script-api", + "tags": [ + "urlrelaxcategory", + "productsearchmodel.urlrelaxcategory" + ], + "title": "ProductSearchModel.urlRelaxCategory" + }, + { + "description": "Constructs a URL that you can use to re-execute the query with no price filter.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPrice", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query with no price\nfilter.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlRelaxPrice(action: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxprice", + "productsearchmodel.urlrelaxprice" + ], + "title": "ProductSearchModel.urlRelaxPrice" + }, + { + "description": "Constructs a URL that you can use to would re-execute the query with no price filter. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPrice", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPrice", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to would re-execute the query with no\nprice filter. The search specific parameters are appended to the provided\nURL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRelaxPrice(url: URL): URL", + "source": "script-api", + "tags": [ + "urlrelaxprice", + "productsearchmodel.urlrelaxprice" + ], + "title": "ProductSearchModel.urlRelaxPrice" + }, + { + "description": "Constructs a URL that you can use to re-execute the query without any promotion refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPromotion", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query without any promotion refinement. The search specific\nparameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRelaxPromotion(url: URL): URL", + "source": "script-api", + "tags": [ + "urlrelaxpromotion", + "productsearchmodel.urlrelaxpromotion" + ], + "title": "ProductSearchModel.urlRelaxPromotion" + }, + { + "description": "Constructs a URL that you can use to re-execute the query without any promotion refinement. The generated URL will be an absolute URL which uses the protocol of the current request.", + "id": "script-api:dw/catalog/ProductSearchModel#urlRelaxPromotion", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlRelaxPromotion", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query without any promotion refinement. The generated URL\nwill be an absolute URL which uses the protocol of the current request.", + "heading": "Description" + } + ], + "signature": "urlRelaxPromotion(action: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxpromotion", + "productsearchmodel.urlrelaxpromotion" + ], + "title": "ProductSearchModel.urlRelaxPromotion" + }, + { + "description": "Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option.", + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "option", + "type": "SortingOption" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingOption", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query but sort the\nresults by the given storefront sorting option.\n\nThe generated URL will be an absolute URL which uses the protocol of the\ncurrent request.", + "heading": "Description" + } + ], + "signature": "urlSortingOption(action: string, option: SortingOption): URL", + "source": "script-api", + "tags": [ + "urlsortingoption", + "productsearchmodel.urlsortingoption" + ], + "title": "ProductSearchModel.urlSortingOption" + }, + { + "description": "Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingOption", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "option", + "type": "SortingOption" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingOption", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query but sort\nthe results by the given storefront sorting option. The search specific parameters are\nappended to the provided URL. The URL is typically generated with one of\nthe URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlSortingOption(url: URL, option: SortingOption): URL", + "source": "script-api", + "tags": [ + "urlsortingoption", + "productsearchmodel.urlsortingoption" + ], + "title": "ProductSearchModel.urlSortingOption" + }, + { + "description": "Constructs a URL that you can use to re-execute the query but sort the results by the given rule.", + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "rule", + "type": "SortingRule" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingRule", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query but sort the\nresults by the given rule.\n\nThe generated URL will be an absolute URL which uses the protocol of the\ncurrent request.", + "heading": "Description" + } + ], + "signature": "urlSortingRule(action: string, rule: SortingRule): URL", + "source": "script-api", + "tags": [ + "urlsortingrule", + "productsearchmodel.urlsortingrule" + ], + "title": "ProductSearchModel.urlSortingRule" + }, + { + "description": "Constructs a URL that you can use to re-execute the query but sort the results by the given rule. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/ProductSearchModel#urlSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "rule", + "type": "SortingRule" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.urlSortingRule", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL that you can use to re-execute the query but sort\nthe results by the given rule. The search specific parameters are\nappended to the provided URL. The URL is typically generated with one of\nthe URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlSortingRule(url: URL, rule: SortingRule): URL", + "source": "script-api", + "tags": [ + "urlsortingrule", + "productsearchmodel.urlsortingrule" + ], + "title": "ProductSearchModel.urlSortingRule" + }, + { + "description": "The method returns true, if this is a visual search. The method checks that a image UUID is specified.", + "id": "script-api:dw/catalog/ProductSearchModel#visualSearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchModel", + "qualifiedName": "dw.catalog.ProductSearchModel.visualSearch", + "sections": [ + { + "body": "The method returns true, if this is a visual search. The\nmethod checks that a image UUID is specified.", + "heading": "Description" + } + ], + "signature": "readonly visualSearch: boolean", + "source": "script-api", + "tags": [ + "visualsearch", + "productsearchmodel.visualsearch" + ], + "title": "ProductSearchModel.visualSearch" + }, + { + "description": "This class provides an interface to refinement options for the product search.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition", + "sections": [ + { + "body": "This class provides an interface to refinement options for the product search.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinementDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productsearchrefinementdefinition", + "dw.catalog.productsearchrefinementdefinition", + "dw/catalog" + ], + "title": "ProductSearchRefinementDefinition" + }, + { + "description": "Identifies if this is a category refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#categoryRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.categoryRefinement", + "sections": [ + { + "body": "Identifies if this is a category refinement.", + "heading": "Description" + } + ], + "signature": "readonly categoryRefinement: boolean", + "source": "script-api", + "tags": [ + "categoryrefinement", + "productsearchrefinementdefinition.categoryrefinement" + ], + "title": "ProductSearchRefinementDefinition.categoryRefinement" + }, + { + "description": "Identifies if this is a category refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isCategoryRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isCategoryRefinement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a category refinement.", + "heading": "Description" + } + ], + "signature": "isCategoryRefinement(): boolean", + "source": "script-api", + "tags": [ + "iscategoryrefinement", + "productsearchrefinementdefinition.iscategoryrefinement" + ], + "title": "ProductSearchRefinementDefinition.isCategoryRefinement" + }, + { + "description": "Identifies if this is a price refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isPriceRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isPriceRefinement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a price refinement.", + "heading": "Description" + } + ], + "signature": "isPriceRefinement(): boolean", + "source": "script-api", + "tags": [ + "ispricerefinement", + "productsearchrefinementdefinition.ispricerefinement" + ], + "title": "ProductSearchRefinementDefinition.isPriceRefinement" + }, + { + "description": "Identifies if this is a promotion refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#isPromotionRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.isPromotionRefinement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a promotion refinement.", + "heading": "Description" + } + ], + "signature": "isPromotionRefinement(): boolean", + "source": "script-api", + "tags": [ + "ispromotionrefinement", + "productsearchrefinementdefinition.ispromotionrefinement" + ], + "title": "ProductSearchRefinementDefinition.isPromotionRefinement" + }, + { + "description": "Identifies if this is a price refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#priceRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.priceRefinement", + "sections": [ + { + "body": "Identifies if this is a price refinement.", + "heading": "Description" + } + ], + "signature": "readonly priceRefinement: boolean", + "source": "script-api", + "tags": [ + "pricerefinement", + "productsearchrefinementdefinition.pricerefinement" + ], + "title": "ProductSearchRefinementDefinition.priceRefinement" + }, + { + "description": "Identifies if this is a promotion refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementDefinition#promotionRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementDefinition", + "qualifiedName": "dw.catalog.ProductSearchRefinementDefinition.promotionRefinement", + "sections": [ + { + "body": "Identifies if this is a promotion refinement.", + "heading": "Description" + } + ], + "signature": "readonly promotionRefinement: boolean", + "source": "script-api", + "tags": [ + "promotionrefinement", + "productsearchrefinementdefinition.promotionrefinement" + ], + "title": "ProductSearchRefinementDefinition.promotionRefinement" + }, + { + "description": "Represents the value of a product search refinement.", + "id": "script-api:dw/catalog/ProductSearchRefinementValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue", + "sections": [ + { + "body": "Represents the value of a product search refinement.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinementValue`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productsearchrefinementvalue", + "dw.catalog.productsearchrefinementvalue", + "dw/catalog" + ], + "title": "ProductSearchRefinementValue" + }, + { + "description": "Returns the lower bound for price refinements. For example, 50.00 for a range of $50.00 - $99.99.", + "id": "script-api:dw/catalog/ProductSearchRefinementValue#getValueFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.getValueFrom", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the lower bound for price refinements. For example, 50.00\nfor a range of $50.00 - $99.99.", + "heading": "Description" + } + ], + "signature": "getValueFrom(): number", + "source": "script-api", + "tags": [ + "getvaluefrom", + "productsearchrefinementvalue.getvaluefrom" + ], + "title": "ProductSearchRefinementValue.getValueFrom" + }, + { + "description": "Returns the upper bound for price refinements. For example, 99.99 for a range of $50.00 - $99.99.", + "id": "script-api:dw/catalog/ProductSearchRefinementValue#getValueTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.getValueTo", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the upper bound for price refinements. For example, 99.99\nfor a range of $50.00 - $99.99.", + "heading": "Description" + } + ], + "signature": "getValueTo(): number", + "source": "script-api", + "tags": [ + "getvalueto", + "productsearchrefinementvalue.getvalueto" + ], + "title": "ProductSearchRefinementValue.getValueTo" + }, + { + "description": "Returns the lower bound for price refinements. For example, 50.00 for a range of $50.00 - $99.99.", + "id": "script-api:dw/catalog/ProductSearchRefinementValue#valueFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.valueFrom", + "sections": [ + { + "body": "Returns the lower bound for price refinements. For example, 50.00\nfor a range of $50.00 - $99.99.", + "heading": "Description" + } + ], + "signature": "readonly valueFrom: number", + "source": "script-api", + "tags": [ + "valuefrom", + "productsearchrefinementvalue.valuefrom" + ], + "title": "ProductSearchRefinementValue.valueFrom" + }, + { + "description": "Returns the upper bound for price refinements. For example, 99.99 for a range of $50.00 - $99.99.", + "id": "script-api:dw/catalog/ProductSearchRefinementValue#valueTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinementValue", + "qualifiedName": "dw.catalog.ProductSearchRefinementValue.valueTo", + "sections": [ + { + "body": "Returns the upper bound for price refinements. For example, 99.99\nfor a range of $50.00 - $99.99.", + "heading": "Description" + } + ], + "signature": "readonly valueTo: number", + "source": "script-api", + "tags": [ + "valueto", + "productsearchrefinementvalue.valueto" + ], + "title": "ProductSearchRefinementValue.valueTo" + }, + { + "description": "This class provides an interface to refinement options for the product search. In a typical usage, the client application UI displays the search refinements along with the search results and allows customers to \"refine\" the results (i.e. limit the results that are shown) by specifying additional product criteria, or \"relax\" (i.e. broaden) the results after previously refining. The four types of product search refinements are:", + "id": "script-api:dw/catalog/ProductSearchRefinements", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductSearchRefinements", + "sections": [ + { + "body": "This class provides an interface to refinement options for the product\nsearch. In a typical usage, the client application UI displays the search\nrefinements along with the search results and allows customers to \"refine\"\nthe results (i.e. limit the results that are shown) by specifying additional\nproduct criteria, or \"relax\" (i.e. broaden) the results after previously\nrefining. The four types of product search refinements are:\n\n- Refine By Category: Limit the products to those assigned to\nspecific child/ancestor categories of the search category.\n- Refine By Attribute: Limit the products to those with specific\nvalues for a given attribute. Values may be grouped into \"buckets\" so that a\ngiven set of values are represented as a single refinement option.\n- Refine By Price: Limit the products to those whose prices fall in\na specific range.\n- Refine By Promotion: Limit the products to those which are related\nto a specific promotion.\n\nRendering a product search refinement UI typically begins with iterating the\nrefinement definitions for the search result. Call\ndw.catalog.SearchRefinements.getRefinementDefinitions or\ndw.catalog.SearchRefinements.getAllRefinementDefinitions to\nretrieve the appropriate collection of refinement definitions. For each\ndefinition, display the available refinement values by calling\ngetAllRefinementValues. Depending\non the type of the refinement definition, the application must use slightly\ndifferent logic to display the refinement widgets. For all 4 types, methods\nin dw.catalog.ProductSearchModel are used to generate URLs to render\nhyperlinks in the UI. When clicked, these links trigger a call to the Search\npipelet which in turn applies the appropriate filters to the native search\nresult.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinements`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productsearchrefinements", + "dw.catalog.productsearchrefinements", + "dw/catalog" + ], + "title": "ProductSearchRefinements" + }, + { + "description": "Returns the appropriate category refinement definition based on the search result. The category refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#categoryRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.categoryRefinementDefinition", + "sections": [ + { + "body": "Returns the appropriate category refinement definition based on the search\nresult. The category refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "readonly categoryRefinementDefinition: ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "categoryrefinementdefinition", + "productsearchrefinements.categoryrefinementdefinition" + ], + "title": "ProductSearchRefinements.categoryRefinementDefinition" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection | null" + }, + "signature": "getAllRefinementValues(attributeName: string): Collection | null", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection" + }, + "signature": "getAllRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns a sorted collection of refinement values for the passed refinement definition. The returned collection includes all refinement values for which the hit count is greater than 0 within the search result when the passed refinement definition is excluded from filtering the search hits but all other refinement filters are still applied. This method is useful for rendering broadening options for definitions that the search is currently refined by. If the search is not currently restricted by the passed refinement definition, then this method will return the same result as getRefinementValues.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "definition", + "type": "ProductSearchRefinementDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of refinement values for the passed\nrefinement definition. The returned collection includes all refinement\nvalues for which the hit count is greater than 0 within the search result\nwhen the passed refinement definition is excluded from filtering the\nsearch hits but all other refinement filters are still applied. This\nmethod is useful for rendering broadening options for definitions that\nthe search is currently refined by. If the search is not currently\nrestricted by the passed refinement definition, then this method will\nreturn the same result as\ngetRefinementValues.\n\nFor attribute-based refinement definitions, the returned collection\ndepends upon how the \"value set\" property is configured. (Category and\nprice refinement definitions do not have such a property.) If this\nproperty is set to \"search result values\", the behavior is as described\nabove. If this property is set to \"all values of category\", then the\nreturned collection will also include all refinement values for products\nin the category subtree rooted at the search definition's category. This\nsetting is useful for refinements whose visualization is supposed to\nremain constant for a certain subtree of a catalog (e.g. color pickers or\nsize charts). These additional values are independent of the search\nresult and do not contribute towards the value hit counts. If the search\nresult is further refined by one of these values, it is possible to get\nan empty search result. Except for this one case this method does NOT\nreturn refinement values independent of the search result.", + "heading": "Description" + } + ], + "signature": "getAllRefinementValues(definition: ProductSearchRefinementDefinition): Collection", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "productsearchrefinements.getallrefinementvalues" + ], + "title": "ProductSearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns the appropriate category refinement definition based on the search result. The category refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getCategoryRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getCategoryRefinementDefinition", + "returns": { + "type": "ProductSearchRefinementDefinition | null" + }, + "sections": [ + { + "body": "Returns the appropriate category refinement definition based on the search\nresult. The category refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "getCategoryRefinementDefinition(): ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "getcategoryrefinementdefinition", + "productsearchrefinements.getcategoryrefinementdefinition" + ], + "title": "ProductSearchRefinements.getCategoryRefinementDefinition" + }, + { + "description": "Returns category refinement values based on the current search result filtered such that only category refinements representing children of the given category are present. If no category is given, the method uses the catalog's root category. The refinement value product counts represent all hits contained in the catalog tree starting at the corresponding child category.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getNextLevelCategoryRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "category", + "type": "Category" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getNextLevelCategoryRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns category refinement values based on the current search result\nfiltered such that only category refinements representing children of the\ngiven category are present. If no category is given, the method uses the\ncatalog's root category. The refinement value product counts represent\nall hits contained in the catalog tree starting at the corresponding\nchild category.", + "heading": "Description" + } + ], + "signature": "getNextLevelCategoryRefinementValues(category: Category): Collection", + "source": "script-api", + "tags": [ + "getnextlevelcategoryrefinementvalues", + "productsearchrefinements.getnextlevelcategoryrefinementvalues" + ], + "title": "ProductSearchRefinements.getNextLevelCategoryRefinementValues" + }, + { + "description": "Returns the appropriate price refinement definition based on the search result. The price refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getPriceRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getPriceRefinementDefinition", + "returns": { + "type": "ProductSearchRefinementDefinition | null" + }, + "sections": [ + { + "body": "Returns the appropriate price refinement definition based on the search\nresult. The price refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "getPriceRefinementDefinition(): ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "getpricerefinementdefinition", + "productsearchrefinements.getpricerefinementdefinition" + ], + "title": "ProductSearchRefinements.getPriceRefinementDefinition" + }, + { + "description": "Returns the appropriate promotion refinement definition based on the search result. The promotion refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getPromotionRefinementDefinition", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getPromotionRefinementDefinition", + "returns": { + "type": "ProductSearchRefinementDefinition | null" + }, + "sections": [ + { + "body": "Returns the appropriate promotion refinement definition based on the search\nresult. The promotion refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "getPromotionRefinementDefinition(): ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "getpromotionrefinementdefinition", + "productsearchrefinements.getpromotionrefinementdefinition" + ], + "title": "ProductSearchRefinements.getPromotionRefinementDefinition" + }, + { + "description": "Returns the refinement value (incl. product hit count) for the given refinement definition and the given (selected) value.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "definition", + "type": "ProductSearchRefinementDefinition" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValue", + "returns": { + "type": "ProductSearchRefinementValue" + }, + "sections": [ + { + "body": "Returns the refinement value (incl. product hit count) for the given\nrefinement definition and the given (selected) value.", + "heading": "Description" + } + ], + "signature": "getRefinementValue(definition: ProductSearchRefinementDefinition, value: string): ProductSearchRefinementValue", + "source": "script-api", + "tags": [ + "getrefinementvalue", + "productsearchrefinements.getrefinementvalue" + ], + "title": "ProductSearchRefinements.getRefinementValue" + }, + { + "description": "Returns the refinement value (incl. product hit count) for the given refinement attribute and the given (selected) value.", + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValue", + "returns": { + "type": "ProductSearchRefinementValue" + }, + "sections": [ + { + "body": "Returns the refinement value (incl. product hit count) for the given\nrefinement attribute and the given (selected) value.", + "heading": "Description" + } + ], + "signature": "getRefinementValue(name: string, value: string): ProductSearchRefinementValue", + "source": "script-api", + "tags": [ + "getrefinementvalue", + "productsearchrefinements.getrefinementvalue" + ], + "title": "ProductSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValues", + "returns": { + "type": "Collection" + }, + "signature": "getRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "productsearchrefinements.getrefinementvalues" + ], + "title": "ProductSearchRefinements.getRefinementValues" + }, + { + "description": "Returns a collection of refinement values for the given refinement definition. The returned refinement values only include those that are part of the actual search result (i.e. hit count will always be > 0).", + "id": "script-api:dw/catalog/ProductSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "definition", + "type": "ProductSearchRefinementDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.getRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of refinement values for the given refinement\ndefinition. The returned refinement values only include those that are\npart of the actual search result (i.e. hit count will always be > 0).", + "heading": "Description" + } + ], + "signature": "getRefinementValues(definition: ProductSearchRefinementDefinition): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "productsearchrefinements.getrefinementvalues" + ], + "title": "ProductSearchRefinements.getRefinementValues" + }, + { + "description": "Returns the appropriate price refinement definition based on the search result. The price refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#priceRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.priceRefinementDefinition", + "sections": [ + { + "body": "Returns the appropriate price refinement definition based on the search\nresult. The price refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "readonly priceRefinementDefinition: ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "pricerefinementdefinition", + "productsearchrefinements.pricerefinementdefinition" + ], + "title": "ProductSearchRefinements.priceRefinementDefinition" + }, + { + "description": "Returns the appropriate promotion refinement definition based on the search result. The promotion refinement definition returned will be the first that can be found traversing the category tree upward starting at the deepest common category of the search result.", + "id": "script-api:dw/catalog/ProductSearchRefinements#promotionRefinementDefinition", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductSearchRefinements", + "qualifiedName": "dw.catalog.ProductSearchRefinements.promotionRefinementDefinition", + "sections": [ + { + "body": "Returns the appropriate promotion refinement definition based on the search\nresult. The promotion refinement definition returned will be the first that\ncan be found traversing the category tree upward starting at the deepest\ncommon category of the search result.", + "heading": "Description" + } + ], + "signature": "readonly promotionRefinementDefinition: ProductSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "promotionrefinementdefinition", + "productsearchrefinements.promotionrefinementdefinition" + ], + "title": "ProductSearchRefinements.promotionRefinementDefinition" + }, + { + "description": "Represents a product variation attribute", + "id": "script-api:dw/catalog/ProductVariationAttribute", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationAttribute", + "sections": [ + { + "body": "Represents a product variation attribute", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productvariationattribute", + "dw.catalog.productvariationattribute", + "dw/catalog" + ], + "title": "ProductVariationAttribute" + }, + { + "description": "Returns the ID of the product variation attribute.", + "id": "script-api:dw/catalog/ProductVariationAttribute#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.ID", + "sections": [ + { + "body": "Returns the ID of the product variation attribute.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productvariationattribute.id" + ], + "title": "ProductVariationAttribute.ID" + }, + { + "description": "Returns the ID of the product attribute defintion related to this variation attribute. This ID matches the value returned by dw.object.ObjectAttributeDefinition.getID for the appropriate product attribute definition. This ID is generally different than the ID returned by getID.", + "id": "script-api:dw/catalog/ProductVariationAttribute#attributeID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.attributeID", + "sections": [ + { + "body": "Returns the ID of the product attribute defintion related to\nthis variation attribute. This ID matches the\nvalue returned by dw.object.ObjectAttributeDefinition.getID\nfor the appropriate product attribute definition.\nThis ID is generally different than the ID returned by\ngetID.", + "heading": "Description" + } + ], + "signature": "readonly attributeID: string", + "source": "script-api", + "tags": [ + "attributeid", + "productvariationattribute.attributeid" + ], + "title": "ProductVariationAttribute.attributeID" + }, + { + "description": "Returns the display name for the product variation attribute, which can be used in the user interface.", + "id": "script-api:dw/catalog/ProductVariationAttribute#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.displayName", + "sections": [ + { + "body": "Returns the display name for the product variation attribute, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "productvariationattribute.displayname" + ], + "title": "ProductVariationAttribute.displayName" + }, + { + "description": "Returns the ID of the product attribute defintion related to this variation attribute. This ID matches the value returned by dw.object.ObjectAttributeDefinition.getID for the appropriate product attribute definition. This ID is generally different than the ID returned by getID.", + "id": "script-api:dw/catalog/ProductVariationAttribute#getAttributeID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getAttributeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product attribute defintion related to\nthis variation attribute. This ID matches the\nvalue returned by dw.object.ObjectAttributeDefinition.getID\nfor the appropriate product attribute definition.\nThis ID is generally different than the ID returned by\ngetID.", + "heading": "Description" + } + ], + "signature": "getAttributeID(): string", + "source": "script-api", + "tags": [ + "getattributeid", + "productvariationattribute.getattributeid" + ], + "title": "ProductVariationAttribute.getAttributeID" + }, + { + "description": "Returns the display name for the product variation attribute, which can be used in the user interface.", + "id": "script-api:dw/catalog/ProductVariationAttribute#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name for the product variation attribute, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "productvariationattribute.getdisplayname" + ], + "title": "ProductVariationAttribute.getDisplayName" + }, + { + "description": "Returns the ID of the product variation attribute.", + "id": "script-api:dw/catalog/ProductVariationAttribute#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttribute", + "qualifiedName": "dw.catalog.ProductVariationAttribute.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product variation attribute.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productvariationattribute.getid" + ], + "title": "ProductVariationAttribute.getID" + }, + { + "description": "Represents a product variation attribute", + "id": "script-api:dw/catalog/ProductVariationAttributeValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue", + "sections": [ + { + "body": "Represents a product variation attribute", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productvariationattributevalue", + "dw.catalog.productvariationattributevalue", + "dw/catalog" + ], + "title": "ProductVariationAttributeValue" + }, + { + "description": "Returns the ID of the product variation attribute value.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.ID", + "sections": [ + { + "body": "Returns the ID of the product variation attribute value.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productvariationattributevalue.id" + ], + "title": "ProductVariationAttributeValue.ID" + }, + { + "description": "Returns the description of the product variation attribute value in the current locale.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.description", + "sections": [ + { + "body": "Returns the description of the product variation attribute value in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "productvariationattributevalue.description" + ], + "title": "ProductVariationAttributeValue.description" + }, + { + "description": "Returns the display value for the product variation attribute value, which can be used in the user interface.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.displayValue", + "sections": [ + { + "body": "Returns the display value for the product variation attribute value, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "readonly displayValue: string", + "source": "script-api", + "tags": [ + "displayvalue", + "productvariationattributevalue.displayvalue" + ], + "title": "ProductVariationAttributeValue.displayValue" + }, + { + "description": "Returns true if the specified object is equal to this object.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#equals", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "obj", + "type": "any" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.equals", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the specified object is equal to this object.", + "heading": "Description" + } + ], + "signature": "equals(obj: any): boolean", + "source": "script-api", + "tags": [ + "equals", + "productvariationattributevalue.equals" + ], + "title": "ProductVariationAttributeValue.equals" + }, + { + "description": "Returns the description of the product variation attribute value in the current locale.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description of the product variation attribute value in the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "productvariationattributevalue.getdescription" + ], + "title": "ProductVariationAttributeValue.getDescription" + }, + { + "description": "Returns the display value for the product variation attribute value, which can be used in the user interface.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getDisplayValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display value for the product variation attribute value, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "getDisplayValue(): string", + "source": "script-api", + "tags": [ + "getdisplayvalue", + "productvariationattributevalue.getdisplayvalue" + ], + "title": "ProductVariationAttributeValue.getDisplayValue" + }, + { + "description": "Returns the ID of the product variation attribute value.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the product variation attribute value.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productvariationattributevalue.getid" + ], + "title": "ProductVariationAttributeValue.getID" + }, + { + "description": "The method calls getImages and returns the image at the specific index.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method calls getImages and returns the image at\nthe specific index.\n\nIf images are defined for this view type and variant, but not for\nspecified index, the method returns null.\n\nIf no images are defined for this variant and specified view type, the\nimage at the specified index of the master product images is returned. If\nno master product image for specified index is defined, the method\nreturns null.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string, index: number): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "productvariationattributevalue.getimage" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "ProductVariationAttributeValue.getImage" + }, + { + "description": "The method calls getImages and returns the first image of the list. The method is specifically built for handling color swatches in an apparel site.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method calls getImages and returns the first image\nof the list. The method is specifically built for handling color\nswatches in an apparel site.\n\nIf no images are defined for this variant and specified view type, then\nthe first image of the master product images for that view type is\nreturned. If no master product images are defined, the method returns\nnull.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "productvariationattributevalue.getimage" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "ProductVariationAttributeValue.getImage" + }, + { + "description": "Returns all images that match the given view type and have the variant value of this value, which is typically the 'color' attribute. The images are returned in the order of their index number ascending.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getImages", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all images that match the given view type and have the variant\nvalue of this value, which is typically the 'color' attribute. The images\nare returned in the order of their index number ascending.\n\nIf no images are defined for this variant, then the images of the master\nfor that view type are returned.", + "heading": "Description" + } + ], + "signature": "getImages(viewtype: string): List", + "source": "script-api", + "tags": [ + "getimages", + "productvariationattributevalue.getimages" + ], + "throws": [ + { + "description": "if viewtype is null", + "type": "NullArgumentException" + } + ], + "title": "ProductVariationAttributeValue.getImages" + }, + { + "description": "Returns the value for the product variation attribute value.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.getValue", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the value for the product variation attribute value.", + "heading": "Description" + } + ], + "signature": "getValue(): any", + "source": "script-api", + "tags": [ + "getvalue", + "productvariationattributevalue.getvalue" + ], + "title": "ProductVariationAttributeValue.getValue" + }, + { + "description": "Calculates the hash code for a product variation attribute value.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#hashCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.hashCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Calculates the hash code for a product variation attribute value.", + "heading": "Description" + } + ], + "signature": "hashCode(): number", + "source": "script-api", + "tags": [ + "hashcode", + "productvariationattributevalue.hashcode" + ], + "title": "ProductVariationAttributeValue.hashCode" + }, + { + "description": "Returns the value for the product variation attribute value.", + "id": "script-api:dw/catalog/ProductVariationAttributeValue#value", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationAttributeValue", + "qualifiedName": "dw.catalog.ProductVariationAttributeValue.value", + "sections": [ + { + "body": "Returns the value for the product variation attribute value.", + "heading": "Description" + } + ], + "signature": "readonly value: any", + "source": "script-api", + "tags": [ + "value", + "productvariationattributevalue.value" + ], + "title": "ProductVariationAttributeValue.value" + }, + { + "description": "Class representing the complete variation information for a master product in the system. An instance of this class provides methods to access the following information:", + "id": "script-api:dw/catalog/ProductVariationModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.ProductVariationModel", + "sections": [ + { + "body": "Class representing the complete variation information for a master product in\nthe system. An instance of this class provides methods to access the\nfollowing information:\n\n- The variation attributes of the master product (e.g. size and color). Use\ngetProductVariationAttributes.\n- The variation attribute values (e.g. size=Small, Medium, Large and\ncolor=Red, Blue). Use getAllValues.\n- The variation groups which may represent a subset of variants by defining a\nsubset of the variation attribute values (e.g. color=Red, size=empty). Use\ngetVariationGroups.\n- The variants themselves (e.g. the products representing Small Red, Large\nRed, Small Blue, Large Blue, etc). Use getVariants.\n- The variation attribute values of those variants. Use\ngetVariationValue.\n\nThis model only considers variants which are complete (i.e. the variant has a\nvalue for each variation attribute), and currently online. Incomplete or\noffline variants will not be returned by any method that returns Variants,\nand their attribute values will not be considered in any method that returns\nvalues.\n\nIn addition to providing access to this meta information,\nProductVariationModel maintains a collection of selected variation attribute\nvalues, representing the selections that a customer makes in the storefront.\nIf this model was constructed for a master product, then none of the\nattributes will have pre-selected values. If this model was constructed for a\nvariant product, then all the attribute values of that variant will be\npre-selected.\n\nIt is possible to query the current selections by calling\ngetSelectedValue or\nisSelectedAttributeValue.\n\nThe method setSelectedAttributeValue can be used to modify\nthe selected values. Depending on the product type, it's possible to select or modify\nvariation attribute values:\n\n- If this model was constructed for a master product, it's possible to select and modify all variation attributes.\n- If this model was constructed for a variation group, it's possible to select and modify all variation attributes that are not defined by the variation group.\n- If this model was constructed for a variation product, it's not possible to select or modify any of the variation attributes.\n\nFurthermore, the model provides helper methods to generate URLs\nfor selecting and unselecting variation attribute values. See those methods\nfor details.\n\nIf this model was constructed for a product that is neither a\nmaster nor a variant, then none of the methods will return useful values at\nall.\n\nThe methods in this class which access the currently selected variation\nattribute values can be used on product detail pages to render information\nabout which combinations are available or unavailable. The methods\ngetFilteredValues and\nhasOrderableVariants\ncan be used to determine this type of situation and render the appropriate\nmessage in the storefront.\n\nNOTE: Several methods in this class have a version taking a\ndw.catalog.ProductVariationAttribute parameter, and another\ndeprecated version accepting a dw.object.ObjectAttributeDefinition\nparameter instead. The former should be strictly favored. The latter are\nhistorical leftovers from when object attributes were used directly as the\nbasis for variation, and the value lists were stored directly on the\nObjectAttributeDefinition. Every ProductVariationAttribute corresponds with\nexactly one ObjectAttributeDefinition, but values are now stored on the\nProductVariationAttribute and not the ObjectAttributeDefinition.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productvariationmodel", + "dw.catalog.productvariationmodel", + "dw/catalog" + ], + "title": "ProductVariationModel" + }, + { + "deprecated": { + "message": "This method is deprecated since custom code should work with\nProductVariationAttributes and not directly with their\ncorresponding ObjectAttributeDefinitions. Use\ngetProductVariationAttributes to get the\nproduct variation attributes." + }, + "description": "Returns the object attribute definitions corresponding with the product variation attributes of the master product.", + "id": "script-api:dw/catalog/ProductVariationModel#attributeDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.attributeDefinitions", + "sections": [ + { + "body": "Returns the object attribute definitions corresponding with the product\nvariation attributes of the master product.", + "heading": "Description" + } + ], + "signature": "readonly attributeDefinitions: Collection", + "source": "script-api", + "tags": [ + "attributedefinitions", + "productvariationmodel.attributedefinitions" + ], + "title": "ProductVariationModel.attributeDefinitions" + }, + { + "description": "Return the default variant of this model's master product. If no default variant has been defined, return an arbitrary variant.", + "id": "script-api:dw/catalog/ProductVariationModel#defaultVariant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.defaultVariant", + "sections": [ + { + "body": "Return the default variant of this model's master product. If no default\nvariant has been defined, return an arbitrary variant.", + "heading": "Description" + } + ], + "signature": "readonly defaultVariant: Variant | null", + "source": "script-api", + "tags": [ + "defaultvariant", + "productvariationmodel.defaultvariant" + ], + "title": "ProductVariationModel.defaultVariant" + }, + { + "deprecated": { + "message": "This method is deprecated since custom code should work with\nProductVariationAttributes and not directly with their\ncorresponding ObjectAttributeDefinitions. Use\ngetAllValues to get the\ncollection of ProductVariationAttributeValue instances\ninstead." + }, + "description": "Returns the value definitions for the specified attribute. Only values that actually exist for at least one of the master product's currently online and complete variants are returned.", + "id": "script-api:dw/catalog/ProductVariationModel#getAllValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAllValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the value definitions for the specified attribute. Only values\nthat actually exist for at least one of the master product's currently\nonline and complete variants are returned.\n\nReturns an empty collection if the passed attribute is not even a\nvariation attribute of the master product.", + "heading": "Description" + } + ], + "signature": "getAllValues(attribute: ObjectAttributeDefinition): Collection", + "source": "script-api", + "tags": [ + "getallvalues", + "productvariationmodel.getallvalues" + ], + "title": "ProductVariationModel.getAllValues" + }, + { + "description": "Returns the values for the specified attribute. Only values that actually exist for at least one of the master product's currently online and complete variants are returned.", + "id": "script-api:dw/catalog/ProductVariationModel#getAllValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAllValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the values for the specified attribute. Only values that actually\nexist for at least one of the master product's currently online and\ncomplete variants are returned.\n\nReturns an empty collection if the passed attribute is not even a\nvariation attribute of the master product.", + "heading": "Description" + } + ], + "signature": "getAllValues(attribute: ProductVariationAttribute): Collection", + "source": "script-api", + "tags": [ + "getallvalues", + "productvariationmodel.getallvalues" + ], + "title": "ProductVariationModel.getAllValues" + }, + { + "deprecated": { + "message": "This method is deprecated since custom code should work with\nProductVariationAttributes and not directly with their\ncorresponding ObjectAttributeDefinitions. Use\ngetProductVariationAttributes to get the\nproduct variation attributes." + }, + "description": "Returns the object attribute definitions corresponding with the product variation attributes of the master product.", + "id": "script-api:dw/catalog/ProductVariationModel#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the object attribute definitions corresponding with the product\nvariation attributes of the master product.", + "heading": "Description" + } + ], + "signature": "getAttributeDefinitions(): Collection", + "source": "script-api", + "tags": [ + "getattributedefinitions", + "productvariationmodel.getattributedefinitions" + ], + "title": "ProductVariationModel.getAttributeDefinitions" + }, + { + "description": "Return the default variant of this model's master product. If no default variant has been defined, return an arbitrary variant.", + "id": "script-api:dw/catalog/ProductVariationModel#getDefaultVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getDefaultVariant", + "returns": { + "type": "Variant | null" + }, + "sections": [ + { + "body": "Return the default variant of this model's master product. If no default\nvariant has been defined, return an arbitrary variant.", + "heading": "Description" + } + ], + "signature": "getDefaultVariant(): Variant | null", + "source": "script-api", + "tags": [ + "getdefaultvariant", + "productvariationmodel.getdefaultvariant" + ], + "title": "ProductVariationModel.getDefaultVariant" + }, + { + "deprecated": { + "message": "Use getFilteredValues to\nget the sorted and calculated collection of product variation\nattribute values." + }, + "description": "Returns a collection of the value definitions defined for the specified attribute, filtered based on currently selected values.", + "id": "script-api:dw/catalog/ProductVariationModel#getFilteredValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getFilteredValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of the value definitions defined for the specified\nattribute, filtered based on currently selected values.\n\nA value is only returned if it at least one variant has the value and\nalso possesses the selected values for all previous attributes. It is\nimportant to know that the filter is applied in a certain order. The\nmethod looks at all ObjectAttributeDefinition instances that appear\nbefore the passed one in the sorted collection returned by\ngetAttributeDefinitions. If the passed attribute is the first\nin this collection, then this method simply returns all its values. If an\nearlier attribute does not have a selected value, this method returns an\nempty list. Otherwise, the filter looks at all variants matching the\nselected value for all previous attributes, and considers the range of\nvalues possessed by these variants for the passed attribute.\n\nThe idea behind this method is that customers in the storefront select\nvariation attribute values one by one in the order the variation\nattributes are defined and displayed. After each selection, customer only\nwants to see values that he can possibly order for the remaining\nattributes.\n\nReturns an empty collection if the passed attribute is not even a\nvariation attribute of the master product.", + "heading": "Description" + } + ], + "signature": "getFilteredValues(attribute: ObjectAttributeDefinition): Collection", + "source": "script-api", + "tags": [ + "getfilteredvalues", + "productvariationmodel.getfilteredvalues" + ], + "title": "ProductVariationModel.getFilteredValues" + }, + { + "description": "Returns a collection of the value definitions defined for the specified attribute, filtered based on currently selected values.", + "id": "script-api:dw/catalog/ProductVariationModel#getFilteredValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getFilteredValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of the value definitions defined for the specified\nattribute, filtered based on currently selected values.\n\nA value is only returned if it at least one variant has the value and\nalso possesses the selected values for all previous attributes. It is\nimportant to know that the filter is applied in a certain order. The\nmethod looks at all ProductVariationAttribute instances that appear\nbefore the passed one in the sorted collection returned by\ngetProductVariationAttributes. If the passed attribute is the\nfirst in this collection, then this method simply returns all its values.\nIf an earlier attribute does not have a selected value, this method\nreturns an empty list. Otherwise, the filter looks at all variants\nmatching the selected value for all previous attributes, and considers\nthe range of values possessed by these variants for the passed attribute.\n\nThe idea behind this method is that customers in the storefront select\nvariation attribute values one by one in the order the variation\nattributes are defined and displayed. After each selection, customer only\nwants to see values that he can possibly order for the remaining\nattributes.\n\nReturns an empty collection if the passed attribute is not even a\nvariation attribute of the master product.", + "heading": "Description" + } + ], + "signature": "getFilteredValues(attribute: ProductVariationAttribute): Collection", + "source": "script-api", + "tags": [ + "getfilteredvalues", + "productvariationmodel.getfilteredvalues" + ], + "title": "ProductVariationModel.getFilteredValues" + }, + { + "deprecated": { + "message": "Use getHtmlName to get\nthe HTML representation of the product variation attribute\nid." + }, + "description": "Returns an HTML representation of the variation attribute id. This method is deprecated. You should use getHtmlName(ProductVariationAttribute) instead.", + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the variation attribute id. This method\nis deprecated. You should use getHtmlName(ProductVariationAttribute)\ninstead.", + "heading": "Description" + } + ], + "signature": "getHtmlName(attribute: ObjectAttributeDefinition): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "deprecated": { + "message": "Use getHtmlName\nto get the HTML representation of the product variation\nattribute id with the custom prefix." + }, + "description": "Returns an HTML representation of the variation attribute id with the custom prefix. This method is deprecated. You should use getHtmlName instead.", + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the variation attribute id with the\ncustom prefix. This method is deprecated. You should use\ngetHtmlName instead.", + "heading": "Description" + } + ], + "signature": "getHtmlName(prefix: string, attribute: ObjectAttributeDefinition): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "description": "Returns an HTML representation of the product variation attribute id.", + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the product variation attribute id.", + "heading": "Description" + } + ], + "signature": "getHtmlName(attribute: ProductVariationAttribute): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "description": "Returns an HTML representation of the product variation attribute id with the custom prefix.", + "id": "script-api:dw/catalog/ProductVariationModel#getHtmlName", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getHtmlName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an HTML representation of the product variation attribute id with the custom prefix.", + "heading": "Description" + } + ], + "signature": "getHtmlName(prefix: string, attribute: ProductVariationAttribute): string", + "source": "script-api", + "tags": [ + "gethtmlname", + "productvariationmodel.gethtmlname" + ], + "title": "ProductVariationModel.getHtmlName" + }, + { + "description": "The method returns the first image appropriate for the currently selected attribute values.", + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "attribute", + "type": "ProductVariationAttribute" + }, + { + "name": "value", + "type": "ProductVariationAttributeValue" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method returns the first image appropriate for the currently selected attribute values.\n\nThe method first considers the most specific combination of attribute values (e.g\n\"Red leather\") and if that is not found, more general (e.g \"Red\"). If no image group\nis found for the attributes, returns null\n\nThe view type parameter is required, otherwise a exception is thrown.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string, attribute: ProductVariationAttribute, value: ProductVariationAttributeValue): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "description": "The method returns an image appropriate for the current selected variation values with the specific index.", + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method returns an image appropriate for the current selected variation values\nwith the specific index.\n\nIf images are defined for this view type and variants, but not for\nspecified index, the method returns null.\n\nIf no images are defined for all variants and specified view type, the\nimage at the specified index of the master product images is returned. If\nno master product image for specified index is defined, the method\nreturns null.\n\nThe view type parameter is required, otherwise a exception is thrown.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string, index: number): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "description": "The method returns the first image appropriate for the current selected variation values with the specific index.", + "id": "script-api:dw/catalog/ProductVariationModel#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImage", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "The method returns the first image appropriate for the current selected variation values\nwith the specific index.\n\nIf images are defined for this view type and variants, but not for\nspecified index, the method returns null.\n\nIf no images are defined for all variants and specified view type, the\nimage at the specified index of the master product images is returned. If\nno master product image for specified index is defined, the method\nreturns null.\n\nThe view type parameter is required, otherwise a exception is thrown.", + "heading": "Description" + } + ], + "signature": "getImage(viewtype: string): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "productvariationmodel.getimage" + ], + "title": "ProductVariationModel.getImage" + }, + { + "description": "The method returns the image appropriate for the currently selected attribute values.", + "id": "script-api:dw/catalog/ProductVariationModel#getImages", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getImages", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "The method returns the image appropriate for the currently selected attribute values.\n\nThe method first considers the most specific combination of attribute values (e.g\n\"Red leather\") and if that is not found, more general (e.g \"Red\"). If no image group\nis found for the attributes, returns null\n\nThe view type parameter is required, otherwise a exception is thrown.", + "heading": "Description" + } + ], + "signature": "getImages(viewtype: string): List", + "source": "script-api", + "tags": [ + "getimages", + "productvariationmodel.getimages" + ], + "title": "ProductVariationModel.getImages" + }, + { + "description": "Returns the master of the product variation.", + "id": "script-api:dw/catalog/ProductVariationModel#getMaster", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getMaster", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the master of the product variation.", + "heading": "Description" + } + ], + "signature": "getMaster(): Product", + "source": "script-api", + "tags": [ + "getmaster", + "productvariationmodel.getmaster" + ], + "title": "ProductVariationModel.getMaster" + }, + { + "description": "Returns the product variation attribute for the specific id, or null if there is no product variation attribute for that id.", + "id": "script-api:dw/catalog/ProductVariationModel#getProductVariationAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getProductVariationAttribute", + "returns": { + "type": "ProductVariationAttribute | null" + }, + "sections": [ + { + "body": "Returns the product variation attribute for the specific id,\nor null if there is no product variation attribute for that id.", + "heading": "Description" + } + ], + "signature": "getProductVariationAttribute(id: string): ProductVariationAttribute | null", + "source": "script-api", + "tags": [ + "getproductvariationattribute", + "productvariationmodel.getproductvariationattribute" + ], + "title": "ProductVariationModel.getProductVariationAttribute" + }, + { + "description": "Returns a collection of product variation attributes of the variation.", + "id": "script-api:dw/catalog/ProductVariationModel#getProductVariationAttributes", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getProductVariationAttributes", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of product variation attributes of the variation.", + "heading": "Description" + } + ], + "signature": "getProductVariationAttributes(): Collection", + "source": "script-api", + "tags": [ + "getproductvariationattributes", + "productvariationmodel.getproductvariationattributes" + ], + "title": "ProductVariationModel.getProductVariationAttributes" + }, + { + "deprecated": { + "message": "Use getSelectedValue to\nget the selected product variation attribute value for the\nspecified attribute." + }, + "description": "Returns the selected value for the specified attribute. If no value is selected, null is returned.", + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedValue", + "returns": { + "type": "ObjectAttributeValueDefinition | null" + }, + "sections": [ + { + "body": "Returns the selected value for the specified attribute. If no value is\nselected, null is returned.", + "heading": "Description" + } + ], + "signature": "getSelectedValue(attribute: ObjectAttributeDefinition): ObjectAttributeValueDefinition | null", + "source": "script-api", + "tags": [ + "getselectedvalue", + "productvariationmodel.getselectedvalue" + ], + "title": "ProductVariationModel.getSelectedValue" + }, + { + "description": "Returns the selected value for the specified product variation attribute. If no value is selected, null is returned.", + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedValue", + "returns": { + "type": "ProductVariationAttributeValue | null" + }, + "sections": [ + { + "body": "Returns the selected value for the specified product variation attribute. If no value is\nselected, null is returned.", + "heading": "Description" + } + ], + "signature": "getSelectedValue(attribute: ProductVariationAttribute): ProductVariationAttributeValue | null", + "source": "script-api", + "tags": [ + "getselectedvalue", + "productvariationmodel.getselectedvalue" + ], + "title": "ProductVariationModel.getSelectedValue" + }, + { + "description": "Returns the variant currently selected for this variation model. Returns null if no variant is selected.", + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedVariant", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedVariant", + "returns": { + "type": "Variant | null" + }, + "sections": [ + { + "body": "Returns the variant currently selected for this variation model.\nReturns null if no variant is selected.", + "heading": "Description" + } + ], + "signature": "getSelectedVariant(): Variant | null", + "source": "script-api", + "tags": [ + "getselectedvariant", + "productvariationmodel.getselectedvariant" + ], + "title": "ProductVariationModel.getSelectedVariant" + }, + { + "description": "Returns the variants currently selected for this variation model. Returns an empty collection if no variant is selected.", + "id": "script-api:dw/catalog/ProductVariationModel#getSelectedVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getSelectedVariants", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the variants currently selected for this variation model.\nReturns an empty collection if no variant is selected.", + "heading": "Description" + } + ], + "signature": "getSelectedVariants(): Collection", + "source": "script-api", + "tags": [ + "getselectedvariants", + "productvariationmodel.getselectedvariants" + ], + "title": "ProductVariationModel.getSelectedVariants" + }, + { + "description": "Returns the collection of product variants of this variation model. This collection only includes online variants. Offline variants are filtered out. If all variation products are required, consider using dw.catalog.Product.getVariants.", + "id": "script-api:dw/catalog/ProductVariationModel#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariants", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of product variants of this variation model.\nThis collection only includes online variants. Offline variants are\nfiltered out. If all variation products are required, consider using\ndw.catalog.Product.getVariants.\n\nThe product variants are returned in no particular order.", + "heading": "Description" + } + ], + "signature": "getVariants(): Collection", + "source": "script-api", + "tags": [ + "getvariants", + "productvariationmodel.getvariants" + ], + "title": "ProductVariationModel.getVariants" + }, + { + "description": "Returns the variants that match the specified filter conditions. The filter conditions are specified as a hash map of - . This method does not consider the currently selected attribute values.", + "id": "script-api:dw/catalog/ProductVariationModel#getVariants", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "filter", + "type": "HashMap" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariants", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the variants that match the specified filter conditions. The\nfilter conditions are specified as a hash map of -\n. This method does not consider the currently selected\nattribute values.", + "heading": "Description" + } + ], + "signature": "getVariants(filter: HashMap): Collection", + "source": "script-api", + "tags": [ + "getvariants", + "productvariationmodel.getvariants" + ], + "title": "ProductVariationModel.getVariants" + }, + { + "description": "Returns the collection of variation groups of this variation model. This collection only includes online variation groups. Offline variation groups are filtered out. If all variation group products are required, consider using dw.catalog.Product.getVariationGroups.", + "id": "script-api:dw/catalog/ProductVariationModel#getVariationGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariationGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of variation groups of this variation model.\nThis collection only includes online variation groups. Offline variation\ngroups are filtered out. If all variation group products are required,\nconsider using dw.catalog.Product.getVariationGroups.\n\nThe variation groups are returned in no particular order.", + "heading": "Description" + } + ], + "signature": "getVariationGroups(): Collection", + "source": "script-api", + "tags": [ + "getvariationgroups", + "productvariationmodel.getvariationgroups" + ], + "title": "ProductVariationModel.getVariationGroups" + }, + { + "description": "Returns the value for the specified variant or variation group product and variation attribute. The specified product should be a dw.catalog.Variant returned by getVariants or a dw.catalog.VariationGroup returned by getVariationGroups. The variation attribute should be one returned by getProductVariationAttributes. If an invalid product or attribute is passed, null is returned. If null is passed for either argument, an exception is thrown.", + "id": "script-api:dw/catalog/ProductVariationModel#getVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "variantOrVariationGroup", + "type": "Product" + }, + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.getVariationValue", + "returns": { + "type": "ProductVariationAttributeValue | null" + }, + "sections": [ + { + "body": "Returns the value for the specified variant or variation group product and\nvariation attribute. The specified product should be a dw.catalog.Variant\nreturned by getVariants or a dw.catalog.VariationGroup returned by\ngetVariationGroups. The variation attribute should be one returned by\ngetProductVariationAttributes. If an invalid product or attribute is passed,\nnull is returned. If null is passed for either argument, an exception is thrown.", + "heading": "Description" + } + ], + "signature": "getVariationValue(variantOrVariationGroup: Product, attribute: ProductVariationAttribute): ProductVariationAttributeValue | null", + "source": "script-api", + "tags": [ + "getvariationvalue", + "productvariationmodel.getvariationvalue" + ], + "title": "ProductVariationModel.getVariationValue" + }, + { + "description": "Returns true if any variant is available with the specified value of the specified variation attribute. Available means that the variant is orderable according to the variant's availability model. This method takes currently selected attribute values into consideration. The specific rules are as follows:", + "id": "script-api:dw/catalog/ProductVariationModel#hasOrderableVariants", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + }, + { + "name": "value", + "type": "ProductVariationAttributeValue" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.hasOrderableVariants", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if any variant is available with the specified value of the\nspecified variation attribute. Available means that the variant is\norderable according to the variant's availability model. This method\ntakes currently selected attribute values into consideration. The\nspecific rules are as follows:\n\n- If no variation value is currently selected, the method returns true\nif any variant with the specified value is available, else false.\n- if one or more variation values are selected, the method returns true\nif any variant with a combination of the specified value and the selected\nvalue is available, else false.\n- if all variation values are selected, the method returns true of the\nvariant that is represented by the current selection is available, else\nfalse.", + "heading": "Description" + } + ], + "signature": "hasOrderableVariants(attribute: ProductVariationAttribute, value: ProductVariationAttributeValue): boolean", + "source": "script-api", + "tags": [ + "hasorderablevariants", + "productvariationmodel.hasorderablevariants" + ], + "title": "ProductVariationModel.hasOrderableVariants" + }, + { + "deprecated": { + "message": "Use\nisSelectedAttributeValue\nto identify if the specified product variation attribute\nvalue is the one currently selected." + }, + "description": "Identifies if the specified variation value is the one currently selected.", + "id": "script-api:dw/catalog/ProductVariationModel#isSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + }, + { + "name": "value", + "type": "ObjectAttributeValueDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.isSelectedAttributeValue", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the specified variation value is the one currently\nselected.", + "heading": "Description" + } + ], + "signature": "isSelectedAttributeValue(attribute: ObjectAttributeDefinition, value: ObjectAttributeValueDefinition): boolean", + "source": "script-api", + "tags": [ + "isselectedattributevalue", + "productvariationmodel.isselectedattributevalue" + ], + "title": "ProductVariationModel.isSelectedAttributeValue" + }, + { + "description": "Identifies if the specified product variation attribute value is the one currently selected.", + "id": "script-api:dw/catalog/ProductVariationModel#isSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attribute", + "type": "ProductVariationAttribute" + }, + { + "name": "value", + "type": "ProductVariationAttributeValue" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.isSelectedAttributeValue", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the specified product variation attribute value is the one\ncurrently selected.", + "heading": "Description" + } + ], + "signature": "isSelectedAttributeValue(attribute: ProductVariationAttribute, value: ProductVariationAttributeValue): boolean", + "source": "script-api", + "tags": [ + "isselectedattributevalue", + "productvariationmodel.isselectedattributevalue" + ], + "title": "ProductVariationModel.isSelectedAttributeValue" + }, + { + "description": "Returns the master of the product variation.", + "id": "script-api:dw/catalog/ProductVariationModel#master", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.master", + "sections": [ + { + "body": "Returns the master of the product variation.", + "heading": "Description" + } + ], + "signature": "readonly master: Product", + "source": "script-api", + "tags": [ + "master", + "productvariationmodel.master" + ], + "title": "ProductVariationModel.master" + }, + { + "description": "Returns a collection of product variation attributes of the variation.", + "id": "script-api:dw/catalog/ProductVariationModel#productVariationAttributes", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.productVariationAttributes", + "sections": [ + { + "body": "Returns a collection of product variation attributes of the variation.", + "heading": "Description" + } + ], + "signature": "readonly productVariationAttributes: Collection", + "source": "script-api", + "tags": [ + "productvariationattributes", + "productvariationmodel.productvariationattributes" + ], + "title": "ProductVariationModel.productVariationAttributes" + }, + { + "description": "Returns the variant currently selected for this variation model. Returns null if no variant is selected.", + "id": "script-api:dw/catalog/ProductVariationModel#selectedVariant", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.selectedVariant", + "sections": [ + { + "body": "Returns the variant currently selected for this variation model.\nReturns null if no variant is selected.", + "heading": "Description" + } + ], + "signature": "readonly selectedVariant: Variant | null", + "source": "script-api", + "tags": [ + "selectedvariant", + "productvariationmodel.selectedvariant" + ], + "title": "ProductVariationModel.selectedVariant" + }, + { + "description": "Returns the variants currently selected for this variation model. Returns an empty collection if no variant is selected.", + "id": "script-api:dw/catalog/ProductVariationModel#selectedVariants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.selectedVariants", + "sections": [ + { + "body": "Returns the variants currently selected for this variation model.\nReturns an empty collection if no variant is selected.", + "heading": "Description" + } + ], + "signature": "readonly selectedVariants: Collection", + "source": "script-api", + "tags": [ + "selectedvariants", + "productvariationmodel.selectedvariants" + ], + "title": "ProductVariationModel.selectedVariants" + }, + { + "description": "Applies a selected attribute value to this model instance. Usually this method is used to set the model state corresponding to the variation attribute values specified by a URL. The URLs can be obtained by using one of the models URL methods, like urlSelectVariationValue and urlUnselectVariationValue.", + "id": "script-api:dw/catalog/ProductVariationModel#setSelectedAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "variationAttributeID", + "type": "string" + }, + { + "name": "variationAttributeValueID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.setSelectedAttributeValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies a selected attribute value to this model instance.\nUsually this method is used to set the model state corresponding to the variation attribute values\nspecified by a URL. The URLs can be obtained by using one of the models URL methods, like\nurlSelectVariationValue and\nurlUnselectVariationValue.\n\nAnyway, there are some limitations to keep in mind when selecting variation attribute values.\nA Variation Model created for a Variation Group or Variant Product is bound to an initial state.\nExample:\n\n- A Variation Model created for Variation Group A can't be switched to Variation Group B.\n- A Variation Model created for Variant A can't be switched to Variant B.\n- The state of a Variation Model for a Variation Group that defines color = red can't be changed to color = black.\n- The state of a Variation Model for a Variant that defines color = red / size = L can't be changed to color = black / size = S.\nHowever, the state of a Variation Model created for a Variation Group that defines color = red\ncan be changed to a more specific state by adding another selected value, e.g. size = L.\n\nThe state of a Variation Model created for a Variation Master can be changed in any possible way\nbecause the initial state involves all variation values and Variants.", + "heading": "Description" + } + ], + "signature": "setSelectedAttributeValue(variationAttributeID: string, variationAttributeValueID: string): void", + "source": "script-api", + "tags": [ + "setselectedattributevalue", + "productvariationmodel.setselectedattributevalue" + ], + "title": "ProductVariationModel.setSelectedAttributeValue" + }, + { + "description": "Constructs a URL to select a set of variation attribute values. The optional `varAttrAndValues` argument can be empty, or can contain one or more variation attribute / value pairs. This variable list should be even in length, with attributes and values alternating. Attributes can be specified as instances of ProductVariationAttribute, or String variation attribute ID. (Note: ObjectAttributeDefinition IDs are not supported.) Values can be specified as instances of ProductVariationAttributeValue or String or Integer depending on the data type of the variation attribute. If a parameter type is invalid, or does not reference a valid ProductVariationAttribute or ProductVariationAttributeValue, then the parameter pair is not included in the generated URL. The returned URL will contain variation attributes and values already selected in the product variation model, as well as attributes and values specified as method parameters.", + "id": "script-api:dw/catalog/ProductVariationModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "varAttrAndValues", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.url", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs a URL to select a set of variation attribute values. The\noptional `varAttrAndValues` argument can be empty, or can\ncontain one or more variation attribute / value pairs. This variable list\nshould be even in length, with attributes and values alternating.\nAttributes can be specified as instances of ProductVariationAttribute, or\nString variation attribute ID. (Note: ObjectAttributeDefinition IDs are\nnot supported.) Values can be specified as instances of\nProductVariationAttributeValue or String or Integer depending on the data\ntype of the variation attribute. If a parameter type is invalid, or does\nnot reference a valid ProductVariationAttribute or\nProductVariationAttributeValue, then the parameter pair is not included\nin the generated URL. The returned URL will contain variation attributes\nand values already selected in the product variation model, as well as\nattributes and values specified as method parameters.\n\nSample usage:", + "heading": "Description" + } + ], + "signature": "url(action: string, varAttrAndValues?: any[]): URL", + "source": "script-api", + "tags": [ + "url", + "productvariationmodel.url" + ], + "title": "ProductVariationModel.url" + }, + { + "deprecated": { + "message": "Use\nurlSelectVariationValue\nto construct an URL to select the specified product variation\nattribute value of the specified product variation attribute." + }, + "description": "Constructs an URL to select the specified value of the specified variation attribute.", + "id": "script-api:dw/catalog/ProductVariationModel#urlSelectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + }, + { + "name": "value", + "type": "ObjectAttributeValueDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlSelectVariationValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Constructs an URL to select the specified value of the specified\nvariation attribute.\n\nThe generated URL will be an absolute URL which uses the protocol of the\ncurrent request.", + "heading": "Description" + } + ], + "signature": "urlSelectVariationValue(action: string, attribute: ObjectAttributeDefinition, value: ObjectAttributeValueDefinition): string", + "source": "script-api", + "tags": [ + "urlselectvariationvalue", + "productvariationmodel.urlselectvariationvalue" + ], + "title": "ProductVariationModel.urlSelectVariationValue" + }, + { + "description": "Generates a URL for selecting a value for a given variation attribute. This URL is intended to be used on dynamic product detail pages. When a customer selects which value he wants for one of the variation attributes, the product detail page can issue a request to the passed URL which in turn can invoke the `UpdateProductVariationSelections` pipelet. That pipelet reads the querystring parameters and returns an updated variation model with the desired attribute value selected.", + "id": "script-api:dw/catalog/ProductVariationModel#urlSelectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attribute", + "type": "ProductVariationAttribute" + }, + { + "name": "value", + "type": "ProductVariationAttributeValue" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlSelectVariationValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Generates a URL for selecting a value for a given variation attribute.\nThis URL is intended to be used on dynamic product detail pages. When a\ncustomer selects which value he wants for one of the variation\nattributes, the product detail page can issue a request to the passed URL\nwhich in turn can invoke the\n`UpdateProductVariationSelections` pipelet. That pipelet reads\nthe querystring parameters and returns an updated variation model with\nthe desired attribute value selected.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlSelectVariationValue(action: string, attribute: ProductVariationAttribute, value: ProductVariationAttributeValue): string", + "source": "script-api", + "tags": [ + "urlselectvariationvalue", + "productvariationmodel.urlselectvariationvalue" + ], + "title": "ProductVariationModel.urlSelectVariationValue" + }, + { + "deprecated": { + "message": "Use\nurlUnselectVariationValue\nto unselect the product variation attribute value of the\nspecified product variation attribute." + }, + "description": "Constructs an URL to unselect the value of the specified variation attribute.", + "id": "script-api:dw/catalog/ProductVariationModel#urlUnselectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attribute", + "type": "ObjectAttributeDefinition" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlUnselectVariationValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Constructs an URL to unselect the value of the specified variation\nattribute.\n\nThe generated URL will be an absolute URL which uses the protocol of the\ncurrent request.", + "heading": "Description" + } + ], + "signature": "urlUnselectVariationValue(action: string, attribute: ObjectAttributeDefinition): string", + "source": "script-api", + "tags": [ + "urlunselectvariationvalue", + "productvariationmodel.urlunselectvariationvalue" + ], + "title": "ProductVariationModel.urlUnselectVariationValue" + }, + { + "description": "Generates a URL for unselecting a value for a given variation attribute. This URL is intended to be used on dynamic product detail pages. When a customer deselects a value for one of the variation attributes, the product detail page can issue a request to the passed URL which in turn can invoke the `UpdateProductVariationSelections` pipelet. That pipelet reads the querystring parameters and returns an updated variation model with the desired attribute value unselected.", + "id": "script-api:dw/catalog/ProductVariationModel#urlUnselectVariationValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attribute", + "type": "ProductVariationAttribute" + } + ], + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.urlUnselectVariationValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Generates a URL for unselecting a value for a given variation attribute.\nThis URL is intended to be used on dynamic product detail pages. When a\ncustomer deselects a value for one of the variation attributes, the\nproduct detail page can issue a request to the passed URL which in turn\ncan invoke the `UpdateProductVariationSelections` pipelet.\nThat pipelet reads the querystring parameters and returns an updated\nvariation model with the desired attribute value unselected.\n\nThe generated URL will be an absolute URL which uses the protocol of\nthe current request.", + "heading": "Description" + } + ], + "signature": "urlUnselectVariationValue(action: string, attribute: ProductVariationAttribute): string", + "source": "script-api", + "tags": [ + "urlunselectvariationvalue", + "productvariationmodel.urlunselectvariationvalue" + ], + "title": "ProductVariationModel.urlUnselectVariationValue" + }, + { + "description": "Returns the collection of product variants of this variation model. This collection only includes online variants. Offline variants are filtered out. If all variation products are required, consider using dw.catalog.Product.getVariants.", + "id": "script-api:dw/catalog/ProductVariationModel#variants", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.variants", + "sections": [ + { + "body": "Returns the collection of product variants of this variation model.\nThis collection only includes online variants. Offline variants are\nfiltered out. If all variation products are required, consider using\ndw.catalog.Product.getVariants.\n\nThe product variants are returned in no particular order.", + "heading": "Description" + } + ], + "signature": "readonly variants: Collection", + "source": "script-api", + "tags": [ + "variants", + "productvariationmodel.variants" + ], + "title": "ProductVariationModel.variants" + }, + { + "description": "Returns the collection of variation groups of this variation model. This collection only includes online variation groups. Offline variation groups are filtered out. If all variation group products are required, consider using dw.catalog.Product.getVariationGroups.", + "id": "script-api:dw/catalog/ProductVariationModel#variationGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/ProductVariationModel", + "qualifiedName": "dw.catalog.ProductVariationModel.variationGroups", + "sections": [ + { + "body": "Returns the collection of variation groups of this variation model.\nThis collection only includes online variation groups. Offline variation\ngroups are filtered out. If all variation group products are required,\nconsider using dw.catalog.Product.getVariationGroups.\n\nThe variation groups are returned in no particular order.", + "heading": "Description" + } + ], + "signature": "readonly variationGroups: Collection", + "source": "script-api", + "tags": [ + "variationgroups", + "productvariationmodel.variationgroups" + ], + "title": "ProductVariationModel.variationGroups" + }, + { + "description": "Represents a recommendation in Commerce Cloud Digital.", + "id": "script-api:dw/catalog/Recommendation", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Recommendation", + "sections": [ + { + "body": "Represents a recommendation in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "recommendation", + "dw.catalog.recommendation", + "dw/catalog" + ], + "title": "Recommendation" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents a cross-sell recommendation.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell recommendation.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_CROSS_SELL = 1", + "source": "script-api", + "tags": [ + "recommendation_type_cross_sell", + "recommendation.recommendation_type_cross_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_CROSS_SELL" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents a cross-sell recommendation.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_CROSS_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_CROSS_SELL", + "sections": [ + { + "body": "Represents a cross-sell recommendation.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_CROSS_SELL = 1", + "source": "script-api", + "tags": [ + "recommendation_type_cross_sell", + "recommendation.recommendation_type_cross_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_CROSS_SELL" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents a recommendation that is neither a cross-sell or an up-sell.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_OTHER", + "sections": [ + { + "body": "Represents a recommendation that is neither a cross-sell or an up-sell.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_OTHER = 3", + "source": "script-api", + "tags": [ + "recommendation_type_other", + "recommendation.recommendation_type_other" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_OTHER" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents a recommendation that is neither a cross-sell or an up-sell.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_OTHER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_OTHER", + "sections": [ + { + "body": "Represents a recommendation that is neither a cross-sell or an up-sell.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_OTHER = 3", + "source": "script-api", + "tags": [ + "recommendation_type_other", + "recommendation.recommendation_type_other" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_OTHER" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents an up-sell recommendation.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell recommendation.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_UP_SELL = 2", + "source": "script-api", + "tags": [ + "recommendation_type_up_sell", + "recommendation.recommendation_type_up_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_UP_SELL" + }, + { + "deprecated": { + "message": "Use the integer value instead. The recommendation types\nand their meanings are now configurable in the Business Manager." + }, + "description": "Represents an up-sell recommendation.", + "id": "script-api:dw/catalog/Recommendation#RECOMMENDATION_TYPE_UP_SELL", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.RECOMMENDATION_TYPE_UP_SELL", + "sections": [ + { + "body": "Represents an up-sell recommendation.", + "heading": "Description" + } + ], + "signature": "static readonly RECOMMENDATION_TYPE_UP_SELL = 2", + "source": "script-api", + "tags": [ + "recommendation_type_up_sell", + "recommendation.recommendation_type_up_sell" + ], + "title": "Recommendation.RECOMMENDATION_TYPE_UP_SELL" + }, + { + "description": "Returns the recommendation's callout message in the current locale.", + "id": "script-api:dw/catalog/Recommendation#calloutMsg", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.calloutMsg", + "sections": [ + { + "body": "Returns the recommendation's callout message in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly calloutMsg: MarkupText | null", + "source": "script-api", + "tags": [ + "calloutmsg", + "recommendation.calloutmsg" + ], + "title": "Recommendation.calloutMsg" + }, + { + "description": "Return the catalog containing the recommendation.", + "id": "script-api:dw/catalog/Recommendation#catalog", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.catalog", + "sections": [ + { + "body": "Return the catalog containing the recommendation.", + "heading": "Description" + } + ], + "signature": "readonly catalog: Catalog", + "source": "script-api", + "tags": [ + "catalog", + "recommendation.catalog" + ], + "title": "Recommendation.catalog" + }, + { + "description": "Returns the recommendation's callout message in the current locale.", + "id": "script-api:dw/catalog/Recommendation#getCalloutMsg", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getCalloutMsg", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the recommendation's callout message in the current locale.", + "heading": "Description" + } + ], + "signature": "getCalloutMsg(): MarkupText | null", + "source": "script-api", + "tags": [ + "getcalloutmsg", + "recommendation.getcalloutmsg" + ], + "title": "Recommendation.getCalloutMsg" + }, + { + "description": "Return the catalog containing the recommendation.", + "id": "script-api:dw/catalog/Recommendation#getCatalog", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getCatalog", + "returns": { + "type": "Catalog" + }, + "sections": [ + { + "body": "Return the catalog containing the recommendation.", + "heading": "Description" + } + ], + "signature": "getCatalog(): Catalog", + "source": "script-api", + "tags": [ + "getcatalog", + "recommendation.getcatalog" + ], + "title": "Recommendation.getCatalog" + }, + { + "description": "Returns the recommendation's image.", + "id": "script-api:dw/catalog/Recommendation#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the recommendation's image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "recommendation.getimage" + ], + "title": "Recommendation.getImage" + }, + { + "description": "Returns the recommendation's long description in the current locale.", + "id": "script-api:dw/catalog/Recommendation#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getLongDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the recommendation's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "getLongDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getlongdescription", + "recommendation.getlongdescription" + ], + "title": "Recommendation.getLongDescription" + }, + { + "description": "Returns the name of the recommended item in the current locale.", + "id": "script-api:dw/catalog/Recommendation#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the name of the recommended item in the current locale.", + "heading": "Description" + } + ], + "signature": "getName(): string | null", + "source": "script-api", + "tags": [ + "getname", + "recommendation.getname" + ], + "title": "Recommendation.getName" + }, + { + "description": "Returns the type of the recommendation.", + "id": "script-api:dw/catalog/Recommendation#getRecommendationType", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendationType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of the recommendation.", + "heading": "Description" + } + ], + "signature": "getRecommendationType(): number", + "source": "script-api", + "tags": [ + "getrecommendationtype", + "recommendation.getrecommendationtype" + ], + "title": "Recommendation.getRecommendationType" + }, + { + "description": "Return a reference to the recommended item. This will always be an object of type `dw.catalog.Product` since this is the only currently supported recommendation target type.", + "id": "script-api:dw/catalog/Recommendation#getRecommendedItem", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendedItem", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Return a reference to the recommended item. This will always be an\nobject of type `dw.catalog.Product` since this is the only\ncurrently supported recommendation target type.", + "heading": "Description" + } + ], + "signature": "getRecommendedItem(): any | null", + "source": "script-api", + "tags": [ + "getrecommendeditem", + "recommendation.getrecommendeditem" + ], + "title": "Recommendation.getRecommendedItem" + }, + { + "description": "Return the ID of the recommended item. This will always be a product ID since this is the only currently supported recommendation target type.", + "id": "script-api:dw/catalog/Recommendation#getRecommendedItemID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getRecommendedItemID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the ID of the recommended item. This will always be a product\nID since this is the only currently supported recommendation target\ntype.", + "heading": "Description" + } + ], + "signature": "getRecommendedItemID(): string", + "source": "script-api", + "tags": [ + "getrecommendeditemid", + "recommendation.getrecommendeditemid" + ], + "title": "Recommendation.getRecommendedItemID" + }, + { + "description": "Returns the recommendation's short description in the current locale.", + "id": "script-api:dw/catalog/Recommendation#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getShortDescription", + "returns": { + "type": "MarkupText | null" + }, + "sections": [ + { + "body": "Returns the recommendation's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "getShortDescription(): MarkupText | null", + "source": "script-api", + "tags": [ + "getshortdescription", + "recommendation.getshortdescription" + ], + "title": "Recommendation.getShortDescription" + }, + { + "description": "Return a reference to the source item. This will be an object of type `dw.catalog.Product` or `dw.catalog.Category.`", + "id": "script-api:dw/catalog/Recommendation#getSourceItem", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getSourceItem", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Return a reference to the source item. This will be an object of type\n`dw.catalog.Product` or `dw.catalog.Category.`", + "heading": "Description" + } + ], + "signature": "getSourceItem(): any", + "source": "script-api", + "tags": [ + "getsourceitem", + "recommendation.getsourceitem" + ], + "title": "Recommendation.getSourceItem" + }, + { + "description": "Return the ID of the recommendation source item. This will either be a product ID or category name.", + "id": "script-api:dw/catalog/Recommendation#getSourceItemID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.getSourceItemID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the ID of the recommendation source item. This will either be a\nproduct ID or category name.", + "heading": "Description" + } + ], + "signature": "getSourceItemID(): string", + "source": "script-api", + "tags": [ + "getsourceitemid", + "recommendation.getsourceitemid" + ], + "title": "Recommendation.getSourceItemID" + }, + { + "description": "Returns the recommendation's image.", + "id": "script-api:dw/catalog/Recommendation#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.image", + "sections": [ + { + "body": "Returns the recommendation's image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "recommendation.image" + ], + "title": "Recommendation.image" + }, + { + "description": "Returns the recommendation's long description in the current locale.", + "id": "script-api:dw/catalog/Recommendation#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.longDescription", + "sections": [ + { + "body": "Returns the recommendation's long description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly longDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "longdescription", + "recommendation.longdescription" + ], + "title": "Recommendation.longDescription" + }, + { + "description": "Returns the name of the recommended item in the current locale.", + "id": "script-api:dw/catalog/Recommendation#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.name", + "sections": [ + { + "body": "Returns the name of the recommended item in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly name: string | null", + "source": "script-api", + "tags": [ + "name", + "recommendation.name" + ], + "title": "Recommendation.name" + }, + { + "description": "Returns the type of the recommendation.", + "id": "script-api:dw/catalog/Recommendation#recommendationType", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendationType", + "sections": [ + { + "body": "Returns the type of the recommendation.", + "heading": "Description" + } + ], + "signature": "readonly recommendationType: number", + "source": "script-api", + "tags": [ + "recommendationtype", + "recommendation.recommendationtype" + ], + "title": "Recommendation.recommendationType" + }, + { + "description": "Return a reference to the recommended item. This will always be an object of type `dw.catalog.Product` since this is the only currently supported recommendation target type.", + "id": "script-api:dw/catalog/Recommendation#recommendedItem", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendedItem", + "sections": [ + { + "body": "Return a reference to the recommended item. This will always be an\nobject of type `dw.catalog.Product` since this is the only\ncurrently supported recommendation target type.", + "heading": "Description" + } + ], + "signature": "readonly recommendedItem: any | null", + "source": "script-api", + "tags": [ + "recommendeditem", + "recommendation.recommendeditem" + ], + "title": "Recommendation.recommendedItem" + }, + { + "description": "Return the ID of the recommended item. This will always be a product ID since this is the only currently supported recommendation target type.", + "id": "script-api:dw/catalog/Recommendation#recommendedItemID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.recommendedItemID", + "sections": [ + { + "body": "Return the ID of the recommended item. This will always be a product\nID since this is the only currently supported recommendation target\ntype.", + "heading": "Description" + } + ], + "signature": "readonly recommendedItemID: string", + "source": "script-api", + "tags": [ + "recommendeditemid", + "recommendation.recommendeditemid" + ], + "title": "Recommendation.recommendedItemID" + }, + { + "description": "Returns the recommendation's short description in the current locale.", + "id": "script-api:dw/catalog/Recommendation#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.shortDescription", + "sections": [ + { + "body": "Returns the recommendation's short description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly shortDescription: MarkupText | null", + "source": "script-api", + "tags": [ + "shortdescription", + "recommendation.shortdescription" + ], + "title": "Recommendation.shortDescription" + }, + { + "description": "Return a reference to the source item. This will be an object of type `dw.catalog.Product` or `dw.catalog.Category.`", + "id": "script-api:dw/catalog/Recommendation#sourceItem", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.sourceItem", + "sections": [ + { + "body": "Return a reference to the source item. This will be an object of type\n`dw.catalog.Product` or `dw.catalog.Category.`", + "heading": "Description" + } + ], + "signature": "readonly sourceItem: any", + "source": "script-api", + "tags": [ + "sourceitem", + "recommendation.sourceitem" + ], + "title": "Recommendation.sourceItem" + }, + { + "description": "Return the ID of the recommendation source item. This will either be a product ID or category name.", + "id": "script-api:dw/catalog/Recommendation#sourceItemID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Recommendation", + "qualifiedName": "dw.catalog.Recommendation.sourceItemID", + "sections": [ + { + "body": "Return the ID of the recommendation source item. This will either be a\nproduct ID or category name.", + "heading": "Description" + } + ], + "signature": "readonly sourceItemID: string", + "source": "script-api", + "tags": [ + "sourceitemid", + "recommendation.sourceitemid" + ], + "title": "Recommendation.sourceItemID" + }, + { + "description": "Common search model base class.", + "id": "script-api:dw/catalog/SearchModel", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchModel", + "sections": [ + { + "body": "Common search model base class.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "searchmodel", + "dw.catalog.searchmodel", + "dw/catalog" + ], + "title": "SearchModel" + }, + { + "description": "URL Parameter for the Search Phrase", + "id": "script-api:dw/catalog/SearchModel#SEARCH_PHRASE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SEARCH_PHRASE_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the Search Phrase", + "heading": "Description" + } + ], + "signature": "static readonly SEARCH_PHRASE_PARAMETER = \"q\"", + "source": "script-api", + "tags": [ + "search_phrase_parameter", + "searchmodel.search_phrase_parameter" + ], + "title": "SearchModel.SEARCH_PHRASE_PARAMETER" + }, + { + "description": "URL Parameter for the Search Phrase", + "id": "script-api:dw/catalog/SearchModel#SEARCH_PHRASE_PARAMETER", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SEARCH_PHRASE_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the Search Phrase", + "heading": "Description" + } + ], + "signature": "static readonly SEARCH_PHRASE_PARAMETER = \"q\"", + "source": "script-api", + "tags": [ + "search_phrase_parameter", + "searchmodel.search_phrase_parameter" + ], + "title": "SearchModel.SEARCH_PHRASE_PARAMETER" + }, + { + "description": "Sorting parameter ASCENDING", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_ASCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_ASCENDING", + "sections": [ + { + "body": "Sorting parameter ASCENDING", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_ASCENDING = 1", + "source": "script-api", + "tags": [ + "sort_direction_ascending", + "searchmodel.sort_direction_ascending" + ], + "title": "SearchModel.SORT_DIRECTION_ASCENDING" + }, + { + "description": "Sorting parameter ASCENDING", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_ASCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_ASCENDING", + "sections": [ + { + "body": "Sorting parameter ASCENDING", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_ASCENDING = 1", + "source": "script-api", + "tags": [ + "sort_direction_ascending", + "searchmodel.sort_direction_ascending" + ], + "title": "SearchModel.SORT_DIRECTION_ASCENDING" + }, + { + "description": "Sorting parameter DESCENDING", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_DESCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_DESCENDING", + "sections": [ + { + "body": "Sorting parameter DESCENDING", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_DESCENDING = 2", + "source": "script-api", + "tags": [ + "sort_direction_descending", + "searchmodel.sort_direction_descending" + ], + "title": "SearchModel.SORT_DIRECTION_DESCENDING" + }, + { + "description": "Sorting parameter DESCENDING", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_DESCENDING", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_DESCENDING", + "sections": [ + { + "body": "Sorting parameter DESCENDING", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_DESCENDING = 2", + "source": "script-api", + "tags": [ + "sort_direction_descending", + "searchmodel.sort_direction_descending" + ], + "title": "SearchModel.SORT_DIRECTION_DESCENDING" + }, + { + "description": "Sorting parameter NO_SORT - will remove a sorting condition", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_NONE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_NONE", + "sections": [ + { + "body": "Sorting parameter NO_SORT - will remove a sorting condition", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_NONE = 0", + "source": "script-api", + "tags": [ + "sort_direction_none", + "searchmodel.sort_direction_none" + ], + "title": "SearchModel.SORT_DIRECTION_NONE" + }, + { + "description": "Sorting parameter NO_SORT - will remove a sorting condition", + "id": "script-api:dw/catalog/SearchModel#SORT_DIRECTION_NONE", + "kind": "constant", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.SORT_DIRECTION_NONE", + "sections": [ + { + "body": "Sorting parameter NO_SORT - will remove a sorting condition", + "heading": "Description" + } + ], + "signature": "static readonly SORT_DIRECTION_NONE = 0", + "source": "script-api", + "tags": [ + "sort_direction_none", + "searchmodel.sort_direction_none" + ], + "title": "SearchModel.SORT_DIRECTION_NONE" + }, + { + "description": "Adds a refinement. The method can be called to add an additional query parameter specified as name-value pair. The values string may encode multiple values delimited by the pipe symbol ('|').", + "id": "script-api:dw/catalog/SearchModel#addRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.addRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a refinement. The method can be called to add an additional query\nparameter specified as name-value pair. The values string may encode\nmultiple values delimited by the pipe symbol ('|').", + "heading": "Description" + } + ], + "signature": "addRefinementValues(attributeID: string, values: string): void", + "source": "script-api", + "tags": [ + "addrefinementvalues", + "searchmodel.addrefinementvalues" + ], + "title": "SearchModel.addRefinementValues" + }, + { + "description": "Identifies if the search can be relaxed without creating a search for all searchable items.", + "id": "script-api:dw/catalog/SearchModel#canRelax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.canRelax", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the search can be relaxed without creating a search for all\nsearchable items.", + "heading": "Description" + } + ], + "signature": "canRelax(): boolean", + "source": "script-api", + "tags": [ + "canrelax", + "searchmodel.canrelax" + ], + "title": "SearchModel.canRelax" + }, + { + "description": "Returns the number of search results found by this search.", + "id": "script-api:dw/catalog/SearchModel#count", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.count", + "sections": [ + { + "body": "Returns the number of search results found by this search.", + "heading": "Description" + } + ], + "signature": "readonly count: number", + "source": "script-api", + "tags": [ + "count", + "searchmodel.count" + ], + "title": "SearchModel.count" + }, + { + "description": "Identifies if the query is emtpy when no search term, search parameter or refinement was specified for the search. In case also no result is returned. This \"empty\" is different to a query with a specified query and with an empty result.", + "id": "script-api:dw/catalog/SearchModel#emptyQuery", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.emptyQuery", + "sections": [ + { + "body": "Identifies if the query is emtpy when no search term, search parameter or\nrefinement was specified for the search. In case also no result is\nreturned. This \"empty\" is different to a query with a specified query and\nwith an empty result.", + "heading": "Description" + } + ], + "signature": "readonly emptyQuery: boolean", + "source": "script-api", + "tags": [ + "emptyquery", + "searchmodel.emptyquery" + ], + "title": "SearchModel.emptyQuery" + }, + { + "description": "Returns the number of search results found by this search.", + "id": "script-api:dw/catalog/SearchModel#getCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of search results found by this search.", + "heading": "Description" + } + ], + "signature": "getCount(): number", + "source": "script-api", + "tags": [ + "getcount", + "searchmodel.getcount" + ], + "title": "SearchModel.getCount" + }, + { + "description": "Returns the maximum refinement value selected in the query for the specific attribute, or null if there is no maximum refinement value or no refinement for that attribute.", + "id": "script-api:dw/catalog/SearchModel#getRefinementMaxValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementMaxValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the maximum refinement value selected in the query for the specific\nattribute, or null if there is no maximum refinement value or no refinement for that attribute.", + "heading": "Description" + } + ], + "signature": "getRefinementMaxValue(attributeID: string): string | null", + "source": "script-api", + "tags": [ + "getrefinementmaxvalue", + "searchmodel.getrefinementmaxvalue" + ], + "title": "SearchModel.getRefinementMaxValue" + }, + { + "description": "Returns the minimum refinement value selected in the query for the specific attribute, or null if there is no minimum refinement value or no refinement for that attribute.", + "id": "script-api:dw/catalog/SearchModel#getRefinementMinValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementMinValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the minimum refinement value selected in the query for the specific\nattribute, or null if there is no minimum refinement value or no refinement for that attribute.", + "heading": "Description" + } + ], + "signature": "getRefinementMinValue(attributeID: string): string | null", + "source": "script-api", + "tags": [ + "getrefinementminvalue", + "searchmodel.getrefinementminvalue" + ], + "title": "SearchModel.getRefinementMinValue" + }, + { + "deprecated": { + "message": "Use getRefinementValues to get the\ncollection of refinement values." + }, + "description": "Returns the refinement value selected in the query for the specific attribute, or null if there is no refinement for that attribute.", + "id": "script-api:dw/catalog/SearchModel#getRefinementValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the refinement value selected in the query for the specific\nattribute, or null if there is no refinement for that attribute.", + "heading": "Description" + } + ], + "signature": "getRefinementValue(attributeID: string): string | null", + "source": "script-api", + "tags": [ + "getrefinementvalue", + "searchmodel.getrefinementvalue" + ], + "title": "SearchModel.getRefinementValue" + }, + { + "description": "Returns the list of selected refinement values for the given attribute as used in the search.", + "id": "script-api:dw/catalog/SearchModel#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the list of selected refinement values for the given attribute as\nused in the search.", + "heading": "Description" + } + ], + "signature": "getRefinementValues(attributeID: string): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "searchmodel.getrefinementvalues" + ], + "title": "SearchModel.getRefinementValues" + }, + { + "description": "Returns the search phrase used in this search.", + "id": "script-api:dw/catalog/SearchModel#getSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchPhrase", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the search phrase used in this search.", + "heading": "Description" + } + ], + "signature": "getSearchPhrase(): string", + "source": "script-api", + "tags": [ + "getsearchphrase", + "searchmodel.getsearchphrase" + ], + "title": "SearchModel.getSearchPhrase" + }, + { + "description": "Returns an URLRedirect object for a search phrase.", + "id": "script-api:dw/catalog/SearchModel#getSearchRedirect", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "searchPhrase", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchRedirect", + "returns": { + "type": "URLRedirect" + }, + "sections": [ + { + "body": "Returns an URLRedirect object for a search phrase.", + "heading": "Description" + } + ], + "signature": "static getSearchRedirect(searchPhrase: string): URLRedirect", + "source": "script-api", + "tags": [ + "getsearchredirect", + "searchmodel.getsearchredirect" + ], + "title": "SearchModel.getSearchRedirect" + }, + { + "description": "Returns an URLRedirect object for a search phrase.", + "id": "script-api:dw/catalog/SearchModel#getSearchRedirect", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "searchPhrase", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSearchRedirect", + "returns": { + "type": "URLRedirect" + }, + "sections": [ + { + "body": "Returns an URLRedirect object for a search phrase.", + "heading": "Description" + } + ], + "signature": "static getSearchRedirect(searchPhrase: string): URLRedirect", + "source": "script-api", + "tags": [ + "getsearchredirect", + "searchmodel.getsearchredirect" + ], + "title": "SearchModel.getSearchRedirect" + }, + { + "description": "Returns the sorting condition for a given attribute name. A value of 0 indicates that no sorting condition is set.", + "id": "script-api:dw/catalog/SearchModel#getSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.getSortingCondition", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the sorting condition for a given attribute name. A value of 0\nindicates that no sorting condition is set.", + "heading": "Description" + } + ], + "signature": "getSortingCondition(attributeID: string): number", + "source": "script-api", + "tags": [ + "getsortingcondition", + "searchmodel.getsortingcondition" + ], + "title": "SearchModel.getSortingCondition" + }, + { + "description": "Identifies if the query is emtpy when no search term, search parameter or refinement was specified for the search. In case also no result is returned. This \"empty\" is different to a query with a specified query and with an empty result.", + "id": "script-api:dw/catalog/SearchModel#isEmptyQuery", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isEmptyQuery", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the query is emtpy when no search term, search parameter or\nrefinement was specified for the search. In case also no result is\nreturned. This \"empty\" is different to a query with a specified query and\nwith an empty result.", + "heading": "Description" + } + ], + "signature": "isEmptyQuery(): boolean", + "source": "script-api", + "tags": [ + "isemptyquery", + "searchmodel.isemptyquery" + ], + "title": "SearchModel.isEmptyQuery" + }, + { + "description": "Identifies if this search has been refined on the given attribute.", + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttribute", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined on the given attribute.", + "heading": "Description" + } + ], + "signature": "isRefinedByAttribute(attributeID: string): boolean", + "source": "script-api", + "tags": [ + "isrefinedbyattribute", + "searchmodel.isrefinedbyattribute" + ], + "title": "SearchModel.isRefinedByAttribute" + }, + { + "description": "The method returns true, if this search is refined by at least one attribute.", + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttribute", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if this search is refined by at least one\nattribute.", + "heading": "Description" + } + ], + "signature": "isRefinedByAttribute(): boolean", + "source": "script-api", + "tags": [ + "isrefinedbyattribute", + "searchmodel.isrefinedbyattribute" + ], + "title": "SearchModel.isRefinedByAttribute" + }, + { + "description": "Identifies if this search has been refined on the given attribute and value.", + "id": "script-api:dw/catalog/SearchModel#isRefinedByAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedByAttributeValue", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined on the given attribute and\nvalue.", + "heading": "Description" + } + ], + "signature": "isRefinedByAttributeValue(attributeID: string, value: string): boolean", + "source": "script-api", + "tags": [ + "isrefinedbyattributevalue", + "searchmodel.isrefinedbyattributevalue" + ], + "title": "SearchModel.isRefinedByAttributeValue" + }, + { + "description": "Identifies if this was a refined search. A search is a refined search if at least one refinement is part of the query.", + "id": "script-api:dw/catalog/SearchModel#isRefinedSearch", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinedSearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this was a refined search. A search is a refined search if\nat least one refinement is part of the query.", + "heading": "Description" + } + ], + "signature": "isRefinedSearch(): boolean", + "source": "script-api", + "tags": [ + "isrefinedsearch", + "searchmodel.isrefinedsearch" + ], + "title": "SearchModel.isRefinedSearch" + }, + { + "description": "Identifies if this search has been refined on the given attribute.", + "id": "script-api:dw/catalog/SearchModel#isRefinementByValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinementByValueRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined on the given attribute.", + "heading": "Description" + } + ], + "signature": "isRefinementByValueRange(attributeID: string): boolean", + "source": "script-api", + "tags": [ + "isrefinementbyvaluerange", + "searchmodel.isrefinementbyvaluerange" + ], + "title": "SearchModel.isRefinementByValueRange" + }, + { + "description": "Identifies if this search has been refined on the given attribute and range values.", + "id": "script-api:dw/catalog/SearchModel#isRefinementByValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "minValue", + "type": "string" + }, + { + "name": "maxValue", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.isRefinementByValueRange", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this search has been refined on the given attribute and range values.", + "heading": "Description" + } + ], + "signature": "isRefinementByValueRange(attributeID: string, minValue: string, maxValue: string): boolean", + "source": "script-api", + "tags": [ + "isrefinementbyvaluerange", + "searchmodel.isrefinementbyvaluerange" + ], + "title": "SearchModel.isRefinementByValueRange" + }, + { + "description": "The method returns true, if this search is refined by at least one attribute.", + "id": "script-api:dw/catalog/SearchModel#refinedByAttribute", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.refinedByAttribute", + "sections": [ + { + "body": "The method returns true, if this search is refined by at least one\nattribute.", + "heading": "Description" + } + ], + "signature": "readonly refinedByAttribute: boolean", + "source": "script-api", + "tags": [ + "refinedbyattribute", + "searchmodel.refinedbyattribute" + ], + "title": "SearchModel.refinedByAttribute" + }, + { + "description": "Identifies if this was a refined search. A search is a refined search if at least one refinement is part of the query.", + "id": "script-api:dw/catalog/SearchModel#refinedSearch", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.refinedSearch", + "sections": [ + { + "body": "Identifies if this was a refined search. A search is a refined search if\nat least one refinement is part of the query.", + "heading": "Description" + } + ], + "signature": "readonly refinedSearch: boolean", + "source": "script-api", + "tags": [ + "refinedsearch", + "searchmodel.refinedsearch" + ], + "title": "SearchModel.refinedSearch" + }, + { + "description": "Removes a refinement. The method can be called to remove previously added refinement values. The values string may encode multiple values delimited by the pipe symbol ('|').", + "id": "script-api:dw/catalog/SearchModel#removeRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string | null" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.removeRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a refinement. The method can be called to remove previously added\nrefinement values. The values string may encode multiple values delimited\nby the pipe symbol ('|').", + "heading": "Description" + } + ], + "signature": "removeRefinementValues(attributeID: string, values: string | null): void", + "source": "script-api", + "tags": [ + "removerefinementvalues", + "searchmodel.removerefinementvalues" + ], + "title": "SearchModel.removeRefinementValues" + }, + { + "description": "Execute the search.", + "id": "script-api:dw/catalog/SearchModel#search", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.search", + "returns": { + "type": "SearchStatus" + }, + "sections": [ + { + "body": "Execute the search.", + "heading": "Description" + } + ], + "signature": "search(): SearchStatus", + "source": "script-api", + "tags": [ + "search", + "searchmodel.search" + ], + "title": "SearchModel.search" + }, + { + "description": "Returns the search phrase used in this search.", + "id": "script-api:dw/catalog/SearchModel#searchPhrase", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.searchPhrase", + "sections": [ + { + "body": "Returns the search phrase used in this search.", + "heading": "Description" + } + ], + "signature": "searchPhrase: string", + "source": "script-api", + "tags": [ + "searchphrase", + "searchmodel.searchphrase" + ], + "title": "SearchModel.searchPhrase" + }, + { + "description": "Sets a refinement value range for an attribute. The method can be called to set an additional range query parameter specified as name-range-value pair. The values string can contain only a range boundary. Existing refinement values for the attribute will be removed.", + "id": "script-api:dw/catalog/SearchModel#setRefinementValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "minValue", + "type": "string | null" + }, + { + "name": "maxValue", + "type": "string | null" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setRefinementValueRange", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a refinement value range for an attribute. The method can be called to set\nan additional range query parameter specified as name-range-value pair. The values\nstring can contain only a range boundary.\nExisting refinement values for the attribute will be removed.", + "heading": "Description" + } + ], + "signature": "setRefinementValueRange(attributeID: string, minValue: string | null, maxValue: string | null): void", + "source": "script-api", + "tags": [ + "setrefinementvaluerange", + "searchmodel.setrefinementvaluerange" + ], + "title": "SearchModel.setRefinementValueRange" + }, + { + "description": "Sets refinement values for an attribute. The method can be called to set an additional query parameter specified as name-value pair. The value string may encode multiple values delimited by the pipe symbol ('|'). Existing refinement values for the attribute will be removed.", + "id": "script-api:dw/catalog/SearchModel#setRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string | null" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets refinement values for an attribute. The method can be called to set\nan additional query parameter specified as name-value pair. The value\nstring may encode multiple values delimited by the pipe symbol ('|').\nExisting refinement values for the attribute will be removed.", + "heading": "Description" + } + ], + "signature": "setRefinementValues(attributeID: string, values: string | null): void", + "source": "script-api", + "tags": [ + "setrefinementvalues", + "searchmodel.setrefinementvalues" + ], + "title": "SearchModel.setRefinementValues" + }, + { + "description": "Sets the search phrase used in this search. The search query parser uses the following operators:", + "id": "script-api:dw/catalog/SearchModel#setSearchPhrase", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "phrase", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setSearchPhrase", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the search phrase used in this search. The search query parser uses\nthe following operators:\n\n- PHRASE operator (\"\"), e.g. \"cream cheese\", \"John Lennon\"\n- NOT operator (-), e.g. -cargo (will not return results containing\n\"cargo\")\n- WILDCARD operator (*), e.g. sho* (will return results containing\n\"shoulder\", \"shoes\" and \"shoot\")", + "heading": "Description" + } + ], + "signature": "setSearchPhrase(phrase: string): void", + "source": "script-api", + "tags": [ + "setsearchphrase", + "searchmodel.setsearchphrase" + ], + "title": "SearchModel.setSearchPhrase" + }, + { + "description": "Sets or removes a sorting condition for the specified attribute. Specify either SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a sorting condition. Specify SORT_DIRECTION_NONE to remove a sorting condition from the attribute.", + "id": "script-api:dw/catalog/SearchModel#setSortingCondition", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "direction", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.setSortingCondition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets or removes a sorting condition for the specified attribute. Specify\neither SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a\nsorting condition. Specify SORT_DIRECTION_NONE to remove a sorting\ncondition from the attribute.", + "heading": "Description" + } + ], + "signature": "setSortingCondition(attributeID: string, direction: number): void", + "source": "script-api", + "tags": [ + "setsortingcondition", + "searchmodel.setsortingcondition" + ], + "title": "SearchModel.setSortingCondition" + }, + { + "description": "Constructs an URL that you can use to re-execute the exact same query. The provided parameter must be an action, e.g. 'Search-Show'.", + "id": "script-api:dw/catalog/SearchModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.url", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the exact same query.\nThe provided parameter must be an action, e.g. 'Search-Show'.", + "heading": "Description" + } + ], + "signature": "url(action: string): URL", + "source": "script-api", + "tags": [ + "url", + "searchmodel.url" + ], + "title": "SearchModel.url" + }, + { + "description": "Constructs an URL that you can use to re-execute the exact same query. The search specific parameter are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#url", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.url", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the exact same query.\nThe search specific parameter are appended to the provided URL. The URL\nis typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "url(url: URL): URL", + "source": "script-api", + "tags": [ + "url", + "searchmodel.url" + ], + "title": "SearchModel.url" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with a default sorting. The provided parameter must be an action, e.g. 'Search-Show'.", + "id": "script-api:dw/catalog/SearchModel#urlDefaultSort", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlDefaultSort", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with a default\nsorting. The provided parameter must be an action, e.g. 'Search-Show'.", + "heading": "Description" + } + ], + "signature": "urlDefaultSort(url: string): URL", + "source": "script-api", + "tags": [ + "urldefaultsort", + "searchmodel.urldefaultsort" + ], + "title": "SearchModel.urlDefaultSort" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with a default sorting. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#urlDefaultSort", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlDefaultSort", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with a default\nsorting. The search specific parameters are appended to the provided URL.\nThe URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlDefaultSort(url: URL): URL", + "source": "script-api", + "tags": [ + "urldefaultsort", + "searchmodel.urldefaultsort" + ], + "title": "SearchModel.urlDefaultSort" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with an additional refinement.", + "id": "script-api:dw/catalog/SearchModel#urlRefineAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttribute", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with an\nadditional refinement.", + "heading": "Description" + } + ], + "signature": "urlRefineAttribute(action: string, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrefineattribute", + "searchmodel.urlrefineattribute" + ], + "title": "SearchModel.urlRefineAttribute" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with an additional refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#urlRefineAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttribute", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with an\nadditional refinement. The search specific parameters are appended to the\nprovided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "urlRefineAttribute(url: URL, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrefineattribute", + "searchmodel.urlrefineattribute" + ], + "title": "SearchModel.urlRefineAttribute" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute. The provided value will be added to the set of allowed values for the refinement attribute. This basically broadens the search result.", + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValue", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with an\nadditional refinement value for a given refinement attribute. The\nprovided value will be added to the set of allowed values for the\nrefinement attribute. This basically broadens the search result.", + "heading": "Description" + } + ], + "signature": "urlRefineAttributeValue(action: string, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrefineattributevalue", + "searchmodel.urlrefineattributevalue" + ], + "title": "SearchModel.urlRefineAttributeValue" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute. The provided value will be added to the set of allowed values for the refinement attribute. This basically broadens the search result.", + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValue", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with an\nadditional refinement value for a given refinement attribute. The\nprovided value will be added to the set of allowed values for the\nrefinement attribute. This basically broadens the search result.\n\nThe search specific parameters are appended to the provided URL. The URL\nis typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRefineAttributeValue(url: URL, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrefineattributevalue", + "searchmodel.urlrefineattributevalue" + ], + "title": "SearchModel.urlRefineAttributeValue" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with an additional refinement value range for a given refinement attribute. The provided value range will be replace to the existing value range for the refinement attribute.", + "id": "script-api:dw/catalog/SearchModel#urlRefineAttributeValueRange", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "minValue", + "type": "string" + }, + { + "name": "maxValue", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRefineAttributeValueRange", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with an additional refinement value range for a given refinement attribute. The\nprovided value range will be replace to the existing value range for the refinement attribute.\n\nThe search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRefineAttributeValueRange(action: string, attributeID: string, minValue: string, maxValue: string): URL", + "source": "script-api", + "tags": [ + "urlrefineattributevaluerange", + "searchmodel.urlrefineattributevaluerange" + ], + "title": "SearchModel.urlRefineAttributeValueRange" + }, + { + "description": "Constructs an URL that you can use to re-execute the query without the specified refinement. The value for the action parameter must be a pipeline action, e.g. 'Search-Show'.", + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttribute", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query without the\nspecified refinement. The value for the action parameter must be a\npipeline action, e.g. 'Search-Show'.", + "heading": "Description" + } + ], + "signature": "urlRelaxAttribute(action: string, attributeID: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxattribute", + "searchmodel.urlrelaxattribute" + ], + "title": "SearchModel.urlRelaxAttribute" + }, + { + "description": "Constructs an URL that you can use to re-execute the query without the specified refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttribute", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttribute", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query without the\nspecified refinement. The search specific parameters are appended to the\nprovided URL. The URL is typically generated with one of the URLUtils\nmethods.", + "heading": "Description" + } + ], + "signature": "urlRelaxAttribute(url: URL, attributeID: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxattribute", + "searchmodel.urlrelaxattribute" + ], + "title": "SearchModel.urlRelaxAttribute" + }, + { + "description": "Constructs an URL that you can use to re-execute the query without the specified refinement. The value for the action parameter must be a pipeline action, e.g. 'Search-Show'.", + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttributeValue", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query without the\nspecified refinement. The value for the action parameter must be a\npipeline action, e.g. 'Search-Show'.", + "heading": "Description" + } + ], + "signature": "urlRelaxAttributeValue(action: string, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxattributevalue", + "searchmodel.urlrelaxattributevalue" + ], + "title": "SearchModel.urlRelaxAttributeValue" + }, + { + "description": "Constructs an URL that you can use to re-execute the query without the specified refinement value. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#urlRelaxAttributeValue", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "attributeID", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlRelaxAttributeValue", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query without the\nspecified refinement value. The search specific parameters are appended\nto the provided URL. The URL is typically generated with one of the\nURLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlRelaxAttributeValue(url: URL, attributeID: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxattributevalue", + "searchmodel.urlrelaxattributevalue" + ], + "title": "SearchModel.urlRelaxAttributeValue" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with a specific sorting criteria. This criteria will overwrite all previous sort critiria. The provided parameter must be an action, e.g. 'Search-Show'.", + "id": "script-api:dw/catalog/SearchModel#urlSort", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "sortBy", + "type": "string" + }, + { + "name": "sortDir", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlSort", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with a\nspecific sorting criteria. This criteria will overwrite all previous sort\ncritiria. The provided parameter must be an action, e.g. 'Search-Show'.", + "heading": "Description" + } + ], + "signature": "urlSort(action: string, sortBy: string, sortDir: number): URL", + "source": "script-api", + "tags": [ + "urlsort", + "searchmodel.urlsort" + ], + "title": "SearchModel.urlSort" + }, + { + "description": "Constructs an URL that you can use to re-execute the query with a specific sorting criteria. This criteria will overwrite all previous sort critiria. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.", + "id": "script-api:dw/catalog/SearchModel#urlSort", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "sortBy", + "type": "string" + }, + { + "name": "sortDir", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/SearchModel", + "qualifiedName": "dw.catalog.SearchModel.urlSort", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Constructs an URL that you can use to re-execute the query with a\nspecific sorting criteria. This criteria will overwrite all previous sort\ncritiria. The search specific parameters are appended to the provided\nURL. The URL is typically generated with one of the URLUtils methods.", + "heading": "Description" + } + ], + "signature": "urlSort(url: URL, sortBy: string, sortDir: number): URL", + "source": "script-api", + "tags": [ + "urlsort", + "searchmodel.urlsort" + ], + "title": "SearchModel.urlSort" + }, + { + "description": "Common search refinement definition base class.", + "id": "script-api:dw/catalog/SearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinementDefinition", + "sections": [ + { + "body": "Common search refinement definition base class.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "searchrefinementdefinition", + "dw.catalog.searchrefinementdefinition", + "dw/catalog" + ], + "title": "SearchRefinementDefinition" + }, + { + "description": "Returns the attribute ID. If the refinement definition is not an attribute refinement, the method returns an empty string.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#attributeID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.attributeID", + "sections": [ + { + "body": "Returns the attribute ID. If the refinement definition is not an\nattribute refinement, the method returns an empty string.", + "heading": "Description" + } + ], + "signature": "readonly attributeID: string", + "source": "script-api", + "tags": [ + "attributeid", + "searchrefinementdefinition.attributeid" + ], + "title": "SearchRefinementDefinition.attributeID" + }, + { + "description": "Identifies if this is an attribute refinement.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#attributeRefinement", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.attributeRefinement", + "sections": [ + { + "body": "Identifies if this is an attribute refinement.", + "heading": "Description" + } + ], + "signature": "readonly attributeRefinement: boolean", + "source": "script-api", + "tags": [ + "attributerefinement", + "searchrefinementdefinition.attributerefinement" + ], + "title": "SearchRefinementDefinition.attributeRefinement" + }, + { + "description": "Returns the cut-off threshold.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#cutoffThreshold", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.cutoffThreshold", + "sections": [ + { + "body": "Returns the cut-off threshold.", + "heading": "Description" + } + ], + "signature": "readonly cutoffThreshold: number", + "source": "script-api", + "tags": [ + "cutoffthreshold", + "searchrefinementdefinition.cutoffthreshold" + ], + "title": "SearchRefinementDefinition.cutoffThreshold" + }, + { + "description": "Returns the display name.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.displayName", + "sections": [ + { + "body": "Returns the display name.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "searchrefinementdefinition.displayname" + ], + "title": "SearchRefinementDefinition.displayName" + }, + { + "description": "Returns the attribute ID. If the refinement definition is not an attribute refinement, the method returns an empty string.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#getAttributeID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getAttributeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the attribute ID. If the refinement definition is not an\nattribute refinement, the method returns an empty string.", + "heading": "Description" + } + ], + "signature": "getAttributeID(): string", + "source": "script-api", + "tags": [ + "getattributeid", + "searchrefinementdefinition.getattributeid" + ], + "title": "SearchRefinementDefinition.getAttributeID" + }, + { + "description": "Returns the cut-off threshold.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#getCutoffThreshold", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getCutoffThreshold", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the cut-off threshold.", + "heading": "Description" + } + ], + "signature": "getCutoffThreshold(): number", + "source": "script-api", + "tags": [ + "getcutoffthreshold", + "searchrefinementdefinition.getcutoffthreshold" + ], + "title": "SearchRefinementDefinition.getCutoffThreshold" + }, + { + "description": "Returns the display name.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "searchrefinementdefinition.getdisplayname" + ], + "title": "SearchRefinementDefinition.getDisplayName" + }, + { + "description": "Returns a code for the data type used for this search refinement definition. See constants defined in ObjectAttributeDefinition.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#getValueTypeCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.getValueTypeCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns a code for the data type used for this search refinement definition. See constants\ndefined in ObjectAttributeDefinition.", + "heading": "Description" + } + ], + "signature": "getValueTypeCode(): number", + "source": "script-api", + "tags": [ + "getvaluetypecode", + "searchrefinementdefinition.getvaluetypecode" + ], + "title": "SearchRefinementDefinition.getValueTypeCode" + }, + { + "description": "Identifies if this is an attribute refinement.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#isAttributeRefinement", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.isAttributeRefinement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is an attribute refinement.", + "heading": "Description" + } + ], + "signature": "isAttributeRefinement(): boolean", + "source": "script-api", + "tags": [ + "isattributerefinement", + "searchrefinementdefinition.isattributerefinement" + ], + "title": "SearchRefinementDefinition.isAttributeRefinement" + }, + { + "description": "Returns a code for the data type used for this search refinement definition. See constants defined in ObjectAttributeDefinition.", + "id": "script-api:dw/catalog/SearchRefinementDefinition#valueTypeCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementDefinition", + "qualifiedName": "dw.catalog.SearchRefinementDefinition.valueTypeCode", + "sections": [ + { + "body": "Returns a code for the data type used for this search refinement definition. See constants\ndefined in ObjectAttributeDefinition.", + "heading": "Description" + } + ], + "signature": "readonly valueTypeCode: number", + "source": "script-api", + "tags": [ + "valuetypecode", + "searchrefinementdefinition.valuetypecode" + ], + "title": "SearchRefinementDefinition.valueTypeCode" + }, + { + "description": "Represents the value of a product or content search refinement.", + "id": "script-api:dw/catalog/SearchRefinementValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinementValue", + "sections": [ + { + "body": "Represents the value of a product or content search refinement.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "searchrefinementvalue", + "dw.catalog.searchrefinementvalue", + "dw/catalog" + ], + "title": "SearchRefinementValue" + }, + { + "description": "Returns the refinement value's ID. For attribute refinements, this will be the ID of the corresponding dw.object.ObjectAttributeDefinition. This ID is included in the querystring parameter names returned by the URL-generating methods of dw.catalog.SearchModel. For price and category refinements, this value will be empty.", + "id": "script-api:dw/catalog/SearchRefinementValue#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.ID", + "sections": [ + { + "body": "Returns the refinement value's ID. For attribute refinements, this will\nbe the ID of the corresponding\ndw.object.ObjectAttributeDefinition. This ID is included in the\nquerystring parameter names returned by the URL-generating methods of\ndw.catalog.SearchModel. For price and category refinements, this\nvalue will be empty.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "searchrefinementvalue.id" + ], + "title": "SearchRefinementValue.ID" + }, + { + "description": "Returns the optional refinement value description in the current locale.", + "id": "script-api:dw/catalog/SearchRefinementValue#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.description", + "sections": [ + { + "body": "Returns the optional refinement value description in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "searchrefinementvalue.description" + ], + "title": "SearchRefinementValue.description" + }, + { + "description": "Returns the refinement display value. For attribute refinements, this is the appropriate display value based on optional value display names within the object attribute definition. If no display name is defined, the value itself is returned. For category refinements, this is the display name of the category in the current locale. For price refinements, this is a string representation of the range appropriate for display.", + "id": "script-api:dw/catalog/SearchRefinementValue#displayValue", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.displayValue", + "sections": [ + { + "body": "Returns the refinement display value. For attribute refinements, this is\nthe appropriate display value based on optional value display names\nwithin the object attribute definition. If no display name is defined,\nthe value itself is returned. For category refinements, this is the\ndisplay name of the category in the current locale. For price\nrefinements, this is a string representation of the range appropriate for\ndisplay.", + "heading": "Description" + } + ], + "signature": "readonly displayValue: string", + "source": "script-api", + "tags": [ + "displayvalue", + "searchrefinementvalue.displayvalue" + ], + "title": "SearchRefinementValue.displayValue" + }, + { + "description": "Returns the optional refinement value description in the current locale.", + "id": "script-api:dw/catalog/SearchRefinementValue#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the optional refinement value description in the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "searchrefinementvalue.getdescription" + ], + "title": "SearchRefinementValue.getDescription" + }, + { + "description": "Returns the refinement display value. For attribute refinements, this is the appropriate display value based on optional value display names within the object attribute definition. If no display name is defined, the value itself is returned. For category refinements, this is the display name of the category in the current locale. For price refinements, this is a string representation of the range appropriate for display.", + "id": "script-api:dw/catalog/SearchRefinementValue#getDisplayValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getDisplayValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the refinement display value. For attribute refinements, this is\nthe appropriate display value based on optional value display names\nwithin the object attribute definition. If no display name is defined,\nthe value itself is returned. For category refinements, this is the\ndisplay name of the category in the current locale. For price\nrefinements, this is a string representation of the range appropriate for\ndisplay.", + "heading": "Description" + } + ], + "signature": "getDisplayValue(): string", + "source": "script-api", + "tags": [ + "getdisplayvalue", + "searchrefinementvalue.getdisplayvalue" + ], + "title": "SearchRefinementValue.getDisplayValue" + }, + { + "description": "Returns the hit count value.", + "id": "script-api:dw/catalog/SearchRefinementValue#getHitCount", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getHitCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the hit count value.", + "heading": "Description" + } + ], + "signature": "getHitCount(): number", + "source": "script-api", + "tags": [ + "gethitcount", + "searchrefinementvalue.gethitcount" + ], + "title": "SearchRefinementValue.getHitCount" + }, + { + "description": "Returns the refinement value's ID. For attribute refinements, this will be the ID of the corresponding dw.object.ObjectAttributeDefinition. This ID is included in the querystring parameter names returned by the URL-generating methods of dw.catalog.SearchModel. For price and category refinements, this value will be empty.", + "id": "script-api:dw/catalog/SearchRefinementValue#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the refinement value's ID. For attribute refinements, this will\nbe the ID of the corresponding\ndw.object.ObjectAttributeDefinition. This ID is included in the\nquerystring parameter names returned by the URL-generating methods of\ndw.catalog.SearchModel. For price and category refinements, this\nvalue will be empty.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "searchrefinementvalue.getid" + ], + "title": "SearchRefinementValue.getID" + }, + { + "description": "Returns the optional presentation ID associated with this refinement value. The presentation ID can be used, for example, to associate an ID with an HTML widget.", + "id": "script-api:dw/catalog/SearchRefinementValue#getPresentationID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getPresentationID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the optional presentation ID associated with this refinement\nvalue. The presentation ID can be used, for example, to associate an ID\nwith an HTML widget.", + "heading": "Description" + } + ], + "signature": "getPresentationID(): string | null", + "source": "script-api", + "tags": [ + "getpresentationid", + "searchrefinementvalue.getpresentationid" + ], + "title": "SearchRefinementValue.getPresentationID" + }, + { + "description": "Returns the refinement value. For attribute refinements, this is the attribute value if the refinement values are unbucketed, or the bucket display name if the values are bucketed. This value is included in the querystring parameter values returned by the URL-generating methods of dw.catalog.SearchModel. For price refinements, the value will be a string representation of the price range lower bound. For category refinements, the value will be a category ID.", + "id": "script-api:dw/catalog/SearchRefinementValue#getValue", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.getValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the refinement value. For attribute refinements, this is the\nattribute value if the refinement values are unbucketed, or the bucket\ndisplay name if the values are bucketed. This value is included in the\nquerystring parameter values returned by the URL-generating methods of\ndw.catalog.SearchModel. For price refinements, the value will be\na string representation of the price range lower bound. For category\nrefinements, the value will be a category ID.", + "heading": "Description" + } + ], + "signature": "getValue(): string", + "source": "script-api", + "tags": [ + "getvalue", + "searchrefinementvalue.getvalue" + ], + "title": "SearchRefinementValue.getValue" + }, + { + "description": "Returns the hit count value.", + "id": "script-api:dw/catalog/SearchRefinementValue#hitCount", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.hitCount", + "sections": [ + { + "body": "Returns the hit count value.", + "heading": "Description" + } + ], + "signature": "readonly hitCount: number", + "source": "script-api", + "tags": [ + "hitcount", + "searchrefinementvalue.hitcount" + ], + "title": "SearchRefinementValue.hitCount" + }, + { + "description": "Returns the optional presentation ID associated with this refinement value. The presentation ID can be used, for example, to associate an ID with an HTML widget.", + "id": "script-api:dw/catalog/SearchRefinementValue#presentationID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.presentationID", + "sections": [ + { + "body": "Returns the optional presentation ID associated with this refinement\nvalue. The presentation ID can be used, for example, to associate an ID\nwith an HTML widget.", + "heading": "Description" + } + ], + "signature": "readonly presentationID: string | null", + "source": "script-api", + "tags": [ + "presentationid", + "searchrefinementvalue.presentationid" + ], + "title": "SearchRefinementValue.presentationID" + }, + { + "description": "Returns the refinement value. For attribute refinements, this is the attribute value if the refinement values are unbucketed, or the bucket display name if the values are bucketed. This value is included in the querystring parameter values returned by the URL-generating methods of dw.catalog.SearchModel. For price refinements, the value will be a string representation of the price range lower bound. For category refinements, the value will be a category ID.", + "id": "script-api:dw/catalog/SearchRefinementValue#value", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinementValue", + "qualifiedName": "dw.catalog.SearchRefinementValue.value", + "sections": [ + { + "body": "Returns the refinement value. For attribute refinements, this is the\nattribute value if the refinement values are unbucketed, or the bucket\ndisplay name if the values are bucketed. This value is included in the\nquerystring parameter values returned by the URL-generating methods of\ndw.catalog.SearchModel. For price refinements, the value will be\na string representation of the price range lower bound. For category\nrefinements, the value will be a category ID.", + "heading": "Description" + } + ], + "signature": "readonly value: string", + "source": "script-api", + "tags": [ + "value", + "searchrefinementvalue.value" + ], + "title": "SearchRefinementValue.value" + }, + { + "description": "Common search refinements base class.", + "id": "script-api:dw/catalog/SearchRefinements", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SearchRefinements", + "sections": [ + { + "body": "Common search refinements base class.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "searchrefinements", + "dw.catalog.searchrefinements", + "dw/catalog" + ], + "title": "SearchRefinements" + }, + { + "description": "Flag for an ascending sort.", + "id": "script-api:dw/catalog/SearchRefinements#ASCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.ASCENDING", + "sections": [ + { + "body": "Flag for an ascending sort.", + "heading": "Description" + } + ], + "signature": "static readonly ASCENDING: number", + "source": "script-api", + "tags": [ + "ascending", + "searchrefinements.ascending" + ], + "title": "SearchRefinements.ASCENDING" + }, + { + "description": "Flag for an ascending sort.", + "id": "script-api:dw/catalog/SearchRefinements#ASCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.ASCENDING", + "sections": [ + { + "body": "Flag for an ascending sort.", + "heading": "Description" + } + ], + "signature": "static readonly ASCENDING: number", + "source": "script-api", + "tags": [ + "ascending", + "searchrefinements.ascending" + ], + "title": "SearchRefinements.ASCENDING" + }, + { + "description": "Flag for a descending sort.", + "id": "script-api:dw/catalog/SearchRefinements#DESCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.DESCENDING", + "sections": [ + { + "body": "Flag for a descending sort.", + "heading": "Description" + } + ], + "signature": "static readonly DESCENDING: number", + "source": "script-api", + "tags": [ + "descending", + "searchrefinements.descending" + ], + "title": "SearchRefinements.DESCENDING" + }, + { + "description": "Flag for a descending sort.", + "id": "script-api:dw/catalog/SearchRefinements#DESCENDING", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.DESCENDING", + "sections": [ + { + "body": "Flag for a descending sort.", + "heading": "Description" + } + ], + "signature": "static readonly DESCENDING: number", + "source": "script-api", + "tags": [ + "descending", + "searchrefinements.descending" + ], + "title": "SearchRefinements.DESCENDING" + }, + { + "description": "Flag for sorting on value count.", + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_COUNT", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_COUNT", + "sections": [ + { + "body": "Flag for sorting on value count.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_VALUE_COUNT: number", + "source": "script-api", + "tags": [ + "sort_value_count", + "searchrefinements.sort_value_count" + ], + "title": "SearchRefinements.SORT_VALUE_COUNT" + }, + { + "description": "Flag for sorting on value count.", + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_COUNT", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_COUNT", + "sections": [ + { + "body": "Flag for sorting on value count.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_VALUE_COUNT: number", + "source": "script-api", + "tags": [ + "sort_value_count", + "searchrefinements.sort_value_count" + ], + "title": "SearchRefinements.SORT_VALUE_COUNT" + }, + { + "description": "Flag for sorting on value name.", + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_NAME", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_NAME", + "sections": [ + { + "body": "Flag for sorting on value name.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_VALUE_NAME: number", + "source": "script-api", + "tags": [ + "sort_value_name", + "searchrefinements.sort_value_name" + ], + "title": "SearchRefinements.SORT_VALUE_NAME" + }, + { + "description": "Flag for sorting on value name.", + "id": "script-api:dw/catalog/SearchRefinements#SORT_VALUE_NAME", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.SORT_VALUE_NAME", + "sections": [ + { + "body": "Flag for sorting on value name.", + "heading": "Description" + } + ], + "signature": "static readonly SORT_VALUE_NAME: number", + "source": "script-api", + "tags": [ + "sort_value_name", + "searchrefinements.sort_value_name" + ], + "title": "SearchRefinements.SORT_VALUE_NAME" + }, + { + "description": "Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category.", + "id": "script-api:dw/catalog/SearchRefinements#allRefinementDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.allRefinementDefinitions", + "sections": [ + { + "body": "Returns a sorted list of refinement definitions that are appropriate for\nthe deepest common category (or deepest common folder) of the search\nresult. The method concatenates the sorted refinement definitions per\ncategory starting at the root category until reaching the deepest common\ncategory.\n\nThe method does not filter out refinement definitions that do\nnot provide values for the current search result and can therefore also\nbe used on empty search results.", + "heading": "Description" + } + ], + "signature": "readonly allRefinementDefinitions: Collection>", + "source": "script-api", + "tags": [ + "allrefinementdefinitions", + "searchrefinements.allrefinementdefinitions" + ], + "title": "SearchRefinements.allRefinementDefinitions" + }, + { + "description": "Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category.", + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementDefinitions", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a sorted list of refinement definitions that are appropriate for\nthe deepest common category (or deepest common folder) of the search\nresult. The method concatenates the sorted refinement definitions per\ncategory starting at the root category until reaching the deepest common\ncategory.\n\nThe method does not filter out refinement definitions that do\nnot provide values for the current search result and can therefore also\nbe used on empty search results.", + "heading": "Description" + } + ], + "signature": "getAllRefinementDefinitions(): Collection>", + "source": "script-api", + "tags": [ + "getallrefinementdefinitions", + "searchrefinements.getallrefinementdefinitions" + ], + "title": "SearchRefinements.getAllRefinementDefinitions" + }, + { + "description": "Returns a sorted collection of refinement values for the given refinement attribute. The returned collection includes all refinement values for which the hit count is greater than 0 within the search result when the passed attribute is excluded from filtering the search hits but all other refinement filters are still applied. This method is useful for rendering broadening options for attributes that the search is currently refined by. This method does NOT return refinement values independent of the search result.", + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection | null" + }, + "sections": [ + { + "body": "Returns a sorted collection of refinement values for the given refinement\nattribute. The returned collection includes all refinement values for\nwhich the hit count is greater than 0 within the search result when the\npassed attribute is excluded from filtering the search hits but all other\nrefinement filters are still applied. This method is useful for rendering\nbroadening options for attributes that the search is currently refined\nby. This method does NOT return refinement values independent of the\nsearch result.\n\nFor product search refinements, this method may return slightly different\nresults based on the \"value set\" property of the refinement definition.\nSee\ndw.catalog.ProductSearchRefinements.getAllRefinementValues\nfor details.", + "heading": "Description" + } + ], + "signature": "getAllRefinementValues(attributeName: string): Collection | null", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "searchrefinements.getallrefinementvalues" + ], + "title": "SearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns a sorted collection of refinement values for the given refinement attribute. In general, the returned collection includes all refinement values for which hit count is greater than 0 within the search result assuming that:", + "id": "script-api:dw/catalog/SearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of refinement values for the given refinement\nattribute. In general, the returned collection includes all refinement\nvalues for which hit count is greater than 0 within the search result\nassuming that:\n\n- The passed refinement attribute is NOT used to filter the search\nhits.\n- All other refinements are still applied.\n\nThis is useful for rendering broadening options for the refinement\ndefinitions that the search is already refined by. It is important to\nnote that this method does NOT return refinement values independent of\nthe search result.\n\nFor product search refinements, this method may return slightly different\nresults based on the \"value set\" of the refinement definition. See\ndw.catalog.ProductSearchRefinements.getAllRefinementValues\nfor details.", + "heading": "Description" + } + ], + "signature": "getAllRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "searchrefinements.getallrefinementvalues" + ], + "title": "SearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category.", + "id": "script-api:dw/catalog/SearchRefinements#getRefinementDefinitions", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getRefinementDefinitions", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns a sorted list of refinement definitions that are appropriate for\nthe deepest common category (or deepest common folder) of the search\nresult. The method concatenates the sorted refinement definitions per category\nstarting at the root category until reaching the deepest common category.\n\nThe method also filters out refinement definitions that do not provide\nany values for the current search result.", + "heading": "Description" + } + ], + "signature": "getRefinementDefinitions(): Collection>", + "source": "script-api", + "tags": [ + "getrefinementdefinitions", + "searchrefinements.getrefinementdefinitions" + ], + "title": "SearchRefinements.getRefinementDefinitions" + }, + { + "description": "Returns a collection of refinement values for the given refinement attribute, sorting mode and sorting direction.", + "id": "script-api:dw/catalog/SearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.getRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of refinement values for the given refinement\nattribute, sorting mode and sorting direction.", + "heading": "Description" + } + ], + "signature": "getRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "searchrefinements.getrefinementvalues" + ], + "title": "SearchRefinements.getRefinementValues" + }, + { + "description": "Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category.", + "id": "script-api:dw/catalog/SearchRefinements#refinementDefinitions", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SearchRefinements", + "qualifiedName": "dw.catalog.SearchRefinements.refinementDefinitions", + "sections": [ + { + "body": "Returns a sorted list of refinement definitions that are appropriate for\nthe deepest common category (or deepest common folder) of the search\nresult. The method concatenates the sorted refinement definitions per category\nstarting at the root category until reaching the deepest common category.\n\nThe method also filters out refinement definitions that do not provide\nany values for the current search result.", + "heading": "Description" + } + ], + "signature": "readonly refinementDefinitions: Collection>", + "source": "script-api", + "tags": [ + "refinementdefinitions", + "searchrefinements.refinementdefinitions" + ], + "title": "SearchRefinements.refinementDefinitions" + }, + { + "description": "Represents an option for how to sort products in storefront search results.", + "id": "script-api:dw/catalog/SortingOption", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SortingOption", + "sections": [ + { + "body": "Represents an option for how to sort products in storefront search results.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "sortingoption", + "dw.catalog.sortingoption", + "dw/catalog" + ], + "title": "SortingOption" + }, + { + "description": "Returns the ID of the sorting option.", + "id": "script-api:dw/catalog/SortingOption#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.ID", + "sections": [ + { + "body": "Returns the ID of the sorting option.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "sortingoption.id" + ], + "title": "SortingOption.ID" + }, + { + "description": "Returns the description of the sorting option for the current locale.", + "id": "script-api:dw/catalog/SortingOption#description", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.description", + "sections": [ + { + "body": "Returns the description of the sorting option for the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "sortingoption.description" + ], + "title": "SortingOption.description" + }, + { + "description": "Returns the display name of the of the sorting option for the current locale.", + "id": "script-api:dw/catalog/SortingOption#displayName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.displayName", + "sections": [ + { + "body": "Returns the display name of the of the sorting option for the current locale.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "sortingoption.displayname" + ], + "title": "SortingOption.displayName" + }, + { + "description": "Returns the description of the sorting option for the current locale.", + "id": "script-api:dw/catalog/SortingOption#getDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description of the sorting option for the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "sortingoption.getdescription" + ], + "title": "SortingOption.getDescription" + }, + { + "description": "Returns the display name of the of the sorting option for the current locale.", + "id": "script-api:dw/catalog/SortingOption#getDisplayName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the display name of the of the sorting option for the current locale.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "sortingoption.getdisplayname" + ], + "title": "SortingOption.getDisplayName" + }, + { + "description": "Returns the ID of the sorting option.", + "id": "script-api:dw/catalog/SortingOption#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the sorting option.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "sortingoption.getid" + ], + "title": "SortingOption.getID" + }, + { + "description": "Returns the sorting rule for this sorting option, or `null` if there is no associated rule.", + "id": "script-api:dw/catalog/SortingOption#getSortingRule", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.getSortingRule", + "returns": { + "type": "SortingRule | null" + }, + "sections": [ + { + "body": "Returns the sorting rule for this sorting option,\nor `null` if there is no associated rule.", + "heading": "Description" + } + ], + "signature": "getSortingRule(): SortingRule | null", + "source": "script-api", + "tags": [ + "getsortingrule", + "sortingoption.getsortingrule" + ], + "title": "SortingOption.getSortingRule" + }, + { + "description": "Returns the sorting rule for this sorting option, or `null` if there is no associated rule.", + "id": "script-api:dw/catalog/SortingOption#sortingRule", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingOption", + "qualifiedName": "dw.catalog.SortingOption.sortingRule", + "sections": [ + { + "body": "Returns the sorting rule for this sorting option,\nor `null` if there is no associated rule.", + "heading": "Description" + } + ], + "signature": "readonly sortingRule: SortingRule | null", + "source": "script-api", + "tags": [ + "sortingrule", + "sortingoption.sortingrule" + ], + "title": "SortingOption.sortingRule" + }, + { + "description": "Represents a product sorting rule for use with the dw.catalog.ProductSearchModel.", + "id": "script-api:dw/catalog/SortingRule", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.SortingRule", + "sections": [ + { + "body": "Represents a product sorting rule for use with the dw.catalog.ProductSearchModel.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "sortingrule", + "dw.catalog.sortingrule", + "dw/catalog" + ], + "title": "SortingRule" + }, + { + "description": "Returns the ID of the sorting rule.", + "id": "script-api:dw/catalog/SortingRule#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingRule", + "qualifiedName": "dw.catalog.SortingRule.ID", + "sections": [ + { + "body": "Returns the ID of the sorting rule.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "sortingrule.id" + ], + "title": "SortingRule.ID" + }, + { + "description": "Returns the ID of the sorting rule.", + "id": "script-api:dw/catalog/SortingRule#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/SortingRule", + "qualifiedName": "dw.catalog.SortingRule.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the sorting rule.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "sortingrule.getid" + ], + "title": "SortingRule.getID" + }, + { + "description": "Represents a store in Commerce Cloud Digital.", + "id": "script-api:dw/catalog/Store", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Store", + "sections": [ + { + "body": "Represents a store in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "store", + "dw.catalog.store", + "dw/catalog" + ], + "title": "Store" + }, + { + "description": "Returns the ID of the store.", + "id": "script-api:dw/catalog/Store#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.ID", + "sections": [ + { + "body": "Returns the ID of the store.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "store.id" + ], + "title": "Store.ID" + }, + { + "description": "Returns the address1 of the store.", + "id": "script-api:dw/catalog/Store#address1", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.address1", + "sections": [ + { + "body": "Returns the address1 of the store.", + "heading": "Description" + } + ], + "signature": "readonly address1: string", + "source": "script-api", + "tags": [ + "address1", + "store.address1" + ], + "title": "Store.address1" + }, + { + "description": "Returns the address2 of the store.", + "id": "script-api:dw/catalog/Store#address2", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.address2", + "sections": [ + { + "body": "Returns the address2 of the store.", + "heading": "Description" + } + ], + "signature": "readonly address2: string", + "source": "script-api", + "tags": [ + "address2", + "store.address2" + ], + "title": "Store.address2" + }, + { + "description": "Returns the city of the store.", + "id": "script-api:dw/catalog/Store#city", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.city", + "sections": [ + { + "body": "Returns the city of the store.", + "heading": "Description" + } + ], + "signature": "readonly city: string", + "source": "script-api", + "tags": [ + "city", + "store.city" + ], + "title": "Store.city" + }, + { + "description": "Returns the countryCode of the store.", + "id": "script-api:dw/catalog/Store#countryCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.countryCode", + "sections": [ + { + "body": "Returns the countryCode of the store.", + "heading": "Description" + } + ], + "signature": "readonly countryCode: EnumValue", + "source": "script-api", + "tags": [ + "countrycode", + "store.countrycode" + ], + "title": "Store.countryCode" + }, + { + "deprecated": { + "message": "Use isPosEnabled instead" + }, + "description": "Returns the demandwarePosEnabled flag for the store. Indicates that this store uses Commerce Cloud Store for point-of-sale.", + "id": "script-api:dw/catalog/Store#demandwarePosEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.demandwarePosEnabled", + "sections": [ + { + "body": "Returns the demandwarePosEnabled flag for the store.\nIndicates that this store uses Commerce Cloud Store for point-of-sale.", + "heading": "Description" + } + ], + "signature": "readonly demandwarePosEnabled: boolean", + "source": "script-api", + "tags": [ + "demandwareposenabled", + "store.demandwareposenabled" + ], + "title": "Store.demandwarePosEnabled" + }, + { + "description": "Returns the email of the store.", + "id": "script-api:dw/catalog/Store#email", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.email", + "sections": [ + { + "body": "Returns the email of the store.", + "heading": "Description" + } + ], + "signature": "readonly email: string", + "source": "script-api", + "tags": [ + "email", + "store.email" + ], + "title": "Store.email" + }, + { + "description": "Returns the fax of the store.", + "id": "script-api:dw/catalog/Store#fax", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.fax", + "sections": [ + { + "body": "Returns the fax of the store.", + "heading": "Description" + } + ], + "signature": "readonly fax: string", + "source": "script-api", + "tags": [ + "fax", + "store.fax" + ], + "title": "Store.fax" + }, + { + "description": "Returns the address1 of the store.", + "id": "script-api:dw/catalog/Store#getAddress1", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getAddress1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address1 of the store.", + "heading": "Description" + } + ], + "signature": "getAddress1(): string", + "source": "script-api", + "tags": [ + "getaddress1", + "store.getaddress1" + ], + "title": "Store.getAddress1" + }, + { + "description": "Returns the address2 of the store.", + "id": "script-api:dw/catalog/Store#getAddress2", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getAddress2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address2 of the store.", + "heading": "Description" + } + ], + "signature": "getAddress2(): string", + "source": "script-api", + "tags": [ + "getaddress2", + "store.getaddress2" + ], + "title": "Store.getAddress2" + }, + { + "description": "Returns the city of the store.", + "id": "script-api:dw/catalog/Store#getCity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the city of the store.", + "heading": "Description" + } + ], + "signature": "getCity(): string", + "source": "script-api", + "tags": [ + "getcity", + "store.getcity" + ], + "title": "Store.getCity" + }, + { + "description": "Returns the countryCode of the store.", + "id": "script-api:dw/catalog/Store#getCountryCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getCountryCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the countryCode of the store.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): EnumValue", + "source": "script-api", + "tags": [ + "getcountrycode", + "store.getcountrycode" + ], + "title": "Store.getCountryCode" + }, + { + "description": "Returns the email of the store.", + "id": "script-api:dw/catalog/Store#getEmail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the email of the store.", + "heading": "Description" + } + ], + "signature": "getEmail(): string", + "source": "script-api", + "tags": [ + "getemail", + "store.getemail" + ], + "title": "Store.getEmail" + }, + { + "description": "Returns the fax of the store.", + "id": "script-api:dw/catalog/Store#getFax", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getFax", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the fax of the store.", + "heading": "Description" + } + ], + "signature": "getFax(): string", + "source": "script-api", + "tags": [ + "getfax", + "store.getfax" + ], + "title": "Store.getFax" + }, + { + "description": "Returns the ID of the store.", + "id": "script-api:dw/catalog/Store#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the store.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "store.getid" + ], + "title": "Store.getID" + }, + { + "description": "Returns the store image.", + "id": "script-api:dw/catalog/Store#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the store image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "store.getimage" + ], + "title": "Store.getImage" + }, + { + "description": "Returns the inventory list the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/catalog/Store#getInventoryList", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list the store is associated with. If the\nstore is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "getInventoryList(): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getinventorylist", + "store.getinventorylist" + ], + "title": "Store.getInventoryList" + }, + { + "description": "Returns the inventory list id the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/catalog/Store#getInventoryListID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getInventoryListID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the inventory list id the store is associated with. If the\nstore is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "getInventoryListID(): string", + "source": "script-api", + "tags": [ + "getinventorylistid", + "store.getinventorylistid" + ], + "title": "Store.getInventoryListID" + }, + { + "description": "Returns the latitude of the store.", + "id": "script-api:dw/catalog/Store#getLatitude", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getLatitude", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the latitude of the store.", + "heading": "Description" + } + ], + "signature": "getLatitude(): number", + "source": "script-api", + "tags": [ + "getlatitude", + "store.getlatitude" + ], + "title": "Store.getLatitude" + }, + { + "description": "Returns the longitude of the store.", + "id": "script-api:dw/catalog/Store#getLongitude", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getLongitude", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the longitude of the store.", + "heading": "Description" + } + ], + "signature": "getLongitude(): number", + "source": "script-api", + "tags": [ + "getlongitude", + "store.getlongitude" + ], + "title": "Store.getLongitude" + }, + { + "description": "Returns the name of the store.", + "id": "script-api:dw/catalog/Store#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the store.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "store.getname" + ], + "title": "Store.getName" + }, + { + "description": "Returns the phone of the store.", + "id": "script-api:dw/catalog/Store#getPhone", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getPhone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the phone of the store.", + "heading": "Description" + } + ], + "signature": "getPhone(): string", + "source": "script-api", + "tags": [ + "getphone", + "store.getphone" + ], + "title": "Store.getPhone" + }, + { + "description": "Returns the postalCode of the store.", + "id": "script-api:dw/catalog/Store#getPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the postalCode of the store.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "store.getpostalcode" + ], + "title": "Store.getPostalCode" + }, + { + "description": "Returns the stateCode of the store.", + "id": "script-api:dw/catalog/Store#getStateCode", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the stateCode of the store.", + "heading": "Description" + } + ], + "signature": "getStateCode(): string", + "source": "script-api", + "tags": [ + "getstatecode", + "store.getstatecode" + ], + "title": "Store.getStateCode" + }, + { + "description": "Returns the storeEvents of the store.", + "id": "script-api:dw/catalog/Store#getStoreEvents", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreEvents", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the storeEvents of the store.", + "heading": "Description" + } + ], + "signature": "getStoreEvents(): MarkupText", + "source": "script-api", + "tags": [ + "getstoreevents", + "store.getstoreevents" + ], + "title": "Store.getStoreEvents" + }, + { + "description": "Returns all the store groups this store belongs to.", + "id": "script-api:dw/catalog/Store#getStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all the store groups this store belongs to.", + "heading": "Description" + } + ], + "signature": "getStoreGroups(): Collection", + "source": "script-api", + "tags": [ + "getstoregroups", + "store.getstoregroups" + ], + "title": "Store.getStoreGroups" + }, + { + "description": "Returns the storeHours of the store.", + "id": "script-api:dw/catalog/Store#getStoreHours", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.getStoreHours", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the storeHours of the store.", + "heading": "Description" + } + ], + "signature": "getStoreHours(): MarkupText", + "source": "script-api", + "tags": [ + "getstorehours", + "store.getstorehours" + ], + "title": "Store.getStoreHours" + }, + { + "description": "Returns the store image.", + "id": "script-api:dw/catalog/Store#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.image", + "sections": [ + { + "body": "Returns the store image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "store.image" + ], + "title": "Store.image" + }, + { + "description": "Returns the inventory list the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/catalog/Store#inventoryList", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.inventoryList", + "sections": [ + { + "body": "Returns the inventory list the store is associated with. If the\nstore is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "readonly inventoryList: ProductInventoryList | null", + "source": "script-api", + "tags": [ + "inventorylist", + "store.inventorylist" + ], + "title": "Store.inventoryList" + }, + { + "description": "Returns the inventory list id the store is associated with. If the store is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/catalog/Store#inventoryListID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.inventoryListID", + "sections": [ + { + "body": "Returns the inventory list id the store is associated with. If the\nstore is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "readonly inventoryListID: string", + "source": "script-api", + "tags": [ + "inventorylistid", + "store.inventorylistid" + ], + "title": "Store.inventoryListID" + }, + { + "deprecated": { + "message": "Use isPosEnabled instead" + }, + "description": "Returns the demandwarePosEnabled flag for the store. Indicates that this store uses Commerce Cloud Store for point-of-sale.", + "id": "script-api:dw/catalog/Store#isDemandwarePosEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isDemandwarePosEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the demandwarePosEnabled flag for the store.\nIndicates that this store uses Commerce Cloud Store for point-of-sale.", + "heading": "Description" + } + ], + "signature": "isDemandwarePosEnabled(): boolean", + "source": "script-api", + "tags": [ + "isdemandwareposenabled", + "store.isdemandwareposenabled" + ], + "title": "Store.isDemandwarePosEnabled" + }, + { + "description": "Returns the posEnabled flag for the Store. Indicates that this store uses Commerce Cloud Store for point-of-sale.", + "id": "script-api:dw/catalog/Store#isPosEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isPosEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the posEnabled flag for the Store.\nIndicates that this store uses Commerce Cloud Store for point-of-sale.", + "heading": "Description" + } + ], + "signature": "isPosEnabled(): boolean", + "source": "script-api", + "tags": [ + "isposenabled", + "store.isposenabled" + ], + "title": "Store.isPosEnabled" + }, + { + "description": "Returns the storeLocatorEnabled flag for the store.", + "id": "script-api:dw/catalog/Store#isStoreLocatorEnabled", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.isStoreLocatorEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the storeLocatorEnabled flag for the store.", + "heading": "Description" + } + ], + "signature": "isStoreLocatorEnabled(): boolean", + "source": "script-api", + "tags": [ + "isstorelocatorenabled", + "store.isstorelocatorenabled" + ], + "title": "Store.isStoreLocatorEnabled" + }, + { + "description": "Returns the latitude of the store.", + "id": "script-api:dw/catalog/Store#latitude", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.latitude", + "sections": [ + { + "body": "Returns the latitude of the store.", + "heading": "Description" + } + ], + "signature": "readonly latitude: number", + "source": "script-api", + "tags": [ + "latitude", + "store.latitude" + ], + "title": "Store.latitude" + }, + { + "description": "Returns the longitude of the store.", + "id": "script-api:dw/catalog/Store#longitude", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.longitude", + "sections": [ + { + "body": "Returns the longitude of the store.", + "heading": "Description" + } + ], + "signature": "readonly longitude: number", + "source": "script-api", + "tags": [ + "longitude", + "store.longitude" + ], + "title": "Store.longitude" + }, + { + "description": "Returns the name of the store.", + "id": "script-api:dw/catalog/Store#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.name", + "sections": [ + { + "body": "Returns the name of the store.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "store.name" + ], + "title": "Store.name" + }, + { + "description": "Returns the phone of the store.", + "id": "script-api:dw/catalog/Store#phone", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.phone", + "sections": [ + { + "body": "Returns the phone of the store.", + "heading": "Description" + } + ], + "signature": "readonly phone: string", + "source": "script-api", + "tags": [ + "phone", + "store.phone" + ], + "title": "Store.phone" + }, + { + "description": "Returns the posEnabled flag for the Store. Indicates that this store uses Commerce Cloud Store for point-of-sale.", + "id": "script-api:dw/catalog/Store#posEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.posEnabled", + "sections": [ + { + "body": "Returns the posEnabled flag for the Store.\nIndicates that this store uses Commerce Cloud Store for point-of-sale.", + "heading": "Description" + } + ], + "signature": "readonly posEnabled: boolean", + "source": "script-api", + "tags": [ + "posenabled", + "store.posenabled" + ], + "title": "Store.posEnabled" + }, + { + "description": "Returns the postalCode of the store.", + "id": "script-api:dw/catalog/Store#postalCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.postalCode", + "sections": [ + { + "body": "Returns the postalCode of the store.", + "heading": "Description" + } + ], + "signature": "readonly postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "store.postalcode" + ], + "title": "Store.postalCode" + }, + { + "description": "Returns the stateCode of the store.", + "id": "script-api:dw/catalog/Store#stateCode", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.stateCode", + "sections": [ + { + "body": "Returns the stateCode of the store.", + "heading": "Description" + } + ], + "signature": "readonly stateCode: string", + "source": "script-api", + "tags": [ + "statecode", + "store.statecode" + ], + "title": "Store.stateCode" + }, + { + "description": "Returns the storeEvents of the store.", + "id": "script-api:dw/catalog/Store#storeEvents", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeEvents", + "sections": [ + { + "body": "Returns the storeEvents of the store.", + "heading": "Description" + } + ], + "signature": "readonly storeEvents: MarkupText", + "source": "script-api", + "tags": [ + "storeevents", + "store.storeevents" + ], + "title": "Store.storeEvents" + }, + { + "description": "Returns all the store groups this store belongs to.", + "id": "script-api:dw/catalog/Store#storeGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeGroups", + "sections": [ + { + "body": "Returns all the store groups this store belongs to.", + "heading": "Description" + } + ], + "signature": "readonly storeGroups: Collection", + "source": "script-api", + "tags": [ + "storegroups", + "store.storegroups" + ], + "title": "Store.storeGroups" + }, + { + "description": "Returns the storeHours of the store.", + "id": "script-api:dw/catalog/Store#storeHours", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeHours", + "sections": [ + { + "body": "Returns the storeHours of the store.", + "heading": "Description" + } + ], + "signature": "readonly storeHours: MarkupText", + "source": "script-api", + "tags": [ + "storehours", + "store.storehours" + ], + "title": "Store.storeHours" + }, + { + "description": "Returns the storeLocatorEnabled flag for the store.", + "id": "script-api:dw/catalog/Store#storeLocatorEnabled", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Store", + "qualifiedName": "dw.catalog.Store.storeLocatorEnabled", + "sections": [ + { + "body": "Returns the storeLocatorEnabled flag for the store.", + "heading": "Description" + } + ], + "signature": "readonly storeLocatorEnabled: boolean", + "source": "script-api", + "tags": [ + "storelocatorenabled", + "store.storelocatorenabled" + ], + "title": "Store.storeLocatorEnabled" + }, + { + "description": "Represents a store group. Store groups can be used to group the stores for different marketing purposes.", + "id": "script-api:dw/catalog/StoreGroup", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreGroup", + "sections": [ + { + "body": "Represents a store group. Store groups can be used to group the stores for different marketing purposes.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "storegroup", + "dw.catalog.storegroup", + "dw/catalog" + ], + "title": "StoreGroup" + }, + { + "description": "Returns the ID of the store group.", + "id": "script-api:dw/catalog/StoreGroup#ID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.ID", + "sections": [ + { + "body": "Returns the ID of the store group.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "storegroup.id" + ], + "title": "StoreGroup.ID" + }, + { + "description": "Returns the ID of the store group.", + "id": "script-api:dw/catalog/StoreGroup#getID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the store group.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "storegroup.getid" + ], + "title": "StoreGroup.getID" + }, + { + "description": "Returns the name of the store group.", + "id": "script-api:dw/catalog/StoreGroup#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the store group.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "storegroup.getname" + ], + "title": "StoreGroup.getName" + }, + { + "description": "Returns all the stores that are assigned to the store group.", + "id": "script-api:dw/catalog/StoreGroup#getStores", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.getStores", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all the stores that are assigned to the store group.", + "heading": "Description" + } + ], + "signature": "getStores(): Collection", + "source": "script-api", + "tags": [ + "getstores", + "storegroup.getstores" + ], + "title": "StoreGroup.getStores" + }, + { + "description": "Returns the name of the store group.", + "id": "script-api:dw/catalog/StoreGroup#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.name", + "sections": [ + { + "body": "Returns the name of the store group.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "storegroup.name" + ], + "title": "StoreGroup.name" + }, + { + "description": "Returns all the stores that are assigned to the store group.", + "id": "script-api:dw/catalog/StoreGroup#stores", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreGroup", + "qualifiedName": "dw.catalog.StoreGroup.stores", + "sections": [ + { + "body": "Returns all the stores that are assigned to the store group.", + "heading": "Description" + } + ], + "signature": "readonly stores: Collection", + "source": "script-api", + "tags": [ + "stores", + "storegroup.stores" + ], + "title": "StoreGroup.stores" + }, + { + "description": "This class represents a store inventory filter, which can be used at ProductSearchModel.setStoreInventoryFilter to filter the search result by one or more store inventories. Compared to the default parameter 'ilids' (Inventory List IDs) see (ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER the store inventory filter allows a customization of the parameter name and the inventory list ID parameter values for the URL generations via all URLRefine and URLRelax methods e.g. for ProductSearchModel.urlRefineCategory, ProductSearchModel.urlRelaxPrice, SearchModel.urlRefineAttribute.", + "id": "script-api:dw/catalog/StoreInventoryFilter", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreInventoryFilter", + "sections": [ + { + "body": "This class represents a store inventory filter, which can be used at\nProductSearchModel.setStoreInventoryFilter to filter the search result by one or more\nstore inventories. Compared to the default parameter 'ilids' (Inventory List IDs) see\n(ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER the store inventory filter allows a customization of the\nparameter name and the inventory list ID parameter values for the URL generations via all URLRefine and URLRelax\nmethods e.g. for ProductSearchModel.urlRefineCategory,\nProductSearchModel.urlRelaxPrice,\nSearchModel.urlRefineAttribute.\n\nExample custom URL: city=Burlington|Boston", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "storeinventoryfilter", + "dw.catalog.storeinventoryfilter", + "dw/catalog" + ], + "title": "StoreInventoryFilter" + }, + { + "description": "Returns the semantic URL parameter of this StoreInventoryFilter.", + "id": "script-api:dw/catalog/StoreInventoryFilter#getSemanticURLParameter", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.getSemanticURLParameter", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the semantic URL parameter of this StoreInventoryFilter.", + "heading": "Description" + } + ], + "signature": "getSemanticURLParameter(): string", + "source": "script-api", + "tags": [ + "getsemanticurlparameter", + "storeinventoryfilter.getsemanticurlparameter" + ], + "title": "StoreInventoryFilter.getSemanticURLParameter" + }, + { + "description": "Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.", + "id": "script-api:dw/catalog/StoreInventoryFilter#getStoreInventoryFilterValues", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.getStoreInventoryFilterValues", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.", + "heading": "Description" + } + ], + "signature": "getStoreInventoryFilterValues(): List", + "source": "script-api", + "tags": [ + "getstoreinventoryfiltervalues", + "storeinventoryfilter.getstoreinventoryfiltervalues" + ], + "title": "StoreInventoryFilter.getStoreInventoryFilterValues" + }, + { + "description": "Returns the semantic URL parameter of this StoreInventoryFilter.", + "id": "script-api:dw/catalog/StoreInventoryFilter#semanticURLParameter", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.semanticURLParameter", + "sections": [ + { + "body": "Returns the semantic URL parameter of this StoreInventoryFilter.", + "heading": "Description" + } + ], + "signature": "readonly semanticURLParameter: string", + "source": "script-api", + "tags": [ + "semanticurlparameter", + "storeinventoryfilter.semanticurlparameter" + ], + "title": "StoreInventoryFilter.semanticURLParameter" + }, + { + "description": "Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.", + "id": "script-api:dw/catalog/StoreInventoryFilter#storeInventoryFilterValues", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilter", + "qualifiedName": "dw.catalog.StoreInventoryFilter.storeInventoryFilterValues", + "sections": [ + { + "body": "Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.", + "heading": "Description" + } + ], + "signature": "readonly storeInventoryFilterValues: List", + "source": "script-api", + "tags": [ + "storeinventoryfiltervalues", + "storeinventoryfilter.storeinventoryfiltervalues" + ], + "title": "StoreInventoryFilter.storeInventoryFilterValues" + }, + { + "description": "This class represents a store inventory filter value, which can be used for a StoreInventoryFilter to filter the search result by one or more store inventory list IDs via ProductSearchModel.setStoreInventoryFilter. Compared to ProductSearchModel.setInventoryListIDs the store inventory filter allows a customization of the inventory parameter name and the inventory list ID values for URL generations. A StoreInventoryFilterValue provides the mapping between a semantic value e.g. store1,store2 or Burlington,Boston to the related real inventory list ID.", + "id": "script-api:dw/catalog/StoreInventoryFilterValue", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue", + "sections": [ + { + "body": "This class represents a store inventory filter value, which can be used for a StoreInventoryFilter to filter\nthe search result by one or more store inventory list IDs via\nProductSearchModel.setStoreInventoryFilter. Compared to\nProductSearchModel.setInventoryListIDs the store inventory filter allows a customization of the\ninventory parameter name and the inventory list ID values for URL generations. A StoreInventoryFilterValue provides\nthe mapping between a semantic value e.g. store1,store2 or Burlington,Boston to the related real inventory list ID.\n\nExample custom URL: city=Burlington|Boston", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "storeinventoryfiltervalue", + "dw.catalog.storeinventoryfiltervalue", + "dw/catalog" + ], + "title": "StoreInventoryFilterValue" + }, + { + "description": "Returns the real inventory list ID of this store inventory filter value.", + "id": "script-api:dw/catalog/StoreInventoryFilterValue#getInventoryListID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.getInventoryListID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the real inventory list ID of this store inventory filter value.", + "heading": "Description" + } + ], + "signature": "getInventoryListID(): string", + "source": "script-api", + "tags": [ + "getinventorylistid", + "storeinventoryfiltervalue.getinventorylistid" + ], + "title": "StoreInventoryFilterValue.getInventoryListID" + }, + { + "description": "Returns the semantic inventory ID of this store inventory filter value.", + "id": "script-api:dw/catalog/StoreInventoryFilterValue#getSemanticInventoryID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.getSemanticInventoryID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the semantic inventory ID of this store inventory filter value.", + "heading": "Description" + } + ], + "signature": "getSemanticInventoryID(): string", + "source": "script-api", + "tags": [ + "getsemanticinventoryid", + "storeinventoryfiltervalue.getsemanticinventoryid" + ], + "title": "StoreInventoryFilterValue.getSemanticInventoryID" + }, + { + "description": "Returns the real inventory list ID of this store inventory filter value.", + "id": "script-api:dw/catalog/StoreInventoryFilterValue#inventoryListID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.inventoryListID", + "sections": [ + { + "body": "Returns the real inventory list ID of this store inventory filter value.", + "heading": "Description" + } + ], + "signature": "readonly inventoryListID: string", + "source": "script-api", + "tags": [ + "inventorylistid", + "storeinventoryfiltervalue.inventorylistid" + ], + "title": "StoreInventoryFilterValue.inventoryListID" + }, + { + "description": "Returns the semantic inventory ID of this store inventory filter value.", + "id": "script-api:dw/catalog/StoreInventoryFilterValue#semanticInventoryID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreInventoryFilterValue", + "qualifiedName": "dw.catalog.StoreInventoryFilterValue.semanticInventoryID", + "sections": [ + { + "body": "Returns the semantic inventory ID of this store inventory filter value.", + "heading": "Description" + } + ], + "signature": "readonly semanticInventoryID: string", + "source": "script-api", + "tags": [ + "semanticinventoryid", + "storeinventoryfiltervalue.semanticinventoryid" + ], + "title": "StoreInventoryFilterValue.semanticInventoryID" + }, + { + "description": "Provides helper methods for getting stores based on id and querying for stores based on geolocation.", + "id": "script-api:dw/catalog/StoreMgr", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.StoreMgr", + "sections": [ + { + "body": "Provides helper methods for getting stores based on id and querying for\nstores based on geolocation.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "storemgr", + "dw.catalog.storemgr", + "dw/catalog" + ], + "title": "StoreMgr" + }, + { + "description": "Returns all the store groups of the current site.", + "id": "script-api:dw/catalog/StoreMgr#allStoreGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.allStoreGroups", + "sections": [ + { + "body": "Returns all the store groups of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly allStoreGroups: Collection", + "source": "script-api", + "tags": [ + "allstoregroups", + "storemgr.allstoregroups" + ], + "title": "StoreMgr.allStoreGroups" + }, + { + "description": "Returns all the store groups of the current site.", + "id": "script-api:dw/catalog/StoreMgr#allStoreGroups", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.allStoreGroups", + "sections": [ + { + "body": "Returns all the store groups of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly allStoreGroups: Collection", + "source": "script-api", + "tags": [ + "allstoregroups", + "storemgr.allstoregroups" + ], + "title": "StoreMgr.allStoreGroups" + }, + { + "description": "Returns all the store groups of the current site.", + "id": "script-api:dw/catalog/StoreMgr#getAllStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getAllStoreGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all the store groups of the current site.", + "heading": "Description" + } + ], + "signature": "static getAllStoreGroups(): Collection", + "source": "script-api", + "tags": [ + "getallstoregroups", + "storemgr.getallstoregroups" + ], + "title": "StoreMgr.getAllStoreGroups" + }, + { + "description": "Returns all the store groups of the current site.", + "id": "script-api:dw/catalog/StoreMgr#getAllStoreGroups", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getAllStoreGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all the store groups of the current site.", + "heading": "Description" + } + ], + "signature": "static getAllStoreGroups(): Collection", + "source": "script-api", + "tags": [ + "getallstoregroups", + "storemgr.getallstoregroups" + ], + "title": "StoreMgr.getAllStoreGroups" + }, + { + "description": "Returns the store object with the specified id or null if store with this id does not exist in the site.", + "id": "script-api:dw/catalog/StoreMgr#getStore", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStore", + "returns": { + "type": "Store | null" + }, + "sections": [ + { + "body": "Returns the store object with the specified id or null if store with this\nid does not exist in the site.", + "heading": "Description" + } + ], + "signature": "static getStore(storeID: string): Store | null", + "source": "script-api", + "tags": [ + "getstore", + "storemgr.getstore" + ], + "title": "StoreMgr.getStore" + }, + { + "description": "Returns the store object with the specified id or null if store with this id does not exist in the site.", + "id": "script-api:dw/catalog/StoreMgr#getStore", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStore", + "returns": { + "type": "Store | null" + }, + "sections": [ + { + "body": "Returns the store object with the specified id or null if store with this\nid does not exist in the site.", + "heading": "Description" + } + ], + "signature": "static getStore(storeID: string): Store | null", + "source": "script-api", + "tags": [ + "getstore", + "storemgr.getstore" + ], + "title": "StoreMgr.getStore" + }, + { + "description": "Returns the store group with the specified id or null if the store group with this id does not exist in the current site.", + "id": "script-api:dw/catalog/StoreMgr#getStoreGroup", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeGroupID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreGroup", + "returns": { + "type": "StoreGroup | null" + }, + "sections": [ + { + "body": "Returns the store group with the specified id or null if the store group with this id does not exist in the current site.", + "heading": "Description" + } + ], + "signature": "static getStoreGroup(storeGroupID: string): StoreGroup | null", + "source": "script-api", + "tags": [ + "getstoregroup", + "storemgr.getstoregroup" + ], + "title": "StoreMgr.getStoreGroup" + }, + { + "description": "Returns the store group with the specified id or null if the store group with this id does not exist in the current site.", + "id": "script-api:dw/catalog/StoreMgr#getStoreGroup", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeGroupID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreGroup", + "returns": { + "type": "StoreGroup | null" + }, + "sections": [ + { + "body": "Returns the store group with the specified id or null if the store group with this id does not exist in the current site.", + "heading": "Description" + } + ], + "signature": "static getStoreGroup(storeGroupID: string): StoreGroup | null", + "source": "script-api", + "tags": [ + "getstoregroup", + "storemgr.getstoregroup" + ], + "title": "StoreMgr.getStoreGroup" + }, + { + "description": "Get the store id associated with the current session. By default, the session store id is null.", + "id": "script-api:dw/catalog/StoreMgr#getStoreIDFromSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreIDFromSession", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the store id associated with the current session. By default, the session store id is null.", + "heading": "Description" + } + ], + "signature": "static getStoreIDFromSession(): string | null", + "source": "script-api", + "tags": [ + "getstoreidfromsession", + "storemgr.getstoreidfromsession" + ], + "title": "StoreMgr.getStoreIDFromSession" + }, + { + "description": "Get the store id associated with the current session. By default, the session store id is null.", + "id": "script-api:dw/catalog/StoreMgr#getStoreIDFromSession", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.getStoreIDFromSession", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the store id associated with the current session. By default, the session store id is null.", + "heading": "Description" + } + ], + "signature": "static getStoreIDFromSession(): string | null", + "source": "script-api", + "tags": [ + "getstoreidfromsession", + "storemgr.getstoreidfromsession" + ], + "title": "StoreMgr.getStoreIDFromSession" + }, + { + "description": "Search for stores based on geo-coordinates. The method returns a list of stores for the current site that are within a specified distance of a location on the earth and which optionally satisfy additional filter criteria. If no additional criteria are specified, then this method behaves similar to GetNearestStores pipelet. The criteria are specified as a querystring, using the same syntax as dw.object.SystemObjectMgr.querySystemObjects", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "latitude", + "type": "number" + }, + { + "name": "longitude", + "type": "number" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Search for stores based on geo-coordinates. The method returns a list of\nstores for the current site that are within a specified distance of a\nlocation on the earth and which optionally satisfy additional filter\ncriteria. If no additional criteria are specified, then this method\nbehaves similar to GetNearestStores pipelet. The criteria are specified\nas a querystring, using the same syntax as\ndw.object.SystemObjectMgr.querySystemObjects\n\nThe stores and their distance from the specified location are returned as\na LinkedHashMap of Store objects to distances, sorting in ascending order\nby distance. The distance is interpreted either in miles or kilometers\ndepending on the \"distanceUnit\" parameter.\n\nThe latitude and longitude of each store is determined by first looking\nat dw.catalog.Store.getLatitude and\ndw.catalog.Store.getLongitude. If these are not set, then the\nsystem deduces the location of the store by looking for a configured\ngeolocation matching the store's postal and country codes.", + "heading": "Description" + } + ], + "signature": "static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number, queryString: string, args?: any[]): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "description": "Convenience method. Same as searchStoresByCoordinates(latitude, longitude, distanceUnit, maxDistance, null).", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "latitude", + "type": "number" + }, + { + "name": "longitude", + "type": "number" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Convenience method. Same as searchStoresByCoordinates(latitude, longitude, distanceUnit, maxDistance, null).", + "heading": "Description" + } + ], + "signature": "static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "description": "Search for stores based on geo-coordinates. The method returns a list of stores for the current site that are within a specified distance of a location on the earth and which optionally satisfy additional filter criteria. If no additional criteria are specified, then this method behaves similar to GetNearestStores pipelet. The criteria are specified as a querystring, using the same syntax as dw.object.SystemObjectMgr.querySystemObjects", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "latitude", + "type": "number" + }, + { + "name": "longitude", + "type": "number" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Search for stores based on geo-coordinates. The method returns a list of\nstores for the current site that are within a specified distance of a\nlocation on the earth and which optionally satisfy additional filter\ncriteria. If no additional criteria are specified, then this method\nbehaves similar to GetNearestStores pipelet. The criteria are specified\nas a querystring, using the same syntax as\ndw.object.SystemObjectMgr.querySystemObjects\n\nThe stores and their distance from the specified location are returned as\na LinkedHashMap of Store objects to distances, sorting in ascending order\nby distance. The distance is interpreted either in miles or kilometers\ndepending on the \"distanceUnit\" parameter.\n\nThe latitude and longitude of each store is determined by first looking\nat dw.catalog.Store.getLatitude and\ndw.catalog.Store.getLongitude. If these are not set, then the\nsystem deduces the location of the store by looking for a configured\ngeolocation matching the store's postal and country codes.", + "heading": "Description" + } + ], + "signature": "static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number, queryString: string, args?: any[]): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "description": "Convenience method. Same as searchStoresByCoordinates(latitude, longitude, distanceUnit, maxDistance, null).", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByCoordinates", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "latitude", + "type": "number" + }, + { + "name": "longitude", + "type": "number" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByCoordinates", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Convenience method. Same as searchStoresByCoordinates(latitude, longitude, distanceUnit, maxDistance, null).", + "heading": "Description" + } + ], + "signature": "static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbycoordinates", + "storemgr.searchstoresbycoordinates" + ], + "title": "StoreMgr.searchStoresByCoordinates" + }, + { + "description": "Search for stores by country/postal code and optionally by additional filter criteria. This method is analagous to dw.catalog.StoreMgr.searchStoresByCoordinates but identifies a location on the earth indirectly using country and postal code. The method will look first in the saved geolocations of the system to find a geolocation matching the passed country and postal code. If none is found, this method will return an empty map. If one is found, it will use the latitude/longitude of the found geolocation as the center of the search.", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "countryCode", + "type": "string" + }, + { + "name": "postalCode", + "type": "string" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Search for stores by country/postal code and optionally by additional\nfilter criteria. This method is analagous to\ndw.catalog.StoreMgr.searchStoresByCoordinates\nbut identifies a location on the earth indirectly using country and\npostal code. The method will look first in the saved geolocations of the\nsystem to find a geolocation matching the passed country and postal code.\nIf none is found, this method will return an empty map. If one is found,\nit will use the latitude/longitude of the found geolocation as the center\nof the search.", + "heading": "Description" + } + ], + "signature": "static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number, queryString: string, args?: any[]): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "description": "Convenience method. Same as searchStoresByPostalCode(countryCode, postalCode, distanceUnit, maxDistance, null).", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "countryCode", + "type": "string" + }, + { + "name": "postalCode", + "type": "string" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Convenience method. Same as searchStoresByPostalCode(countryCode, postalCode, distanceUnit, maxDistance, null).", + "heading": "Description" + } + ], + "signature": "static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "description": "Search for stores by country/postal code and optionally by additional filter criteria. This method is analagous to dw.catalog.StoreMgr.searchStoresByCoordinates but identifies a location on the earth indirectly using country and postal code. The method will look first in the saved geolocations of the system to find a geolocation matching the passed country and postal code. If none is found, this method will return an empty map. If one is found, it will use the latitude/longitude of the found geolocation as the center of the search.", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "countryCode", + "type": "string" + }, + { + "name": "postalCode", + "type": "string" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Search for stores by country/postal code and optionally by additional\nfilter criteria. This method is analagous to\ndw.catalog.StoreMgr.searchStoresByCoordinates\nbut identifies a location on the earth indirectly using country and\npostal code. The method will look first in the saved geolocations of the\nsystem to find a geolocation matching the passed country and postal code.\nIf none is found, this method will return an empty map. If one is found,\nit will use the latitude/longitude of the found geolocation as the center\nof the search.", + "heading": "Description" + } + ], + "signature": "static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number, queryString: string, args?: any[]): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "description": "Convenience method. Same as searchStoresByPostalCode(countryCode, postalCode, distanceUnit, maxDistance, null).", + "id": "script-api:dw/catalog/StoreMgr#searchStoresByPostalCode", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "countryCode", + "type": "string" + }, + { + "name": "postalCode", + "type": "string" + }, + { + "name": "distanceUnit", + "type": "string" + }, + { + "name": "maxDistance", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.searchStoresByPostalCode", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Convenience method. Same as searchStoresByPostalCode(countryCode, postalCode, distanceUnit, maxDistance, null).", + "heading": "Description" + } + ], + "signature": "static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number): LinkedHashMap", + "source": "script-api", + "tags": [ + "searchstoresbypostalcode", + "storemgr.searchstoresbypostalcode" + ], + "title": "StoreMgr.searchStoresByPostalCode" + }, + { + "description": "Set the store id for the current session. The store id is also saved on the cookie with the cookie name \"dw_store\" with no expiration time. Null is allowed to remove store id from session, when null is passed in, the cookie will be removed when browser exits.", + "id": "script-api:dw/catalog/StoreMgr#setStoreIDToSession", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.setStoreIDToSession", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the store id for the current session. The store id is also saved on the cookie with the cookie name\n\"dw_store\" with no expiration time. Null is allowed to remove store id from session, when null is passed in, the\ncookie will be removed when browser exits.", + "heading": "Description" + } + ], + "signature": "static setStoreIDToSession(storeID: string): void", + "source": "script-api", + "tags": [ + "setstoreidtosession", + "storemgr.setstoreidtosession" + ], + "title": "StoreMgr.setStoreIDToSession" + }, + { + "description": "Set the store id for the current session. The store id is also saved on the cookie with the cookie name \"dw_store\" with no expiration time. Null is allowed to remove store id from session, when null is passed in, the cookie will be removed when browser exits.", + "id": "script-api:dw/catalog/StoreMgr#setStoreIDToSession", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "storeID", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.setStoreIDToSession", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the store id for the current session. The store id is also saved on the cookie with the cookie name\n\"dw_store\" with no expiration time. Null is allowed to remove store id from session, when null is passed in, the\ncookie will be removed when browser exits.", + "heading": "Description" + } + ], + "signature": "static setStoreIDToSession(storeID: string): void", + "source": "script-api", + "tags": [ + "setstoreidtosession", + "storemgr.setstoreidtosession" + ], + "title": "StoreMgr.setStoreIDToSession" + }, + { + "description": "Get the store id associated with the current session. By default, the session store id is null.", + "id": "script-api:dw/catalog/StoreMgr#storeIDFromSession", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.storeIDFromSession", + "sections": [ + { + "body": "Get the store id associated with the current session. By default, the session store id is null.", + "heading": "Description" + } + ], + "signature": "static readonly storeIDFromSession: string | null", + "source": "script-api", + "tags": [ + "storeidfromsession", + "storemgr.storeidfromsession" + ], + "title": "StoreMgr.storeIDFromSession" + }, + { + "description": "Get the store id associated with the current session. By default, the session store id is null.", + "id": "script-api:dw/catalog/StoreMgr#storeIDFromSession", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/StoreMgr", + "qualifiedName": "dw.catalog.StoreMgr.storeIDFromSession", + "sections": [ + { + "body": "Get the store id associated with the current session. By default, the session store id is null.", + "heading": "Description" + } + ], + "signature": "static readonly storeIDFromSession: string | null", + "source": "script-api", + "tags": [ + "storeidfromsession", + "storemgr.storeidfromsession" + ], + "title": "StoreMgr.storeIDFromSession" + }, + { + "description": "Represents a variant of a product variation. If the variant does not define an own value, the value is retrieved by fallback from variation groups (sorted by their position) or the variation master.", + "id": "script-api:dw/catalog/Variant", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.Variant", + "sections": [ + { + "body": "Represents a variant of a product variation. If the variant does not define an own value,\nthe value is retrieved by fallback from variation groups (sorted by their position) or the\nvariation master.", + "heading": "Description" + }, + { + "body": "Extends `Product`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "variant", + "dw.catalog.variant", + "dw/catalog" + ], + "title": "Variant" + }, + { + "description": "Returns the EAN of the product variant.", + "id": "script-api:dw/catalog/Variant#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.EAN", + "sections": [ + { + "body": "Returns the EAN of the product variant.\n\nIf the variant does not define an own value for 'EAN', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'EAN', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly EAN: string", + "source": "script-api", + "tags": [ + "ean", + "variant.ean" + ], + "title": "Variant.EAN" + }, + { + "description": "Returns the UPC of the product variant.", + "id": "script-api:dw/catalog/Variant#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.UPC", + "sections": [ + { + "body": "Returns the UPC of the product variant.\n\nIf the variant does not define an own value for 'UPC', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'UPC', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly UPC: string", + "source": "script-api", + "tags": [ + "upc", + "variant.upc" + ], + "title": "Variant.UPC" + }, + { + "description": "Returns all product links of the product variant.", + "id": "script-api:dw/catalog/Variant#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.allProductLinks", + "sections": [ + { + "body": "Returns all product links of the product variant.\n\nIf the variant does not define any product links, the product links are retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define any product links, the product links are\nretrieved from the master product.", + "heading": "Description" + } + ], + "signature": "readonly allProductLinks: Collection", + "source": "script-api", + "tags": [ + "allproductlinks", + "variant.allproductlinks" + ], + "title": "Variant.allProductLinks" + }, + { + "description": "Returns the brand of the product variant.", + "id": "script-api:dw/catalog/Variant#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.brand", + "sections": [ + { + "body": "Returns the brand of the product variant.\n\nIf the variant does not define an own value for 'brand', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'brand', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly brand: string", + "source": "script-api", + "tags": [ + "brand", + "variant.brand" + ], + "title": "Variant.brand" + }, + { + "description": "Returns the classification category of the product variant.", + "id": "script-api:dw/catalog/Variant#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.classificationCategory", + "sections": [ + { + "body": "Returns the classification category of the product variant.\n\nPlease note that the classification category is always inherited\nfrom the master and cannot be overridden by the variant.", + "heading": "Description" + } + ], + "signature": "readonly classificationCategory: Category", + "source": "script-api", + "tags": [ + "classificationcategory", + "variant.classificationcategory" + ], + "title": "Variant.classificationCategory" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getAllProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "description": "Returns all product links of the product variant.", + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the product variant.\n\nIf the variant does not define any product links, the product links are retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define any product links, the product links are\nretrieved from the master product.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getAllProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "description": "Returns all product links of the specified type of the product variant.", + "id": "script-api:dw/catalog/Variant#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the specified type of the product variant.\n\nIf the variant does not define any product links of the specified type,\nthe product links are retrieved for the specified type from the assigned\nvariation groups, sorted by their position.\n\nIf none of the variation groups define any product links of the specified type,\nthe product links are retrieved for the specified type from the master product.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variant.getallproductlinks" + ], + "title": "Variant.getAllProductLinks" + }, + { + "description": "Returns the brand of the product variant.", + "id": "script-api:dw/catalog/Variant#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getBrand", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the brand of the product variant.\n\nIf the variant does not define an own value for 'brand', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'brand', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getBrand(): string", + "source": "script-api", + "tags": [ + "getbrand", + "variant.getbrand" + ], + "title": "Variant.getBrand" + }, + { + "description": "Returns the classification category of the product variant.", + "id": "script-api:dw/catalog/Variant#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getClassificationCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the classification category of the product variant.\n\nPlease note that the classification category is always inherited\nfrom the master and cannot be overridden by the variant.", + "heading": "Description" + } + ], + "signature": "getClassificationCategory(): Category", + "source": "script-api", + "tags": [ + "getclassificationcategory", + "variant.getclassificationcategory" + ], + "title": "Variant.getClassificationCategory" + }, + { + "description": "Returns the EAN of the product variant.", + "id": "script-api:dw/catalog/Variant#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getEAN", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the EAN of the product variant.\n\nIf the variant does not define an own value for 'EAN', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'EAN', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getEAN(): string", + "source": "script-api", + "tags": [ + "getean", + "variant.getean" + ], + "title": "Variant.getEAN" + }, + { + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "returns": { + "type": "MediaFile | null" + }, + "signature": "getImage(viewtype: string, index: number): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "returns": { + "type": "MediaFile | null" + }, + "signature": "getImage(viewtype: string): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "description": "Returns the image of the product variant.", + "id": "script-api:dw/catalog/Variant#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the image of the product variant.\n\nIf the variant does not define an own value for 'image', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'image', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "variant.getimage" + ], + "title": "Variant.getImage" + }, + { + "description": "Returns the long description of the product variant.", + "id": "script-api:dw/catalog/Variant#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getLongDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the long description of the product variant.\n\nIf the variant does not define an own value for 'longDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'longDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getLongDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getlongdescription", + "variant.getlongdescription" + ], + "title": "Variant.getLongDescription" + }, + { + "description": "Returns the manufacturer name of the product variant.", + "id": "script-api:dw/catalog/Variant#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getManufacturerName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the manufacturer name of the product variant.\n\nIf the variant does not define an own value for 'manufacturerName', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'manufacturerName', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getManufacturerName(): string", + "source": "script-api", + "tags": [ + "getmanufacturername", + "variant.getmanufacturername" + ], + "title": "Variant.getManufacturerName" + }, + { + "description": "Returns the manufacturer sku of the product variant.", + "id": "script-api:dw/catalog/Variant#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getManufacturerSKU", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the manufacturer sku of the product variant.\n\nIf the variant does not define an own value for 'manufacturerSKU', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'manufacturerSKU', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getManufacturerSKU(): string", + "source": "script-api", + "tags": [ + "getmanufacturersku", + "variant.getmanufacturersku" + ], + "title": "Variant.getManufacturerSKU" + }, + { + "description": "Returns the ProductMaster for this mastered product.", + "id": "script-api:dw/catalog/Variant#getMasterProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getMasterProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the ProductMaster for this mastered product.", + "heading": "Description" + } + ], + "signature": "getMasterProduct(): Product", + "source": "script-api", + "tags": [ + "getmasterproduct", + "variant.getmasterproduct" + ], + "title": "Variant.getMasterProduct" + }, + { + "description": "Returns the name of the product variant.", + "id": "script-api:dw/catalog/Variant#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the product variant.\n\nIf the variant does not define an own value for 'name', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'name', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "variant.getname" + ], + "title": "Variant.getName" + }, + { + "description": "Returns the onlineFrom date of the product variant.", + "id": "script-api:dw/catalog/Variant#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getOnlineFrom", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the onlineFrom date of the product variant.\n\nIf the variant does not define an own value for 'onlineFrom', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'onlineFrom', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date", + "source": "script-api", + "tags": [ + "getonlinefrom", + "variant.getonlinefrom" + ], + "title": "Variant.getOnlineFrom" + }, + { + "description": "Returns the onlineTo date of the product variant.", + "id": "script-api:dw/catalog/Variant#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getOnlineTo", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the onlineTo date of the product variant.\n\nIf the variant does not define an own value for 'onlineTo', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'onlineTo', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date", + "source": "script-api", + "tags": [ + "getonlineto", + "variant.getonlineto" + ], + "title": "Variant.getOnlineTo" + }, + { + "description": "Returns the pageDescription of the product variant.", + "id": "script-api:dw/catalog/Variant#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageDescription of the product variant.\n\nIf the variant does not define an own value for 'pageDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string", + "source": "script-api", + "tags": [ + "getpagedescription", + "variant.getpagedescription" + ], + "title": "Variant.getPageDescription" + }, + { + "description": "Returns the pageKeywords of the product variant.", + "id": "script-api:dw/catalog/Variant#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageKeywords", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageKeywords of the product variant.\n\nIf the variant does not define an own value for 'pageKeywords', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageKeywords', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string", + "source": "script-api", + "tags": [ + "getpagekeywords", + "variant.getpagekeywords" + ], + "title": "Variant.getPageKeywords" + }, + { + "description": "Returns the pageTitle of the product variant.", + "id": "script-api:dw/catalog/Variant#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageTitle of the product variant.\n\nIf the variant does not define an own value for 'pageTitle', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageTitle', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string", + "source": "script-api", + "tags": [ + "getpagetitle", + "variant.getpagetitle" + ], + "title": "Variant.getPageTitle" + }, + { + "description": "Returns the pageURL of the product variant.", + "id": "script-api:dw/catalog/Variant#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getPageURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageURL of the product variant.\n\nIf the variant does not define an own value for 'pageURL', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageURL', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string", + "source": "script-api", + "tags": [ + "getpageurl", + "variant.getpageurl" + ], + "title": "Variant.getPageURL" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "description": "Returns all product links of the product variant for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the product variant for which the target\nproduct is assigned to the current site catalog.\n\nIf the variant does not define any product links, the product links are retrieved\nfrom the assigned variation groups, sorted by their position\n\nIf none of the variation groups define any product links, the product links are retrieved\nfrom the master product.", + "heading": "Description" + } + ], + "signature": "getProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "description": "Returns all product links of the specified type of the product variant for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/Variant#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the specified type of the product variant\nfor which the target product is assigned to the current site catalog.\n\nIf the variant does not define any product links of the specified type,\nthe product links are retrieved for the specified type from the assigned\nvariation groups, sorted by their position\n\nIf none of the variation groups define any product links of the specified type,\nthe product links are retrieved for the specified type from the master product.", + "heading": "Description" + } + ], + "signature": "getProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variant.getproductlinks" + ], + "title": "Variant.getProductLinks" + }, + { + "id": "script-api:dw/catalog/Variant#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getRecommendations", + "returns": { + "type": "Collection" + }, + "signature": "getRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "variant.getrecommendations" + ], + "title": "Variant.getRecommendations" + }, + { + "description": "Retrieve the sorted collection of recommendations of the specified type for this product variant. The types (cross-sell, up-sell, etc) are enumerated in the `dw.catalog.Recommendation` class. Only recommendations which are stored in the current site catalog are returned. Furthermore, a recommendation is only returned if the target of the recommendation is assigned to the current site catalog.", + "id": "script-api:dw/catalog/Variant#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve the sorted collection of recommendations of the specified type\nfor this product variant. The types (cross-sell, up-sell, etc) are\nenumerated in the `dw.catalog.Recommendation` class. Only\nrecommendations which are stored in the current site catalog are returned.\nFurthermore, a recommendation is only returned if the target of the\nrecommendation is assigned to the current site catalog.\n\nIf the variant does not define any recommendations, recommendations are\nretrieved from the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define any recommendations, the recommendations\nof the master are returned.", + "heading": "Description" + } + ], + "signature": "getRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "variant.getrecommendations" + ], + "title": "Variant.getRecommendations" + }, + { + "description": "Returns the short description of the product variant.", + "id": "script-api:dw/catalog/Variant#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getShortDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the short description of the product variant.\n\nIf the variant does not define an own value for 'shortDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'shortDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getShortDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getshortdescription", + "variant.getshortdescription" + ], + "title": "Variant.getShortDescription" + }, + { + "description": "Returns the tax class id of the product variant.", + "id": "script-api:dw/catalog/Variant#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tax class id of the product variant.\n\nIf the variant does not define an own value for 'taxClassID', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'taxClassID', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxclassid", + "variant.gettaxclassid" + ], + "title": "Variant.getTaxClassID" + }, + { + "description": "Returns the rendering template name of the product variant.", + "id": "script-api:dw/catalog/Variant#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the rendering template name of the product variant.\n\nIf the variant does not define an own value for 'template', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'template', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "variant.gettemplate" + ], + "title": "Variant.getTemplate" + }, + { + "description": "Returns the thumbnail image of the product variant.", + "id": "script-api:dw/catalog/Variant#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getThumbnail", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the thumbnail image of the product variant.\n\nIf the variant does not define an own value for 'thumbnail', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'thumbnail', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getThumbnail(): MediaFile", + "source": "script-api", + "tags": [ + "getthumbnail", + "variant.getthumbnail" + ], + "title": "Variant.getThumbnail" + }, + { + "description": "Returns the UPC of the product variant.", + "id": "script-api:dw/catalog/Variant#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUPC", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the UPC of the product variant.\n\nIf the variant does not define an own value for 'UPC', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'UPC', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUPC(): string", + "source": "script-api", + "tags": [ + "getupc", + "variant.getupc" + ], + "title": "Variant.getUPC" + }, + { + "description": "Returns the sales unit of the product variant as defined by the master product.", + "id": "script-api:dw/catalog/Variant#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUnit", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the sales unit of the product variant as defined by the\nmaster product.\n\nIf the variant does not define an own value for 'unit', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'unit', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUnit(): string", + "source": "script-api", + "tags": [ + "getunit", + "variant.getunit" + ], + "title": "Variant.getUnit" + }, + { + "description": "Returns the unitQuantity of the product variant as defined by the master product.", + "id": "script-api:dw/catalog/Variant#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.getUnitQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the unitQuantity of the product variant as defined by the\nmaster product.\n\nIf the variant does not define an own value for 'unitQuantity', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'unitQuantity', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUnitQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getunitquantity", + "variant.getunitquantity" + ], + "title": "Variant.getUnitQuantity" + }, + { + "description": "Returns the image of the product variant.", + "id": "script-api:dw/catalog/Variant#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.image", + "sections": [ + { + "body": "Returns the image of the product variant.\n\nIf the variant does not define an own value for 'image', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'image', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "variant.image" + ], + "title": "Variant.image" + }, + { + "description": "Returns 'true' if the variant has any options, otherwise 'false'. Method also returns 'true' if the variant has not any options, but the related variation groups (sorted by position) or master product has options.", + "id": "script-api:dw/catalog/Variant#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.isOptionProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the variant has any options, otherwise 'false'.\nMethod also returns 'true' if the variant has not any options,\nbut the related variation groups (sorted by position) or\nmaster product has options.", + "heading": "Description" + } + ], + "signature": "isOptionProduct(): boolean", + "source": "script-api", + "tags": [ + "isoptionproduct", + "variant.isoptionproduct" + ], + "title": "Variant.isOptionProduct" + }, + { + "description": "Returns the long description of the product variant.", + "id": "script-api:dw/catalog/Variant#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.longDescription", + "sections": [ + { + "body": "Returns the long description of the product variant.\n\nIf the variant does not define an own value for 'longDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'longDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly longDescription: MarkupText", + "source": "script-api", + "tags": [ + "longdescription", + "variant.longdescription" + ], + "title": "Variant.longDescription" + }, + { + "description": "Returns the manufacturer name of the product variant.", + "id": "script-api:dw/catalog/Variant#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.manufacturerName", + "sections": [ + { + "body": "Returns the manufacturer name of the product variant.\n\nIf the variant does not define an own value for 'manufacturerName', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'manufacturerName', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerName: string", + "source": "script-api", + "tags": [ + "manufacturername", + "variant.manufacturername" + ], + "title": "Variant.manufacturerName" + }, + { + "description": "Returns the manufacturer sku of the product variant.", + "id": "script-api:dw/catalog/Variant#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.manufacturerSKU", + "sections": [ + { + "body": "Returns the manufacturer sku of the product variant.\n\nIf the variant does not define an own value for 'manufacturerSKU', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'manufacturerSKU', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerSKU: string", + "source": "script-api", + "tags": [ + "manufacturersku", + "variant.manufacturersku" + ], + "title": "Variant.manufacturerSKU" + }, + { + "description": "Returns the ProductMaster for this mastered product.", + "id": "script-api:dw/catalog/Variant#masterProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.masterProduct", + "sections": [ + { + "body": "Returns the ProductMaster for this mastered product.", + "heading": "Description" + } + ], + "signature": "readonly masterProduct: Product", + "source": "script-api", + "tags": [ + "masterproduct", + "variant.masterproduct" + ], + "title": "Variant.masterProduct" + }, + { + "description": "Returns the name of the product variant.", + "id": "script-api:dw/catalog/Variant#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.name", + "sections": [ + { + "body": "Returns the name of the product variant.\n\nIf the variant does not define an own value for 'name', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'name', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "variant.name" + ], + "title": "Variant.name" + }, + { + "description": "Returns the onlineFrom date of the product variant.", + "id": "script-api:dw/catalog/Variant#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.onlineFrom", + "sections": [ + { + "body": "Returns the onlineFrom date of the product variant.\n\nIf the variant does not define an own value for 'onlineFrom', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'onlineFrom', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date", + "source": "script-api", + "tags": [ + "onlinefrom", + "variant.onlinefrom" + ], + "title": "Variant.onlineFrom" + }, + { + "description": "Returns the onlineTo date of the product variant.", + "id": "script-api:dw/catalog/Variant#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.onlineTo", + "sections": [ + { + "body": "Returns the onlineTo date of the product variant.\n\nIf the variant does not define an own value for 'onlineTo', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'onlineTo', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date", + "source": "script-api", + "tags": [ + "onlineto", + "variant.onlineto" + ], + "title": "Variant.onlineTo" + }, + { + "description": "Returns 'true' if the variant has any options, otherwise 'false'. Method also returns 'true' if the variant has not any options, but the related variation groups (sorted by position) or master product has options.", + "id": "script-api:dw/catalog/Variant#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.optionProduct", + "sections": [ + { + "body": "Returns 'true' if the variant has any options, otherwise 'false'.\nMethod also returns 'true' if the variant has not any options,\nbut the related variation groups (sorted by position) or\nmaster product has options.", + "heading": "Description" + } + ], + "signature": "readonly optionProduct: boolean", + "source": "script-api", + "tags": [ + "optionproduct", + "variant.optionproduct" + ], + "title": "Variant.optionProduct" + }, + { + "description": "Returns the pageDescription of the product variant.", + "id": "script-api:dw/catalog/Variant#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageDescription", + "sections": [ + { + "body": "Returns the pageDescription of the product variant.\n\nIf the variant does not define an own value for 'pageDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string", + "source": "script-api", + "tags": [ + "pagedescription", + "variant.pagedescription" + ], + "title": "Variant.pageDescription" + }, + { + "description": "Returns the pageKeywords of the product variant.", + "id": "script-api:dw/catalog/Variant#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageKeywords", + "sections": [ + { + "body": "Returns the pageKeywords of the product variant.\n\nIf the variant does not define an own value for 'pageKeywords', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageKeywords', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string", + "source": "script-api", + "tags": [ + "pagekeywords", + "variant.pagekeywords" + ], + "title": "Variant.pageKeywords" + }, + { + "description": "Returns the pageTitle of the product variant.", + "id": "script-api:dw/catalog/Variant#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageTitle", + "sections": [ + { + "body": "Returns the pageTitle of the product variant.\n\nIf the variant does not define an own value for 'pageTitle', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageTitle', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string", + "source": "script-api", + "tags": [ + "pagetitle", + "variant.pagetitle" + ], + "title": "Variant.pageTitle" + }, + { + "description": "Returns the pageURL of the product variant.", + "id": "script-api:dw/catalog/Variant#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.pageURL", + "sections": [ + { + "body": "Returns the pageURL of the product variant.\n\nIf the variant does not define an own value for 'pageURL', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'pageURL', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string", + "source": "script-api", + "tags": [ + "pageurl", + "variant.pageurl" + ], + "title": "Variant.pageURL" + }, + { + "description": "Returns all product links of the product variant for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/Variant#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.productLinks", + "sections": [ + { + "body": "Returns all product links of the product variant for which the target\nproduct is assigned to the current site catalog.\n\nIf the variant does not define any product links, the product links are retrieved\nfrom the assigned variation groups, sorted by their position\n\nIf none of the variation groups define any product links, the product links are retrieved\nfrom the master product.", + "heading": "Description" + } + ], + "signature": "readonly productLinks: Collection", + "source": "script-api", + "tags": [ + "productlinks", + "variant.productlinks" + ], + "title": "Variant.productLinks" + }, + { + "description": "Returns the short description of the product variant.", + "id": "script-api:dw/catalog/Variant#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.shortDescription", + "sections": [ + { + "body": "Returns the short description of the product variant.\n\nIf the variant does not define an own value for 'shortDescription', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'shortDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly shortDescription: MarkupText", + "source": "script-api", + "tags": [ + "shortdescription", + "variant.shortdescription" + ], + "title": "Variant.shortDescription" + }, + { + "description": "Returns the tax class id of the product variant.", + "id": "script-api:dw/catalog/Variant#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.taxClassID", + "sections": [ + { + "body": "Returns the tax class id of the product variant.\n\nIf the variant does not define an own value for 'taxClassID', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'taxClassID', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly taxClassID: string", + "source": "script-api", + "tags": [ + "taxclassid", + "variant.taxclassid" + ], + "title": "Variant.taxClassID" + }, + { + "description": "Returns the rendering template name of the product variant.", + "id": "script-api:dw/catalog/Variant#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.template", + "sections": [ + { + "body": "Returns the rendering template name of the product variant.\n\nIf the variant does not define an own value for 'template', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'template', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "variant.template" + ], + "title": "Variant.template" + }, + { + "description": "Returns the thumbnail image of the product variant.", + "id": "script-api:dw/catalog/Variant#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.thumbnail", + "sections": [ + { + "body": "Returns the thumbnail image of the product variant.\n\nIf the variant does not define an own value for 'thumbnail', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'thumbnail', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly thumbnail: MediaFile", + "source": "script-api", + "tags": [ + "thumbnail", + "variant.thumbnail" + ], + "title": "Variant.thumbnail" + }, + { + "description": "Returns the sales unit of the product variant as defined by the master product.", + "id": "script-api:dw/catalog/Variant#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.unit", + "sections": [ + { + "body": "Returns the sales unit of the product variant as defined by the\nmaster product.\n\nIf the variant does not define an own value for 'unit', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'unit', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly unit: string", + "source": "script-api", + "tags": [ + "unit", + "variant.unit" + ], + "title": "Variant.unit" + }, + { + "description": "Returns the unitQuantity of the product variant as defined by the master product.", + "id": "script-api:dw/catalog/Variant#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/Variant", + "qualifiedName": "dw.catalog.Variant.unitQuantity", + "sections": [ + { + "body": "Returns the unitQuantity of the product variant as defined by the\nmaster product.\n\nIf the variant does not define an own value for 'unitQuantity', the value is retrieved\nfrom the assigned variation groups, sorted by their position.\n\nIf none of the variation groups define a value for 'unitQuantity', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly unitQuantity: Quantity", + "source": "script-api", + "tags": [ + "unitquantity", + "variant.unitquantity" + ], + "title": "Variant.unitQuantity" + }, + { + "description": "Class representing a group of variants within a master product who share a common value for one or more variation attribute values. Variation groups are used to simplify merchandising of products.", + "id": "script-api:dw/catalog/VariationGroup", + "kind": "class", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog", + "qualifiedName": "dw.catalog.VariationGroup", + "sections": [ + { + "body": "Class representing a group of variants within a master product who share a\ncommon value for one or more variation attribute values. Variation groups are\nused to simplify merchandising of products.\n\nFrom a more technical perspective, variation groups are defined by two things:\n\n- A relation to a master product.\n- A set of variation attributes which have fixed values.\n\nA variant of the related master product is considered in the group if and\nonly if it matches on the fixed variation attribute values.\n\nSimilar to a Variant, a VariationGroup does a fallback to the master product\nfor all attributes (name, description, etc) and relations (recommendations,\netc).", + "heading": "Description" + }, + { + "body": "Extends `Product`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "variationgroup", + "dw.catalog.variationgroup", + "dw/catalog" + ], + "title": "VariationGroup" + }, + { + "description": "Returns the EAN of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#EAN", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.EAN", + "sections": [ + { + "body": "Returns the EAN of the product variation group.\n\nIf the variation group does not define an own value for 'EAN', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly EAN: string", + "source": "script-api", + "tags": [ + "ean", + "variationgroup.ean" + ], + "title": "VariationGroup.EAN" + }, + { + "description": "Returns the UPC of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#UPC", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.UPC", + "sections": [ + { + "body": "Returns the UPC of the product variation group.\n\nIf the variation group does not define an own value for 'UPC', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly UPC: string", + "source": "script-api", + "tags": [ + "upc", + "variationgroup.upc" + ], + "title": "VariationGroup.UPC" + }, + { + "description": "Returns all product links of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#allProductLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.allProductLinks", + "sections": [ + { + "body": "Returns all product links of the product variation group.\n\nIf the variation group does not define any product links, but the master product\ndoes, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "readonly allProductLinks: Collection", + "source": "script-api", + "tags": [ + "allproductlinks", + "variationgroup.allproductlinks" + ], + "title": "VariationGroup.allProductLinks" + }, + { + "description": "Returns the brand of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#brand", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.brand", + "sections": [ + { + "body": "Returns the brand of the product variation group.\n\nIf the variation group does not define an own value for 'brand', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly brand: string", + "source": "script-api", + "tags": [ + "brand", + "variationgroup.brand" + ], + "title": "VariationGroup.brand" + }, + { + "description": "Returns the classification category of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#classificationCategory", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.classificationCategory", + "sections": [ + { + "body": "Returns the classification category of the product variation group.\n\nPlease note that the classification category is always inherited\nfrom the master and cannot be overridden by the variation group.", + "heading": "Description" + } + ], + "signature": "readonly classificationCategory: Category", + "source": "script-api", + "tags": [ + "classificationcategory", + "variationgroup.classificationcategory" + ], + "title": "VariationGroup.classificationCategory" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getAllProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "description": "Returns all product links of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the product variation group.\n\nIf the variation group does not define any product links, but the master product\ndoes, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getAllProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "description": "Returns all product links of the specified type of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getAllProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getAllProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the specified type of the product variation group.\n\nIf the variation group does not define any product links, but the master product\ndoes, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "getAllProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getallproductlinks", + "variationgroup.getallproductlinks" + ], + "title": "VariationGroup.getAllProductLinks" + }, + { + "description": "Returns the brand of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getBrand", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getBrand", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the brand of the product variation group.\n\nIf the variation group does not define an own value for 'brand', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getBrand(): string", + "source": "script-api", + "tags": [ + "getbrand", + "variationgroup.getbrand" + ], + "title": "VariationGroup.getBrand" + }, + { + "description": "Returns the classification category of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getClassificationCategory", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getClassificationCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "Returns the classification category of the product variation group.\n\nPlease note that the classification category is always inherited\nfrom the master and cannot be overridden by the variation group.", + "heading": "Description" + } + ], + "signature": "getClassificationCategory(): Category", + "source": "script-api", + "tags": [ + "getclassificationcategory", + "variationgroup.getclassificationcategory" + ], + "title": "VariationGroup.getClassificationCategory" + }, + { + "description": "Returns the EAN of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getEAN", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getEAN", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the EAN of the product variation group.\n\nIf the variation group does not define an own value for 'EAN', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getEAN(): string", + "source": "script-api", + "tags": [ + "getean", + "variationgroup.getean" + ], + "title": "VariationGroup.getEAN" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + }, + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "returns": { + "type": "MediaFile | null" + }, + "signature": "getImage(viewtype: string, index: number): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "viewtype", + "type": "string" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "returns": { + "type": "MediaFile | null" + }, + "signature": "getImage(viewtype: string): MediaFile | null", + "source": "script-api", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "description": "Returns the image of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getImage", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the image of the product variation group.\n\nIf the variation group does not define an own value for 'image', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "variationgroup.getimage" + ], + "title": "VariationGroup.getImage" + }, + { + "description": "Returns the long description of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getLongDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getLongDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the long description of the product variation group.\n\nIf the variation group does not define an own value for 'longDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getLongDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getlongdescription", + "variationgroup.getlongdescription" + ], + "title": "VariationGroup.getLongDescription" + }, + { + "description": "Returns the manufacturer name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getManufacturerName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getManufacturerName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the manufacturer name of the product variation group.\n\nIf the variation group does not define an own value for 'manufacturerName', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getManufacturerName(): string", + "source": "script-api", + "tags": [ + "getmanufacturername", + "variationgroup.getmanufacturername" + ], + "title": "VariationGroup.getManufacturerName" + }, + { + "description": "Returns the manufacturer sku of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getManufacturerSKU", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the manufacturer sku of the product variation group.\n\nIf the variation group does not define an own value for 'manufacturerSKU', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getManufacturerSKU(): string", + "source": "script-api", + "tags": [ + "getmanufacturersku", + "variationgroup.getmanufacturersku" + ], + "title": "VariationGroup.getManufacturerSKU" + }, + { + "description": "Returns the ProductMaster for this mastered product.", + "id": "script-api:dw/catalog/VariationGroup#getMasterProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getMasterProduct", + "returns": { + "type": "Product" + }, + "sections": [ + { + "body": "Returns the ProductMaster for this mastered product.", + "heading": "Description" + } + ], + "signature": "getMasterProduct(): Product", + "source": "script-api", + "tags": [ + "getmasterproduct", + "variationgroup.getmasterproduct" + ], + "title": "VariationGroup.getMasterProduct" + }, + { + "description": "Returns the name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getName", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the product variation group.\n\nIf the variation group does not define an own value for 'name', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "variationgroup.getname" + ], + "title": "VariationGroup.getName" + }, + { + "description": "Returns the onlineFrom date of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getOnlineFrom", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getOnlineFrom", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the onlineFrom date of the product variation group.\n\nIf the variation group does not define an own value for 'onlineFrom', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getOnlineFrom(): Date", + "source": "script-api", + "tags": [ + "getonlinefrom", + "variationgroup.getonlinefrom" + ], + "title": "VariationGroup.getOnlineFrom" + }, + { + "description": "Returns the onlineTo date of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getOnlineTo", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getOnlineTo", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the onlineTo date of the product variation group.\n\nIf the variation group does not define an own value for 'onlineTo', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getOnlineTo(): Date", + "source": "script-api", + "tags": [ + "getonlineto", + "variationgroup.getonlineto" + ], + "title": "VariationGroup.getOnlineTo" + }, + { + "description": "Returns the pageDescription of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getPageDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageDescription of the product variation group.\n\nIf the variation group does not define an own value for 'pageDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string", + "source": "script-api", + "tags": [ + "getpagedescription", + "variationgroup.getpagedescription" + ], + "title": "VariationGroup.getPageDescription" + }, + { + "description": "Returns the pageKeywords of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getPageKeywords", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageKeywords", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageKeywords of the product variation group.\n\nIf the variation group does not define an own value for 'pageKeywords', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string", + "source": "script-api", + "tags": [ + "getpagekeywords", + "variationgroup.getpagekeywords" + ], + "title": "VariationGroup.getPageKeywords" + }, + { + "description": "Returns the pageTitle of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getPageTitle", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageTitle of the product variation group.\n\nIf the variation group does not define an own value for 'pageTitle', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string", + "source": "script-api", + "tags": [ + "getpagetitle", + "variationgroup.getpagetitle" + ], + "title": "VariationGroup.getPageTitle" + }, + { + "description": "Returns the pageURL of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getPageURL", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getPageURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the pageURL of the product variation group.\n\nIf the variation group does not define an own value for 'pageURL', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string", + "source": "script-api", + "tags": [ + "getpageurl", + "variationgroup.getpageurl" + ], + "title": "VariationGroup.getPageURL" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "description": "Returns all product links of the product variation group for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the product variation group for which the target\nproduct is assigned to the current site catalog.\n\nIf the variation group does not define any product links, but the master product\ndoes, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "getProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "returns": { + "type": "Collection" + }, + "signature": "getProductLinks(): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "description": "Returns all product links of the specified type of the product variation group for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/VariationGroup#getProductLinks", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getProductLinks", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product links of the specified type of the product variation group\nfor which the target product is assigned to the current site catalog.\n\nIf the variation group does not define any product links of the specified type,\nbut the master product does, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "getProductLinks(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlinks", + "variationgroup.getproductlinks" + ], + "title": "VariationGroup.getProductLinks" + }, + { + "id": "script-api:dw/catalog/VariationGroup#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getRecommendations", + "returns": { + "type": "Collection" + }, + "signature": "getRecommendations(): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "variationgroup.getrecommendations" + ], + "title": "VariationGroup.getRecommendations" + }, + { + "description": "Retrieve the sorted collection of recommendations of the specified type for this product variation group. The types (cross-sell, up-sell, etc) are enumerated in the `dw.catalog.Recommendation` class. Only recommendations which are stored in the current site catalog are returned. Furthermore, a recommendation is only returned if the target of the recommendation is assigned to the current site catalog.", + "id": "script-api:dw/catalog/VariationGroup#getRecommendations", + "kind": "method", + "packagePath": "dw/catalog", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getRecommendations", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve the sorted collection of recommendations of the specified type\nfor this product variation group. The types (cross-sell, up-sell, etc) are\nenumerated in the `dw.catalog.Recommendation` class. Only\nrecommendations which are stored in the current site catalog are returned.\nFurthermore, a recommendation is only returned if the target of the\nrecommendation is assigned to the current site catalog.\n\nIf the variation group does not define any recommendations, but the master\nproduct does, the recommendations of the master are returned.", + "heading": "Description" + } + ], + "signature": "getRecommendations(type: number): Collection", + "source": "script-api", + "tags": [ + "getrecommendations", + "variationgroup.getrecommendations" + ], + "title": "VariationGroup.getRecommendations" + }, + { + "description": "Returns the short description of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getShortDescription", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getShortDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the short description of the product variation group.\n\nIf the variation group does not define an own value for 'shortDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getShortDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getshortdescription", + "variationgroup.getshortdescription" + ], + "title": "VariationGroup.getShortDescription" + }, + { + "description": "Returns the tax class id of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getTaxClassID", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tax class id of the product variation group.\n\nIf the variation group does not define an own value for 'taxClassID', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxclassid", + "variationgroup.gettaxclassid" + ], + "title": "VariationGroup.getTaxClassID" + }, + { + "description": "Returns the rendering template name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getTemplate", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the rendering template name of the product variation group.\n\nIf the variation group does not define an own value for 'template', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "variationgroup.gettemplate" + ], + "title": "VariationGroup.getTemplate" + }, + { + "description": "Returns the thumbnail image of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getThumbnail", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getThumbnail", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the thumbnail image of the product variation group.\n\nIf the variation group does not define an own value for 'thumbnailImage', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getThumbnail(): MediaFile", + "source": "script-api", + "tags": [ + "getthumbnail", + "variationgroup.getthumbnail" + ], + "title": "VariationGroup.getThumbnail" + }, + { + "description": "Returns the UPC of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#getUPC", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUPC", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the UPC of the product variation group.\n\nIf the variation group does not define an own value for 'UPC', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUPC(): string", + "source": "script-api", + "tags": [ + "getupc", + "variationgroup.getupc" + ], + "title": "VariationGroup.getUPC" + }, + { + "description": "Returns the sales unit of the product variation group as defined by the master product.", + "id": "script-api:dw/catalog/VariationGroup#getUnit", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUnit", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the sales unit of the product variation group as defined by the\nmaster product.\n\nIf the variation group does not define an own value for 'unit', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUnit(): string", + "source": "script-api", + "tags": [ + "getunit", + "variationgroup.getunit" + ], + "title": "VariationGroup.getUnit" + }, + { + "description": "Returns the unitQuantity of the product variation group as defined by the master product.", + "id": "script-api:dw/catalog/VariationGroup#getUnitQuantity", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.getUnitQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the unitQuantity of the product variation group as defined by the\nmaster product.\n\nIf the variation group does not define an own value for 'unitQuantity', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "getUnitQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getunitquantity", + "variationgroup.getunitquantity" + ], + "title": "VariationGroup.getUnitQuantity" + }, + { + "description": "Returns the image of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#image", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.image", + "sections": [ + { + "body": "Returns the image of the product variation group.\n\nIf the variation group does not define an own value for 'image', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "variationgroup.image" + ], + "title": "VariationGroup.image" + }, + { + "description": "Returns 'true' if the variation group has any options, otherwise 'false'. Method also returns 'true' if the variation group has not any options, but the related master product has options.", + "id": "script-api:dw/catalog/VariationGroup#isOptionProduct", + "kind": "method", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.isOptionProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the variation group has any options, otherwise 'false'.\nMethod also returns 'true' if the variation group has not any options,\nbut the related master product has options.", + "heading": "Description" + } + ], + "signature": "isOptionProduct(): boolean", + "source": "script-api", + "tags": [ + "isoptionproduct", + "variationgroup.isoptionproduct" + ], + "title": "VariationGroup.isOptionProduct" + }, + { + "description": "Returns the long description of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#longDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.longDescription", + "sections": [ + { + "body": "Returns the long description of the product variation group.\n\nIf the variation group does not define an own value for 'longDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly longDescription: MarkupText", + "source": "script-api", + "tags": [ + "longdescription", + "variationgroup.longdescription" + ], + "title": "VariationGroup.longDescription" + }, + { + "description": "Returns the manufacturer name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#manufacturerName", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.manufacturerName", + "sections": [ + { + "body": "Returns the manufacturer name of the product variation group.\n\nIf the variation group does not define an own value for 'manufacturerName', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerName: string", + "source": "script-api", + "tags": [ + "manufacturername", + "variationgroup.manufacturername" + ], + "title": "VariationGroup.manufacturerName" + }, + { + "description": "Returns the manufacturer sku of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#manufacturerSKU", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.manufacturerSKU", + "sections": [ + { + "body": "Returns the manufacturer sku of the product variation group.\n\nIf the variation group does not define an own value for 'manufacturerSKU', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly manufacturerSKU: string", + "source": "script-api", + "tags": [ + "manufacturersku", + "variationgroup.manufacturersku" + ], + "title": "VariationGroup.manufacturerSKU" + }, + { + "description": "Returns the ProductMaster for this mastered product.", + "id": "script-api:dw/catalog/VariationGroup#masterProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.masterProduct", + "sections": [ + { + "body": "Returns the ProductMaster for this mastered product.", + "heading": "Description" + } + ], + "signature": "readonly masterProduct: Product", + "source": "script-api", + "tags": [ + "masterproduct", + "variationgroup.masterproduct" + ], + "title": "VariationGroup.masterProduct" + }, + { + "description": "Returns the name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#name", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.name", + "sections": [ + { + "body": "Returns the name of the product variation group.\n\nIf the variation group does not define an own value for 'name', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "variationgroup.name" + ], + "title": "VariationGroup.name" + }, + { + "description": "Returns the onlineFrom date of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#onlineFrom", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.onlineFrom", + "sections": [ + { + "body": "Returns the onlineFrom date of the product variation group.\n\nIf the variation group does not define an own value for 'onlineFrom', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineFrom: Date", + "source": "script-api", + "tags": [ + "onlinefrom", + "variationgroup.onlinefrom" + ], + "title": "VariationGroup.onlineFrom" + }, + { + "description": "Returns the onlineTo date of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#onlineTo", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.onlineTo", + "sections": [ + { + "body": "Returns the onlineTo date of the product variation group.\n\nIf the variation group does not define an own value for 'onlineTo', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly onlineTo: Date", + "source": "script-api", + "tags": [ + "onlineto", + "variationgroup.onlineto" + ], + "title": "VariationGroup.onlineTo" + }, + { + "description": "Returns 'true' if the variation group has any options, otherwise 'false'. Method also returns 'true' if the variation group has not any options, but the related master product has options.", + "id": "script-api:dw/catalog/VariationGroup#optionProduct", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.optionProduct", + "sections": [ + { + "body": "Returns 'true' if the variation group has any options, otherwise 'false'.\nMethod also returns 'true' if the variation group has not any options,\nbut the related master product has options.", + "heading": "Description" + } + ], + "signature": "readonly optionProduct: boolean", + "source": "script-api", + "tags": [ + "optionproduct", + "variationgroup.optionproduct" + ], + "title": "VariationGroup.optionProduct" + }, + { + "description": "Returns the pageDescription of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#pageDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageDescription", + "sections": [ + { + "body": "Returns the pageDescription of the product variation group.\n\nIf the variation group does not define an own value for 'pageDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string", + "source": "script-api", + "tags": [ + "pagedescription", + "variationgroup.pagedescription" + ], + "title": "VariationGroup.pageDescription" + }, + { + "description": "Returns the pageKeywords of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#pageKeywords", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageKeywords", + "sections": [ + { + "body": "Returns the pageKeywords of the product variation group.\n\nIf the variation group does not define an own value for 'pageKeywords', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string", + "source": "script-api", + "tags": [ + "pagekeywords", + "variationgroup.pagekeywords" + ], + "title": "VariationGroup.pageKeywords" + }, + { + "description": "Returns the pageTitle of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#pageTitle", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageTitle", + "sections": [ + { + "body": "Returns the pageTitle of the product variation group.\n\nIf the variation group does not define an own value for 'pageTitle', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string", + "source": "script-api", + "tags": [ + "pagetitle", + "variationgroup.pagetitle" + ], + "title": "VariationGroup.pageTitle" + }, + { + "description": "Returns the pageURL of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#pageURL", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.pageURL", + "sections": [ + { + "body": "Returns the pageURL of the product variation group.\n\nIf the variation group does not define an own value for 'pageURL', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string", + "source": "script-api", + "tags": [ + "pageurl", + "variationgroup.pageurl" + ], + "title": "VariationGroup.pageURL" + }, + { + "description": "Returns all product links of the product variation group for which the target product is assigned to the current site catalog.", + "id": "script-api:dw/catalog/VariationGroup#productLinks", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.productLinks", + "sections": [ + { + "body": "Returns all product links of the product variation group for which the target\nproduct is assigned to the current site catalog.\n\nIf the variation group does not define any product links, but the master product\ndoes, the product links of the master are returned.", + "heading": "Description" + } + ], + "signature": "readonly productLinks: Collection", + "source": "script-api", + "tags": [ + "productlinks", + "variationgroup.productlinks" + ], + "title": "VariationGroup.productLinks" + }, + { + "description": "Returns the short description of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#shortDescription", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.shortDescription", + "sections": [ + { + "body": "Returns the short description of the product variation group.\n\nIf the variation group does not define an own value for 'shortDescription', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly shortDescription: MarkupText", + "source": "script-api", + "tags": [ + "shortdescription", + "variationgroup.shortdescription" + ], + "title": "VariationGroup.shortDescription" + }, + { + "description": "Returns the tax class id of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#taxClassID", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.taxClassID", + "sections": [ + { + "body": "Returns the tax class id of the product variation group.\n\nIf the variation group does not define an own value for 'taxClassID', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly taxClassID: string", + "source": "script-api", + "tags": [ + "taxclassid", + "variationgroup.taxclassid" + ], + "title": "VariationGroup.taxClassID" + }, + { + "description": "Returns the rendering template name of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#template", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.template", + "sections": [ + { + "body": "Returns the rendering template name of the product variation group.\n\nIf the variation group does not define an own value for 'template', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "variationgroup.template" + ], + "title": "VariationGroup.template" + }, + { + "description": "Returns the thumbnail image of the product variation group.", + "id": "script-api:dw/catalog/VariationGroup#thumbnail", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.thumbnail", + "sections": [ + { + "body": "Returns the thumbnail image of the product variation group.\n\nIf the variation group does not define an own value for 'thumbnailImage', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly thumbnail: MediaFile", + "source": "script-api", + "tags": [ + "thumbnail", + "variationgroup.thumbnail" + ], + "title": "VariationGroup.thumbnail" + }, + { + "description": "Returns the sales unit of the product variation group as defined by the master product.", + "id": "script-api:dw/catalog/VariationGroup#unit", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.unit", + "sections": [ + { + "body": "Returns the sales unit of the product variation group as defined by the\nmaster product.\n\nIf the variation group does not define an own value for 'unit', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly unit: string", + "source": "script-api", + "tags": [ + "unit", + "variationgroup.unit" + ], + "title": "VariationGroup.unit" + }, + { + "description": "Returns the unitQuantity of the product variation group as defined by the master product.", + "id": "script-api:dw/catalog/VariationGroup#unitQuantity", + "kind": "property", + "packagePath": "dw/catalog", + "parentId": "script-api:dw/catalog/VariationGroup", + "qualifiedName": "dw.catalog.VariationGroup.unitQuantity", + "sections": [ + { + "body": "Returns the unitQuantity of the product variation group as defined by the\nmaster product.\n\nIf the variation group does not define an own value for 'unitQuantity', the value of\nthe master product is returned.", + "heading": "Description" + } + ], + "signature": "readonly unitQuantity: Quantity", + "source": "script-api", + "tags": [ + "unitquantity", + "variationgroup.unitquantity" + ], + "title": "VariationGroup.unitQuantity" + }, + { + "description": "10 declarations", + "id": "script-api:dw/content", + "kind": "package", + "packagePath": "dw/content", + "qualifiedName": "dw.content", + "source": "script-api", + "tags": [ + "dw/content", + "dw.content" + ], + "title": "dw.content" + }, + { + "description": "Class representing a Content asset in Commerce Cloud Digital.", + "id": "script-api:dw/content/Content", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Content", + "sections": [ + { + "body": "Class representing a Content asset in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "content", + "dw.content.content", + "dw/content" + ], + "title": "Content" + }, + { + "description": "Returns the ID of the content asset.", + "id": "script-api:dw/content/Content#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.ID", + "sections": [ + { + "body": "Returns the ID of the content asset.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "content.id" + ], + "title": "Content.ID" + }, + { + "description": "Returns the Folder associated with this Content. The folder is used to determine the classification of the content.", + "id": "script-api:dw/content/Content#classificationFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.classificationFolder", + "sections": [ + { + "body": "Returns the Folder associated with this Content. The folder is\nused to determine the classification of the content.", + "heading": "Description" + } + ], + "signature": "readonly classificationFolder: Folder", + "source": "script-api", + "tags": [ + "classificationfolder", + "content.classificationfolder" + ], + "title": "Content.classificationFolder" + }, + { + "description": "Returns the description in the current locale or null.", + "id": "script-api:dw/content/Content#description", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.description", + "sections": [ + { + "body": "Returns the description in the current locale or null.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "content.description" + ], + "title": "Content.description" + }, + { + "description": "Returns all folders to which this content is assigned.", + "id": "script-api:dw/content/Content#folders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.folders", + "sections": [ + { + "body": "Returns all folders to which this content is assigned.", + "heading": "Description" + } + ], + "signature": "readonly folders: Collection", + "source": "script-api", + "tags": [ + "folders", + "content.folders" + ], + "title": "Content.folders" + }, + { + "description": "Returns the Folder associated with this Content. The folder is used to determine the classification of the content.", + "id": "script-api:dw/content/Content#getClassificationFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getClassificationFolder", + "returns": { + "type": "Folder" + }, + "sections": [ + { + "body": "Returns the Folder associated with this Content. The folder is\nused to determine the classification of the content.", + "heading": "Description" + } + ], + "signature": "getClassificationFolder(): Folder", + "source": "script-api", + "tags": [ + "getclassificationfolder", + "content.getclassificationfolder" + ], + "title": "Content.getClassificationFolder" + }, + { + "description": "Returns the description in the current locale or null.", + "id": "script-api:dw/content/Content#getDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description in the current locale or null.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "content.getdescription" + ], + "title": "Content.getDescription" + }, + { + "description": "Returns all folders to which this content is assigned.", + "id": "script-api:dw/content/Content#getFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getFolders", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all folders to which this content is assigned.", + "heading": "Description" + } + ], + "signature": "getFolders(): Collection", + "source": "script-api", + "tags": [ + "getfolders", + "content.getfolders" + ], + "title": "Content.getFolders" + }, + { + "description": "Returns the ID of the content asset.", + "id": "script-api:dw/content/Content#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the content asset.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "content.getid" + ], + "title": "Content.getID" + }, + { + "description": "Returns the name of the content asset.", + "id": "script-api:dw/content/Content#getName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the content asset.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "content.getname" + ], + "title": "Content.getName" + }, + { + "description": "Returns the online status flag of the content.", + "id": "script-api:dw/content/Content#getOnlineFlag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getOnlineFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status flag of the content.", + "heading": "Description" + } + ], + "signature": "getOnlineFlag(): boolean", + "source": "script-api", + "tags": [ + "getonlineflag", + "content.getonlineflag" + ], + "title": "Content.getOnlineFlag" + }, + { + "description": "Returns the page description for the content in the current locale or null if there is no page description.", + "id": "script-api:dw/content/Content#getPageDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page description for the content in the current locale\nor null if there is no page description.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string | null", + "source": "script-api", + "tags": [ + "getpagedescription", + "content.getpagedescription" + ], + "title": "Content.getPageDescription" + }, + { + "description": "Returns the page keywords for the content in the current locale or null if there is no page title.", + "id": "script-api:dw/content/Content#getPageKeywords", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageKeywords", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page keywords for the content in the current locale\nor null if there is no page title.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string | null", + "source": "script-api", + "tags": [ + "getpagekeywords", + "content.getpagekeywords" + ], + "title": "Content.getPageKeywords" + }, + { + "description": "Returns the page meta tag for the specified id.", + "id": "script-api:dw/content/Content#getPageMetaTag", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageMetaTag", + "returns": { + "type": "PageMetaTag | null" + }, + "sections": [ + { + "body": "Returns the page meta tag for the specified id.\n\nThe meta tag content is generated based on the content detail page meta tag context and rule.\nThe rule is obtained from the current content or inherited from the default folder,\nup to the root folder.\n\nNull will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the\ncurrent context, or if the rule resolves to an empty string.", + "heading": "Description" + } + ], + "signature": "getPageMetaTag(id: string): PageMetaTag | null", + "source": "script-api", + "tags": [ + "getpagemetatag", + "content.getpagemetatag" + ], + "title": "Content.getPageMetaTag" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/content/Content#getPageMetaTags", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageMetaTags", + "returns": { + "type": "Array" + }, + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the content detail page meta tag context and rules.\nThe rules are obtained from the current content or inherited from the default folder,\nup to the root folder.", + "heading": "Description" + } + ], + "signature": "getPageMetaTags(): Array", + "source": "script-api", + "tags": [ + "getpagemetatags", + "content.getpagemetatags" + ], + "title": "Content.getPageMetaTags" + }, + { + "description": "Returns the page title for the content in the current locale or null if there is no page title.", + "id": "script-api:dw/content/Content#getPageTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageTitle", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page title for the content in the current locale\nor null if there is no page title.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string | null", + "source": "script-api", + "tags": [ + "getpagetitle", + "content.getpagetitle" + ], + "title": "Content.getPageTitle" + }, + { + "description": "Returns the page URL for the content in the current locale or null if there is no page URL.", + "id": "script-api:dw/content/Content#getPageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getPageURL", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page URL for the content in the current locale\nor null if there is no page URL.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string | null", + "source": "script-api", + "tags": [ + "getpageurl", + "content.getpageurl" + ], + "title": "Content.getPageURL" + }, + { + "description": "Returns the online status flag of the content.", + "id": "script-api:dw/content/Content#getSearchableFlag", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSearchableFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status flag of the content.", + "heading": "Description" + } + ], + "signature": "getSearchableFlag(): boolean", + "source": "script-api", + "tags": [ + "getsearchableflag", + "content.getsearchableflag" + ], + "title": "Content.getSearchableFlag" + }, + { + "description": "Returns the contents change frequency needed for the sitemap creation.", + "id": "script-api:dw/content/Content#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapChangeFrequency", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the contents change frequency needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "getSiteMapChangeFrequency(): string", + "source": "script-api", + "tags": [ + "getsitemapchangefrequency", + "content.getsitemapchangefrequency" + ], + "title": "Content.getSiteMapChangeFrequency" + }, + { + "description": "Returns the status if the content is included into the sitemap.", + "id": "script-api:dw/content/Content#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapIncluded", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status if the content is included into the sitemap.", + "heading": "Description" + } + ], + "signature": "getSiteMapIncluded(): number", + "source": "script-api", + "tags": [ + "getsitemapincluded", + "content.getsitemapincluded" + ], + "title": "Content.getSiteMapIncluded" + }, + { + "description": "Returns the contents priority needed for the sitemap creation. If no priority is defined, the method returns 0.0.", + "id": "script-api:dw/content/Content#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getSiteMapPriority", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the contents priority needed for the sitemap creation.\nIf no priority is defined, the method returns 0.0.", + "heading": "Description" + } + ], + "signature": "getSiteMapPriority(): number", + "source": "script-api", + "tags": [ + "getsitemappriority", + "content.getsitemappriority" + ], + "title": "Content.getSiteMapPriority" + }, + { + "description": "Returns the value of attribute 'template'.", + "id": "script-api:dw/content/Content#getTemplate", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the value of attribute 'template'.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "content.gettemplate" + ], + "title": "Content.getTemplate" + }, + { + "description": "Returns the online status of the content.", + "id": "script-api:dw/content/Content#isOnline", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the online status of the content.", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "content.isonline" + ], + "title": "Content.isOnline" + }, + { + "description": "Returns if the content is a dw.experience.Page or not.", + "id": "script-api:dw/content/Content#isPage", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isPage", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns if the content is a dw.experience.Page or not.", + "heading": "Description" + } + ], + "signature": "isPage(): boolean", + "source": "script-api", + "tags": [ + "ispage", + "content.ispage" + ], + "title": "Content.isPage" + }, + { + "description": "Returns the search status of the content.", + "id": "script-api:dw/content/Content#isSearchable", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.isSearchable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the search status of the content.", + "heading": "Description" + } + ], + "signature": "isSearchable(): boolean", + "source": "script-api", + "tags": [ + "issearchable", + "content.issearchable" + ], + "title": "Content.isSearchable" + }, + { + "description": "Returns the name of the content asset.", + "id": "script-api:dw/content/Content#name", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.name", + "sections": [ + { + "body": "Returns the name of the content asset.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "content.name" + ], + "title": "Content.name" + }, + { + "description": "Returns the online status of the content.", + "id": "script-api:dw/content/Content#online", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.online", + "sections": [ + { + "body": "Returns the online status of the content.", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "content.online" + ], + "title": "Content.online" + }, + { + "description": "Returns the online status flag of the content.", + "id": "script-api:dw/content/Content#onlineFlag", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.onlineFlag", + "sections": [ + { + "body": "Returns the online status flag of the content.", + "heading": "Description" + } + ], + "signature": "readonly onlineFlag: boolean", + "source": "script-api", + "tags": [ + "onlineflag", + "content.onlineflag" + ], + "title": "Content.onlineFlag" + }, + { + "description": "Returns if the content is a dw.experience.Page or not.", + "id": "script-api:dw/content/Content#page", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.page", + "sections": [ + { + "body": "Returns if the content is a dw.experience.Page or not.", + "heading": "Description" + } + ], + "signature": "readonly page: boolean", + "source": "script-api", + "tags": [ + "page", + "content.page" + ], + "title": "Content.page" + }, + { + "description": "Returns the page description for the content in the current locale or null if there is no page description.", + "id": "script-api:dw/content/Content#pageDescription", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageDescription", + "sections": [ + { + "body": "Returns the page description for the content in the current locale\nor null if there is no page description.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string | null", + "source": "script-api", + "tags": [ + "pagedescription", + "content.pagedescription" + ], + "title": "Content.pageDescription" + }, + { + "description": "Returns the page keywords for the content in the current locale or null if there is no page title.", + "id": "script-api:dw/content/Content#pageKeywords", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageKeywords", + "sections": [ + { + "body": "Returns the page keywords for the content in the current locale\nor null if there is no page title.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string | null", + "source": "script-api", + "tags": [ + "pagekeywords", + "content.pagekeywords" + ], + "title": "Content.pageKeywords" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/content/Content#pageMetaTags", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageMetaTags", + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the content detail page meta tag context and rules.\nThe rules are obtained from the current content or inherited from the default folder,\nup to the root folder.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaTags: Array", + "source": "script-api", + "tags": [ + "pagemetatags", + "content.pagemetatags" + ], + "title": "Content.pageMetaTags" + }, + { + "description": "Returns the page title for the content in the current locale or null if there is no page title.", + "id": "script-api:dw/content/Content#pageTitle", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageTitle", + "sections": [ + { + "body": "Returns the page title for the content in the current locale\nor null if there is no page title.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string | null", + "source": "script-api", + "tags": [ + "pagetitle", + "content.pagetitle" + ], + "title": "Content.pageTitle" + }, + { + "description": "Returns the page URL for the content in the current locale or null if there is no page URL.", + "id": "script-api:dw/content/Content#pageURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.pageURL", + "sections": [ + { + "body": "Returns the page URL for the content in the current locale\nor null if there is no page URL.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string | null", + "source": "script-api", + "tags": [ + "pageurl", + "content.pageurl" + ], + "title": "Content.pageURL" + }, + { + "description": "Returns the search status of the content.", + "id": "script-api:dw/content/Content#searchable", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.searchable", + "sections": [ + { + "body": "Returns the search status of the content.", + "heading": "Description" + } + ], + "signature": "readonly searchable: boolean", + "source": "script-api", + "tags": [ + "searchable", + "content.searchable" + ], + "title": "Content.searchable" + }, + { + "description": "Returns the online status flag of the content.", + "id": "script-api:dw/content/Content#searchableFlag", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.searchableFlag", + "sections": [ + { + "body": "Returns the online status flag of the content.", + "heading": "Description" + } + ], + "signature": "readonly searchableFlag: boolean", + "source": "script-api", + "tags": [ + "searchableflag", + "content.searchableflag" + ], + "title": "Content.searchableFlag" + }, + { + "description": "Returns the contents change frequency needed for the sitemap creation.", + "id": "script-api:dw/content/Content#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapChangeFrequency", + "sections": [ + { + "body": "Returns the contents change frequency needed for the sitemap creation.", + "heading": "Description" + } + ], + "signature": "readonly siteMapChangeFrequency: string", + "source": "script-api", + "tags": [ + "sitemapchangefrequency", + "content.sitemapchangefrequency" + ], + "title": "Content.siteMapChangeFrequency" + }, + { + "description": "Returns the status if the content is included into the sitemap.", + "id": "script-api:dw/content/Content#siteMapIncluded", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapIncluded", + "sections": [ + { + "body": "Returns the status if the content is included into the sitemap.", + "heading": "Description" + } + ], + "signature": "readonly siteMapIncluded: number", + "source": "script-api", + "tags": [ + "sitemapincluded", + "content.sitemapincluded" + ], + "title": "Content.siteMapIncluded" + }, + { + "description": "Returns the contents priority needed for the sitemap creation. If no priority is defined, the method returns 0.0.", + "id": "script-api:dw/content/Content#siteMapPriority", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.siteMapPriority", + "sections": [ + { + "body": "Returns the contents priority needed for the sitemap creation.\nIf no priority is defined, the method returns 0.0.", + "heading": "Description" + } + ], + "signature": "readonly siteMapPriority: number", + "source": "script-api", + "tags": [ + "sitemappriority", + "content.sitemappriority" + ], + "title": "Content.siteMapPriority" + }, + { + "description": "Returns the value of attribute 'template'.", + "id": "script-api:dw/content/Content#template", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.template", + "sections": [ + { + "body": "Returns the value of attribute 'template'.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "content.template" + ], + "title": "Content.template" + }, + { + "description": "Converts the content into the dw.experience.Page representation if isPage yields true.", + "id": "script-api:dw/content/Content#toPage", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Content", + "qualifiedName": "dw.content.Content.toPage", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Converts the content into the dw.experience.Page representation if isPage yields true.", + "heading": "Description" + } + ], + "signature": "toPage(): Page | null", + "source": "script-api", + "tags": [ + "topage", + "content.topage" + ], + "title": "Content.toPage" + }, + { + "description": "Provides helper methods for getting content assets, library folders and the content library of the current site.", + "id": "script-api:dw/content/ContentMgr", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentMgr", + "sections": [ + { + "body": "Provides helper methods for getting content assets, library folders and the\ncontent library of the current site.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "contentmgr", + "dw.content.contentmgr", + "dw/content" + ], + "title": "ContentMgr" + }, + { + "description": "The input string to identify that the library is a private site library when invoking getLibrary.", + "id": "script-api:dw/content/ContentMgr#PRIVATE_LIBRARY", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.PRIVATE_LIBRARY", + "sections": [ + { + "body": "The input string to identify that the library is a private site library when invoking getLibrary.", + "heading": "Description" + } + ], + "signature": "static readonly PRIVATE_LIBRARY = \"PrivateLibrary\"", + "source": "script-api", + "tags": [ + "private_library", + "contentmgr.private_library" + ], + "title": "ContentMgr.PRIVATE_LIBRARY" + }, + { + "description": "The input string to identify that the library is a private site library when invoking getLibrary.", + "id": "script-api:dw/content/ContentMgr#PRIVATE_LIBRARY", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.PRIVATE_LIBRARY", + "sections": [ + { + "body": "The input string to identify that the library is a private site library when invoking getLibrary.", + "heading": "Description" + } + ], + "signature": "static readonly PRIVATE_LIBRARY = \"PrivateLibrary\"", + "source": "script-api", + "tags": [ + "private_library", + "contentmgr.private_library" + ], + "title": "ContentMgr.PRIVATE_LIBRARY" + }, + { + "description": "Returns the content with the corresponding identifier within the current site's site library.", + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "returns": { + "type": "Content | null" + }, + "sections": [ + { + "body": "Returns the content with the corresponding identifier within the current\nsite's site library.", + "heading": "Description" + } + ], + "signature": "static getContent(id: string): Content | null", + "source": "script-api", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "description": "Returns the content with the corresponding identifier within the specified library.", + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "library", + "type": "Library" + }, + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "returns": { + "type": "Content | null" + }, + "sections": [ + { + "body": "Returns the content with the corresponding identifier within the specified library.", + "heading": "Description" + } + ], + "signature": "static getContent(library: Library, id: string): Content | null", + "source": "script-api", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "description": "Returns the content with the corresponding identifier within the current site's site library.", + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "returns": { + "type": "Content | null" + }, + "sections": [ + { + "body": "Returns the content with the corresponding identifier within the current\nsite's site library.", + "heading": "Description" + } + ], + "signature": "static getContent(id: string): Content | null", + "source": "script-api", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "description": "Returns the content with the corresponding identifier within the specified library.", + "id": "script-api:dw/content/ContentMgr#getContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "library", + "type": "Library" + }, + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getContent", + "returns": { + "type": "Content | null" + }, + "sections": [ + { + "body": "Returns the content with the corresponding identifier within the specified library.", + "heading": "Description" + } + ], + "signature": "static getContent(library: Library, id: string): Content | null", + "source": "script-api", + "tags": [ + "getcontent", + "contentmgr.getcontent" + ], + "title": "ContentMgr.getContent" + }, + { + "description": "Returns the folder identified by the specified id within the current site's site library.", + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "returns": { + "type": "Folder | null" + }, + "sections": [ + { + "body": "Returns the folder identified by the specified id within the current\nsite's site library.", + "heading": "Description" + } + ], + "signature": "static getFolder(id: string): Folder | null", + "source": "script-api", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "description": "Returns the folder identified by the specified id within the specified library.", + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "library", + "type": "Library" + }, + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "returns": { + "type": "Folder | null" + }, + "sections": [ + { + "body": "Returns the folder identified by the specified id within the specified library.", + "heading": "Description" + } + ], + "signature": "static getFolder(library: Library, id: string): Folder | null", + "source": "script-api", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "description": "Returns the folder identified by the specified id within the current site's site library.", + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "returns": { + "type": "Folder | null" + }, + "sections": [ + { + "body": "Returns the folder identified by the specified id within the current\nsite's site library.", + "heading": "Description" + } + ], + "signature": "static getFolder(id: string): Folder | null", + "source": "script-api", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "description": "Returns the folder identified by the specified id within the specified library.", + "id": "script-api:dw/content/ContentMgr#getFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "library", + "type": "Library" + }, + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getFolder", + "returns": { + "type": "Folder | null" + }, + "sections": [ + { + "body": "Returns the folder identified by the specified id within the specified library.", + "heading": "Description" + } + ], + "signature": "static getFolder(library: Library, id: string): Folder | null", + "source": "script-api", + "tags": [ + "getfolder", + "contentmgr.getfolder" + ], + "title": "ContentMgr.getFolder" + }, + { + "description": "Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current site's private library will be returned.", + "id": "script-api:dw/content/ContentMgr#getLibrary", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "libraryId", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getLibrary", + "returns": { + "type": "Library | null" + }, + "sections": [ + { + "body": "Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current\nsite's private library will be returned.", + "heading": "Description" + } + ], + "signature": "static getLibrary(libraryId: string): Library | null", + "source": "script-api", + "tags": [ + "getlibrary", + "contentmgr.getlibrary" + ], + "title": "ContentMgr.getLibrary" + }, + { + "description": "Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current site's private library will be returned.", + "id": "script-api:dw/content/ContentMgr#getLibrary", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "libraryId", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getLibrary", + "returns": { + "type": "Library | null" + }, + "sections": [ + { + "body": "Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current\nsite's private library will be returned.", + "heading": "Description" + } + ], + "signature": "static getLibrary(libraryId: string): Library | null", + "source": "script-api", + "tags": [ + "getlibrary", + "contentmgr.getlibrary" + ], + "title": "ContentMgr.getLibrary" + }, + { + "description": "Returns the content library of the current site.", + "id": "script-api:dw/content/ContentMgr#getSiteLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getSiteLibrary", + "returns": { + "type": "Library | null" + }, + "sections": [ + { + "body": "Returns the content library of the current site.", + "heading": "Description" + } + ], + "signature": "static getSiteLibrary(): Library | null", + "source": "script-api", + "tags": [ + "getsitelibrary", + "contentmgr.getsitelibrary" + ], + "title": "ContentMgr.getSiteLibrary" + }, + { + "description": "Returns the content library of the current site.", + "id": "script-api:dw/content/ContentMgr#getSiteLibrary", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.getSiteLibrary", + "returns": { + "type": "Library | null" + }, + "sections": [ + { + "body": "Returns the content library of the current site.", + "heading": "Description" + } + ], + "signature": "static getSiteLibrary(): Library | null", + "source": "script-api", + "tags": [ + "getsitelibrary", + "contentmgr.getsitelibrary" + ], + "title": "ContentMgr.getSiteLibrary" + }, + { + "description": "Returns the content library of the current site.", + "id": "script-api:dw/content/ContentMgr#siteLibrary", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.siteLibrary", + "sections": [ + { + "body": "Returns the content library of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly siteLibrary: Library | null", + "source": "script-api", + "tags": [ + "sitelibrary", + "contentmgr.sitelibrary" + ], + "title": "ContentMgr.siteLibrary" + }, + { + "description": "Returns the content library of the current site.", + "id": "script-api:dw/content/ContentMgr#siteLibrary", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentMgr", + "qualifiedName": "dw.content.ContentMgr.siteLibrary", + "sections": [ + { + "body": "Returns the content library of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly siteLibrary: Library | null", + "source": "script-api", + "tags": [ + "sitelibrary", + "contentmgr.sitelibrary" + ], + "title": "ContentMgr.siteLibrary" + }, + { + "description": "The class is the central interface to a content search result and a content search refinement. It also provides utility methods to generate a search URL.", + "id": "script-api:dw/content/ContentSearchModel", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchModel", + "sections": [ + { + "body": "The class is the central interface to a content search result and a content\nsearch refinement. It also provides utility methods to generate a search URL.", + "heading": "Description" + }, + { + "body": "Extends `SearchModel`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "contentsearchmodel", + "dw.content.contentsearchmodel", + "dw/content" + ], + "title": "ContentSearchModel" + }, + { + "description": "URL Parameter for the content ID", + "id": "script-api:dw/content/ContentSearchModel#CONTENTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.CONTENTID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the content ID", + "heading": "Description" + } + ], + "signature": "static readonly CONTENTID_PARAMETER = \"cid\"", + "source": "script-api", + "tags": [ + "contentid_parameter", + "contentsearchmodel.contentid_parameter" + ], + "title": "ContentSearchModel.CONTENTID_PARAMETER" + }, + { + "description": "URL Parameter for the content ID", + "id": "script-api:dw/content/ContentSearchModel#CONTENTID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.CONTENTID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the content ID", + "heading": "Description" + } + ], + "signature": "static readonly CONTENTID_PARAMETER = \"cid\"", + "source": "script-api", + "tags": [ + "contentid_parameter", + "contentsearchmodel.contentid_parameter" + ], + "title": "ContentSearchModel.CONTENTID_PARAMETER" + }, + { + "description": "URL Parameter for the folder ID", + "id": "script-api:dw/content/ContentSearchModel#FOLDERID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.FOLDERID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the folder ID", + "heading": "Description" + } + ], + "signature": "static readonly FOLDERID_PARAMETER = \"fdid\"", + "source": "script-api", + "tags": [ + "folderid_parameter", + "contentsearchmodel.folderid_parameter" + ], + "title": "ContentSearchModel.FOLDERID_PARAMETER" + }, + { + "description": "URL Parameter for the folder ID", + "id": "script-api:dw/content/ContentSearchModel#FOLDERID_PARAMETER", + "kind": "constant", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.FOLDERID_PARAMETER", + "sections": [ + { + "body": "URL Parameter for the folder ID", + "heading": "Description" + } + ], + "signature": "static readonly FOLDERID_PARAMETER = \"fdid\"", + "source": "script-api", + "tags": [ + "folderid_parameter", + "contentsearchmodel.folderid_parameter" + ], + "title": "ContentSearchModel.FOLDERID_PARAMETER" + }, + { + "description": "Returns an Iterator containing all Content Assets that are the result of the search.", + "id": "script-api:dw/content/ContentSearchModel#content", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.content", + "sections": [ + { + "body": "Returns an Iterator containing all Content Assets that are the result of the\nsearch.", + "heading": "Description" + } + ], + "signature": "readonly content: utilIterator", + "source": "script-api", + "tags": [ + "content", + "contentsearchmodel.content" + ], + "title": "ContentSearchModel.content" + }, + { + "description": "Returns the content ID against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#contentID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.contentID", + "sections": [ + { + "body": "Returns the content ID against which the search results apply.", + "heading": "Description" + } + ], + "signature": "contentID: string", + "source": "script-api", + "tags": [ + "contentid", + "contentsearchmodel.contentid" + ], + "title": "ContentSearchModel.contentID" + }, + { + "description": "Returns the deepest common folder of all content assets in the search result.", + "id": "script-api:dw/content/ContentSearchModel#deepestCommonFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.deepestCommonFolder", + "sections": [ + { + "body": "Returns the deepest common folder of all content assets in the search result.", + "heading": "Description" + } + ], + "signature": "readonly deepestCommonFolder: Folder", + "source": "script-api", + "tags": [ + "deepestcommonfolder", + "contentsearchmodel.deepestcommonfolder" + ], + "title": "ContentSearchModel.deepestCommonFolder" + }, + { + "description": "The method returns true, if the content search result is filtered by the folder and it is not subsequently possible to search for content assets that belong to no folder (e.g. those for Page Designer).", + "id": "script-api:dw/content/ContentSearchModel#filteredByFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.filteredByFolder", + "sections": [ + { + "body": "The method returns true, if the content search result is filtered by the folder and it is not subsequently\npossible to search for content assets that belong to no folder (e.g. those for Page Designer).", + "heading": "Description" + } + ], + "signature": "filteredByFolder: boolean", + "source": "script-api", + "tags": [ + "filteredbyfolder", + "contentsearchmodel.filteredbyfolder" + ], + "title": "ContentSearchModel.filteredByFolder" + }, + { + "description": "Returns the folder against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#folder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folder", + "sections": [ + { + "body": "Returns the folder against which the search results apply.", + "heading": "Description" + } + ], + "signature": "readonly folder: Folder", + "source": "script-api", + "tags": [ + "folder", + "contentsearchmodel.folder" + ], + "title": "ContentSearchModel.folder" + }, + { + "description": "Returns the folder ID against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#folderID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folderID", + "sections": [ + { + "body": "Returns the folder ID against which the search results apply.", + "heading": "Description" + } + ], + "signature": "folderID: string", + "source": "script-api", + "tags": [ + "folderid", + "contentsearchmodel.folderid" + ], + "title": "ContentSearchModel.folderID" + }, + { + "description": "The method returns true, if this is a pure search for a folder. The method checks, that a folder ID is specified and no search phrase is specified.", + "id": "script-api:dw/content/ContentSearchModel#folderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.folderSearch", + "sections": [ + { + "body": "The method returns true, if this is a pure search for a folder. The\nmethod checks, that a folder ID is specified and no search phrase is\nspecified.", + "heading": "Description" + } + ], + "signature": "readonly folderSearch: boolean", + "source": "script-api", + "tags": [ + "foldersearch", + "contentsearchmodel.foldersearch" + ], + "title": "ContentSearchModel.folderSearch" + }, + { + "description": "Returns an Iterator containing all Content Assets that are the result of the search.", + "id": "script-api:dw/content/ContentSearchModel#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getContent", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns an Iterator containing all Content Assets that are the result of the\nsearch.", + "heading": "Description" + } + ], + "signature": "getContent(): utilIterator", + "source": "script-api", + "tags": [ + "getcontent", + "contentsearchmodel.getcontent" + ], + "title": "ContentSearchModel.getContent" + }, + { + "description": "Returns the content ID against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#getContentID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getContentID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the content ID against which the search results apply.", + "heading": "Description" + } + ], + "signature": "getContentID(): string", + "source": "script-api", + "tags": [ + "getcontentid", + "contentsearchmodel.getcontentid" + ], + "title": "ContentSearchModel.getContentID" + }, + { + "description": "Returns the deepest common folder of all content assets in the search result.", + "id": "script-api:dw/content/ContentSearchModel#getDeepestCommonFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getDeepestCommonFolder", + "returns": { + "type": "Folder" + }, + "sections": [ + { + "body": "Returns the deepest common folder of all content assets in the search result.", + "heading": "Description" + } + ], + "signature": "getDeepestCommonFolder(): Folder", + "source": "script-api", + "tags": [ + "getdeepestcommonfolder", + "contentsearchmodel.getdeepestcommonfolder" + ], + "title": "ContentSearchModel.getDeepestCommonFolder" + }, + { + "description": "Returns the folder against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#getFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getFolder", + "returns": { + "type": "Folder" + }, + "sections": [ + { + "body": "Returns the folder against which the search results apply.", + "heading": "Description" + } + ], + "signature": "getFolder(): Folder", + "source": "script-api", + "tags": [ + "getfolder", + "contentsearchmodel.getfolder" + ], + "title": "ContentSearchModel.getFolder" + }, + { + "description": "Returns the folder ID against which the search results apply.", + "id": "script-api:dw/content/ContentSearchModel#getFolderID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getFolderID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the folder ID against which the search results apply.", + "heading": "Description" + } + ], + "signature": "getFolderID(): string", + "source": "script-api", + "tags": [ + "getfolderid", + "contentsearchmodel.getfolderid" + ], + "title": "ContentSearchModel.getFolderID" + }, + { + "description": "Returns the page meta tag for the specified id.", + "id": "script-api:dw/content/ContentSearchModel#getPageMetaTag", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getPageMetaTag", + "returns": { + "type": "PageMetaTag | null" + }, + "sections": [ + { + "body": "Returns the page meta tag for the specified id.\n\nThe meta tag content is generated based on the content listing page meta tag context and rule.\nThe rule is obtained from the current folder context or inherited from the parent folder,\nup to the root folder.\n\nNull will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the\ncurrent context, or if the rule resolves to an empty string.", + "heading": "Description" + } + ], + "signature": "getPageMetaTag(id: string): PageMetaTag | null", + "source": "script-api", + "tags": [ + "getpagemetatag", + "contentsearchmodel.getpagemetatag" + ], + "title": "ContentSearchModel.getPageMetaTag" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/content/ContentSearchModel#getPageMetaTags", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getPageMetaTags", + "returns": { + "type": "Array" + }, + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the content listing page meta tag context and rules.\nThe rules are obtained from the current folder context or inherited from the parent folder,\nup to the root folder.", + "heading": "Description" + } + ], + "signature": "getPageMetaTags(): Array", + "source": "script-api", + "tags": [ + "getpagemetatags", + "contentsearchmodel.getpagemetatags" + ], + "title": "ContentSearchModel.getPageMetaTags" + }, + { + "description": "Returns the set of search refinements used in this search.", + "id": "script-api:dw/content/ContentSearchModel#getRefinements", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.getRefinements", + "returns": { + "type": "ContentSearchRefinements" + }, + "sections": [ + { + "body": "Returns the set of search refinements used in this search.", + "heading": "Description" + } + ], + "signature": "getRefinements(): ContentSearchRefinements", + "source": "script-api", + "tags": [ + "getrefinements", + "contentsearchmodel.getrefinements" + ], + "title": "ContentSearchModel.getRefinements" + }, + { + "description": "The method returns true, if the content search result is filtered by the folder and it is not subsequently possible to search for content assets that belong to no folder (e.g. those for Page Designer).", + "id": "script-api:dw/content/ContentSearchModel#isFilteredByFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isFilteredByFolder", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if the content search result is filtered by the folder and it is not subsequently\npossible to search for content assets that belong to no folder (e.g. those for Page Designer).", + "heading": "Description" + } + ], + "signature": "isFilteredByFolder(): boolean", + "source": "script-api", + "tags": [ + "isfilteredbyfolder", + "contentsearchmodel.isfilteredbyfolder" + ], + "title": "ContentSearchModel.isFilteredByFolder" + }, + { + "description": "The method returns true, if this is a pure search for a folder. The method checks, that a folder ID is specified and no search phrase is specified.", + "id": "script-api:dw/content/ContentSearchModel#isFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isFolderSearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if this is a pure search for a folder. The\nmethod checks, that a folder ID is specified and no search phrase is\nspecified.", + "heading": "Description" + } + ], + "signature": "isFolderSearch(): boolean", + "source": "script-api", + "tags": [ + "isfoldersearch", + "contentsearchmodel.isfoldersearch" + ], + "title": "ContentSearchModel.isFolderSearch" + }, + { + "description": "Get the flag that determines if the folder search will be recursive.", + "id": "script-api:dw/content/ContentSearchModel#isRecursiveFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRecursiveFolderSearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Get the flag that determines if the folder search will\nbe recursive.", + "heading": "Description" + } + ], + "signature": "isRecursiveFolderSearch(): boolean", + "source": "script-api", + "tags": [ + "isrecursivefoldersearch", + "contentsearchmodel.isrecursivefoldersearch" + ], + "title": "ContentSearchModel.isRecursiveFolderSearch" + }, + { + "description": "The method returns true, if the search is refined by a folder. The method checks, that a folder ID is specified.", + "id": "script-api:dw/content/ContentSearchModel#isRefinedByFolder", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRefinedByFolder", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if the search is refined by a folder.\nThe method checks, that a folder ID is specified.", + "heading": "Description" + } + ], + "signature": "isRefinedByFolder(): boolean", + "source": "script-api", + "tags": [ + "isrefinedbyfolder", + "contentsearchmodel.isrefinedbyfolder" + ], + "title": "ContentSearchModel.isRefinedByFolder" + }, + { + "description": "Identifies if this is a folder search and is refined with further criteria, like a name refinement or an attribute refinement.", + "id": "script-api:dw/content/ContentSearchModel#isRefinedFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.isRefinedFolderSearch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a folder search and is refined with further\ncriteria, like a name refinement or an attribute refinement.", + "heading": "Description" + } + ], + "signature": "isRefinedFolderSearch(): boolean", + "source": "script-api", + "tags": [ + "isrefinedfoldersearch", + "contentsearchmodel.isrefinedfoldersearch" + ], + "title": "ContentSearchModel.isRefinedFolderSearch" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/content/ContentSearchModel#pageMetaTags", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.pageMetaTags", + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the content listing page meta tag context and rules.\nThe rules are obtained from the current folder context or inherited from the parent folder,\nup to the root folder.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaTags: Array", + "source": "script-api", + "tags": [ + "pagemetatags", + "contentsearchmodel.pagemetatags" + ], + "title": "ContentSearchModel.pageMetaTags" + }, + { + "description": "Get the flag that determines if the folder search will be recursive.", + "id": "script-api:dw/content/ContentSearchModel#recursiveFolderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.recursiveFolderSearch", + "sections": [ + { + "body": "Get the flag that determines if the folder search will\nbe recursive.", + "heading": "Description" + } + ], + "signature": "recursiveFolderSearch: boolean", + "source": "script-api", + "tags": [ + "recursivefoldersearch", + "contentsearchmodel.recursivefoldersearch" + ], + "title": "ContentSearchModel.recursiveFolderSearch" + }, + { + "description": "The method returns true, if the search is refined by a folder. The method checks, that a folder ID is specified.", + "id": "script-api:dw/content/ContentSearchModel#refinedByFolder", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinedByFolder", + "sections": [ + { + "body": "The method returns true, if the search is refined by a folder.\nThe method checks, that a folder ID is specified.", + "heading": "Description" + } + ], + "signature": "readonly refinedByFolder: boolean", + "source": "script-api", + "tags": [ + "refinedbyfolder", + "contentsearchmodel.refinedbyfolder" + ], + "title": "ContentSearchModel.refinedByFolder" + }, + { + "description": "Identifies if this is a folder search and is refined with further criteria, like a name refinement or an attribute refinement.", + "id": "script-api:dw/content/ContentSearchModel#refinedFolderSearch", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinedFolderSearch", + "sections": [ + { + "body": "Identifies if this is a folder search and is refined with further\ncriteria, like a name refinement or an attribute refinement.", + "heading": "Description" + } + ], + "signature": "readonly refinedFolderSearch: boolean", + "source": "script-api", + "tags": [ + "refinedfoldersearch", + "contentsearchmodel.refinedfoldersearch" + ], + "title": "ContentSearchModel.refinedFolderSearch" + }, + { + "description": "Returns the set of search refinements used in this search.", + "id": "script-api:dw/content/ContentSearchModel#refinements", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.refinements", + "sections": [ + { + "body": "Returns the set of search refinements used in this search.", + "heading": "Description" + } + ], + "signature": "readonly refinements: ContentSearchRefinements", + "source": "script-api", + "tags": [ + "refinements", + "contentsearchmodel.refinements" + ], + "title": "ContentSearchModel.refinements" + }, + { + "description": "Execute the search.", + "id": "script-api:dw/content/ContentSearchModel#search", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.search", + "returns": { + "type": "SearchStatus" + }, + "sections": [ + { + "body": "Execute the search.", + "heading": "Description" + } + ], + "signature": "search(): SearchStatus", + "source": "script-api", + "tags": [ + "search", + "contentsearchmodel.search" + ], + "title": "ContentSearchModel.search" + }, + { + "description": "Sets the contentID used in this search.", + "id": "script-api:dw/content/ContentSearchModel#setContentID", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "contentID", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setContentID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the contentID used in this search.", + "heading": "Description" + } + ], + "signature": "setContentID(contentID: string): void", + "source": "script-api", + "tags": [ + "setcontentid", + "contentsearchmodel.setcontentid" + ], + "title": "ContentSearchModel.setContentID" + }, + { + "description": "Set a flag to indicate if the search is filtered by the folder. Must be set to false to return content assets that do not belong to any folder.", + "id": "script-api:dw/content/ContentSearchModel#setFilteredByFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "filteredByFolder", + "type": "boolean" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setFilteredByFolder", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag to indicate if the search is filtered by the folder. Must be set to false to return content assets that\ndo not belong to any folder.", + "heading": "Description" + } + ], + "signature": "setFilteredByFolder(filteredByFolder: boolean): void", + "source": "script-api", + "tags": [ + "setfilteredbyfolder", + "contentsearchmodel.setfilteredbyfolder" + ], + "title": "ContentSearchModel.setFilteredByFolder" + }, + { + "description": "Sets the folderID used in this search.", + "id": "script-api:dw/content/ContentSearchModel#setFolderID", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "folderID", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setFolderID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the folderID used in this search.", + "heading": "Description" + } + ], + "signature": "setFolderID(folderID: string): void", + "source": "script-api", + "tags": [ + "setfolderid", + "contentsearchmodel.setfolderid" + ], + "title": "ContentSearchModel.setFolderID" + }, + { + "description": "Set a flag to indicate if the search in folder should be recursive.", + "id": "script-api:dw/content/ContentSearchModel#setRecursiveFolderSearch", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "recurse", + "type": "boolean" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.setRecursiveFolderSearch", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag to indicate if the search in folder should be recursive.", + "heading": "Description" + } + ], + "signature": "setRecursiveFolderSearch(recurse: boolean): void", + "source": "script-api", + "tags": [ + "setrecursivefoldersearch", + "contentsearchmodel.setrecursivefoldersearch" + ], + "title": "ContentSearchModel.setRecursiveFolderSearch" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Content. The passed action is used to build an initial url. All search specific attributes are appended.", + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nContent. The passed action is used to build an initial url. All search\nspecific attributes are appended.", + "heading": "Description" + } + ], + "signature": "static urlForContent(action: string, cid: string): URL", + "source": "script-api", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Content. The passed url can be either a full url or just the name for a pipeline. In the later case a relative URL is created.", + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nContent. The passed url can be either a full url or just the name for a\npipeline. In the later case a relative URL is created.", + "heading": "Description" + } + ], + "signature": "static urlForContent(url: URL, cid: string): URL", + "source": "script-api", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Content. The passed action is used to build an initial url. All search specific attributes are appended.", + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "cid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nContent. The passed action is used to build an initial url. All search\nspecific attributes are appended.", + "heading": "Description" + } + ], + "signature": "static urlForContent(action: string, cid: string): URL", + "source": "script-api", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Content. The passed url can be either a full url or just the name for a pipeline. In the later case a relative URL is created.", + "id": "script-api:dw/content/ContentSearchModel#urlForContent", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "cid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForContent", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nContent. The passed url can be either a full url or just the name for a\npipeline. In the later case a relative URL is created.", + "heading": "Description" + } + ], + "signature": "static urlForContent(url: URL, cid: string): URL", + "source": "script-api", + "tags": [ + "urlforcontent", + "contentsearchmodel.urlforcontent" + ], + "title": "ContentSearchModel.urlForContent" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Folder.", + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "fid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nFolder.", + "heading": "Description" + } + ], + "signature": "static urlForFolder(action: string, fid: string): URL", + "source": "script-api", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Folder.", + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "fid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nFolder.", + "heading": "Description" + } + ], + "signature": "static urlForFolder(url: URL, fid: string): URL", + "source": "script-api", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Folder.", + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "fid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nFolder.", + "heading": "Description" + } + ], + "signature": "static urlForFolder(action: string, fid: string): URL", + "source": "script-api", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific Folder.", + "id": "script-api:dw/content/ContentSearchModel#urlForFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "fid", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nFolder.", + "heading": "Description" + } + ], + "signature": "static urlForFolder(url: URL, fid: string): URL", + "source": "script-api", + "tags": [ + "urlforfolder", + "contentsearchmodel.urlforfolder" + ], + "title": "ContentSearchModel.urlForFolder" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nattribute name-value pair.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(action: string, name: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nattribute name-value pair.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(url: URL, name: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nattribute name-value pair.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(action: string, name: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "description": "Returns an URL that you can use to execute a query for a specific attribute name-value pair.", + "id": "script-api:dw/content/ContentSearchModel#urlForRefine", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlForRefine", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to execute a query for a specific\nattribute name-value pair.", + "heading": "Description" + } + ], + "signature": "static urlForRefine(url: URL, name: string, value: string): URL", + "source": "script-api", + "tags": [ + "urlforrefine", + "contentsearchmodel.urlforrefine" + ], + "title": "ContentSearchModel.urlForRefine" + }, + { + "description": "Returns an URL that you can use to re-execute the query using the specified pipeline action and folder refinement.", + "id": "script-api:dw/content/ContentSearchModel#urlRefineFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "refineFolderID", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRefineFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to re-execute the query using the\nspecified pipeline action and folder refinement.", + "heading": "Description" + } + ], + "signature": "urlRefineFolder(action: string, refineFolderID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinefolder", + "contentsearchmodel.urlrefinefolder" + ], + "title": "ContentSearchModel.urlRefineFolder" + }, + { + "description": "Returns an URL that you can use to re-execute the query using the specified URL and folder refinement.", + "id": "script-api:dw/content/ContentSearchModel#urlRefineFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "refineFolderID", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRefineFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to re-execute the query using the\nspecified URL and folder refinement.", + "heading": "Description" + } + ], + "signature": "urlRefineFolder(url: URL, refineFolderID: string): URL", + "source": "script-api", + "tags": [ + "urlrefinefolder", + "contentsearchmodel.urlrefinefolder" + ], + "title": "ContentSearchModel.urlRefineFolder" + }, + { + "description": "Returns an URL that you can use to re-execute the query with no folder refinement.", + "id": "script-api:dw/content/ContentSearchModel#urlRelaxFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "action", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRelaxFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to re-execute the query with no folder\nrefinement.", + "heading": "Description" + } + ], + "signature": "urlRelaxFolder(action: string): URL", + "source": "script-api", + "tags": [ + "urlrelaxfolder", + "contentsearchmodel.urlrelaxfolder" + ], + "title": "ContentSearchModel.urlRelaxFolder" + }, + { + "description": "Returns an URL that you can use to re-execute the query with no folder refinement.", + "id": "script-api:dw/content/ContentSearchModel#urlRelaxFolder", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/content/ContentSearchModel", + "qualifiedName": "dw.content.ContentSearchModel.urlRelaxFolder", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL that you can use to re-execute the query with no folder\nrefinement.", + "heading": "Description" + } + ], + "signature": "urlRelaxFolder(url: URL): URL", + "source": "script-api", + "tags": [ + "urlrelaxfolder", + "contentsearchmodel.urlrelaxfolder" + ], + "title": "ContentSearchModel.urlRelaxFolder" + }, + { + "description": "This class provides an interface to refinement options for content search.", + "id": "script-api:dw/content/ContentSearchRefinementDefinition", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition", + "sections": [ + { + "body": "This class provides an interface to refinement options for content search.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinementDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "contentsearchrefinementdefinition", + "dw.content.contentsearchrefinementdefinition", + "dw/content" + ], + "title": "ContentSearchRefinementDefinition" + }, + { + "description": "Identifies if this is a folder refinement.", + "id": "script-api:dw/content/ContentSearchRefinementDefinition#folderRefinement", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinementDefinition", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition.folderRefinement", + "sections": [ + { + "body": "Identifies if this is a folder refinement.", + "heading": "Description" + } + ], + "signature": "readonly folderRefinement: boolean", + "source": "script-api", + "tags": [ + "folderrefinement", + "contentsearchrefinementdefinition.folderrefinement" + ], + "title": "ContentSearchRefinementDefinition.folderRefinement" + }, + { + "description": "Identifies if this is a folder refinement.", + "id": "script-api:dw/content/ContentSearchRefinementDefinition#isFolderRefinement", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinementDefinition", + "qualifiedName": "dw.content.ContentSearchRefinementDefinition.isFolderRefinement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is a folder refinement.", + "heading": "Description" + } + ], + "signature": "isFolderRefinement(): boolean", + "source": "script-api", + "tags": [ + "isfolderrefinement", + "contentsearchrefinementdefinition.isfolderrefinement" + ], + "title": "ContentSearchRefinementDefinition.isFolderRefinement" + }, + { + "description": "Represents the value of a content search refinement.", + "id": "script-api:dw/content/ContentSearchRefinementValue", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinementValue", + "sections": [ + { + "body": "Represents the value of a content search refinement.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinementValue`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "contentsearchrefinementvalue", + "dw.content.contentsearchrefinementvalue", + "dw/content" + ], + "title": "ContentSearchRefinementValue" + }, + { + "description": "This class provides an interface to refinement options for the content asset search. In a typical usage, the client application UI displays the search refinements along with the search results and allows customers to \"refine\" the results (i.e. limit the results that are shown) by specifying additional criteria, or \"relax\" (i.e. broaden) the results after previously refining. The two types of content search refinements are:", + "id": "script-api:dw/content/ContentSearchRefinements", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.ContentSearchRefinements", + "sections": [ + { + "body": "This class provides an interface to refinement options for the content asset\nsearch. In a typical usage, the client application UI displays the search\nrefinements along with the search results and allows customers to \"refine\"\nthe results (i.e. limit the results that are shown) by specifying additional\ncriteria, or \"relax\" (i.e. broaden) the results after previously refining.\nThe two types of content search refinements are:\n\n- Refine By Folder: Limit the content assets to those assigned to\nspecific child/ancestor folder of the search folder.\n- Refine By Attribute: Limit the content assets to those with\nspecific values for a given attribute. Values may be grouped into \"buckets\"\nso that a given set of values are represented as a single refinement option.\n\nRendering a content search refinement UI typically begins with iterating the\nrefinement definitions for the search result. Call\ndw.catalog.SearchRefinements.getRefinementDefinitions or\ndw.catalog.SearchRefinements.getAllRefinementDefinitions to\nretrieve the appropriate collection of refinement definitions. For each\ndefinition, display the available refinement values by calling\ngetAllRefinementValues. Depending\non the type of the refinement definition, the application must use slightly\ndifferent logic to display the refinement widgets. For all 2 types, methods\nin dw.content.ContentSearchModel are used to generate URLs to render\nhyperlinks in the UI. When clicked, these links trigger a call to the Search\npipelet which in turn applies the appropriate filters to the native search\nresult.", + "heading": "Description" + }, + { + "body": "Extends `SearchRefinements`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "contentsearchrefinements", + "dw.content.contentsearchrefinements", + "dw/content" + ], + "title": "ContentSearchRefinements" + }, + { + "description": "Returns the appropriate folder refinement definition based on the search result. The folder refinement definition returned will be the first that can be found traversing the folder tree upward starting at the deepest common folder of the search result.", + "id": "script-api:dw/content/ContentSearchRefinements#folderRefinementDefinition", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.folderRefinementDefinition", + "sections": [ + { + "body": "Returns the appropriate folder refinement definition based on the search\nresult. The folder refinement definition returned will be the first that\ncan be found traversing the folder tree upward starting at the deepest\ncommon folder of the search result.", + "heading": "Description" + } + ], + "signature": "readonly folderRefinementDefinition: ContentSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "folderrefinementdefinition", + "contentsearchrefinements.folderrefinementdefinition" + ], + "title": "ContentSearchRefinements.folderRefinementDefinition" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "attributeName", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection | null" + }, + "signature": "getAllRefinementValues(attributeName: string): Collection | null", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection" + }, + "signature": "getAllRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns a sorted collection of refinement values for the given refinement definition. The returned collection includes all refinement values for which the hit count is greater than 0 within the search result when the passed refinement definitions is excluded from filtering the search hits but all other refinement filters are still applied. This is useful for rendering broadening options for the refinement definitions that the search is already refined by. It is important to note that this method does NOT return refinement values independent of the search result.", + "id": "script-api:dw/content/ContentSearchRefinements#getAllRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "definition", + "type": "ContentSearchRefinementDefinition" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getAllRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of refinement values for the given refinement\ndefinition. The returned collection includes all refinement values for\nwhich the hit count is greater than 0 within the search result when the\npassed refinement definitions is excluded from filtering the search hits\nbut all other refinement filters are still applied. This is useful for\nrendering broadening options for the refinement definitions that the\nsearch is already refined by. It is important to note that this method\ndoes NOT return refinement values independent of the search result.", + "heading": "Description" + } + ], + "signature": "getAllRefinementValues(definition: ContentSearchRefinementDefinition): Collection", + "source": "script-api", + "tags": [ + "getallrefinementvalues", + "contentsearchrefinements.getallrefinementvalues" + ], + "title": "ContentSearchRefinements.getAllRefinementValues" + }, + { + "description": "Returns the number of search hits for the passed folder object.", + "id": "script-api:dw/content/ContentSearchRefinements#getFolderHits", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "folder", + "type": "Folder" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getFolderHits", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of search hits for the passed folder object.", + "heading": "Description" + } + ], + "signature": "getFolderHits(folder: Folder): number", + "source": "script-api", + "tags": [ + "getfolderhits", + "contentsearchrefinements.getfolderhits" + ], + "title": "ContentSearchRefinements.getFolderHits" + }, + { + "description": "Returns the appropriate folder refinement definition based on the search result. The folder refinement definition returned will be the first that can be found traversing the folder tree upward starting at the deepest common folder of the search result.", + "id": "script-api:dw/content/ContentSearchRefinements#getFolderRefinementDefinition", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getFolderRefinementDefinition", + "returns": { + "type": "ContentSearchRefinementDefinition | null" + }, + "sections": [ + { + "body": "Returns the appropriate folder refinement definition based on the search\nresult. The folder refinement definition returned will be the first that\ncan be found traversing the folder tree upward starting at the deepest\ncommon folder of the search result.", + "heading": "Description" + } + ], + "signature": "getFolderRefinementDefinition(): ContentSearchRefinementDefinition | null", + "source": "script-api", + "tags": [ + "getfolderrefinementdefinition", + "contentsearchrefinements.getfolderrefinementdefinition" + ], + "title": "ContentSearchRefinements.getFolderRefinementDefinition" + }, + { + "description": "Returns a collection of matching folders.", + "id": "script-api:dw/content/ContentSearchRefinements#getMatchingFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getMatchingFolders", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of matching folders.", + "heading": "Description" + } + ], + "signature": "getMatchingFolders(): Collection", + "source": "script-api", + "tags": [ + "getmatchingfolders", + "contentsearchrefinements.getmatchingfolders" + ], + "title": "ContentSearchRefinements.getMatchingFolders" + }, + { + "description": "Returns folder refinement values based on the current search result filtered such that only folder refinements representing children of the given folder are present. If no folder is given, the method uses the library's root folder. The refinement value content counts represent all hits contained in the library tree starting at the corresponding child folder.", + "id": "script-api:dw/content/ContentSearchRefinements#getNextLevelFolderRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "folder", + "type": "Folder" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getNextLevelFolderRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns folder refinement values based on the current search result\nfiltered such that only folder refinements representing children of the\ngiven folder are present. If no folder is given, the method uses the\nlibrary's root folder. The refinement value content counts represent all\nhits contained in the library tree starting at the corresponding child\nfolder.", + "heading": "Description" + } + ], + "signature": "getNextLevelFolderRefinementValues(folder: Folder): Collection", + "source": "script-api", + "tags": [ + "getnextlevelfolderrefinementvalues", + "contentsearchrefinements.getnextlevelfolderrefinementvalues" + ], + "title": "ContentSearchRefinements.getNextLevelFolderRefinementValues" + }, + { + "description": "Returns the refinement value (incl. content hit count) for the given refinement definition and the given (selected) value.", + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "definition", + "type": "ContentSearchRefinementDefinition" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValue", + "returns": { + "type": "ContentSearchRefinementValue" + }, + "sections": [ + { + "body": "Returns the refinement value (incl. content hit count) for the given\nrefinement definition and the given (selected) value.", + "heading": "Description" + } + ], + "signature": "getRefinementValue(definition: ContentSearchRefinementDefinition, value: string): ContentSearchRefinementValue", + "source": "script-api", + "tags": [ + "getrefinementvalue", + "contentsearchrefinements.getrefinementvalue" + ], + "title": "ContentSearchRefinements.getRefinementValue" + }, + { + "description": "Returns the refinement value (incl. content hit count) for the given attribute refinement and the given (selected) value.", + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValue", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValue", + "returns": { + "type": "ContentSearchRefinementValue" + }, + "sections": [ + { + "body": "Returns the refinement value (incl. content hit count) for the given\nattribute refinement and the given (selected) value.", + "heading": "Description" + } + ], + "signature": "getRefinementValue(name: string, value: string): ContentSearchRefinementValue", + "source": "script-api", + "tags": [ + "getrefinementvalue", + "contentsearchrefinements.getrefinementvalue" + ], + "title": "ContentSearchRefinements.getRefinementValue" + }, + { + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "attributeName", + "type": "string" + }, + { + "name": "sortMode", + "type": "number" + }, + { + "name": "sortDirection", + "type": "number" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValues", + "returns": { + "type": "Collection" + }, + "signature": "getRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "contentsearchrefinements.getrefinementvalues" + ], + "title": "ContentSearchRefinements.getRefinementValues" + }, + { + "description": "Returns a collection of refinement values for the given refinement definition. The returned refinement values only include those that are part of the actual search result (i.e. hit count will always be > 0).", + "id": "script-api:dw/content/ContentSearchRefinements#getRefinementValues", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "definition", + "type": "ContentSearchRefinementDefinition" + } + ], + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.getRefinementValues", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of refinement values for the given refinement\ndefinition. The returned refinement values only include those that are\npart of the actual search result (i.e. hit count will always be > 0).", + "heading": "Description" + } + ], + "signature": "getRefinementValues(definition: ContentSearchRefinementDefinition): Collection", + "source": "script-api", + "tags": [ + "getrefinementvalues", + "contentsearchrefinements.getrefinementvalues" + ], + "title": "ContentSearchRefinements.getRefinementValues" + }, + { + "description": "Returns a collection of matching folders.", + "id": "script-api:dw/content/ContentSearchRefinements#matchingFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/ContentSearchRefinements", + "qualifiedName": "dw.content.ContentSearchRefinements.matchingFolders", + "sections": [ + { + "body": "Returns a collection of matching folders.", + "heading": "Description" + } + ], + "signature": "readonly matchingFolders: Collection", + "source": "script-api", + "tags": [ + "matchingfolders", + "contentsearchrefinements.matchingfolders" + ], + "title": "ContentSearchRefinements.matchingFolders" + }, + { + "description": "Class representing a folder for organizing content assets in Commerce Cloud Digital.", + "id": "script-api:dw/content/Folder", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Folder", + "sections": [ + { + "body": "Class representing a folder for organizing content assets in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "folder", + "dw.content.folder", + "dw/content" + ], + "title": "Folder" + }, + { + "description": "Returns the ID of the folder. The ID can be used to uniquely identify a folder within any given library. This folder ID provides an alternative lookup mechanism for folders frequently used in the storefront.", + "id": "script-api:dw/content/Folder#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.ID", + "sections": [ + { + "body": "Returns the ID of the folder. The ID can be used to uniquely\nidentify a folder within any given library. This folder ID provides\nan alternative lookup mechanism for folders frequently used in\nthe storefront.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "folder.id" + ], + "title": "Folder.ID" + }, + { + "description": "Returns the content objects for this folder, sorted by position.", + "id": "script-api:dw/content/Folder#content", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.content", + "sections": [ + { + "body": "Returns the content objects for this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "readonly content: Collection", + "source": "script-api", + "tags": [ + "content", + "folder.content" + ], + "title": "Folder.content" + }, + { + "description": "Returns the description for the folder as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Folder#description", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.description", + "sections": [ + { + "body": "Returns the description for the folder as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "folder.description" + ], + "title": "Folder.description" + }, + { + "description": "Returns the display name for the folder as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Folder#displayName", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.displayName", + "sections": [ + { + "body": "Returns the display name for the folder as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "folder.displayname" + ], + "title": "Folder.displayName" + }, + { + "description": "Returns the content objects for this folder, sorted by position.", + "id": "script-api:dw/content/Folder#getContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getContent", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the content objects for this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "getContent(): Collection", + "source": "script-api", + "tags": [ + "getcontent", + "folder.getcontent" + ], + "title": "Folder.getContent" + }, + { + "description": "Returns the description for the folder as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Folder#getDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description for the folder as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "folder.getdescription" + ], + "title": "Folder.getDescription" + }, + { + "description": "Returns the display name for the folder as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Folder#getDisplayName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the display name for the folder as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "folder.getdisplayname" + ], + "title": "Folder.getDisplayName" + }, + { + "description": "Returns the ID of the folder. The ID can be used to uniquely identify a folder within any given library. This folder ID provides an alternative lookup mechanism for folders frequently used in the storefront.", + "id": "script-api:dw/content/Folder#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the folder. The ID can be used to uniquely\nidentify a folder within any given library. This folder ID provides\nan alternative lookup mechanism for folders frequently used in\nthe storefront.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "folder.getid" + ], + "title": "Folder.getID" + }, + { + "description": "Returns the online content objects for this folder, sorted by position.", + "id": "script-api:dw/content/Folder#getOnlineContent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getOnlineContent", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the online content objects for this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "getOnlineContent(): Collection", + "source": "script-api", + "tags": [ + "getonlinecontent", + "folder.getonlinecontent" + ], + "title": "Folder.getOnlineContent" + }, + { + "description": "Returns the online subfolders of this folder, sorted by position.", + "id": "script-api:dw/content/Folder#getOnlineSubFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getOnlineSubFolders", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the online subfolders of this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "getOnlineSubFolders(): Collection", + "source": "script-api", + "tags": [ + "getonlinesubfolders", + "folder.getonlinesubfolders" + ], + "title": "Folder.getOnlineSubFolders" + }, + { + "description": "Returns the page description for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#getPageDescription", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page description for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string | null", + "source": "script-api", + "tags": [ + "getpagedescription", + "folder.getpagedescription" + ], + "title": "Folder.getPageDescription" + }, + { + "description": "Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#getPageKeywords", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageKeywords", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page keywords for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string | null", + "source": "script-api", + "tags": [ + "getpagekeywords", + "folder.getpagekeywords" + ], + "title": "Folder.getPageKeywords" + }, + { + "description": "Returns the page title for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#getPageTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageTitle", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page title for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string | null", + "source": "script-api", + "tags": [ + "getpagetitle", + "folder.getpagetitle" + ], + "title": "Folder.getPageTitle" + }, + { + "description": "Returns the page URL for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#getPageURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getPageURL", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the page URL for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "getPageURL(): string | null", + "source": "script-api", + "tags": [ + "getpageurl", + "folder.getpageurl" + ], + "title": "Folder.getPageURL" + }, + { + "description": "Returns the parent folder of this folder.", + "id": "script-api:dw/content/Folder#getParent", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getParent", + "returns": { + "type": "Folder" + }, + "sections": [ + { + "body": "Returns the parent folder of this folder.", + "heading": "Description" + } + ], + "signature": "getParent(): Folder", + "source": "script-api", + "tags": [ + "getparent", + "folder.getparent" + ], + "title": "Folder.getParent" + }, + { + "description": "Returns the folder's sitemap change frequency.", + "id": "script-api:dw/content/Folder#getSiteMapChangeFrequency", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapChangeFrequency", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the folder's sitemap change frequency.", + "heading": "Description" + } + ], + "signature": "getSiteMapChangeFrequency(): string", + "source": "script-api", + "tags": [ + "getsitemapchangefrequency", + "folder.getsitemapchangefrequency" + ], + "title": "Folder.getSiteMapChangeFrequency" + }, + { + "description": "Returns the folder's sitemap inclusion.", + "id": "script-api:dw/content/Folder#getSiteMapIncluded", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapIncluded", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the folder's sitemap inclusion.", + "heading": "Description" + } + ], + "signature": "getSiteMapIncluded(): number", + "source": "script-api", + "tags": [ + "getsitemapincluded", + "folder.getsitemapincluded" + ], + "title": "Folder.getSiteMapIncluded" + }, + { + "description": "Returns the folder's sitemap priority.", + "id": "script-api:dw/content/Folder#getSiteMapPriority", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSiteMapPriority", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the folder's sitemap priority.", + "heading": "Description" + } + ], + "signature": "getSiteMapPriority(): number", + "source": "script-api", + "tags": [ + "getsitemappriority", + "folder.getsitemappriority" + ], + "title": "Folder.getSiteMapPriority" + }, + { + "description": "Returns the subfolders of this folder, sorted by position.", + "id": "script-api:dw/content/Folder#getSubFolders", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getSubFolders", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the subfolders of this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "getSubFolders(): Collection", + "source": "script-api", + "tags": [ + "getsubfolders", + "folder.getsubfolders" + ], + "title": "Folder.getSubFolders" + }, + { + "description": "Returns the name of the template used to render the folder in the store front.", + "id": "script-api:dw/content/Folder#getTemplate", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.getTemplate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the template used to render the folder\nin the store front.", + "heading": "Description" + } + ], + "signature": "getTemplate(): string", + "source": "script-api", + "tags": [ + "gettemplate", + "folder.gettemplate" + ], + "title": "Folder.getTemplate" + }, + { + "description": "Indicates if the folder is set online or offline. Initially, all folders are set online.", + "id": "script-api:dw/content/Folder#isOnline", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the folder is set online or\noffline. Initially, all folders are set online.", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "folder.isonline" + ], + "title": "Folder.isOnline" + }, + { + "description": "Indicates if this is the root folder.", + "id": "script-api:dw/content/Folder#isRoot", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.isRoot", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if this is the root folder.", + "heading": "Description" + } + ], + "signature": "isRoot(): boolean", + "source": "script-api", + "tags": [ + "isroot", + "folder.isroot" + ], + "title": "Folder.isRoot" + }, + { + "description": "Indicates if the folder is set online or offline. Initially, all folders are set online.", + "id": "script-api:dw/content/Folder#online", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.online", + "sections": [ + { + "body": "Indicates if the folder is set online or\noffline. Initially, all folders are set online.", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "folder.online" + ], + "title": "Folder.online" + }, + { + "description": "Returns the online content objects for this folder, sorted by position.", + "id": "script-api:dw/content/Folder#onlineContent", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.onlineContent", + "sections": [ + { + "body": "Returns the online content objects for this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "readonly onlineContent: Collection", + "source": "script-api", + "tags": [ + "onlinecontent", + "folder.onlinecontent" + ], + "title": "Folder.onlineContent" + }, + { + "description": "Returns the online subfolders of this folder, sorted by position.", + "id": "script-api:dw/content/Folder#onlineSubFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.onlineSubFolders", + "sections": [ + { + "body": "Returns the online subfolders of this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "readonly onlineSubFolders: Collection", + "source": "script-api", + "tags": [ + "onlinesubfolders", + "folder.onlinesubfolders" + ], + "title": "Folder.onlineSubFolders" + }, + { + "description": "Returns the page description for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#pageDescription", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageDescription", + "sections": [ + { + "body": "Returns the page description for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string | null", + "source": "script-api", + "tags": [ + "pagedescription", + "folder.pagedescription" + ], + "title": "Folder.pageDescription" + }, + { + "description": "Returns the page keywords for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#pageKeywords", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageKeywords", + "sections": [ + { + "body": "Returns the page keywords for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string | null", + "source": "script-api", + "tags": [ + "pagekeywords", + "folder.pagekeywords" + ], + "title": "Folder.pageKeywords" + }, + { + "description": "Returns the page title for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#pageTitle", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageTitle", + "sections": [ + { + "body": "Returns the page title for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string | null", + "source": "script-api", + "tags": [ + "pagetitle", + "folder.pagetitle" + ], + "title": "Folder.pageTitle" + }, + { + "description": "Returns the page URL for this folder using the value in the current locale, or returns null if no value was found.", + "id": "script-api:dw/content/Folder#pageURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.pageURL", + "sections": [ + { + "body": "Returns the page URL for this folder using the value in\nthe current locale, or returns null if no value was found.", + "heading": "Description" + } + ], + "signature": "readonly pageURL: string | null", + "source": "script-api", + "tags": [ + "pageurl", + "folder.pageurl" + ], + "title": "Folder.pageURL" + }, + { + "description": "Returns the parent folder of this folder.", + "id": "script-api:dw/content/Folder#parent", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.parent", + "sections": [ + { + "body": "Returns the parent folder of this folder.", + "heading": "Description" + } + ], + "signature": "readonly parent: Folder", + "source": "script-api", + "tags": [ + "parent", + "folder.parent" + ], + "title": "Folder.parent" + }, + { + "description": "Indicates if this is the root folder.", + "id": "script-api:dw/content/Folder#root", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.root", + "sections": [ + { + "body": "Indicates if this is the root folder.", + "heading": "Description" + } + ], + "signature": "readonly root: boolean", + "source": "script-api", + "tags": [ + "root", + "folder.root" + ], + "title": "Folder.root" + }, + { + "description": "Returns the folder's sitemap change frequency.", + "id": "script-api:dw/content/Folder#siteMapChangeFrequency", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapChangeFrequency", + "sections": [ + { + "body": "Returns the folder's sitemap change frequency.", + "heading": "Description" + } + ], + "signature": "readonly siteMapChangeFrequency: string", + "source": "script-api", + "tags": [ + "sitemapchangefrequency", + "folder.sitemapchangefrequency" + ], + "title": "Folder.siteMapChangeFrequency" + }, + { + "description": "Returns the folder's sitemap inclusion.", + "id": "script-api:dw/content/Folder#siteMapIncluded", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapIncluded", + "sections": [ + { + "body": "Returns the folder's sitemap inclusion.", + "heading": "Description" + } + ], + "signature": "readonly siteMapIncluded: number", + "source": "script-api", + "tags": [ + "sitemapincluded", + "folder.sitemapincluded" + ], + "title": "Folder.siteMapIncluded" + }, + { + "description": "Returns the folder's sitemap priority.", + "id": "script-api:dw/content/Folder#siteMapPriority", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.siteMapPriority", + "sections": [ + { + "body": "Returns the folder's sitemap priority.", + "heading": "Description" + } + ], + "signature": "readonly siteMapPriority: number", + "source": "script-api", + "tags": [ + "sitemappriority", + "folder.sitemappriority" + ], + "title": "Folder.siteMapPriority" + }, + { + "description": "Returns the subfolders of this folder, sorted by position.", + "id": "script-api:dw/content/Folder#subFolders", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.subFolders", + "sections": [ + { + "body": "Returns the subfolders of this folder, sorted by position.", + "heading": "Description" + } + ], + "signature": "readonly subFolders: Collection", + "source": "script-api", + "tags": [ + "subfolders", + "folder.subfolders" + ], + "title": "Folder.subFolders" + }, + { + "description": "Returns the name of the template used to render the folder in the store front.", + "id": "script-api:dw/content/Folder#template", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Folder", + "qualifiedName": "dw.content.Folder.template", + "sections": [ + { + "body": "Returns the name of the template used to render the folder\nin the store front.", + "heading": "Description" + } + ], + "signature": "readonly template: string", + "source": "script-api", + "tags": [ + "template", + "folder.template" + ], + "title": "Folder.template" + }, + { + "description": "Class representing a collection of dw.content.Content assets, and a dw.content.Folder hierarchy organizing these content assets. Currently only one library is allowed per site. An instance of this library can be obtained by calling dw.content.ContentMgr.getSiteLibrary.", + "id": "script-api:dw/content/Library", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.Library", + "sections": [ + { + "body": "Class representing a collection of dw.content.Content assets, and a\ndw.content.Folder hierarchy organizing these content assets.\nCurrently only one library is allowed per site. An instance of this library\ncan be obtained by calling dw.content.ContentMgr.getSiteLibrary.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "library", + "dw.content.library", + "dw/content" + ], + "title": "Library" + }, + { + "description": "Returns the CMS channel of the library.", + "id": "script-api:dw/content/Library#CMSChannelID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.CMSChannelID", + "sections": [ + { + "body": "Returns the CMS channel of the library.", + "heading": "Description" + } + ], + "signature": "readonly CMSChannelID: string", + "source": "script-api", + "tags": [ + "cmschannelid", + "library.cmschannelid" + ], + "title": "Library.CMSChannelID" + }, + { + "description": "Returns the ID of this library.", + "id": "script-api:dw/content/Library#ID", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.ID", + "sections": [ + { + "body": "Returns the ID of this library.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "library.id" + ], + "title": "Library.ID" + }, + { + "description": "Returns the display name for the library as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Library#displayName", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.displayName", + "sections": [ + { + "body": "Returns the display name for the library as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "library.displayname" + ], + "title": "Library.displayName" + }, + { + "description": "Returns the CMS channel of the library.", + "id": "script-api:dw/content/Library#getCMSChannelID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getCMSChannelID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the CMS channel of the library.", + "heading": "Description" + } + ], + "signature": "getCMSChannelID(): string", + "source": "script-api", + "tags": [ + "getcmschannelid", + "library.getcmschannelid" + ], + "title": "Library.getCMSChannelID" + }, + { + "description": "Returns the display name for the library as known in the current locale or null if it cannot be found.", + "id": "script-api:dw/content/Library#getDisplayName", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the display name for the library as known in the current\nlocale or null if it cannot be found.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "library.getdisplayname" + ], + "title": "Library.getDisplayName" + }, + { + "description": "Returns the ID of this library.", + "id": "script-api:dw/content/Library#getID", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this library.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "library.getid" + ], + "title": "Library.getID" + }, + { + "description": "Returns the root folder for this library.", + "id": "script-api:dw/content/Library#getRoot", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.getRoot", + "returns": { + "type": "Folder" + }, + "sections": [ + { + "body": "Returns the root folder for this library.", + "heading": "Description" + } + ], + "signature": "getRoot(): Folder", + "source": "script-api", + "tags": [ + "getroot", + "library.getroot" + ], + "title": "Library.getRoot" + }, + { + "description": "Returns the root folder for this library.", + "id": "script-api:dw/content/Library#root", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/Library", + "qualifiedName": "dw.content.Library.root", + "sections": [ + { + "body": "Returns the root folder for this library.", + "heading": "Description" + } + ], + "signature": "readonly root: Folder", + "source": "script-api", + "tags": [ + "root", + "library.root" + ], + "title": "Library.root" + }, + { + "description": "The class represents a content snippet with markup. This is typically a HTML content snippet. The class also processes the special links from Commerce Cloud Digital content management and automatically rewrites them into links for use in the storefront.", + "id": "script-api:dw/content/MarkupText", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.MarkupText", + "sections": [ + { + "body": "The class represents a content snippet with markup. This is typically a\nHTML content snippet. The class also processes the special links from\nCommerce Cloud Digital content management and automatically rewrites them into\nlinks for use in the storefront.\n\nThe following special links can be used inside of a MarkupText:\n\n- `$url('' [, '', '', '', '', ...])$`\n\nDescription:\n\nThe `$url()$` function creates and absolute URL and retains the protocol incoming\nrequest.\n\nExample:\n\nMarkupText:\n\n`$url('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`\n\nis rewritten to:\n\n`http://:/on/demandware.store//default/MyLinkPipeline-Start?key1=value1&key2=value2`\n\nNote that the incoming protocol was http in the example above.\n\n- `$httpUrl('' [, '', '', '', '', ...])$`\n\nDescription:\n\nThe `$httpUrl()$` function creates an absolute URL but always with the fix protocol\n\"http\". The protocol type of the incomming request is ignored.\n\nExample:\n\nMarkupText:\n\n`$httpUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`\n\nis rewritten to:\n\n`http://:'/on/demandware.store//default/MyLinkPipeline-Start?key1=value1&key2=value2`\n\n- `$httpsUrl('' [, '', '', '', '', ...])$`\n\nDescription:\n\nThe `$httpsUrl()$` function creates an absolute URL but always with the fix protocol\n\"https\". The protocol type of the incomming request is ignored.\n\nExample:\n\nMarkupText:\n\n`$httpsUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`\n\nis rewritten to:\n\n`https://:/on/demandware.store//default/MyLinkPipeline-Start?key1=value1&key2=value2`\n\n- `$include('' [, '', '', '', '', ...])$`\n\nDescription:\n\nThe `$include()$` function creates a relative URL which is post processed by the\nCommerce Cloud Digital Webadapter. The result is the content generated by the given pipeline call.\n\nExample:\n\nMarkupText:\n\n`$include('MyIncludePipeline-Start','key1', 'value1', 'key2' ,'value2')$`\n\nresults in the content delivered by the 'MyIncludePipeline-Start' pipeline.\n\n- `...?$staticlink$`\n\nDescription:\n\nThe `$staticlink$` function can be used to create a URL to a static resource\n(such as an image). The URL being generated depends on the owner of the MarkupText instance.\nFor example, a product's long description (which is a MarkupText) will generate\nlinks to static resources within the catalog. Possible URL targets are catalogs\n(for catalog related objects like products and categories), the content library\n(for library related objects like folders and assets) or the organization\n(for all objects that are not catalog or library related).\n\nExample:\n\nMarkupText: (owned by a content asset)\n\n``\n\nis rewritten to:\n\n`//default/v1178201405900/demo/content/bullet.gif\">`\n\nNote: The comma symbol `,` is not supported in parameter values for the link functions.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "markuptext", + "dw.content.markuptext", + "dw/content" + ], + "title": "MarkupText" + }, + { + "description": "Returns the content with all links rewritten for storefront use.", + "id": "script-api:dw/content/MarkupText#getMarkup", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.getMarkup", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the content with all links rewritten for storefront use.", + "heading": "Description" + } + ], + "signature": "getMarkup(): string", + "source": "script-api", + "tags": [ + "getmarkup", + "markuptext.getmarkup" + ], + "title": "MarkupText.getMarkup" + }, + { + "description": "Returns the original content source, without any links re-written.", + "id": "script-api:dw/content/MarkupText#getSource", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.getSource", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the original content source, without any links re-written.", + "heading": "Description" + } + ], + "signature": "getSource(): string", + "source": "script-api", + "tags": [ + "getsource", + "markuptext.getsource" + ], + "title": "MarkupText.getSource" + }, + { + "description": "Returns the content with all links rewritten for storefront use.", + "id": "script-api:dw/content/MarkupText#markup", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.markup", + "sections": [ + { + "body": "Returns the content with all links rewritten for storefront use.", + "heading": "Description" + } + ], + "signature": "readonly markup: string", + "source": "script-api", + "tags": [ + "markup", + "markuptext.markup" + ], + "title": "MarkupText.markup" + }, + { + "description": "Returns the original content source, without any links re-written.", + "id": "script-api:dw/content/MarkupText#source", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.source", + "sections": [ + { + "body": "Returns the original content source, without any links re-written.", + "heading": "Description" + } + ], + "signature": "readonly source: string", + "source": "script-api", + "tags": [ + "source", + "markuptext.source" + ], + "title": "MarkupText.source" + }, + { + "description": "Returns a string representation of this class, the same as getMarkup().", + "id": "script-api:dw/content/MarkupText#toString", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MarkupText", + "qualifiedName": "dw.content.MarkupText.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this class, the same as getMarkup().", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "markuptext.tostring" + ], + "title": "MarkupText.toString" + }, + { + "description": "This class represents references to media content (such as images) located within Commerce Cloud Digital or on external systems.", + "id": "script-api:dw/content/MediaFile", + "kind": "class", + "packagePath": "dw/content", + "parentId": "script-api:dw/content", + "qualifiedName": "dw.content.MediaFile", + "sections": [ + { + "body": "This class represents references to media content (such as images)\nlocated within Commerce Cloud Digital or on external systems.\n\nParameter `transform`:\n\nSome methods allow the specification of image transformation parameters. Image\ntransformation is only performed if the Dynamic Imaging Service (DIS) is available\nfor the Commerce Cloud Digital instance, otherwise a standard static content URL\nis returned. The to-be-transformed image needs to be hosted on Commerce Cloud\nDigital.\n\nImage transformation parameters are specified as JavaScript object literal. They\nare translated into URL parameters. See Create Image Transformation URLs.\n\nType of transformation\nParameters\nDescription\n\nScale an image\n\n`scaleWidth`\n\n`scaleHeight`\n\n`scaleMode`\n\nThe `scaleWidth` and `scaleHeight` parameters\nare both integers; setting one of these parameters triggers a\nscaling operation. If both are provided, the one that scales the\nimage less is used to calculate the scale factor. The image is then\nautomatically cropped accord to the second dimension, with a\ncentered position of the cropped area. If the parameter would scale\nthe image larger, only this operation is applied, if the image\nremains within acceptable pixel dimensions.\n\nNote: `scaleMode` can only be used in combination with `scaleHeight` and `scaleWidth`.\n\nThe `scaleMode` parameter can be set to `cut`\nor `fit`. The default `scaleMode` is\n`cut`, the behavior of which is explained above. If you\nspecify `fit` as the `scaleMode`, the system\nscales the image into the given box of dimensions while keeping the\naspect ratio (possibly resulting in a smaller image in one\ndimension).\n\nOverlay an image\n\n`imageX`\n\n`imageY`\n\n`imageURI`\n\nThe `imageX` and `imageY` parameters are both\nintegers. Valid values for these parameters are 0 or greater.\n\nSupported formats are `png`, `jpg`, `jp2`, and\n`gif`.\n\nThe `imageURI` parameter can be set to the absolute path\nof the overlaid image. The value of the `imageURI`\nparameter must be given in proper URL encoding, and it cannot exceed\n400 characters in length. The path may include query string\nparameters, which supports dynamically generating the overlaid image\nitself through this service; that is, the overlaid image can itself\nbe a transformed image.\n\nIf the overlaid image extends over the primary image's boundaries,\nthe overlaid image is cropped so that it fits directly over the\nprimary image.\n\nCrop an image\n\n`cropX`\n\n`cropY`\n\n`cropWidth`\n\n`cropHeight`\n\nThe `cropX`, `cropY`, `cropWidth`,\n`cropHeight` parameters are integers. All four parameters\nmust be specified to trigger a cropping operation.\n\nValid values for the `cropX` and `cropY`\nparameters are 0 or greater. If the crop location defined by\n`cropX` and `cropY` is outside the image area,\nnothing is cropped.\n\nValid values for the `cropWidth` and\n`cropHeight` parameters are 10 or greater. If the\n`cropWidth` and `cropHeight` parameters\nspecify a size that is greater than the original image, the crop\narea is reduced to the actual image area. If `cropWidth`\nand `cropHeight` are 0 or less, no transformation is\napplied.\n\nFormat an image\n`format`\n\nThe `format` parameter specifies the target format of\nimage. Supported formats are `png`, `jpg`, `jp2`, and\n`gif`. If no target format is specified, no format\nconversion is performed.\n\nThe attribute value must reference the source image. Source image's\nformat is recognized by the file extension which must be\n`tif`, `tiff`, `jpg`,\n`jpeg`, `png`, or `gif`.\n\nIn the generated URL the file extension of the target format is used\nin the URL path. This is to make sure the image is loaded from an\nURL with a matching file extension. The source format is provided as\nURL parameter.\n\nAdjust image compression quality\n`quality`\n\nThe `quality` parameter specifies a quality setting for `jpg` and `jp2` images,\nand specifies the compression level for `png` images.\n\nFor `jpg` and `jp2` images, you can set values from 1–100 for the highest quality.\nThe default quality is 80. If you're not changing the default quality, you don't need to pass in a value.\n\nFor `png` images, the quality setting has no effect on the appearance of the `png`, since the compression is always lossless.\nInstead you can use the quality setting to set the zlib compression level and filter-type for PNG images.\nThe tens digit sets the zlib compression level(1-9). The ones digit sets the filter type.\n\nIf the `png` setting is not present or set to 0, it uses a default value of 75.\nIf this setting is set to 100, it actually equals the quality setting 90.\n\nAdjust Metadata stripping\n`strip`\n\nThe `strip` parameter specifies if metadata like EXIF and color profiles is\nstripped from the image during transformation.\n\nValid values for the `strip` parameter are between `true` and `false`.\nThe default is `true`\n\nChange background color\n`bgcolor(color) or bgcolor(color+alpha)`\n\nThe `bgcolor` parameter specifies the background color for images that support transparency\nas well as JPEG images when being converted from a format that supports transparency.\nOptionally, alpha setting for PNG images are also supported.\n\n`bgcolor` expects a 6 digit hexadecimal value of RGB with an optional\ntwo hexadecimal characters representing alpha value that determines transparency.\n\nFF0000 = Red\n\nFF000077 = Red with 50% transparency\n\nAlpha values are optional. When the alpha value is omitted, the resulting color is opaque.\nAlpha values are only valid when the image output format is PNG.\n\nExample:\n\nThe following code\n\n`var url = product.getImage('thumbnail', 0).getImageURL({scaleWidth: 100, format: 'jpg'});`\n\nwill produce an image transformation URL like\n\n`http:///.../on/demandware.static/...//image.jpg?sw=100&sfrm=png`.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mediafile", + "dw.content.mediafile", + "dw/content" + ], + "title": "MediaFile" + }, + { + "description": "Returns an URL to the referenced media file. The returned URL is a relative URL.", + "id": "script-api:dw/content/MediaFile#URL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.URL", + "sections": [ + { + "body": "Returns an URL to the referenced media file. The\nreturned URL is a relative URL.", + "heading": "Description" + } + ], + "signature": "readonly URL: URL", + "source": "script-api", + "tags": [ + "url", + "mediafile.url" + ], + "title": "MediaFile.URL" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol for the reference is the current protocol of the current HTTP request.", + "id": "script-api:dw/content/MediaFile#absURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.absURL", + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol for the reference is the current protocol of the current\nHTTP request.", + "heading": "Description" + } + ], + "signature": "readonly absURL: URL", + "source": "script-api", + "tags": [ + "absurl", + "mediafile.absurl" + ], + "title": "MediaFile.absURL" + }, + { + "description": "Returns the alternative text assigned to the media file in current requests locale. If no alternative text was assigned or if no defaulting rule was defined, the method returns null.", + "id": "script-api:dw/content/MediaFile#alt", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.alt", + "sections": [ + { + "body": "Returns the alternative text assigned to the media file in current\nrequests locale. If no alternative text was assigned or if no defaulting\nrule was defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "readonly alt: string | null", + "source": "script-api", + "tags": [ + "alt", + "mediafile.alt" + ], + "title": "MediaFile.alt" + }, + { + "description": "Returns an URL to the referenced image file. Image transformation can be applied to the image. The protocol for the reference is the current protocol of the current HTTP request.", + "id": "script-api:dw/content/MediaFile#getAbsImageURL", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "transform", + "type": "any" + } + ], + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAbsImageURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced image file. Image transformation\ncan be applied to the image. The protocol for the reference is the\ncurrent protocol of the current HTTP request.\n\nImage transformation can only be applied to images that are hosted on\nCommerce Cloud Digital.", + "heading": "Description" + } + ], + "signature": "getAbsImageURL(transform: any): URL", + "source": "script-api", + "tags": [ + "getabsimageurl", + "mediafile.getabsimageurl" + ], + "title": "MediaFile.getAbsImageURL" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol for the reference is the current protocol of the current HTTP request.", + "id": "script-api:dw/content/MediaFile#getAbsURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAbsURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol for the reference is the current protocol of the current\nHTTP request.", + "heading": "Description" + } + ], + "signature": "getAbsURL(): URL", + "source": "script-api", + "tags": [ + "getabsurl", + "mediafile.getabsurl" + ], + "title": "MediaFile.getAbsURL" + }, + { + "description": "Returns the alternative text assigned to the media file in current requests locale. If no alternative text was assigned or if no defaulting rule was defined, the method returns null.", + "id": "script-api:dw/content/MediaFile#getAlt", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getAlt", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the alternative text assigned to the media file in current\nrequests locale. If no alternative text was assigned or if no defaulting\nrule was defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "getAlt(): string | null", + "source": "script-api", + "tags": [ + "getalt", + "mediafile.getalt" + ], + "title": "MediaFile.getAlt" + }, + { + "description": "Returns an URL to the referenced image file. Image transformation can be applied to the image. The protocol is http.", + "id": "script-api:dw/content/MediaFile#getHttpImageURL", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "transform", + "type": "any" + } + ], + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpImageURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced image file. Image transformation\ncan be applied to the image. The protocol is http.\n\nImage transformation can only be applied to images that are hosted on\nCommerce Cloud Digital.", + "heading": "Description" + } + ], + "signature": "getHttpImageURL(transform: any): URL", + "source": "script-api", + "tags": [ + "gethttpimageurl", + "mediafile.gethttpimageurl" + ], + "title": "MediaFile.getHttpImageURL" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol is http.", + "id": "script-api:dw/content/MediaFile#getHttpURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol is http.", + "heading": "Description" + } + ], + "signature": "getHttpURL(): URL", + "source": "script-api", + "tags": [ + "gethttpurl", + "mediafile.gethttpurl" + ], + "title": "MediaFile.getHttpURL" + }, + { + "description": "Returns an URL to the referenced image file. Image transformation can be applied to the image. The protocol is https.", + "id": "script-api:dw/content/MediaFile#getHttpsImageURL", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "transform", + "type": "any" + } + ], + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpsImageURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced image file. Image transformation\ncan be applied to the image. The protocol is https.\n\nImage transformation can only be applied to images that are hosted on\nCommerce Cloud Digital.", + "heading": "Description" + } + ], + "signature": "getHttpsImageURL(transform: any): URL", + "source": "script-api", + "tags": [ + "gethttpsimageurl", + "mediafile.gethttpsimageurl" + ], + "title": "MediaFile.getHttpsImageURL" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol is https.", + "id": "script-api:dw/content/MediaFile#getHttpsURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getHttpsURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol is https.", + "heading": "Description" + } + ], + "signature": "getHttpsURL(): URL", + "source": "script-api", + "tags": [ + "gethttpsurl", + "mediafile.gethttpsurl" + ], + "title": "MediaFile.getHttpsURL" + }, + { + "description": "Returns an URL to the referenced image file. Image transformation can be applied to the image.", + "id": "script-api:dw/content/MediaFile#getImageURL", + "kind": "method", + "packagePath": "dw/content", + "params": [ + { + "name": "transform", + "type": "any" + } + ], + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getImageURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced image file. Image transformation\ncan be applied to the image.\n\nImage transformation can only be applied to images that are hosted on\nCommerce Cloud Digital.", + "heading": "Description" + } + ], + "signature": "getImageURL(transform: any): URL", + "source": "script-api", + "tags": [ + "getimageurl", + "mediafile.getimageurl" + ], + "title": "MediaFile.getImageURL" + }, + { + "description": "Returns the title assigned to the media file in current requests locale. If no title was assigned or if no defaulting rule was defined, the method returns null.", + "id": "script-api:dw/content/MediaFile#getTitle", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getTitle", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the title assigned to the media file in current requests locale.\nIf no title was assigned or if no defaulting rule was defined, the\nmethod returns null.", + "heading": "Description" + } + ], + "signature": "getTitle(): string | null", + "source": "script-api", + "tags": [ + "gettitle", + "mediafile.gettitle" + ], + "title": "MediaFile.getTitle" + }, + { + "description": "Returns an URL to the referenced media file. The returned URL is a relative URL.", + "id": "script-api:dw/content/MediaFile#getURL", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced media file. The\nreturned URL is a relative URL.", + "heading": "Description" + } + ], + "signature": "getURL(): URL", + "source": "script-api", + "tags": [ + "geturl", + "mediafile.geturl" + ], + "title": "MediaFile.getURL" + }, + { + "deprecated": { + "message": "Use getURL instead." + }, + "description": "Returns an URL to the referenced media file. The returned URL is a relative URL.", + "id": "script-api:dw/content/MediaFile#getUrl", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getUrl", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns an URL to the referenced media file. The\nreturned URL is a relative URL.", + "heading": "Description" + } + ], + "signature": "getUrl(): URL", + "source": "script-api", + "tags": [ + "geturl", + "mediafile.geturl" + ], + "title": "MediaFile.getUrl" + }, + { + "description": "Returns the view type annotation for the media file. The method returns null, if the media file has no view type annotation.", + "id": "script-api:dw/content/MediaFile#getViewType", + "kind": "method", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.getViewType", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the view type annotation for the media file. The method returns\nnull, if the media file has no view type annotation.", + "heading": "Description" + } + ], + "signature": "getViewType(): string | null", + "source": "script-api", + "tags": [ + "getviewtype", + "mediafile.getviewtype" + ], + "title": "MediaFile.getViewType" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol is http.", + "id": "script-api:dw/content/MediaFile#httpURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.httpURL", + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol is http.", + "heading": "Description" + } + ], + "signature": "readonly httpURL: URL", + "source": "script-api", + "tags": [ + "httpurl", + "mediafile.httpurl" + ], + "title": "MediaFile.httpURL" + }, + { + "description": "Returns an absolute URL to the referenced media file. The protocol is https.", + "id": "script-api:dw/content/MediaFile#httpsURL", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.httpsURL", + "sections": [ + { + "body": "Returns an absolute URL to the referenced media file. The\nprotocol is https.", + "heading": "Description" + } + ], + "signature": "readonly httpsURL: URL", + "source": "script-api", + "tags": [ + "httpsurl", + "mediafile.httpsurl" + ], + "title": "MediaFile.httpsURL" + }, + { + "description": "Returns the title assigned to the media file in current requests locale. If no title was assigned or if no defaulting rule was defined, the method returns null.", + "id": "script-api:dw/content/MediaFile#title", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.title", + "sections": [ + { + "body": "Returns the title assigned to the media file in current requests locale.\nIf no title was assigned or if no defaulting rule was defined, the\nmethod returns null.", + "heading": "Description" + } + ], + "signature": "readonly title: string | null", + "source": "script-api", + "tags": [ + "title", + "mediafile.title" + ], + "title": "MediaFile.title" + }, + { + "deprecated": { + "message": "Use getURL instead." + }, + "description": "Returns an URL to the referenced media file. The returned URL is a relative URL.", + "id": "script-api:dw/content/MediaFile#url", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.url", + "sections": [ + { + "body": "Returns an URL to the referenced media file. The\nreturned URL is a relative URL.", + "heading": "Description" + } + ], + "signature": "readonly url: URL", + "source": "script-api", + "tags": [ + "url", + "mediafile.url" + ], + "title": "MediaFile.url" + }, + { + "description": "Returns the view type annotation for the media file. The method returns null, if the media file has no view type annotation.", + "id": "script-api:dw/content/MediaFile#viewType", + "kind": "property", + "packagePath": "dw/content", + "parentId": "script-api:dw/content/MediaFile", + "qualifiedName": "dw.content.MediaFile.viewType", + "sections": [ + { + "body": "Returns the view type annotation for the media file. The method returns\nnull, if the media file has no view type annotation.", + "heading": "Description" + } + ], + "signature": "readonly viewType: string | null", + "source": "script-api", + "tags": [ + "viewtype", + "mediafile.viewtype" + ], + "title": "MediaFile.viewType" + }, + { + "description": "18 declarations", + "id": "script-api:dw/crypto", + "kind": "package", + "packagePath": "dw/crypto", + "qualifiedName": "dw.crypto", + "source": "script-api", + "tags": [ + "dw/crypto", + "dw.crypto" + ], + "title": "dw.crypto" + }, + { + "description": "This class is used as a reference to a certificate or public key.", + "id": "script-api:dw/crypto/CertificateRef", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.CertificateRef", + "sections": [ + { + "body": "This class is used as a reference to a certificate or public key.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "certificateref", + "dw.crypto.certificateref", + "dw/crypto" + ], + "title": "CertificateRef" + }, + { + "description": "Returns the string representation of this CertificateRef.", + "id": "script-api:dw/crypto/CertificateRef#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/CertificateRef", + "qualifiedName": "dw.crypto.CertificateRef.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the string representation of this CertificateRef.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "certificateref.tostring" + ], + "title": "CertificateRef.toString" + }, + { + "description": "Utilities for managing certificates and keys.", + "id": "script-api:dw/crypto/CertificateUtils", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.CertificateUtils", + "sections": [ + { + "body": "Utilities for managing certificates and keys.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "certificateutils", + "dw.crypto.certificateutils", + "dw/crypto" + ], + "title": "CertificateUtils" + }, + { + "description": "Gets the certificate from the given certificate reference.", + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "returns": { + "type": "X509Certificate" + }, + "sections": [ + { + "body": "Gets the certificate from the given certificate reference.", + "heading": "Description" + } + ], + "signature": "static getCertificate(certificateRef: CertificateRef): X509Certificate", + "source": "script-api", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "throws": [ + { + "description": "if the reference is invalid or does not refer to an X.509 certificate", + "type": "Exception" + } + ], + "title": "CertificateUtils.getCertificate" + }, + { + "description": "Gets the public certificate from the given private key reference.", + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "returns": { + "type": "X509Certificate" + }, + "sections": [ + { + "body": "Gets the public certificate from the given private key reference.", + "heading": "Description" + } + ], + "signature": "static getCertificate(keyRef: KeyRef): X509Certificate", + "source": "script-api", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "throws": [ + { + "description": "if the reference is invalid or there is no X.509 certificate", + "type": "Exception" + } + ], + "title": "CertificateUtils.getCertificate" + }, + { + "description": "Gets the certificate from the given certificate reference.", + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "returns": { + "type": "X509Certificate" + }, + "sections": [ + { + "body": "Gets the certificate from the given certificate reference.", + "heading": "Description" + } + ], + "signature": "static getCertificate(certificateRef: CertificateRef): X509Certificate", + "source": "script-api", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "throws": [ + { + "description": "if the reference is invalid or does not refer to an X.509 certificate", + "type": "Exception" + } + ], + "title": "CertificateUtils.getCertificate" + }, + { + "description": "Gets the public certificate from the given private key reference.", + "id": "script-api:dw/crypto/CertificateUtils#getCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getCertificate", + "returns": { + "type": "X509Certificate" + }, + "sections": [ + { + "body": "Gets the public certificate from the given private key reference.", + "heading": "Description" + } + ], + "signature": "static getCertificate(keyRef: KeyRef): X509Certificate", + "source": "script-api", + "tags": [ + "getcertificate", + "certificateutils.getcertificate" + ], + "throws": [ + { + "description": "if the reference is invalid or there is no X.509 certificate", + "type": "Exception" + } + ], + "title": "CertificateUtils.getCertificate" + }, + { + "description": "Encode the certificate to the base64-encoded DER format.", + "id": "script-api:dw/crypto/CertificateUtils#getEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedCertificate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encode the certificate to the base64-encoded DER format.", + "heading": "Description" + } + ], + "signature": "static getEncodedCertificate(certificateRef: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencodedcertificate", + "certificateutils.getencodedcertificate" + ], + "title": "CertificateUtils.getEncodedCertificate" + }, + { + "description": "Encode the certificate to the base64-encoded DER format.", + "id": "script-api:dw/crypto/CertificateUtils#getEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedCertificate", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encode the certificate to the base64-encoded DER format.", + "heading": "Description" + } + ], + "signature": "static getEncodedCertificate(certificateRef: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencodedcertificate", + "certificateutils.getencodedcertificate" + ], + "title": "CertificateUtils.getEncodedCertificate" + }, + { + "description": "Gets the public key from the given certificate reference.", + "id": "script-api:dw/crypto/CertificateUtils#getEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedPublicKey", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the public key from the given certificate reference.\n\nIt is exported in the standard X.509 SubjectPublicKeyInfo format and base64-encoded.", + "heading": "Description" + } + ], + "signature": "static getEncodedPublicKey(certificateRef: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencodedpublickey", + "certificateutils.getencodedpublickey" + ], + "title": "CertificateUtils.getEncodedPublicKey" + }, + { + "description": "Gets the public key from the given certificate reference.", + "id": "script-api:dw/crypto/CertificateUtils#getEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.getEncodedPublicKey", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the public key from the given certificate reference.\n\nIt is exported in the standard X.509 SubjectPublicKeyInfo format and base64-encoded.", + "heading": "Description" + } + ], + "signature": "static getEncodedPublicKey(certificateRef: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencodedpublickey", + "certificateutils.getencodedpublickey" + ], + "title": "CertificateUtils.getEncodedPublicKey" + }, + { + "description": "Parse the certificate from the base64-encoded DER format.", + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificate", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedCertificate", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the certificate from the base64-encoded DER format.", + "heading": "Description" + } + ], + "signature": "static parseEncodedCertificate(certificate: string): CertificateRef", + "source": "script-api", + "tags": [ + "parseencodedcertificate", + "certificateutils.parseencodedcertificate" + ], + "title": "CertificateUtils.parseEncodedCertificate" + }, + { + "description": "Parse the certificate from the base64-encoded DER format.", + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedCertificate", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificate", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedCertificate", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the certificate from the base64-encoded DER format.", + "heading": "Description" + } + ], + "signature": "static parseEncodedCertificate(certificate: string): CertificateRef", + "source": "script-api", + "tags": [ + "parseencodedcertificate", + "certificateutils.parseencodedcertificate" + ], + "title": "CertificateUtils.parseEncodedCertificate" + }, + { + "description": "Parse the public key from the given key in X.509 SubjectPublicKeyInfo format.", + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "encodedKey", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedPublicKey", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the public key from the given key in X.509 SubjectPublicKeyInfo format.\n\nThe resulting reference contains only the public key. It can be used for cryptographic operations, but not\nanything that requires the full certificate.", + "heading": "Description" + } + ], + "signature": "static parseEncodedPublicKey(algorithm: string, encodedKey: string): CertificateRef", + "source": "script-api", + "tags": [ + "parseencodedpublickey", + "certificateutils.parseencodedpublickey" + ], + "title": "CertificateUtils.parseEncodedPublicKey" + }, + { + "description": "Parse the public key from the given key in X.509 SubjectPublicKeyInfo format.", + "id": "script-api:dw/crypto/CertificateUtils#parseEncodedPublicKey", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "encodedKey", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parseEncodedPublicKey", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the public key from the given key in X.509 SubjectPublicKeyInfo format.\n\nThe resulting reference contains only the public key. It can be used for cryptographic operations, but not\nanything that requires the full certificate.", + "heading": "Description" + } + ], + "signature": "static parseEncodedPublicKey(algorithm: string, encodedKey: string): CertificateRef", + "source": "script-api", + "tags": [ + "parseencodedpublickey", + "certificateutils.parseencodedpublickey" + ], + "title": "CertificateUtils.parseEncodedPublicKey" + }, + { + "description": "Parse the public key from the given base64-encoded JWK string.", + "id": "script-api:dw/crypto/CertificateUtils#parsePublicKeyFromJWK", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jwk", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parsePublicKeyFromJWK", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the public key from the given base64-encoded JWK string.\n\nThis returns the public key portion of the JWK, not the `x5c` certificate chain.\n\nOnly RSA and EC keys are supported.\n\nThe resulting reference contains only the public key. It can be used for cryptographic operations, but not\nanything that requires the full certificate.", + "heading": "Description" + } + ], + "signature": "static parsePublicKeyFromJWK(jwk: string): CertificateRef", + "source": "script-api", + "tags": [ + "parsepublickeyfromjwk", + "certificateutils.parsepublickeyfromjwk" + ], + "title": "CertificateUtils.parsePublicKeyFromJWK" + }, + { + "description": "Parse the public key from the given base64-encoded JWK string.", + "id": "script-api:dw/crypto/CertificateUtils#parsePublicKeyFromJWK", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jwk", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/CertificateUtils", + "qualifiedName": "dw.crypto.CertificateUtils.parsePublicKeyFromJWK", + "returns": { + "type": "CertificateRef" + }, + "sections": [ + { + "body": "Parse the public key from the given base64-encoded JWK string.\n\nThis returns the public key portion of the JWK, not the `x5c` certificate chain.\n\nOnly RSA and EC keys are supported.\n\nThe resulting reference contains only the public key. It can be used for cryptographic operations, but not\nanything that requires the full certificate.", + "heading": "Description" + } + ], + "signature": "static parsePublicKeyFromJWK(jwk: string): CertificateRef", + "source": "script-api", + "tags": [ + "parsepublickeyfromjwk", + "certificateutils.parsepublickeyfromjwk" + ], + "title": "CertificateUtils.parsePublicKeyFromJWK" + }, + { + "description": "This class allows access to encryption services offered through the Java Cryptography Architecture (JCA). At this time the implementation of the encryption/decryption methods is based on the default JCE provider of the JDK. See the Java documentation for a reference guide to the underlying security provider and information about the Secure Sockets Extension.", + "id": "script-api:dw/crypto/Cipher", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Cipher", + "sections": [ + { + "body": "This class allows access to encryption services offered through the Java\nCryptography Architecture (JCA). At this time the implementation of the\nencryption/decryption methods is based on the default JCE provider of the JDK.\nSee the Java documentation for a reference guide to the underlying security\nprovider and information about the Secure Sockets Extension.\n\nYou can find a good overview of the essential purposes of cryptography and\nsome common implementations in the Wikipedia article on cryptography.\nAlso see the website of the National Institute of Standards and Technology.\nThe format of various files used to hold keys, certificate signing requests,\nand the like, as well as some related algorithms, are defined in the PKCS series of\ndocuments published by RSALabs (the research arm of RSA Security).\n\nMany internet standards documenting security protocols and concepts are described\nin documents originally described as \"Request For Comment\" and thus widely known\nas RFCs. Many of them are available on the Internet FAQ Archives website.\n\ndw.crypto.Cipher is intentionally an Adapter to the full cryptography power supplied\nin the security provider implementation.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3 requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "cipher", + "dw.crypto.cipher", + "dw/crypto" + ], + "title": "Cipher" + }, + { + "description": "Strings containing keys, plain texts, cipher texts etc. are internally converted into byte arrays using this encoding (currently UTF8).", + "id": "script-api:dw/crypto/Cipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.CHAR_ENCODING", + "sections": [ + { + "body": "Strings containing keys, plain texts, cipher texts etc. are internally\nconverted into byte arrays using this encoding (currently UTF8).", + "heading": "Description" + } + ], + "signature": "static readonly CHAR_ENCODING = \"UTF8\"", + "source": "script-api", + "tags": [ + "char_encoding", + "cipher.char_encoding" + ], + "title": "Cipher.CHAR_ENCODING" + }, + { + "description": "Strings containing keys, plain texts, cipher texts etc. are internally converted into byte arrays using this encoding (currently UTF8).", + "id": "script-api:dw/crypto/Cipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.CHAR_ENCODING", + "sections": [ + { + "body": "Strings containing keys, plain texts, cipher texts etc. are internally\nconverted into byte arrays using this encoding (currently UTF8).", + "heading": "Description" + } + ], + "signature": "static readonly CHAR_ENCODING = \"UTF8\"", + "source": "script-api", + "tags": [ + "char_encoding", + "cipher.char_encoding" + ], + "title": "Cipher.CHAR_ENCODING" + }, + { + "description": "Decrypts the passed Base-64 encoded message using the passed key and applying the transformations described by the passed parameters.", + "id": "script-api:dw/crypto/Cipher#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64Msg", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.decrypt", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decrypts the passed Base-64 encoded message using the passed key and\napplying the transformations described by the passed parameters.\n\nDecryption is the process of getting back the original data from the\ncipher-text using a decryption key.", + "heading": "Description" + } + ], + "signature": "decrypt(base64Msg: string, key: string, transformation: string, saltOrIV: string, iterations: number): string", + "source": "script-api", + "tags": [ + "decrypt", + "cipher.decrypt" + ], + "title": "Cipher.decrypt" + }, + { + "description": "Lower-level decryption API. Decrypts the passed bytes using the specified key and applying the transformations described by the specified parameters.", + "id": "script-api:dw/crypto/Cipher#decryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "encryptedBytes", + "type": "Bytes" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.decryptBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Lower-level decryption API. Decrypts the passed bytes using the specified\nkey and applying the transformations described by the specified\nparameters.\n\nTypical usage:", + "heading": "Description" + } + ], + "signature": "decryptBytes(encryptedBytes: Bytes, key: string, transformation: string, saltOrIV: string, iterations: number): Bytes", + "source": "script-api", + "tags": [ + "decryptbytes", + "cipher.decryptbytes" + ], + "title": "Cipher.decryptBytes" + }, + { + "description": "Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.", + "examples": [ + "openssl genrsa -out rsaprivatekey.pem 2048", + "openssl rsa -in rsaprivatekey.pem -out publickey.pem -pubout", + "openssl pkcs8 -topk8 -in rsaprivatekey.pem -out privatekey.pem -nocrypt" + ], + "id": "script-api:dw/crypto/Cipher#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "message", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.encrypt", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypt the passed message by using the specified key and applying the\ntransformations described by the specified parameters.\n\nEncryption is the process of converting normal data or plain text to\nsomething incomprehensible or cipher-text by applying transformations,\nwhich are the operation (or set of operations) to be performed on given input\nto produce some output. A transformation always includes the name of a\ncryptographic algorithm (for example, RSA) and may be followed by a mode and padding scheme.\nThe supported algorithms are listed in the parameter description below.\n\nThe cryptographic algorithms can be partitioned into symmetric\nand asymmetric (or public key/private key).\n\nSymmetric or \"secret key\" algorithms use the same key to encrypt\nand to decrypt the data. Symmetric algorithms are what most people think\nof as codes: using a well-known algorithm and a secret key to encode information,\nwhich can be decoded using the same algorithm and the same key. The algorithm\nis not secret, the secrecy is inherent to guarding the key. A significant\nproblem with symmetric ciphers is that it is difficult to transfer the keys\nthemselves securely. Symmetric algorithms include password-based algorithms.\n\nAES with key length of 256 bits is the preferred choice for symmetric encryption going forward.\nPlease consider switching to it if you are using any other scheme or if using AES with a\nshorter key length. The rest of the symmetric algorithms will be deprecated in the future.\n\nAsymmetric or \"public key\" cryptography uses a public/private key pair, and then publishes the public key.\nOnly the holder of the private key will be able to decrypt.\nThe public key and private key together are also called a \"key pair\".\nData encrypted with one key can only be decrypted using the other key\nfrom the pair, and it is not possible to deduce one key from the other.\nThis helps to solve the key distribution problem since it is possible to\npublicise one of the keys widely (the \"public key\") and keep the other\na closely guarded secret (the \"private key\"). Many partners can then\nsend data encrypted with the public key, but only the holder of the\ncorresponding private key can decrypt it.\n\nKey pairs for asymmetric ciphers can be generated with an arbitrary tool.\nOne of the most popular options is the open source tool OpenSSL.\nOpenSSL has a command-line syntax and is available on major platforms.\n\nThe following steps are involved in creating an RSA key pair:\n\n- Generate an RSA private key with keylength of 2048 bits. Store this key in a safe place.\n\n\n- Generate a public key from the private key. You use the public key to encrypt messages with Cipher.encrypt. OpenSSL saves the key PEM-encoded; this means the key is saved with a base64 encoding. After you removed the header and footer lines you can pass the content directly to the API method.\n\n\n- Generate a private key in PKCS#8 format. You use that key to decrypt messages with Cipher.decrypt. OpenSSL saves the key PEM-encoded; this means the key is saved with a base64 encoding. After you removed the header and footer lines you can pass the content directly to the API method.\n\n\nModes\n\nThe following modes of operation are block cipher operations that\nare used with some algorithms.\n\n- \"NONE\" no mode\n- \"CBC\" Cipher Block Chaining (defined in FIPS PUB 81)\n- \"CTR\" Counter mode or Segmented Integer Counter mode (defined in FIPS PUB 81)\n- \"CTS\" CipherText Streaming mode\n- \"CFB\" Cipher Feedback Mode, can be referred to with key\nlength referenced as \"CFB8\",\"CFB16\",\"CFB24\"..\"CFB64\" (defined in FIPS PUB 81)\n- \"ECB\" Electronic Cook book as defined in: The National\nInstitute of Standards and Technology (NIST) Federal Information\nProcessing Standard (FIPS) PUB 81, \"DES Modes of Operation,\"\nU.S. Department of Commerce, Dec 1980.\n- \"OFB\" Output Feedback Mode, can be referred to with key\nlength referenced as \"OFB8\",\"OFB16\",\"OFB24\"..\"OFB64\" (defined in FIPS PUB 81)\n- \"PCBC\" Propagating Cipher Block Chaining (defined in Kerberos V4)\n\nPaddings\n\n- \"NoPadding\": No padding.\n- OAEPWithAndPadding:\n\nOptimal Asymmetric Encryption\nPadding scheme defined in PKCS#1, where should be replaced\nby the message digest and by the mask generation function.\n\nExamples: OAEPWITHSHA-256ANDMGF1PADDING, OAEPWITHSHA-384ANDMGF1PADDING, OAEPWITHSHA-512ANDMGF1PADDING\n- ISO10126PADDING: the ISO10126-2:1991 DEA padding scheme\n- PKCS1Padding: Public Key Cryptography Standard #1, a standard\nfor padding from RSA Laboratories that can encrypt messages up\nto 11 bytes smaller than the modulus size in bytes.\n- PKCS5Padding: Public Key Cryptography Standard #1, a standard\nfor padding from RSA Laboratories, \"PKCS#5: Password-Based Encryption Standard,\" version 1.5, November 1993.\n- SSL3Padding: The padding scheme defined in the SSL Protocol Version 3.0, November 18, 1996, section 5.2.3.2 (CBC block cipher)", + "heading": "Description" + } + ], + "signature": "encrypt(message: string, key: string, transformation: string, saltOrIV: string, iterations: number): string", + "source": "script-api", + "tags": [ + "encrypt", + "cipher.encrypt" + ], + "title": "Cipher.encrypt" + }, + { + "description": "Lower-level encryption API. Encrypts the passed bytes by using the specified key and applying the transformations described by the specified parameters.", + "id": "script-api:dw/crypto/Cipher#encryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "messageBytes", + "type": "Bytes" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/Cipher", + "qualifiedName": "dw.crypto.Cipher.encryptBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Lower-level encryption API. Encrypts the passed bytes by using the\nspecified key and applying the transformations described by the specified\nparameters.\n\nTypical usage:", + "heading": "Description" + } + ], + "signature": "encryptBytes(messageBytes: Bytes, key: string, transformation: string, saltOrIV: string, iterations: number): Bytes", + "source": "script-api", + "tags": [ + "encryptbytes", + "cipher.encryptbytes" + ], + "title": "Cipher.encryptBytes" + }, + { + "description": "Utility class which handles several common character encodings.", + "id": "script-api:dw/crypto/Encoding", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Encoding", + "sections": [ + { + "body": "Utility class which handles several common character encodings.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "encoding", + "dw.crypto.encoding", + "dw/crypto" + ], + "title": "Encoding" + }, + { + "description": "Decode the given string which represents a sequence of characters encoded in base-64 to a byte array. This operation supports both the base-64 and base-64 for URL formats. Characters not in the base-64 alphabet are ignored. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#fromBase64", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromBase64", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Decode the given string which represents a sequence of characters encoded in base-64 to a byte array. This\noperation supports both the base-64 and base-64 for URL formats. Characters not in the base-64 alphabet are\nignored. An exception is thrown if a null value is passed.\n\nNote: This decoding operation is limited to the maximum number of bytes that a Bytes object can hold. See\ndw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "static fromBase64(string: string): Bytes", + "source": "script-api", + "tags": [ + "frombase64", + "encoding.frombase64" + ], + "title": "Encoding.fromBase64" + }, + { + "description": "Decode the given string which represents a sequence of characters encoded in base-64 to a byte array. This operation supports both the base-64 and base-64 for URL formats. Characters not in the base-64 alphabet are ignored. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#fromBase64", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromBase64", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Decode the given string which represents a sequence of characters encoded in base-64 to a byte array. This\noperation supports both the base-64 and base-64 for URL formats. Characters not in the base-64 alphabet are\nignored. An exception is thrown if a null value is passed.\n\nNote: This decoding operation is limited to the maximum number of bytes that a Bytes object can hold. See\ndw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "static fromBase64(string: string): Bytes", + "source": "script-api", + "tags": [ + "frombase64", + "encoding.frombase64" + ], + "title": "Encoding.fromBase64" + }, + { + "description": "Converts a String representing hexadecimal values into an array of bytes of those same values. The returned byte array will be half the length of the passed, as it takes two characters to represent any given byte. An exception is thrown if the passed string has an odd number of character or if any characters in the string are not valid hexadecimal characters. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#fromHex", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromHex", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Converts a String representing hexadecimal values into an array of bytes\nof those same values. The returned byte array will be half the length of\nthe passed, as it takes two characters to represent any given byte. An\nexception is thrown if the passed string has an odd number of character\nor if any characters in the string are not valid hexadecimal characters.\nAn exception is thrown if a null value is passed.\n\nNote: This decoding operation is limited to the maximum number of bytes\nthat a Bytes object can hold. See dw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "static fromHex(string: string): Bytes", + "source": "script-api", + "tags": [ + "fromhex", + "encoding.fromhex" + ], + "title": "Encoding.fromHex" + }, + { + "description": "Converts a String representing hexadecimal values into an array of bytes of those same values. The returned byte array will be half the length of the passed, as it takes two characters to represent any given byte. An exception is thrown if the passed string has an odd number of character or if any characters in the string are not valid hexadecimal characters. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#fromHex", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromHex", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Converts a String representing hexadecimal values into an array of bytes\nof those same values. The returned byte array will be half the length of\nthe passed, as it takes two characters to represent any given byte. An\nexception is thrown if the passed string has an odd number of character\nor if any characters in the string are not valid hexadecimal characters.\nAn exception is thrown if a null value is passed.\n\nNote: This decoding operation is limited to the maximum number of bytes\nthat a Bytes object can hold. See dw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "static fromHex(string: string): Bytes", + "source": "script-api", + "tags": [ + "fromhex", + "encoding.fromhex" + ], + "title": "Encoding.fromHex" + }, + { + "description": "Decodes a URL safe string into its original form. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if null is passed.", + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decodes a URL safe string into its original form. Escaped characters are\nconverted back to their original representation. An exception is thrown\nif URL decoding is unsuccessful or if null is passed.", + "heading": "Description" + } + ], + "signature": "static fromURI(string: string): string", + "source": "script-api", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "description": "Decodes a URL safe string into its original form using the specified encoding. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if the specified encoding is unsupported or if null is passed for either argument.", + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decodes a URL safe string into its original form using the specified\nencoding. Escaped characters are converted back to their original\nrepresentation. An exception is thrown if URL decoding is unsuccessful or\nif the specified encoding is unsupported or if null is passed for either\nargument.", + "heading": "Description" + } + ], + "signature": "static fromURI(string: string, encoding: string): string", + "source": "script-api", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "description": "Decodes a URL safe string into its original form. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if null is passed.", + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decodes a URL safe string into its original form. Escaped characters are\nconverted back to their original representation. An exception is thrown\nif URL decoding is unsuccessful or if null is passed.", + "heading": "Description" + } + ], + "signature": "static fromURI(string: string): string", + "source": "script-api", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "description": "Decodes a URL safe string into its original form using the specified encoding. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if the specified encoding is unsupported or if null is passed for either argument.", + "id": "script-api:dw/crypto/Encoding#fromURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.fromURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decodes a URL safe string into its original form using the specified\nencoding. Escaped characters are converted back to their original\nrepresentation. An exception is thrown if URL decoding is unsuccessful or\nif the specified encoding is unsupported or if null is passed for either\nargument.", + "heading": "Description" + } + ], + "signature": "static fromURI(string: string, encoding: string): string", + "source": "script-api", + "tags": [ + "fromuri", + "encoding.fromuri" + ], + "title": "Encoding.fromURI" + }, + { + "description": "Convert the given byte array to a string encoded in base-64. This method does not chunk the data by adding line breaks. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toBase64", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Convert the given byte array to a string encoded in base-64. This method\ndoes not chunk the data by adding line breaks. An exception is thrown\nif a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toBase64(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tobase64", + "encoding.tobase64" + ], + "title": "Encoding.toBase64" + }, + { + "description": "Convert the given byte array to a string encoded in base-64. This method does not chunk the data by adding line breaks. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toBase64", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Convert the given byte array to a string encoded in base-64. This method\ndoes not chunk the data by adding line breaks. An exception is thrown\nif a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toBase64(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tobase64", + "encoding.tobase64" + ], + "title": "Encoding.toBase64" + }, + { + "description": "Convert the given byte array to a string encoded in base-64 for URLs. This method does not chunk the data by adding line breaks and it does not add any padding. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toBase64URL", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64URL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Convert the given byte array to a string encoded in base-64 for URLs. This method does not chunk the data by\nadding line breaks and it does not add any padding. An exception is thrown if a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toBase64URL(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tobase64url", + "encoding.tobase64url" + ], + "title": "Encoding.toBase64URL" + }, + { + "description": "Convert the given byte array to a string encoded in base-64 for URLs. This method does not chunk the data by adding line breaks and it does not add any padding. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toBase64URL", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toBase64URL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Convert the given byte array to a string encoded in base-64 for URLs. This method does not chunk the data by\nadding line breaks and it does not add any padding. An exception is thrown if a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toBase64URL(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tobase64url", + "encoding.tobase64url" + ], + "title": "Encoding.toBase64URL" + }, + { + "description": "Converts an array of bytes into a string representing the hexadecimal values of each byte in order. The returned string will be double the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toHex", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toHex", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Converts an array of bytes into a string representing the hexadecimal\nvalues of each byte in order. The returned string will be double the\nlength of the passed array, as it takes two characters to represent any\ngiven byte. An exception is thrown if a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toHex(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tohex", + "encoding.tohex" + ], + "title": "Encoding.toHex" + }, + { + "description": "Converts an array of bytes into a string representing the hexadecimal values of each byte in order. The returned string will be double the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toHex", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "bytes", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toHex", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Converts an array of bytes into a string representing the hexadecimal\nvalues of each byte in order. The returned string will be double the\nlength of the passed array, as it takes two characters to represent any\ngiven byte. An exception is thrown if a null value is passed.", + "heading": "Description" + } + ], + "signature": "static toHex(bytes: Bytes): string", + "source": "script-api", + "tags": [ + "tohex", + "encoding.tohex" + ], + "title": "Encoding.toHex" + }, + { + "description": "Encodes a string into its URL safe form according to the \"application/x-www-form-urlencoded\" encoding scheme using the default encoding. Unsafe characters are escaped. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a string into its URL safe form according to the\n\"application/x-www-form-urlencoded\" encoding scheme using the default\nencoding. Unsafe characters are escaped. An exception is thrown if a null\nvalue is passed.", + "heading": "Description" + } + ], + "signature": "static toURI(string: string): string", + "source": "script-api", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "description": "Encodes a string into its URL safe form according to the \"application/x-www-form-urlencoded\" encoding scheme using the specified encoding. Unsafe characters are escaped. An exception is thrown if the specified encoding is unsupported. An exception is thrown if either argument is null.", + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a string into its URL safe form according to the\n\"application/x-www-form-urlencoded\" encoding scheme using the specified\nencoding. Unsafe characters are escaped. An exception is thrown if the\nspecified encoding is unsupported. An exception is thrown if either\nargument is null.", + "heading": "Description" + } + ], + "signature": "static toURI(string: string, encoding: string): string", + "source": "script-api", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "description": "Encodes a string into its URL safe form according to the \"application/x-www-form-urlencoded\" encoding scheme using the default encoding. Unsafe characters are escaped. An exception is thrown if a null value is passed.", + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a string into its URL safe form according to the\n\"application/x-www-form-urlencoded\" encoding scheme using the default\nencoding. Unsafe characters are escaped. An exception is thrown if a null\nvalue is passed.", + "heading": "Description" + } + ], + "signature": "static toURI(string: string): string", + "source": "script-api", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "description": "Encodes a string into its URL safe form according to the \"application/x-www-form-urlencoded\" encoding scheme using the specified encoding. Unsafe characters are escaped. An exception is thrown if the specified encoding is unsupported. An exception is thrown if either argument is null.", + "id": "script-api:dw/crypto/Encoding#toURI", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "string", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Encoding", + "qualifiedName": "dw.crypto.Encoding.toURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a string into its URL safe form according to the\n\"application/x-www-form-urlencoded\" encoding scheme using the specified\nencoding. Unsafe characters are escaped. An exception is thrown if the\nspecified encoding is unsupported. An exception is thrown if either\nargument is null.", + "heading": "Description" + } + ], + "signature": "static toURI(string: string, encoding: string): string", + "source": "script-api", + "tags": [ + "touri", + "encoding.touri" + ], + "title": "Encoding.toURI" + }, + { + "description": "This class represents a JSON Web Encryption (JWE) object.", + "id": "script-api:dw/crypto/JWE", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWE", + "sections": [ + { + "body": "This class represents a JSON Web Encryption (JWE) object.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3 requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jwe", + "dw.crypto.jwe", + "dw/crypto" + ], + "title": "JWE" + }, + { + "description": "Get the algorithm (`alg`) from the header.", + "id": "script-api:dw/crypto/JWE#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.algorithm", + "sections": [ + { + "body": "Get the algorithm (`alg`) from the header.", + "heading": "Description" + } + ], + "signature": "readonly algorithm: string | null", + "source": "script-api", + "tags": [ + "algorithm", + "jwe.algorithm" + ], + "title": "JWE.algorithm" + }, + { + "description": "Decrypt the payload of this JWE object.", + "id": "script-api:dw/crypto/JWE#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "privateKey", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.decrypt", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Decrypt the payload of this JWE object.\n\nElliptic Curve (EC) and RSA keys are both supported.\n\nSupported EC key management algorithms:\n\n- ECDH-ES\n- ECDH-ES+A128KW\n- ECDH-ES+A192KW\n- ECDH-ES+A256KW\n\nSupported EC curves:\n\n- P-256\n- P-384\n- P-521\n\nSupported RSA key management algorithms:\n\n- RSA-OAEP-256\n- RSA-OAEP-384\n- RSA-OAEP-512\n\nSupported content encryption algorithms:\n\n- A128CBC-HS256\n- A128CBC-HS384\n- A128CBC-HS512\n- A128GCM\n- A192GCM\n- A256GCM", + "heading": "Description" + } + ], + "signature": "decrypt(privateKey: KeyRef): void", + "source": "script-api", + "tags": [ + "decrypt", + "jwe.decrypt" + ], + "title": "JWE.decrypt" + }, + { + "description": "Encrypt the payload of this JWE object.", + "id": "script-api:dw/crypto/JWE#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "publicKey", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.encrypt", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Encrypt the payload of this JWE object.\n\nElliptic Curve (EC) and RSA keys are both supported.\n\nSee decrypt for the list of supported algorithms and encryption methods.", + "heading": "Description" + } + ], + "signature": "encrypt(publicKey: CertificateRef): void", + "source": "script-api", + "tags": [ + "encrypt", + "jwe.encrypt" + ], + "title": "JWE.encrypt" + }, + { + "description": "Get the encryption method (`enc`) from the header.", + "id": "script-api:dw/crypto/JWE#encryptionMethod", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.encryptionMethod", + "sections": [ + { + "body": "Get the encryption method (`enc`) from the header.", + "heading": "Description" + } + ], + "signature": "readonly encryptionMethod: string | null", + "source": "script-api", + "tags": [ + "encryptionmethod", + "jwe.encryptionmethod" + ], + "title": "JWE.encryptionMethod" + }, + { + "description": "Get the algorithm (`alg`) from the header.", + "id": "script-api:dw/crypto/JWE#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getAlgorithm", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the algorithm (`alg`) from the header.", + "heading": "Description" + } + ], + "signature": "getAlgorithm(): string | null", + "source": "script-api", + "tags": [ + "getalgorithm", + "jwe.getalgorithm" + ], + "title": "JWE.getAlgorithm" + }, + { + "description": "Get the encryption method (`enc`) from the header.", + "id": "script-api:dw/crypto/JWE#getEncryptionMethod", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getEncryptionMethod", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the encryption method (`enc`) from the header.", + "heading": "Description" + } + ], + "signature": "getEncryptionMethod(): string | null", + "source": "script-api", + "tags": [ + "getencryptionmethod", + "jwe.getencryptionmethod" + ], + "title": "JWE.getEncryptionMethod" + }, + { + "description": "Get a copy of the JWE headers as a Map.", + "id": "script-api:dw/crypto/JWE#getHeaderMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getHeaderMap", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Get a copy of the JWE headers as a Map.", + "heading": "Description" + } + ], + "signature": "getHeaderMap(): utilMap", + "source": "script-api", + "tags": [ + "getheadermap", + "jwe.getheadermap" + ], + "title": "JWE.getHeaderMap" + }, + { + "description": "Get the key id (`kid`) from the header.", + "id": "script-api:dw/crypto/JWE#getKeyID", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getKeyID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the key id (`kid`) from the header.", + "heading": "Description" + } + ], + "signature": "getKeyID(): string | null", + "source": "script-api", + "tags": [ + "getkeyid", + "jwe.getkeyid" + ], + "title": "JWE.getKeyID" + }, + { + "description": "Get the decrypted payload.", + "id": "script-api:dw/crypto/JWE#getPayload", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.getPayload", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the decrypted payload.", + "heading": "Description" + } + ], + "signature": "getPayload(): string | null", + "source": "script-api", + "tags": [ + "getpayload", + "jwe.getpayload" + ], + "title": "JWE.getPayload" + }, + { + "description": "Get a copy of the JWE headers as a Map.", + "id": "script-api:dw/crypto/JWE#headerMap", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.headerMap", + "sections": [ + { + "body": "Get a copy of the JWE headers as a Map.", + "heading": "Description" + } + ], + "signature": "readonly headerMap: utilMap", + "source": "script-api", + "tags": [ + "headermap", + "jwe.headermap" + ], + "title": "JWE.headerMap" + }, + { + "description": "Get the key id (`kid`) from the header.", + "id": "script-api:dw/crypto/JWE#keyID", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.keyID", + "sections": [ + { + "body": "Get the key id (`kid`) from the header.", + "heading": "Description" + } + ], + "signature": "readonly keyID: string | null", + "source": "script-api", + "tags": [ + "keyid", + "jwe.keyid" + ], + "title": "JWE.keyID" + }, + { + "description": "Parse a JSON Web Encryption (JWE) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWE#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jwe", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.parse", + "returns": { + "type": "JWE" + }, + "sections": [ + { + "body": "Parse a JSON Web Encryption (JWE) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jwe: string): JWE", + "source": "script-api", + "tags": [ + "parse", + "jwe.parse" + ], + "title": "JWE.parse" + }, + { + "description": "Parse a JSON Web Encryption (JWE) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWE#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jwe", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.parse", + "returns": { + "type": "JWE" + }, + "sections": [ + { + "body": "Parse a JSON Web Encryption (JWE) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jwe: string): JWE", + "source": "script-api", + "tags": [ + "parse", + "jwe.parse" + ], + "title": "JWE.parse" + }, + { + "description": "Get the decrypted payload.", + "id": "script-api:dw/crypto/JWE#payload", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.payload", + "sections": [ + { + "body": "Get the decrypted payload.", + "heading": "Description" + } + ], + "signature": "readonly payload: string | null", + "source": "script-api", + "tags": [ + "payload", + "jwe.payload" + ], + "title": "JWE.payload" + }, + { + "description": "Get this JWE in compact serialization form.", + "id": "script-api:dw/crypto/JWE#serialize", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWE", + "qualifiedName": "dw.crypto.JWE.serialize", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get this JWE in compact serialization form.", + "heading": "Description" + } + ], + "signature": "serialize(): string", + "source": "script-api", + "tags": [ + "serialize", + "jwe.serialize" + ], + "title": "JWE.serialize" + }, + { + "description": "This class represents an immutable header of a JWE (JSON Web Encryption) object.", + "id": "script-api:dw/crypto/JWEHeader", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWEHeader", + "sections": [ + { + "body": "This class represents an immutable header of a JWE (JSON Web Encryption) object.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jweheader", + "dw.crypto.jweheader", + "dw/crypto" + ], + "title": "JWEHeader" + }, + { + "description": "Get the value of the algorithm parameter (`alg`).", + "id": "script-api:dw/crypto/JWEHeader#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.algorithm", + "sections": [ + { + "body": "Get the value of the algorithm parameter (`alg`).", + "heading": "Description" + } + ], + "signature": "readonly algorithm: string", + "source": "script-api", + "tags": [ + "algorithm", + "jweheader.algorithm" + ], + "title": "JWEHeader.algorithm" + }, + { + "description": "Get the value of the encryption algorithm parameter (`enc`).", + "id": "script-api:dw/crypto/JWEHeader#encryptionAlgorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.encryptionAlgorithm", + "sections": [ + { + "body": "Get the value of the encryption algorithm parameter (`enc`).", + "heading": "Description" + } + ], + "signature": "readonly encryptionAlgorithm: string", + "source": "script-api", + "tags": [ + "encryptionalgorithm", + "jweheader.encryptionalgorithm" + ], + "title": "JWEHeader.encryptionAlgorithm" + }, + { + "description": "Get the value of the algorithm parameter (`alg`).", + "id": "script-api:dw/crypto/JWEHeader#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.getAlgorithm", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the value of the algorithm parameter (`alg`).", + "heading": "Description" + } + ], + "signature": "getAlgorithm(): string", + "source": "script-api", + "tags": [ + "getalgorithm", + "jweheader.getalgorithm" + ], + "title": "JWEHeader.getAlgorithm" + }, + { + "description": "Get the value of the encryption algorithm parameter (`enc`).", + "id": "script-api:dw/crypto/JWEHeader#getEncryptionAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.getEncryptionAlgorithm", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the value of the encryption algorithm parameter (`enc`).", + "heading": "Description" + } + ], + "signature": "getEncryptionAlgorithm(): string", + "source": "script-api", + "tags": [ + "getencryptionalgorithm", + "jweheader.getencryptionalgorithm" + ], + "title": "JWEHeader.getEncryptionAlgorithm" + }, + { + "description": "Convert the given Map or JavaScript object into a JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "map", + "type": "Object" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parse", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Convert the given Map or JavaScript object into a JWE header.\n\nAll keys correspond to JWE parameters. The algorithm (`alg`) and encryption method\n(`enc`) parameters are required. See JWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parse(map: Object): JWEHeader", + "source": "script-api", + "tags": [ + "parse", + "jweheader.parse" + ], + "title": "JWEHeader.parse" + }, + { + "description": "Convert the given Map or JavaScript object into a JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "map", + "type": "Object" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parse", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Convert the given Map or JavaScript object into a JWE header.\n\nAll keys correspond to JWE parameters. The algorithm (`alg`) and encryption method\n(`enc`) parameters are required. See JWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parse(map: Object): JWEHeader", + "source": "script-api", + "tags": [ + "parse", + "jweheader.parse" + ], + "title": "JWEHeader.parse" + }, + { + "description": "Parse the given string as a Base64URL-encoded JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64encoded", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseEncoded", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Parse the given string as a Base64URL-encoded JWE header.\n\nThe algorithm (`alg`) and encryption method (`enc`) parameters are required. See\nJWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parseEncoded(base64encoded: string): JWEHeader", + "source": "script-api", + "tags": [ + "parseencoded", + "jweheader.parseencoded" + ], + "title": "JWEHeader.parseEncoded" + }, + { + "description": "Parse the given string as a Base64URL-encoded JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64encoded", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseEncoded", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Parse the given string as a Base64URL-encoded JWE header.\n\nThe algorithm (`alg`) and encryption method (`enc`) parameters are required. See\nJWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parseEncoded(base64encoded: string): JWEHeader", + "source": "script-api", + "tags": [ + "parseencoded", + "jweheader.parseencoded" + ], + "title": "JWEHeader.parseEncoded" + }, + { + "description": "Parse the given string as a JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "json", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseJSON", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Parse the given string as a JWE header.\n\nThe algorithm (`alg`) and encryption method (`enc`) parameters are required. See\nJWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parseJSON(json: string): JWEHeader", + "source": "script-api", + "tags": [ + "parsejson", + "jweheader.parsejson" + ], + "title": "JWEHeader.parseJSON" + }, + { + "description": "Parse the given string as a JWE header.", + "id": "script-api:dw/crypto/JWEHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "json", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.parseJSON", + "returns": { + "type": "JWEHeader" + }, + "sections": [ + { + "body": "Parse the given string as a JWE header.\n\nThe algorithm (`alg`) and encryption method (`enc`) parameters are required. See\nJWE.decrypt for supported values.", + "heading": "Description" + } + ], + "signature": "static parseJSON(json: string): JWEHeader", + "source": "script-api", + "tags": [ + "parsejson", + "jweheader.parsejson" + ], + "title": "JWEHeader.parseJSON" + }, + { + "description": "Get a copy of these headers as a Map.", + "id": "script-api:dw/crypto/JWEHeader#toMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.toMap", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Get a copy of these headers as a Map.", + "heading": "Description" + } + ], + "signature": "toMap(): utilMap", + "source": "script-api", + "tags": [ + "tomap", + "jweheader.tomap" + ], + "title": "JWEHeader.toMap" + }, + { + "description": "Get the content of the headers as a JSON String.", + "id": "script-api:dw/crypto/JWEHeader#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWEHeader", + "qualifiedName": "dw.crypto.JWEHeader.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the content of the headers as a JSON String.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "jweheader.tostring" + ], + "title": "JWEHeader.toString" + }, + { + "description": "This class represents a JSON Web Signature (JWS) object.", + "id": "script-api:dw/crypto/JWS", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWS", + "sections": [ + { + "body": "This class represents a JSON Web Signature (JWS) object.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3 requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jws", + "dw.crypto.jws", + "dw/crypto" + ], + "title": "JWS" + }, + { + "description": "Get the algorithm (`alg`) from the header.", + "id": "script-api:dw/crypto/JWS#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.algorithm", + "sections": [ + { + "body": "Get the algorithm (`alg`) from the header.", + "heading": "Description" + } + ], + "signature": "readonly algorithm: string | null", + "source": "script-api", + "tags": [ + "algorithm", + "jws.algorithm" + ], + "title": "JWS.algorithm" + }, + { + "description": "Get the algorithm (`alg`) from the header.", + "id": "script-api:dw/crypto/JWS#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getAlgorithm", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the algorithm (`alg`) from the header.", + "heading": "Description" + } + ], + "signature": "getAlgorithm(): string | null", + "source": "script-api", + "tags": [ + "getalgorithm", + "jws.getalgorithm" + ], + "title": "JWS.getAlgorithm" + }, + { + "description": "Get a copy of the JWS header.", + "id": "script-api:dw/crypto/JWS#getHeader", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getHeader", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Get a copy of the JWS header.", + "heading": "Description" + } + ], + "signature": "getHeader(): JWSHeader", + "source": "script-api", + "tags": [ + "getheader", + "jws.getheader" + ], + "title": "JWS.getHeader" + }, + { + "description": "Get a copy of the JWS header as a Map.", + "id": "script-api:dw/crypto/JWS#getHeaderMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getHeaderMap", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Get a copy of the JWS header as a Map.", + "heading": "Description" + } + ], + "signature": "getHeaderMap(): utilMap", + "source": "script-api", + "tags": [ + "getheadermap", + "jws.getheadermap" + ], + "title": "JWS.getHeaderMap" + }, + { + "description": "Get the payload from this object.", + "id": "script-api:dw/crypto/JWS#getPayload", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.getPayload", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the payload from this object.\n\nThis is available even if the signature has not been verified.", + "heading": "Description" + } + ], + "signature": "getPayload(): string", + "source": "script-api", + "tags": [ + "getpayload", + "jws.getpayload" + ], + "title": "JWS.getPayload" + }, + { + "description": "Get a copy of the JWS header.", + "id": "script-api:dw/crypto/JWS#header", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.header", + "sections": [ + { + "body": "Get a copy of the JWS header.", + "heading": "Description" + } + ], + "signature": "readonly header: JWSHeader", + "source": "script-api", + "tags": [ + "header", + "jws.header" + ], + "title": "JWS.header" + }, + { + "description": "Get a copy of the JWS header as a Map.", + "id": "script-api:dw/crypto/JWS#headerMap", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.headerMap", + "sections": [ + { + "body": "Get a copy of the JWS header as a Map.", + "heading": "Description" + } + ], + "signature": "readonly headerMap: utilMap", + "source": "script-api", + "tags": [ + "headermap", + "jws.headermap" + ], + "title": "JWS.headerMap" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + }, + { + "name": "payload", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string, payload: string): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + }, + { + "name": "payload", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string, payload: Bytes): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + }, + { + "name": "payload", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string, payload: string): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "id": "script-api:dw/crypto/JWS#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "jws", + "type": "string" + }, + { + "name": "payload", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.parse", + "returns": { + "type": "JWS" + }, + "sections": [ + { + "body": "Parse a JSON Web Signature (JWS) object from its compact serialization format.", + "heading": "Description" + } + ], + "signature": "static parse(jws: string, payload: Bytes): JWS", + "source": "script-api", + "tags": [ + "parse", + "jws.parse" + ], + "title": "JWS.parse" + }, + { + "description": "Get the payload from this object.", + "id": "script-api:dw/crypto/JWS#payload", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.payload", + "sections": [ + { + "body": "Get the payload from this object.\n\nThis is available even if the signature has not been verified.", + "heading": "Description" + } + ], + "signature": "readonly payload: string", + "source": "script-api", + "tags": [ + "payload", + "jws.payload" + ], + "title": "JWS.payload" + }, + { + "description": "Get this JWS in compact serialization form.", + "id": "script-api:dw/crypto/JWS#serialize", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "detachPayload", + "type": "boolean" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.serialize", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get this JWS in compact serialization form.", + "heading": "Description" + } + ], + "signature": "serialize(detachPayload: boolean): string", + "source": "script-api", + "tags": [ + "serialize", + "jws.serialize" + ], + "title": "JWS.serialize" + }, + { + "description": "Sign the payload using the given private key.", + "id": "script-api:dw/crypto/JWS#sign", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.sign", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sign the payload using the given private key.\n\nThe key type and size must match the algorithm given in the JWS header.", + "heading": "Description" + } + ], + "signature": "sign(keyRef: KeyRef): void", + "source": "script-api", + "tags": [ + "sign", + "jws.sign" + ], + "throws": [ + { + "description": "if there is an error while signing the payload.", + "type": "Exception" + } + ], + "title": "JWS.sign" + }, + { + "description": "Verifies the signature of the payload.", + "id": "script-api:dw/crypto/JWS#verify", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/crypto/JWS", + "qualifiedName": "dw.crypto.JWS.verify", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies the signature of the payload.\n\nIf the `x5c` header parameter is present, then that certificate chain will be used to verify the\nsignature and the given `certificateRef` must be its root certificate. If this parameter is not\npresent then the given `certificateRef` will be used to directly verify the signature.\n\nThe following algorithms are supported:\n\n- ES256\n- ES256K\n- ES384\n- ES512\n- RS256\n- RS384\n- RS512\n- PS256\n- PS384\n- PS512", + "heading": "Description" + } + ], + "signature": "verify(certificateRef: CertificateRef): boolean", + "source": "script-api", + "tags": [ + "verify", + "jws.verify" + ], + "throws": [ + { + "description": "if there is an error while processing the certificate (for example if the x5c is not signed by the given certificate) or the algorithm is unsupported.", + "type": "Exception" + } + ], + "title": "JWS.verify" + }, + { + "description": "This class represents an immutable header of a JWS (JSON Web Signature) object.", + "id": "script-api:dw/crypto/JWSHeader", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.JWSHeader", + "sections": [ + { + "body": "This class represents an immutable header of a JWS (JSON Web Signature) object.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jwsheader", + "dw.crypto.jwsheader", + "dw/crypto" + ], + "title": "JWSHeader" + }, + { + "description": "Get the value of the algorithm parameter (`alg`).", + "id": "script-api:dw/crypto/JWSHeader#algorithm", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.algorithm", + "sections": [ + { + "body": "Get the value of the algorithm parameter (`alg`).", + "heading": "Description" + } + ], + "signature": "readonly algorithm: string", + "source": "script-api", + "tags": [ + "algorithm", + "jwsheader.algorithm" + ], + "title": "JWSHeader.algorithm" + }, + { + "description": "Get the value of the algorithm parameter (`alg`).", + "id": "script-api:dw/crypto/JWSHeader#getAlgorithm", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.getAlgorithm", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the value of the algorithm parameter (`alg`).", + "heading": "Description" + } + ], + "signature": "getAlgorithm(): string", + "source": "script-api", + "tags": [ + "getalgorithm", + "jwsheader.getalgorithm" + ], + "title": "JWSHeader.getAlgorithm" + }, + { + "description": "Convert the given Map or JavaScript object into a JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "map", + "type": "Object" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parse", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Convert the given Map or JavaScript object into a JWS header.\n\nAll keys correspond to JWS parameters. The algorithm parameter (`alg`) is required. See\nJWS.verify for supported values.", + "heading": "Description" + } + ], + "signature": "static parse(map: Object): JWSHeader", + "source": "script-api", + "tags": [ + "parse", + "jwsheader.parse" + ], + "title": "JWSHeader.parse" + }, + { + "description": "Convert the given Map or JavaScript object into a JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parse", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "map", + "type": "Object" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parse", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Convert the given Map or JavaScript object into a JWS header.\n\nAll keys correspond to JWS parameters. The algorithm parameter (`alg`) is required. See\nJWS.verify for supported values.", + "heading": "Description" + } + ], + "signature": "static parse(map: Object): JWSHeader", + "source": "script-api", + "tags": [ + "parse", + "jwsheader.parse" + ], + "title": "JWSHeader.parse" + }, + { + "description": "Parse the given string as a Base64URL-encoded JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64encoded", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseEncoded", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Parse the given string as a Base64URL-encoded JWS header.\n\nThe algorithm parameter (`alg`) is required. See JWS.verify for supported\nvalues.", + "heading": "Description" + } + ], + "signature": "static parseEncoded(base64encoded: string): JWSHeader", + "source": "script-api", + "tags": [ + "parseencoded", + "jwsheader.parseencoded" + ], + "title": "JWSHeader.parseEncoded" + }, + { + "description": "Parse the given string as a Base64URL-encoded JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parseEncoded", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64encoded", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseEncoded", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Parse the given string as a Base64URL-encoded JWS header.\n\nThe algorithm parameter (`alg`) is required. See JWS.verify for supported\nvalues.", + "heading": "Description" + } + ], + "signature": "static parseEncoded(base64encoded: string): JWSHeader", + "source": "script-api", + "tags": [ + "parseencoded", + "jwsheader.parseencoded" + ], + "title": "JWSHeader.parseEncoded" + }, + { + "description": "Parse the given string as a JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "json", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseJSON", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Parse the given string as a JWS header.\n\nThe algorithm parameter (`alg`) is required. See JWS.verify for supported\nvalues.", + "heading": "Description" + } + ], + "signature": "static parseJSON(json: string): JWSHeader", + "source": "script-api", + "tags": [ + "parsejson", + "jwsheader.parsejson" + ], + "title": "JWSHeader.parseJSON" + }, + { + "description": "Parse the given string as a JWS header.", + "id": "script-api:dw/crypto/JWSHeader#parseJSON", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "json", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.parseJSON", + "returns": { + "type": "JWSHeader" + }, + "sections": [ + { + "body": "Parse the given string as a JWS header.\n\nThe algorithm parameter (`alg`) is required. See JWS.verify for supported\nvalues.", + "heading": "Description" + } + ], + "signature": "static parseJSON(json: string): JWSHeader", + "source": "script-api", + "tags": [ + "parsejson", + "jwsheader.parsejson" + ], + "title": "JWSHeader.parseJSON" + }, + { + "description": "Get a copy of these headers as a Map.", + "id": "script-api:dw/crypto/JWSHeader#toMap", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.toMap", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Get a copy of these headers as a Map.", + "heading": "Description" + } + ], + "signature": "toMap(): utilMap", + "source": "script-api", + "tags": [ + "tomap", + "jwsheader.tomap" + ], + "title": "JWSHeader.toMap" + }, + { + "description": "Get the content of the headers as a JSON String.", + "id": "script-api:dw/crypto/JWSHeader#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/JWSHeader", + "qualifiedName": "dw.crypto.JWSHeader.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the content of the headers as a JSON String.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "jwsheader.tostring" + ], + "title": "JWSHeader.toString" + }, + { + "description": "This class is used as a reference to a private key in the keystore which can be managed in the Business Manager.", + "id": "script-api:dw/crypto/KeyRef", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.KeyRef", + "sections": [ + { + "body": "This class is used as a reference to a private key in the keystore\nwhich can be managed in the Business Manager.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "keyref", + "dw.crypto.keyref", + "dw/crypto" + ], + "title": "KeyRef" + }, + { + "description": "Returns the string representation of this KeyRef.", + "id": "script-api:dw/crypto/KeyRef#toString", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/KeyRef", + "qualifiedName": "dw.crypto.KeyRef.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the string representation of this KeyRef.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "keyref.tostring" + ], + "title": "KeyRef.toString" + }, + { + "description": "This class provides the functionality of a \"Message Authentication Code\" (MAC) algorithm. A MAC provides a way to check the integrity of information transmitted over or stored in an unreliable medium, based on a secret key. Typically, message authentication codes are used between two parties that share a secret key in order to validate information transmitted between these parties. A MAC mechanism that is based on cryptographic hash functions is referred to as HMAC. HMAC can be used with any cryptographic hash function, e.g., SHA256, in combination with a secret shared key. HMAC is specified in RFC 2104.", + "id": "script-api:dw/crypto/Mac", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Mac", + "sections": [ + { + "body": "This class provides the functionality of a \"Message Authentication Code\" (MAC) algorithm.\nA MAC provides a way to check the integrity of information transmitted over or\nstored in an unreliable medium, based on a secret key.\nTypically, message authentication codes are used between two parties\nthat share a secret key in order to validate information transmitted between these parties.\nA MAC mechanism that is based on cryptographic hash functions is referred to as HMAC.\nHMAC can be used with any cryptographic hash function, e.g., SHA256,\nin combination with a secret shared key. HMAC is specified in RFC 2104.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mac", + "dw.crypto.mac", + "dw/crypto" + ], + "title": "Mac" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512." + }, + "description": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997). This algorithm uses as MD5 cryptographic hash function.", + "id": "script-api:dw/crypto/Mac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_MD5", + "sections": [ + { + "body": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997).\nThis algorithm uses as MD5 cryptographic hash function.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_MD5 = \"HmacMD5\"", + "source": "script-api", + "tags": [ + "hmac_md5", + "mac.hmac_md5" + ], + "title": "Mac.HMAC_MD5" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512." + }, + "description": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997). This algorithm uses as MD5 cryptographic hash function.", + "id": "script-api:dw/crypto/Mac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_MD5", + "sections": [ + { + "body": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997).\nThis algorithm uses as MD5 cryptographic hash function.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_MD5 = \"HmacMD5\"", + "source": "script-api", + "tags": [ + "hmac_md5", + "mac.hmac_md5" + ], + "title": "Mac.HMAC_MD5" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512." + }, + "description": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-1 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_1", + "sections": [ + { + "body": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-1 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_1 = \"HmacSHA1\"", + "source": "script-api", + "tags": [ + "hmac_sha_1", + "mac.hmac_sha_1" + ], + "title": "Mac.HMAC_SHA_1" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use HmacSHA256, HmacSHA384 or HmacSHA512." + }, + "description": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-1 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_1", + "sections": [ + { + "body": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-1 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_1 = \"HmacSHA1\"", + "source": "script-api", + "tags": [ + "hmac_sha_1", + "mac.hmac_sha_1" + ], + "title": "Mac.HMAC_SHA_1" + }, + { + "description": "Constant representing the HmacSHA256 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-256 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_256", + "sections": [ + { + "body": "Constant representing the HmacSHA256 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-256 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_256 = \"HmacSHA256\"", + "source": "script-api", + "tags": [ + "hmac_sha_256", + "mac.hmac_sha_256" + ], + "title": "Mac.HMAC_SHA_256" + }, + { + "description": "Constant representing the HmacSHA256 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-256 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_256", + "sections": [ + { + "body": "Constant representing the HmacSHA256 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-256 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_256 = \"HmacSHA256\"", + "source": "script-api", + "tags": [ + "hmac_sha_256", + "mac.hmac_sha_256" + ], + "title": "Mac.HMAC_SHA_256" + }, + { + "description": "Constant representing the HmacSHA384 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-384 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_384", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_384", + "sections": [ + { + "body": "Constant representing the HmacSHA384 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-384 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_384 = \"HmacSHA384\"", + "source": "script-api", + "tags": [ + "hmac_sha_384", + "mac.hmac_sha_384" + ], + "title": "Mac.HMAC_SHA_384" + }, + { + "description": "Constant representing the HmacSHA384 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-384 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_384", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_384", + "sections": [ + { + "body": "Constant representing the HmacSHA384 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-384 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_384 = \"HmacSHA384\"", + "source": "script-api", + "tags": [ + "hmac_sha_384", + "mac.hmac_sha_384" + ], + "title": "Mac.HMAC_SHA_384" + }, + { + "description": "Constant representing the HmacSHA512 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-512 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_512", + "sections": [ + { + "body": "Constant representing the HmacSHA512 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-512 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_512 = \"HmacSHA512\"", + "source": "script-api", + "tags": [ + "hmac_sha_512", + "mac.hmac_sha_512" + ], + "title": "Mac.HMAC_SHA_512" + }, + { + "description": "Constant representing the HmacSHA512 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-512 as the message digest algorithm.", + "id": "script-api:dw/crypto/Mac#HMAC_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.HMAC_SHA_512", + "sections": [ + { + "body": "Constant representing the HmacSHA512 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-512 as the message digest algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_512 = \"HmacSHA512\"", + "source": "script-api", + "tags": [ + "hmac_sha_512", + "mac.hmac_sha_512" + ], + "title": "Mac.HMAC_SHA_512" + }, + { + "description": "Computes the hash value for the passed string input using the passed secret key. Given input and the given key will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.", + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed string input using the passed secret key.\nGiven input and the given key will be first converted with UTF-8 encoding into a byte array.\nThe resulting hash is typically converted with base64 back into a string.", + "heading": "Description" + } + ], + "signature": "digest(input: string, key: string): Bytes", + "source": "script-api", + "tags": [ + "digest", + "mac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "Mac.digest" + }, + { + "description": "Computes the hash value for the passed string input using the passed secret key. Given input will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.", + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + }, + { + "name": "key", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed string input using the passed secret key.\nGiven input will be first converted with UTF-8 encoding into a byte array.\nThe resulting hash is typically converted with base64 back into a string.", + "heading": "Description" + } + ], + "signature": "digest(input: string, key: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "mac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "Mac.digest" + }, + { + "description": "Computes the hash value for the passed bytes input using the passed secret key.", + "id": "script-api:dw/crypto/Mac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + }, + { + "name": "key", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/Mac", + "qualifiedName": "dw.crypto.Mac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed bytes input using the passed secret key.", + "heading": "Description" + } + ], + "signature": "digest(input: Bytes, key: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "mac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "Mac.digest" + }, + { + "description": "This class provides the functionality of a message digest algorithm, such as MD5 or SHA. Message digests are secure one-way hash functions that take arbitrary-sized data and output a fixed-length hash value. This implementation offers only stateless digest() methods. A Bytes object or String is passed to a digest() method and the computed hash is returned.", + "id": "script-api:dw/crypto/MessageDigest", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.MessageDigest", + "sections": [ + { + "body": "This class provides the functionality of a message digest algorithm, such as\nMD5 or SHA. Message digests are secure one-way hash functions that take\narbitrary-sized data and output a fixed-length hash value. This\nimplementation offers only stateless digest() methods. A Bytes object or\nString is passed to a digest() method and the computed hash is returned.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "messagedigest", + "dw.crypto.messagedigest", + "dw/crypto" + ], + "title": "MessageDigest" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the MD2 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD2", + "sections": [ + { + "body": "Constant representing the MD2 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD2 = \"MD2\"", + "source": "script-api", + "tags": [ + "digest_md2", + "messagedigest.digest_md2" + ], + "title": "MessageDigest.DIGEST_MD2" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the MD2 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD2", + "sections": [ + { + "body": "Constant representing the MD2 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD2 = \"MD2\"", + "source": "script-api", + "tags": [ + "digest_md2", + "messagedigest.digest_md2" + ], + "title": "MessageDigest.DIGEST_MD2" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the MD5 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD5", + "sections": [ + { + "body": "Constant representing the MD5 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD5 = \"MD5\"", + "source": "script-api", + "tags": [ + "digest_md5", + "messagedigest.digest_md5" + ], + "title": "MessageDigest.DIGEST_MD5" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the MD5 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_MD5", + "sections": [ + { + "body": "Constant representing the MD5 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD5 = \"MD5\"", + "source": "script-api", + "tags": [ + "digest_md5", + "messagedigest.digest_md5" + ], + "title": "MessageDigest.DIGEST_MD5" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the SHA algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA", + "sections": [ + { + "body": "Constant representing the SHA algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA = \"SHA\"", + "source": "script-api", + "tags": [ + "digest_sha", + "messagedigest.digest_sha" + ], + "title": "MessageDigest.DIGEST_SHA" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the SHA algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA", + "sections": [ + { + "body": "Constant representing the SHA algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA = \"SHA\"", + "source": "script-api", + "tags": [ + "digest_sha", + "messagedigest.digest_sha" + ], + "title": "MessageDigest.DIGEST_SHA" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the SHA 1 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_1", + "sections": [ + { + "body": "Constant representing the SHA 1 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_1 = \"SHA-1\"", + "source": "script-api", + "tags": [ + "digest_sha_1", + "messagedigest.digest_sha_1" + ], + "title": "MessageDigest.DIGEST_SHA_1" + }, + { + "deprecated": { + "message": "This algorithm is obsolete and and has been deprecated. Please use SHA-256 or SHA-512." + }, + "description": "Constant representing the SHA 1 algorithm.", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_1", + "sections": [ + { + "body": "Constant representing the SHA 1 algorithm.", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_1 = \"SHA-1\"", + "source": "script-api", + "tags": [ + "digest_sha_1", + "messagedigest.digest_sha_1" + ], + "title": "MessageDigest.DIGEST_SHA_1" + }, + { + "description": "Constant representing the SHA 256 algorithm", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_256", + "sections": [ + { + "body": "Constant representing the SHA 256 algorithm", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_256 = \"SHA-256\"", + "source": "script-api", + "tags": [ + "digest_sha_256", + "messagedigest.digest_sha_256" + ], + "title": "MessageDigest.DIGEST_SHA_256" + }, + { + "description": "Constant representing the SHA 256 algorithm", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_256", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_256", + "sections": [ + { + "body": "Constant representing the SHA 256 algorithm", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_256 = \"SHA-256\"", + "source": "script-api", + "tags": [ + "digest_sha_256", + "messagedigest.digest_sha_256" + ], + "title": "MessageDigest.DIGEST_SHA_256" + }, + { + "description": "Constant representing the SHA 512 algorithm", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_512", + "sections": [ + { + "body": "Constant representing the SHA 512 algorithm", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_512 = \"SHA-512\"", + "source": "script-api", + "tags": [ + "digest_sha_512", + "messagedigest.digest_sha_512" + ], + "title": "MessageDigest.DIGEST_SHA_512" + }, + { + "description": "Constant representing the SHA 512 algorithm", + "id": "script-api:dw/crypto/MessageDigest#DIGEST_SHA_512", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.DIGEST_SHA_512", + "sections": [ + { + "body": "Constant representing the SHA 512 algorithm", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_512 = \"SHA-512\"", + "source": "script-api", + "tags": [ + "digest_sha_512", + "messagedigest.digest_sha_512" + ], + "title": "MessageDigest.DIGEST_SHA_512" + }, + { + "deprecated": { + "message": "Deprecated because the conversion of the input to bytes using\nthe default platform encoding and the hex-encoded return\nvalue are not generally appropriate." + }, + "description": "Digests the passed string and returns a computed hash value as a string. The passed String is first encoded into a sequence of bytes using the platform's default encoding. The digest then performs any prerequisite padding, before computing the hash value. The hash is then converted into a string by converting all digits to hexadecimal.", + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Digests the passed string and returns a computed hash value as a string.\nThe passed String is first encoded into a sequence of bytes using the\nplatform's default encoding. The digest then performs any prerequisite\npadding, before computing the hash value. The hash is then converted into\na string by converting all digits to hexadecimal.", + "heading": "Description" + } + ], + "signature": "digest(input: string): string", + "source": "script-api", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "deprecated": { + "message": "Deprecated because the digest algorithm should be the one\nset in the constructor." + }, + "description": "Computes the hash value for the passed array of bytes. The algorithm argument is optional. If null, then the algorithm established at construction time is used.", + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "algorithm", + "type": "string | null" + }, + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed array of bytes. The algorithm\nargument is optional. If null, then the algorithm established at\nconstruction time is used.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest( \"MD5\", new Bytes( \"my password\", \"UTF-8\" ) ) );\n`", + "heading": "Description" + } + ], + "signature": "digest(algorithm: string | null, input: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "description": "Completes the hash computation by performing final operations such as padding.", + "id": "script-api:dw/crypto/MessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Completes the hash computation by performing final operations such as\npadding.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest() );\n`", + "heading": "Description" + } + ], + "signature": "digest(): Bytes", + "source": "script-api", + "tags": [ + "digest", + "messagedigest.digest" + ], + "title": "MessageDigest.digest" + }, + { + "description": "Computes the hash value for the passed dw.util.Bytes.", + "id": "script-api:dw/crypto/MessageDigest#digestBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.digestBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed dw.util.Bytes.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest( new Bytes( \"my password\", \"UTF-8\" ) ) );\n`", + "heading": "Description" + } + ], + "signature": "digestBytes(input: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digestbytes", + "messagedigest.digestbytes" + ], + "title": "MessageDigest.digestBytes" + }, + { + "description": "Updates the digest using the passed dw.util.Bytes.", + "id": "script-api:dw/crypto/MessageDigest#updateBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/MessageDigest", + "qualifiedName": "dw.crypto.MessageDigest.updateBytes", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the digest using the passed dw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "updateBytes(input: Bytes): void", + "source": "script-api", + "tags": [ + "updatebytes", + "messagedigest.updatebytes" + ], + "title": "MessageDigest.updateBytes" + }, + { + "description": "The SecureRandom class provides a cryptographically strong random number generator (RNG). See the Internet Engineering Task Force (IETF) RFC 1750: Randomness Recommendations for Security for more information.", + "examples": [ + "Bytes bytes...\nSecureRandom random = new SecureRandom();\nBytes nextBytes = random.nextBytes(bytes);", + "int length = 32;\nSecureRandom random = new SecureRandom();\nBytes nextBytes = random.nextBytes(length);" + ], + "id": "script-api:dw/crypto/SecureRandom", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.SecureRandom", + "sections": [ + { + "body": "The SecureRandom class provides a cryptographically strong random number generator (RNG).\nSee the Internet Engineering Task Force (IETF) RFC 1750: Randomness Recommendations for\nSecurity for more information.\n\nTypical callers of SecureRandom invoke the following methods to retrieve random bytes:\n\n\nor more convenient to get a Bytes with the demanded length\n\n\ndw.crypto.SecureRandom is intentionally an adapter for generating cryptographic hard random numbers.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "securerandom", + "dw.crypto.securerandom", + "dw/crypto" + ], + "title": "SecureRandom" + }, + { + "description": "Returns the given number of seed bytes, computed using the seed generation algorithm that this class uses to seed itself. This call may be used to seed other random number generators.", + "id": "script-api:dw/crypto/SecureRandom#generateSeed", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "numBytes", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.generateSeed", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Returns the given number of seed bytes, computed using the seed\ngeneration algorithm that this class uses to seed itself. This\ncall may be used to seed other random number generators.", + "heading": "Description" + } + ], + "signature": "generateSeed(numBytes: number): Bytes", + "source": "script-api", + "tags": [ + "generateseed", + "securerandom.generateseed" + ], + "title": "SecureRandom.generateSeed" + }, + { + "description": "Generates a user-specified number of random bytes.", + "id": "script-api:dw/crypto/SecureRandom#nextBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "numBits", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Generates a user-specified number of random bytes.\n\nIf a call to `setSeed` had not occurred previously,\nthe first call to this method forces this SecureRandom object\nto seed itself. This self-seeding will not occur if\n`setSeed` was previously called.", + "heading": "Description" + } + ], + "signature": "nextBytes(numBits: number): Bytes", + "source": "script-api", + "tags": [ + "nextbytes", + "securerandom.nextbytes" + ], + "title": "SecureRandom.nextBytes" + }, + { + "description": "Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. The general contract of nextInt is that one int value is pseudorandomly generated and returned. All 2^32 possible int values are produced with (approximately) equal probability.", + "id": "script-api:dw/crypto/SecureRandom#nextInt", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextInt", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. The general\ncontract of nextInt is that one int value is pseudorandomly generated and returned. All 2^32\npossible int values are produced with (approximately) equal probability.", + "heading": "Description" + } + ], + "signature": "nextInt(): number", + "source": "script-api", + "tags": [ + "nextint", + "securerandom.nextint" + ], + "title": "SecureRandom.nextInt" + }, + { + "description": "Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.", + "id": "script-api:dw/crypto/SecureRandom#nextInt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "upperBound", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextInt", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns a pseudorandom, uniformly distributed int value\nbetween 0 (inclusive) and the specified value (exclusive), drawn from\nthis random number generator's sequence.", + "heading": "Description" + } + ], + "signature": "nextInt(upperBound: number): number", + "source": "script-api", + "tags": [ + "nextint", + "securerandom.nextint" + ], + "throws": [ + { + "description": "if n is not positive", + "type": "IllegalArgumentException" + } + ], + "title": "SecureRandom.nextInt" + }, + { + "description": "Returns the next pseudorandom, uniformly distributed Number value between 0.0 (inclusive) and 1.0 (exclusive) from this random number generator's sequence.", + "id": "script-api:dw/crypto/SecureRandom#nextNumber", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.nextNumber", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the next pseudorandom, uniformly distributed\nNumber value between 0.0 (inclusive) and 1.0 (exclusive) from this random number generator's sequence.", + "heading": "Description" + } + ], + "signature": "nextNumber(): number", + "source": "script-api", + "tags": [ + "nextnumber", + "securerandom.nextnumber" + ], + "title": "SecureRandom.nextNumber" + }, + { + "description": "Reseeds this random object. The given seed supplements, rather than replaces, the existing seed. Thus, repeated calls are guaranteed never to reduce randomness.", + "id": "script-api:dw/crypto/SecureRandom#setSeed", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "seed", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/SecureRandom", + "qualifiedName": "dw.crypto.SecureRandom.setSeed", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Reseeds this random object. The given seed supplements, rather than replaces, the existing seed. Thus, repeated calls are guaranteed never to reduce randomness.", + "heading": "Description" + } + ], + "signature": "setSeed(seed: Bytes): void", + "source": "script-api", + "tags": [ + "setseed", + "securerandom.setseed" + ], + "title": "SecureRandom.setSeed" + }, + { + "description": "This class allows access to signature services offered through the Java Cryptography Architecture (JCA). At this time the signature/verification implementation of the methods is based on the default RSA JCE provider of the JDK - sun.security.rsa.SunRsaSign", + "id": "script-api:dw/crypto/Signature", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.Signature", + "sections": [ + { + "body": "This class allows access to signature services offered through the Java\nCryptography Architecture (JCA). At this time the signature/verification implementation of the\nmethods is based on the default RSA JCE provider of the JDK - sun.security.rsa.SunRsaSign\n\ndw.crypto.Signature is an adapter to the security provider implementation\nand covers several digest algorithms:\n\n- SHA1withRSA (deprecated)\n- SHA256withRSA\n- SHA384withRSA\n- SHA512withRSA\n- SHA256withRSA/PSS\n- SHA384withRSA/PSS\n- SHA512withRSA/PSS\n- SHA256withECDSA\n- SHA384withECDSA\n- SHA512withECDSA\n\nKey size generally ranges between 512 and 65536 bits (the latter of which is unnecessarily large).\n\nDefault key size for RSA is 1024. SHA384withRSA and SHA512withRSA require a key with length of at least 1024 bits.\n\nFor ECDSA, the following key sizes are supported:\n\n- SHA256withECDSA: 256-bit key (NIST P-256)\n- SHA384withECDSA: 384-bit key (NIST P-384)\n- SHA512withECDSA: 521-bit key (NIST P-521)\n\nWhen choosing a key size - beware of the tradeoff between security and processing time:\n\nThe longer the key, the harder to break it but also it takes more time for the two sides to sign and verify the signature.\n\nAn exception will be thrown for keys shorter than 2048 bits in this version of the API.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, 12, and other relevant requirements.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "signature", + "dw.crypto.signature", + "dw/crypto" + ], + "title": "Signature" + }, + { + "description": "Supported digest algorithms exposed as a string array", + "id": "script-api:dw/crypto/Signature#SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "sections": [ + { + "body": "Supported digest algorithms exposed as a string array", + "heading": "Description" + } + ], + "signature": "static readonly SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY: string[]", + "source": "script-api", + "tags": [ + "supported_digest_algorithms_as_array", + "signature.supported_digest_algorithms_as_array" + ], + "title": "Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY" + }, + { + "description": "Supported digest algorithms exposed as a string array", + "id": "script-api:dw/crypto/Signature#SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY", + "sections": [ + { + "body": "Supported digest algorithms exposed as a string array", + "heading": "Description" + } + ], + "signature": "static readonly SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY: string[]", + "source": "script-api", + "tags": [ + "supported_digest_algorithms_as_array", + "signature.supported_digest_algorithms_as_array" + ], + "title": "Signature.SUPPORTED_DIGEST_ALGORITHMS_AS_ARRAY" + }, + { + "description": "Checks to see if a digest algorithm is supported", + "id": "script-api:dw/crypto/Signature#isDigestAlgorithmSupported", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.isDigestAlgorithmSupported", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks to see if a digest algorithm is supported", + "heading": "Description" + } + ], + "signature": "isDigestAlgorithmSupported(digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "isdigestalgorithmsupported", + "signature.isdigestalgorithmsupported" + ], + "title": "Signature.isDigestAlgorithmSupported" + }, + { + "description": "Signs a string and returns a string", + "id": "script-api:dw/crypto/Signature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "string" + }, + { + "name": "privateKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.sign", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Signs a string and returns a string", + "heading": "Description" + } + ], + "signature": "sign(contentToSign: string, privateKey: string, digestAlgorithm: string): string", + "source": "script-api", + "tags": [ + "sign", + "signature.sign" + ], + "title": "Signature.sign" + }, + { + "description": "Signs a string and returns a string", + "id": "script-api:dw/crypto/Signature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "string" + }, + { + "name": "privateKey", + "type": "KeyRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.sign", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Signs a string and returns a string", + "heading": "Description" + } + ], + "signature": "sign(contentToSign: string, privateKey: KeyRef, digestAlgorithm: string): string", + "source": "script-api", + "tags": [ + "sign", + "signature.sign" + ], + "title": "Signature.sign" + }, + { + "description": "Signs bytes and returns bytes", + "id": "script-api:dw/crypto/Signature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "Bytes" + }, + { + "name": "privateKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.signBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Signs bytes and returns bytes", + "heading": "Description" + } + ], + "signature": "signBytes(contentToSign: Bytes, privateKey: string, digestAlgorithm: string): Bytes", + "source": "script-api", + "tags": [ + "signbytes", + "signature.signbytes" + ], + "title": "Signature.signBytes" + }, + { + "description": "Signs bytes and returns bytes", + "id": "script-api:dw/crypto/Signature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "Bytes" + }, + { + "name": "privateKey", + "type": "KeyRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.signBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Signs bytes and returns bytes", + "heading": "Description" + } + ], + "signature": "signBytes(contentToSign: Bytes, privateKey: KeyRef, digestAlgorithm: string): Bytes", + "source": "script-api", + "tags": [ + "signbytes", + "signature.signbytes" + ], + "title": "Signature.signBytes" + }, + { + "description": "Verifies a signature supplied as bytes", + "id": "script-api:dw/crypto/Signature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "Bytes" + }, + { + "name": "contentToVerify", + "type": "Bytes" + }, + { + "name": "publicKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifyBytesSignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as bytes", + "heading": "Description" + } + ], + "signature": "verifyBytesSignature(signature: Bytes, contentToVerify: Bytes, publicKey: string, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifybytessignature", + "signature.verifybytessignature" + ], + "title": "Signature.verifyBytesSignature" + }, + { + "description": "Verifies a signature supplied as bytes", + "id": "script-api:dw/crypto/Signature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "Bytes" + }, + { + "name": "contentToVerify", + "type": "Bytes" + }, + { + "name": "certificate", + "type": "CertificateRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifyBytesSignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as bytes", + "heading": "Description" + } + ], + "signature": "verifyBytesSignature(signature: Bytes, contentToVerify: Bytes, certificate: CertificateRef, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifybytessignature", + "signature.verifybytessignature" + ], + "title": "Signature.verifyBytesSignature" + }, + { + "description": "Verifies a signature supplied as string", + "id": "script-api:dw/crypto/Signature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "string" + }, + { + "name": "contentToVerify", + "type": "string" + }, + { + "name": "publicKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifySignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as string", + "heading": "Description" + } + ], + "signature": "verifySignature(signature: string, contentToVerify: string, publicKey: string, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifysignature", + "signature.verifysignature" + ], + "title": "Signature.verifySignature" + }, + { + "description": "Verifies a signature supplied as string", + "id": "script-api:dw/crypto/Signature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "string" + }, + { + "name": "contentToVerify", + "type": "string" + }, + { + "name": "certificate", + "type": "CertificateRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/Signature", + "qualifiedName": "dw.crypto.Signature.verifySignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as string", + "heading": "Description" + } + ], + "signature": "verifySignature(signature: string, contentToVerify: string, certificate: CertificateRef, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifysignature", + "signature.verifysignature" + ], + "title": "Signature.verifySignature" + }, + { + "description": "This API provides access to Deprecated algorithms.", + "id": "script-api:dw/crypto/WeakCipher", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakCipher", + "sections": [ + { + "body": "This API provides access to Deprecated algorithms.\n\nSee Cipher for full documentation. WeakCipher is simply a drop-in replacement that only supports\ndeprecated algorithms and key lengths. This is helpful when you need to deal with weak algorithms for backward\ncompatibility purposes, but Cipher should always be used for new development and for anything intended to be secure.\n\nNote: this class handles sensitive security-related data. Pay special attention to PCI DSS v3 requirements 2,\n4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "weakcipher", + "dw.crypto.weakcipher", + "dw/crypto" + ], + "title": "WeakCipher" + }, + { + "description": "Strings containing keys, plain texts, cipher texts etc. are internally converted into byte arrays using this encoding (currently UTF8).", + "id": "script-api:dw/crypto/WeakCipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.CHAR_ENCODING", + "sections": [ + { + "body": "Strings containing keys, plain texts, cipher texts etc. are internally\nconverted into byte arrays using this encoding (currently UTF8).", + "heading": "Description" + } + ], + "signature": "static readonly CHAR_ENCODING = \"UTF8\"", + "source": "script-api", + "tags": [ + "char_encoding", + "weakcipher.char_encoding" + ], + "title": "WeakCipher.CHAR_ENCODING" + }, + { + "description": "Strings containing keys, plain texts, cipher texts etc. are internally converted into byte arrays using this encoding (currently UTF8).", + "id": "script-api:dw/crypto/WeakCipher#CHAR_ENCODING", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.CHAR_ENCODING", + "sections": [ + { + "body": "Strings containing keys, plain texts, cipher texts etc. are internally\nconverted into byte arrays using this encoding (currently UTF8).", + "heading": "Description" + } + ], + "signature": "static readonly CHAR_ENCODING = \"UTF8\"", + "source": "script-api", + "tags": [ + "char_encoding", + "weakcipher.char_encoding" + ], + "title": "WeakCipher.CHAR_ENCODING" + }, + { + "description": "Decrypts the message using the given parameters. See Cipher.decrypt_1 for full documentation.", + "id": "script-api:dw/crypto/WeakCipher#decrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "base64Msg", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.decrypt", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Decrypts the message using the given parameters. See\nCipher.decrypt_1 for full documentation.", + "heading": "Description" + } + ], + "signature": "decrypt(base64Msg: string, key: string, transformation: string, saltOrIV: string, iterations: number): string", + "source": "script-api", + "tags": [ + "decrypt", + "weakcipher.decrypt" + ], + "title": "WeakCipher.decrypt" + }, + { + "description": "Lower-level decryption API. Decrypts the passed bytes using the specified key and applying the transformations described by the specified parameters. See Cipher.decryptBytes_1 for full documentation.", + "id": "script-api:dw/crypto/WeakCipher#decryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "encryptedBytes", + "type": "Bytes" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.decryptBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Lower-level decryption API. Decrypts the passed bytes using the specified\nkey and applying the transformations described by the specified\nparameters. See Cipher.decryptBytes_1 for full\ndocumentation.", + "heading": "Description" + } + ], + "signature": "decryptBytes(encryptedBytes: Bytes, key: string, transformation: string, saltOrIV: string, iterations: number): Bytes", + "source": "script-api", + "tags": [ + "decryptbytes", + "weakcipher.decryptbytes" + ], + "title": "WeakCipher.decryptBytes" + }, + { + "description": "Encrypt the passed message by using the specified key and applying the transformations described by the specified parameters.", + "id": "script-api:dw/crypto/WeakCipher#encrypt", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "message", + "type": "string" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.encrypt", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypt the passed message by using the specified key and applying the\ntransformations described by the specified parameters.\n\nSee Cipher.encrypt_1 for full documentation.", + "heading": "Description" + } + ], + "signature": "encrypt(message: string, key: string, transformation: string, saltOrIV: string, iterations: number): string", + "source": "script-api", + "tags": [ + "encrypt", + "weakcipher.encrypt" + ], + "title": "WeakCipher.encrypt" + }, + { + "description": "Lower-level encryption API. Encrypts the passed bytes by using the specified key and applying the transformations described by the specified parameters. See Cipher.encryptBytes_1 for full documentation.", + "id": "script-api:dw/crypto/WeakCipher#encryptBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "messageBytes", + "type": "Bytes" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "transformation", + "type": "string" + }, + { + "name": "saltOrIV", + "type": "string" + }, + { + "name": "iterations", + "type": "number" + } + ], + "parentId": "script-api:dw/crypto/WeakCipher", + "qualifiedName": "dw.crypto.WeakCipher.encryptBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Lower-level encryption API. Encrypts the passed bytes by using the specified key and applying the transformations\ndescribed by the specified parameters. See Cipher.encryptBytes_1\nfor full documentation.", + "heading": "Description" + } + ], + "signature": "encryptBytes(messageBytes: Bytes, key: string, transformation: string, saltOrIV: string, iterations: number): Bytes", + "source": "script-api", + "tags": [ + "encryptbytes", + "weakcipher.encryptbytes" + ], + "title": "WeakCipher.encryptBytes" + }, + { + "description": "This API provides access to Deprecated algorithms.", + "id": "script-api:dw/crypto/WeakMac", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakMac", + "sections": [ + { + "body": "This API provides access to Deprecated algorithms.\n\nSee Mac for full documentation. WeakMac is simply a drop-in replacement that only supports\ndeprecated algorithms. This is helpful when you need to deal with weak algorithms for backward\ncompatibility purposes, but Mac should always be used for new development and for anything intended to be secure.\n\nThis class provides the functionality of a \"Message Authentication Code\" (MAC) algorithm.\nA MAC provides a way to check the integrity of information transmitted over or\nstored in an unreliable medium, based on a secret key.\nTypically, message authentication codes are used between two parties\nthat share a secret key in order to validate information transmitted between these parties.\nA MAC mechanism that is based on cryptographic hash functions is referred to as HMAC.\nHMAC can be used with any cryptographic hash function, e.g., SHA256,\nin combination with a secret shared key. HMAC is specified in RFC 2104.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "weakmac", + "dw.crypto.weakmac", + "dw/crypto" + ], + "title": "WeakMac" + }, + { + "description": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997). This algorithm uses as MD5 cryptographic hash function.", + "id": "script-api:dw/crypto/WeakMac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_MD5", + "sections": [ + { + "body": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997).\nThis algorithm uses as MD5 cryptographic hash function.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_MD5 = \"HmacMD5\"", + "source": "script-api", + "tags": [ + "hmac_md5", + "weakmac.hmac_md5" + ], + "title": "WeakMac.HMAC_MD5" + }, + { + "description": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997). This algorithm uses as MD5 cryptographic hash function.", + "id": "script-api:dw/crypto/WeakMac#HMAC_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_MD5", + "sections": [ + { + "body": "Constant representing the HMAC-MD5 keyed-hashing algorithm as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997).\nThis algorithm uses as MD5 cryptographic hash function.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_MD5 = \"HmacMD5\"", + "source": "script-api", + "tags": [ + "hmac_md5", + "weakmac.hmac_md5" + ], + "title": "WeakMac.HMAC_MD5" + }, + { + "description": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-1 as the message digest algorithm.", + "id": "script-api:dw/crypto/WeakMac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_SHA_1", + "sections": [ + { + "body": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-1 as the message digest algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_1 = \"HmacSHA1\"", + "source": "script-api", + "tags": [ + "hmac_sha_1", + "weakmac.hmac_sha_1" + ], + "title": "WeakMac.HMAC_SHA_1" + }, + { + "description": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997) with SHA-1 as the message digest algorithm.", + "id": "script-api:dw/crypto/WeakMac#HMAC_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.HMAC_SHA_1", + "sections": [ + { + "body": "Constant representing the HmacSHA1 algorithms as defined in RFC 2104 \"HMAC: Keyed-Hashing for Message Authentication\" (February 1997)\nwith SHA-1 as the message digest algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly HMAC_SHA_1 = \"HmacSHA1\"", + "source": "script-api", + "tags": [ + "hmac_sha_1", + "weakmac.hmac_sha_1" + ], + "title": "WeakMac.HMAC_SHA_1" + }, + { + "description": "Computes the hash value for the passed string input using the passed secret key. Given input and the given key will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.", + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed string input using the passed secret key.\nGiven input and the given key will be first converted with UTF-8 encoding into a byte array.\nThe resulting hash is typically converted with base64 back into a string.", + "heading": "Description" + } + ], + "signature": "digest(input: string, key: string): Bytes", + "source": "script-api", + "tags": [ + "digest", + "weakmac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "WeakMac.digest" + }, + { + "description": "Computes the hash value for the passed string input using the passed secret key. Given input will be first converted with UTF-8 encoding into a byte array. The resulting hash is typically converted with base64 back into a string.", + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + }, + { + "name": "key", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed string input using the passed secret key.\nGiven input will be first converted with UTF-8 encoding into a byte array.\nThe resulting hash is typically converted with base64 back into a string.", + "heading": "Description" + } + ], + "signature": "digest(input: string, key: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "weakmac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "WeakMac.digest" + }, + { + "description": "Computes the hash value for the passed bytes input using the passed secret key.", + "id": "script-api:dw/crypto/WeakMac#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + }, + { + "name": "key", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/WeakMac", + "qualifiedName": "dw.crypto.WeakMac.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed bytes input using the passed secret key.", + "heading": "Description" + } + ], + "signature": "digest(input: Bytes, key: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "weakmac.digest" + ], + "throws": [ + { + "description": "if algorithm is not null and the specified algorithm name is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "WeakMac.digest" + }, + { + "description": "This API provides access to Deprecated algorithms.", + "id": "script-api:dw/crypto/WeakMessageDigest", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakMessageDigest", + "sections": [ + { + "body": "This API provides access to Deprecated algorithms.\n\nSee MessageDigest for full documentation. WeakMessageDigest is simply a drop-in replacement that only supports\ndeprecated algorithms. This is helpful when you need to deal with weak algorithms for backward\ncompatibility purposes, but MessageDigest should always be used for new development and for anything intended to be secure.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "weakmessagedigest", + "dw.crypto.weakmessagedigest", + "dw/crypto" + ], + "title": "WeakMessageDigest" + }, + { + "description": "Constant representing the MD2 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD2", + "sections": [ + { + "body": "Constant representing the MD2 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD2 = \"MD2\"", + "source": "script-api", + "tags": [ + "digest_md2", + "weakmessagedigest.digest_md2" + ], + "title": "WeakMessageDigest.DIGEST_MD2" + }, + { + "description": "Constant representing the MD2 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD2", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD2", + "sections": [ + { + "body": "Constant representing the MD2 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD2 = \"MD2\"", + "source": "script-api", + "tags": [ + "digest_md2", + "weakmessagedigest.digest_md2" + ], + "title": "WeakMessageDigest.DIGEST_MD2" + }, + { + "description": "Constant representing the MD5 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD5", + "sections": [ + { + "body": "Constant representing the MD5 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD5 = \"MD5\"", + "source": "script-api", + "tags": [ + "digest_md5", + "weakmessagedigest.digest_md5" + ], + "title": "WeakMessageDigest.DIGEST_MD5" + }, + { + "description": "Constant representing the MD5 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_MD5", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_MD5", + "sections": [ + { + "body": "Constant representing the MD5 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_MD5 = \"MD5\"", + "source": "script-api", + "tags": [ + "digest_md5", + "weakmessagedigest.digest_md5" + ], + "title": "WeakMessageDigest.DIGEST_MD5" + }, + { + "description": "Constant representing the SHA algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA", + "sections": [ + { + "body": "Constant representing the SHA algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA = \"SHA\"", + "source": "script-api", + "tags": [ + "digest_sha", + "weakmessagedigest.digest_sha" + ], + "title": "WeakMessageDigest.DIGEST_SHA" + }, + { + "description": "Constant representing the SHA algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA", + "sections": [ + { + "body": "Constant representing the SHA algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA = \"SHA\"", + "source": "script-api", + "tags": [ + "digest_sha", + "weakmessagedigest.digest_sha" + ], + "title": "WeakMessageDigest.DIGEST_SHA" + }, + { + "description": "Constant representing the SHA 1 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA_1", + "sections": [ + { + "body": "Constant representing the SHA 1 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_1 = \"SHA-1\"", + "source": "script-api", + "tags": [ + "digest_sha_1", + "weakmessagedigest.digest_sha_1" + ], + "title": "WeakMessageDigest.DIGEST_SHA_1" + }, + { + "description": "Constant representing the SHA 1 algorithm.", + "id": "script-api:dw/crypto/WeakMessageDigest#DIGEST_SHA_1", + "kind": "constant", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.DIGEST_SHA_1", + "sections": [ + { + "body": "Constant representing the SHA 1 algorithm.\n\nThis algorithm is obsolete. Do not use it for any sensitive data", + "heading": "Description" + } + ], + "signature": "static readonly DIGEST_SHA_1 = \"SHA-1\"", + "source": "script-api", + "tags": [ + "digest_sha_1", + "weakmessagedigest.digest_sha_1" + ], + "title": "WeakMessageDigest.DIGEST_SHA_1" + }, + { + "deprecated": { + "message": "Deprecated because the conversion of the input to bytes using\nthe default platform encoding and the hex-encoded return\nvalue are not generally appropriate." + }, + "description": "Digests the passed string and returns a computed hash value as a string. The passed String is first encoded into a sequence of bytes using the platform's default encoding. The digest then performs any prerequisite padding, before computing the hash value. The hash is then converted into a string by converting all digits to hexadecimal.", + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Digests the passed string and returns a computed hash value as a string.\nThe passed String is first encoded into a sequence of bytes using the\nplatform's default encoding. The digest then performs any prerequisite\npadding, before computing the hash value. The hash is then converted into\na string by converting all digits to hexadecimal.", + "heading": "Description" + } + ], + "signature": "digest(input: string): string", + "source": "script-api", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "deprecated": { + "message": "Deprecated because the digest algorithm should be the one\nset in the constructor." + }, + "description": "Computes the hash value for the passed array of bytes. The algorithm argument is optional. If null, then the algorithm established at construction time is used.", + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "algorithm", + "type": "string | null" + }, + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed array of bytes. The algorithm\nargument is optional. If null, then the algorithm established at\nconstruction time is used.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest( \"MD5\", new Bytes( \"my password\", \"UTF-8\" ) ) );\n`", + "heading": "Description" + } + ], + "signature": "digest(algorithm: string | null, input: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "description": "Completes the hash computation by performing final operations such as padding.", + "id": "script-api:dw/crypto/WeakMessageDigest#digest", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digest", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Completes the hash computation by performing final operations such as\npadding.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest() );\n`", + "heading": "Description" + } + ], + "signature": "digest(): Bytes", + "source": "script-api", + "tags": [ + "digest", + "weakmessagedigest.digest" + ], + "title": "WeakMessageDigest.digest" + }, + { + "description": "Computes the hash value for the passed dw.util.Bytes.", + "id": "script-api:dw/crypto/WeakMessageDigest#digestBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.digestBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Computes the hash value for the passed dw.util.Bytes.\n\nThe binary representation of the message is typically derived from a\nstring and the resulting hash is typically converted with base64 back\ninto a string. Example:\n\n`\nEncoding.toBase64( digest( new Bytes( \"my password\", \"UTF-8\" ) ) );\n`", + "heading": "Description" + } + ], + "signature": "digestBytes(input: Bytes): Bytes", + "source": "script-api", + "tags": [ + "digestbytes", + "weakmessagedigest.digestbytes" + ], + "title": "WeakMessageDigest.digestBytes" + }, + { + "description": "Updates the digest using the passed dw.util.Bytes.", + "id": "script-api:dw/crypto/WeakMessageDigest#updateBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "input", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/crypto/WeakMessageDigest", + "qualifiedName": "dw.crypto.WeakMessageDigest.updateBytes", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the digest using the passed dw.util.Bytes.", + "heading": "Description" + } + ], + "signature": "updateBytes(input: Bytes): void", + "source": "script-api", + "tags": [ + "updatebytes", + "weakmessagedigest.updatebytes" + ], + "title": "WeakMessageDigest.updateBytes" + }, + { + "description": "This API provides access to Deprecated algorithms.", + "id": "script-api:dw/crypto/WeakSignature", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.WeakSignature", + "sections": [ + { + "body": "This API provides access to Deprecated algorithms.\n\nSee Signature for full documentation. WeakSignature is simply a drop-in replacement that only supports\ndeprecated algorithms. This is helpful when you need to deal with weak algorithms for backward compatibility\npurposes, but Signature should always be used for new development and for anything intended to be secure.\n\nThis class allows access to signature services offered through the Java Cryptography Architecture (JCA). At this time\nthe signature/verification implementation of the methods is based on the default RSA JCE provider of the JDK -\nsun.security.rsa.SunRsaSign\n\ndw.crypto.WeakSignature is an adapter to the security provider implementation and only covers one digest algorithm:\n\n- SHA1withRSA\n\nNote: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2,\n4, 12, and other relevant requirements.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "weaksignature", + "dw.crypto.weaksignature", + "dw/crypto" + ], + "title": "WeakSignature" + }, + { + "description": "Checks to see if a digest algorithm is supported", + "id": "script-api:dw/crypto/WeakSignature#isDigestAlgorithmSupported", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.isDigestAlgorithmSupported", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks to see if a digest algorithm is supported", + "heading": "Description" + } + ], + "signature": "isDigestAlgorithmSupported(digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "isdigestalgorithmsupported", + "weaksignature.isdigestalgorithmsupported" + ], + "title": "WeakSignature.isDigestAlgorithmSupported" + }, + { + "description": "Signs a string and returns a string", + "id": "script-api:dw/crypto/WeakSignature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "string" + }, + { + "name": "privateKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.sign", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Signs a string and returns a string", + "heading": "Description" + } + ], + "signature": "sign(contentToSign: string, privateKey: string, digestAlgorithm: string): string", + "source": "script-api", + "tags": [ + "sign", + "weaksignature.sign" + ], + "title": "WeakSignature.sign" + }, + { + "description": "Signs a string and returns a string", + "id": "script-api:dw/crypto/WeakSignature#sign", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "string" + }, + { + "name": "privateKey", + "type": "KeyRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.sign", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Signs a string and returns a string", + "heading": "Description" + } + ], + "signature": "sign(contentToSign: string, privateKey: KeyRef, digestAlgorithm: string): string", + "source": "script-api", + "tags": [ + "sign", + "weaksignature.sign" + ], + "title": "WeakSignature.sign" + }, + { + "description": "Signs bytes and returns bytes", + "id": "script-api:dw/crypto/WeakSignature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "Bytes" + }, + { + "name": "privateKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.signBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Signs bytes and returns bytes", + "heading": "Description" + } + ], + "signature": "signBytes(contentToSign: Bytes, privateKey: string, digestAlgorithm: string): Bytes", + "source": "script-api", + "tags": [ + "signbytes", + "weaksignature.signbytes" + ], + "title": "WeakSignature.signBytes" + }, + { + "description": "Signs bytes and returns bytes", + "id": "script-api:dw/crypto/WeakSignature#signBytes", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "contentToSign", + "type": "Bytes" + }, + { + "name": "privateKey", + "type": "KeyRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.signBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Signs bytes and returns bytes", + "heading": "Description" + } + ], + "signature": "signBytes(contentToSign: Bytes, privateKey: KeyRef, digestAlgorithm: string): Bytes", + "source": "script-api", + "tags": [ + "signbytes", + "weaksignature.signbytes" + ], + "title": "WeakSignature.signBytes" + }, + { + "description": "Verifies a signature supplied as bytes", + "id": "script-api:dw/crypto/WeakSignature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "Bytes" + }, + { + "name": "contentToVerify", + "type": "Bytes" + }, + { + "name": "publicKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifyBytesSignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as bytes", + "heading": "Description" + } + ], + "signature": "verifyBytesSignature(signature: Bytes, contentToVerify: Bytes, publicKey: string, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifybytessignature", + "weaksignature.verifybytessignature" + ], + "title": "WeakSignature.verifyBytesSignature" + }, + { + "description": "Verifies a signature supplied as bytes", + "id": "script-api:dw/crypto/WeakSignature#verifyBytesSignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "Bytes" + }, + { + "name": "contentToVerify", + "type": "Bytes" + }, + { + "name": "certificate", + "type": "CertificateRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifyBytesSignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as bytes", + "heading": "Description" + } + ], + "signature": "verifyBytesSignature(signature: Bytes, contentToVerify: Bytes, certificate: CertificateRef, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifybytessignature", + "weaksignature.verifybytessignature" + ], + "title": "WeakSignature.verifyBytesSignature" + }, + { + "description": "Verifies a signature supplied as string", + "id": "script-api:dw/crypto/WeakSignature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "string" + }, + { + "name": "contentToVerify", + "type": "string" + }, + { + "name": "publicKey", + "type": "string" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifySignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as string", + "heading": "Description" + } + ], + "signature": "verifySignature(signature: string, contentToVerify: string, publicKey: string, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifysignature", + "weaksignature.verifysignature" + ], + "title": "WeakSignature.verifySignature" + }, + { + "description": "Verifies a signature supplied as string", + "id": "script-api:dw/crypto/WeakSignature#verifySignature", + "kind": "method", + "packagePath": "dw/crypto", + "params": [ + { + "name": "signature", + "type": "string" + }, + { + "name": "contentToVerify", + "type": "string" + }, + { + "name": "certificate", + "type": "CertificateRef" + }, + { + "name": "digestAlgorithm", + "type": "string" + } + ], + "parentId": "script-api:dw/crypto/WeakSignature", + "qualifiedName": "dw.crypto.WeakSignature.verifySignature", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Verifies a signature supplied as string", + "heading": "Description" + } + ], + "signature": "verifySignature(signature: string, contentToVerify: string, certificate: CertificateRef, digestAlgorithm: string): boolean", + "source": "script-api", + "tags": [ + "verifysignature", + "weaksignature.verifysignature" + ], + "title": "WeakSignature.verifySignature" + }, + { + "description": "Represents an X.509 public key certificate as defined in RFC 5280.", + "id": "script-api:dw/crypto/X509Certificate", + "kind": "class", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto", + "qualifiedName": "dw.crypto.X509Certificate", + "sections": [ + { + "body": "Represents an X.509 public key certificate as defined in RFC 5280.\n\nIt provides access to the standard fields of an X.509 certificate including version, serial number, validity period,\ndistinguished names, and signature algorithm.", + "heading": "Description" + }, + { + "body": "Extends `CertificateRef`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "x509certificate", + "dw.crypto.x509certificate", + "dw/crypto" + ], + "title": "X509Certificate" + }, + { + "description": "Returns the X.500 distinguished name of the entity that signed this certificate.", + "id": "script-api:dw/crypto/X509Certificate#getIssuerDN", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getIssuerDN", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the X.500 distinguished name of the entity that signed this certificate.", + "heading": "Description" + } + ], + "signature": "getIssuerDN(): string", + "source": "script-api", + "tags": [ + "getissuerdn", + "x509certificate.getissuerdn" + ], + "title": "X509Certificate.getIssuerDN" + }, + { + "description": "Returns the end date of the certificate validity period.", + "id": "script-api:dw/crypto/X509Certificate#getNotAfter", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getNotAfter", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the end date of the certificate validity period.", + "heading": "Description" + } + ], + "signature": "getNotAfter(): Date", + "source": "script-api", + "tags": [ + "getnotafter", + "x509certificate.getnotafter" + ], + "title": "X509Certificate.getNotAfter" + }, + { + "description": "Returns the start date of the certificate validity period.", + "id": "script-api:dw/crypto/X509Certificate#getNotBefore", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getNotBefore", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the start date of the certificate validity period.", + "heading": "Description" + } + ], + "signature": "getNotBefore(): Date", + "source": "script-api", + "tags": [ + "getnotbefore", + "x509certificate.getnotbefore" + ], + "title": "X509Certificate.getNotBefore" + }, + { + "description": "Returns the certificate serial number in string format. The serial number is a unique positive integer assigned by the CA to each certificate.", + "id": "script-api:dw/crypto/X509Certificate#getSerialNumber", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSerialNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the certificate serial number in string format. The serial number is a unique positive integer assigned\nby the CA to each certificate.", + "heading": "Description" + } + ], + "signature": "getSerialNumber(): string", + "source": "script-api", + "tags": [ + "getserialnumber", + "x509certificate.getserialnumber" + ], + "title": "X509Certificate.getSerialNumber" + }, + { + "description": "Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g., \"SHA256withRSA\", \"SHA384withECDSA\").", + "id": "script-api:dw/crypto/X509Certificate#getSigAlgName", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSigAlgName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,\n\"SHA256withRSA\", \"SHA384withECDSA\").", + "heading": "Description" + } + ], + "signature": "getSigAlgName(): string", + "source": "script-api", + "tags": [ + "getsigalgname", + "x509certificate.getsigalgname" + ], + "title": "X509Certificate.getSigAlgName" + }, + { + "description": "Returns the X.500 distinguished name of the entity this certificate belongs to.", + "id": "script-api:dw/crypto/X509Certificate#getSubjectDN", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getSubjectDN", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the X.500 distinguished name of the entity this certificate belongs to.", + "heading": "Description" + } + ], + "signature": "getSubjectDN(): string", + "source": "script-api", + "tags": [ + "getsubjectdn", + "x509certificate.getsubjectdn" + ], + "title": "X509Certificate.getSubjectDN" + }, + { + "description": "Returns the X.509 certificate version number.", + "id": "script-api:dw/crypto/X509Certificate#getVersion", + "kind": "method", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.getVersion", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the X.509 certificate version number.", + "heading": "Description" + } + ], + "signature": "getVersion(): number", + "source": "script-api", + "tags": [ + "getversion", + "x509certificate.getversion" + ], + "title": "X509Certificate.getVersion" + }, + { + "description": "Returns the X.500 distinguished name of the entity that signed this certificate.", + "id": "script-api:dw/crypto/X509Certificate#issuerDN", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.issuerDN", + "sections": [ + { + "body": "Returns the X.500 distinguished name of the entity that signed this certificate.", + "heading": "Description" + } + ], + "signature": "readonly issuerDN: string", + "source": "script-api", + "tags": [ + "issuerdn", + "x509certificate.issuerdn" + ], + "title": "X509Certificate.issuerDN" + }, + { + "description": "Returns the end date of the certificate validity period.", + "id": "script-api:dw/crypto/X509Certificate#notAfter", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.notAfter", + "sections": [ + { + "body": "Returns the end date of the certificate validity period.", + "heading": "Description" + } + ], + "signature": "readonly notAfter: Date", + "source": "script-api", + "tags": [ + "notafter", + "x509certificate.notafter" + ], + "title": "X509Certificate.notAfter" + }, + { + "description": "Returns the start date of the certificate validity period.", + "id": "script-api:dw/crypto/X509Certificate#notBefore", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.notBefore", + "sections": [ + { + "body": "Returns the start date of the certificate validity period.", + "heading": "Description" + } + ], + "signature": "readonly notBefore: Date", + "source": "script-api", + "tags": [ + "notbefore", + "x509certificate.notbefore" + ], + "title": "X509Certificate.notBefore" + }, + { + "description": "Returns the certificate serial number in string format. The serial number is a unique positive integer assigned by the CA to each certificate.", + "id": "script-api:dw/crypto/X509Certificate#serialNumber", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.serialNumber", + "sections": [ + { + "body": "Returns the certificate serial number in string format. The serial number is a unique positive integer assigned\nby the CA to each certificate.", + "heading": "Description" + } + ], + "signature": "readonly serialNumber: string", + "source": "script-api", + "tags": [ + "serialnumber", + "x509certificate.serialnumber" + ], + "title": "X509Certificate.serialNumber" + }, + { + "description": "Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g., \"SHA256withRSA\", \"SHA384withECDSA\").", + "id": "script-api:dw/crypto/X509Certificate#sigAlgName", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.sigAlgName", + "sections": [ + { + "body": "Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,\n\"SHA256withRSA\", \"SHA384withECDSA\").", + "heading": "Description" + } + ], + "signature": "readonly sigAlgName: string", + "source": "script-api", + "tags": [ + "sigalgname", + "x509certificate.sigalgname" + ], + "title": "X509Certificate.sigAlgName" + }, + { + "description": "Returns the X.500 distinguished name of the entity this certificate belongs to.", + "id": "script-api:dw/crypto/X509Certificate#subjectDN", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.subjectDN", + "sections": [ + { + "body": "Returns the X.500 distinguished name of the entity this certificate belongs to.", + "heading": "Description" + } + ], + "signature": "readonly subjectDN: string", + "source": "script-api", + "tags": [ + "subjectdn", + "x509certificate.subjectdn" + ], + "title": "X509Certificate.subjectDN" + }, + { + "description": "Returns the X.509 certificate version number.", + "id": "script-api:dw/crypto/X509Certificate#version", + "kind": "property", + "packagePath": "dw/crypto", + "parentId": "script-api:dw/crypto/X509Certificate", + "qualifiedName": "dw.crypto.X509Certificate.version", + "sections": [ + { + "body": "Returns the X.509 certificate version number.", + "heading": "Description" + } + ], + "signature": "readonly version: number", + "source": "script-api", + "tags": [ + "version", + "x509certificate.version" + ], + "title": "X509Certificate.version" + }, + { + "description": "26 declarations", + "id": "script-api:dw/customer", + "kind": "package", + "packagePath": "dw/customer", + "qualifiedName": "dw.customer", + "source": "script-api", + "tags": [ + "dw/customer", + "dw.customer" + ], + "title": "dw.customer" + }, + { + "description": "Represents a set of addresses associated with a specific customer. The AddressBook object gets its data from the Profile object for the customer. When scripting, this class allows AddressBook to be treated as a separate object from the Profile. However, data is only stored in the platform in the Profile object and there is no separate AddressBook object. For this reason, the AddressBook ID is always the customer profile ID.", + "id": "script-api:dw/customer/AddressBook", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AddressBook", + "sections": [ + { + "body": "Represents a set of addresses associated with a specific customer.\nThe AddressBook object gets its data from the Profile object for the customer.\nWhen scripting, this class allows AddressBook to be treated as a separate object\nfrom the Profile. However, data is only stored in the platform in the Profile object\nand there is no separate AddressBook object. For this reason, the AddressBook ID is\nalways the customer profile ID.\n\nNote: this class allows access to sensitive personal and private information.\nPay attention to appropriate legal and regulatory requirements when developing.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "addressbook", + "dw.customer.addressbook", + "dw/customer" + ], + "title": "AddressBook" + }, + { + "description": "Returns a sorted list of addresses in the address book. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID.", + "id": "script-api:dw/customer/AddressBook#addresses", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.addresses", + "sections": [ + { + "body": "Returns a sorted list of addresses in the address book. The addresses\nare sorted so that the preferred address is always sorted first. The\nremaining addresses are sorted alphabetically by ID.", + "heading": "Description" + } + ], + "signature": "readonly addresses: List", + "source": "script-api", + "tags": [ + "addresses", + "addressbook.addresses" + ], + "title": "AddressBook.addresses" + }, + { + "description": "Creates a new, empty address object with the specified name.", + "id": "script-api:dw/customer/AddressBook#createAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.createAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "Creates a new, empty address object with the specified name.", + "heading": "Description" + } + ], + "signature": "createAddress(name: string): CustomerAddress | null", + "source": "script-api", + "tags": [ + "createaddress", + "addressbook.createaddress" + ], + "throws": [ + { + "description": "If passed 'name' is null.", + "type": "NullArgumentException" + }, + { + "description": "If passed 'name' is not null, but an empty string.", + "type": "IllegalArgumentException" + } + ], + "title": "AddressBook.createAddress" + }, + { + "description": "Returns the address with the given name from the address book. The name is a unique identifier of the address within the address book.", + "id": "script-api:dw/customer/AddressBook#getAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "Returns the address with the given name from the address book. The name\nis a unique identifier of the address within the address book.", + "heading": "Description" + } + ], + "signature": "getAddress(id: string): CustomerAddress | null", + "source": "script-api", + "tags": [ + "getaddress", + "addressbook.getaddress" + ], + "throws": [ + { + "description": "If passed 'id' is null.", + "type": "NullArgumentException" + }, + { + "description": "If passed 'id' is not null, but an empty string.", + "type": "IllegalArgumentException" + } + ], + "title": "AddressBook.getAddress" + }, + { + "description": "Returns a sorted list of addresses in the address book. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID.", + "id": "script-api:dw/customer/AddressBook#getAddresses", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getAddresses", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a sorted list of addresses in the address book. The addresses\nare sorted so that the preferred address is always sorted first. The\nremaining addresses are sorted alphabetically by ID.", + "heading": "Description" + } + ], + "signature": "getAddresses(): List", + "source": "script-api", + "tags": [ + "getaddresses", + "addressbook.getaddresses" + ], + "title": "AddressBook.getAddresses" + }, + { + "description": "Returns the address that has been defined as the customer's preferred address.", + "id": "script-api:dw/customer/AddressBook#getPreferredAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.getPreferredAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "Returns the address that has been defined as the customer's preferred\naddress.", + "heading": "Description" + } + ], + "signature": "getPreferredAddress(): CustomerAddress | null", + "source": "script-api", + "tags": [ + "getpreferredaddress", + "addressbook.getpreferredaddress" + ], + "title": "AddressBook.getPreferredAddress" + }, + { + "description": "Returns the address that has been defined as the customer's preferred address.", + "id": "script-api:dw/customer/AddressBook#preferredAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.preferredAddress", + "sections": [ + { + "body": "Returns the address that has been defined as the customer's preferred\naddress.", + "heading": "Description" + } + ], + "signature": "preferredAddress: CustomerAddress | null", + "source": "script-api", + "tags": [ + "preferredaddress", + "addressbook.preferredaddress" + ], + "title": "AddressBook.preferredAddress" + }, + { + "description": "Removes the specified address from the address book. Because an address can be associated with a product list, you may want to verify if the address is being used by a product list. See ProductListMgr.findAddress().", + "id": "script-api:dw/customer/AddressBook#removeAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "address", + "type": "CustomerAddress" + } + ], + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.removeAddress", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified address from the address book. Because an address\ncan be associated with a product list, you may want to verify if the\naddress is being used by a product list. See ProductListMgr.findAddress().", + "heading": "Description" + } + ], + "signature": "removeAddress(address: CustomerAddress): void", + "source": "script-api", + "tags": [ + "removeaddress", + "addressbook.removeaddress" + ], + "title": "AddressBook.removeAddress" + }, + { + "description": "Sets the specified address as the customer's preferred address. If null is passed, and there is an existing preferred address, then the address book will have no preferred address.", + "id": "script-api:dw/customer/AddressBook#setPreferredAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "anAddress", + "type": "CustomerAddress | null" + } + ], + "parentId": "script-api:dw/customer/AddressBook", + "qualifiedName": "dw.customer.AddressBook.setPreferredAddress", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the specified address as the customer's preferred address. If null\nis passed, and there is an existing preferred address, then the address\nbook will have no preferred address.", + "heading": "Description" + } + ], + "signature": "setPreferredAddress(anAddress: CustomerAddress | null): void", + "source": "script-api", + "tags": [ + "setpreferredaddress", + "addressbook.setpreferredaddress" + ], + "title": "AddressBook.setPreferredAddress" + }, + { + "description": "Provides helper methods for handling agent user functionality (login and logout) Pay attention to appropriate legal and regulatory requirements related to this functionality.", + "id": "script-api:dw/customer/AgentUserMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AgentUserMgr", + "sections": [ + { + "body": "Provides helper methods for handling agent user functionality (login and logout)\nPay attention to appropriate legal and regulatory requirements related to this functionality.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "agentusermgr", + "dw.customer.agentusermgr", + "dw/customer" + ], + "title": "AgentUserMgr" + }, + { + "description": "Logs in an agent user (which for example is authorized to login on-behalf of a customer for instance to place an order). The login is only allowed during a secure protocol request (https) and only in the storefront context. The user must have the permission 'Login_Agent'.", + "id": "script-api:dw/customer/AgentUserMgr#loginAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginAgentUser", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Logs in an agent user (which for example is authorized to login on-behalf of a customer for\ninstance to place an order). The login is only allowed during a secure protocol\nrequest (https) and only in the storefront context. The user must have the permission 'Login_Agent'.\n\nWhen the login is successful, a new session will be created. Any objects that need\nto be preserved in the session need to bet set on the session afterwards.\n\nA Status object is returned which signals whether the login was successful or not.\nIn case of a login failure the status object contains the reason for this.\nSee AgentUserStatusCodes for more information.", + "heading": "Description" + } + ], + "signature": "static loginAgentUser(login: string, password: string): Status", + "source": "script-api", + "tags": [ + "loginagentuser", + "agentusermgr.loginagentuser" + ], + "title": "AgentUserMgr.loginAgentUser" + }, + { + "description": "Logs in an agent user (which for example is authorized to login on-behalf of a customer for instance to place an order). The login is only allowed during a secure protocol request (https) and only in the storefront context. The user must have the permission 'Login_Agent'.", + "id": "script-api:dw/customer/AgentUserMgr#loginAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginAgentUser", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Logs in an agent user (which for example is authorized to login on-behalf of a customer for\ninstance to place an order). The login is only allowed during a secure protocol\nrequest (https) and only in the storefront context. The user must have the permission 'Login_Agent'.\n\nWhen the login is successful, a new session will be created. Any objects that need\nto be preserved in the session need to bet set on the session afterwards.\n\nA Status object is returned which signals whether the login was successful or not.\nIn case of a login failure the status object contains the reason for this.\nSee AgentUserStatusCodes for more information.", + "heading": "Description" + } + ], + "signature": "static loginAgentUser(login: string, password: string): Status", + "source": "script-api", + "tags": [ + "loginagentuser", + "agentusermgr.loginagentuser" + ], + "title": "AgentUserMgr.loginAgentUser" + }, + { + "description": "This method logs the specified customer into the current session if the current agent user has the functional permission 'Login_On_Behalf' in the current site.", + "id": "script-api:dw/customer/AgentUserMgr#loginOnBehalfOfCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginOnBehalfOfCustomer", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method logs the specified customer into the current session if the\ncurrent agent user has the functional permission 'Login_On_Behalf' in the\ncurrent site.\n\nThe dwcustomer cookie will not be set.\nThe login is only allowed during a secure protocol request (https).\nA Status object is returned indicating whether the login was successful or not (and indicating the\nfailure reason). See AgentUserStatusCodes for more information.\nError conditions include:\n\n- if the method is not called in the storefront context\n- if the given customer is not a registered customer (anonymous)\n- if the given customer is not registered for the current site\n- if the given customer is disabled\n- if there is no agent user at the current session\n- if the agent user is not logged in\n- if the agent user has not the functional permission 'Login_On_Behalf'", + "heading": "Description" + } + ], + "signature": "static loginOnBehalfOfCustomer(customer: Customer): Status", + "source": "script-api", + "tags": [ + "loginonbehalfofcustomer", + "agentusermgr.loginonbehalfofcustomer" + ], + "title": "AgentUserMgr.loginOnBehalfOfCustomer" + }, + { + "description": "This method logs the specified customer into the current session if the current agent user has the functional permission 'Login_On_Behalf' in the current site.", + "id": "script-api:dw/customer/AgentUserMgr#loginOnBehalfOfCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.loginOnBehalfOfCustomer", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method logs the specified customer into the current session if the\ncurrent agent user has the functional permission 'Login_On_Behalf' in the\ncurrent site.\n\nThe dwcustomer cookie will not be set.\nThe login is only allowed during a secure protocol request (https).\nA Status object is returned indicating whether the login was successful or not (and indicating the\nfailure reason). See AgentUserStatusCodes for more information.\nError conditions include:\n\n- if the method is not called in the storefront context\n- if the given customer is not a registered customer (anonymous)\n- if the given customer is not registered for the current site\n- if the given customer is disabled\n- if there is no agent user at the current session\n- if the agent user is not logged in\n- if the agent user has not the functional permission 'Login_On_Behalf'", + "heading": "Description" + } + ], + "signature": "static loginOnBehalfOfCustomer(customer: Customer): Status", + "source": "script-api", + "tags": [ + "loginonbehalfofcustomer", + "agentusermgr.loginonbehalfofcustomer" + ], + "title": "AgentUserMgr.loginOnBehalfOfCustomer" + }, + { + "description": "Performs a logout of the agent user and the current customer which are attached to the current session. The logout is only allowed during a secure protocol request (https) and only in the storefront context.", + "id": "script-api:dw/customer/AgentUserMgr#logoutAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.logoutAgentUser", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Performs a logout of the agent user and the current customer which are attached to the current session.\nThe logout is only allowed during a secure protocol request (https) and only in the storefront context.", + "heading": "Description" + } + ], + "signature": "static logoutAgentUser(): Status", + "source": "script-api", + "tags": [ + "logoutagentuser", + "agentusermgr.logoutagentuser" + ], + "title": "AgentUserMgr.logoutAgentUser" + }, + { + "description": "Performs a logout of the agent user and the current customer which are attached to the current session. The logout is only allowed during a secure protocol request (https) and only in the storefront context.", + "id": "script-api:dw/customer/AgentUserMgr#logoutAgentUser", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserMgr", + "qualifiedName": "dw.customer.AgentUserMgr.logoutAgentUser", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Performs a logout of the agent user and the current customer which are attached to the current session.\nThe logout is only allowed during a secure protocol request (https) and only in the storefront context.", + "heading": "Description" + } + ], + "signature": "static logoutAgentUser(): Status", + "source": "script-api", + "tags": [ + "logoutagentuser", + "agentusermgr.logoutagentuser" + ], + "title": "AgentUserMgr.logoutAgentUser" + }, + { + "description": "AgentUserStatusCodes contains constants representing status codes that can be used with a dw.system.Status object to indicate the success or failure of the agent user login process.", + "id": "script-api:dw/customer/AgentUserStatusCodes", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AgentUserStatusCodes", + "sections": [ + { + "body": "AgentUserStatusCodes contains constants representing status codes that can be\nused with a dw.system.Status object to indicate the success or failure of the agent\nuser login process.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "agentuserstatuscodes", + "dw.customer.agentuserstatuscodes", + "dw/customer" + ], + "title": "AgentUserStatusCodes" + }, + { + "description": "Indicates that the agent user is not available.", + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE", + "sections": [ + { + "body": "Indicates that the agent user is not available.", + "heading": "Description" + } + ], + "signature": "static readonly AGENT_USER_NOT_AVAILABLE: string", + "source": "script-api", + "tags": [ + "agent_user_not_available", + "agentuserstatuscodes.agent_user_not_available" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE" + }, + { + "description": "Indicates that the agent user is not available.", + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_AVAILABLE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE", + "sections": [ + { + "body": "Indicates that the agent user is not available.", + "heading": "Description" + } + ], + "signature": "static readonly AGENT_USER_NOT_AVAILABLE: string", + "source": "script-api", + "tags": [ + "agent_user_not_available", + "agentuserstatuscodes.agent_user_not_available" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_AVAILABLE" + }, + { + "description": "Indicates that the agent user is not logged in.", + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_LOGGED_IN", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN", + "sections": [ + { + "body": "Indicates that the agent user is not logged in.", + "heading": "Description" + } + ], + "signature": "static readonly AGENT_USER_NOT_LOGGED_IN: string", + "source": "script-api", + "tags": [ + "agent_user_not_logged_in", + "agentuserstatuscodes.agent_user_not_logged_in" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN" + }, + { + "description": "Indicates that the agent user is not logged in.", + "id": "script-api:dw/customer/AgentUserStatusCodes#AGENT_USER_NOT_LOGGED_IN", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN", + "sections": [ + { + "body": "Indicates that the agent user is not logged in.", + "heading": "Description" + } + ], + "signature": "static readonly AGENT_USER_NOT_LOGGED_IN: string", + "source": "script-api", + "tags": [ + "agent_user_not_logged_in", + "agentuserstatuscodes.agent_user_not_logged_in" + ], + "title": "AgentUserStatusCodes.AGENT_USER_NOT_LOGGED_IN" + }, + { + "description": "Indicates that the given agent user login or password was wrong.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CREDENTIALS_INVALID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CREDENTIALS_INVALID", + "sections": [ + { + "body": "Indicates that the given agent user login or password was wrong.", + "heading": "Description" + } + ], + "signature": "static readonly CREDENTIALS_INVALID: string", + "source": "script-api", + "tags": [ + "credentials_invalid", + "agentuserstatuscodes.credentials_invalid" + ], + "title": "AgentUserStatusCodes.CREDENTIALS_INVALID" + }, + { + "description": "Indicates that the given agent user login or password was wrong.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CREDENTIALS_INVALID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CREDENTIALS_INVALID", + "sections": [ + { + "body": "Indicates that the given agent user login or password was wrong.", + "heading": "Description" + } + ], + "signature": "static readonly CREDENTIALS_INVALID: string", + "source": "script-api", + "tags": [ + "credentials_invalid", + "agentuserstatuscodes.credentials_invalid" + ], + "title": "AgentUserStatusCodes.CREDENTIALS_INVALID" + }, + { + "description": "Indicates that the customer is disabled.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_DISABLED", + "sections": [ + { + "body": "Indicates that the customer is disabled.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_DISABLED: string", + "source": "script-api", + "tags": [ + "customer_disabled", + "agentuserstatuscodes.customer_disabled" + ], + "title": "AgentUserStatusCodes.CUSTOMER_DISABLED" + }, + { + "description": "Indicates that the customer is disabled.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_DISABLED", + "sections": [ + { + "body": "Indicates that the customer is disabled.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_DISABLED: string", + "source": "script-api", + "tags": [ + "customer_disabled", + "agentuserstatuscodes.customer_disabled" + ], + "title": "AgentUserStatusCodes.CUSTOMER_DISABLED" + }, + { + "description": "Indicates that the customer is either not registered or not registered with the current site.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_UNREGISTERED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_UNREGISTERED", + "sections": [ + { + "body": "Indicates that the customer is either not registered or not registered with the current site.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_UNREGISTERED: string", + "source": "script-api", + "tags": [ + "customer_unregistered", + "agentuserstatuscodes.customer_unregistered" + ], + "title": "AgentUserStatusCodes.CUSTOMER_UNREGISTERED" + }, + { + "description": "Indicates that the customer is either not registered or not registered with the current site.", + "id": "script-api:dw/customer/AgentUserStatusCodes#CUSTOMER_UNREGISTERED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.CUSTOMER_UNREGISTERED", + "sections": [ + { + "body": "Indicates that the customer is either not registered or not registered with the current site.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_UNREGISTERED: string", + "source": "script-api", + "tags": [ + "customer_unregistered", + "agentuserstatuscodes.customer_unregistered" + ], + "title": "AgentUserStatusCodes.CUSTOMER_UNREGISTERED" + }, + { + "description": "Indicates that the current connection is not secure (HTTP instead of HTTPS) and the server is configured to require a secure connection.", + "id": "script-api:dw/customer/AgentUserStatusCodes#INSECURE_CONNECTION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSECURE_CONNECTION", + "sections": [ + { + "body": "Indicates that the current connection is not secure (HTTP instead of HTTPS)\nand the server is configured to require a secure connection.", + "heading": "Description" + } + ], + "signature": "static readonly INSECURE_CONNECTION: string", + "source": "script-api", + "tags": [ + "insecure_connection", + "agentuserstatuscodes.insecure_connection" + ], + "title": "AgentUserStatusCodes.INSECURE_CONNECTION" + }, + { + "description": "Indicates that the current connection is not secure (HTTP instead of HTTPS) and the server is configured to require a secure connection.", + "id": "script-api:dw/customer/AgentUserStatusCodes#INSECURE_CONNECTION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSECURE_CONNECTION", + "sections": [ + { + "body": "Indicates that the current connection is not secure (HTTP instead of HTTPS)\nand the server is configured to require a secure connection.", + "heading": "Description" + } + ], + "signature": "static readonly INSECURE_CONNECTION: string", + "source": "script-api", + "tags": [ + "insecure_connection", + "agentuserstatuscodes.insecure_connection" + ], + "title": "AgentUserStatusCodes.INSECURE_CONNECTION" + }, + { + "description": "Indicates that the given agent user does not have the permission 'Login_Agent' which is required to login to the storefront as an agent user.", + "id": "script-api:dw/customer/AgentUserStatusCodes#INSUFFICIENT_PERMISSION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSUFFICIENT_PERMISSION", + "sections": [ + { + "body": "Indicates that the given agent user does not have the permission\n'Login_Agent' which is required to login to the storefront as an agent\nuser.", + "heading": "Description" + } + ], + "signature": "static readonly INSUFFICIENT_PERMISSION: string", + "source": "script-api", + "tags": [ + "insufficient_permission", + "agentuserstatuscodes.insufficient_permission" + ], + "title": "AgentUserStatusCodes.INSUFFICIENT_PERMISSION" + }, + { + "description": "Indicates that the given agent user does not have the permission 'Login_Agent' which is required to login to the storefront as an agent user.", + "id": "script-api:dw/customer/AgentUserStatusCodes#INSUFFICIENT_PERMISSION", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.INSUFFICIENT_PERMISSION", + "sections": [ + { + "body": "Indicates that the given agent user does not have the permission\n'Login_Agent' which is required to login to the storefront as an agent\nuser.", + "heading": "Description" + } + ], + "signature": "static readonly INSUFFICIENT_PERMISSION: string", + "source": "script-api", + "tags": [ + "insufficient_permission", + "agentuserstatuscodes.insufficient_permission" + ], + "title": "AgentUserStatusCodes.INSUFFICIENT_PERMISSION" + }, + { + "description": "Indicates that the agent user login was successful.", + "id": "script-api:dw/customer/AgentUserStatusCodes#LOGIN_SUCCESSFUL", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.LOGIN_SUCCESSFUL", + "sections": [ + { + "body": "Indicates that the agent user login was successful.", + "heading": "Description" + } + ], + "signature": "static readonly LOGIN_SUCCESSFUL: string", + "source": "script-api", + "tags": [ + "login_successful", + "agentuserstatuscodes.login_successful" + ], + "title": "AgentUserStatusCodes.LOGIN_SUCCESSFUL" + }, + { + "description": "Indicates that the agent user login was successful.", + "id": "script-api:dw/customer/AgentUserStatusCodes#LOGIN_SUCCESSFUL", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.LOGIN_SUCCESSFUL", + "sections": [ + { + "body": "Indicates that the agent user login was successful.", + "heading": "Description" + } + ], + "signature": "static readonly LOGIN_SUCCESSFUL: string", + "source": "script-api", + "tags": [ + "login_successful", + "agentuserstatuscodes.login_successful" + ], + "title": "AgentUserStatusCodes.LOGIN_SUCCESSFUL" + }, + { + "description": "Indicates that the current context is not a storefront request.", + "id": "script-api:dw/customer/AgentUserStatusCodes#NO_STOREFRONT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.NO_STOREFRONT", + "sections": [ + { + "body": "Indicates that the current context is not a storefront request.", + "heading": "Description" + } + ], + "signature": "static readonly NO_STOREFRONT: string", + "source": "script-api", + "tags": [ + "no_storefront", + "agentuserstatuscodes.no_storefront" + ], + "title": "AgentUserStatusCodes.NO_STOREFRONT" + }, + { + "description": "Indicates that the current context is not a storefront request.", + "id": "script-api:dw/customer/AgentUserStatusCodes#NO_STOREFRONT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.NO_STOREFRONT", + "sections": [ + { + "body": "Indicates that the current context is not a storefront request.", + "heading": "Description" + } + ], + "signature": "static readonly NO_STOREFRONT: string", + "source": "script-api", + "tags": [ + "no_storefront", + "agentuserstatuscodes.no_storefront" + ], + "title": "AgentUserStatusCodes.NO_STOREFRONT" + }, + { + "description": "Indicates that the given agent user password has expired and needs to be changed in the Business Manager.", + "id": "script-api:dw/customer/AgentUserStatusCodes#PASSWORD_EXPIRED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.PASSWORD_EXPIRED", + "sections": [ + { + "body": "Indicates that the given agent user password has expired and needs to be\nchanged in the Business Manager.", + "heading": "Description" + } + ], + "signature": "static readonly PASSWORD_EXPIRED: string", + "source": "script-api", + "tags": [ + "password_expired", + "agentuserstatuscodes.password_expired" + ], + "title": "AgentUserStatusCodes.PASSWORD_EXPIRED" + }, + { + "description": "Indicates that the given agent user password has expired and needs to be changed in the Business Manager.", + "id": "script-api:dw/customer/AgentUserStatusCodes#PASSWORD_EXPIRED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.PASSWORD_EXPIRED", + "sections": [ + { + "body": "Indicates that the given agent user password has expired and needs to be\nchanged in the Business Manager.", + "heading": "Description" + } + ], + "signature": "static readonly PASSWORD_EXPIRED: string", + "source": "script-api", + "tags": [ + "password_expired", + "agentuserstatuscodes.password_expired" + ], + "title": "AgentUserStatusCodes.PASSWORD_EXPIRED" + }, + { + "description": "Indicates that the agent user account has been disabled in the Business Manager.", + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_DISABLED", + "sections": [ + { + "body": "Indicates that the agent user account has been disabled in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static readonly USER_DISABLED: string", + "source": "script-api", + "tags": [ + "user_disabled", + "agentuserstatuscodes.user_disabled" + ], + "title": "AgentUserStatusCodes.USER_DISABLED" + }, + { + "description": "Indicates that the agent user account has been disabled in the Business Manager.", + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_DISABLED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_DISABLED", + "sections": [ + { + "body": "Indicates that the agent user account has been disabled in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static readonly USER_DISABLED: string", + "source": "script-api", + "tags": [ + "user_disabled", + "agentuserstatuscodes.user_disabled" + ], + "title": "AgentUserStatusCodes.USER_DISABLED" + }, + { + "description": "Indicates that the agent user account is locked, because the maximum number of failed login attempts was exceeded.", + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_LOCKED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_LOCKED", + "sections": [ + { + "body": "Indicates that the agent user account is locked, because the maximum\nnumber of failed login attempts was exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly USER_LOCKED: string", + "source": "script-api", + "tags": [ + "user_locked", + "agentuserstatuscodes.user_locked" + ], + "title": "AgentUserStatusCodes.USER_LOCKED" + }, + { + "description": "Indicates that the agent user account is locked, because the maximum number of failed login attempts was exceeded.", + "id": "script-api:dw/customer/AgentUserStatusCodes#USER_LOCKED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AgentUserStatusCodes", + "qualifiedName": "dw.customer.AgentUserStatusCodes.USER_LOCKED", + "sections": [ + { + "body": "Indicates that the agent user account is locked, because the maximum\nnumber of failed login attempts was exceeded.", + "heading": "Description" + } + ], + "signature": "static readonly USER_LOCKED: string", + "source": "script-api", + "tags": [ + "user_locked", + "agentuserstatuscodes.user_locked" + ], + "title": "AgentUserStatusCodes.USER_LOCKED" + }, + { + "description": "Holds the status of an authentication process.", + "id": "script-api:dw/customer/AuthenticationStatus", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.AuthenticationStatus", + "sections": [ + { + "body": "Holds the status of an authentication process.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "authenticationstatus", + "dw.customer.authenticationstatus", + "dw/customer" + ], + "title": "AuthenticationStatus" + }, + { + "description": "Authentication was successful", + "id": "script-api:dw/customer/AuthenticationStatus#AUTH_OK", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.AUTH_OK", + "sections": [ + { + "body": "Authentication was successful", + "heading": "Description" + } + ], + "signature": "static readonly AUTH_OK = \"AUTH_OK\"", + "source": "script-api", + "tags": [ + "auth_ok", + "authenticationstatus.auth_ok" + ], + "title": "AuthenticationStatus.AUTH_OK" + }, + { + "description": "Authentication was successful", + "id": "script-api:dw/customer/AuthenticationStatus#AUTH_OK", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.AUTH_OK", + "sections": [ + { + "body": "Authentication was successful", + "heading": "Description" + } + ], + "signature": "static readonly AUTH_OK = \"AUTH_OK\"", + "source": "script-api", + "tags": [ + "auth_ok", + "authenticationstatus.auth_ok" + ], + "title": "AuthenticationStatus.AUTH_OK" + }, + { + "description": "customer could be found, but is disabled. Password was not verified.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_DISABLED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_DISABLED", + "sections": [ + { + "body": "customer could be found, but is disabled. Password was not verified.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_DISABLED = \"ERROR_CUSTOMER_DISABLED\"", + "source": "script-api", + "tags": [ + "error_customer_disabled", + "authenticationstatus.error_customer_disabled" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_DISABLED" + }, + { + "description": "customer could be found, but is disabled. Password was not verified.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_DISABLED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_DISABLED", + "sections": [ + { + "body": "customer could be found, but is disabled. Password was not verified.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_DISABLED = \"ERROR_CUSTOMER_DISABLED\"", + "source": "script-api", + "tags": [ + "error_customer_disabled", + "authenticationstatus.error_customer_disabled" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_DISABLED" + }, + { + "description": "customer could be found, but is locked (too many failed login attempts). Password was verified before.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_LOCKED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_LOCKED", + "sections": [ + { + "body": "customer could be found, but is locked (too many failed login attempts). Password was verified before.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_LOCKED = \"ERROR_CUSTOMER_LOCKED\"", + "source": "script-api", + "tags": [ + "error_customer_locked", + "authenticationstatus.error_customer_locked" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_LOCKED" + }, + { + "description": "customer could be found, but is locked (too many failed login attempts). Password was verified before.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_LOCKED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_LOCKED", + "sections": [ + { + "body": "customer could be found, but is locked (too many failed login attempts). Password was verified before.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_LOCKED = \"ERROR_CUSTOMER_LOCKED\"", + "source": "script-api", + "tags": [ + "error_customer_locked", + "authenticationstatus.error_customer_locked" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_LOCKED" + }, + { + "description": "customer could not be found", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND", + "sections": [ + { + "body": "customer could not be found", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_NOT_FOUND = \"ERROR_CUSTOMER_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "error_customer_not_found", + "authenticationstatus.error_customer_not_found" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND" + }, + { + "description": "customer could not be found", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_CUSTOMER_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND", + "sections": [ + { + "body": "customer could not be found", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_CUSTOMER_NOT_FOUND = \"ERROR_CUSTOMER_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "error_customer_not_found", + "authenticationstatus.error_customer_not_found" + ], + "title": "AuthenticationStatus.ERROR_CUSTOMER_NOT_FOUND" + }, + { + "description": "Password does match, but is expired.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_EXPIRED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_EXPIRED", + "sections": [ + { + "body": "Password does match, but is expired.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_PASSWORD_EXPIRED = \"ERROR_PASSWORD_EXPIRED\"", + "source": "script-api", + "tags": [ + "error_password_expired", + "authenticationstatus.error_password_expired" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_EXPIRED" + }, + { + "description": "Password does match, but is expired.", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_EXPIRED", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_EXPIRED", + "sections": [ + { + "body": "Password does match, but is expired.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_PASSWORD_EXPIRED = \"ERROR_PASSWORD_EXPIRED\"", + "source": "script-api", + "tags": [ + "error_password_expired", + "authenticationstatus.error_password_expired" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_EXPIRED" + }, + { + "description": "the used password is not correct", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_MISMATCH", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_MISMATCH", + "sections": [ + { + "body": "the used password is not correct", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_PASSWORD_MISMATCH = \"ERROR_PASSWORD_MISMATCH\"", + "source": "script-api", + "tags": [ + "error_password_mismatch", + "authenticationstatus.error_password_mismatch" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_MISMATCH" + }, + { + "description": "the used password is not correct", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_PASSWORD_MISMATCH", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_PASSWORD_MISMATCH", + "sections": [ + { + "body": "the used password is not correct", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_PASSWORD_MISMATCH = \"ERROR_PASSWORD_MISMATCH\"", + "source": "script-api", + "tags": [ + "error_password_mismatch", + "authenticationstatus.error_password_mismatch" + ], + "title": "AuthenticationStatus.ERROR_PASSWORD_MISMATCH" + }, + { + "description": "Any other error", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_UNKNOWN", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_UNKNOWN", + "sections": [ + { + "body": "Any other error", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_UNKNOWN = \"ERROR_UNKNOWN\"", + "source": "script-api", + "tags": [ + "error_unknown", + "authenticationstatus.error_unknown" + ], + "title": "AuthenticationStatus.ERROR_UNKNOWN" + }, + { + "description": "Any other error", + "id": "script-api:dw/customer/AuthenticationStatus#ERROR_UNKNOWN", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.ERROR_UNKNOWN", + "sections": [ + { + "body": "Any other error", + "heading": "Description" + } + ], + "signature": "static readonly ERROR_UNKNOWN = \"ERROR_UNKNOWN\"", + "source": "script-api", + "tags": [ + "error_unknown", + "authenticationstatus.error_unknown" + ], + "title": "AuthenticationStatus.ERROR_UNKNOWN" + }, + { + "description": "checks whether the authentication was successful or not", + "id": "script-api:dw/customer/AuthenticationStatus#authenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.authenticated", + "sections": [ + { + "body": "checks whether the authentication was successful or not", + "heading": "Description" + } + ], + "signature": "readonly authenticated: boolean", + "source": "script-api", + "tags": [ + "authenticated", + "authenticationstatus.authenticated" + ], + "title": "AuthenticationStatus.authenticated" + }, + { + "description": "The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.", + "id": "script-api:dw/customer/AuthenticationStatus#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.customer", + "sections": [ + { + "body": "The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.", + "heading": "Description" + } + ], + "signature": "readonly customer: Customer", + "source": "script-api", + "tags": [ + "customer", + "authenticationstatus.customer" + ], + "title": "AuthenticationStatus.customer" + }, + { + "description": "The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.", + "id": "script-api:dw/customer/AuthenticationStatus#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.getCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.", + "heading": "Description" + } + ], + "signature": "getCustomer(): Customer", + "source": "script-api", + "tags": [ + "getcustomer", + "authenticationstatus.getcustomer" + ], + "title": "AuthenticationStatus.getCustomer" + }, + { + "description": "the status code (see the constants above)", + "id": "script-api:dw/customer/AuthenticationStatus#getStatus", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.getStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "the status code (see the constants above)", + "heading": "Description" + } + ], + "signature": "getStatus(): string", + "source": "script-api", + "tags": [ + "getstatus", + "authenticationstatus.getstatus" + ], + "title": "AuthenticationStatus.getStatus" + }, + { + "description": "checks whether the authentication was successful or not", + "id": "script-api:dw/customer/AuthenticationStatus#isAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.isAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "checks whether the authentication was successful or not", + "heading": "Description" + } + ], + "signature": "isAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "isauthenticated", + "authenticationstatus.isauthenticated" + ], + "title": "AuthenticationStatus.isAuthenticated" + }, + { + "description": "the status code (see the constants above)", + "id": "script-api:dw/customer/AuthenticationStatus#status", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/AuthenticationStatus", + "qualifiedName": "dw.customer.AuthenticationStatus.status", + "sections": [ + { + "body": "the status code (see the constants above)", + "heading": "Description" + } + ], + "signature": "readonly status: string", + "source": "script-api", + "tags": [ + "status", + "authenticationstatus.status" + ], + "title": "AuthenticationStatus.status" + }, + { + "description": "Represents the credentials of a customer.", + "id": "script-api:dw/customer/Credentials", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Credentials", + "sections": [ + { + "body": "Represents the credentials of a customer.\n\nSince 13.6 it is possible to have customers who are not authenticated through a\nlogin and password but through an external authentication provider via the OAuth2 protocol.\n\nIn such cases, the AuthenticationProviderID will point to an OAuth provider configured in the system\nand the ExternalID will be the unique identifier of the customer on the Authentication Provider's system.\n\nFor example, if an authentication provider with ID \"Google123\" is configured pointing to Google\nand the customer has a logged in into Google in the past and has created a profile there, Google\nassigns a unique number identifier to that customer. If the storefront is configured to allow\nauthentication through Google and a new customer logs into the storefront using Google,\nthe AuthenticationProviderID property of his Credentials will contain \"Google123\" and\nthe ExternalID property will contain whatever unique identifier Google has assigned to him.\nIn such cases the password-related properties of the Credentials will be empty.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "credentials", + "dw.customer.credentials", + "dw/customer" + ], + "title": "Credentials" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will get the Authentication Provider from\nthe first element of the Customer.getExternalProfiles collection" + }, + "description": "Returns the authentication provider ID.", + "id": "script-api:dw/customer/Credentials#authenticationProviderID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.authenticationProviderID", + "sections": [ + { + "body": "Returns the authentication provider ID.", + "heading": "Description" + } + ], + "signature": "authenticationProviderID: string", + "source": "script-api", + "tags": [ + "authenticationproviderid", + "credentials.authenticationproviderid" + ], + "title": "Credentials.authenticationProviderID" + }, + { + "description": "Generate a random token which can be used for resetting the password of the underlying Customer. The token is guaranteed to be unique and will be valid for 30 minutes. Any token previously generated for this customer will be invalidated.", + "id": "script-api:dw/customer/Credentials#createResetPasswordToken", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.createResetPasswordToken", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Generate a random token which can be used for resetting the password of the underlying Customer. The token is\nguaranteed to be unique and will be valid for 30 minutes. Any token previously generated for this customer will\nbe invalidated.", + "heading": "Description" + } + ], + "signature": "createResetPasswordToken(): string", + "source": "script-api", + "tags": [ + "createresetpasswordtoken", + "credentials.createresetpasswordtoken" + ], + "title": "Credentials.createResetPasswordToken" + }, + { + "description": "Identifies if this customer is enabled and can log in.", + "id": "script-api:dw/customer/Credentials#enabled", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.enabled", + "sections": [ + { + "body": "Identifies if this customer is enabled and can log in.", + "heading": "Description" + } + ], + "signature": "readonly enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "credentials.enabled" + ], + "title": "Credentials.enabled" + }, + { + "description": "Identifies if this customer is enabled and can log in - same as isEnabled().", + "id": "script-api:dw/customer/Credentials#enabledFlag", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.enabledFlag", + "sections": [ + { + "body": "Identifies if this customer is enabled and can log in - same as isEnabled().", + "heading": "Description" + } + ], + "signature": "enabledFlag: boolean", + "source": "script-api", + "tags": [ + "enabledflag", + "credentials.enabledflag" + ], + "title": "Credentials.enabledFlag" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will get the External ID from\nthe first element of the Customer.getExternalProfiles collection" + }, + "description": "Returns the external ID of the customer.", + "id": "script-api:dw/customer/Credentials#externalID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.externalID", + "sections": [ + { + "body": "Returns the external ID of the customer.", + "heading": "Description" + } + ], + "signature": "externalID: string", + "source": "script-api", + "tags": [ + "externalid", + "credentials.externalid" + ], + "title": "Credentials.externalID" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will get the Authentication Provider from\nthe first element of the Customer.getExternalProfiles collection" + }, + "description": "Returns the authentication provider ID.", + "id": "script-api:dw/customer/Credentials#getAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getAuthenticationProviderID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the authentication provider ID.", + "heading": "Description" + } + ], + "signature": "getAuthenticationProviderID(): string", + "source": "script-api", + "tags": [ + "getauthenticationproviderid", + "credentials.getauthenticationproviderid" + ], + "title": "Credentials.getAuthenticationProviderID" + }, + { + "description": "Identifies if this customer is enabled and can log in - same as isEnabled().", + "id": "script-api:dw/customer/Credentials#getEnabledFlag", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getEnabledFlag", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this customer is enabled and can log in - same as isEnabled().", + "heading": "Description" + } + ], + "signature": "getEnabledFlag(): boolean", + "source": "script-api", + "tags": [ + "getenabledflag", + "credentials.getenabledflag" + ], + "title": "Credentials.getEnabledFlag" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will get the External ID from\nthe first element of the Customer.getExternalProfiles collection" + }, + "description": "Returns the external ID of the customer.", + "id": "script-api:dw/customer/Credentials#getExternalID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getExternalID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the external ID of the customer.", + "heading": "Description" + } + ], + "signature": "getExternalID(): string", + "source": "script-api", + "tags": [ + "getexternalid", + "credentials.getexternalid" + ], + "title": "Credentials.getExternalID" + }, + { + "description": "Returns the login of the user. It must be unique.", + "id": "script-api:dw/customer/Credentials#getLogin", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getLogin", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the login of the user. It must be unique.", + "heading": "Description" + } + ], + "signature": "getLogin(): string", + "source": "script-api", + "tags": [ + "getlogin", + "credentials.getlogin" + ], + "title": "Credentials.getLogin" + }, + { + "description": "Returns the answer to the password question for the customer. The answer is used with the password question to confirm the identity of a customer when they are trying to fetch their password.", + "id": "script-api:dw/customer/Credentials#getPasswordAnswer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getPasswordAnswer", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the answer to the password question for the customer. The answer is used\nwith the password question to confirm the identity of a customer when\nthey are trying to fetch their password.", + "heading": "Description" + } + ], + "signature": "getPasswordAnswer(): string", + "source": "script-api", + "tags": [ + "getpasswordanswer", + "credentials.getpasswordanswer" + ], + "title": "Credentials.getPasswordAnswer" + }, + { + "description": "Returns the password question for the customer. The password question is used with the password answer to confirm the identity of a customer when they are trying to fetch their password.", + "id": "script-api:dw/customer/Credentials#getPasswordQuestion", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getPasswordQuestion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the password question for the customer. The password question is\nused with the password answer to confirm the identity of a customer when\nthey are trying to fetch their password.", + "heading": "Description" + } + ], + "signature": "getPasswordQuestion(): string", + "source": "script-api", + "tags": [ + "getpasswordquestion", + "credentials.getpasswordquestion" + ], + "title": "Credentials.getPasswordQuestion" + }, + { + "description": "Returns the number of consecutive failed logins after which this customer will be temporarily locked out and prevented from logging in to the current site. This value is based on the number of previous invalid logins for this customer and customer site preferences defining the limits.", + "id": "script-api:dw/customer/Credentials#getRemainingLoginAttempts", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.getRemainingLoginAttempts", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of consecutive failed logins after which this customer\nwill be temporarily locked out and prevented from logging in to the\ncurrent site. This value is based on the number of previous invalid\nlogins for this customer and customer site preferences defining the\nlimits.\n\nIf this customer is already locked out, this method will always return 0.\nIf customer locking is disabled altogether, or if the system cannot\ndetermine the number of failed login attempts for this customer, then\nthis method will return a negative number.", + "heading": "Description" + } + ], + "signature": "getRemainingLoginAttempts(): number", + "source": "script-api", + "tags": [ + "getremainingloginattempts", + "credentials.getremainingloginattempts" + ], + "title": "Credentials.getRemainingLoginAttempts" + }, + { + "description": "Identifies if this customer is enabled and can log in.", + "id": "script-api:dw/customer/Credentials#isEnabled", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this customer is enabled and can log in.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "credentials.isenabled" + ], + "title": "Credentials.isEnabled" + }, + { + "description": "Identifies if this customer is temporarily locked out because of invalid login attempts. If customer locking is not enabled, this method always returns false.", + "id": "script-api:dw/customer/Credentials#isLocked", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isLocked", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this customer is temporarily locked out because of invalid\nlogin attempts. If customer locking is not enabled, this method always\nreturns false.", + "heading": "Description" + } + ], + "signature": "isLocked(): boolean", + "source": "script-api", + "tags": [ + "islocked", + "credentials.islocked" + ], + "title": "Credentials.isLocked" + }, + { + "description": "Returns whether the password is set. Creating externally authenticated customers results in customers with credentials for which the password is not set.", + "id": "script-api:dw/customer/Credentials#isPasswordSet", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.isPasswordSet", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the password is set. Creating externally authenticated customers\nresults in customers with credentials for which the password is not set.", + "heading": "Description" + } + ], + "signature": "isPasswordSet(): boolean", + "source": "script-api", + "tags": [ + "ispasswordset", + "credentials.ispasswordset" + ], + "title": "Credentials.isPasswordSet" + }, + { + "description": "Identifies if this customer is temporarily locked out because of invalid login attempts. If customer locking is not enabled, this method always returns false.", + "id": "script-api:dw/customer/Credentials#locked", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.locked", + "sections": [ + { + "body": "Identifies if this customer is temporarily locked out because of invalid\nlogin attempts. If customer locking is not enabled, this method always\nreturns false.", + "heading": "Description" + } + ], + "signature": "readonly locked: boolean", + "source": "script-api", + "tags": [ + "locked", + "credentials.locked" + ], + "title": "Credentials.locked" + }, + { + "description": "Returns the login of the user. It must be unique.", + "id": "script-api:dw/customer/Credentials#login", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.login", + "sections": [ + { + "body": "Returns the login of the user. It must be unique.", + "heading": "Description" + } + ], + "signature": "login: string", + "source": "script-api", + "tags": [ + "login", + "credentials.login" + ], + "title": "Credentials.login" + }, + { + "description": "Returns the answer to the password question for the customer. The answer is used with the password question to confirm the identity of a customer when they are trying to fetch their password.", + "id": "script-api:dw/customer/Credentials#passwordAnswer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordAnswer", + "sections": [ + { + "body": "Returns the answer to the password question for the customer. The answer is used\nwith the password question to confirm the identity of a customer when\nthey are trying to fetch their password.", + "heading": "Description" + } + ], + "signature": "passwordAnswer: string", + "source": "script-api", + "tags": [ + "passwordanswer", + "credentials.passwordanswer" + ], + "title": "Credentials.passwordAnswer" + }, + { + "description": "Returns the password question for the customer. The password question is used with the password answer to confirm the identity of a customer when they are trying to fetch their password.", + "id": "script-api:dw/customer/Credentials#passwordQuestion", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordQuestion", + "sections": [ + { + "body": "Returns the password question for the customer. The password question is\nused with the password answer to confirm the identity of a customer when\nthey are trying to fetch their password.", + "heading": "Description" + } + ], + "signature": "passwordQuestion: string", + "source": "script-api", + "tags": [ + "passwordquestion", + "credentials.passwordquestion" + ], + "title": "Credentials.passwordQuestion" + }, + { + "description": "Returns whether the password is set. Creating externally authenticated customers results in customers with credentials for which the password is not set.", + "id": "script-api:dw/customer/Credentials#passwordSet", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.passwordSet", + "sections": [ + { + "body": "Returns whether the password is set. Creating externally authenticated customers\nresults in customers with credentials for which the password is not set.", + "heading": "Description" + } + ], + "signature": "readonly passwordSet: boolean", + "source": "script-api", + "tags": [ + "passwordset", + "credentials.passwordset" + ], + "title": "Credentials.passwordSet" + }, + { + "description": "Returns the number of consecutive failed logins after which this customer will be temporarily locked out and prevented from logging in to the current site. This value is based on the number of previous invalid logins for this customer and customer site preferences defining the limits.", + "id": "script-api:dw/customer/Credentials#remainingLoginAttempts", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.remainingLoginAttempts", + "sections": [ + { + "body": "Returns the number of consecutive failed logins after which this customer\nwill be temporarily locked out and prevented from logging in to the\ncurrent site. This value is based on the number of previous invalid\nlogins for this customer and customer site preferences defining the\nlimits.\n\nIf this customer is already locked out, this method will always return 0.\nIf customer locking is disabled altogether, or if the system cannot\ndetermine the number of failed login attempts for this customer, then\nthis method will return a negative number.", + "heading": "Description" + } + ], + "signature": "readonly remainingLoginAttempts: number", + "source": "script-api", + "tags": [ + "remainingloginattempts", + "credentials.remainingloginattempts" + ], + "title": "Credentials.remainingLoginAttempts" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will set the Authentication Provider on\nthe first element of the Customer.getExternalProfiles collection if there is only one.\nIt will create the collection and add an element if no elements are present.\nIt will not change anything and will log an error if there are more than one elements in the collection." + }, + "description": "Sets the authentication provider ID corresponding to an OAuth provider configured in the system.", + "id": "script-api:dw/customer/Credentials#setAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setAuthenticationProviderID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the authentication provider ID corresponding to an OAuth provider configured in the system.", + "heading": "Description" + } + ], + "signature": "setAuthenticationProviderID(authenticationProviderID: string): void", + "source": "script-api", + "tags": [ + "setauthenticationproviderid", + "credentials.setauthenticationproviderid" + ], + "title": "Credentials.setAuthenticationProviderID" + }, + { + "description": "Sets the enabled status of the customer.", + "id": "script-api:dw/customer/Credentials#setEnabledFlag", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "enabledFlag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setEnabledFlag", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the enabled status of the customer.", + "heading": "Description" + } + ], + "signature": "setEnabledFlag(enabledFlag: boolean): void", + "source": "script-api", + "tags": [ + "setenabledflag", + "credentials.setenabledflag" + ], + "title": "Credentials.setEnabledFlag" + }, + { + "deprecated": { + "message": "As of release 17.2, replaced by methods on the new class ExternalProfile\nwhich can be obtained from Customer.getExternalProfiles\n\nUntil the method is fully removed from the API it will set the ExternalID on\nthe first element of the Customer.getExternalProfiles collection if there is only one.\nIt will create the collection and add an element if no elements are present.\nIt will not change anything and will log an error if there are more than one elements in the collection." + }, + "description": "Sets the external ID of the customer at the authentication provider. The value is provided by the authentication provider during the OAuth authentication and is unique within that provider.", + "id": "script-api:dw/customer/Credentials#setExternalID", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "externalID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setExternalID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the external ID of the customer at the authentication provider.\nThe value is provided by the authentication provider during the\nOAuth authentication and is unique within that provider.", + "heading": "Description" + } + ], + "signature": "setExternalID(externalID: string): void", + "source": "script-api", + "tags": [ + "setexternalid", + "credentials.setexternalid" + ], + "title": "Credentials.setExternalID" + }, + { + "deprecated": { + "message": "Use Credentials.setLogin" + }, + "description": "Sets the login value for the customer.", + "id": "script-api:dw/customer/Credentials#setLogin", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setLogin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the login value for the customer.\n\nIMPORTANT: This method should no longer be used for the following\nreasons:\n\n- It changes the login without re-encrypting the password. (The\ncustomer password is stored internally using a one-way encryption scheme\nwhich uses the login as one of its inputs. Therefore changing the login\nrequires re-encrypting the password.)\n- It does not validate the structure of the login to ensure that it\nonly uses acceptable characters.\n- It does not correctly prevent duplicate logins. If the passed login\nmatches a different customer's login exactly, then this method will throw\nan exception. However, it does not prevent the creation of inexact matches,\nwhere two customers have a login differing only by alphabetic case (e.g.\n\"JaneDoe\" and \"janedoe\")", + "heading": "Description" + } + ], + "signature": "setLogin(login: string): void", + "source": "script-api", + "tags": [ + "setlogin", + "credentials.setlogin" + ], + "title": "Credentials.setLogin" + }, + { + "description": "Sets the login value for the customer, and also re-encrypt the customer password based on the new login. Customer login must be a sequence of letters, numbers, and the following characters: space, period, ampersand, underscore and dash.", + "id": "script-api:dw/customer/Credentials#setLogin", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "newLogin", + "type": "string" + }, + { + "name": "currentPassword", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setLogin", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Sets the login value for the customer, and also re-encrypt the customer\npassword based on the new login. Customer login must be a sequence of\nletters, numbers, and the following characters: space, period, ampersand,\nunderscore and dash.\n\nThis method fails to set the login and returns false in the following\ncases:\n\n- newLogin is of an invalid form (e.g. contains invalid characters).\n- currentPassword is not the customer's correct password.\n- newLogin is already in use by another customer (i.e. there is another\ncustomer in the system with the exact same login name or a name differing\nonly by alphabetic case.)\n\nIf newLogin is the same as the existing login, the method does nothing and\nreturns true, regardless of whether currentPassword is the correct\npassword.", + "heading": "Description" + } + ], + "signature": "setLogin(newLogin: string, currentPassword: string): boolean", + "source": "script-api", + "tags": [ + "setlogin", + "credentials.setlogin" + ], + "title": "Credentials.setLogin" + }, + { + "description": "Sets the password of an authenticated customer.", + "id": "script-api:dw/customer/Credentials#setPassword", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "newPassword", + "type": "string" + }, + { + "name": "oldPassword", + "type": "string" + }, + { + "name": "verifyOldPassword", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPassword", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Sets the password of an authenticated customer.\n\nThe method can be called for externally authenticated customers as well but\nthese customers will still be externally authenticated so calling the method\nfor such customers does not have an immediate practical benefit. If such customers\nare converted back to regularly authenticated (via login and password) the new password\nwill be used.\n\nMethod call will fail under any of these conditions:\n\n- customer is not registered\n- customer is not authenticated\n- verifyOldPassword=true && oldPassword is empty\n- verifyOldPassword=true and oldPassword does not match the existing password\n- newPassword is empty\n- newPassword does not meet acceptance criteria", + "heading": "Description" + } + ], + "signature": "setPassword(newPassword: string, oldPassword: string, verifyOldPassword: boolean): Status", + "source": "script-api", + "tags": [ + "setpassword", + "credentials.setpassword" + ], + "title": "Credentials.setPassword" + }, + { + "description": "Sets the answer to the password question for the customer.", + "id": "script-api:dw/customer/Credentials#setPasswordAnswer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "answer", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordAnswer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the answer to the password question for the customer.", + "heading": "Description" + } + ], + "signature": "setPasswordAnswer(answer: string): void", + "source": "script-api", + "tags": [ + "setpasswordanswer", + "credentials.setpasswordanswer" + ], + "title": "Credentials.setPasswordAnswer" + }, + { + "description": "Sets the password question for the customer.", + "id": "script-api:dw/customer/Credentials#setPasswordQuestion", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "question", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordQuestion", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the password question for the customer.", + "heading": "Description" + } + ], + "signature": "setPasswordQuestion(question: string): void", + "source": "script-api", + "tags": [ + "setpasswordquestion", + "credentials.setpasswordquestion" + ], + "title": "Credentials.setPasswordQuestion" + }, + { + "description": "Set the password of the specified customer to the specified value. This operation will fail if the specified token is invalid (i.e. not associated with the specified Customer), the token is expired, or the password does not satisfy system password requirements.", + "id": "script-api:dw/customer/Credentials#setPasswordWithToken", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "token", + "type": "string" + }, + { + "name": "newPassword", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Credentials", + "qualifiedName": "dw.customer.Credentials.setPasswordWithToken", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Set the password of the specified customer to the specified value. This operation will fail if the specified\ntoken is invalid (i.e. not associated with the specified Customer), the token is expired, or the password does\nnot satisfy system password requirements.", + "heading": "Description" + } + ], + "signature": "setPasswordWithToken(token: string, newPassword: string): Status", + "source": "script-api", + "tags": [ + "setpasswordwithtoken", + "credentials.setpasswordwithtoken" + ], + "title": "Credentials.setPasswordWithToken" + }, + { + "description": "Represents a customer.", + "id": "script-api:dw/customer/Customer", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Customer", + "sections": [ + { + "body": "Represents a customer.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customer", + "dw.customer.customer", + "dw/customer" + ], + "title": "Customer" + }, + { + "description": "Returns the Salesforce CDP (Customer Data Platform) data for this customer.", + "id": "script-api:dw/customer/Customer#CDPData", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.CDPData", + "sections": [ + { + "body": "Returns the Salesforce CDP (Customer Data Platform) data for this customer.", + "heading": "Description" + } + ], + "signature": "readonly CDPData: CustomerCDPData", + "source": "script-api", + "tags": [ + "cdpdata", + "customer.cdpdata" + ], + "title": "Customer.CDPData" + }, + { + "description": "Returns the unique, system generated ID of the customer.", + "id": "script-api:dw/customer/Customer#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.ID", + "sections": [ + { + "body": "Returns the unique, system generated ID of the customer.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "customer.id" + ], + "title": "Customer.ID" + }, + { + "description": "Returns the active data for this customer.", + "id": "script-api:dw/customer/Customer#activeData", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.activeData", + "sections": [ + { + "body": "Returns the active data for this customer.", + "heading": "Description" + } + ], + "signature": "readonly activeData: CustomerActiveData", + "source": "script-api", + "tags": [ + "activedata", + "customer.activedata" + ], + "title": "Customer.activeData" + }, + { + "description": "Returns the address book for the profile of this customer, or `null` if this customer has no profile, such as for an anonymous customer.", + "id": "script-api:dw/customer/Customer#addressBook", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.addressBook", + "sections": [ + { + "body": "Returns the address book for the profile of this customer,\nor `null` if this customer has no profile, such as for an\nanonymous customer.", + "heading": "Description" + } + ], + "signature": "readonly addressBook: AddressBook | null", + "source": "script-api", + "tags": [ + "addressbook", + "customer.addressbook" + ], + "title": "Customer.addressBook" + }, + { + "description": "Identifies if the customer is anonymous. An anonymous customer is the opposite of a registered customer.", + "id": "script-api:dw/customer/Customer#anonymous", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.anonymous", + "sections": [ + { + "body": "Identifies if the customer is anonymous. An anonymous\ncustomer is the opposite of a registered customer.", + "heading": "Description" + } + ], + "signature": "readonly anonymous: boolean", + "source": "script-api", + "tags": [ + "anonymous", + "customer.anonymous" + ], + "title": "Customer.anonymous" + }, + { + "description": "Identifies if the customer is authenticated. This method checks whether this customer is the customer associated with the session and than checks whether the session in an authenticated state.", + "id": "script-api:dw/customer/Customer#authenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.authenticated", + "sections": [ + { + "body": "Identifies if the customer is authenticated. This method checks whether\nthis customer is the customer associated with the session and than checks\nwhether the session in an authenticated state.\n\nNote: The pipeline debugger will always show 'false' for this value\nregardless of whether the customer is authenticated or not.", + "heading": "Description" + } + ], + "signature": "readonly authenticated: boolean", + "source": "script-api", + "tags": [ + "authenticated", + "customer.authenticated" + ], + "title": "Customer.authenticated" + }, + { + "description": "Creates an externalProfile and attaches it to the list of external profiles for the customer", + "id": "script-api:dw/customer/Customer#createExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.createExternalProfile", + "returns": { + "type": "ExternalProfile" + }, + "sections": [ + { + "body": "Creates an externalProfile and attaches it to the list of external profiles for the customer", + "heading": "Description" + } + ], + "signature": "createExternalProfile(authenticationProviderId: string, externalId: string): ExternalProfile", + "source": "script-api", + "tags": [ + "createexternalprofile", + "customer.createexternalprofile" + ], + "title": "Customer.createExternalProfile" + }, + { + "description": "Returns the customer groups this customer is member of.", + "id": "script-api:dw/customer/Customer#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.customerGroups", + "sections": [ + { + "body": "Returns the customer groups this customer is member of.\n\n- Result contains static customer groups in storefront and job session\n- Result contains dynamic customer groups in storefront and job session.\nDynamic customer groups referring session or request data are not available\nwhen processing the customer in a job session, or when this customer is not the customer assigned to the current session.\n\n- Result contains system groups 'Everyone', 'Unregistered', 'Registered' for all customers in storefront and job sessions", + "heading": "Description" + } + ], + "signature": "readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "customer.customergroups" + ], + "title": "Customer.customerGroups" + }, + { + "description": "Returns a collection of any external profiles the customer may have", + "id": "script-api:dw/customer/Customer#externalProfiles", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.externalProfiles", + "sections": [ + { + "body": "Returns a collection of any external profiles the customer may have", + "heading": "Description" + } + ], + "signature": "readonly externalProfiles: Collection", + "source": "script-api", + "tags": [ + "externalprofiles", + "customer.externalprofiles" + ], + "title": "Customer.externalProfiles" + }, + { + "description": "Identifies if the customer is externally authenticated. An externally authenticated customer does not have the password stored in our system but logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)", + "id": "script-api:dw/customer/Customer#externallyAuthenticated", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.externallyAuthenticated", + "sections": [ + { + "body": "Identifies if the customer is externally authenticated. An externally\nauthenticated customer does not have the password stored in our system\nbut logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)", + "heading": "Description" + } + ], + "signature": "readonly externallyAuthenticated: boolean", + "source": "script-api", + "tags": [ + "externallyauthenticated", + "customer.externallyauthenticated" + ], + "title": "Customer.externallyAuthenticated" + }, + { + "description": "Returns the active data for this customer.", + "id": "script-api:dw/customer/Customer#getActiveData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getActiveData", + "returns": { + "type": "CustomerActiveData" + }, + "sections": [ + { + "body": "Returns the active data for this customer.", + "heading": "Description" + } + ], + "signature": "getActiveData(): CustomerActiveData", + "source": "script-api", + "tags": [ + "getactivedata", + "customer.getactivedata" + ], + "title": "Customer.getActiveData" + }, + { + "description": "Returns the address book for the profile of this customer, or `null` if this customer has no profile, such as for an anonymous customer.", + "id": "script-api:dw/customer/Customer#getAddressBook", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getAddressBook", + "returns": { + "type": "AddressBook | null" + }, + "sections": [ + { + "body": "Returns the address book for the profile of this customer,\nor `null` if this customer has no profile, such as for an\nanonymous customer.", + "heading": "Description" + } + ], + "signature": "getAddressBook(): AddressBook | null", + "source": "script-api", + "tags": [ + "getaddressbook", + "customer.getaddressbook" + ], + "title": "Customer.getAddressBook" + }, + { + "description": "Returns the Salesforce CDP (Customer Data Platform) data for this customer.", + "id": "script-api:dw/customer/Customer#getCDPData", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getCDPData", + "returns": { + "type": "CustomerCDPData" + }, + "sections": [ + { + "body": "Returns the Salesforce CDP (Customer Data Platform) data for this customer.", + "heading": "Description" + } + ], + "signature": "getCDPData(): CustomerCDPData", + "source": "script-api", + "tags": [ + "getcdpdata", + "customer.getcdpdata" + ], + "title": "Customer.getCDPData" + }, + { + "description": "Returns the customer groups this customer is member of.", + "id": "script-api:dw/customer/Customer#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups this customer is member of.\n\n- Result contains static customer groups in storefront and job session\n- Result contains dynamic customer groups in storefront and job session.\nDynamic customer groups referring session or request data are not available\nwhen processing the customer in a job session, or when this customer is not the customer assigned to the current session.\n\n- Result contains system groups 'Everyone', 'Unregistered', 'Registered' for all customers in storefront and job sessions", + "heading": "Description" + } + ], + "signature": "getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "customer.getcustomergroups" + ], + "title": "Customer.getCustomerGroups" + }, + { + "description": "A convenience method for finding an external profile among the customer's external profiles collection", + "id": "script-api:dw/customer/Customer#getExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getExternalProfile", + "returns": { + "type": "ExternalProfile | null" + }, + "sections": [ + { + "body": "A convenience method for finding an external profile among the customer's external profiles collection", + "heading": "Description" + } + ], + "signature": "getExternalProfile(authenticationProviderId: string, externalId: string): ExternalProfile | null", + "source": "script-api", + "tags": [ + "getexternalprofile", + "customer.getexternalprofile" + ], + "title": "Customer.getExternalProfile" + }, + { + "description": "Returns a collection of any external profiles the customer may have", + "id": "script-api:dw/customer/Customer#getExternalProfiles", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getExternalProfiles", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of any external profiles the customer may have", + "heading": "Description" + } + ], + "signature": "getExternalProfiles(): Collection", + "source": "script-api", + "tags": [ + "getexternalprofiles", + "customer.getexternalprofiles" + ], + "title": "Customer.getExternalProfiles" + }, + { + "description": "Returns the Global Party ID for the customer, if there is one. Global Party ID is created by Customer 360 and identifies a person across multiple systems.", + "id": "script-api:dw/customer/Customer#getGlobalPartyID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getGlobalPartyID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Global Party ID for the customer, if there is one.\nGlobal Party ID is created by Customer 360 and identifies a person across multiple systems.", + "heading": "Description" + } + ], + "signature": "getGlobalPartyID(): string", + "source": "script-api", + "tags": [ + "getglobalpartyid", + "customer.getglobalpartyid" + ], + "title": "Customer.getGlobalPartyID" + }, + { + "description": "Returns the unique, system generated ID of the customer.", + "id": "script-api:dw/customer/Customer#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique, system generated ID of the customer.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "customer.getid" + ], + "title": "Customer.getID" + }, + { + "description": "Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous customer or when note has 0 length.", + "id": "script-api:dw/customer/Customer#getNote", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getNote", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous\ncustomer or when note has 0 length.", + "heading": "Description" + } + ], + "signature": "getNote(): string | null", + "source": "script-api", + "tags": [ + "getnote", + "customer.getnote" + ], + "title": "Customer.getNote" + }, + { + "description": "Returns the customer order history.", + "id": "script-api:dw/customer/Customer#getOrderHistory", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getOrderHistory", + "returns": { + "type": "OrderHistory" + }, + "sections": [ + { + "body": "Returns the customer order history.", + "heading": "Description" + } + ], + "signature": "getOrderHistory(): OrderHistory", + "source": "script-api", + "tags": [ + "getorderhistory", + "customer.getorderhistory" + ], + "title": "Customer.getOrderHistory" + }, + { + "description": "Returns the product lists of the specified type.", + "id": "script-api:dw/customer/Customer#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product lists of the specified type.", + "heading": "Description" + } + ], + "signature": "getProductLists(type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "customer.getproductlists" + ], + "title": "Customer.getProductLists" + }, + { + "description": "Returns the customer profile.", + "id": "script-api:dw/customer/Customer#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.getProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Returns the customer profile.", + "heading": "Description" + } + ], + "signature": "getProfile(): Profile", + "source": "script-api", + "tags": [ + "getprofile", + "customer.getprofile" + ], + "title": "Customer.getProfile" + }, + { + "description": "Returns the Global Party ID for the customer, if there is one. Global Party ID is created by Customer 360 and identifies a person across multiple systems.", + "id": "script-api:dw/customer/Customer#globalPartyID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.globalPartyID", + "sections": [ + { + "body": "Returns the Global Party ID for the customer, if there is one.\nGlobal Party ID is created by Customer 360 and identifies a person across multiple systems.", + "heading": "Description" + } + ], + "signature": "readonly globalPartyID: string", + "source": "script-api", + "tags": [ + "globalpartyid", + "customer.globalpartyid" + ], + "title": "Customer.globalPartyID" + }, + { + "description": "Identifies if the customer is anonymous. An anonymous customer is the opposite of a registered customer.", + "id": "script-api:dw/customer/Customer#isAnonymous", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isAnonymous", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the customer is anonymous. An anonymous\ncustomer is the opposite of a registered customer.", + "heading": "Description" + } + ], + "signature": "isAnonymous(): boolean", + "source": "script-api", + "tags": [ + "isanonymous", + "customer.isanonymous" + ], + "title": "Customer.isAnonymous" + }, + { + "description": "Identifies if the customer is authenticated. This method checks whether this customer is the customer associated with the session and than checks whether the session in an authenticated state.", + "id": "script-api:dw/customer/Customer#isAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the customer is authenticated. This method checks whether\nthis customer is the customer associated with the session and than checks\nwhether the session in an authenticated state.\n\nNote: The pipeline debugger will always show 'false' for this value\nregardless of whether the customer is authenticated or not.", + "heading": "Description" + } + ], + "signature": "isAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "isauthenticated", + "customer.isauthenticated" + ], + "title": "Customer.isAuthenticated" + }, + { + "description": "Identifies if the customer is externally authenticated. An externally authenticated customer does not have the password stored in our system but logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)", + "id": "script-api:dw/customer/Customer#isExternallyAuthenticated", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isExternallyAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the customer is externally authenticated. An externally\nauthenticated customer does not have the password stored in our system\nbut logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)", + "heading": "Description" + } + ], + "signature": "isExternallyAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "isexternallyauthenticated", + "customer.isexternallyauthenticated" + ], + "title": "Customer.isExternallyAuthenticated" + }, + { + "description": "Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of at least one of that groups.", + "id": "script-api:dw/customer/Customer#isMemberOfAnyCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "groupIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfAnyCustomerGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of at least one of that groups.", + "heading": "Description" + } + ], + "signature": "isMemberOfAnyCustomerGroup(groupIDs?: string[]): boolean", + "source": "script-api", + "tags": [ + "ismemberofanycustomergroup", + "customer.ismemberofanycustomergroup" + ], + "title": "Customer.isMemberOfAnyCustomerGroup" + }, + { + "description": "Returns true if the customer is member of the specified CustomerGroup.", + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "group", + "type": "CustomerGroup" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the customer is member of the specified\nCustomerGroup.", + "heading": "Description" + } + ], + "signature": "isMemberOfCustomerGroup(group: CustomerGroup): boolean", + "source": "script-api", + "tags": [ + "ismemberofcustomergroup", + "customer.ismemberofcustomergroup" + ], + "title": "Customer.isMemberOfCustomerGroup" + }, + { + "description": "Returns true if there is a CustomerGroup with such an ID and the customer is member of that group.", + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "groupID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if there is a CustomerGroup with such an ID and the customer is member of that group.", + "heading": "Description" + } + ], + "signature": "isMemberOfCustomerGroup(groupID: string): boolean", + "source": "script-api", + "tags": [ + "ismemberofcustomergroup", + "customer.ismemberofcustomergroup" + ], + "title": "Customer.isMemberOfCustomerGroup" + }, + { + "description": "Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of all that groups.", + "id": "script-api:dw/customer/Customer#isMemberOfCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "groupIDs", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isMemberOfCustomerGroups", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of all that groups.", + "heading": "Description" + } + ], + "signature": "isMemberOfCustomerGroups(groupIDs?: string[]): boolean", + "source": "script-api", + "tags": [ + "ismemberofcustomergroups", + "customer.ismemberofcustomergroups" + ], + "title": "Customer.isMemberOfCustomerGroups" + }, + { + "description": "Identifies if the customer is registered. A registered customer may or may not be authenticated. This method checks whether the user has a profile.", + "id": "script-api:dw/customer/Customer#isRegistered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.isRegistered", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the customer is registered. A registered customer\nmay or may not be authenticated. This method checks whether\nthe user has a profile.", + "heading": "Description" + } + ], + "signature": "isRegistered(): boolean", + "source": "script-api", + "tags": [ + "isregistered", + "customer.isregistered" + ], + "title": "Customer.isRegistered" + }, + { + "description": "Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous customer or when note has 0 length.", + "id": "script-api:dw/customer/Customer#note", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.note", + "sections": [ + { + "body": "Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous\ncustomer or when note has 0 length.", + "heading": "Description" + } + ], + "signature": "note: string | null", + "source": "script-api", + "tags": [ + "note", + "customer.note" + ], + "title": "Customer.note" + }, + { + "description": "Returns the customer order history.", + "id": "script-api:dw/customer/Customer#orderHistory", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.orderHistory", + "sections": [ + { + "body": "Returns the customer order history.", + "heading": "Description" + } + ], + "signature": "readonly orderHistory: OrderHistory", + "source": "script-api", + "tags": [ + "orderhistory", + "customer.orderhistory" + ], + "title": "Customer.orderHistory" + }, + { + "description": "Returns the customer profile.", + "id": "script-api:dw/customer/Customer#profile", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.profile", + "sections": [ + { + "body": "Returns the customer profile.", + "heading": "Description" + } + ], + "signature": "readonly profile: Profile", + "source": "script-api", + "tags": [ + "profile", + "customer.profile" + ], + "title": "Customer.profile" + }, + { + "description": "Identifies if the customer is registered. A registered customer may or may not be authenticated. This method checks whether the user has a profile.", + "id": "script-api:dw/customer/Customer#registered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.registered", + "sections": [ + { + "body": "Identifies if the customer is registered. A registered customer\nmay or may not be authenticated. This method checks whether\nthe user has a profile.", + "heading": "Description" + } + ], + "signature": "readonly registered: boolean", + "source": "script-api", + "tags": [ + "registered", + "customer.registered" + ], + "title": "Customer.registered" + }, + { + "description": "Removes an external profile from the customer", + "id": "script-api:dw/customer/Customer#removeExternalProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "externalProfile", + "type": "ExternalProfile" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.removeExternalProfile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes an external profile from the customer", + "heading": "Description" + } + ], + "signature": "removeExternalProfile(externalProfile: ExternalProfile): void", + "source": "script-api", + "tags": [ + "removeexternalprofile", + "customer.removeexternalprofile" + ], + "title": "Customer.removeExternalProfile" + }, + { + "description": "Sets the note for this customer. This is a no-op for an anonymous customer.", + "id": "script-api:dw/customer/Customer#setNote", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Customer", + "qualifiedName": "dw.customer.Customer.setNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the note for this customer. This is a no-op for an anonymous customer.", + "heading": "Description" + } + ], + "signature": "setNote(aValue: string): void", + "source": "script-api", + "tags": [ + "setnote", + "customer.setnote" + ], + "title": "Customer.setNote" + }, + { + "description": "Represents the active data for a dw.customer.Customer in Commerce Cloud Digital.", + "id": "script-api:dw/customer/CustomerActiveData", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerActiveData", + "sections": [ + { + "body": "Represents the active data for a dw.customer.Customer in Commerce Cloud Digital.\n\nNote: this class allows access to sensitive personal and private information.\nPay attention to appropriate legal and regulatory requirements when developing.", + "heading": "Description" + }, + { + "body": "Extends `ActiveData`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customeractivedata", + "dw.customer.customeractivedata", + "dw/customer" + ], + "title": "CustomerActiveData" + }, + { + "description": "Returns the average order value of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#avgOrderValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.avgOrderValue", + "sections": [ + { + "body": "Returns the average order value of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly avgOrderValue: number", + "source": "script-api", + "tags": [ + "avgordervalue", + "customeractivedata.avgordervalue" + ], + "title": "CustomerActiveData.avgOrderValue" + }, + { + "description": "Returns the discount value resulting from coupons, that has been applied to orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#discountValueWithCoupon", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.discountValueWithCoupon", + "sections": [ + { + "body": "Returns the discount value resulting from coupons, that has been applied\nto orders of the customer, or `null` if none has been set or\nthe value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly discountValueWithCoupon: number", + "source": "script-api", + "tags": [ + "discountvaluewithcoupon", + "customeractivedata.discountvaluewithcoupon" + ], + "title": "CustomerActiveData.discountValueWithCoupon" + }, + { + "description": "Returns the discount value resulting from promotions other than coupons, that has been applied to orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#discountValueWithoutCoupon", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.discountValueWithoutCoupon", + "sections": [ + { + "body": "Returns the discount value resulting from promotions other than coupons,\nthat has been applied to orders of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly discountValueWithoutCoupon: number", + "source": "script-api", + "tags": [ + "discountvaluewithoutcoupon", + "customeractivedata.discountvaluewithoutcoupon" + ], + "title": "CustomerActiveData.discountValueWithoutCoupon" + }, + { + "description": "Returns the average order value of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getAvgOrderValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getAvgOrderValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the average order value of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getAvgOrderValue(): number", + "source": "script-api", + "tags": [ + "getavgordervalue", + "customeractivedata.getavgordervalue" + ], + "title": "CustomerActiveData.getAvgOrderValue" + }, + { + "description": "Returns the discount value resulting from coupons, that has been applied to orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getDiscountValueWithCoupon", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getDiscountValueWithCoupon", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the discount value resulting from coupons, that has been applied\nto orders of the customer, or `null` if none has been set or\nthe value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getDiscountValueWithCoupon(): number", + "source": "script-api", + "tags": [ + "getdiscountvaluewithcoupon", + "customeractivedata.getdiscountvaluewithcoupon" + ], + "title": "CustomerActiveData.getDiscountValueWithCoupon" + }, + { + "description": "Returns the discount value resulting from promotions other than coupons, that has been applied to orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getDiscountValueWithoutCoupon", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getDiscountValueWithoutCoupon", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the discount value resulting from promotions other than coupons,\nthat has been applied to orders of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getDiscountValueWithoutCoupon(): number", + "source": "script-api", + "tags": [ + "getdiscountvaluewithoutcoupon", + "customeractivedata.getdiscountvaluewithoutcoupon" + ], + "title": "CustomerActiveData.getDiscountValueWithoutCoupon" + }, + { + "description": "Returns the number of orders for the Customer that contained at least one product unit marked as a gift, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getGiftOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getGiftOrders", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders for the Customer that contained at least\none product unit marked as a gift, or `null` if none has been\nset or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getGiftOrders(): number", + "source": "script-api", + "tags": [ + "getgiftorders", + "customeractivedata.getgiftorders" + ], + "title": "CustomerActiveData.getGiftOrders" + }, + { + "description": "Returns the number of product units in orders for the customer that were marked as a gift, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getGiftUnits", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getGiftUnits", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of product units in orders for the customer\nthat were marked as a gift, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getGiftUnits(): number", + "source": "script-api", + "tags": [ + "getgiftunits", + "customeractivedata.getgiftunits" + ], + "title": "CustomerActiveData.getGiftUnits" + }, + { + "description": "Returns the date of the last order for the customer, or `null` if there are no orders for the customer.", + "id": "script-api:dw/customer/CustomerActiveData#getLastOrderDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getLastOrderDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the date of the last order for the customer, or `null`\nif there are no orders for the customer.", + "heading": "Description" + } + ], + "signature": "getLastOrderDate(): Date | null", + "source": "script-api", + "tags": [ + "getlastorderdate", + "customeractivedata.getlastorderdate" + ], + "title": "CustomerActiveData.getLastOrderDate" + }, + { + "description": "Returns the lifetime order value of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getOrderValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrderValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the lifetime order value of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrderValue(): number", + "source": "script-api", + "tags": [ + "getordervalue", + "customeractivedata.getordervalue" + ], + "title": "CustomerActiveData.getOrderValue" + }, + { + "description": "Returns the order value of the customer, over the most recent 30 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getOrderValueMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrderValueMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the order value of the customer, over the most recent 30 days,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrderValueMonth(): number", + "source": "script-api", + "tags": [ + "getordervaluemonth", + "customeractivedata.getordervaluemonth" + ], + "title": "CustomerActiveData.getOrderValueMonth" + }, + { + "description": "Returns the orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getOrders", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the orders of the customer, or `null` if none\nhas been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getOrders(): number", + "source": "script-api", + "tags": [ + "getorders", + "customeractivedata.getorders" + ], + "title": "CustomerActiveData.getOrders" + }, + { + "description": "Returns an array containing the master product SKUs of variation products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#getProductMastersOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductMastersOrdered", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the master product SKUs of variation products\nin orders for the customer, or an empty collection if no SKUs have been\nset or the collection of SKUs is no longer valid. There is no specific\nlimit on the number of SKUs that will be returned in the collection, but\nthere is also no guarantee that it will contain the SKUs for all products\nordered by the customer.", + "heading": "Description" + } + ], + "signature": "getProductMastersOrdered(): string[]", + "source": "script-api", + "tags": [ + "getproductmastersordered", + "customeractivedata.getproductmastersordered" + ], + "title": "CustomerActiveData.getProductMastersOrdered" + }, + { + "description": "Returns an array containing the SKUs of products in baskets abandoned by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products in baskets abandoned by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#getProductsAbandonedMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsAbandonedMonth", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the SKUs of products in baskets abandoned\nby the customer in the last 30 days, or an empty collection if no SKUs\nhave been set or the collection is no longer valid. There is no specific\nlimit on the number of SKUs that will be returned in the collection, but\nthere is also no guarantee that it will contain the SKUs for all products\nin baskets abandoned by the customer.", + "heading": "Description" + } + ], + "signature": "getProductsAbandonedMonth(): string[]", + "source": "script-api", + "tags": [ + "getproductsabandonedmonth", + "customeractivedata.getproductsabandonedmonth" + ], + "title": "CustomerActiveData.getProductsAbandonedMonth" + }, + { + "description": "Returns an array containing the SKUs of products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#getProductsOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsOrdered", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the SKUs of products in orders\nfor the customer, or an empty collection if no SKUs have been set or the\ncollection of SKUs is no longer valid. There is no specific limit on the\nnumber of SKUs that will be returned in the collection, but there is also\nno guarantee that it will contain the SKUs for all products ordered by\nthe customer.", + "heading": "Description" + } + ], + "signature": "getProductsOrdered(): string[]", + "source": "script-api", + "tags": [ + "getproductsordered", + "customeractivedata.getproductsordered" + ], + "title": "CustomerActiveData.getProductsOrdered" + }, + { + "description": "Returns an array containing the SKUs of products viewed by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products viewed by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#getProductsViewedMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getProductsViewedMonth", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the SKUs of products viewed by the\ncustomer in the last 30 days, or an empty collection if no SKUs have been\nset or the collection is no longer valid. There is no specific limit on\nthe number of SKUs that will be returned in the collection, but there is\nalso no guarantee that it will contain the SKUs for all products viewed\nby the customer.", + "heading": "Description" + } + ], + "signature": "getProductsViewedMonth(): string[]", + "source": "script-api", + "tags": [ + "getproductsviewedmonth", + "customeractivedata.getproductsviewedmonth" + ], + "title": "CustomerActiveData.getProductsViewedMonth" + }, + { + "description": "Returns the returned revenue of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getReturnValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getReturnValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the returned revenue of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getReturnValue(): number", + "source": "script-api", + "tags": [ + "getreturnvalue", + "customeractivedata.getreturnvalue" + ], + "title": "CustomerActiveData.getReturnValue" + }, + { + "description": "Returns the number of returns of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getReturns", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getReturns", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of returns of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "getReturns(): number", + "source": "script-api", + "tags": [ + "getreturns", + "customeractivedata.getreturns" + ], + "title": "CustomerActiveData.getReturns" + }, + { + "description": "Returns the number of orders for the customer where a source code was in effect, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getSourceCodeOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getSourceCodeOrders", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders for the customer where a source code was\nin effect, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getSourceCodeOrders(): number", + "source": "script-api", + "tags": [ + "getsourcecodeorders", + "customeractivedata.getsourcecodeorders" + ], + "title": "CustomerActiveData.getSourceCodeOrders" + }, + { + "description": "Returns an array containing the IDs of up to the top 20 categories for customer orders, or an empty list if no categories have been set or the list of categories is no longer valid. The top category is the one for which the most orders for the customer contained at least one product found in that category.", + "id": "script-api:dw/customer/CustomerActiveData#getTopCategoriesOrdered", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getTopCategoriesOrdered", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the IDs of up to the top 20 categories for\ncustomer orders, or an empty list if no categories have been set or the\nlist of categories is no longer valid. The top category is the one for\nwhich the most orders for the customer contained at least one product\nfound in that category.", + "heading": "Description" + } + ], + "signature": "getTopCategoriesOrdered(): string[]", + "source": "script-api", + "tags": [ + "gettopcategoriesordered", + "customeractivedata.gettopcategoriesordered" + ], + "title": "CustomerActiveData.getTopCategoriesOrdered" + }, + { + "description": "Returns the visits of the customer, over the most recent 30 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getVisitsMonth", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 30 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getVisitsMonth(): number", + "source": "script-api", + "tags": [ + "getvisitsmonth", + "customeractivedata.getvisitsmonth" + ], + "title": "CustomerActiveData.getVisitsMonth" + }, + { + "description": "Returns the visits of the customer, over the most recent 7 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getVisitsWeek", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 7 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getVisitsWeek(): number", + "source": "script-api", + "tags": [ + "getvisitsweek", + "customeractivedata.getvisitsweek" + ], + "title": "CustomerActiveData.getVisitsWeek" + }, + { + "description": "Returns the visits of the customer, over the most recent 365 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#getVisitsYear", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.getVisitsYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 365 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "getVisitsYear(): number", + "source": "script-api", + "tags": [ + "getvisitsyear", + "customeractivedata.getvisitsyear" + ], + "title": "CustomerActiveData.getVisitsYear" + }, + { + "description": "Returns the number of orders for the Customer that contained at least one product unit marked as a gift, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#giftOrders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.giftOrders", + "sections": [ + { + "body": "Returns the number of orders for the Customer that contained at least\none product unit marked as a gift, or `null` if none has been\nset or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly giftOrders: number", + "source": "script-api", + "tags": [ + "giftorders", + "customeractivedata.giftorders" + ], + "title": "CustomerActiveData.giftOrders" + }, + { + "description": "Returns the number of product units in orders for the customer that were marked as a gift, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#giftUnits", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.giftUnits", + "sections": [ + { + "body": "Returns the number of product units in orders for the customer\nthat were marked as a gift, or `null` if none has been set\nor the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly giftUnits: number", + "source": "script-api", + "tags": [ + "giftunits", + "customeractivedata.giftunits" + ], + "title": "CustomerActiveData.giftUnits" + }, + { + "description": "Returns the date of the last order for the customer, or `null` if there are no orders for the customer.", + "id": "script-api:dw/customer/CustomerActiveData#lastOrderDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.lastOrderDate", + "sections": [ + { + "body": "Returns the date of the last order for the customer, or `null`\nif there are no orders for the customer.", + "heading": "Description" + } + ], + "signature": "readonly lastOrderDate: Date | null", + "source": "script-api", + "tags": [ + "lastorderdate", + "customeractivedata.lastorderdate" + ], + "title": "CustomerActiveData.lastOrderDate" + }, + { + "description": "Returns the lifetime order value of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#orderValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orderValue", + "sections": [ + { + "body": "Returns the lifetime order value of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly orderValue: number", + "source": "script-api", + "tags": [ + "ordervalue", + "customeractivedata.ordervalue" + ], + "title": "CustomerActiveData.orderValue" + }, + { + "description": "Returns the order value of the customer, over the most recent 30 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#orderValueMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orderValueMonth", + "sections": [ + { + "body": "Returns the order value of the customer, over the most recent 30 days,\nor `null` if none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly orderValueMonth: number", + "source": "script-api", + "tags": [ + "ordervaluemonth", + "customeractivedata.ordervaluemonth" + ], + "title": "CustomerActiveData.orderValueMonth" + }, + { + "description": "Returns the orders of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#orders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.orders", + "sections": [ + { + "body": "Returns the orders of the customer, or `null` if none\nhas been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly orders: number", + "source": "script-api", + "tags": [ + "orders", + "customeractivedata.orders" + ], + "title": "CustomerActiveData.orders" + }, + { + "description": "Returns an array containing the master product SKUs of variation products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#productMastersOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productMastersOrdered", + "sections": [ + { + "body": "Returns an array containing the master product SKUs of variation products\nin orders for the customer, or an empty collection if no SKUs have been\nset or the collection of SKUs is no longer valid. There is no specific\nlimit on the number of SKUs that will be returned in the collection, but\nthere is also no guarantee that it will contain the SKUs for all products\nordered by the customer.", + "heading": "Description" + } + ], + "signature": "readonly productMastersOrdered: string[]", + "source": "script-api", + "tags": [ + "productmastersordered", + "customeractivedata.productmastersordered" + ], + "title": "CustomerActiveData.productMastersOrdered" + }, + { + "description": "Returns an array containing the SKUs of products in baskets abandoned by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products in baskets abandoned by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#productsAbandonedMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsAbandonedMonth", + "sections": [ + { + "body": "Returns an array containing the SKUs of products in baskets abandoned\nby the customer in the last 30 days, or an empty collection if no SKUs\nhave been set or the collection is no longer valid. There is no specific\nlimit on the number of SKUs that will be returned in the collection, but\nthere is also no guarantee that it will contain the SKUs for all products\nin baskets abandoned by the customer.", + "heading": "Description" + } + ], + "signature": "readonly productsAbandonedMonth: string[]", + "source": "script-api", + "tags": [ + "productsabandonedmonth", + "customeractivedata.productsabandonedmonth" + ], + "title": "CustomerActiveData.productsAbandonedMonth" + }, + { + "description": "Returns an array containing the SKUs of products in orders for the customer, or an empty collection if no SKUs have been set or the collection of SKUs is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products ordered by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#productsOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsOrdered", + "sections": [ + { + "body": "Returns an array containing the SKUs of products in orders\nfor the customer, or an empty collection if no SKUs have been set or the\ncollection of SKUs is no longer valid. There is no specific limit on the\nnumber of SKUs that will be returned in the collection, but there is also\nno guarantee that it will contain the SKUs for all products ordered by\nthe customer.", + "heading": "Description" + } + ], + "signature": "readonly productsOrdered: string[]", + "source": "script-api", + "tags": [ + "productsordered", + "customeractivedata.productsordered" + ], + "title": "CustomerActiveData.productsOrdered" + }, + { + "description": "Returns an array containing the SKUs of products viewed by the customer in the last 30 days, or an empty collection if no SKUs have been set or the collection is no longer valid. There is no specific limit on the number of SKUs that will be returned in the collection, but there is also no guarantee that it will contain the SKUs for all products viewed by the customer.", + "id": "script-api:dw/customer/CustomerActiveData#productsViewedMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.productsViewedMonth", + "sections": [ + { + "body": "Returns an array containing the SKUs of products viewed by the\ncustomer in the last 30 days, or an empty collection if no SKUs have been\nset or the collection is no longer valid. There is no specific limit on\nthe number of SKUs that will be returned in the collection, but there is\nalso no guarantee that it will contain the SKUs for all products viewed\nby the customer.", + "heading": "Description" + } + ], + "signature": "readonly productsViewedMonth: string[]", + "source": "script-api", + "tags": [ + "productsviewedmonth", + "customeractivedata.productsviewedmonth" + ], + "title": "CustomerActiveData.productsViewedMonth" + }, + { + "description": "Returns the returned revenue of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#returnValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.returnValue", + "sections": [ + { + "body": "Returns the returned revenue of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly returnValue: number", + "source": "script-api", + "tags": [ + "returnvalue", + "customeractivedata.returnvalue" + ], + "title": "CustomerActiveData.returnValue" + }, + { + "description": "Returns the number of returns of the customer, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#returns", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.returns", + "sections": [ + { + "body": "Returns the number of returns of the customer, or `null`\nif none has been set or the value is no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly returns: number", + "source": "script-api", + "tags": [ + "returns", + "customeractivedata.returns" + ], + "title": "CustomerActiveData.returns" + }, + { + "description": "Returns the number of orders for the customer where a source code was in effect, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#sourceCodeOrders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.sourceCodeOrders", + "sections": [ + { + "body": "Returns the number of orders for the customer where a source code was\nin effect, or `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeOrders: number", + "source": "script-api", + "tags": [ + "sourcecodeorders", + "customeractivedata.sourcecodeorders" + ], + "title": "CustomerActiveData.sourceCodeOrders" + }, + { + "description": "Returns an array containing the IDs of up to the top 20 categories for customer orders, or an empty list if no categories have been set or the list of categories is no longer valid. The top category is the one for which the most orders for the customer contained at least one product found in that category.", + "id": "script-api:dw/customer/CustomerActiveData#topCategoriesOrdered", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.topCategoriesOrdered", + "sections": [ + { + "body": "Returns an array containing the IDs of up to the top 20 categories for\ncustomer orders, or an empty list if no categories have been set or the\nlist of categories is no longer valid. The top category is the one for\nwhich the most orders for the customer contained at least one product\nfound in that category.", + "heading": "Description" + } + ], + "signature": "readonly topCategoriesOrdered: string[]", + "source": "script-api", + "tags": [ + "topcategoriesordered", + "customeractivedata.topcategoriesordered" + ], + "title": "CustomerActiveData.topCategoriesOrdered" + }, + { + "description": "Returns the visits of the customer, over the most recent 30 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#visitsMonth", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsMonth", + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 30 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly visitsMonth: number", + "source": "script-api", + "tags": [ + "visitsmonth", + "customeractivedata.visitsmonth" + ], + "title": "CustomerActiveData.visitsMonth" + }, + { + "description": "Returns the visits of the customer, over the most recent 7 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#visitsWeek", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsWeek", + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 7 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly visitsWeek: number", + "source": "script-api", + "tags": [ + "visitsweek", + "customeractivedata.visitsweek" + ], + "title": "CustomerActiveData.visitsWeek" + }, + { + "description": "Returns the visits of the customer, over the most recent 365 days, or `null` if none has been set or the value is no longer valid.", + "id": "script-api:dw/customer/CustomerActiveData#visitsYear", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerActiveData", + "qualifiedName": "dw.customer.CustomerActiveData.visitsYear", + "sections": [ + { + "body": "Returns the visits of the customer, over the most recent 365 days,\nor `null` if none has been set or the value\nis no longer valid.", + "heading": "Description" + } + ], + "signature": "readonly visitsYear: number", + "source": "script-api", + "tags": [ + "visitsyear", + "customeractivedata.visitsyear" + ], + "title": "CustomerActiveData.visitsYear" + }, + { + "description": "The Address class represents a customer's address.", + "id": "script-api:dw/customer/CustomerAddress", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerAddress", + "sections": [ + { + "body": "The Address class represents a customer's address.\n\nNote: this class allows access to sensitive personal and private information.\nPay attention to appropriate legal and regulatory requirements.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customeraddress", + "dw.customer.customeraddress", + "dw/customer" + ], + "title": "CustomerAddress" + }, + { + "description": "Returns the name of the address.", + "id": "script-api:dw/customer/CustomerAddress#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.ID", + "sections": [ + { + "body": "Returns the name of the address.", + "heading": "Description" + } + ], + "signature": "ID: string", + "source": "script-api", + "tags": [ + "id", + "customeraddress.id" + ], + "title": "CustomerAddress.ID" + }, + { + "description": "Returns the customer's first address.", + "id": "script-api:dw/customer/CustomerAddress#address1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.address1", + "sections": [ + { + "body": "Returns the customer's first address.", + "heading": "Description" + } + ], + "signature": "address1: string", + "source": "script-api", + "tags": [ + "address1", + "customeraddress.address1" + ], + "title": "CustomerAddress.address1" + }, + { + "description": "Returns the customer's second address value.", + "id": "script-api:dw/customer/CustomerAddress#address2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.address2", + "sections": [ + { + "body": "Returns the customer's second address value.", + "heading": "Description" + } + ], + "signature": "address2: string", + "source": "script-api", + "tags": [ + "address2", + "customeraddress.address2" + ], + "title": "CustomerAddress.address2" + }, + { + "description": "Returns the customer's city.", + "id": "script-api:dw/customer/CustomerAddress#city", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.city", + "sections": [ + { + "body": "Returns the customer's city.", + "heading": "Description" + } + ], + "signature": "city: string", + "source": "script-api", + "tags": [ + "city", + "customeraddress.city" + ], + "title": "CustomerAddress.city" + }, + { + "description": "Returns the customer's company name.", + "id": "script-api:dw/customer/CustomerAddress#companyName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.companyName", + "sections": [ + { + "body": "Returns the customer's company name.", + "heading": "Description" + } + ], + "signature": "companyName: string", + "source": "script-api", + "tags": [ + "companyname", + "customeraddress.companyname" + ], + "title": "CustomerAddress.companyName" + }, + { + "description": "Returns the customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.", + "id": "script-api:dw/customer/CustomerAddress#countryCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.countryCode", + "sections": [ + { + "body": "Returns the customer's country code. Commerce Cloud Digital supports two-character\ncountry codes per ISO 3166-1 alpha-2. See\nhttp://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm\nfor additional information.", + "heading": "Description" + } + ], + "signature": "countryCode: EnumValue", + "source": "script-api", + "tags": [ + "countrycode", + "customeraddress.countrycode" + ], + "title": "CustomerAddress.countryCode" + }, + { + "description": "Returns the customer's first name.", + "id": "script-api:dw/customer/CustomerAddress#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.firstName", + "sections": [ + { + "body": "Returns the customer's first name.", + "heading": "Description" + } + ], + "signature": "firstName: string", + "source": "script-api", + "tags": [ + "firstname", + "customeraddress.firstname" + ], + "title": "CustomerAddress.firstName" + }, + { + "description": "Returns a concatenation of the customer's first, middle, and last names and its suffix.", + "id": "script-api:dw/customer/CustomerAddress#fullName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.fullName", + "sections": [ + { + "body": "Returns a concatenation of the customer's first, middle,\nand last names and its suffix.", + "heading": "Description" + } + ], + "signature": "readonly fullName: string", + "source": "script-api", + "tags": [ + "fullname", + "customeraddress.fullname" + ], + "title": "CustomerAddress.fullName" + }, + { + "description": "Returns the customer's first address.", + "id": "script-api:dw/customer/CustomerAddress#getAddress1", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getAddress1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's first address.", + "heading": "Description" + } + ], + "signature": "getAddress1(): string", + "source": "script-api", + "tags": [ + "getaddress1", + "customeraddress.getaddress1" + ], + "title": "CustomerAddress.getAddress1" + }, + { + "description": "Returns the customer's second address value.", + "id": "script-api:dw/customer/CustomerAddress#getAddress2", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getAddress2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's second address value.", + "heading": "Description" + } + ], + "signature": "getAddress2(): string", + "source": "script-api", + "tags": [ + "getaddress2", + "customeraddress.getaddress2" + ], + "title": "CustomerAddress.getAddress2" + }, + { + "description": "Returns the customer's city.", + "id": "script-api:dw/customer/CustomerAddress#getCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's city.", + "heading": "Description" + } + ], + "signature": "getCity(): string", + "source": "script-api", + "tags": [ + "getcity", + "customeraddress.getcity" + ], + "title": "CustomerAddress.getCity" + }, + { + "description": "Returns the customer's company name.", + "id": "script-api:dw/customer/CustomerAddress#getCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCompanyName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's company name.", + "heading": "Description" + } + ], + "signature": "getCompanyName(): string", + "source": "script-api", + "tags": [ + "getcompanyname", + "customeraddress.getcompanyname" + ], + "title": "CustomerAddress.getCompanyName" + }, + { + "description": "Returns the customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.", + "id": "script-api:dw/customer/CustomerAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getCountryCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the customer's country code. Commerce Cloud Digital supports two-character\ncountry codes per ISO 3166-1 alpha-2. See\nhttp://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm\nfor additional information.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): EnumValue", + "source": "script-api", + "tags": [ + "getcountrycode", + "customeraddress.getcountrycode" + ], + "title": "CustomerAddress.getCountryCode" + }, + { + "description": "Returns the customer's first name.", + "id": "script-api:dw/customer/CustomerAddress#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getFirstName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's first name.", + "heading": "Description" + } + ], + "signature": "getFirstName(): string", + "source": "script-api", + "tags": [ + "getfirstname", + "customeraddress.getfirstname" + ], + "title": "CustomerAddress.getFirstName" + }, + { + "description": "Returns a concatenation of the customer's first, middle, and last names and its suffix.", + "id": "script-api:dw/customer/CustomerAddress#getFullName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getFullName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a concatenation of the customer's first, middle,\nand last names and its suffix.", + "heading": "Description" + } + ], + "signature": "getFullName(): string", + "source": "script-api", + "tags": [ + "getfullname", + "customeraddress.getfullname" + ], + "title": "CustomerAddress.getFullName" + }, + { + "description": "Returns the name of the address.", + "id": "script-api:dw/customer/CustomerAddress#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the address.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "customeraddress.getid" + ], + "title": "CustomerAddress.getID" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/customer/CustomerAddress#getJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getJobTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "getJobTitle(): string", + "source": "script-api", + "tags": [ + "getjobtitle", + "customeraddress.getjobtitle" + ], + "title": "CustomerAddress.getJobTitle" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/customer/CustomerAddress#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getLastName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "getLastName(): string", + "source": "script-api", + "tags": [ + "getlastname", + "customeraddress.getlastname" + ], + "title": "CustomerAddress.getLastName" + }, + { + "description": "Returns the customer's phone number.", + "id": "script-api:dw/customer/CustomerAddress#getPhone", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPhone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's phone number.", + "heading": "Description" + } + ], + "signature": "getPhone(): string", + "source": "script-api", + "tags": [ + "getphone", + "customeraddress.getphone" + ], + "title": "CustomerAddress.getPhone" + }, + { + "description": "Returns the customer's post box.", + "id": "script-api:dw/customer/CustomerAddress#getPostBox", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPostBox", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's post box.", + "heading": "Description" + } + ], + "signature": "getPostBox(): string", + "source": "script-api", + "tags": [ + "getpostbox", + "customeraddress.getpostbox" + ], + "title": "CustomerAddress.getPostBox" + }, + { + "description": "Returns the customer's postal code.", + "id": "script-api:dw/customer/CustomerAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's postal code.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "customeraddress.getpostalcode" + ], + "title": "CustomerAddress.getPostalCode" + }, + { + "description": "Returns the customer's salutation.", + "id": "script-api:dw/customer/CustomerAddress#getSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSalutation", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's salutation.", + "heading": "Description" + } + ], + "signature": "getSalutation(): string", + "source": "script-api", + "tags": [ + "getsalutation", + "customeraddress.getsalutation" + ], + "title": "CustomerAddress.getSalutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/customer/CustomerAddress#getSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSecondName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "getSecondName(): string", + "source": "script-api", + "tags": [ + "getsecondname", + "customeraddress.getsecondname" + ], + "title": "CustomerAddress.getSecondName" + }, + { + "description": "Returns the customer's state.", + "id": "script-api:dw/customer/CustomerAddress#getStateCode", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getStateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's state.", + "heading": "Description" + } + ], + "signature": "getStateCode(): string", + "source": "script-api", + "tags": [ + "getstatecode", + "customeraddress.getstatecode" + ], + "title": "CustomerAddress.getStateCode" + }, + { + "description": "Returns the customer's suffix.", + "id": "script-api:dw/customer/CustomerAddress#getSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSuffix", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's suffix.", + "heading": "Description" + } + ], + "signature": "getSuffix(): string", + "source": "script-api", + "tags": [ + "getsuffix", + "customeraddress.getsuffix" + ], + "title": "CustomerAddress.getSuffix" + }, + { + "description": "Returns the customer's suite.", + "id": "script-api:dw/customer/CustomerAddress#getSuite", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getSuite", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's suite.", + "heading": "Description" + } + ], + "signature": "getSuite(): string", + "source": "script-api", + "tags": [ + "getsuite", + "customeraddress.getsuite" + ], + "title": "CustomerAddress.getSuite" + }, + { + "description": "Returns the customer's title.", + "id": "script-api:dw/customer/CustomerAddress#getTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's title.", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "customeraddress.gettitle" + ], + "title": "CustomerAddress.getTitle" + }, + { + "description": "Returns true if the specified address is equivalent to this address. An equivalent address is an address whose core attributes contain the same values. The core attributes are:", + "id": "script-api:dw/customer/CustomerAddress#isEquivalentAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "address", + "type": "any" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.isEquivalentAddress", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the specified address is equivalent to\nthis address. An equivalent address is an address whose\ncore attributes contain the same values. The core attributes\nare:\n\n- address1\n- address2\n- city\n- companyName\n- countryCode\n- firstName\n- lastName\n- postalCode\n- postBox\n- stateCode", + "heading": "Description" + } + ], + "signature": "isEquivalentAddress(address: any): boolean", + "source": "script-api", + "tags": [ + "isequivalentaddress", + "customeraddress.isequivalentaddress" + ], + "title": "CustomerAddress.isEquivalentAddress" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/customer/CustomerAddress#jobTitle", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.jobTitle", + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "jobTitle: string", + "source": "script-api", + "tags": [ + "jobtitle", + "customeraddress.jobtitle" + ], + "title": "CustomerAddress.jobTitle" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/customer/CustomerAddress#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.lastName", + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "lastName: string", + "source": "script-api", + "tags": [ + "lastname", + "customeraddress.lastname" + ], + "title": "CustomerAddress.lastName" + }, + { + "description": "Returns the customer's phone number.", + "id": "script-api:dw/customer/CustomerAddress#phone", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.phone", + "sections": [ + { + "body": "Returns the customer's phone number.", + "heading": "Description" + } + ], + "signature": "phone: string", + "source": "script-api", + "tags": [ + "phone", + "customeraddress.phone" + ], + "title": "CustomerAddress.phone" + }, + { + "description": "Returns the customer's post box.", + "id": "script-api:dw/customer/CustomerAddress#postBox", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.postBox", + "sections": [ + { + "body": "Returns the customer's post box.", + "heading": "Description" + } + ], + "signature": "postBox: string", + "source": "script-api", + "tags": [ + "postbox", + "customeraddress.postbox" + ], + "title": "CustomerAddress.postBox" + }, + { + "description": "Returns the customer's postal code.", + "id": "script-api:dw/customer/CustomerAddress#postalCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.postalCode", + "sections": [ + { + "body": "Returns the customer's postal code.", + "heading": "Description" + } + ], + "signature": "postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "customeraddress.postalcode" + ], + "title": "CustomerAddress.postalCode" + }, + { + "description": "Returns the customer's salutation.", + "id": "script-api:dw/customer/CustomerAddress#salutation", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.salutation", + "sections": [ + { + "body": "Returns the customer's salutation.", + "heading": "Description" + } + ], + "signature": "salutation: string", + "source": "script-api", + "tags": [ + "salutation", + "customeraddress.salutation" + ], + "title": "CustomerAddress.salutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/customer/CustomerAddress#secondName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.secondName", + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "secondName: string", + "source": "script-api", + "tags": [ + "secondname", + "customeraddress.secondname" + ], + "title": "CustomerAddress.secondName" + }, + { + "description": "Sets the value of the customer's first address.", + "id": "script-api:dw/customer/CustomerAddress#setAddress1", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setAddress1", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value of the customer's first address.", + "heading": "Description" + } + ], + "signature": "setAddress1(value: string): void", + "source": "script-api", + "tags": [ + "setaddress1", + "customeraddress.setaddress1" + ], + "title": "CustomerAddress.setAddress1" + }, + { + "description": "Sets the customer's second address value.", + "id": "script-api:dw/customer/CustomerAddress#setAddress2", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setAddress2", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's second address value.", + "heading": "Description" + } + ], + "signature": "setAddress2(value: string): void", + "source": "script-api", + "tags": [ + "setaddress2", + "customeraddress.setaddress2" + ], + "title": "CustomerAddress.setAddress2" + }, + { + "description": "Sets the customer's city.", + "id": "script-api:dw/customer/CustomerAddress#setCity", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "city", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's city.", + "heading": "Description" + } + ], + "signature": "setCity(city: string): void", + "source": "script-api", + "tags": [ + "setcity", + "customeraddress.setcity" + ], + "title": "CustomerAddress.setCity" + }, + { + "description": "Sets the customer's company name.", + "id": "script-api:dw/customer/CustomerAddress#setCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "companyName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCompanyName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's company name.", + "heading": "Description" + } + ], + "signature": "setCompanyName(companyName: string): void", + "source": "script-api", + "tags": [ + "setcompanyname", + "customeraddress.setcompanyname" + ], + "title": "CustomerAddress.setCompanyName" + }, + { + "description": "Sets the customer's country code. Commerce Cloud Digital supports two-character country codes per ISO 3166-1 alpha-2. See http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm for additional information.", + "id": "script-api:dw/customer/CustomerAddress#setCountryCode", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "countryCode", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setCountryCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's country code. Commerce Cloud Digital supports two-character\ncountry codes per ISO 3166-1 alpha-2. See\nhttp://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm\nfor additional information.", + "heading": "Description" + } + ], + "signature": "setCountryCode(countryCode: string): void", + "source": "script-api", + "tags": [ + "setcountrycode", + "customeraddress.setcountrycode" + ], + "title": "CustomerAddress.setCountryCode" + }, + { + "description": "Sets the customer's first name.", + "id": "script-api:dw/customer/CustomerAddress#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "firstName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setFirstName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's first name.", + "heading": "Description" + } + ], + "signature": "setFirstName(firstName: string): void", + "source": "script-api", + "tags": [ + "setfirstname", + "customeraddress.setfirstname" + ], + "title": "CustomerAddress.setFirstName" + }, + { + "description": "Sets the address name.", + "id": "script-api:dw/customer/CustomerAddress#setID", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the address name.", + "heading": "Description" + } + ], + "signature": "setID(value: string): void", + "source": "script-api", + "tags": [ + "setid", + "customeraddress.setid" + ], + "title": "CustomerAddress.setID" + }, + { + "description": "Sets the customer's job title.", + "id": "script-api:dw/customer/CustomerAddress#setJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "jobTitle", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setJobTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's job title.", + "heading": "Description" + } + ], + "signature": "setJobTitle(jobTitle: string): void", + "source": "script-api", + "tags": [ + "setjobtitle", + "customeraddress.setjobtitle" + ], + "title": "CustomerAddress.setJobTitle" + }, + { + "description": "Sets the customer's last name.", + "id": "script-api:dw/customer/CustomerAddress#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "lastName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setLastName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's last name.", + "heading": "Description" + } + ], + "signature": "setLastName(lastName: string): void", + "source": "script-api", + "tags": [ + "setlastname", + "customeraddress.setlastname" + ], + "title": "CustomerAddress.setLastName" + }, + { + "description": "Sets the customer's phone number. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/CustomerAddress#setPhone", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "phoneNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPhone", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's phone number. The length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setPhone(phoneNumber: string): void", + "source": "script-api", + "tags": [ + "setphone", + "customeraddress.setphone" + ], + "title": "CustomerAddress.setPhone" + }, + { + "description": "Sets the customer's post box.", + "id": "script-api:dw/customer/CustomerAddress#setPostBox", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "postBox", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPostBox", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's post box.", + "heading": "Description" + } + ], + "signature": "setPostBox(postBox: string): void", + "source": "script-api", + "tags": [ + "setpostbox", + "customeraddress.setpostbox" + ], + "title": "CustomerAddress.setPostBox" + }, + { + "description": "Sets the customer's postal code.", + "id": "script-api:dw/customer/CustomerAddress#setPostalCode", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "postalCode", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setPostalCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's postal code.", + "heading": "Description" + } + ], + "signature": "setPostalCode(postalCode: string): void", + "source": "script-api", + "tags": [ + "setpostalcode", + "customeraddress.setpostalcode" + ], + "title": "CustomerAddress.setPostalCode" + }, + { + "deprecated": { + "message": "Use setSalutation" + }, + "description": "Sets the customer's salutation.", + "id": "script-api:dw/customer/CustomerAddress#setSaluation", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSaluation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's salutation.", + "heading": "Description" + } + ], + "signature": "setSaluation(value: string): void", + "source": "script-api", + "tags": [ + "setsaluation", + "customeraddress.setsaluation" + ], + "title": "CustomerAddress.setSaluation" + }, + { + "description": "Sets the customer's salutation.", + "id": "script-api:dw/customer/CustomerAddress#setSalutation", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSalutation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's salutation.", + "heading": "Description" + } + ], + "signature": "setSalutation(value: string): void", + "source": "script-api", + "tags": [ + "setsalutation", + "customeraddress.setsalutation" + ], + "title": "CustomerAddress.setSalutation" + }, + { + "description": "Sets the customer's second name.", + "id": "script-api:dw/customer/CustomerAddress#setSecondName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "secondName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSecondName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's second name.", + "heading": "Description" + } + ], + "signature": "setSecondName(secondName: string): void", + "source": "script-api", + "tags": [ + "setsecondname", + "customeraddress.setsecondname" + ], + "title": "CustomerAddress.setSecondName" + }, + { + "description": "Sets the customer's state.", + "id": "script-api:dw/customer/CustomerAddress#setStateCode", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "state", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setStateCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's state.", + "heading": "Description" + } + ], + "signature": "setStateCode(state: string): void", + "source": "script-api", + "tags": [ + "setstatecode", + "customeraddress.setstatecode" + ], + "title": "CustomerAddress.setStateCode" + }, + { + "description": "Sets the customer's suffix.", + "id": "script-api:dw/customer/CustomerAddress#setSuffix", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "suffix", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSuffix", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's suffix.", + "heading": "Description" + } + ], + "signature": "setSuffix(suffix: string): void", + "source": "script-api", + "tags": [ + "setsuffix", + "customeraddress.setsuffix" + ], + "title": "CustomerAddress.setSuffix" + }, + { + "description": "Sets the customer's suite. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/CustomerAddress#setSuite", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setSuite", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's suite. The length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setSuite(value: string): void", + "source": "script-api", + "tags": [ + "setsuite", + "customeraddress.setsuite" + ], + "title": "CustomerAddress.setSuite" + }, + { + "description": "Sets the customer's title.", + "id": "script-api:dw/customer/CustomerAddress#setTitle", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.setTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's title.", + "heading": "Description" + } + ], + "signature": "setTitle(title: string): void", + "source": "script-api", + "tags": [ + "settitle", + "customeraddress.settitle" + ], + "title": "CustomerAddress.setTitle" + }, + { + "description": "Returns the customer's state.", + "id": "script-api:dw/customer/CustomerAddress#stateCode", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.stateCode", + "sections": [ + { + "body": "Returns the customer's state.", + "heading": "Description" + } + ], + "signature": "stateCode: string", + "source": "script-api", + "tags": [ + "statecode", + "customeraddress.statecode" + ], + "title": "CustomerAddress.stateCode" + }, + { + "description": "Returns the customer's suffix.", + "id": "script-api:dw/customer/CustomerAddress#suffix", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.suffix", + "sections": [ + { + "body": "Returns the customer's suffix.", + "heading": "Description" + } + ], + "signature": "suffix: string", + "source": "script-api", + "tags": [ + "suffix", + "customeraddress.suffix" + ], + "title": "CustomerAddress.suffix" + }, + { + "description": "Returns the customer's suite.", + "id": "script-api:dw/customer/CustomerAddress#suite", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.suite", + "sections": [ + { + "body": "Returns the customer's suite.", + "heading": "Description" + } + ], + "signature": "suite: string", + "source": "script-api", + "tags": [ + "suite", + "customeraddress.suite" + ], + "title": "CustomerAddress.suite" + }, + { + "description": "Returns the customer's title.", + "id": "script-api:dw/customer/CustomerAddress#title", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerAddress", + "qualifiedName": "dw.customer.CustomerAddress.title", + "sections": [ + { + "body": "Returns the customer's title.", + "heading": "Description" + } + ], + "signature": "title: string", + "source": "script-api", + "tags": [ + "title", + "customeraddress.title" + ], + "title": "CustomerAddress.title" + }, + { + "description": "Represents the read-only Customer's Salesforce CDP (Customer Data Platform) data for a dw.customer.Customer in Commerce Cloud. Please see Salesforce CDP enablement documentation", + "id": "script-api:dw/customer/CustomerCDPData", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerCDPData", + "sections": [ + { + "body": "Represents the read-only Customer's Salesforce CDP (Customer Data Platform) data for a dw.customer.Customer in Commerce\nCloud. Please see Salesforce CDP enablement documentation", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customercdpdata", + "dw.customer.customercdpdata", + "dw/customer" + ], + "title": "CustomerCDPData" + }, + { + "description": "Return true if the CDPData is empty (has no meaningful data)", + "id": "script-api:dw/customer/CustomerCDPData#empty", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.empty", + "sections": [ + { + "body": "Return true if the CDPData is empty (has no meaningful data)", + "heading": "Description" + } + ], + "signature": "readonly empty: boolean", + "source": "script-api", + "tags": [ + "empty", + "customercdpdata.empty" + ], + "title": "CustomerCDPData.empty" + }, + { + "description": "Returns an array containing the CDP segments for the customer, or an empty array if no segments found", + "id": "script-api:dw/customer/CustomerCDPData#getSegments", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.getSegments", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns an array containing the CDP segments for the customer, or an empty array if no segments found", + "heading": "Description" + } + ], + "signature": "getSegments(): string[]", + "source": "script-api", + "tags": [ + "getsegments", + "customercdpdata.getsegments" + ], + "title": "CustomerCDPData.getSegments" + }, + { + "description": "Return true if the CDPData is empty (has no meaningful data)", + "id": "script-api:dw/customer/CustomerCDPData#isEmpty", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.isEmpty", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Return true if the CDPData is empty (has no meaningful data)", + "heading": "Description" + } + ], + "signature": "isEmpty(): boolean", + "source": "script-api", + "tags": [ + "isempty", + "customercdpdata.isempty" + ], + "title": "CustomerCDPData.isEmpty" + }, + { + "description": "Returns an array containing the CDP segments for the customer, or an empty array if no segments found", + "id": "script-api:dw/customer/CustomerCDPData#segments", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerCDPData", + "qualifiedName": "dw.customer.CustomerCDPData.segments", + "sections": [ + { + "body": "Returns an array containing the CDP segments for the customer, or an empty array if no segments found", + "heading": "Description" + } + ], + "signature": "readonly segments: string[]", + "source": "script-api", + "tags": [ + "segments", + "customercdpdata.segments" + ], + "title": "CustomerCDPData.segments" + }, + { + "description": "Provides helper methods for managing customer context, such as the Effective Time for which the customer is shopping at", + "id": "script-api:dw/customer/CustomerContextMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerContextMgr", + "sections": [ + { + "body": "Provides helper methods for managing customer context, such as the Effective Time for which the customer is shopping\nat", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customercontextmgr", + "dw.customer.customercontextmgr", + "dw/customer" + ], + "title": "CustomerContextMgr" + }, + { + "description": "Get the effective time associated with the customer. By default, the effective time is null.", + "id": "script-api:dw/customer/CustomerContextMgr#effectiveTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.effectiveTime", + "sections": [ + { + "body": "Get the effective time associated with the customer. By default, the effective time is null.", + "heading": "Description" + } + ], + "signature": "static effectiveTime: Date | null", + "source": "script-api", + "tags": [ + "effectivetime", + "customercontextmgr.effectivetime" + ], + "title": "CustomerContextMgr.effectiveTime" + }, + { + "description": "Get the effective time associated with the customer. By default, the effective time is null.", + "id": "script-api:dw/customer/CustomerContextMgr#effectiveTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.effectiveTime", + "sections": [ + { + "body": "Get the effective time associated with the customer. By default, the effective time is null.", + "heading": "Description" + } + ], + "signature": "static effectiveTime: Date | null", + "source": "script-api", + "tags": [ + "effectivetime", + "customercontextmgr.effectivetime" + ], + "title": "CustomerContextMgr.effectiveTime" + }, + { + "description": "Get the effective time associated with the customer. By default, the effective time is null.", + "id": "script-api:dw/customer/CustomerContextMgr#getEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.getEffectiveTime", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Get the effective time associated with the customer. By default, the effective time is null.", + "heading": "Description" + } + ], + "signature": "static getEffectiveTime(): Date | null", + "source": "script-api", + "tags": [ + "geteffectivetime", + "customercontextmgr.geteffectivetime" + ], + "title": "CustomerContextMgr.getEffectiveTime" + }, + { + "description": "Get the effective time associated with the customer. By default, the effective time is null.", + "id": "script-api:dw/customer/CustomerContextMgr#getEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.getEffectiveTime", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Get the effective time associated with the customer. By default, the effective time is null.", + "heading": "Description" + } + ], + "signature": "static getEffectiveTime(): Date | null", + "source": "script-api", + "tags": [ + "geteffectivetime", + "customercontextmgr.geteffectivetime" + ], + "title": "CustomerContextMgr.getEffectiveTime" + }, + { + "description": "Set the effective time for the customer. Null is allowed to remove effective time from the customer.", + "id": "script-api:dw/customer/CustomerContextMgr#setEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "effectiveTime", + "type": "Date" + } + ], + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.setEffectiveTime", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the effective time for the customer. Null is allowed to remove effective time from the customer.", + "heading": "Description" + } + ], + "signature": "static setEffectiveTime(effectiveTime: Date): void", + "source": "script-api", + "tags": [ + "seteffectivetime", + "customercontextmgr.seteffectivetime" + ], + "title": "CustomerContextMgr.setEffectiveTime" + }, + { + "description": "Set the effective time for the customer. Null is allowed to remove effective time from the customer.", + "id": "script-api:dw/customer/CustomerContextMgr#setEffectiveTime", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "effectiveTime", + "type": "Date" + } + ], + "parentId": "script-api:dw/customer/CustomerContextMgr", + "qualifiedName": "dw.customer.CustomerContextMgr.setEffectiveTime", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the effective time for the customer. Null is allowed to remove effective time from the customer.", + "heading": "Description" + } + ], + "signature": "static setEffectiveTime(effectiveTime: Date): void", + "source": "script-api", + "tags": [ + "seteffectivetime", + "customercontextmgr.seteffectivetime" + ], + "title": "CustomerContextMgr.setEffectiveTime" + }, + { + "description": "CustomerGroups provide a means to segment customers by various criteria. A merchant can then provide different site experiences (e.g. promotions, prices, sorting rules) to each customer segment. Customer groups can consist of either an explicit list of customers or a business rule that dynamically determines whether a customer is a member. The former type is called \"explicit\" and the latter type is called \"dynamic\".", + "id": "script-api:dw/customer/CustomerGroup", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerGroup", + "sections": [ + { + "body": "CustomerGroups provide a means to segment customers by various criteria. A\nmerchant can then provide different site experiences (e.g. promotions,\nprices, sorting rules) to each customer segment. Customer groups can consist\nof either an explicit list of customers or a business rule that dynamically\ndetermines whether a customer is a member. The former type is called\n\"explicit\" and the latter type is called \"dynamic\".\n\n- Explicit customer group: Consists of an explicit list of\ncustomers. Only registered customers can be member of such a group.\nisRuleBased==false.\n- Dynamic customer group: Memberships are evaluated by a business\nrule that is attached to the customer group. Registered as well as anonymous\ncustomers can be member of such a group. isRuleBased==true.\n\nNote: this class might allow access to sensitive personal and private\ninformation, depending on how you segment your customers and the names given to\nyour custoemer groups. Pay attention to appropriate legal and regulatory requirements\nwhen developing with this data.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customergroup", + "dw.customer.customergroup", + "dw/customer" + ], + "title": "CustomerGroup" + }, + { + "description": "Returns the unique ID of the customer group.", + "id": "script-api:dw/customer/CustomerGroup#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.ID", + "sections": [ + { + "body": "Returns the unique ID of the customer group.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "customergroup.id" + ], + "title": "CustomerGroup.ID" + }, + { + "description": "Assigns the specified customer to this group.", + "id": "script-api:dw/customer/CustomerGroup#assignCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.assignCustomer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Assigns the specified customer to this group.\n\nThe customer must be registered and the group must not be rule-based.", + "heading": "Description" + } + ], + "signature": "assignCustomer(customer: Customer): void", + "source": "script-api", + "tags": [ + "assigncustomer", + "customergroup.assigncustomer" + ], + "title": "CustomerGroup.assignCustomer" + }, + { + "description": "Gets the value of the description of the customer group.", + "id": "script-api:dw/customer/CustomerGroup#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.description", + "sections": [ + { + "body": "Gets the value of the description of the customer group.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "customergroup.description" + ], + "title": "CustomerGroup.description" + }, + { + "description": "Gets the value of the description of the customer group.", + "id": "script-api:dw/customer/CustomerGroup#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the value of the description of the customer group.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "customergroup.getdescription" + ], + "title": "CustomerGroup.getDescription" + }, + { + "description": "Returns the unique ID of the customer group.", + "id": "script-api:dw/customer/CustomerGroup#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique ID of the customer group.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "customergroup.getid" + ], + "title": "CustomerGroup.getID" + }, + { + "description": "Returns true if the group determines the membership of customers based on rules. Returns false if the group provides explicit assignement of customers.", + "id": "script-api:dw/customer/CustomerGroup#isRuleBased", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.isRuleBased", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the group determines the membership of customers\nbased on rules. Returns false if the group provides explicit assignement\nof customers.", + "heading": "Description" + } + ], + "signature": "isRuleBased(): boolean", + "source": "script-api", + "tags": [ + "isrulebased", + "customergroup.isrulebased" + ], + "title": "CustomerGroup.isRuleBased" + }, + { + "description": "Returns true if the group determines the membership of customers based on rules. Returns false if the group provides explicit assignement of customers.", + "id": "script-api:dw/customer/CustomerGroup#ruleBased", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.ruleBased", + "sections": [ + { + "body": "Returns true if the group determines the membership of customers\nbased on rules. Returns false if the group provides explicit assignement\nof customers.", + "heading": "Description" + } + ], + "signature": "readonly ruleBased: boolean", + "source": "script-api", + "tags": [ + "rulebased", + "customergroup.rulebased" + ], + "title": "CustomerGroup.ruleBased" + }, + { + "description": "Unassigns the specified customer from this group.", + "id": "script-api:dw/customer/CustomerGroup#unassignCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerGroup", + "qualifiedName": "dw.customer.CustomerGroup.unassignCustomer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Unassigns the specified customer from this group.\n\nThe customer must be registered and the group must not be rule-based.", + "heading": "Description" + } + ], + "signature": "unassignCustomer(customer: Customer): void", + "source": "script-api", + "tags": [ + "unassigncustomer", + "customergroup.unassigncustomer" + ], + "title": "CustomerGroup.unassignCustomer" + }, + { + "description": "Object representing the collection of customers who are registered for a given site. In Commerce Cloud Digital, every site has exactly one assigned customer list but multiple sites may share a customer list.", + "id": "script-api:dw/customer/CustomerList", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerList", + "sections": [ + { + "body": "Object representing the collection of customers who are registered\nfor a given site. In Commerce Cloud Digital, every site has exactly\none assigned customer list but multiple sites may share a customer\nlist.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customerlist", + "dw.customer.customerlist", + "dw/customer" + ], + "title": "CustomerList" + }, + { + "description": "Get the ID of the customer list. For customer lists that were created automatically for a given site, this is equal to the ID of the site itself.", + "id": "script-api:dw/customer/CustomerList#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.ID", + "sections": [ + { + "body": "Get the ID of the customer list. For customer lists that were created automatically\nfor a given site, this is equal to the ID of the site itself.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "customerlist.id" + ], + "title": "CustomerList.ID" + }, + { + "description": "Get the optional description of the customer list.", + "id": "script-api:dw/customer/CustomerList#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.description", + "sections": [ + { + "body": "Get the optional description of the customer list.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "customerlist.description" + ], + "title": "CustomerList.description" + }, + { + "description": "Get the optional description of the customer list.", + "id": "script-api:dw/customer/CustomerList#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the optional description of the customer list.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "customerlist.getdescription" + ], + "title": "CustomerList.getDescription" + }, + { + "description": "Get the ID of the customer list. For customer lists that were created automatically for a given site, this is equal to the ID of the site itself.", + "id": "script-api:dw/customer/CustomerList#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerList", + "qualifiedName": "dw.customer.CustomerList.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the ID of the customer list. For customer lists that were created automatically\nfor a given site, this is equal to the ID of the site itself.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "customerlist.getid" + ], + "title": "CustomerList.getID" + }, + { + "description": "Provides helper methods for managing customers and customer profiles. Note: this class allows access to sensitive information through operations that retrieve the Profile object. Pay attention to appropriate legal and regulatory requirements related to this data.", + "id": "script-api:dw/customer/CustomerMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerMgr", + "sections": [ + { + "body": "Provides helper methods for managing customers and customer\nprofiles.\nNote: this class allows access to sensitive information through\noperations that retrieve the Profile object.\nPay attention to appropriate legal and regulatory requirements related to this data.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customermgr", + "dw.customer.customermgr", + "dw/customer" + ], + "title": "CustomerMgr" + }, + { + "description": "This method authenticates a customer using the supplied login and password. It will not log in the customer into the current session, but returns only a status indicating success or failure (with different error codes for the failure cases). Upon successful authentication (status code 'AUTH_OK') the status object also holds the authenticated customer. To continue the login process, call the loginCustomer(AuthenticationStatus, boolean) method.", + "id": "script-api:dw/customer/CustomerMgr#authenticateCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.authenticateCustomer", + "returns": { + "type": "AuthenticationStatus" + }, + "sections": [ + { + "body": "This method authenticates a customer using the supplied login and password. It will not log in the customer into\nthe current session, but returns only a status indicating success or failure (with different error codes for the failure cases).\nUpon successful authentication (status code 'AUTH_OK') the status object also holds the authenticated customer.\nTo continue the login process, call the loginCustomer(AuthenticationStatus, boolean) method.\n\nThis method verifies that the password for the customer is not expired. If it is expired the authentication will fail, with a status code of\nERROR_PASSWORD_EXPIRED. This allows the storefront to require the customer to change the password, and then the login can proceed.", + "heading": "Description" + } + ], + "signature": "static authenticateCustomer(login: string, password: string): AuthenticationStatus", + "source": "script-api", + "tags": [ + "authenticatecustomer", + "customermgr.authenticatecustomer" + ], + "title": "CustomerMgr.authenticateCustomer" + }, + { + "description": "This method authenticates a customer using the supplied login and password. It will not log in the customer into the current session, but returns only a status indicating success or failure (with different error codes for the failure cases). Upon successful authentication (status code 'AUTH_OK') the status object also holds the authenticated customer. To continue the login process, call the loginCustomer(AuthenticationStatus, boolean) method.", + "id": "script-api:dw/customer/CustomerMgr#authenticateCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.authenticateCustomer", + "returns": { + "type": "AuthenticationStatus" + }, + "sections": [ + { + "body": "This method authenticates a customer using the supplied login and password. It will not log in the customer into\nthe current session, but returns only a status indicating success or failure (with different error codes for the failure cases).\nUpon successful authentication (status code 'AUTH_OK') the status object also holds the authenticated customer.\nTo continue the login process, call the loginCustomer(AuthenticationStatus, boolean) method.\n\nThis method verifies that the password for the customer is not expired. If it is expired the authentication will fail, with a status code of\nERROR_PASSWORD_EXPIRED. This allows the storefront to require the customer to change the password, and then the login can proceed.", + "heading": "Description" + } + ], + "signature": "static authenticateCustomer(login: string, password: string): AuthenticationStatus", + "source": "script-api", + "tags": [ + "authenticatecustomer", + "customermgr.authenticatecustomer" + ], + "title": "CustomerMgr.authenticateCustomer" + }, + { + "description": "Creates a new Customer using the supplied login, password. The system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. The number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their order of creation.", + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Creates a new Customer using the supplied login, password. The system automatically assigns a customer number based on\nthe customer sequence numbers configured for the site or organization. The number is guaranteed to be unique, but is not guaranteed to be sequential.\nIt can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their\norder of creation.\n\nThe method throws an exception if any of the following conditions are encountered:\n\n- A Customer with the supplied Login already exists\n- The Login is not acceptable.\n- The Password is not acceptable.\n- The system cannot create the Customer.\n\nA valid login name is between 1 and 256 characters in length (not counting leading or trailing whitespace), and may contain only the\nfollowing characters:\n\n- alphanumeric (Unicode letters or decimal digits)\n- space\n- period\n- dash\n- underscore\n- @\n\nNote: a storefront can be customized to provide further constraints on characters in a login name, but it cannot remove any constraints described above.\n\nIf customers are created using this Script API call then any updated to the customer records should be done through Script API calls as well.\nThe customer records created with Script API call should not be updated with OCAPI calls as the email validation is handled\ndifferently in these calls and may result in InvalidEmailException.", + "heading": "Description" + } + ], + "signature": "static createCustomer(login: string, password: string): Customer", + "source": "script-api", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "description": "Creates a new Customer using the supplied login, password, and a customerNo. If the customerNo is not specified, the system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. An automatically assigned number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their order of creation.", + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + }, + { + "name": "customerNo", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Creates a new Customer using the supplied login, password, and a customerNo. If the customerNo is not specified,\nthe system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. An automatically assigned\nnumber is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting\ncustomers by customer number is not guaranteed to sort them in their order of creation.\n\nThe method throws an exception if any of the following conditions are encountered:\n\n- A Customer with the supplied Login already exists\n- A Customer with the explicitly provided or calculated customer number already exists.\n- The Login is not acceptable.\n- The Password is not acceptable.\n- The system cannot create the Customer.\n\nA valid login name is between 1 and 256 characters in length (not counting leading or trailing whitespace), and may contain only the\nfollowing characters:\n\n- alphanumeric (Unicode letters or decimal digits)\n- space\n- period\n- dash\n- underscore\n- @\n\nNote: a storefront can be customized to provide further constraints on characters in a login name, but it cannot remove any constraints described above.\n\nA valid CustomerNo is between 1 and 100 characters in length (not counting leading or trailing whitespace). Commerce Cloud Digital recommends that a CustomerNo only\ncontain characters valid for URLs.\n\nIf customers are created using this Script API call then any updated to the customer records should be done through Script API calls as well.\nThe customer records created with Script API call should not be updated with OCAPI calls as the email validation is handled\ndifferently in these calls and may result in InvalidEmailException.", + "heading": "Description" + } + ], + "signature": "static createCustomer(login: string, password: string, customerNo: string): Customer", + "source": "script-api", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "description": "Creates a new Customer using the supplied login, password. The system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. The number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their order of creation.", + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Creates a new Customer using the supplied login, password. The system automatically assigns a customer number based on\nthe customer sequence numbers configured for the site or organization. The number is guaranteed to be unique, but is not guaranteed to be sequential.\nIt can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their\norder of creation.\n\nThe method throws an exception if any of the following conditions are encountered:\n\n- A Customer with the supplied Login already exists\n- The Login is not acceptable.\n- The Password is not acceptable.\n- The system cannot create the Customer.\n\nA valid login name is between 1 and 256 characters in length (not counting leading or trailing whitespace), and may contain only the\nfollowing characters:\n\n- alphanumeric (Unicode letters or decimal digits)\n- space\n- period\n- dash\n- underscore\n- @\n\nNote: a storefront can be customized to provide further constraints on characters in a login name, but it cannot remove any constraints described above.\n\nIf customers are created using this Script API call then any updated to the customer records should be done through Script API calls as well.\nThe customer records created with Script API call should not be updated with OCAPI calls as the email validation is handled\ndifferently in these calls and may result in InvalidEmailException.", + "heading": "Description" + } + ], + "signature": "static createCustomer(login: string, password: string): Customer", + "source": "script-api", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "description": "Creates a new Customer using the supplied login, password, and a customerNo. If the customerNo is not specified, the system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. An automatically assigned number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting customers by customer number is not guaranteed to sort them in their order of creation.", + "id": "script-api:dw/customer/CustomerMgr#createCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + }, + { + "name": "customerNo", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Creates a new Customer using the supplied login, password, and a customerNo. If the customerNo is not specified,\nthe system automatically assigns a customer number based on the customer sequence numbers configured for the site or organization. An automatically assigned\nnumber is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously created number. As a result, sorting\ncustomers by customer number is not guaranteed to sort them in their order of creation.\n\nThe method throws an exception if any of the following conditions are encountered:\n\n- A Customer with the supplied Login already exists\n- A Customer with the explicitly provided or calculated customer number already exists.\n- The Login is not acceptable.\n- The Password is not acceptable.\n- The system cannot create the Customer.\n\nA valid login name is between 1 and 256 characters in length (not counting leading or trailing whitespace), and may contain only the\nfollowing characters:\n\n- alphanumeric (Unicode letters or decimal digits)\n- space\n- period\n- dash\n- underscore\n- @\n\nNote: a storefront can be customized to provide further constraints on characters in a login name, but it cannot remove any constraints described above.\n\nA valid CustomerNo is between 1 and 100 characters in length (not counting leading or trailing whitespace). Commerce Cloud Digital recommends that a CustomerNo only\ncontain characters valid for URLs.\n\nIf customers are created using this Script API call then any updated to the customer records should be done through Script API calls as well.\nThe customer records created with Script API call should not be updated with OCAPI calls as the email validation is handled\ndifferently in these calls and may result in InvalidEmailException.", + "heading": "Description" + } + ], + "signature": "static createCustomer(login: string, password: string, customerNo: string): Customer", + "source": "script-api", + "tags": [ + "createcustomer", + "customermgr.createcustomer" + ], + "title": "CustomerMgr.createCustomer" + }, + { + "description": "Given an authentication provider Id and an external Id: creates a Customer record in the system if one does not exist already for the same 'authenticationProviderId' and 'externalId' pair. If one already exists - it is returned.", + "id": "script-api:dw/customer/CustomerMgr#createExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createExternallyAuthenticatedCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Given an authentication provider Id and an external Id: creates a Customer record in the system if one does not\nexist already for the same 'authenticationProviderId' and 'externalId' pair. If one already exists - it is returned.", + "heading": "Description" + } + ], + "signature": "static createExternallyAuthenticatedCustomer(authenticationProviderId: string, externalId: string): Customer", + "source": "script-api", + "tags": [ + "createexternallyauthenticatedcustomer", + "customermgr.createexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.createExternallyAuthenticatedCustomer" + }, + { + "description": "Given an authentication provider Id and an external Id: creates a Customer record in the system if one does not exist already for the same 'authenticationProviderId' and 'externalId' pair. If one already exists - it is returned.", + "id": "script-api:dw/customer/CustomerMgr#createExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.createExternallyAuthenticatedCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Given an authentication provider Id and an external Id: creates a Customer record in the system if one does not\nexist already for the same 'authenticationProviderId' and 'externalId' pair. If one already exists - it is returned.", + "heading": "Description" + } + ], + "signature": "static createExternallyAuthenticatedCustomer(authenticationProviderId: string, externalId: string): Customer", + "source": "script-api", + "tags": [ + "createexternallyauthenticatedcustomer", + "customermgr.createexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.createExternallyAuthenticatedCustomer" + }, + { + "description": "Returns the customer groups of the current site.", + "id": "script-api:dw/customer/CustomerMgr#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.customerGroups", + "sections": [ + { + "body": "Returns the customer groups of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "customermgr.customergroups" + ], + "title": "CustomerMgr.customerGroups" + }, + { + "description": "Returns the customer groups of the current site.", + "id": "script-api:dw/customer/CustomerMgr#customerGroups", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.customerGroups", + "sections": [ + { + "body": "Returns the customer groups of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "customermgr.customergroups" + ], + "title": "CustomerMgr.customerGroups" + }, + { + "description": "Returns the meta data for profiles.", + "id": "script-api:dw/customer/CustomerMgr#describeProfileType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.describeProfileType", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for profiles.", + "heading": "Description" + } + ], + "signature": "static describeProfileType(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describeprofiletype", + "customermgr.describeprofiletype" + ], + "title": "CustomerMgr.describeProfileType" + }, + { + "description": "Returns the meta data for profiles.", + "id": "script-api:dw/customer/CustomerMgr#describeProfileType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.describeProfileType", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for profiles.", + "heading": "Description" + } + ], + "signature": "static describeProfileType(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describeprofiletype", + "customermgr.describeprofiletype" + ], + "title": "CustomerMgr.describeProfileType" + }, + { + "description": "Returns the customer with the specified customer number. If no customer with this customer number exists, null is returned.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByCustomerNumber", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByCustomerNumber", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer with the specified customer number. If no customer with this customer number exists, null is returned.", + "heading": "Description" + } + ], + "signature": "static getCustomerByCustomerNumber(customerNumber: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbycustomernumber", + "customermgr.getcustomerbycustomernumber" + ], + "title": "CustomerMgr.getCustomerByCustomerNumber" + }, + { + "description": "Returns the customer with the specified customer number. If no customer with this customer number exists, null is returned.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByCustomerNumber", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByCustomerNumber", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer with the specified customer number. If no customer with this customer number exists, null is returned.", + "heading": "Description" + } + ], + "signature": "static getCustomerByCustomerNumber(customerNumber: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbycustomernumber", + "customermgr.getcustomerbycustomernumber" + ], + "title": "CustomerMgr.getCustomerByCustomerNumber" + }, + { + "description": "Returns the customer for the specified login name. If no customer with this login name exists, null is returned.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByLogin", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByLogin", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer for the specified login name. If no customer with this login name exists, null is returned.", + "heading": "Description" + } + ], + "signature": "static getCustomerByLogin(login: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbylogin", + "customermgr.getcustomerbylogin" + ], + "title": "CustomerMgr.getCustomerByLogin" + }, + { + "description": "Returns the customer for the specified login name. If no customer with this login name exists, null is returned.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByLogin", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByLogin", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer for the specified login name. If no customer with this login name exists, null is returned.", + "heading": "Description" + } + ], + "signature": "static getCustomerByLogin(login: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbylogin", + "customermgr.getcustomerbylogin" + ], + "title": "CustomerMgr.getCustomerByLogin" + }, + { + "description": "Returns the customer associated with the specified password reset token. A valid token is one that is associated with a customer record and is not expired. Such a token can be generated by dw.customer.Credentials.createResetPasswordToken. If the passed token is valid, the associated customer is returned. Otherwise `null` is returned", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByToken", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "token", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByToken", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer associated with the specified password reset token. A valid token is one that is associated\nwith a customer record and is not expired. Such a token can be generated by\ndw.customer.Credentials.createResetPasswordToken. If the passed token is valid, the associated customer\nis returned. Otherwise `null` is returned", + "heading": "Description" + } + ], + "signature": "static getCustomerByToken(token: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbytoken", + "customermgr.getcustomerbytoken" + ], + "title": "CustomerMgr.getCustomerByToken" + }, + { + "description": "Returns the customer associated with the specified password reset token. A valid token is one that is associated with a customer record and is not expired. Such a token can be generated by dw.customer.Credentials.createResetPasswordToken. If the passed token is valid, the associated customer is returned. Otherwise `null` is returned", + "id": "script-api:dw/customer/CustomerMgr#getCustomerByToken", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "token", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerByToken", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer associated with the specified password reset token. A valid token is one that is associated\nwith a customer record and is not expired. Such a token can be generated by\ndw.customer.Credentials.createResetPasswordToken. If the passed token is valid, the associated customer\nis returned. Otherwise `null` is returned", + "heading": "Description" + } + ], + "signature": "static getCustomerByToken(token: string): Customer | null", + "source": "script-api", + "tags": [ + "getcustomerbytoken", + "customermgr.getcustomerbytoken" + ], + "title": "CustomerMgr.getCustomerByToken" + }, + { + "description": "Returns the customer group with the specified ID or null if group does not exists.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroup", + "returns": { + "type": "CustomerGroup | null" + }, + "sections": [ + { + "body": "Returns the customer group with the specified ID or null if group\ndoes not exists.", + "heading": "Description" + } + ], + "signature": "static getCustomerGroup(id: string): CustomerGroup | null", + "source": "script-api", + "tags": [ + "getcustomergroup", + "customermgr.getcustomergroup" + ], + "title": "CustomerMgr.getCustomerGroup" + }, + { + "description": "Returns the customer group with the specified ID or null if group does not exists.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroup", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroup", + "returns": { + "type": "CustomerGroup | null" + }, + "sections": [ + { + "body": "Returns the customer group with the specified ID or null if group\ndoes not exists.", + "heading": "Description" + } + ], + "signature": "static getCustomerGroup(id: string): CustomerGroup | null", + "source": "script-api", + "tags": [ + "getcustomergroup", + "customermgr.getcustomergroup" + ], + "title": "CustomerMgr.getCustomerGroup" + }, + { + "description": "Returns the customer groups of the current site.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups of the current site.", + "heading": "Description" + } + ], + "signature": "static getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "customermgr.getcustomergroups" + ], + "title": "CustomerMgr.getCustomerGroups" + }, + { + "description": "Returns the customer groups of the current site.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerGroups", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups of the current site.", + "heading": "Description" + } + ], + "signature": "static getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "customermgr.getcustomergroups" + ], + "title": "CustomerMgr.getCustomerGroups" + }, + { + "description": "Returns the customer list identified by the specified ID. Returns null if no customer list with the specified id exists.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerList", + "returns": { + "type": "CustomerList | null" + }, + "sections": [ + { + "body": "Returns the customer list identified by the specified ID.\nReturns null if no customer list with the specified id exists.\n\nNote: Typically the ID of an automatically created customer\nlist is equal to the ID of the site.", + "heading": "Description" + } + ], + "signature": "static getCustomerList(id: string): CustomerList | null", + "source": "script-api", + "tags": [ + "getcustomerlist", + "customermgr.getcustomerlist" + ], + "title": "CustomerMgr.getCustomerList" + }, + { + "description": "Returns the customer list identified by the specified ID. Returns null if no customer list with the specified id exists.", + "id": "script-api:dw/customer/CustomerMgr#getCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getCustomerList", + "returns": { + "type": "CustomerList | null" + }, + "sections": [ + { + "body": "Returns the customer list identified by the specified ID.\nReturns null if no customer list with the specified id exists.\n\nNote: Typically the ID of an automatically created customer\nlist is equal to the ID of the site.", + "heading": "Description" + } + ], + "signature": "static getCustomerList(id: string): CustomerList | null", + "source": "script-api", + "tags": [ + "getcustomerlist", + "customermgr.getcustomerlist" + ], + "title": "CustomerMgr.getCustomerList" + }, + { + "description": "Given an authentication provider Id and external Id returns the Customer Profile in our system.", + "id": "script-api:dw/customer/CustomerMgr#getExternallyAuthenticatedCustomerProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getExternallyAuthenticatedCustomerProfile", + "returns": { + "type": "Profile | null" + }, + "sections": [ + { + "body": "Given an authentication provider Id and external Id returns the Customer Profile\nin our system.", + "heading": "Description" + } + ], + "signature": "static getExternallyAuthenticatedCustomerProfile(authenticationProviderId: string, externalId: string): Profile | null", + "source": "script-api", + "tags": [ + "getexternallyauthenticatedcustomerprofile", + "customermgr.getexternallyauthenticatedcustomerprofile" + ], + "title": "CustomerMgr.getExternallyAuthenticatedCustomerProfile" + }, + { + "description": "Given an authentication provider Id and external Id returns the Customer Profile in our system.", + "id": "script-api:dw/customer/CustomerMgr#getExternallyAuthenticatedCustomerProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getExternallyAuthenticatedCustomerProfile", + "returns": { + "type": "Profile | null" + }, + "sections": [ + { + "body": "Given an authentication provider Id and external Id returns the Customer Profile\nin our system.", + "heading": "Description" + } + ], + "signature": "static getExternallyAuthenticatedCustomerProfile(authenticationProviderId: string, externalId: string): Profile | null", + "source": "script-api", + "tags": [ + "getexternallyauthenticatedcustomerprofile", + "customermgr.getexternallyauthenticatedcustomerprofile" + ], + "title": "CustomerMgr.getExternallyAuthenticatedCustomerProfile" + }, + { + "description": "Returns an instance of CustomerPasswordConstraints for the customer list assigned to the current site.", + "id": "script-api:dw/customer/CustomerMgr#getPasswordConstraints", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getPasswordConstraints", + "returns": { + "type": "CustomerPasswordConstraints" + }, + "sections": [ + { + "body": "Returns an instance of CustomerPasswordConstraints\nfor the customer list assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static getPasswordConstraints(): CustomerPasswordConstraints", + "source": "script-api", + "tags": [ + "getpasswordconstraints", + "customermgr.getpasswordconstraints" + ], + "title": "CustomerMgr.getPasswordConstraints" + }, + { + "description": "Returns an instance of CustomerPasswordConstraints for the customer list assigned to the current site.", + "id": "script-api:dw/customer/CustomerMgr#getPasswordConstraints", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getPasswordConstraints", + "returns": { + "type": "CustomerPasswordConstraints" + }, + "sections": [ + { + "body": "Returns an instance of CustomerPasswordConstraints\nfor the customer list assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static getPasswordConstraints(): CustomerPasswordConstraints", + "source": "script-api", + "tags": [ + "getpasswordconstraints", + "customermgr.getpasswordconstraints" + ], + "title": "CustomerMgr.getPasswordConstraints" + }, + { + "description": "Returns the profile with the specified customer number.", + "id": "script-api:dw/customer/CustomerMgr#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Returns the profile with the specified customer number.", + "heading": "Description" + } + ], + "signature": "static getProfile(customerNumber: string): Profile", + "source": "script-api", + "tags": [ + "getprofile", + "customermgr.getprofile" + ], + "title": "CustomerMgr.getProfile" + }, + { + "description": "Returns the profile with the specified customer number.", + "id": "script-api:dw/customer/CustomerMgr#getProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Returns the profile with the specified customer number.", + "heading": "Description" + } + ], + "signature": "static getProfile(customerNumber: string): Profile", + "source": "script-api", + "tags": [ + "getprofile", + "customermgr.getprofile" + ], + "title": "CustomerMgr.getProfile" + }, + { + "description": "Returns the number of registered customers in the system. This number can be used for reporting purposes.", + "id": "script-api:dw/customer/CustomerMgr#getRegisteredCustomerCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getRegisteredCustomerCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of registered customers in the system. This number can be used for reporting\npurposes.", + "heading": "Description" + } + ], + "signature": "static getRegisteredCustomerCount(): number", + "source": "script-api", + "tags": [ + "getregisteredcustomercount", + "customermgr.getregisteredcustomercount" + ], + "title": "CustomerMgr.getRegisteredCustomerCount" + }, + { + "description": "Returns the number of registered customers in the system. This number can be used for reporting purposes.", + "id": "script-api:dw/customer/CustomerMgr#getRegisteredCustomerCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getRegisteredCustomerCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of registered customers in the system. This number can be used for reporting\npurposes.", + "heading": "Description" + } + ], + "signature": "static getRegisteredCustomerCount(): number", + "source": "script-api", + "tags": [ + "getregisteredcustomercount", + "customermgr.getregisteredcustomercount" + ], + "title": "CustomerMgr.getRegisteredCustomerCount" + }, + { + "description": "Returns the customer list of the current site.", + "id": "script-api:dw/customer/CustomerMgr#getSiteCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getSiteCustomerList", + "returns": { + "type": "CustomerList" + }, + "sections": [ + { + "body": "Returns the customer list of the current site.", + "heading": "Description" + } + ], + "signature": "static getSiteCustomerList(): CustomerList", + "source": "script-api", + "tags": [ + "getsitecustomerlist", + "customermgr.getsitecustomerlist" + ], + "title": "CustomerMgr.getSiteCustomerList" + }, + { + "description": "Returns the customer list of the current site.", + "id": "script-api:dw/customer/CustomerMgr#getSiteCustomerList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.getSiteCustomerList", + "returns": { + "type": "CustomerList" + }, + "sections": [ + { + "body": "Returns the customer list of the current site.", + "heading": "Description" + } + ], + "signature": "static getSiteCustomerList(): CustomerList", + "source": "script-api", + "tags": [ + "getsitecustomerlist", + "customermgr.getsitecustomerlist" + ], + "title": "CustomerMgr.getSiteCustomerList" + }, + { + "description": "Checks if the given password matches the password constraints (for example password length) of the current site's assigned customerlist.", + "id": "script-api:dw/customer/CustomerMgr#isAcceptablePassword", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isAcceptablePassword", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if the given password matches the password constraints (for example password length) of\nthe current site's assigned customerlist.", + "heading": "Description" + } + ], + "signature": "static isAcceptablePassword(password: string): boolean", + "source": "script-api", + "tags": [ + "isacceptablepassword", + "customermgr.isacceptablepassword" + ], + "title": "CustomerMgr.isAcceptablePassword" + }, + { + "description": "Checks if the given password matches the password constraints (for example password length) of the current site's assigned customerlist.", + "id": "script-api:dw/customer/CustomerMgr#isAcceptablePassword", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isAcceptablePassword", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if the given password matches the password constraints (for example password length) of\nthe current site's assigned customerlist.", + "heading": "Description" + } + ], + "signature": "static isAcceptablePassword(password: string): boolean", + "source": "script-api", + "tags": [ + "isacceptablepassword", + "customermgr.isacceptablepassword" + ], + "title": "CustomerMgr.isAcceptablePassword" + }, + { + "description": "Checks if the password for the given customer is expired", + "id": "script-api:dw/customer/CustomerMgr#isPasswordExpired", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isPasswordExpired", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if the password for the given customer is expired", + "heading": "Description" + } + ], + "signature": "static isPasswordExpired(login: string): boolean", + "source": "script-api", + "tags": [ + "ispasswordexpired", + "customermgr.ispasswordexpired" + ], + "title": "CustomerMgr.isPasswordExpired" + }, + { + "description": "Checks if the password for the given customer is expired", + "id": "script-api:dw/customer/CustomerMgr#isPasswordExpired", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.isPasswordExpired", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if the password for the given customer is expired", + "heading": "Description" + } + ], + "signature": "static isPasswordExpired(login: string): boolean", + "source": "script-api", + "tags": [ + "ispasswordexpired", + "customermgr.ispasswordexpired" + ], + "title": "CustomerMgr.isPasswordExpired" + }, + { + "deprecated": { + "message": "use authenticateCustomer(login, password) and loginCustomer(authStatus, rememberMe) instead since they correctly check for expired passwords" + }, + "description": "This method authenticates the current session using the supplied login and password. If a different customer is currently authenticated in the session, then this customer is \"logged out\" and her/his privacy and form data are deleted. If the authentication with the given credentials fails, then null is returned and no changes to the session are made. The authentication will be sucessful even when the password of the customer is already expired (according to the customer list settings).", + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "This method authenticates the current session using the supplied login and password. If a different customer is currently authenticated in the session, then this\ncustomer is \"logged out\" and her/his privacy and form data are deleted. If the authentication with the given credentials fails, then null is returned and no changes\nto the session are made. The authentication will be sucessful even when the password of the customer is already expired (according to the customer list settings).\n\nIf the input value \"RememberMe\" is set to true, this method stores a cookie on the customer's machine which will be used to identify the customer when the next\nsession is initiated. The cookie is set to expire in 180 days (i.e. 6 months). Note that a customer who is remembered is not automatically authenticated and will\nhave to explicitly log in to access any personal information.", + "heading": "Description" + } + ], + "signature": "static loginCustomer(login: string, password: string, rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "description": "This method logs in the authenticated customer (from a previous authenticateCustomer() call). If a different customer is currently authenticated in the session, then this customer is \"logged out\" and all privacy-relevant data and all form data are deleted. If the previous authentication was not successful, then null is returned and no changes to the session are made.", + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authStatus", + "type": "AuthenticationStatus" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "This method logs in the authenticated customer (from a previous authenticateCustomer() call). If a different customer is currently authenticated in the session, then this\ncustomer is \"logged out\" and all privacy-relevant data and all form data are deleted. If the previous authentication was not successful, then null is returned and no changes\nto the session are made.\n\nIf the input value \"RememberMe\" is set to true, this method stores a cookie on the customer's machine which will be used to identify the customer when the next\nsession is initiated. The cookie is set to expire in 180 days (i.e. 6 months). Note that a customer who is remembered is not automatically authenticated and will\nhave to explicitly log in to access any personal information.", + "heading": "Description" + } + ], + "signature": "static loginCustomer(authStatus: AuthenticationStatus, rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "deprecated": { + "message": "use authenticateCustomer(login, password) and loginCustomer(authStatus, rememberMe) instead since they correctly check for expired passwords" + }, + "description": "This method authenticates the current session using the supplied login and password. If a different customer is currently authenticated in the session, then this customer is \"logged out\" and her/his privacy and form data are deleted. If the authentication with the given credentials fails, then null is returned and no changes to the session are made. The authentication will be sucessful even when the password of the customer is already expired (according to the customer list settings).", + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "login", + "type": "string" + }, + { + "name": "password", + "type": "string" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "This method authenticates the current session using the supplied login and password. If a different customer is currently authenticated in the session, then this\ncustomer is \"logged out\" and her/his privacy and form data are deleted. If the authentication with the given credentials fails, then null is returned and no changes\nto the session are made. The authentication will be sucessful even when the password of the customer is already expired (according to the customer list settings).\n\nIf the input value \"RememberMe\" is set to true, this method stores a cookie on the customer's machine which will be used to identify the customer when the next\nsession is initiated. The cookie is set to expire in 180 days (i.e. 6 months). Note that a customer who is remembered is not automatically authenticated and will\nhave to explicitly log in to access any personal information.", + "heading": "Description" + } + ], + "signature": "static loginCustomer(login: string, password: string, rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "description": "This method logs in the authenticated customer (from a previous authenticateCustomer() call). If a different customer is currently authenticated in the session, then this customer is \"logged out\" and all privacy-relevant data and all form data are deleted. If the previous authentication was not successful, then null is returned and no changes to the session are made.", + "id": "script-api:dw/customer/CustomerMgr#loginCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authStatus", + "type": "AuthenticationStatus" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "This method logs in the authenticated customer (from a previous authenticateCustomer() call). If a different customer is currently authenticated in the session, then this\ncustomer is \"logged out\" and all privacy-relevant data and all form data are deleted. If the previous authentication was not successful, then null is returned and no changes\nto the session are made.\n\nIf the input value \"RememberMe\" is set to true, this method stores a cookie on the customer's machine which will be used to identify the customer when the next\nsession is initiated. The cookie is set to expire in 180 days (i.e. 6 months). Note that a customer who is remembered is not automatically authenticated and will\nhave to explicitly log in to access any personal information.", + "heading": "Description" + } + ], + "signature": "static loginCustomer(authStatus: AuthenticationStatus, rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logincustomer", + "customermgr.logincustomer" + ], + "title": "CustomerMgr.loginCustomer" + }, + { + "description": "Logs in externally authenticated customer if it has already been created in the system and the profile is not disabled or locked", + "id": "script-api:dw/customer/CustomerMgr#loginExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginExternallyAuthenticatedCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Logs in externally authenticated customer if it has already been created in the system and the profile is not disabled or locked", + "heading": "Description" + } + ], + "signature": "static loginExternallyAuthenticatedCustomer(authenticationProviderId: string, externalId: string, rememberMe: boolean): Customer", + "source": "script-api", + "tags": [ + "loginexternallyauthenticatedcustomer", + "customermgr.loginexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.loginExternallyAuthenticatedCustomer" + }, + { + "description": "Logs in externally authenticated customer if it has already been created in the system and the profile is not disabled or locked", + "id": "script-api:dw/customer/CustomerMgr#loginExternallyAuthenticatedCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "authenticationProviderId", + "type": "string" + }, + { + "name": "externalId", + "type": "string" + }, + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.loginExternallyAuthenticatedCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Logs in externally authenticated customer if it has already been created in the system and the profile is not disabled or locked", + "heading": "Description" + } + ], + "signature": "static loginExternallyAuthenticatedCustomer(authenticationProviderId: string, externalId: string, rememberMe: boolean): Customer", + "source": "script-api", + "tags": [ + "loginexternallyauthenticatedcustomer", + "customermgr.loginexternallyauthenticatedcustomer" + ], + "title": "CustomerMgr.loginExternallyAuthenticatedCustomer" + }, + { + "description": "Logs out the customer currently logged into the storefront. The boolean value \"RememberMe\" indicates, if the customer would like to be remembered on the current browser. If a value of true is supplied, the customer authentication state is set to \"not logged in\" and additionally the following session data is removed: the customer session private data, the form status data, dictionary information of interaction continue nodes, basket reference information, the secure token cookie. If the value is set to false or null, the complete session dictionary is cleaned up. The customer and anonymous cookie are removed and a new session cookie is set.", + "id": "script-api:dw/customer/CustomerMgr#logoutCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.logoutCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Logs out the customer currently logged into the storefront. The boolean value \"RememberMe\" indicates, if the customer would like to be remembered on the current\nbrowser. If a value of true is supplied, the customer authentication state is set to \"not logged in\" and additionally the following session data is removed: the customer\nsession private data, the form status data, dictionary information of interaction continue nodes, basket reference information, the secure token cookie. If the value is set\nto false or null, the complete session dictionary is cleaned up. The customer and anonymous cookie are removed and a new session cookie is set.", + "heading": "Description" + } + ], + "signature": "static logoutCustomer(rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logoutcustomer", + "customermgr.logoutcustomer" + ], + "title": "CustomerMgr.logoutCustomer" + }, + { + "description": "Logs out the customer currently logged into the storefront. The boolean value \"RememberMe\" indicates, if the customer would like to be remembered on the current browser. If a value of true is supplied, the customer authentication state is set to \"not logged in\" and additionally the following session data is removed: the customer session private data, the form status data, dictionary information of interaction continue nodes, basket reference information, the secure token cookie. If the value is set to false or null, the complete session dictionary is cleaned up. The customer and anonymous cookie are removed and a new session cookie is set.", + "id": "script-api:dw/customer/CustomerMgr#logoutCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "rememberMe", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.logoutCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Logs out the customer currently logged into the storefront. The boolean value \"RememberMe\" indicates, if the customer would like to be remembered on the current\nbrowser. If a value of true is supplied, the customer authentication state is set to \"not logged in\" and additionally the following session data is removed: the customer\nsession private data, the form status data, dictionary information of interaction continue nodes, basket reference information, the secure token cookie. If the value is set\nto false or null, the complete session dictionary is cleaned up. The customer and anonymous cookie are removed and a new session cookie is set.", + "heading": "Description" + } + ], + "signature": "static logoutCustomer(rememberMe: boolean): Customer | null", + "source": "script-api", + "tags": [ + "logoutcustomer", + "customermgr.logoutcustomer" + ], + "title": "CustomerMgr.logoutCustomer" + }, + { + "description": "Returns an instance of CustomerPasswordConstraints for the customer list assigned to the current site.", + "id": "script-api:dw/customer/CustomerMgr#passwordConstraints", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.passwordConstraints", + "sections": [ + { + "body": "Returns an instance of CustomerPasswordConstraints\nfor the customer list assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static readonly passwordConstraints: CustomerPasswordConstraints", + "source": "script-api", + "tags": [ + "passwordconstraints", + "customermgr.passwordconstraints" + ], + "title": "CustomerMgr.passwordConstraints" + }, + { + "description": "Returns an instance of CustomerPasswordConstraints for the customer list assigned to the current site.", + "id": "script-api:dw/customer/CustomerMgr#passwordConstraints", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.passwordConstraints", + "sections": [ + { + "body": "Returns an instance of CustomerPasswordConstraints\nfor the customer list assigned to the current site.", + "heading": "Description" + } + ], + "signature": "static readonly passwordConstraints: CustomerPasswordConstraints", + "source": "script-api", + "tags": [ + "passwordconstraints", + "customermgr.passwordconstraints" + ], + "title": "CustomerMgr.passwordConstraints" + }, + { + "description": "Executes a user-definable function on a set of customer profiles. This method is intended to be used in batch processes and jobs, since it allows efficient processing of large result sets (which might take a while to process).", + "id": "script-api:dw/customer/CustomerMgr#processProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.processProfiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Executes a user-definable function on a set of customer profiles. This method is intended to be used in batch processes and jobs,\nsince it allows efficient processing of large result sets (which might take a while to process).\n\nFirst, a search with the given parameters is executed. Then the given function is executed once for each profile of the search result.\nThe profile is handed over as the only parameter to this function.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the queryProfile method.\n\nThe callback function will be supplied with a single argument of type 'Profile'. When the callback function defines\nadditional arguments, they will be undefined when the function is called. When the callback function doesn't define\nany arguments at all, it will be called anyway (no error will happen, but the function won't get a profile as parameter).\n\nError during execution of the callback function will be logged, and execution will continue with the next element from the\nresult set.\n\nThis method can be used as in this example (which counts the number of men):", + "heading": "Description" + } + ], + "signature": "static processProfiles(processFunction: Function, queryString: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "processprofiles", + "customermgr.processprofiles" + ], + "title": "CustomerMgr.processProfiles" + }, + { + "description": "Executes a user-definable function on a set of customer profiles. This method is intended to be used in batch processes and jobs, since it allows efficient processing of large result sets (which might take a while to process).", + "id": "script-api:dw/customer/CustomerMgr#processProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.processProfiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Executes a user-definable function on a set of customer profiles. This method is intended to be used in batch processes and jobs,\nsince it allows efficient processing of large result sets (which might take a while to process).\n\nFirst, a search with the given parameters is executed. Then the given function is executed once for each profile of the search result.\nThe profile is handed over as the only parameter to this function.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the queryProfile method.\n\nThe callback function will be supplied with a single argument of type 'Profile'. When the callback function defines\nadditional arguments, they will be undefined when the function is called. When the callback function doesn't define\nany arguments at all, it will be called anyway (no error will happen, but the function won't get a profile as parameter).\n\nError during execution of the callback function will be logged, and execution will continue with the next element from the\nresult set.\n\nThis method can be used as in this example (which counts the number of men):", + "heading": "Description" + } + ], + "signature": "static processProfiles(processFunction: Function, queryString: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "processprofiles", + "customermgr.processprofiles" + ], + "title": "CustomerMgr.processProfiles" + }, + { + "deprecated": { + "message": "use searchProfile instead." + }, + "description": "Searches for a single profile instance.", + "id": "script-api:dw/customer/CustomerMgr#queryProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Searches for a single profile instance.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the\nresult is not deterministic. In order to retrieve a single object from a sorted result\nset it is recommended to use the following code:\n`queryProfiles(\"\", \"custom.myAttr asc\", null).first()`.\nThe method `first()` returns only the next element and closes the\niterator.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfile(queryString: string, args?: any[]): Profile", + "source": "script-api", + "tags": [ + "queryprofile", + "customermgr.queryprofile" + ], + "title": "CustomerMgr.queryProfile" + }, + { + "deprecated": { + "message": "use searchProfile instead." + }, + "description": "Searches for a single profile instance.", + "id": "script-api:dw/customer/CustomerMgr#queryProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Searches for a single profile instance.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the\nresult is not deterministic. In order to retrieve a single object from a sorted result\nset it is recommended to use the following code:\n`queryProfiles(\"\", \"custom.myAttr asc\", null).first()`.\nThe method `first()` returns only the next element and closes the\niterator.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfile(queryString: string, args?: any[]): Profile", + "source": "script-api", + "tags": [ + "queryprofile", + "customermgr.queryprofile" + ], + "title": "CustomerMgr.queryProfile" + }, + { + "deprecated": { + "message": "use searchProfiles instead." + }, + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the queryProfile method.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfiles(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "deprecated": { + "message": "use searchProfiles instead." + }, + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.\nSee dw.util.SeekableIterator.close\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfiles(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "deprecated": { + "message": "use searchProfiles instead." + }, + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the queryProfile method.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfiles(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "deprecated": { + "message": "use searchProfiles instead." + }, + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#queryProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.queryProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.\nSee dw.util.SeekableIterator.close\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchProfile,\nsearchProfiles and\nsearchProfiles to search for customers and\nprocessProfiles to search and process customers in jobs.", + "heading": "Description" + } + ], + "signature": "static queryProfiles(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryprofiles", + "customermgr.queryprofiles" + ], + "title": "CustomerMgr.queryProfiles" + }, + { + "description": "Returns the number of registered customers in the system. This number can be used for reporting purposes.", + "id": "script-api:dw/customer/CustomerMgr#registeredCustomerCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.registeredCustomerCount", + "sections": [ + { + "body": "Returns the number of registered customers in the system. This number can be used for reporting\npurposes.", + "heading": "Description" + } + ], + "signature": "static readonly registeredCustomerCount: number", + "source": "script-api", + "tags": [ + "registeredcustomercount", + "customermgr.registeredcustomercount" + ], + "title": "CustomerMgr.registeredCustomerCount" + }, + { + "description": "Returns the number of registered customers in the system. This number can be used for reporting purposes.", + "id": "script-api:dw/customer/CustomerMgr#registeredCustomerCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.registeredCustomerCount", + "sections": [ + { + "body": "Returns the number of registered customers in the system. This number can be used for reporting\npurposes.", + "heading": "Description" + } + ], + "signature": "static readonly registeredCustomerCount: number", + "source": "script-api", + "tags": [ + "registeredcustomercount", + "customermgr.registeredcustomercount" + ], + "title": "CustomerMgr.registeredCustomerCount" + }, + { + "description": "Logs out the supplied customer and deletes the customer record. The customer must be a registered customer and the customer must currently be logged in. The customer must be logged in for security reasons to ensure that only the customer itself can remove itself from the system. While logout the customers session is reset to an anonymous session and, if present, the \"Remember me\" cookie of the customer is removed. Deleting the customer record includes the customer credentials, profile, address-book with all addresses, customer payment instruments, product lists and memberships in customer groups. Orders placed by this customer won't be deleted. If the supplied customer is not a registered customer or is not logged in, the API throws an exception", + "id": "script-api:dw/customer/CustomerMgr#removeCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Logs out the supplied customer and deletes the customer record. The customer must be a registered customer and the customer must currently be logged in. The customer must be\nlogged in for security reasons to ensure that only the customer itself can remove itself from the system. While logout the customers session is reset to an anonymous session and, if present, the \"Remember me\" cookie of the customer is removed.\nDeleting the customer record includes the customer credentials, profile, address-book with all addresses, customer payment instruments, product lists and memberships in\ncustomer groups. Orders placed by this customer won't be deleted. If the supplied customer is not a registered customer or is not logged in, the API throws an exception", + "heading": "Description" + } + ], + "signature": "static removeCustomer(customer: Customer): void", + "source": "script-api", + "tags": [ + "removecustomer", + "customermgr.removecustomer" + ], + "title": "CustomerMgr.removeCustomer" + }, + { + "description": "Logs out the supplied customer and deletes the customer record. The customer must be a registered customer and the customer must currently be logged in. The customer must be logged in for security reasons to ensure that only the customer itself can remove itself from the system. While logout the customers session is reset to an anonymous session and, if present, the \"Remember me\" cookie of the customer is removed. Deleting the customer record includes the customer credentials, profile, address-book with all addresses, customer payment instruments, product lists and memberships in customer groups. Orders placed by this customer won't be deleted. If the supplied customer is not a registered customer or is not logged in, the API throws an exception", + "id": "script-api:dw/customer/CustomerMgr#removeCustomer", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Logs out the supplied customer and deletes the customer record. The customer must be a registered customer and the customer must currently be logged in. The customer must be\nlogged in for security reasons to ensure that only the customer itself can remove itself from the system. While logout the customers session is reset to an anonymous session and, if present, the \"Remember me\" cookie of the customer is removed.\nDeleting the customer record includes the customer credentials, profile, address-book with all addresses, customer payment instruments, product lists and memberships in\ncustomer groups. Orders placed by this customer won't be deleted. If the supplied customer is not a registered customer or is not logged in, the API throws an exception", + "heading": "Description" + } + ], + "signature": "static removeCustomer(customer: Customer): void", + "source": "script-api", + "tags": [ + "removecustomer", + "customermgr.removecustomer" + ], + "title": "CustomerMgr.removeCustomer" + }, + { + "description": "Removes (asynchronously) tracking data for this customer (from external systems or data stores). This will not remove the customer from the database, nor will it prevent tracking to start again in the future for this customer.", + "id": "script-api:dw/customer/CustomerMgr#removeCustomerTrackingData", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomerTrackingData", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes (asynchronously) tracking data for this customer (from external systems or data stores). This will not remove the\ncustomer from the database, nor will it prevent tracking to start again in the future for this customer.\n\nThe customer is identified by login / email /customerNo / cookie when its a registered customer, and by cookie\nwhen its an anonymous customer.", + "heading": "Description" + } + ], + "signature": "static removeCustomerTrackingData(customer: Customer): void", + "source": "script-api", + "tags": [ + "removecustomertrackingdata", + "customermgr.removecustomertrackingdata" + ], + "title": "CustomerMgr.removeCustomerTrackingData" + }, + { + "description": "Removes (asynchronously) tracking data for this customer (from external systems or data stores). This will not remove the customer from the database, nor will it prevent tracking to start again in the future for this customer.", + "id": "script-api:dw/customer/CustomerMgr#removeCustomerTrackingData", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.removeCustomerTrackingData", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes (asynchronously) tracking data for this customer (from external systems or data stores). This will not remove the\ncustomer from the database, nor will it prevent tracking to start again in the future for this customer.\n\nThe customer is identified by login / email /customerNo / cookie when its a registered customer, and by cookie\nwhen its an anonymous customer.", + "heading": "Description" + } + ], + "signature": "static removeCustomerTrackingData(customer: Customer): void", + "source": "script-api", + "tags": [ + "removecustomertrackingdata", + "customermgr.removecustomertrackingdata" + ], + "title": "CustomerMgr.removeCustomerTrackingData" + }, + { + "description": "Searches for a single profile instance.", + "id": "script-api:dw/customer/CustomerMgr#searchProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Searches for a single profile instance.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the\nresult is not deterministic. In order to retrieve a single object from a sorted result\nset it is recommended to use the following code:\n`queryProfiles(\"\", \"custom.myAttr asc\", null).first()`.\nThe method `first()` returns only the next element and closes the\niterator.\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined", + "heading": "Description" + } + ], + "signature": "static searchProfile(queryString: string, args?: any[]): Profile", + "source": "script-api", + "tags": [ + "searchprofile", + "customermgr.searchprofile" + ], + "title": "CustomerMgr.searchProfile" + }, + { + "description": "Searches for a single profile instance.", + "id": "script-api:dw/customer/CustomerMgr#searchProfile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfile", + "returns": { + "type": "Profile" + }, + "sections": [ + { + "body": "Searches for a single profile instance.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the\nresult is not deterministic. In order to retrieve a single object from a sorted result\nset it is recommended to use the following code:\n`queryProfiles(\"\", \"custom.myAttr asc\", null).first()`.\nThe method `first()` returns only the next element and closes the\niterator.\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined", + "heading": "Description" + } + ], + "signature": "static searchProfile(queryString: string, args?: any[]): Profile", + "source": "script-api", + "tags": [ + "searchprofile", + "customermgr.searchprofile" + ], + "title": "CustomerMgr.searchProfile" + }, + { + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the searchProfile method.\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The search returns only the first 1000 hits from the search result", + "heading": "Description" + } + ], + "signature": "static searchProfiles(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.\n\ndw.util.SeekableIterator.close\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The search returns only the first 1000 hits from the search result", + "heading": "Description" + } + ], + "signature": "static searchProfiles(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nFor a description of this query language, see the searchProfile method.\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The search returns only the first 1000 hits from the search result", + "heading": "Description" + } + ], + "signature": "static searchProfiles(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "description": "Searches for profile instances.", + "id": "script-api:dw/customer/CustomerMgr#searchProfiles", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.searchProfiles", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for profile instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.\n\ndw.util.SeekableIterator.close\n\nIf the customer search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Newly created customers might not be found immediately via the search service, and changes to existing\ncustomers might also not be in effect immediately (there is a slight delay in updating the index)\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches\n- LIKE queries are always case insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The search returns only the first 1000 hits from the search result", + "heading": "Description" + } + ], + "signature": "static searchProfiles(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "searchprofiles", + "customermgr.searchprofiles" + ], + "title": "CustomerMgr.searchProfiles" + }, + { + "description": "Returns the customer list of the current site.", + "id": "script-api:dw/customer/CustomerMgr#siteCustomerList", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.siteCustomerList", + "sections": [ + { + "body": "Returns the customer list of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly siteCustomerList: CustomerList", + "source": "script-api", + "tags": [ + "sitecustomerlist", + "customermgr.sitecustomerlist" + ], + "title": "CustomerMgr.siteCustomerList" + }, + { + "description": "Returns the customer list of the current site.", + "id": "script-api:dw/customer/CustomerMgr#siteCustomerList", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerMgr", + "qualifiedName": "dw.customer.CustomerMgr.siteCustomerList", + "sections": [ + { + "body": "Returns the customer list of the current site.", + "heading": "Description" + } + ], + "signature": "static readonly siteCustomerList: CustomerList", + "source": "script-api", + "tags": [ + "sitecustomerlist", + "customermgr.sitecustomerlist" + ], + "title": "CustomerMgr.siteCustomerList" + }, + { + "description": "Provides access to the constraints of customer passwords. An instance of this class can be obtained via CustomerMgr.getPasswordConstraints.", + "id": "script-api:dw/customer/CustomerPasswordConstraints", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerPasswordConstraints", + "sections": [ + { + "body": "Provides access to the constraints of customer passwords. An instance of this class can be obtained via CustomerMgr.getPasswordConstraints.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customerpasswordconstraints", + "dw.customer.customerpasswordconstraints", + "dw/customer" + ], + "title": "CustomerPasswordConstraints" + }, + { + "description": "Returns `true` if letters are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceLetters", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceLetters", + "sections": [ + { + "body": "Returns `true` if letters are enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceLetters: boolean", + "source": "script-api", + "tags": [ + "forceletters", + "customerpasswordconstraints.forceletters" + ], + "title": "CustomerPasswordConstraints.forceLetters" + }, + { + "description": "Returns `true` if letters are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceLetters", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceLetters", + "sections": [ + { + "body": "Returns `true` if letters are enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceLetters: boolean", + "source": "script-api", + "tags": [ + "forceletters", + "customerpasswordconstraints.forceletters" + ], + "title": "CustomerPasswordConstraints.forceLetters" + }, + { + "description": "Returns `true` if mixed case is enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceMixedCase", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceMixedCase", + "sections": [ + { + "body": "Returns `true` if mixed case is enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceMixedCase: boolean", + "source": "script-api", + "tags": [ + "forcemixedcase", + "customerpasswordconstraints.forcemixedcase" + ], + "title": "CustomerPasswordConstraints.forceMixedCase" + }, + { + "description": "Returns `true` if mixed case is enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceMixedCase", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceMixedCase", + "sections": [ + { + "body": "Returns `true` if mixed case is enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceMixedCase: boolean", + "source": "script-api", + "tags": [ + "forcemixedcase", + "customerpasswordconstraints.forcemixedcase" + ], + "title": "CustomerPasswordConstraints.forceMixedCase" + }, + { + "description": "Returns `true` if numbers are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceNumbers", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceNumbers", + "sections": [ + { + "body": "Returns `true` if numbers are enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceNumbers: boolean", + "source": "script-api", + "tags": [ + "forcenumbers", + "customerpasswordconstraints.forcenumbers" + ], + "title": "CustomerPasswordConstraints.forceNumbers" + }, + { + "description": "Returns `true` if numbers are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#forceNumbers", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.forceNumbers", + "sections": [ + { + "body": "Returns `true` if numbers are enforced.", + "heading": "Description" + } + ], + "signature": "static readonly forceNumbers: boolean", + "source": "script-api", + "tags": [ + "forcenumbers", + "customerpasswordconstraints.forcenumbers" + ], + "title": "CustomerPasswordConstraints.forceNumbers" + }, + { + "description": "Returns the minimum length.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinLength", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum length.", + "heading": "Description" + } + ], + "signature": "static getMinLength(): number", + "source": "script-api", + "tags": [ + "getminlength", + "customerpasswordconstraints.getminlength" + ], + "title": "CustomerPasswordConstraints.getMinLength" + }, + { + "description": "Returns the minimum length.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinLength", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum length.", + "heading": "Description" + } + ], + "signature": "static getMinLength(): number", + "source": "script-api", + "tags": [ + "getminlength", + "customerpasswordconstraints.getminlength" + ], + "title": "CustomerPasswordConstraints.getMinLength" + }, + { + "description": "Returns the minimum number of special characters.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinSpecialChars", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinSpecialChars", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum number of special characters.", + "heading": "Description" + } + ], + "signature": "static getMinSpecialChars(): number", + "source": "script-api", + "tags": [ + "getminspecialchars", + "customerpasswordconstraints.getminspecialchars" + ], + "title": "CustomerPasswordConstraints.getMinSpecialChars" + }, + { + "description": "Returns the minimum number of special characters.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#getMinSpecialChars", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.getMinSpecialChars", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum number of special characters.", + "heading": "Description" + } + ], + "signature": "static getMinSpecialChars(): number", + "source": "script-api", + "tags": [ + "getminspecialchars", + "customerpasswordconstraints.getminspecialchars" + ], + "title": "CustomerPasswordConstraints.getMinSpecialChars" + }, + { + "description": "Returns `true` if letters are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceLetters", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceLetters", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if letters are enforced.", + "heading": "Description" + } + ], + "signature": "static isForceLetters(): boolean", + "source": "script-api", + "tags": [ + "isforceletters", + "customerpasswordconstraints.isforceletters" + ], + "title": "CustomerPasswordConstraints.isForceLetters" + }, + { + "description": "Returns `true` if letters are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceLetters", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceLetters", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if letters are enforced.", + "heading": "Description" + } + ], + "signature": "static isForceLetters(): boolean", + "source": "script-api", + "tags": [ + "isforceletters", + "customerpasswordconstraints.isforceletters" + ], + "title": "CustomerPasswordConstraints.isForceLetters" + }, + { + "description": "Returns `true` if mixed case is enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceMixedCase", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceMixedCase", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if mixed case is enforced.", + "heading": "Description" + } + ], + "signature": "static isForceMixedCase(): boolean", + "source": "script-api", + "tags": [ + "isforcemixedcase", + "customerpasswordconstraints.isforcemixedcase" + ], + "title": "CustomerPasswordConstraints.isForceMixedCase" + }, + { + "description": "Returns `true` if mixed case is enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceMixedCase", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceMixedCase", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if mixed case is enforced.", + "heading": "Description" + } + ], + "signature": "static isForceMixedCase(): boolean", + "source": "script-api", + "tags": [ + "isforcemixedcase", + "customerpasswordconstraints.isforcemixedcase" + ], + "title": "CustomerPasswordConstraints.isForceMixedCase" + }, + { + "description": "Returns `true` if numbers are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceNumbers", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceNumbers", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if numbers are enforced.", + "heading": "Description" + } + ], + "signature": "static isForceNumbers(): boolean", + "source": "script-api", + "tags": [ + "isforcenumbers", + "customerpasswordconstraints.isforcenumbers" + ], + "title": "CustomerPasswordConstraints.isForceNumbers" + }, + { + "description": "Returns `true` if numbers are enforced.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#isForceNumbers", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.isForceNumbers", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if numbers are enforced.", + "heading": "Description" + } + ], + "signature": "static isForceNumbers(): boolean", + "source": "script-api", + "tags": [ + "isforcenumbers", + "customerpasswordconstraints.isforcenumbers" + ], + "title": "CustomerPasswordConstraints.isForceNumbers" + }, + { + "description": "Returns the minimum length.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#minLength", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minLength", + "sections": [ + { + "body": "Returns the minimum length.", + "heading": "Description" + } + ], + "signature": "static readonly minLength: number", + "source": "script-api", + "tags": [ + "minlength", + "customerpasswordconstraints.minlength" + ], + "title": "CustomerPasswordConstraints.minLength" + }, + { + "description": "Returns the minimum length.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#minLength", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minLength", + "sections": [ + { + "body": "Returns the minimum length.", + "heading": "Description" + } + ], + "signature": "static readonly minLength: number", + "source": "script-api", + "tags": [ + "minlength", + "customerpasswordconstraints.minlength" + ], + "title": "CustomerPasswordConstraints.minLength" + }, + { + "description": "Returns the minimum number of special characters.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#minSpecialChars", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minSpecialChars", + "sections": [ + { + "body": "Returns the minimum number of special characters.", + "heading": "Description" + } + ], + "signature": "static readonly minSpecialChars: number", + "source": "script-api", + "tags": [ + "minspecialchars", + "customerpasswordconstraints.minspecialchars" + ], + "title": "CustomerPasswordConstraints.minSpecialChars" + }, + { + "description": "Returns the minimum number of special characters.", + "id": "script-api:dw/customer/CustomerPasswordConstraints#minSpecialChars", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPasswordConstraints", + "qualifiedName": "dw.customer.CustomerPasswordConstraints.minSpecialChars", + "sections": [ + { + "body": "Returns the minimum number of special characters.", + "heading": "Description" + } + ], + "signature": "static readonly minSpecialChars: number", + "source": "script-api", + "tags": [ + "minspecialchars", + "customerpasswordconstraints.minspecialchars" + ], + "title": "CustomerPasswordConstraints.minSpecialChars" + }, + { + "description": "Represents any payment instrument stored in the customers profile, such as credit card or bank transfer. The object defines standard methods for credit card payment, and can be extended by attributes appropriate for other payment methods.", + "id": "script-api:dw/customer/CustomerPaymentInstrument", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerPaymentInstrument", + "sections": [ + { + "body": "Represents any payment instrument stored in the customers profile, such as\ncredit card or bank transfer. The object defines standard methods for credit\ncard payment, and can be extended by attributes appropriate for other\npayment methods.", + "heading": "Description" + }, + { + "body": "Extends `PaymentInstrument`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customerpaymentinstrument", + "dw.customer.customerpaymentinstrument", + "dw/customer" + ], + "title": "CustomerPaymentInstrument" + }, + { + "description": "Returns the driver's license number of the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.bankAccountDriversLicense", + "sections": [ + { + "body": "Returns the driver's license number of the bank account number\nif the calling context meets the following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is registered and authenticated, and the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS\n\nOtherwise, the method returns the masked driver's license number of the bank account.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountDriversLicense: string", + "source": "script-api", + "tags": [ + "bankaccountdriverslicense", + "customerpaymentinstrument.bankaccountdriverslicense" + ], + "title": "CustomerPaymentInstrument.bankAccountDriversLicense" + }, + { + "description": "Returns the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.bankAccountNumber", + "sections": [ + { + "body": "Returns the bank account number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request,\nthe current customer is registered and authenticated, the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS\n\nOtherwise, the method returns the masked bank account number.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountNumber: string", + "source": "script-api", + "tags": [ + "bankaccountnumber", + "customerpaymentinstrument.bankaccountnumber" + ], + "title": "CustomerPaymentInstrument.bankAccountNumber" + }, + { + "description": "Returns the decrypted credit card number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.creditCardNumber", + "sections": [ + { + "body": "Returns the decrypted credit card number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request,\nthe current customer is registered and authenticated, the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS.\n\nOtherwise, the method returns the masked credit card number.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "readonly creditCardNumber: string", + "source": "script-api", + "tags": [ + "creditcardnumber", + "customerpaymentinstrument.creditcardnumber" + ], + "title": "CustomerPaymentInstrument.creditCardNumber" + }, + { + "description": "Returns the driver's license number of the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getBankAccountDriversLicense", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the driver's license number of the bank account number\nif the calling context meets the following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is registered and authenticated, and the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS\n\nOtherwise, the method returns the masked driver's license number of the bank account.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicense(): string", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicense", + "customerpaymentinstrument.getbankaccountdriverslicense" + ], + "title": "CustomerPaymentInstrument.getBankAccountDriversLicense" + }, + { + "description": "Returns the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getBankAccountNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the bank account number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request,\nthe current customer is registered and authenticated, the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS\n\nOtherwise, the method returns the masked bank account number.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "getBankAccountNumber(): string", + "source": "script-api", + "tags": [ + "getbankaccountnumber", + "customerpaymentinstrument.getbankaccountnumber" + ], + "title": "CustomerPaymentInstrument.getBankAccountNumber" + }, + { + "description": "Returns the decrypted credit card number if the calling context meets the following criteria:", + "id": "script-api:dw/customer/CustomerPaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerPaymentInstrument", + "qualifiedName": "dw.customer.CustomerPaymentInstrument.getCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the decrypted credit card number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request,\nthe current customer is registered and authenticated, the payment\ninstrument is associated to the profile of the current customer, and\nthe current protocol is HTTPS.\n\nOtherwise, the method returns the masked credit card number.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + } + ], + "signature": "getCreditCardNumber(): string", + "source": "script-api", + "tags": [ + "getcreditcardnumber", + "customerpaymentinstrument.getcreditcardnumber" + ], + "title": "CustomerPaymentInstrument.getCreditCardNumber" + }, + { + "description": "CustomerStatusCodes contains constants representing status codes that can be used with a Status object to indicate the success or failure of an operation.", + "id": "script-api:dw/customer/CustomerStatusCodes", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.CustomerStatusCodes", + "sections": [ + { + "body": "CustomerStatusCodes contains constants representing\nstatus codes that can be used with a Status object to\nindicate the success or failure of an operation.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customerstatuscodes", + "dw.customer.customerstatuscodes", + "dw/customer" + ], + "title": "CustomerStatusCodes" + }, + { + "description": "Indicates that an error occurred when trying to perform an operation on an address that is currently associated with a product list.", + "id": "script-api:dw/customer/CustomerStatusCodes#CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerStatusCodes", + "qualifiedName": "dw.customer.CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "sections": [ + { + "body": "Indicates that an error occurred when trying to perform\nan operation on an address that is currently associated\nwith a product list.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST = \"CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST\"", + "source": "script-api", + "tags": [ + "customer_address_referenced_by_product_list", + "customerstatuscodes.customer_address_referenced_by_product_list" + ], + "title": "CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST" + }, + { + "description": "Indicates that an error occurred when trying to perform an operation on an address that is currently associated with a product list.", + "id": "script-api:dw/customer/CustomerStatusCodes#CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "kind": "constant", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/CustomerStatusCodes", + "qualifiedName": "dw.customer.CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST", + "sections": [ + { + "body": "Indicates that an error occurred when trying to perform\nan operation on an address that is currently associated\nwith a product list.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST = \"CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST\"", + "source": "script-api", + "tags": [ + "customer_address_referenced_by_product_list", + "customerstatuscodes.customer_address_referenced_by_product_list" + ], + "title": "CustomerStatusCodes.CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST" + }, + { + "description": "Defines a API base class for classes containing encrypted attributes like credit cards.", + "id": "script-api:dw/customer/EncryptedObject", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.EncryptedObject", + "sections": [ + { + "body": "Defines a API base class for classes containing\nencrypted attributes like credit cards.\n\nNote: this method handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "encryptedobject", + "dw.customer.encryptedobject", + "dw/customer" + ], + "title": "EncryptedObject" + }, + { + "description": "Represents the credentials of a customer.", + "id": "script-api:dw/customer/ExternalProfile", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ExternalProfile", + "sections": [ + { + "body": "Represents the credentials of a customer.\n\nSince 13.6 it is possible to have customers who are not authenticated through a\nlogin and password but through an external authentication provider via the OAuth2 protocol.\n\nIn such cases, the AuthenticationProviderID will point to an OAuth provider configured in the system\nand the ExternalID will be the unique identifier of the customer on the Authentication Provider's system.\n\nFor example, if an authentication provider with ID \"Google123\" is configured pointing to Google\nand the customer has a logged in into Google in the past and has created a profile there, Google\nassigns a unique number identifier to that customer. If the storefront is configured to allow\nauthentication through Google and a new customer logs into the storefront using Google,\nthe AuthenticationProviderID property of his Credentials will contain \"Google123\" and\nthe ExternalID property will contain whatever unique identifier Google has assigned to him.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "externalprofile", + "dw.customer.externalprofile", + "dw/customer" + ], + "title": "ExternalProfile" + }, + { + "description": "Returns the authentication provider ID.", + "id": "script-api:dw/customer/ExternalProfile#authenticationProviderID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.authenticationProviderID", + "sections": [ + { + "body": "Returns the authentication provider ID.", + "heading": "Description" + } + ], + "signature": "readonly authenticationProviderID: string", + "source": "script-api", + "tags": [ + "authenticationproviderid", + "externalprofile.authenticationproviderid" + ], + "title": "ExternalProfile.authenticationProviderID" + }, + { + "description": "Returns the customer object related to this profile.", + "id": "script-api:dw/customer/ExternalProfile#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.customer", + "sections": [ + { + "body": "Returns the customer object related to this profile.", + "heading": "Description" + } + ], + "signature": "readonly customer: Customer", + "source": "script-api", + "tags": [ + "customer", + "externalprofile.customer" + ], + "title": "ExternalProfile.customer" + }, + { + "description": "Returns the customer's email address.", + "id": "script-api:dw/customer/ExternalProfile#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.email", + "sections": [ + { + "body": "Returns the customer's email address.", + "heading": "Description" + } + ], + "signature": "email: string", + "source": "script-api", + "tags": [ + "email", + "externalprofile.email" + ], + "title": "ExternalProfile.email" + }, + { + "description": "Returns the external ID.", + "id": "script-api:dw/customer/ExternalProfile#externalID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.externalID", + "sections": [ + { + "body": "Returns the external ID.", + "heading": "Description" + } + ], + "signature": "readonly externalID: string", + "source": "script-api", + "tags": [ + "externalid", + "externalprofile.externalid" + ], + "title": "ExternalProfile.externalID" + }, + { + "description": "Returns the authentication provider ID.", + "id": "script-api:dw/customer/ExternalProfile#getAuthenticationProviderID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getAuthenticationProviderID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the authentication provider ID.", + "heading": "Description" + } + ], + "signature": "getAuthenticationProviderID(): string", + "source": "script-api", + "tags": [ + "getauthenticationproviderid", + "externalprofile.getauthenticationproviderid" + ], + "title": "ExternalProfile.getAuthenticationProviderID" + }, + { + "description": "Returns the customer object related to this profile.", + "id": "script-api:dw/customer/ExternalProfile#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Returns the customer object related to this profile.", + "heading": "Description" + } + ], + "signature": "getCustomer(): Customer", + "source": "script-api", + "tags": [ + "getcustomer", + "externalprofile.getcustomer" + ], + "title": "ExternalProfile.getCustomer" + }, + { + "description": "Returns the customer's email address.", + "id": "script-api:dw/customer/ExternalProfile#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's email address.", + "heading": "Description" + } + ], + "signature": "getEmail(): string", + "source": "script-api", + "tags": [ + "getemail", + "externalprofile.getemail" + ], + "title": "ExternalProfile.getEmail" + }, + { + "description": "Returns the external ID.", + "id": "script-api:dw/customer/ExternalProfile#getExternalID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getExternalID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the external ID.", + "heading": "Description" + } + ], + "signature": "getExternalID(): string", + "source": "script-api", + "tags": [ + "getexternalid", + "externalprofile.getexternalid" + ], + "title": "ExternalProfile.getExternalID" + }, + { + "description": "Returns the last login time of the customer through the external provider", + "id": "script-api:dw/customer/ExternalProfile#getLastLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.getLastLoginTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the last login time of the customer through the external provider", + "heading": "Description" + } + ], + "signature": "getLastLoginTime(): Date", + "source": "script-api", + "tags": [ + "getlastlogintime", + "externalprofile.getlastlogintime" + ], + "title": "ExternalProfile.getLastLoginTime" + }, + { + "description": "Returns the last login time of the customer through the external provider", + "id": "script-api:dw/customer/ExternalProfile#lastLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.lastLoginTime", + "sections": [ + { + "body": "Returns the last login time of the customer through the external provider", + "heading": "Description" + } + ], + "signature": "readonly lastLoginTime: Date", + "source": "script-api", + "tags": [ + "lastlogintime", + "externalprofile.lastlogintime" + ], + "title": "ExternalProfile.lastLoginTime" + }, + { + "description": "Sets the customer's email address.", + "id": "script-api:dw/customer/ExternalProfile#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "email", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ExternalProfile", + "qualifiedName": "dw.customer.ExternalProfile.setEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's email address.", + "heading": "Description" + } + ], + "signature": "setEmail(email: string): void", + "source": "script-api", + "tags": [ + "setemail", + "externalprofile.setemail" + ], + "title": "ExternalProfile.setEmail" + }, + { + "description": "The class provides access to past orders of the customer.", + "id": "script-api:dw/customer/OrderHistory", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.OrderHistory", + "sections": [ + { + "body": "The class provides access to past orders of the customer.\n\nNote: This class allows access to sensitive financial and cardholder data. Pay special attention to PCI DSS\nv3. requirements 1, 3, 7, and 9. It also allows access to sensitive personal and private information. Pay attention\nto appropriate legal and regulatory requirements related to this data.\nNote: The following methods do not work with Salesforce Order Management orders.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "orderhistory", + "dw.customer.orderhistory", + "dw/customer" + ], + "title": "OrderHistory" + }, + { + "description": "Returns the number of orders the customer has placed in the store.", + "id": "script-api:dw/customer/OrderHistory#getOrderCount", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrderCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of orders the customer has placed in the store.\n\nIf the customer is anonymous, this method always returns zero. If an active data record is available for this\ncustomer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.", + "heading": "Description" + } + ], + "signature": "getOrderCount(): number", + "source": "script-api", + "tags": [ + "getordercount", + "orderhistory.getordercount" + ], + "title": "OrderHistory.getOrderCount" + }, + { + "description": "Retrieves the order history for the customer in the current storefront site.", + "examples": [ + "orderHistory.getOrders( null, \"creationDate DESC\" )" + ], + "id": "script-api:dw/customer/OrderHistory#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Retrieves the order history for the customer in the current storefront site.\n\nIf the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as\n\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.", + "heading": "Description" + } + ], + "signature": "getOrders(): SeekableIterator", + "source": "script-api", + "tags": [ + "getorders", + "orderhistory.getorders" + ], + "title": "OrderHistory.getOrders" + }, + { + "description": "Retrieves the order history for the customer in the current storefront site.", + "id": "script-api:dw/customer/OrderHistory#getOrders", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "query", + "type": "string" + }, + { + "name": "sortString", + "type": "string" + }, + { + "name": "params", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.getOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Retrieves the order history for the customer in the current storefront site.\n\nIf the result exceeds 1000 orders, only the first 1000 orders are retrieved. Optionally, you can retrieve a subset\nof the orders by specifying a query. At maximum 3 expressions are allowed to be specified and no custom attribute\nexpressions are allowed.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nExample:", + "heading": "Description" + } + ], + "signature": "getOrders(query: string, sortString: string, params?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "getorders", + "orderhistory.getorders" + ], + "title": "OrderHistory.getOrders" + }, + { + "description": "Returns the number of orders the customer has placed in the store.", + "id": "script-api:dw/customer/OrderHistory#orderCount", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.orderCount", + "sections": [ + { + "body": "Returns the number of orders the customer has placed in the store.\n\nIf the customer is anonymous, this method always returns zero. If an active data record is available for this\ncustomer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.", + "heading": "Description" + } + ], + "signature": "readonly orderCount: number", + "source": "script-api", + "tags": [ + "ordercount", + "orderhistory.ordercount" + ], + "title": "OrderHistory.orderCount" + }, + { + "description": "Retrieves the order history for the customer in the current storefront site.", + "examples": [ + "orderHistory.getOrders( null, \"creationDate DESC\" )" + ], + "id": "script-api:dw/customer/OrderHistory#orders", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/OrderHistory", + "qualifiedName": "dw.customer.OrderHistory.orders", + "sections": [ + { + "body": "Retrieves the order history for the customer in the current storefront site.\n\nIf the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as\n\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.", + "heading": "Description" + } + ], + "signature": "readonly orders: SeekableIterator", + "source": "script-api", + "tags": [ + "orders", + "orderhistory.orders" + ], + "title": "OrderHistory.orders" + }, + { + "description": "Represents a list of products (and optionally a gift certificate) that is typically maintained by a customer. This class can be used to implement a number of different storefront features, e.g. shopping list, wish list and gift registry. A product list is always owned by a customer. The owner can be anonymous or a registered customer. The owner can be the person for which items from that list will be purchased (wish list). Or it can be a person who maintains the list, for example a gift registry, on behalf of the bridal couple. Each product list can have a registrant and a co-registrant. A registrant is typically associated with an event related product list such as a gift registry. It holds information about a person associated with the event such as a bride or groom. A shipping address can be associated with this product list to ship the items, e.g. to an event location. A post-event shipping address can be associated to ship items to which could not be delivered on event date. The product list can also hold information about the event date and event location.", + "id": "script-api:dw/customer/ProductList", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductList", + "sections": [ + { + "body": "Represents a list of products (and optionally a gift certificate) that is\ntypically maintained by a customer. This class can be used to implement\na number of different storefront features, e.g. shopping list, wish list and gift registry.\nA product list is always owned by a customer. The owner can be anonymous or a registered customer.\nThe owner can be the person for which items from that list will be purchased (wish list).\nOr it can be a person who maintains the list, for example a gift registry, on behalf of the bridal couple.\nEach product list can have a registrant and a co-registrant. A registrant is typically associated with an event related product list\nsuch as a gift registry. It holds information about a person associated with the\nevent such as a bride or groom.\nA shipping address can be associated with this product list to ship the items,\ne.g. to an event location. A post-event shipping address can be associated to\nship items to which could not be delivered on event date.\nThe product list can also hold information about the event date and event location.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productlist", + "dw.customer.productlist", + "dw/customer" + ], + "title": "ProductList" + }, + { + "description": "Constant for when Export Status is Exported", + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_EXPORTED", + "sections": [ + { + "body": "Constant for when Export Status is Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_EXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_exported", + "productlist.export_status_exported" + ], + "title": "ProductList.EXPORT_STATUS_EXPORTED" + }, + { + "description": "Constant for when Export Status is Exported", + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_EXPORTED", + "sections": [ + { + "body": "Constant for when Export Status is Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_EXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_exported", + "productlist.export_status_exported" + ], + "title": "ProductList.EXPORT_STATUS_EXPORTED" + }, + { + "description": "Constant for when Export Status is Not Exported", + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_NOTEXPORTED", + "sections": [ + { + "body": "Constant for when Export Status is Not Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_NOTEXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_notexported", + "productlist.export_status_notexported" + ], + "title": "ProductList.EXPORT_STATUS_NOTEXPORTED" + }, + { + "description": "Constant for when Export Status is Not Exported", + "id": "script-api:dw/customer/ProductList#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.EXPORT_STATUS_NOTEXPORTED", + "sections": [ + { + "body": "Constant for when Export Status is Not Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_NOTEXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_notexported", + "productlist.export_status_notexported" + ], + "title": "ProductList.EXPORT_STATUS_NOTEXPORTED" + }, + { + "description": "Returns the unique system generated ID of the object.", + "id": "script-api:dw/customer/ProductList#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.ID", + "sections": [ + { + "body": "Returns the unique system generated ID of the object.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productlist.id" + ], + "title": "ProductList.ID" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_1", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_1: number", + "source": "script-api", + "tags": [ + "type_custom_1", + "productlist.type_custom_1" + ], + "title": "ProductList.TYPE_CUSTOM_1" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_1", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_1", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_1: number", + "source": "script-api", + "tags": [ + "type_custom_1", + "productlist.type_custom_1" + ], + "title": "ProductList.TYPE_CUSTOM_1" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_2", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_2: number", + "source": "script-api", + "tags": [ + "type_custom_2", + "productlist.type_custom_2" + ], + "title": "ProductList.TYPE_CUSTOM_2" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_2", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_2", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_2: number", + "source": "script-api", + "tags": [ + "type_custom_2", + "productlist.type_custom_2" + ], + "title": "ProductList.TYPE_CUSTOM_2" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_3", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_3", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_3: number", + "source": "script-api", + "tags": [ + "type_custom_3", + "productlist.type_custom_3" + ], + "title": "ProductList.TYPE_CUSTOM_3" + }, + { + "description": "Constant representing a custom list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_CUSTOM_3", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_CUSTOM_3", + "sections": [ + { + "body": "Constant representing a custom list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CUSTOM_3: number", + "source": "script-api", + "tags": [ + "type_custom_3", + "productlist.type_custom_3" + ], + "title": "ProductList.TYPE_CUSTOM_3" + }, + { + "description": "Constant representing the gift registry type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_GIFT_REGISTRY", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_GIFT_REGISTRY", + "sections": [ + { + "body": "Constant representing the gift registry type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_GIFT_REGISTRY: number", + "source": "script-api", + "tags": [ + "type_gift_registry", + "productlist.type_gift_registry" + ], + "title": "ProductList.TYPE_GIFT_REGISTRY" + }, + { + "description": "Constant representing the gift registry type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_GIFT_REGISTRY", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_GIFT_REGISTRY", + "sections": [ + { + "body": "Constant representing the gift registry type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_GIFT_REGISTRY: number", + "source": "script-api", + "tags": [ + "type_gift_registry", + "productlist.type_gift_registry" + ], + "title": "ProductList.TYPE_GIFT_REGISTRY" + }, + { + "description": "Constant representing the shopping list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_SHOPPING_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_SHOPPING_LIST", + "sections": [ + { + "body": "Constant representing the shopping list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHOPPING_LIST: number", + "source": "script-api", + "tags": [ + "type_shopping_list", + "productlist.type_shopping_list" + ], + "title": "ProductList.TYPE_SHOPPING_LIST" + }, + { + "description": "Constant representing the shopping list type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_SHOPPING_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_SHOPPING_LIST", + "sections": [ + { + "body": "Constant representing the shopping list type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHOPPING_LIST: number", + "source": "script-api", + "tags": [ + "type_shopping_list", + "productlist.type_shopping_list" + ], + "title": "ProductList.TYPE_SHOPPING_LIST" + }, + { + "description": "Constant representing the wish list registry type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_WISH_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_WISH_LIST", + "sections": [ + { + "body": "Constant representing the wish list registry type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_WISH_LIST: number", + "source": "script-api", + "tags": [ + "type_wish_list", + "productlist.type_wish_list" + ], + "title": "ProductList.TYPE_WISH_LIST" + }, + { + "description": "Constant representing the wish list registry type attribute.", + "id": "script-api:dw/customer/ProductList#TYPE_WISH_LIST", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.TYPE_WISH_LIST", + "sections": [ + { + "body": "Constant representing the wish list registry type attribute.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_WISH_LIST: number", + "source": "script-api", + "tags": [ + "type_wish_list", + "productlist.type_wish_list" + ], + "title": "ProductList.TYPE_WISH_LIST" + }, + { + "description": "Returns true if this product list is owned by an anonymous customer.", + "id": "script-api:dw/customer/ProductList#anonymous", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.anonymous", + "sections": [ + { + "body": "Returns true if this product list is owned by an anonymous customer.", + "heading": "Description" + } + ], + "signature": "readonly anonymous: boolean", + "source": "script-api", + "tags": [ + "anonymous", + "productlist.anonymous" + ], + "title": "ProductList.anonymous" + }, + { + "description": "Returns the ProductListRegistrant assigned to the coRegistrant attribute or null if this list has no co-registrant.", + "id": "script-api:dw/customer/ProductList#coRegistrant", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.coRegistrant", + "sections": [ + { + "body": "Returns the ProductListRegistrant assigned to the coRegistrant attribute or null\nif this list has no co-registrant.", + "heading": "Description" + } + ], + "signature": "readonly coRegistrant: ProductListRegistrant | null", + "source": "script-api", + "tags": [ + "coregistrant", + "productlist.coregistrant" + ], + "title": "ProductList.coRegistrant" + }, + { + "description": "Create a ProductListRegistrant and assign it to the coRegistrant attribute of the list. An exception is thrown if the list already has a coRegistrant assigned to it.", + "id": "script-api:dw/customer/ProductList#createCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createCoRegistrant", + "returns": { + "type": "ProductListRegistrant" + }, + "sections": [ + { + "body": "Create a ProductListRegistrant and assign it to the coRegistrant attribute\nof the list. An exception is thrown if the list already has a coRegistrant\nassigned to it.", + "heading": "Description" + } + ], + "signature": "createCoRegistrant(): ProductListRegistrant", + "source": "script-api", + "tags": [ + "createcoregistrant", + "productlist.createcoregistrant" + ], + "throws": [ + { + "description": "if one already exists", + "type": "CreateException" + } + ], + "title": "ProductList.createCoRegistrant" + }, + { + "description": "Create an item in the list that represents a gift certificate. A list may only contain a single gift certificate, so an exception is thrown if one already exists in the list.", + "id": "script-api:dw/customer/ProductList#createGiftCertificateItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createGiftCertificateItem", + "returns": { + "type": "ProductListItem" + }, + "sections": [ + { + "body": "Create an item in the list that represents a gift certificate.\nA list may only contain a single gift certificate, so an exception\nis thrown if one already exists in the list.", + "heading": "Description" + } + ], + "signature": "createGiftCertificateItem(): ProductListItem", + "source": "script-api", + "tags": [ + "creategiftcertificateitem", + "productlist.creategiftcertificateitem" + ], + "throws": [ + { + "description": "if a gift certificate item already exists in the list.", + "type": "CreateException" + } + ], + "title": "ProductList.createGiftCertificateItem" + }, + { + "description": "Create an item in the list that references the specified product.", + "id": "script-api:dw/customer/ProductList#createProductItem", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createProductItem", + "returns": { + "type": "ProductListItem" + }, + "sections": [ + { + "body": "Create an item in the list that references the specified product.", + "heading": "Description" + } + ], + "signature": "createProductItem(product: Product): ProductListItem", + "source": "script-api", + "tags": [ + "createproductitem", + "productlist.createproductitem" + ], + "title": "ProductList.createProductItem" + }, + { + "description": "Create a ProductListRegistrant and assign it to the registrant attribute of the list. An exception is thrown if the list already has a registrant assigned to it.", + "id": "script-api:dw/customer/ProductList#createRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.createRegistrant", + "returns": { + "type": "ProductListRegistrant" + }, + "sections": [ + { + "body": "Create a ProductListRegistrant and assign it to the registrant attribute\nof the list. An exception is thrown if the list already has a registrant\nassigned to it.", + "heading": "Description" + } + ], + "signature": "createRegistrant(): ProductListRegistrant", + "source": "script-api", + "tags": [ + "createregistrant", + "productlist.createregistrant" + ], + "throws": [ + { + "description": "if one already exists", + "type": "CreateException" + } + ], + "title": "ProductList.createRegistrant" + }, + { + "description": "This is a helper method typically used with an event related list. It provides the appropriate shipping address based on the eventDate. If the current date is after the eventDate, then the postEventShippingAddress is returned, otherwise the shippingAddress is returned. If the eventDate is null, then null is returned.", + "id": "script-api:dw/customer/ProductList#currentShippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.currentShippingAddress", + "sections": [ + { + "body": "This is a helper method typically used with an event related list.\nIt provides the appropriate shipping address based on the eventDate.\nIf the current date is after the eventDate, then the postEventShippingAddress\nis returned, otherwise the shippingAddress is returned. If the eventDate\nis null, then null is returned.", + "heading": "Description" + } + ], + "signature": "readonly currentShippingAddress: CustomerAddress | null", + "source": "script-api", + "tags": [ + "currentshippingaddress", + "productlist.currentshippingaddress" + ], + "title": "ProductList.currentShippingAddress" + }, + { + "description": "Returns a description text that, for example, explains the purpose of this product list.", + "id": "script-api:dw/customer/ProductList#description", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.description", + "sections": [ + { + "body": "Returns a description text that, for example, explains the purpose of this product list.", + "heading": "Description" + } + ], + "signature": "description: string", + "source": "script-api", + "tags": [ + "description", + "productlist.description" + ], + "title": "ProductList.description" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event city.", + "id": "script-api:dw/customer/ProductList#eventCity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventCity", + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event city.", + "heading": "Description" + } + ], + "signature": "eventCity: string", + "source": "script-api", + "tags": [ + "eventcity", + "productlist.eventcity" + ], + "title": "ProductList.eventCity" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event country.", + "id": "script-api:dw/customer/ProductList#eventCountry", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventCountry", + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event country.", + "heading": "Description" + } + ], + "signature": "eventCountry: string", + "source": "script-api", + "tags": [ + "eventcountry", + "productlist.eventcountry" + ], + "title": "ProductList.eventCountry" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the date of the event.", + "id": "script-api:dw/customer/ProductList#eventDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventDate", + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the date\nof the event.", + "heading": "Description" + } + ], + "signature": "eventDate: Date", + "source": "script-api", + "tags": [ + "eventdate", + "productlist.eventdate" + ], + "title": "ProductList.eventDate" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event state.", + "id": "script-api:dw/customer/ProductList#eventState", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventState", + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event state.", + "heading": "Description" + } + ], + "signature": "eventState: string", + "source": "script-api", + "tags": [ + "eventstate", + "productlist.eventstate" + ], + "title": "ProductList.eventState" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the type of event, e.g. Wedding, Baby Shower.", + "id": "script-api:dw/customer/ProductList#eventType", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.eventType", + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the type\nof event, e.g. Wedding, Baby Shower.", + "heading": "Description" + } + ], + "signature": "eventType: string", + "source": "script-api", + "tags": [ + "eventtype", + "productlist.eventtype" + ], + "title": "ProductList.eventType" + }, + { + "description": "Returns the export status of the product list.", + "id": "script-api:dw/customer/ProductList#exportStatus", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.exportStatus", + "sections": [ + { + "body": "Returns the export status of the product list.\n\nPossible values are: EXPORT_STATUS_NOTEXPORTED,\nEXPORT_STATUS_EXPORTED.", + "heading": "Description" + } + ], + "signature": "readonly exportStatus: EnumValue", + "source": "script-api", + "tags": [ + "exportstatus", + "productlist.exportstatus" + ], + "title": "ProductList.exportStatus" + }, + { + "description": "Returns the ProductListRegistrant assigned to the coRegistrant attribute or null if this list has no co-registrant.", + "id": "script-api:dw/customer/ProductList#getCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getCoRegistrant", + "returns": { + "type": "ProductListRegistrant | null" + }, + "sections": [ + { + "body": "Returns the ProductListRegistrant assigned to the coRegistrant attribute or null\nif this list has no co-registrant.", + "heading": "Description" + } + ], + "signature": "getCoRegistrant(): ProductListRegistrant | null", + "source": "script-api", + "tags": [ + "getcoregistrant", + "productlist.getcoregistrant" + ], + "title": "ProductList.getCoRegistrant" + }, + { + "description": "This is a helper method typically used with an event related list. It provides the appropriate shipping address based on the eventDate. If the current date is after the eventDate, then the postEventShippingAddress is returned, otherwise the shippingAddress is returned. If the eventDate is null, then null is returned.", + "id": "script-api:dw/customer/ProductList#getCurrentShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getCurrentShippingAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "This is a helper method typically used with an event related list.\nIt provides the appropriate shipping address based on the eventDate.\nIf the current date is after the eventDate, then the postEventShippingAddress\nis returned, otherwise the shippingAddress is returned. If the eventDate\nis null, then null is returned.", + "heading": "Description" + } + ], + "signature": "getCurrentShippingAddress(): CustomerAddress | null", + "source": "script-api", + "tags": [ + "getcurrentshippingaddress", + "productlist.getcurrentshippingaddress" + ], + "title": "ProductList.getCurrentShippingAddress" + }, + { + "description": "Returns a description text that, for example, explains the purpose of this product list.", + "id": "script-api:dw/customer/ProductList#getDescription", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a description text that, for example, explains the purpose of this product list.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "productlist.getdescription" + ], + "title": "ProductList.getDescription" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event city.", + "id": "script-api:dw/customer/ProductList#getEventCity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event city.", + "heading": "Description" + } + ], + "signature": "getEventCity(): string", + "source": "script-api", + "tags": [ + "geteventcity", + "productlist.geteventcity" + ], + "title": "ProductList.getEventCity" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event country.", + "id": "script-api:dw/customer/ProductList#getEventCountry", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventCountry", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event country.", + "heading": "Description" + } + ], + "signature": "getEventCountry(): string", + "source": "script-api", + "tags": [ + "geteventcountry", + "productlist.geteventcountry" + ], + "title": "ProductList.getEventCountry" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the date of the event.", + "id": "script-api:dw/customer/ProductList#getEventDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the date\nof the event.", + "heading": "Description" + } + ], + "signature": "getEventDate(): Date", + "source": "script-api", + "tags": [ + "geteventdate", + "productlist.geteventdate" + ], + "title": "ProductList.getEventDate" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the event state.", + "id": "script-api:dw/customer/ProductList#getEventState", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventState", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the event state.", + "heading": "Description" + } + ], + "signature": "getEventState(): string", + "source": "script-api", + "tags": [ + "geteventstate", + "productlist.geteventstate" + ], + "title": "ProductList.getEventState" + }, + { + "description": "For event related uses (e.g. gift registry), this holds the type of event, e.g. Wedding, Baby Shower.", + "id": "script-api:dw/customer/ProductList#getEventType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getEventType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "For event related uses (e.g. gift registry), this holds the type\nof event, e.g. Wedding, Baby Shower.", + "heading": "Description" + } + ], + "signature": "getEventType(): string", + "source": "script-api", + "tags": [ + "geteventtype", + "productlist.geteventtype" + ], + "title": "ProductList.getEventType" + }, + { + "description": "Returns the export status of the product list.", + "id": "script-api:dw/customer/ProductList#getExportStatus", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getExportStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the export status of the product list.\n\nPossible values are: EXPORT_STATUS_NOTEXPORTED,\nEXPORT_STATUS_EXPORTED.", + "heading": "Description" + } + ], + "signature": "getExportStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getexportstatus", + "productlist.getexportstatus" + ], + "title": "ProductList.getExportStatus" + }, + { + "description": "Returns the item in the list that represents a gift certificate.", + "id": "script-api:dw/customer/ProductList#getGiftCertificateItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getGiftCertificateItem", + "returns": { + "type": "ProductListItem | null" + }, + "sections": [ + { + "body": "Returns the item in the list that represents a gift certificate.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateItem(): ProductListItem | null", + "source": "script-api", + "tags": [ + "getgiftcertificateitem", + "productlist.getgiftcertificateitem" + ], + "title": "ProductList.getGiftCertificateItem" + }, + { + "description": "Returns the unique system generated ID of the object.", + "id": "script-api:dw/customer/ProductList#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique system generated ID of the object.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productlist.getid" + ], + "title": "ProductList.getID" + }, + { + "description": "Returns the item from the list that has the specified ID.", + "id": "script-api:dw/customer/ProductList#getItem", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "ID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getItem", + "returns": { + "type": "ProductListItem | null" + }, + "sections": [ + { + "body": "Returns the item from the list that has the specified ID.", + "heading": "Description" + } + ], + "signature": "getItem(ID: string): ProductListItem | null", + "source": "script-api", + "tags": [ + "getitem", + "productlist.getitem" + ], + "title": "ProductList.getItem" + }, + { + "description": "Returns a collection containing all items in the list.", + "id": "script-api:dw/customer/ProductList#getItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing all items in the list.", + "heading": "Description" + } + ], + "signature": "getItems(): Collection", + "source": "script-api", + "tags": [ + "getitems", + "productlist.getitems" + ], + "title": "ProductList.getItems" + }, + { + "description": "Returns the date where this product list has been exported successfully the last time.", + "id": "script-api:dw/customer/ProductList#getLastExportTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getLastExportTime", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the date where this product list has been exported successfully\nthe last time.", + "heading": "Description" + } + ], + "signature": "getLastExportTime(): Date | null", + "source": "script-api", + "tags": [ + "getlastexporttime", + "productlist.getlastexporttime" + ], + "title": "ProductList.getLastExportTime" + }, + { + "description": "Returns the name of this product list given by its owner.", + "id": "script-api:dw/customer/ProductList#getName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of this product list given by its owner.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "productlist.getname" + ], + "title": "ProductList.getName" + }, + { + "description": "Returns the customer that created and owns the product list.", + "id": "script-api:dw/customer/ProductList#getOwner", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getOwner", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Returns the customer that created and owns the product list.", + "heading": "Description" + } + ], + "signature": "getOwner(): Customer", + "source": "script-api", + "tags": [ + "getowner", + "productlist.getowner" + ], + "title": "ProductList.getOwner" + }, + { + "description": "Returns the shipping address for purchases made after the event date.", + "id": "script-api:dw/customer/ProductList#getPostEventShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPostEventShippingAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "Returns the shipping address for purchases made after the event date.", + "heading": "Description" + } + ], + "signature": "getPostEventShippingAddress(): CustomerAddress | null", + "source": "script-api", + "tags": [ + "getposteventshippingaddress", + "productlist.getposteventshippingaddress" + ], + "title": "ProductList.getPostEventShippingAddress" + }, + { + "description": "Returns a collection containing all items in the list that reference products.", + "id": "script-api:dw/customer/ProductList#getProductItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getProductItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing all items in the list that reference products.", + "heading": "Description" + } + ], + "signature": "getProductItems(): Collection", + "source": "script-api", + "tags": [ + "getproductitems", + "productlist.getproductitems" + ], + "title": "ProductList.getProductItems" + }, + { + "description": "Returns a collection containing all items in the list that are flagged as public.", + "id": "script-api:dw/customer/ProductList#getPublicItems", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPublicItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing all items in the list that are flagged as public.", + "heading": "Description" + } + ], + "signature": "getPublicItems(): Collection", + "source": "script-api", + "tags": [ + "getpublicitems", + "productlist.getpublicitems" + ], + "title": "ProductList.getPublicItems" + }, + { + "description": "Returns the aggregated purchases from all the individual items.", + "id": "script-api:dw/customer/ProductList#getPurchases", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getPurchases", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the aggregated purchases from all the individual items.", + "heading": "Description" + } + ], + "signature": "getPurchases(): Collection", + "source": "script-api", + "tags": [ + "getpurchases", + "productlist.getpurchases" + ], + "title": "ProductList.getPurchases" + }, + { + "description": "Returns the ProductListRegistrant assigned to the registrant attribute or null if this list has no registrant.", + "id": "script-api:dw/customer/ProductList#getRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getRegistrant", + "returns": { + "type": "ProductListRegistrant | null" + }, + "sections": [ + { + "body": "Returns the ProductListRegistrant assigned to the registrant attribute or null\nif this list has no registrant.", + "heading": "Description" + } + ], + "signature": "getRegistrant(): ProductListRegistrant | null", + "source": "script-api", + "tags": [ + "getregistrant", + "productlist.getregistrant" + ], + "title": "ProductList.getRegistrant" + }, + { + "description": "Return the address that should be used as the shipping address for purchases made from the list.", + "id": "script-api:dw/customer/ProductList#getShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getShippingAddress", + "returns": { + "type": "CustomerAddress | null" + }, + "sections": [ + { + "body": "Return the address that should be used as the shipping address for purchases\nmade from the list.", + "heading": "Description" + } + ], + "signature": "getShippingAddress(): CustomerAddress | null", + "source": "script-api", + "tags": [ + "getshippingaddress", + "productlist.getshippingaddress" + ], + "title": "ProductList.getShippingAddress" + }, + { + "description": "Returns an int representing the type of object (e.g. wish list, gift registry). This is set at object creation time.", + "id": "script-api:dw/customer/ProductList#getType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.getType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns an int representing the type of object (e.g. wish list,\ngift registry). This is set at object creation time.", + "heading": "Description" + } + ], + "signature": "getType(): number", + "source": "script-api", + "tags": [ + "gettype", + "productlist.gettype" + ], + "title": "ProductList.getType" + }, + { + "description": "Returns the item in the list that represents a gift certificate.", + "id": "script-api:dw/customer/ProductList#giftCertificateItem", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.giftCertificateItem", + "sections": [ + { + "body": "Returns the item in the list that represents a gift certificate.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateItem: ProductListItem | null", + "source": "script-api", + "tags": [ + "giftcertificateitem", + "productlist.giftcertificateitem" + ], + "title": "ProductList.giftCertificateItem" + }, + { + "description": "Returns true if this product list is owned by an anonymous customer.", + "id": "script-api:dw/customer/ProductList#isAnonymous", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.isAnonymous", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this product list is owned by an anonymous customer.", + "heading": "Description" + } + ], + "signature": "isAnonymous(): boolean", + "source": "script-api", + "tags": [ + "isanonymous", + "productlist.isanonymous" + ], + "title": "ProductList.isAnonymous" + }, + { + "description": "A flag, typically used to determine if the object is searchable by other customers.", + "id": "script-api:dw/customer/ProductList#isPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.isPublic", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "A flag, typically used to determine if the object is searchable\nby other customers.", + "heading": "Description" + } + ], + "signature": "isPublic(): boolean", + "source": "script-api", + "tags": [ + "ispublic", + "productlist.ispublic" + ], + "title": "ProductList.isPublic" + }, + { + "description": "Returns a collection containing all items in the list.", + "id": "script-api:dw/customer/ProductList#items", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.items", + "sections": [ + { + "body": "Returns a collection containing all items in the list.", + "heading": "Description" + } + ], + "signature": "readonly items: Collection", + "source": "script-api", + "tags": [ + "items", + "productlist.items" + ], + "title": "ProductList.items" + }, + { + "description": "Returns the date where this product list has been exported successfully the last time.", + "id": "script-api:dw/customer/ProductList#lastExportTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.lastExportTime", + "sections": [ + { + "body": "Returns the date where this product list has been exported successfully\nthe last time.", + "heading": "Description" + } + ], + "signature": "readonly lastExportTime: Date | null", + "source": "script-api", + "tags": [ + "lastexporttime", + "productlist.lastexporttime" + ], + "title": "ProductList.lastExportTime" + }, + { + "description": "Returns the name of this product list given by its owner.", + "id": "script-api:dw/customer/ProductList#name", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.name", + "sections": [ + { + "body": "Returns the name of this product list given by its owner.", + "heading": "Description" + } + ], + "signature": "name: string", + "source": "script-api", + "tags": [ + "name", + "productlist.name" + ], + "title": "ProductList.name" + }, + { + "description": "Returns the customer that created and owns the product list.", + "id": "script-api:dw/customer/ProductList#owner", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.owner", + "sections": [ + { + "body": "Returns the customer that created and owns the product list.", + "heading": "Description" + } + ], + "signature": "readonly owner: Customer", + "source": "script-api", + "tags": [ + "owner", + "productlist.owner" + ], + "title": "ProductList.owner" + }, + { + "description": "Returns the shipping address for purchases made after the event date.", + "id": "script-api:dw/customer/ProductList#postEventShippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.postEventShippingAddress", + "sections": [ + { + "body": "Returns the shipping address for purchases made after the event date.", + "heading": "Description" + } + ], + "signature": "postEventShippingAddress: CustomerAddress | null", + "source": "script-api", + "tags": [ + "posteventshippingaddress", + "productlist.posteventshippingaddress" + ], + "title": "ProductList.postEventShippingAddress" + }, + { + "description": "Returns a collection containing all items in the list that reference products.", + "id": "script-api:dw/customer/ProductList#productItems", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.productItems", + "sections": [ + { + "body": "Returns a collection containing all items in the list that reference products.", + "heading": "Description" + } + ], + "signature": "readonly productItems: Collection", + "source": "script-api", + "tags": [ + "productitems", + "productlist.productitems" + ], + "title": "ProductList.productItems" + }, + { + "description": "A flag, typically used to determine if the object is searchable by other customers.", + "id": "script-api:dw/customer/ProductList#public", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.public", + "sections": [ + { + "body": "A flag, typically used to determine if the object is searchable\nby other customers.", + "heading": "Description" + } + ], + "signature": "public: boolean", + "source": "script-api", + "tags": [ + "public", + "productlist.public" + ], + "title": "ProductList.public" + }, + { + "description": "Returns a collection containing all items in the list that are flagged as public.", + "id": "script-api:dw/customer/ProductList#publicItems", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.publicItems", + "sections": [ + { + "body": "Returns a collection containing all items in the list that are flagged as public.", + "heading": "Description" + } + ], + "signature": "readonly publicItems: Collection", + "source": "script-api", + "tags": [ + "publicitems", + "productlist.publicitems" + ], + "title": "ProductList.publicItems" + }, + { + "description": "Returns the aggregated purchases from all the individual items.", + "id": "script-api:dw/customer/ProductList#purchases", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.purchases", + "sections": [ + { + "body": "Returns the aggregated purchases from all the individual items.", + "heading": "Description" + } + ], + "signature": "readonly purchases: Collection", + "source": "script-api", + "tags": [ + "purchases", + "productlist.purchases" + ], + "title": "ProductList.purchases" + }, + { + "description": "Returns the ProductListRegistrant assigned to the registrant attribute or null if this list has no registrant.", + "id": "script-api:dw/customer/ProductList#registrant", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.registrant", + "sections": [ + { + "body": "Returns the ProductListRegistrant assigned to the registrant attribute or null\nif this list has no registrant.", + "heading": "Description" + } + ], + "signature": "readonly registrant: ProductListRegistrant | null", + "source": "script-api", + "tags": [ + "registrant", + "productlist.registrant" + ], + "title": "ProductList.registrant" + }, + { + "description": "Removes the ProductListRegistrant assigned to the coRegistrant attribute.", + "id": "script-api:dw/customer/ProductList#removeCoRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeCoRegistrant", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the ProductListRegistrant assigned to the coRegistrant attribute.", + "heading": "Description" + } + ], + "signature": "removeCoRegistrant(): void", + "source": "script-api", + "tags": [ + "removecoregistrant", + "productlist.removecoregistrant" + ], + "title": "ProductList.removeCoRegistrant" + }, + { + "description": "Removes the specified item from the list. This will also cause all purchase information associated with that item to be removed.", + "id": "script-api:dw/customer/ProductList#removeItem", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "item", + "type": "ProductListItem" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified item from the list. This will also cause\nall purchase information associated with that item to be removed.", + "heading": "Description" + } + ], + "signature": "removeItem(item: ProductListItem): void", + "source": "script-api", + "tags": [ + "removeitem", + "productlist.removeitem" + ], + "title": "ProductList.removeItem" + }, + { + "description": "Removes the ProductListRegistrant assigned to the registrant attribute.", + "id": "script-api:dw/customer/ProductList#removeRegistrant", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.removeRegistrant", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the ProductListRegistrant assigned to the registrant attribute.", + "heading": "Description" + } + ], + "signature": "removeRegistrant(): void", + "source": "script-api", + "tags": [ + "removeregistrant", + "productlist.removeregistrant" + ], + "title": "ProductList.removeRegistrant" + }, + { + "description": "Set the description of this product list.", + "id": "script-api:dw/customer/ProductList#setDescription", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "description", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the description of this product list.", + "heading": "Description" + } + ], + "signature": "setDescription(description: string): void", + "source": "script-api", + "tags": [ + "setdescription", + "productlist.setdescription" + ], + "title": "ProductList.setDescription" + }, + { + "description": "Set the event city to which this product list is related.", + "id": "script-api:dw/customer/ProductList#setEventCity", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "eventCity", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventCity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the event city to which this product list is related.", + "heading": "Description" + } + ], + "signature": "setEventCity(eventCity: string): void", + "source": "script-api", + "tags": [ + "seteventcity", + "productlist.seteventcity" + ], + "title": "ProductList.setEventCity" + }, + { + "description": "Set the event country to which this product list is related.", + "id": "script-api:dw/customer/ProductList#setEventCountry", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "eventCountry", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventCountry", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the event country to which this product list is related.", + "heading": "Description" + } + ], + "signature": "setEventCountry(eventCountry: string): void", + "source": "script-api", + "tags": [ + "seteventcountry", + "productlist.seteventcountry" + ], + "title": "ProductList.setEventCountry" + }, + { + "description": "Set the date of the event to which this product list is related.", + "id": "script-api:dw/customer/ProductList#setEventDate", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "eventDate", + "type": "Date | null" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventDate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the date of the event to which this product list is related.", + "heading": "Description" + } + ], + "signature": "setEventDate(eventDate: Date | null): void", + "source": "script-api", + "tags": [ + "seteventdate", + "productlist.seteventdate" + ], + "title": "ProductList.setEventDate" + }, + { + "description": "Set the event state to which this product list is related.", + "id": "script-api:dw/customer/ProductList#setEventState", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "eventState", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventState", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the event state to which this product list is related.", + "heading": "Description" + } + ], + "signature": "setEventState(eventState: string): void", + "source": "script-api", + "tags": [ + "seteventstate", + "productlist.seteventstate" + ], + "title": "ProductList.setEventState" + }, + { + "description": "Set the event type for which this product list was created by the owner.", + "id": "script-api:dw/customer/ProductList#setEventType", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "eventType", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setEventType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the event type for which this product list was created by the owner.", + "heading": "Description" + } + ], + "signature": "setEventType(eventType: string): void", + "source": "script-api", + "tags": [ + "seteventtype", + "productlist.seteventtype" + ], + "title": "ProductList.setEventType" + }, + { + "description": "Set the name of this product list.", + "id": "script-api:dw/customer/ProductList#setName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the name of this product list.", + "heading": "Description" + } + ], + "signature": "setName(name: string): void", + "source": "script-api", + "tags": [ + "setname", + "productlist.setname" + ], + "title": "ProductList.setName" + }, + { + "description": "This is typically used by an event related list (e.g. gift registry) to specify a shipping address for purchases made after the event date.", + "id": "script-api:dw/customer/ProductList#setPostEventShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "address", + "type": "CustomerAddress" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setPostEventShippingAddress", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This is typically used by an event related list (e.g. gift registry) to\nspecify a shipping address for purchases made after the event date.", + "heading": "Description" + } + ], + "signature": "setPostEventShippingAddress(address: CustomerAddress): void", + "source": "script-api", + "tags": [ + "setposteventshippingaddress", + "productlist.setposteventshippingaddress" + ], + "title": "ProductList.setPostEventShippingAddress" + }, + { + "description": "Makes this product list visible to other customers or hides it.", + "id": "script-api:dw/customer/ProductList#setPublic", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "flag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setPublic", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Makes this product list visible to other customers or hides it.", + "heading": "Description" + } + ], + "signature": "setPublic(flag: boolean): void", + "source": "script-api", + "tags": [ + "setpublic", + "productlist.setpublic" + ], + "title": "ProductList.setPublic" + }, + { + "description": "Associate an address, used as the shipping address for purchases made from the list.", + "id": "script-api:dw/customer/ProductList#setShippingAddress", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "address", + "type": "CustomerAddress" + } + ], + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.setShippingAddress", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Associate an address, used as the shipping address for purchases\nmade from the list.", + "heading": "Description" + } + ], + "signature": "setShippingAddress(address: CustomerAddress): void", + "source": "script-api", + "tags": [ + "setshippingaddress", + "productlist.setshippingaddress" + ], + "title": "ProductList.setShippingAddress" + }, + { + "description": "Return the address that should be used as the shipping address for purchases made from the list.", + "id": "script-api:dw/customer/ProductList#shippingAddress", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.shippingAddress", + "sections": [ + { + "body": "Return the address that should be used as the shipping address for purchases\nmade from the list.", + "heading": "Description" + } + ], + "signature": "shippingAddress: CustomerAddress | null", + "source": "script-api", + "tags": [ + "shippingaddress", + "productlist.shippingaddress" + ], + "title": "ProductList.shippingAddress" + }, + { + "description": "Returns an int representing the type of object (e.g. wish list, gift registry). This is set at object creation time.", + "id": "script-api:dw/customer/ProductList#type", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductList", + "qualifiedName": "dw.customer.ProductList.type", + "sections": [ + { + "body": "Returns an int representing the type of object (e.g. wish list,\ngift registry). This is set at object creation time.", + "heading": "Description" + } + ], + "signature": "readonly type: number", + "source": "script-api", + "tags": [ + "type", + "productlist.type" + ], + "title": "ProductList.type" + }, + { + "description": "An item in a product list. Types of items are:", + "id": "script-api:dw/customer/ProductListItem", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListItem", + "sections": [ + { + "body": "An item in a product list. Types of items are:\n\n- An item that references a product via the product's SKU.\n- An item that represents a gift certificate.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productlistitem", + "dw.customer.productlistitem", + "dw/customer" + ], + "title": "ProductListItem" + }, + { + "description": "Returns the unique system generated ID of the object.", + "id": "script-api:dw/customer/ProductListItem#ID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.ID", + "sections": [ + { + "body": "Returns the unique system generated ID of the object.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "productlistitem.id" + ], + "title": "ProductListItem.ID" + }, + { + "description": "Constant representing a gift certificate list item type.", + "id": "script-api:dw/customer/ProductListItem#TYPE_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_GIFT_CERTIFICATE", + "sections": [ + { + "body": "Constant representing a gift certificate list item type.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_GIFT_CERTIFICATE: number", + "source": "script-api", + "tags": [ + "type_gift_certificate", + "productlistitem.type_gift_certificate" + ], + "title": "ProductListItem.TYPE_GIFT_CERTIFICATE" + }, + { + "description": "Constant representing a gift certificate list item type.", + "id": "script-api:dw/customer/ProductListItem#TYPE_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_GIFT_CERTIFICATE", + "sections": [ + { + "body": "Constant representing a gift certificate list item type.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_GIFT_CERTIFICATE: number", + "source": "script-api", + "tags": [ + "type_gift_certificate", + "productlistitem.type_gift_certificate" + ], + "title": "ProductListItem.TYPE_GIFT_CERTIFICATE" + }, + { + "description": "Constant representing a product list item type.", + "id": "script-api:dw/customer/ProductListItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_PRODUCT", + "sections": [ + { + "body": "Constant representing a product list item type.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRODUCT: number", + "source": "script-api", + "tags": [ + "type_product", + "productlistitem.type_product" + ], + "title": "ProductListItem.TYPE_PRODUCT" + }, + { + "description": "Constant representing a product list item type.", + "id": "script-api:dw/customer/ProductListItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.TYPE_PRODUCT", + "sections": [ + { + "body": "Constant representing a product list item type.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRODUCT: number", + "source": "script-api", + "tags": [ + "type_product", + "productlistitem.type_product" + ], + "title": "ProductListItem.TYPE_PRODUCT" + }, + { + "description": "Create a purchase record for this item.", + "id": "script-api:dw/customer/ProductListItem#createPurchase", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "quantity", + "type": "number" + }, + { + "name": "purchaserName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.createPurchase", + "returns": { + "type": "ProductListItemPurchase" + }, + "sections": [ + { + "body": "Create a purchase record for this item.", + "heading": "Description" + } + ], + "signature": "createPurchase(quantity: number, purchaserName: string): ProductListItemPurchase", + "source": "script-api", + "tags": [ + "createpurchase", + "productlistitem.createpurchase" + ], + "title": "ProductListItem.createPurchase" + }, + { + "description": "Returns the unique system generated ID of the object.", + "id": "script-api:dw/customer/ProductListItem#getID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique system generated ID of the object.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "productlistitem.getid" + ], + "title": "ProductListItem.getID" + }, + { + "description": "Returns the product list that this item belongs to.", + "id": "script-api:dw/customer/ProductListItem#getList", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getList", + "returns": { + "type": "ProductList" + }, + "sections": [ + { + "body": "Returns the product list that this item belongs to.", + "heading": "Description" + } + ], + "signature": "getList(): ProductList", + "source": "script-api", + "tags": [ + "getlist", + "productlistitem.getlist" + ], + "title": "ProductListItem.getList" + }, + { + "description": "Specify the priority level for the item. Typically the lower the number, the higher the priority. This can be used by the owner of the product list to express which items he/she likes to get purchased first.", + "id": "script-api:dw/customer/ProductListItem#getPriority", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPriority", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Specify the priority level for the item. Typically the lower the\nnumber, the higher the priority. This can be used by the owner of the product list\nto express which items he/she likes to get purchased first.", + "heading": "Description" + } + ], + "signature": "getPriority(): number", + "source": "script-api", + "tags": [ + "getpriority", + "productlistitem.getpriority" + ], + "title": "ProductListItem.getPriority" + }, + { + "description": "Returns the referenced product for this item. The reference is made via the product ID attribute. This method returns null if there is no such product in the system or if the product exists but is not assigned to the site catalog.", + "id": "script-api:dw/customer/ProductListItem#getProduct", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProduct", + "returns": { + "type": "Product | null" + }, + "sections": [ + { + "body": "Returns the referenced product for this item. The reference is made\nvia the product ID attribute. This method returns null if there is\nno such product in the system or if the product exists but is not\nassigned to the site catalog.", + "heading": "Description" + } + ], + "signature": "getProduct(): Product | null", + "source": "script-api", + "tags": [ + "getproduct", + "productlistitem.getproduct" + ], + "title": "ProductListItem.getProduct" + }, + { + "description": "Returns the ID of the product referenced by this item. This attribute is set when a product is assigned via setProduct(). It is possible for the ID to reference a product that doesn't exist anymore. In this case getProduct() would return null.", + "id": "script-api:dw/customer/ProductListItem#getProductID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProductID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the product referenced by this item.\nThis attribute is set when a product is assigned via setProduct().\nIt is possible for the ID to reference a product that doesn't exist\nanymore. In this case getProduct() would return null.", + "heading": "Description" + } + ], + "signature": "getProductID(): string | null", + "source": "script-api", + "tags": [ + "getproductid", + "productlistitem.getproductid" + ], + "title": "ProductListItem.getProductID" + }, + { + "description": "Returns the ProductOptionModel for the product associated with this item, or null if there is no valid product associated with this item.", + "id": "script-api:dw/customer/ProductListItem#getProductOptionModel", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getProductOptionModel", + "returns": { + "type": "ProductOptionModel | null" + }, + "sections": [ + { + "body": "Returns the ProductOptionModel for the product associated with this item,\nor null if there is no valid product associated with this item.", + "heading": "Description" + } + ], + "signature": "getProductOptionModel(): ProductOptionModel | null", + "source": "script-api", + "tags": [ + "getproductoptionmodel", + "productlistitem.getproductoptionmodel" + ], + "title": "ProductListItem.getProductOptionModel" + }, + { + "description": "Returns the sum of the quantities of all the individual purchase records for this item.", + "id": "script-api:dw/customer/ProductListItem#getPurchasedQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchasedQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the sum of the quantities of all the individual purchase records\nfor this item.", + "heading": "Description" + } + ], + "signature": "getPurchasedQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getpurchasedquantity", + "productlistitem.getpurchasedquantity" + ], + "title": "ProductListItem.getPurchasedQuantity" + }, + { + "description": "Returns the value part of the underlying purchased quantity object, as distinct from the unit.", + "id": "script-api:dw/customer/ProductListItem#getPurchasedQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchasedQuantityValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value part of the underlying purchased quantity object, as distinct\nfrom the unit.", + "heading": "Description" + } + ], + "signature": "getPurchasedQuantityValue(): number", + "source": "script-api", + "tags": [ + "getpurchasedquantityvalue", + "productlistitem.getpurchasedquantityvalue" + ], + "title": "ProductListItem.getPurchasedQuantityValue" + }, + { + "description": "Returns all purchases made for this item.", + "id": "script-api:dw/customer/ProductListItem#getPurchases", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getPurchases", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all purchases made for this item.", + "heading": "Description" + } + ], + "signature": "getPurchases(): Collection", + "source": "script-api", + "tags": [ + "getpurchases", + "productlistitem.getpurchases" + ], + "title": "ProductListItem.getPurchases" + }, + { + "description": "Returns the quantity of the item. The quantity is the number of products or gift certificates that get shipped when purchasing this product list item.", + "id": "script-api:dw/customer/ProductListItem#getQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of the item.\nThe quantity is the number of products or gift certificates\nthat get shipped when purchasing this product list item.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "productlistitem.getquantity" + ], + "title": "ProductListItem.getQuantity" + }, + { + "description": "Returns the value part of the underlying quantity object, as distinct from the unit.", + "id": "script-api:dw/customer/ProductListItem#getQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getQuantityValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value part of the underlying quantity object, as distinct\nfrom the unit.", + "heading": "Description" + } + ], + "signature": "getQuantityValue(): number", + "source": "script-api", + "tags": [ + "getquantityvalue", + "productlistitem.getquantityvalue" + ], + "title": "ProductListItem.getQuantityValue" + }, + { + "description": "Returns the type of this product list item.", + "id": "script-api:dw/customer/ProductListItem#getType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.getType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of this product list item.", + "heading": "Description" + } + ], + "signature": "getType(): number", + "source": "script-api", + "tags": [ + "gettype", + "productlistitem.gettype" + ], + "title": "ProductListItem.getType" + }, + { + "description": "A flag, typically used to determine whether the item should display in a customer's view of the list (as opposed to the list owner's view).", + "id": "script-api:dw/customer/ProductListItem#isPublic", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.isPublic", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "A flag, typically used to determine whether the item should display\nin a customer's view of the list (as opposed to the list owner's view).", + "heading": "Description" + } + ], + "signature": "isPublic(): boolean", + "source": "script-api", + "tags": [ + "ispublic", + "productlistitem.ispublic" + ], + "title": "ProductListItem.isPublic" + }, + { + "description": "Returns the product list that this item belongs to.", + "id": "script-api:dw/customer/ProductListItem#list", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.list", + "sections": [ + { + "body": "Returns the product list that this item belongs to.", + "heading": "Description" + } + ], + "signature": "readonly list: ProductList", + "source": "script-api", + "tags": [ + "list", + "productlistitem.list" + ], + "title": "ProductListItem.list" + }, + { + "description": "Specify the priority level for the item. Typically the lower the number, the higher the priority. This can be used by the owner of the product list to express which items he/she likes to get purchased first.", + "id": "script-api:dw/customer/ProductListItem#priority", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.priority", + "sections": [ + { + "body": "Specify the priority level for the item. Typically the lower the\nnumber, the higher the priority. This can be used by the owner of the product list\nto express which items he/she likes to get purchased first.", + "heading": "Description" + } + ], + "signature": "priority: number", + "source": "script-api", + "tags": [ + "priority", + "productlistitem.priority" + ], + "title": "ProductListItem.priority" + }, + { + "description": "Returns the referenced product for this item. The reference is made via the product ID attribute. This method returns null if there is no such product in the system or if the product exists but is not assigned to the site catalog.", + "id": "script-api:dw/customer/ProductListItem#product", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.product", + "sections": [ + { + "body": "Returns the referenced product for this item. The reference is made\nvia the product ID attribute. This method returns null if there is\nno such product in the system or if the product exists but is not\nassigned to the site catalog.", + "heading": "Description" + } + ], + "signature": "product: Product | null", + "source": "script-api", + "tags": [ + "product", + "productlistitem.product" + ], + "title": "ProductListItem.product" + }, + { + "description": "Returns the ID of the product referenced by this item. This attribute is set when a product is assigned via setProduct(). It is possible for the ID to reference a product that doesn't exist anymore. In this case getProduct() would return null.", + "id": "script-api:dw/customer/ProductListItem#productID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.productID", + "sections": [ + { + "body": "Returns the ID of the product referenced by this item.\nThis attribute is set when a product is assigned via setProduct().\nIt is possible for the ID to reference a product that doesn't exist\nanymore. In this case getProduct() would return null.", + "heading": "Description" + } + ], + "signature": "readonly productID: string | null", + "source": "script-api", + "tags": [ + "productid", + "productlistitem.productid" + ], + "title": "ProductListItem.productID" + }, + { + "description": "Returns the ProductOptionModel for the product associated with this item, or null if there is no valid product associated with this item.", + "id": "script-api:dw/customer/ProductListItem#productOptionModel", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.productOptionModel", + "sections": [ + { + "body": "Returns the ProductOptionModel for the product associated with this item,\nor null if there is no valid product associated with this item.", + "heading": "Description" + } + ], + "signature": "productOptionModel: ProductOptionModel | null", + "source": "script-api", + "tags": [ + "productoptionmodel", + "productlistitem.productoptionmodel" + ], + "title": "ProductListItem.productOptionModel" + }, + { + "description": "A flag, typically used to determine whether the item should display in a customer's view of the list (as opposed to the list owner's view).", + "id": "script-api:dw/customer/ProductListItem#public", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.public", + "sections": [ + { + "body": "A flag, typically used to determine whether the item should display\nin a customer's view of the list (as opposed to the list owner's view).", + "heading": "Description" + } + ], + "signature": "public: boolean", + "source": "script-api", + "tags": [ + "public", + "productlistitem.public" + ], + "title": "ProductListItem.public" + }, + { + "description": "Returns the sum of the quantities of all the individual purchase records for this item.", + "id": "script-api:dw/customer/ProductListItem#purchasedQuantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchasedQuantity", + "sections": [ + { + "body": "Returns the sum of the quantities of all the individual purchase records\nfor this item.", + "heading": "Description" + } + ], + "signature": "readonly purchasedQuantity: Quantity", + "source": "script-api", + "tags": [ + "purchasedquantity", + "productlistitem.purchasedquantity" + ], + "title": "ProductListItem.purchasedQuantity" + }, + { + "description": "Returns the value part of the underlying purchased quantity object, as distinct from the unit.", + "id": "script-api:dw/customer/ProductListItem#purchasedQuantityValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchasedQuantityValue", + "sections": [ + { + "body": "Returns the value part of the underlying purchased quantity object, as distinct\nfrom the unit.", + "heading": "Description" + } + ], + "signature": "readonly purchasedQuantityValue: number", + "source": "script-api", + "tags": [ + "purchasedquantityvalue", + "productlistitem.purchasedquantityvalue" + ], + "title": "ProductListItem.purchasedQuantityValue" + }, + { + "description": "Returns all purchases made for this item.", + "id": "script-api:dw/customer/ProductListItem#purchases", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.purchases", + "sections": [ + { + "body": "Returns all purchases made for this item.", + "heading": "Description" + } + ], + "signature": "readonly purchases: Collection", + "source": "script-api", + "tags": [ + "purchases", + "productlistitem.purchases" + ], + "title": "ProductListItem.purchases" + }, + { + "description": "Returns the quantity of the item. The quantity is the number of products or gift certificates that get shipped when purchasing this product list item.", + "id": "script-api:dw/customer/ProductListItem#quantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.quantity", + "sections": [ + { + "body": "Returns the quantity of the item.\nThe quantity is the number of products or gift certificates\nthat get shipped when purchasing this product list item.", + "heading": "Description" + } + ], + "signature": "quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "productlistitem.quantity" + ], + "title": "ProductListItem.quantity" + }, + { + "description": "Returns the value part of the underlying quantity object, as distinct from the unit.", + "id": "script-api:dw/customer/ProductListItem#quantityValue", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.quantityValue", + "sections": [ + { + "body": "Returns the value part of the underlying quantity object, as distinct\nfrom the unit.", + "heading": "Description" + } + ], + "signature": "quantityValue: number", + "source": "script-api", + "tags": [ + "quantityvalue", + "productlistitem.quantityvalue" + ], + "title": "ProductListItem.quantityValue" + }, + { + "description": "Specify the priority level for the item. Typically the lower the number, the higher the priority. This can be used by the owner of the product list to express which items he/she likes to get purchased first.", + "id": "script-api:dw/customer/ProductListItem#setPriority", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "priority", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setPriority", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specify the priority level for the item. Typically the lower the\nnumber, the higher the priority. This can be used by the owner of the product list\nto express which items he/she likes to get purchased first.", + "heading": "Description" + } + ], + "signature": "setPriority(priority: number): void", + "source": "script-api", + "tags": [ + "setpriority", + "productlistitem.setpriority" + ], + "title": "ProductListItem.setPriority" + }, + { + "deprecated": { + "message": "Use dw.customer.ProductList.createProductItem instead." + }, + "description": "Sets the referenced product for this item by storing the product's id. If null is specified, then the id is set to null.", + "id": "script-api:dw/customer/ProductListItem#setProduct", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setProduct", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the referenced product for this item by storing the product's id.\nIf null is specified, then the id is set to null.", + "heading": "Description" + } + ], + "signature": "setProduct(product: Product): void", + "source": "script-api", + "tags": [ + "setproduct", + "productlistitem.setproduct" + ], + "title": "ProductListItem.setProduct" + }, + { + "description": "Store a product option model with this object. This stores a copy of the specified model, rather than an assocation to the same instance.", + "id": "script-api:dw/customer/ProductListItem#setProductOptionModel", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "productOptionModel", + "type": "ProductOptionModel" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setProductOptionModel", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Store a product option model with this object. This stores a copy\nof the specified model, rather than an assocation to the same instance.", + "heading": "Description" + } + ], + "signature": "setProductOptionModel(productOptionModel: ProductOptionModel): void", + "source": "script-api", + "tags": [ + "setproductoptionmodel", + "productlistitem.setproductoptionmodel" + ], + "title": "ProductListItem.setProductOptionModel" + }, + { + "description": "Typically used to determine if the item is visible to other customers.", + "id": "script-api:dw/customer/ProductListItem#setPublic", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "flag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setPublic", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Typically used to determine if the item is visible to other customers.", + "heading": "Description" + } + ], + "signature": "setPublic(flag: boolean): void", + "source": "script-api", + "tags": [ + "setpublic", + "productlistitem.setpublic" + ], + "title": "ProductListItem.setPublic" + }, + { + "deprecated": { + "message": "Use setQuantityValue instead." + }, + "description": "Sets the quantity of the item.", + "id": "script-api:dw/customer/ProductListItem#setQuantity", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setQuantity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the quantity of the item.", + "heading": "Description" + } + ], + "signature": "setQuantity(value: Quantity): void", + "source": "script-api", + "tags": [ + "setquantity", + "productlistitem.setquantity" + ], + "title": "ProductListItem.setQuantity" + }, + { + "description": "Set the value part of the underlying quantity object, as distinct from the unit.", + "id": "script-api:dw/customer/ProductListItem#setQuantityValue", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.setQuantityValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the value part of the underlying quantity object, as distinct from\nthe unit.", + "heading": "Description" + } + ], + "signature": "setQuantityValue(value: number): void", + "source": "script-api", + "tags": [ + "setquantityvalue", + "productlistitem.setquantityvalue" + ], + "title": "ProductListItem.setQuantityValue" + }, + { + "description": "Returns the type of this product list item.", + "id": "script-api:dw/customer/ProductListItem#type", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItem", + "qualifiedName": "dw.customer.ProductListItem.type", + "sections": [ + { + "body": "Returns the type of this product list item.", + "heading": "Description" + } + ], + "signature": "readonly type: number", + "source": "script-api", + "tags": [ + "type", + "productlistitem.type" + ], + "title": "ProductListItem.type" + }, + { + "description": "A record of the purchase of an item contained in a product list.", + "id": "script-api:dw/customer/ProductListItemPurchase", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListItemPurchase", + "sections": [ + { + "body": "A record of the purchase of an item contained in a product list.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productlistitempurchase", + "dw.customer.productlistitempurchase", + "dw/customer" + ], + "title": "ProductListItemPurchase" + }, + { + "description": "Returns the item that was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#getItem", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getItem", + "returns": { + "type": "ProductListItem" + }, + "sections": [ + { + "body": "Returns the item that was purchased.", + "heading": "Description" + } + ], + "signature": "getItem(): ProductListItem", + "source": "script-api", + "tags": [ + "getitem", + "productlistitempurchase.getitem" + ], + "title": "ProductListItemPurchase.getItem" + }, + { + "description": "Returns the number of the order in which the product list item was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#getOrderNo", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the number of the order in which the\nproduct list item was purchased.", + "heading": "Description" + } + ], + "signature": "getOrderNo(): string", + "source": "script-api", + "tags": [ + "getorderno", + "productlistitempurchase.getorderno" + ], + "title": "ProductListItemPurchase.getOrderNo" + }, + { + "description": "Returns the date on which the product list item was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#getPurchaseDate", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getPurchaseDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date on which the product list item was purchased.", + "heading": "Description" + } + ], + "signature": "getPurchaseDate(): Date", + "source": "script-api", + "tags": [ + "getpurchasedate", + "productlistitempurchase.getpurchasedate" + ], + "title": "ProductListItemPurchase.getPurchaseDate" + }, + { + "description": "Returns the name of the purchaser of the product list item.", + "id": "script-api:dw/customer/ProductListItemPurchase#getPurchaserName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getPurchaserName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the purchaser of the product list item.", + "heading": "Description" + } + ], + "signature": "getPurchaserName(): string", + "source": "script-api", + "tags": [ + "getpurchasername", + "productlistitempurchase.getpurchasername" + ], + "title": "ProductListItemPurchase.getPurchaserName" + }, + { + "description": "Returns the quantity of the product list item that was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#getQuantity", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of the product list item that was purchased.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "productlistitempurchase.getquantity" + ], + "title": "ProductListItemPurchase.getQuantity" + }, + { + "description": "Returns the item that was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#item", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.item", + "sections": [ + { + "body": "Returns the item that was purchased.", + "heading": "Description" + } + ], + "signature": "readonly item: ProductListItem", + "source": "script-api", + "tags": [ + "item", + "productlistitempurchase.item" + ], + "title": "ProductListItemPurchase.item" + }, + { + "description": "Returns the number of the order in which the product list item was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#orderNo", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.orderNo", + "sections": [ + { + "body": "Returns the number of the order in which the\nproduct list item was purchased.", + "heading": "Description" + } + ], + "signature": "readonly orderNo: string", + "source": "script-api", + "tags": [ + "orderno", + "productlistitempurchase.orderno" + ], + "title": "ProductListItemPurchase.orderNo" + }, + { + "description": "Returns the date on which the product list item was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#purchaseDate", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.purchaseDate", + "sections": [ + { + "body": "Returns the date on which the product list item was purchased.", + "heading": "Description" + } + ], + "signature": "readonly purchaseDate: Date", + "source": "script-api", + "tags": [ + "purchasedate", + "productlistitempurchase.purchasedate" + ], + "title": "ProductListItemPurchase.purchaseDate" + }, + { + "description": "Returns the name of the purchaser of the product list item.", + "id": "script-api:dw/customer/ProductListItemPurchase#purchaserName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.purchaserName", + "sections": [ + { + "body": "Returns the name of the purchaser of the product list item.", + "heading": "Description" + } + ], + "signature": "readonly purchaserName: string", + "source": "script-api", + "tags": [ + "purchasername", + "productlistitempurchase.purchasername" + ], + "title": "ProductListItemPurchase.purchaserName" + }, + { + "description": "Returns the quantity of the product list item that was purchased.", + "id": "script-api:dw/customer/ProductListItemPurchase#quantity", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListItemPurchase", + "qualifiedName": "dw.customer.ProductListItemPurchase.quantity", + "sections": [ + { + "body": "Returns the quantity of the product list item that was purchased.", + "heading": "Description" + } + ], + "signature": "readonly quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "productlistitempurchase.quantity" + ], + "title": "ProductListItemPurchase.quantity" + }, + { + "description": "ProductListMgr provides methods for retrieving, creating, searching for, and removing product lists.", + "id": "script-api:dw/customer/ProductListMgr", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListMgr", + "sections": [ + { + "body": "ProductListMgr provides methods for retrieving, creating, searching for, and\nremoving product lists.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productlistmgr", + "dw.customer.productlistmgr", + "dw/customer" + ], + "title": "ProductListMgr" + }, + { + "description": "Creates a new instance of a product list, of the specified type.", + "id": "script-api:dw/customer/ProductListMgr#createProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.createProductList", + "returns": { + "type": "ProductList" + }, + "sections": [ + { + "body": "Creates a new instance of a product list, of the specified type.", + "heading": "Description" + } + ], + "signature": "static createProductList(customer: Customer, type: number): ProductList", + "source": "script-api", + "tags": [ + "createproductlist", + "productlistmgr.createproductlist" + ], + "title": "ProductListMgr.createProductList" + }, + { + "description": "Creates a new instance of a product list, of the specified type.", + "id": "script-api:dw/customer/ProductListMgr#createProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.createProductList", + "returns": { + "type": "ProductList" + }, + "sections": [ + { + "body": "Creates a new instance of a product list, of the specified type.", + "heading": "Description" + } + ], + "signature": "static createProductList(customer: Customer, type: number): ProductList", + "source": "script-api", + "tags": [ + "createproductlist", + "productlistmgr.createproductlist" + ], + "title": "ProductListMgr.createProductList" + }, + { + "description": "Gets the product list by its ID.", + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "ID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "returns": { + "type": "ProductList | null" + }, + "sections": [ + { + "body": "Gets the product list by its ID.", + "heading": "Description" + } + ], + "signature": "static getProductList(ID: string): ProductList | null", + "source": "script-api", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "deprecated": { + "message": "Use getProductLists or getProductLists instead." + }, + "description": "Returns the first product list belonging to the customer with the specified profile.", + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "profile", + "type": "Profile" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "returns": { + "type": "ProductList | null" + }, + "sections": [ + { + "body": "Returns the first product list belonging to the customer with the\nspecified profile.", + "heading": "Description" + } + ], + "signature": "static getProductList(profile: Profile, type: number): ProductList | null", + "source": "script-api", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "description": "Gets the product list by its ID.", + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "ID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "returns": { + "type": "ProductList | null" + }, + "sections": [ + { + "body": "Gets the product list by its ID.", + "heading": "Description" + } + ], + "signature": "static getProductList(ID: string): ProductList | null", + "source": "script-api", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "deprecated": { + "message": "Use getProductLists or getProductLists instead." + }, + "description": "Returns the first product list belonging to the customer with the specified profile.", + "id": "script-api:dw/customer/ProductListMgr#getProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "profile", + "type": "Profile" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductList", + "returns": { + "type": "ProductList | null" + }, + "sections": [ + { + "body": "Returns the first product list belonging to the customer with the\nspecified profile.", + "heading": "Description" + } + ], + "signature": "static getProductList(profile: Profile, type: number): ProductList | null", + "source": "script-api", + "tags": [ + "getproductlist", + "productlistmgr.getproductlist" + ], + "title": "ProductListMgr.getProductList" + }, + { + "description": "Retrieve all product lists of the specified type owned by the specified customer.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve all product lists of the specified type owned by the\nspecified customer.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customer: Customer, type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Retrieve all the product lists of the specified type and event type belonging to the specified customer.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + }, + { + "name": "eventType", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve all the product lists of the specified type and event type\nbelonging to the specified customer.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customer: Customer, type: number, eventType: string): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Returns the collection of product lists that have the specified address as the shipping address.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerAddress", + "type": "CustomerAddress" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of product lists that have the specified address\nas the shipping address.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customerAddress: CustomerAddress): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Retrieve all product lists of the specified type owned by the specified customer.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve all product lists of the specified type owned by the\nspecified customer.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customer: Customer, type: number): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Retrieve all the product lists of the specified type and event type belonging to the specified customer.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "type", + "type": "number" + }, + { + "name": "eventType", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieve all the product lists of the specified type and event type\nbelonging to the specified customer.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customer: Customer, type: number, eventType: string): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Returns the collection of product lists that have the specified address as the shipping address.", + "id": "script-api:dw/customer/ProductListMgr#getProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "customerAddress", + "type": "CustomerAddress" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.getProductLists", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of product lists that have the specified address\nas the shipping address.", + "heading": "Description" + } + ], + "signature": "static getProductLists(customerAddress: CustomerAddress): Collection", + "source": "script-api", + "tags": [ + "getproductlists", + "productlistmgr.getproductlists" + ], + "title": "ProductListMgr.getProductLists" + }, + { + "description": "Searches for product list instances.", + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for product list instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductLists(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "description": "Searches for product list instances.", + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for product list instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nSometimes it is desired to get all instances with a special sorting condition.\nThis can be easily done by providing the 'sortString' in combination with\nan empty 'queryString', e.g. `querySystemObjects(\"sample\", \"\", \"ID asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductLists(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "description": "Searches for product list instances.", + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for product list instances.\n\nThe search can be configured with a map, which key-value pairs are\nconverted into a query expression. The key-value pairs are turned into a\nsequence of '=' or 'like' conditions, which are combined with AND\nstatements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66\nwill be converted as follows: `\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductLists(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "description": "Searches for product list instances.", + "id": "script-api:dw/customer/ProductListMgr#queryProductLists", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.queryProductLists", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for product list instances.\n\nThe search can be configured using a simple query language, which\nprovides most common filter and operator functionality.\n\nThe identifier for an attribute to use in a query condition is always the\nID of the attribute as defined in the type definition. For custom defined attributes\nthe prefix custom is required in the search term (e.g. `custom.color = {1}`),\nwhile for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the\nactual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing\nwildcards will be used to support substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support\ncase insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for\nsubstring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT'\nand nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as\nadditional search parameters. Each passed object is related to a\nplaceholder in the query string. The placeholder must be an Integer that\nis surrounded by braces. The first Integer value must be '0', the second\n'1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of\nattribute names to sort by. Each sort attribute name may be followed by an\noptional sort direction specifier ('asc' | 'desc'). Default sorting directions is\nascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is\ncurrently not supported.\n\nSometimes it is desired to get all instances with a special sorting condition.\nThis can be easily done by providing the 'sortString' in combination with\nan empty 'queryString', e.g. `querySystemObjects(\"sample\", \"\", \"ID asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static queryProductLists(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryproductlists", + "productlistmgr.queryproductlists" + ], + "title": "ProductListMgr.queryProductLists" + }, + { + "description": "Removes the specified product list from the system.", + "id": "script-api:dw/customer/ProductListMgr#removeProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "productList", + "type": "ProductList" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.removeProductList", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified product list from the system.", + "heading": "Description" + } + ], + "signature": "static removeProductList(productList: ProductList): void", + "source": "script-api", + "tags": [ + "removeproductlist", + "productlistmgr.removeproductlist" + ], + "title": "ProductListMgr.removeProductList" + }, + { + "description": "Removes the specified product list from the system.", + "id": "script-api:dw/customer/ProductListMgr#removeProductList", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "productList", + "type": "ProductList" + } + ], + "parentId": "script-api:dw/customer/ProductListMgr", + "qualifiedName": "dw.customer.ProductListMgr.removeProductList", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified product list from the system.", + "heading": "Description" + } + ], + "signature": "static removeProductList(productList: ProductList): void", + "source": "script-api", + "tags": [ + "removeproductlist", + "productlistmgr.removeproductlist" + ], + "title": "ProductListMgr.removeProductList" + }, + { + "description": "A ProductListRegistrant is typically associated with an event related product list such as a gift registry. It holds information about a person associated with the event such as a bride or groom.", + "id": "script-api:dw/customer/ProductListRegistrant", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.ProductListRegistrant", + "sections": [ + { + "body": "A ProductListRegistrant is typically associated with an event related product list\nsuch as a gift registry. It holds information about a person associated with the\nevent such as a bride or groom.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productlistregistrant", + "dw.customer.productlistregistrant", + "dw/customer" + ], + "title": "ProductListRegistrant" + }, + { + "description": "Returns the email address of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.email", + "sections": [ + { + "body": "Returns the email address of the registrant or null.", + "heading": "Description" + } + ], + "signature": "email: string | null", + "source": "script-api", + "tags": [ + "email", + "productlistregistrant.email" + ], + "title": "ProductListRegistrant.email" + }, + { + "description": "Returns the first name of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.firstName", + "sections": [ + { + "body": "Returns the first name of the registrant or null.", + "heading": "Description" + } + ], + "signature": "firstName: string | null", + "source": "script-api", + "tags": [ + "firstname", + "productlistregistrant.firstname" + ], + "title": "ProductListRegistrant.firstName" + }, + { + "description": "Returns the email address of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getEmail", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the email address of the registrant or null.", + "heading": "Description" + } + ], + "signature": "getEmail(): string | null", + "source": "script-api", + "tags": [ + "getemail", + "productlistregistrant.getemail" + ], + "title": "ProductListRegistrant.getEmail" + }, + { + "description": "Returns the first name of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getFirstName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the first name of the registrant or null.", + "heading": "Description" + } + ], + "signature": "getFirstName(): string | null", + "source": "script-api", + "tags": [ + "getfirstname", + "productlistregistrant.getfirstname" + ], + "title": "ProductListRegistrant.getFirstName" + }, + { + "description": "Returns the last name of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getLastName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last name of the registrant or null.", + "heading": "Description" + } + ], + "signature": "getLastName(): string | null", + "source": "script-api", + "tags": [ + "getlastname", + "productlistregistrant.getlastname" + ], + "title": "ProductListRegistrant.getLastName" + }, + { + "description": "Returns the role of the registrant or null. The role of a registrant can be for example the bride of a bridal couple.", + "id": "script-api:dw/customer/ProductListRegistrant#getRole", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.getRole", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the role of the registrant or null. The role of a registrant\ncan be for example the bride of a bridal couple.", + "heading": "Description" + } + ], + "signature": "getRole(): string | null", + "source": "script-api", + "tags": [ + "getrole", + "productlistregistrant.getrole" + ], + "title": "ProductListRegistrant.getRole" + }, + { + "description": "Returns the last name of the registrant or null.", + "id": "script-api:dw/customer/ProductListRegistrant#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.lastName", + "sections": [ + { + "body": "Returns the last name of the registrant or null.", + "heading": "Description" + } + ], + "signature": "lastName: string | null", + "source": "script-api", + "tags": [ + "lastname", + "productlistregistrant.lastname" + ], + "title": "ProductListRegistrant.lastName" + }, + { + "description": "Returns the role of the registrant or null. The role of a registrant can be for example the bride of a bridal couple.", + "id": "script-api:dw/customer/ProductListRegistrant#role", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.role", + "sections": [ + { + "body": "Returns the role of the registrant or null. The role of a registrant\ncan be for example the bride of a bridal couple.", + "heading": "Description" + } + ], + "signature": "role: string | null", + "source": "script-api", + "tags": [ + "role", + "productlistregistrant.role" + ], + "title": "ProductListRegistrant.role" + }, + { + "description": "Sets the email address of the registrant.", + "id": "script-api:dw/customer/ProductListRegistrant#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "email", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the email address of the registrant.", + "heading": "Description" + } + ], + "signature": "setEmail(email: string): void", + "source": "script-api", + "tags": [ + "setemail", + "productlistregistrant.setemail" + ], + "title": "ProductListRegistrant.setEmail" + }, + { + "description": "Sets the first name of the registrant.", + "id": "script-api:dw/customer/ProductListRegistrant#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "firstName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setFirstName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the first name of the registrant.", + "heading": "Description" + } + ], + "signature": "setFirstName(firstName: string): void", + "source": "script-api", + "tags": [ + "setfirstname", + "productlistregistrant.setfirstname" + ], + "title": "ProductListRegistrant.setFirstName" + }, + { + "description": "Sets the last name of the registrant.", + "id": "script-api:dw/customer/ProductListRegistrant#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "lastName", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setLastName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the last name of the registrant.", + "heading": "Description" + } + ], + "signature": "setLastName(lastName: string): void", + "source": "script-api", + "tags": [ + "setlastname", + "productlistregistrant.setlastname" + ], + "title": "ProductListRegistrant.setLastName" + }, + { + "description": "Sets the role of the registrant.", + "id": "script-api:dw/customer/ProductListRegistrant#setRole", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "role", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/ProductListRegistrant", + "qualifiedName": "dw.customer.ProductListRegistrant.setRole", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the role of the registrant.", + "heading": "Description" + } + ], + "signature": "setRole(role: string): void", + "source": "script-api", + "tags": [ + "setrole", + "productlistregistrant.setrole" + ], + "title": "ProductListRegistrant.setRole" + }, + { + "description": "The class represents a customer profile. It also provides access to the customers address book and credentials.", + "id": "script-api:dw/customer/Profile", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Profile", + "sections": [ + { + "body": "The class represents a customer profile. It also provides access to the\ncustomers address book and credentials.\n\nNote: this class handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + }, + { + "body": "Extends `EncryptedObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "profile", + "dw.customer.profile", + "dw/customer" + ], + "title": "Profile" + }, + { + "description": "Returns the customer's address book.", + "id": "script-api:dw/customer/Profile#addressBook", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.addressBook", + "sections": [ + { + "body": "Returns the customer's address book.", + "heading": "Description" + } + ], + "signature": "readonly addressBook: AddressBook", + "source": "script-api", + "tags": [ + "addressbook", + "profile.addressbook" + ], + "title": "Profile.addressBook" + }, + { + "description": "Returns the customer's birthday as a date.", + "id": "script-api:dw/customer/Profile#birthday", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.birthday", + "sections": [ + { + "body": "Returns the customer's birthday as a date.", + "heading": "Description" + } + ], + "signature": "birthday: Date", + "source": "script-api", + "tags": [ + "birthday", + "profile.birthday" + ], + "title": "Profile.birthday" + }, + { + "description": "Returns the customer's company name.", + "id": "script-api:dw/customer/Profile#companyName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.companyName", + "sections": [ + { + "body": "Returns the customer's company name.", + "heading": "Description" + } + ], + "signature": "companyName: string", + "source": "script-api", + "tags": [ + "companyname", + "profile.companyname" + ], + "title": "Profile.companyName" + }, + { + "description": "Returns the customer's credentials.", + "id": "script-api:dw/customer/Profile#credentials", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.credentials", + "sections": [ + { + "body": "Returns the customer's credentials.", + "heading": "Description" + } + ], + "signature": "readonly credentials: Credentials", + "source": "script-api", + "tags": [ + "credentials", + "profile.credentials" + ], + "title": "Profile.credentials" + }, + { + "description": "Returns the customer object related to this profile.", + "id": "script-api:dw/customer/Profile#customer", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.customer", + "sections": [ + { + "body": "Returns the customer object related to this profile.", + "heading": "Description" + } + ], + "signature": "readonly customer: Customer", + "source": "script-api", + "tags": [ + "customer", + "profile.customer" + ], + "title": "Profile.customer" + }, + { + "description": "Returns the customer's number, which is a number used to identify the Customer.", + "id": "script-api:dw/customer/Profile#customerNo", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.customerNo", + "sections": [ + { + "body": "Returns the customer's number, which is a number used to identify the Customer.", + "heading": "Description" + } + ], + "signature": "readonly customerNo: string", + "source": "script-api", + "tags": [ + "customerno", + "profile.customerno" + ], + "title": "Profile.customerNo" + }, + { + "description": "Returns the customer's email address.", + "id": "script-api:dw/customer/Profile#email", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.email", + "sections": [ + { + "body": "Returns the customer's email address.", + "heading": "Description" + } + ], + "signature": "email: string", + "source": "script-api", + "tags": [ + "email", + "profile.email" + ], + "title": "Profile.email" + }, + { + "description": "Returns whether the customer's email has been verified.", + "id": "script-api:dw/customer/Profile#emailVerified", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.emailVerified", + "sections": [ + { + "body": "Returns whether the customer's email has been verified.\n\nThis is a read-only field. The field value cannot be set externally and will be set in platform based on\nfollowing rules:\n\n- If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will\nalways be NULL;\n- If the Email Verification Site Preference under LoginPreferences is enabled:\n\n- If the incoming email value is the same as existing email and email was previously verified, the value for\nthis field will remain unchanged as TRUE;\n- If the incoming email value is the same as existing email and email was not previously verified, the value\nfor this field will remain unchanged as FALSE;\n- If the incoming email value is not the same as existing email, the value for this field will be set to FALSE\nno matter the previous state;", + "heading": "Description" + } + ], + "signature": "readonly emailVerified: boolean", + "source": "script-api", + "tags": [ + "emailverified", + "profile.emailverified" + ], + "title": "Profile.emailVerified" + }, + { + "description": "Returns the fax number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#fax", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.fax", + "sections": [ + { + "body": "Returns the fax number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "fax: string", + "source": "script-api", + "tags": [ + "fax", + "profile.fax" + ], + "title": "Profile.fax" + }, + { + "description": "Indicates that the customer is female when set to true.", + "id": "script-api:dw/customer/Profile#female", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.female", + "sections": [ + { + "body": "Indicates that the customer is female when set to true.", + "heading": "Description" + } + ], + "signature": "readonly female: boolean", + "source": "script-api", + "tags": [ + "female", + "profile.female" + ], + "title": "Profile.female" + }, + { + "description": "Returns the customer's first name.", + "id": "script-api:dw/customer/Profile#firstName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.firstName", + "sections": [ + { + "body": "Returns the customer's first name.", + "heading": "Description" + } + ], + "signature": "firstName: string", + "source": "script-api", + "tags": [ + "firstname", + "profile.firstname" + ], + "title": "Profile.firstName" + }, + { + "description": "Returns the customer's gender.", + "id": "script-api:dw/customer/Profile#gender", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.gender", + "sections": [ + { + "body": "Returns the customer's gender.", + "heading": "Description" + } + ], + "signature": "gender: EnumValue", + "source": "script-api", + "tags": [ + "gender", + "profile.gender" + ], + "title": "Profile.gender" + }, + { + "description": "Returns the customer's address book.", + "id": "script-api:dw/customer/Profile#getAddressBook", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getAddressBook", + "returns": { + "type": "AddressBook" + }, + "sections": [ + { + "body": "Returns the customer's address book.", + "heading": "Description" + } + ], + "signature": "getAddressBook(): AddressBook", + "source": "script-api", + "tags": [ + "getaddressbook", + "profile.getaddressbook" + ], + "title": "Profile.getAddressBook" + }, + { + "description": "Returns the customer's birthday as a date.", + "id": "script-api:dw/customer/Profile#getBirthday", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getBirthday", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the customer's birthday as a date.", + "heading": "Description" + } + ], + "signature": "getBirthday(): Date", + "source": "script-api", + "tags": [ + "getbirthday", + "profile.getbirthday" + ], + "title": "Profile.getBirthday" + }, + { + "description": "Returns the customer's company name.", + "id": "script-api:dw/customer/Profile#getCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCompanyName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's company name.", + "heading": "Description" + } + ], + "signature": "getCompanyName(): string", + "source": "script-api", + "tags": [ + "getcompanyname", + "profile.getcompanyname" + ], + "title": "Profile.getCompanyName" + }, + { + "description": "Returns the customer's credentials.", + "id": "script-api:dw/customer/Profile#getCredentials", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCredentials", + "returns": { + "type": "Credentials" + }, + "sections": [ + { + "body": "Returns the customer's credentials.", + "heading": "Description" + } + ], + "signature": "getCredentials(): Credentials", + "source": "script-api", + "tags": [ + "getcredentials", + "profile.getcredentials" + ], + "title": "Profile.getCredentials" + }, + { + "description": "Returns the customer object related to this profile.", + "id": "script-api:dw/customer/Profile#getCustomer", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Returns the customer object related to this profile.", + "heading": "Description" + } + ], + "signature": "getCustomer(): Customer", + "source": "script-api", + "tags": [ + "getcustomer", + "profile.getcustomer" + ], + "title": "Profile.getCustomer" + }, + { + "description": "Returns the customer's number, which is a number used to identify the Customer.", + "id": "script-api:dw/customer/Profile#getCustomerNo", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getCustomerNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's number, which is a number used to identify the Customer.", + "heading": "Description" + } + ], + "signature": "getCustomerNo(): string", + "source": "script-api", + "tags": [ + "getcustomerno", + "profile.getcustomerno" + ], + "title": "Profile.getCustomerNo" + }, + { + "description": "Returns the customer's email address.", + "id": "script-api:dw/customer/Profile#getEmail", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's email address.", + "heading": "Description" + } + ], + "signature": "getEmail(): string", + "source": "script-api", + "tags": [ + "getemail", + "profile.getemail" + ], + "title": "Profile.getEmail" + }, + { + "description": "Returns the fax number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#getFax", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getFax", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the fax number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "getFax(): string", + "source": "script-api", + "tags": [ + "getfax", + "profile.getfax" + ], + "title": "Profile.getFax" + }, + { + "description": "Returns the customer's first name.", + "id": "script-api:dw/customer/Profile#getFirstName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getFirstName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's first name.", + "heading": "Description" + } + ], + "signature": "getFirstName(): string", + "source": "script-api", + "tags": [ + "getfirstname", + "profile.getfirstname" + ], + "title": "Profile.getFirstName" + }, + { + "description": "Returns the customer's gender.", + "id": "script-api:dw/customer/Profile#getGender", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getGender", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the customer's gender.", + "heading": "Description" + } + ], + "signature": "getGender(): EnumValue", + "source": "script-api", + "tags": [ + "getgender", + "profile.getgender" + ], + "title": "Profile.getGender" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/customer/Profile#getJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getJobTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "getJobTitle(): string", + "source": "script-api", + "tags": [ + "getjobtitle", + "profile.getjobtitle" + ], + "title": "Profile.getJobTitle" + }, + { + "description": "Returns the last login time of the customer.", + "id": "script-api:dw/customer/Profile#getLastLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastLoginTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the last login time of the customer.", + "heading": "Description" + } + ], + "signature": "getLastLoginTime(): Date", + "source": "script-api", + "tags": [ + "getlastlogintime", + "profile.getlastlogintime" + ], + "title": "Profile.getLastLoginTime" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/customer/Profile#getLastName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "getLastName(): string", + "source": "script-api", + "tags": [ + "getlastname", + "profile.getlastname" + ], + "title": "Profile.getLastName" + }, + { + "description": "Returns the last visit time of the customer.", + "id": "script-api:dw/customer/Profile#getLastVisitTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getLastVisitTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the last visit time of the customer.", + "heading": "Description" + } + ], + "signature": "getLastVisitTime(): Date", + "source": "script-api", + "tags": [ + "getlastvisittime", + "profile.getlastvisittime" + ], + "title": "Profile.getLastVisitTime" + }, + { + "description": "Returns the upcoming customer's birthday as a date. If the customer already had birthday this year the method returns the birthday of the next year. Otherwise its birthday in this year. If the customer has not set a birthday this method returns null.", + "id": "script-api:dw/customer/Profile#getNextBirthday", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getNextBirthday", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the upcoming customer's birthday as a date.\nIf the customer already had birthday this year the method returns the birthday of the next year.\nOtherwise its birthday in this year.\nIf the customer has not set a birthday this method returns null.", + "heading": "Description" + } + ], + "signature": "getNextBirthday(): Date", + "source": "script-api", + "tags": [ + "getnextbirthday", + "profile.getnextbirthday" + ], + "title": "Profile.getNextBirthday" + }, + { + "description": "Returns the business phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#getPhoneBusiness", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneBusiness", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the business phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "getPhoneBusiness(): string", + "source": "script-api", + "tags": [ + "getphonebusiness", + "profile.getphonebusiness" + ], + "title": "Profile.getPhoneBusiness" + }, + { + "description": "Returns the phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#getPhoneHome", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneHome", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "getPhoneHome(): string", + "source": "script-api", + "tags": [ + "getphonehome", + "profile.getphonehome" + ], + "title": "Profile.getPhoneHome" + }, + { + "description": "Returns the mobile phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#getPhoneMobile", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPhoneMobile", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the mobile phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "getPhoneMobile(): string", + "source": "script-api", + "tags": [ + "getphonemobile", + "profile.getphonemobile" + ], + "title": "Profile.getPhoneMobile" + }, + { + "description": "Returns the customer's preferred locale.", + "id": "script-api:dw/customer/Profile#getPreferredLocale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreferredLocale", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's preferred locale.", + "heading": "Description" + } + ], + "signature": "getPreferredLocale(): string", + "source": "script-api", + "tags": [ + "getpreferredlocale", + "profile.getpreferredlocale" + ], + "title": "Profile.getPreferredLocale" + }, + { + "description": "Returns the time the customer logged in prior to the current login.", + "id": "script-api:dw/customer/Profile#getPreviousLoginTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreviousLoginTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the time the customer logged in prior to the current login.", + "heading": "Description" + } + ], + "signature": "getPreviousLoginTime(): Date", + "source": "script-api", + "tags": [ + "getpreviouslogintime", + "profile.getpreviouslogintime" + ], + "title": "Profile.getPreviousLoginTime" + }, + { + "description": "Returns the time the customer visited the store prior to the current visit.", + "id": "script-api:dw/customer/Profile#getPreviousVisitTime", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getPreviousVisitTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the time the customer visited the store prior to the current visit.", + "heading": "Description" + } + ], + "signature": "getPreviousVisitTime(): Date", + "source": "script-api", + "tags": [ + "getpreviousvisittime", + "profile.getpreviousvisittime" + ], + "title": "Profile.getPreviousVisitTime" + }, + { + "description": "Returns the salutation to use for the customer.", + "id": "script-api:dw/customer/Profile#getSalutation", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSalutation", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the salutation to use for the customer.", + "heading": "Description" + } + ], + "signature": "getSalutation(): string", + "source": "script-api", + "tags": [ + "getsalutation", + "profile.getsalutation" + ], + "title": "Profile.getSalutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/customer/Profile#getSecondName", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSecondName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "getSecondName(): string", + "source": "script-api", + "tags": [ + "getsecondname", + "profile.getsecondname" + ], + "title": "Profile.getSecondName" + }, + { + "description": "Returns the customer's suffix, such as \"Jr.\" or \"Sr.\".", + "id": "script-api:dw/customer/Profile#getSuffix", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getSuffix", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's suffix, such as \"Jr.\" or \"Sr.\".", + "heading": "Description" + } + ], + "signature": "getSuffix(): string", + "source": "script-api", + "tags": [ + "getsuffix", + "profile.getsuffix" + ], + "title": "Profile.getSuffix" + }, + { + "description": "Returns the tax ID value. The value is returned either plain text if the current context allows plain text access, or if it's not allowed, the ID value will be returned masked. The following criteria must be met in order to have plain text access:", + "id": "script-api:dw/customer/Profile#getTaxID", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tax ID value. The value is returned either plain\ntext if the current context allows plain text access, or\nif it's not allowed, the ID value will be returned masked.\nThe following criteria must be met in order to have plain text access:\n\n- the method call must happen in the context of a storefront request;\n- the current customer must be registered and authenticated;\n- it is the profile of the current customer;\n- and the current protocol is HTTPS.", + "heading": "Description" + } + ], + "signature": "getTaxID(): string", + "source": "script-api", + "tags": [ + "gettaxid", + "profile.gettaxid" + ], + "title": "Profile.getTaxID" + }, + { + "description": "Returns the masked value of the tax ID.", + "id": "script-api:dw/customer/Profile#getTaxIDMasked", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxIDMasked", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the masked value of the tax ID.", + "heading": "Description" + } + ], + "signature": "getTaxIDMasked(): string", + "source": "script-api", + "tags": [ + "gettaxidmasked", + "profile.gettaxidmasked" + ], + "title": "Profile.getTaxIDMasked" + }, + { + "description": "Returns the tax ID type.", + "id": "script-api:dw/customer/Profile#getTaxIDType", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTaxIDType", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the tax ID type.", + "heading": "Description" + } + ], + "signature": "getTaxIDType(): EnumValue", + "source": "script-api", + "tags": [ + "gettaxidtype", + "profile.gettaxidtype" + ], + "title": "Profile.getTaxIDType" + }, + { + "description": "Returns the customer's title, such as \"Mrs\" or \"Mr\".", + "id": "script-api:dw/customer/Profile#getTitle", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's title, such as \"Mrs\" or \"Mr\".", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "profile.gettitle" + ], + "title": "Profile.getTitle" + }, + { + "description": "Returns the wallet of this customer.", + "id": "script-api:dw/customer/Profile#getWallet", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.getWallet", + "returns": { + "type": "Wallet" + }, + "sections": [ + { + "body": "Returns the wallet of this customer.", + "heading": "Description" + } + ], + "signature": "getWallet(): Wallet", + "source": "script-api", + "tags": [ + "getwallet", + "profile.getwallet" + ], + "title": "Profile.getWallet" + }, + { + "description": "Returns whether the customer's email has been verified.", + "id": "script-api:dw/customer/Profile#isEmailVerified", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isEmailVerified", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the customer's email has been verified.\n\nThis is a read-only field. The field value cannot be set externally and will be set in platform based on\nfollowing rules:\n\n- If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will\nalways be NULL;\n- If the Email Verification Site Preference under LoginPreferences is enabled:\n\n- If the incoming email value is the same as existing email and email was previously verified, the value for\nthis field will remain unchanged as TRUE;\n- If the incoming email value is the same as existing email and email was not previously verified, the value\nfor this field will remain unchanged as FALSE;\n- If the incoming email value is not the same as existing email, the value for this field will be set to FALSE\nno matter the previous state;", + "heading": "Description" + } + ], + "signature": "isEmailVerified(): boolean", + "source": "script-api", + "tags": [ + "isemailverified", + "profile.isemailverified" + ], + "title": "Profile.isEmailVerified" + }, + { + "description": "Indicates that the customer is female when set to true.", + "id": "script-api:dw/customer/Profile#isFemale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isFemale", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates that the customer is female when set to true.", + "heading": "Description" + } + ], + "signature": "isFemale(): boolean", + "source": "script-api", + "tags": [ + "isfemale", + "profile.isfemale" + ], + "title": "Profile.isFemale" + }, + { + "description": "Indicates that the customer is male when set to true.", + "id": "script-api:dw/customer/Profile#isMale", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.isMale", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates that the customer is male when set to true.", + "heading": "Description" + } + ], + "signature": "isMale(): boolean", + "source": "script-api", + "tags": [ + "ismale", + "profile.ismale" + ], + "title": "Profile.isMale" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/customer/Profile#jobTitle", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.jobTitle", + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "jobTitle: string", + "source": "script-api", + "tags": [ + "jobtitle", + "profile.jobtitle" + ], + "title": "Profile.jobTitle" + }, + { + "description": "Returns the last login time of the customer.", + "id": "script-api:dw/customer/Profile#lastLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastLoginTime", + "sections": [ + { + "body": "Returns the last login time of the customer.", + "heading": "Description" + } + ], + "signature": "readonly lastLoginTime: Date", + "source": "script-api", + "tags": [ + "lastlogintime", + "profile.lastlogintime" + ], + "title": "Profile.lastLoginTime" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/customer/Profile#lastName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastName", + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "lastName: string", + "source": "script-api", + "tags": [ + "lastname", + "profile.lastname" + ], + "title": "Profile.lastName" + }, + { + "description": "Returns the last visit time of the customer.", + "id": "script-api:dw/customer/Profile#lastVisitTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.lastVisitTime", + "sections": [ + { + "body": "Returns the last visit time of the customer.", + "heading": "Description" + } + ], + "signature": "readonly lastVisitTime: Date", + "source": "script-api", + "tags": [ + "lastvisittime", + "profile.lastvisittime" + ], + "title": "Profile.lastVisitTime" + }, + { + "description": "Indicates that the customer is male when set to true.", + "id": "script-api:dw/customer/Profile#male", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.male", + "sections": [ + { + "body": "Indicates that the customer is male when set to true.", + "heading": "Description" + } + ], + "signature": "readonly male: boolean", + "source": "script-api", + "tags": [ + "male", + "profile.male" + ], + "title": "Profile.male" + }, + { + "description": "Returns the upcoming customer's birthday as a date. If the customer already had birthday this year the method returns the birthday of the next year. Otherwise its birthday in this year. If the customer has not set a birthday this method returns null.", + "id": "script-api:dw/customer/Profile#nextBirthday", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.nextBirthday", + "sections": [ + { + "body": "Returns the upcoming customer's birthday as a date.\nIf the customer already had birthday this year the method returns the birthday of the next year.\nOtherwise its birthday in this year.\nIf the customer has not set a birthday this method returns null.", + "heading": "Description" + } + ], + "signature": "readonly nextBirthday: Date", + "source": "script-api", + "tags": [ + "nextbirthday", + "profile.nextbirthday" + ], + "title": "Profile.nextBirthday" + }, + { + "description": "Returns the business phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#phoneBusiness", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneBusiness", + "sections": [ + { + "body": "Returns the business phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "phoneBusiness: string", + "source": "script-api", + "tags": [ + "phonebusiness", + "profile.phonebusiness" + ], + "title": "Profile.phoneBusiness" + }, + { + "description": "Returns the phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#phoneHome", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneHome", + "sections": [ + { + "body": "Returns the phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "phoneHome: string", + "source": "script-api", + "tags": [ + "phonehome", + "profile.phonehome" + ], + "title": "Profile.phoneHome" + }, + { + "description": "Returns the mobile phone number to use for the customer.", + "id": "script-api:dw/customer/Profile#phoneMobile", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.phoneMobile", + "sections": [ + { + "body": "Returns the mobile phone number to use for the customer.", + "heading": "Description" + } + ], + "signature": "phoneMobile: string", + "source": "script-api", + "tags": [ + "phonemobile", + "profile.phonemobile" + ], + "title": "Profile.phoneMobile" + }, + { + "description": "Returns the customer's preferred locale.", + "id": "script-api:dw/customer/Profile#preferredLocale", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.preferredLocale", + "sections": [ + { + "body": "Returns the customer's preferred locale.", + "heading": "Description" + } + ], + "signature": "preferredLocale: string", + "source": "script-api", + "tags": [ + "preferredlocale", + "profile.preferredlocale" + ], + "title": "Profile.preferredLocale" + }, + { + "description": "Returns the time the customer logged in prior to the current login.", + "id": "script-api:dw/customer/Profile#previousLoginTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.previousLoginTime", + "sections": [ + { + "body": "Returns the time the customer logged in prior to the current login.", + "heading": "Description" + } + ], + "signature": "readonly previousLoginTime: Date", + "source": "script-api", + "tags": [ + "previouslogintime", + "profile.previouslogintime" + ], + "title": "Profile.previousLoginTime" + }, + { + "description": "Returns the time the customer visited the store prior to the current visit.", + "id": "script-api:dw/customer/Profile#previousVisitTime", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.previousVisitTime", + "sections": [ + { + "body": "Returns the time the customer visited the store prior to the current visit.", + "heading": "Description" + } + ], + "signature": "readonly previousVisitTime: Date", + "source": "script-api", + "tags": [ + "previousvisittime", + "profile.previousvisittime" + ], + "title": "Profile.previousVisitTime" + }, + { + "description": "Returns the salutation to use for the customer.", + "id": "script-api:dw/customer/Profile#salutation", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.salutation", + "sections": [ + { + "body": "Returns the salutation to use for the customer.", + "heading": "Description" + } + ], + "signature": "salutation: string", + "source": "script-api", + "tags": [ + "salutation", + "profile.salutation" + ], + "title": "Profile.salutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/customer/Profile#secondName", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.secondName", + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "secondName: string", + "source": "script-api", + "tags": [ + "secondname", + "profile.secondname" + ], + "title": "Profile.secondName" + }, + { + "description": "Sets the customer's birthday as a date.", + "id": "script-api:dw/customer/Profile#setBirthday", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "Date" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setBirthday", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's birthday as a date.", + "heading": "Description" + } + ], + "signature": "setBirthday(aValue: Date): void", + "source": "script-api", + "tags": [ + "setbirthday", + "profile.setbirthday" + ], + "title": "Profile.setBirthday" + }, + { + "description": "Sets the customer's company name.", + "id": "script-api:dw/customer/Profile#setCompanyName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setCompanyName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's company name.", + "heading": "Description" + } + ], + "signature": "setCompanyName(aValue: string): void", + "source": "script-api", + "tags": [ + "setcompanyname", + "profile.setcompanyname" + ], + "title": "Profile.setCompanyName" + }, + { + "description": "Sets the customer's email address.", + "id": "script-api:dw/customer/Profile#setEmail", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's email address.", + "heading": "Description" + } + ], + "signature": "setEmail(aValue: string): void", + "source": "script-api", + "tags": [ + "setemail", + "profile.setemail" + ], + "title": "Profile.setEmail" + }, + { + "description": "Sets the fax number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#setFax", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "number", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setFax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the fax number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setFax(number: string): void", + "source": "script-api", + "tags": [ + "setfax", + "profile.setfax" + ], + "title": "Profile.setFax" + }, + { + "description": "Sets the customer's first name.", + "id": "script-api:dw/customer/Profile#setFirstName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setFirstName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's first name.", + "heading": "Description" + } + ], + "signature": "setFirstName(aValue: string): void", + "source": "script-api", + "tags": [ + "setfirstname", + "profile.setfirstname" + ], + "title": "Profile.setFirstName" + }, + { + "description": "Sets the customer's gender.", + "id": "script-api:dw/customer/Profile#setGender", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setGender", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's gender.", + "heading": "Description" + } + ], + "signature": "setGender(aValue: number): void", + "source": "script-api", + "tags": [ + "setgender", + "profile.setgender" + ], + "title": "Profile.setGender" + }, + { + "description": "Sets the customer's job title.", + "id": "script-api:dw/customer/Profile#setJobTitle", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setJobTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's job title.", + "heading": "Description" + } + ], + "signature": "setJobTitle(aValue: string): void", + "source": "script-api", + "tags": [ + "setjobtitle", + "profile.setjobtitle" + ], + "title": "Profile.setJobTitle" + }, + { + "description": "Sets the customer's last name.", + "id": "script-api:dw/customer/Profile#setLastName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setLastName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's last name.", + "heading": "Description" + } + ], + "signature": "setLastName(aValue: string): void", + "source": "script-api", + "tags": [ + "setlastname", + "profile.setlastname" + ], + "title": "Profile.setLastName" + }, + { + "description": "Sets the business phone number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#setPhoneBusiness", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "number", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneBusiness", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the business phone number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setPhoneBusiness(number: string): void", + "source": "script-api", + "tags": [ + "setphonebusiness", + "profile.setphonebusiness" + ], + "title": "Profile.setPhoneBusiness" + }, + { + "description": "Sets the phone number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#setPhoneHome", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "number", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneHome", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the phone number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setPhoneHome(number: string): void", + "source": "script-api", + "tags": [ + "setphonehome", + "profile.setphonehome" + ], + "title": "Profile.setPhoneHome" + }, + { + "description": "Sets the mobile phone number to use for the customer. The length is restricted to 32 characters.", + "id": "script-api:dw/customer/Profile#setPhoneMobile", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "number", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPhoneMobile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the mobile phone number to use for the customer.\nThe length is restricted to 32 characters.", + "heading": "Description" + } + ], + "signature": "setPhoneMobile(number: string): void", + "source": "script-api", + "tags": [ + "setphonemobile", + "profile.setphonemobile" + ], + "title": "Profile.setPhoneMobile" + }, + { + "description": "Sets the customer's preferred locale.", + "id": "script-api:dw/customer/Profile#setPreferredLocale", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setPreferredLocale", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's preferred locale.", + "heading": "Description" + } + ], + "signature": "setPreferredLocale(aValue: string): void", + "source": "script-api", + "tags": [ + "setpreferredlocale", + "profile.setpreferredlocale" + ], + "title": "Profile.setPreferredLocale" + }, + { + "deprecated": { + "message": "Use setSalutation" + }, + "description": "Sets the salutation to use for the customer.", + "id": "script-api:dw/customer/Profile#setSaluation", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "salutation", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSaluation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the salutation to use for the customer.", + "heading": "Description" + } + ], + "signature": "setSaluation(salutation: string): void", + "source": "script-api", + "tags": [ + "setsaluation", + "profile.setsaluation" + ], + "title": "Profile.setSaluation" + }, + { + "description": "Sets the salutation to use for the customer.", + "id": "script-api:dw/customer/Profile#setSalutation", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "salutation", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSalutation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the salutation to use for the customer.", + "heading": "Description" + } + ], + "signature": "setSalutation(salutation: string): void", + "source": "script-api", + "tags": [ + "setsalutation", + "profile.setsalutation" + ], + "title": "Profile.setSalutation" + }, + { + "description": "Sets the customer's second name.", + "id": "script-api:dw/customer/Profile#setSecondName", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSecondName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's second name.", + "heading": "Description" + } + ], + "signature": "setSecondName(aValue: string): void", + "source": "script-api", + "tags": [ + "setsecondname", + "profile.setsecondname" + ], + "title": "Profile.setSecondName" + }, + { + "description": "Sets the the customer's suffix.", + "id": "script-api:dw/customer/Profile#setSuffix", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setSuffix", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the the customer's suffix.", + "heading": "Description" + } + ], + "signature": "setSuffix(aValue: string): void", + "source": "script-api", + "tags": [ + "setsuffix", + "profile.setsuffix" + ], + "title": "Profile.setSuffix" + }, + { + "description": "Sets the tax ID value. The value can be set if the current context allows write access. The current context allows write access if the currently logged in user owns this profile and the connection is secured.", + "id": "script-api:dw/customer/Profile#setTaxID", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "taxID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTaxID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tax ID value. The value can be set if the current context\nallows write access.\nThe current context allows write access if the currently\nlogged in user owns this profile and the connection is secured.", + "heading": "Description" + } + ], + "signature": "setTaxID(taxID: string): void", + "source": "script-api", + "tags": [ + "settaxid", + "profile.settaxid" + ], + "title": "Profile.setTaxID" + }, + { + "description": "Sets the tax ID type.", + "id": "script-api:dw/customer/Profile#setTaxIDType", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "taxIdType", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTaxIDType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tax ID type.", + "heading": "Description" + } + ], + "signature": "setTaxIDType(taxIdType: string): void", + "source": "script-api", + "tags": [ + "settaxidtype", + "profile.settaxidtype" + ], + "title": "Profile.setTaxIDType" + }, + { + "description": "Sets the customer's title.", + "id": "script-api:dw/customer/Profile#setTitle", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.setTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's title.", + "heading": "Description" + } + ], + "signature": "setTitle(aValue: string): void", + "source": "script-api", + "tags": [ + "settitle", + "profile.settitle" + ], + "title": "Profile.setTitle" + }, + { + "description": "Returns the customer's suffix, such as \"Jr.\" or \"Sr.\".", + "id": "script-api:dw/customer/Profile#suffix", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.suffix", + "sections": [ + { + "body": "Returns the customer's suffix, such as \"Jr.\" or \"Sr.\".", + "heading": "Description" + } + ], + "signature": "suffix: string", + "source": "script-api", + "tags": [ + "suffix", + "profile.suffix" + ], + "title": "Profile.suffix" + }, + { + "description": "Returns the tax ID value. The value is returned either plain text if the current context allows plain text access, or if it's not allowed, the ID value will be returned masked. The following criteria must be met in order to have plain text access:", + "id": "script-api:dw/customer/Profile#taxID", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxID", + "sections": [ + { + "body": "Returns the tax ID value. The value is returned either plain\ntext if the current context allows plain text access, or\nif it's not allowed, the ID value will be returned masked.\nThe following criteria must be met in order to have plain text access:\n\n- the method call must happen in the context of a storefront request;\n- the current customer must be registered and authenticated;\n- it is the profile of the current customer;\n- and the current protocol is HTTPS.", + "heading": "Description" + } + ], + "signature": "taxID: string", + "source": "script-api", + "tags": [ + "taxid", + "profile.taxid" + ], + "title": "Profile.taxID" + }, + { + "description": "Returns the masked value of the tax ID.", + "id": "script-api:dw/customer/Profile#taxIDMasked", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxIDMasked", + "sections": [ + { + "body": "Returns the masked value of the tax ID.", + "heading": "Description" + } + ], + "signature": "readonly taxIDMasked: string", + "source": "script-api", + "tags": [ + "taxidmasked", + "profile.taxidmasked" + ], + "title": "Profile.taxIDMasked" + }, + { + "description": "Returns the tax ID type.", + "id": "script-api:dw/customer/Profile#taxIDType", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.taxIDType", + "sections": [ + { + "body": "Returns the tax ID type.", + "heading": "Description" + } + ], + "signature": "taxIDType: EnumValue", + "source": "script-api", + "tags": [ + "taxidtype", + "profile.taxidtype" + ], + "title": "Profile.taxIDType" + }, + { + "description": "Returns the customer's title, such as \"Mrs\" or \"Mr\".", + "id": "script-api:dw/customer/Profile#title", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.title", + "sections": [ + { + "body": "Returns the customer's title, such as \"Mrs\" or \"Mr\".", + "heading": "Description" + } + ], + "signature": "title: string", + "source": "script-api", + "tags": [ + "title", + "profile.title" + ], + "title": "Profile.title" + }, + { + "description": "Returns the wallet of this customer.", + "id": "script-api:dw/customer/Profile#wallet", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Profile", + "qualifiedName": "dw.customer.Profile.wallet", + "sections": [ + { + "body": "Returns the wallet of this customer.", + "heading": "Description" + } + ], + "signature": "readonly wallet: Wallet", + "source": "script-api", + "tags": [ + "wallet", + "profile.wallet" + ], + "title": "Profile.wallet" + }, + { + "description": "Represents a set of payment instruments associated with a registered customer.", + "id": "script-api:dw/customer/Wallet", + "kind": "class", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer", + "qualifiedName": "dw.customer.Wallet", + "sections": [ + { + "body": "Represents a set of payment instruments associated with a registered customer.\n\nNote: this class allows access to sensitive personal and private\ninformation. Pay attention to appropriate legal and regulatory requirements\nwhen developing.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "wallet", + "dw.customer.wallet", + "dw/customer" + ], + "title": "Wallet" + }, + { + "description": "Creates a new, empty payment instrument object associated with the related customer for the given payment method.", + "id": "script-api:dw/customer/Wallet#createPaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "paymentMethodId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.createPaymentInstrument", + "returns": { + "type": "CustomerPaymentInstrument" + }, + "sections": [ + { + "body": "Creates a new, empty payment instrument object associated with the\nrelated customer for the given payment method.", + "heading": "Description" + } + ], + "signature": "createPaymentInstrument(paymentMethodId: string): CustomerPaymentInstrument", + "source": "script-api", + "tags": [ + "createpaymentinstrument", + "wallet.createpaymentinstrument" + ], + "throws": [ + { + "description": "If passed 'paymentMethodId' is null.", + "type": "NullArgumentException" + } + ], + "title": "Wallet.createPaymentInstrument" + }, + { + "description": "Returns the default payment instrument associated with the related customer. If not available, returns the first payment instrument or null if no payment instruments are associated with the customer.", + "id": "script-api:dw/customer/Wallet#defaultPaymentInstrument", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.defaultPaymentInstrument", + "sections": [ + { + "body": "Returns the default payment instrument associated with the related customer. If not available, returns the first\npayment instrument or null if no payment instruments are associated with the customer.", + "heading": "Description" + } + ], + "signature": "readonly defaultPaymentInstrument: CustomerPaymentInstrument | null", + "source": "script-api", + "tags": [ + "defaultpaymentinstrument", + "wallet.defaultpaymentinstrument" + ], + "title": "Wallet.defaultPaymentInstrument" + }, + { + "description": "Returns the default payment instrument associated with the related customer. If not available, returns the first payment instrument or null if no payment instruments are associated with the customer.", + "id": "script-api:dw/customer/Wallet#getDefaultPaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getDefaultPaymentInstrument", + "returns": { + "type": "CustomerPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the default payment instrument associated with the related customer. If not available, returns the first\npayment instrument or null if no payment instruments are associated with the customer.", + "heading": "Description" + } + ], + "signature": "getDefaultPaymentInstrument(): CustomerPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getdefaultpaymentinstrument", + "wallet.getdefaultpaymentinstrument" + ], + "title": "Wallet.getDefaultPaymentInstrument" + }, + { + "description": "Returns a collection of all payment instruments associated with the related customer.", + "id": "script-api:dw/customer/Wallet#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getPaymentInstruments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all payment instruments associated with the\nrelated customer.", + "heading": "Description" + } + ], + "signature": "getPaymentInstruments(): Collection", + "source": "script-api", + "tags": [ + "getpaymentinstruments", + "wallet.getpaymentinstruments" + ], + "title": "Wallet.getPaymentInstruments" + }, + { + "description": "Returns a collection of all payment instruments associated with the related customer filtered by the given payment method id. If `null` is passed as payment method id all payment instruments of the customer will be retrieved. If for the given payment method id no payment instrument is associated with the customer an empty collection will be returned.", + "id": "script-api:dw/customer/Wallet#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "paymentMethodID", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.getPaymentInstruments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all payment instruments associated with the\nrelated customer filtered by the given payment method id. If\n`null` is passed as payment method id all payment instruments\nof the customer will be retrieved. If for the given payment method id no\npayment instrument is associated with the customer an empty collection\nwill be returned.", + "heading": "Description" + } + ], + "signature": "getPaymentInstruments(paymentMethodID: string): Collection", + "source": "script-api", + "tags": [ + "getpaymentinstruments", + "wallet.getpaymentinstruments" + ], + "title": "Wallet.getPaymentInstruments" + }, + { + "description": "Returns a collection of all payment instruments associated with the related customer.", + "id": "script-api:dw/customer/Wallet#paymentInstruments", + "kind": "property", + "packagePath": "dw/customer", + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.paymentInstruments", + "sections": [ + { + "body": "Returns a collection of all payment instruments associated with the\nrelated customer.", + "heading": "Description" + } + ], + "signature": "readonly paymentInstruments: Collection", + "source": "script-api", + "tags": [ + "paymentinstruments", + "wallet.paymentinstruments" + ], + "title": "Wallet.paymentInstruments" + }, + { + "description": "Removes a payment instrument associated with the customer.", + "id": "script-api:dw/customer/Wallet#removePaymentInstrument", + "kind": "method", + "packagePath": "dw/customer", + "params": [ + { + "name": "instrument", + "type": "CustomerPaymentInstrument" + } + ], + "parentId": "script-api:dw/customer/Wallet", + "qualifiedName": "dw.customer.Wallet.removePaymentInstrument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a payment instrument associated with the customer.", + "heading": "Description" + } + ], + "signature": "removePaymentInstrument(instrument: CustomerPaymentInstrument): void", + "source": "script-api", + "tags": [ + "removepaymentinstrument", + "wallet.removepaymentinstrument" + ], + "throws": [ + { + "description": "If passed 'instrument' is null.", + "type": "NullArgumentException" + }, + { + "description": "If passed 'instrument' belongs to an other customer", + "type": "IllegalArgumentException" + } + ], + "title": "Wallet.removePaymentInstrument" + }, + { + "description": "5 declarations", + "id": "script-api:dw/customer/consent", + "kind": "package", + "packagePath": "dw/customer/consent", + "qualifiedName": "dw.customer.consent", + "source": "script-api", + "tags": [ + "dw/customer/consent", + "dw.customer.consent" + ], + "title": "dw.customer.consent" + }, + { + "description": "Represents the consent status for a specific channel and contact point.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry", + "sections": [ + { + "body": "Represents the consent status for a specific channel and contact point.\n\nThis class provides information about the shopper's consent status (OPT_IN, OPT_OUT)\nfor a particular marketing communication channel.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "consentstatusentry", + "dw.customer.consent.consentstatusentry", + "dw/customer/consent" + ], + "title": "ConsentStatusEntry" + }, + { + "description": "Returns the channel type for this consent status entry.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#channel", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.channel", + "sections": [ + { + "body": "Returns the channel type for this consent status entry.", + "heading": "Description" + } + ], + "signature": "readonly channel: string", + "source": "script-api", + "tags": [ + "channel", + "consentstatusentry.channel" + ], + "title": "ConsentStatusEntry.channel" + }, + { + "description": "Returns the contact point value (email address or phone number) for this consent entry.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#contactPointValue", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.contactPointValue", + "sections": [ + { + "body": "Returns the contact point value (email address or phone number) for this consent entry.", + "heading": "Description" + } + ], + "signature": "readonly contactPointValue: string", + "source": "script-api", + "tags": [ + "contactpointvalue", + "consentstatusentry.contactpointvalue" + ], + "title": "ConsentStatusEntry.contactPointValue" + }, + { + "description": "Returns the channel type for this consent status entry.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getChannel", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getChannel", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the channel type for this consent status entry.", + "heading": "Description" + } + ], + "signature": "getChannel(): string", + "source": "script-api", + "tags": [ + "getchannel", + "consentstatusentry.getchannel" + ], + "title": "ConsentStatusEntry.getChannel" + }, + { + "description": "Returns the contact point value (email address or phone number) for this consent entry.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getContactPointValue", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getContactPointValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the contact point value (email address or phone number) for this consent entry.", + "heading": "Description" + } + ], + "signature": "getContactPointValue(): string", + "source": "script-api", + "tags": [ + "getcontactpointvalue", + "consentstatusentry.getcontactpointvalue" + ], + "title": "ConsentStatusEntry.getContactPointValue" + }, + { + "description": "Returns the consent status.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#getStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.getStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the consent status.", + "heading": "Description" + } + ], + "signature": "getStatus(): string", + "source": "script-api", + "tags": [ + "getstatus", + "consentstatusentry.getstatus" + ], + "title": "ConsentStatusEntry.getStatus" + }, + { + "description": "Returns the consent status.", + "id": "script-api:dw/customer/consent/ConsentStatusEntry#status", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ConsentStatusEntry", + "qualifiedName": "dw.customer.consent.ConsentStatusEntry.status", + "sections": [ + { + "body": "Returns the consent status.", + "heading": "Description" + } + ], + "signature": "readonly status: string", + "source": "script-api", + "tags": [ + "status", + "consentstatusentry.status" + ], + "title": "ConsentStatusEntry.status" + }, + { + "description": "Represents a marketing consent subscription for a shopper.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription", + "sections": [ + { + "body": "Represents a marketing consent subscription for a shopper.\n\nA marketing consent subscription defines a communication preference category (e.g., \"Newsletter\", \"Product Updates\")\nwith associated channels (EMAIL, SMS, WHATSAPP) through which the shopper can receive marketing communications.\n\nExample usage:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "marketingconsentsubscription", + "dw.customer.consent.marketingconsentsubscription", + "dw/customer/consent" + ], + "title": "MarketingConsentSubscription" + }, + { + "description": "Returns the available channels for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#channels", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.channels", + "sections": [ + { + "body": "Returns the available channels for this subscription.\n\nChannels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.", + "heading": "Description" + } + ], + "signature": "readonly channels: string[]", + "source": "script-api", + "tags": [ + "channels", + "marketingconsentsubscription.channels" + ], + "title": "MarketingConsentSubscription.channels" + }, + { + "description": "Returns whether consent is required for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentRequired", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentRequired", + "sections": [ + { + "body": "Returns whether consent is required for this subscription.", + "heading": "Description" + } + ], + "signature": "readonly consentRequired: boolean", + "source": "script-api", + "tags": [ + "consentrequired", + "marketingconsentsubscription.consentrequired" + ], + "title": "MarketingConsentSubscription.consentRequired" + }, + { + "description": "Returns the consent status entries for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentStatus", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentStatus", + "sections": [ + { + "body": "Returns the consent status entries for this subscription.\n\nThis is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the\ncustomer is authenticated.", + "heading": "Description" + } + ], + "signature": "readonly consentStatus: Collection | null", + "source": "script-api", + "tags": [ + "consentstatus", + "marketingconsentsubscription.consentstatus" + ], + "title": "MarketingConsentSubscription.consentStatus" + }, + { + "description": "Returns the consent type for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#consentType", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.consentType", + "sections": [ + { + "body": "Returns the consent type for this subscription.", + "heading": "Description" + } + ], + "signature": "readonly consentType: string", + "source": "script-api", + "tags": [ + "consenttype", + "marketingconsentsubscription.consenttype" + ], + "title": "MarketingConsentSubscription.consentType" + }, + { + "description": "Returns the default consent status for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#defaultStatus", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.defaultStatus", + "sections": [ + { + "body": "Returns the default consent status for this subscription.", + "heading": "Description" + } + ], + "signature": "readonly defaultStatus: string", + "source": "script-api", + "tags": [ + "defaultstatus", + "marketingconsentsubscription.defaultstatus" + ], + "title": "MarketingConsentSubscription.defaultStatus" + }, + { + "description": "Returns the available channels for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getChannels", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getChannels", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns the available channels for this subscription.\n\nChannels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.", + "heading": "Description" + } + ], + "signature": "getChannels(): string[]", + "source": "script-api", + "tags": [ + "getchannels", + "marketingconsentsubscription.getchannels" + ], + "title": "MarketingConsentSubscription.getChannels" + }, + { + "description": "Returns whether consent is required for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentRequired", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentRequired", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether consent is required for this subscription.", + "heading": "Description" + } + ], + "signature": "getConsentRequired(): boolean", + "source": "script-api", + "tags": [ + "getconsentrequired", + "marketingconsentsubscription.getconsentrequired" + ], + "title": "MarketingConsentSubscription.getConsentRequired" + }, + { + "description": "Returns the consent status entries for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentStatus", + "returns": { + "type": "Collection | null" + }, + "sections": [ + { + "body": "Returns the consent status entries for this subscription.\n\nThis is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the\ncustomer is authenticated.", + "heading": "Description" + } + ], + "signature": "getConsentStatus(): Collection | null", + "source": "script-api", + "tags": [ + "getconsentstatus", + "marketingconsentsubscription.getconsentstatus" + ], + "title": "MarketingConsentSubscription.getConsentStatus" + }, + { + "description": "Returns the consent type for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getConsentType", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getConsentType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the consent type for this subscription.", + "heading": "Description" + } + ], + "signature": "getConsentType(): string", + "source": "script-api", + "tags": [ + "getconsenttype", + "marketingconsentsubscription.getconsenttype" + ], + "title": "MarketingConsentSubscription.getConsentType" + }, + { + "description": "Returns the default consent status for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getDefaultStatus", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getDefaultStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the default consent status for this subscription.", + "heading": "Description" + } + ], + "signature": "getDefaultStatus(): string", + "source": "script-api", + "tags": [ + "getdefaultstatus", + "marketingconsentsubscription.getdefaultstatus" + ], + "title": "MarketingConsentSubscription.getDefaultStatus" + }, + { + "description": "Returns the unique identifier for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getSubscriptionId", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getSubscriptionId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique identifier for this subscription.", + "heading": "Description" + } + ], + "signature": "getSubscriptionId(): string", + "source": "script-api", + "tags": [ + "getsubscriptionid", + "marketingconsentsubscription.getsubscriptionid" + ], + "title": "MarketingConsentSubscription.getSubscriptionId" + }, + { + "description": "Returns the localized subtitle of this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getSubtitle", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getSubtitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the localized subtitle of this subscription.", + "heading": "Description" + } + ], + "signature": "getSubtitle(): string", + "source": "script-api", + "tags": [ + "getsubtitle", + "marketingconsentsubscription.getsubtitle" + ], + "title": "MarketingConsentSubscription.getSubtitle" + }, + { + "description": "Returns the tags associated with this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getTags", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getTags", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns the tags associated with this subscription.\n\nTags can be used to categorize and filter subscriptions.", + "heading": "Description" + } + ], + "signature": "getTags(): string[]", + "source": "script-api", + "tags": [ + "gettags", + "marketingconsentsubscription.gettags" + ], + "title": "MarketingConsentSubscription.getTags" + }, + { + "description": "Returns the localized title of this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#getTitle", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the localized title of this subscription.", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "marketingconsentsubscription.gettitle" + ], + "title": "MarketingConsentSubscription.getTitle" + }, + { + "description": "Returns the unique identifier for this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#subscriptionId", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.subscriptionId", + "sections": [ + { + "body": "Returns the unique identifier for this subscription.", + "heading": "Description" + } + ], + "signature": "readonly subscriptionId: string", + "source": "script-api", + "tags": [ + "subscriptionid", + "marketingconsentsubscription.subscriptionid" + ], + "title": "MarketingConsentSubscription.subscriptionId" + }, + { + "description": "Returns the localized subtitle of this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#subtitle", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.subtitle", + "sections": [ + { + "body": "Returns the localized subtitle of this subscription.", + "heading": "Description" + } + ], + "signature": "readonly subtitle: string", + "source": "script-api", + "tags": [ + "subtitle", + "marketingconsentsubscription.subtitle" + ], + "title": "MarketingConsentSubscription.subtitle" + }, + { + "description": "Returns the tags associated with this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#tags", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.tags", + "sections": [ + { + "body": "Returns the tags associated with this subscription.\n\nTags can be used to categorize and filter subscriptions.", + "heading": "Description" + } + ], + "signature": "readonly tags: string[]", + "source": "script-api", + "tags": [ + "tags", + "marketingconsentsubscription.tags" + ], + "title": "MarketingConsentSubscription.tags" + }, + { + "description": "Returns the localized title of this subscription.", + "id": "script-api:dw/customer/consent/MarketingConsentSubscription#title", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/MarketingConsentSubscription", + "qualifiedName": "dw.customer.consent.MarketingConsentSubscription.title", + "sections": [ + { + "body": "Returns the localized title of this subscription.", + "heading": "Description" + } + ], + "signature": "readonly title: string", + "source": "script-api", + "tags": [ + "title", + "marketingconsentsubscription.title" + ], + "title": "MarketingConsentSubscription.title" + }, + { + "description": "Error codes for ShopperConsentException.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes", + "sections": [ + { + "body": "Error codes for ShopperConsentException.\n\nThese error codes indicate the reason why a shopper consent operation failed.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shopperconsenterrorcodes", + "dw.customer.consent.shopperconsenterrorcodes", + "dw/customer/consent" + ], + "title": "ShopperConsentErrorCodes" + }, + { + "description": "Indicates that the customer is not authenticated.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#CUSTOMER_NOT_AUTHENTICATED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED", + "sections": [ + { + "body": "Indicates that the customer is not authenticated.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_NOT_AUTHENTICATED = \"CUSTOMER_NOT_AUTHENTICATED\"", + "source": "script-api", + "tags": [ + "customer_not_authenticated", + "shopperconsenterrorcodes.customer_not_authenticated" + ], + "title": "ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED" + }, + { + "description": "Indicates that the customer is not authenticated.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#CUSTOMER_NOT_AUTHENTICATED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED", + "sections": [ + { + "body": "Indicates that the customer is not authenticated.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_NOT_AUTHENTICATED = \"CUSTOMER_NOT_AUTHENTICATED\"", + "source": "script-api", + "tags": [ + "customer_not_authenticated", + "shopperconsenterrorcodes.customer_not_authenticated" + ], + "title": "ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED" + }, + { + "description": "Indicates that the Marketing Consent feature is not enabled.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.FEATURE_DISABLED", + "sections": [ + { + "body": "Indicates that the Marketing Consent feature is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly FEATURE_DISABLED = \"FEATURE_DISABLED\"", + "source": "script-api", + "tags": [ + "feature_disabled", + "shopperconsenterrorcodes.feature_disabled" + ], + "title": "ShopperConsentErrorCodes.FEATURE_DISABLED" + }, + { + "description": "Indicates that the Marketing Consent feature is not enabled.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.FEATURE_DISABLED", + "sections": [ + { + "body": "Indicates that the Marketing Consent feature is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly FEATURE_DISABLED = \"FEATURE_DISABLED\"", + "source": "script-api", + "tags": [ + "feature_disabled", + "shopperconsenterrorcodes.feature_disabled" + ], + "title": "ShopperConsentErrorCodes.FEATURE_DISABLED" + }, + { + "description": "Indicates that an internal error occurred.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.INTERNAL_ERROR", + "sections": [ + { + "body": "Indicates that an internal error occurred.", + "heading": "Description" + } + ], + "signature": "static readonly INTERNAL_ERROR = \"INTERNAL_ERROR\"", + "source": "script-api", + "tags": [ + "internal_error", + "shopperconsenterrorcodes.internal_error" + ], + "title": "ShopperConsentErrorCodes.INTERNAL_ERROR" + }, + { + "description": "Indicates that an internal error occurred.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.INTERNAL_ERROR", + "sections": [ + { + "body": "Indicates that an internal error occurred.", + "heading": "Description" + } + ], + "signature": "static readonly INTERNAL_ERROR = \"INTERNAL_ERROR\"", + "source": "script-api", + "tags": [ + "internal_error", + "shopperconsenterrorcodes.internal_error" + ], + "title": "ShopperConsentErrorCodes.INTERNAL_ERROR" + }, + { + "description": "Indicates that an error occurred while retrieving consent subscriptions.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#RETRIEVAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.RETRIEVAL_ERROR", + "sections": [ + { + "body": "Indicates that an error occurred while retrieving consent subscriptions.", + "heading": "Description" + } + ], + "signature": "static readonly RETRIEVAL_ERROR = \"RETRIEVAL_ERROR\"", + "source": "script-api", + "tags": [ + "retrieval_error", + "shopperconsenterrorcodes.retrieval_error" + ], + "title": "ShopperConsentErrorCodes.RETRIEVAL_ERROR" + }, + { + "description": "Indicates that an error occurred while retrieving consent subscriptions.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#RETRIEVAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.RETRIEVAL_ERROR", + "sections": [ + { + "body": "Indicates that an error occurred while retrieving consent subscriptions.", + "heading": "Description" + } + ], + "signature": "static readonly RETRIEVAL_ERROR = \"RETRIEVAL_ERROR\"", + "source": "script-api", + "tags": [ + "retrieval_error", + "shopperconsenterrorcodes.retrieval_error" + ], + "title": "ShopperConsentErrorCodes.RETRIEVAL_ERROR" + }, + { + "description": "Indicates that an error occurred while updating consent subscriptions.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#UPDATE_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.UPDATE_ERROR", + "sections": [ + { + "body": "Indicates that an error occurred while updating consent subscriptions.", + "heading": "Description" + } + ], + "signature": "static readonly UPDATE_ERROR = \"UPDATE_ERROR\"", + "source": "script-api", + "tags": [ + "update_error", + "shopperconsenterrorcodes.update_error" + ], + "title": "ShopperConsentErrorCodes.UPDATE_ERROR" + }, + { + "description": "Indicates that an error occurred while updating consent subscriptions.", + "id": "script-api:dw/customer/consent/ShopperConsentErrorCodes#UPDATE_ERROR", + "kind": "constant", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentErrorCodes", + "qualifiedName": "dw.customer.consent.ShopperConsentErrorCodes.UPDATE_ERROR", + "sections": [ + { + "body": "Indicates that an error occurred while updating consent subscriptions.", + "heading": "Description" + } + ], + "signature": "static readonly UPDATE_ERROR = \"UPDATE_ERROR\"", + "source": "script-api", + "tags": [ + "update_error", + "shopperconsenterrorcodes.update_error" + ], + "title": "ShopperConsentErrorCodes.UPDATE_ERROR" + }, + { + "description": "This exception is thrown by ShopperConsentMgr methods when an error occurs during consent subscription operations.", + "id": "script-api:dw/customer/consent/ShopperConsentException", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentException", + "sections": [ + { + "body": "This exception is thrown by ShopperConsentMgr methods when an error occurs\nduring consent subscription operations.\n\nThe 'errorCode' property is set to one of the following values:\n\n- ShopperConsentErrorCodes.FEATURE_DISABLED - Indicates that the Marketing Consent\nfeature is not enabled.\n- ShopperConsentErrorCodes.RETRIEVAL_ERROR - Indicates that an error occurred while\nretrieving consent subscriptions.\n- ShopperConsentErrorCodes.UPDATE_ERROR - Indicates that an error occurred while\nupdating consent subscriptions.\n- ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED - Indicates that the customer\nis not authenticated (required for consent status retrieval).\n- ShopperConsentErrorCodes.INTERNAL_ERROR - Indicates that an internal error occurred.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shopperconsentexception", + "dw.customer.consent.shopperconsentexception", + "dw/customer/consent" + ], + "title": "ShopperConsentException" + }, + { + "description": "Returns the error code indicating the reason for the failure.", + "id": "script-api:dw/customer/consent/ShopperConsentException#errorCode", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentException", + "qualifiedName": "dw.customer.consent.ShopperConsentException.errorCode", + "sections": [ + { + "body": "Returns the error code indicating the reason for the failure.", + "heading": "Description" + } + ], + "signature": "readonly errorCode: string", + "source": "script-api", + "tags": [ + "errorcode", + "shopperconsentexception.errorcode" + ], + "title": "ShopperConsentException.errorCode" + }, + { + "description": "Returns the error code indicating the reason for the failure.", + "id": "script-api:dw/customer/consent/ShopperConsentException#getErrorCode", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentException", + "qualifiedName": "dw.customer.consent.ShopperConsentException.getErrorCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the error code indicating the reason for the failure.", + "heading": "Description" + } + ], + "signature": "getErrorCode(): string", + "source": "script-api", + "tags": [ + "geterrorcode", + "shopperconsentexception.geterrorcode" + ], + "title": "ShopperConsentException.getErrorCode" + }, + { + "description": "Provides static helper methods for managing shopper marketing consent subscriptions.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr", + "kind": "class", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr", + "sections": [ + { + "body": "Provides static helper methods for managing shopper marketing consent subscriptions.\n\nThis API enables retrieving and updating marketing consent preferences.\nConsent subscriptions define communication categories (e.g., \"Newsletter\", \"Product Updates\")\nand the channels (EMAIL, SMS, WHATSAPP) through which marketing communications can be sent.\n\nPrerequisites:\n\n- The Marketing Consent feature must be enabled and configured\n- For consent status retrieval, the current request must have a customer context\n\nExample usage:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shopperconsentmgr", + "dw.customer.consent.shopperconsentmgr", + "dw/customer/consent" + ], + "title": "ShopperConsentMgr" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site.\n\nThis method returns all available consent subscriptions without consent status information.", + "heading": "Description" + } + ], + "signature": "static getSubscriptions(): Collection", + "source": "script-api", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site with optional filtering and status.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "params": [ + { + "name": "tags", + "type": "List" + }, + { + "name": "includeConsentStatus", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site with optional filtering and status.\n\nUse this method to retrieve subscriptions filtered by tags and optionally include\nthe current consent status for authenticated customers.", + "heading": "Description" + } + ], + "signature": "static getSubscriptions(tags: List, includeConsentStatus: boolean): Collection", + "source": "script-api", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled, retrieval fails, or consent status retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site.\n\nThis method returns all available consent subscriptions without consent status information.", + "heading": "Description" + } + ], + "signature": "static getSubscriptions(): Collection", + "source": "script-api", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site with optional filtering and status.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#getSubscriptions", + "kind": "method", + "packagePath": "dw/customer/consent", + "params": [ + { + "name": "tags", + "type": "List" + }, + { + "name": "includeConsentStatus", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.getSubscriptions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site with optional filtering and status.\n\nUse this method to retrieve subscriptions filtered by tags and optionally include\nthe current consent status for authenticated customers.", + "heading": "Description" + } + ], + "signature": "static getSubscriptions(tags: List, includeConsentStatus: boolean): Collection", + "source": "script-api", + "tags": [ + "getsubscriptions", + "shopperconsentmgr.getsubscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled, retrieval fails, or consent status retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.getSubscriptions" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#subscriptions", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.subscriptions", + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site.\n\nThis method returns all available consent subscriptions without consent status information.", + "heading": "Description" + } + ], + "signature": "static readonly subscriptions: Collection", + "source": "script-api", + "tags": [ + "subscriptions", + "shopperconsentmgr.subscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.subscriptions" + }, + { + "description": "Retrieves marketing consent subscriptions for the current site.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#subscriptions", + "kind": "property", + "packagePath": "dw/customer/consent", + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.subscriptions", + "sections": [ + { + "body": "Retrieves marketing consent subscriptions for the current site.\n\nThis method returns all available consent subscriptions without consent status information.", + "heading": "Description" + } + ], + "signature": "static readonly subscriptions: Collection", + "source": "script-api", + "tags": [ + "subscriptions", + "shopperconsentmgr.subscriptions" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or retrieval fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.subscriptions" + }, + { + "description": "Updates consent status for a subscription.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#updateSubscription", + "kind": "method", + "packagePath": "dw/customer/consent", + "params": [ + { + "name": "contactPointValue", + "type": "string" + }, + { + "name": "subscriptionId", + "type": "string" + }, + { + "name": "channel", + "type": "string" + }, + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.updateSubscription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates consent status for a subscription.\n\nThis method updates the consent status in Salesforce Core for the specified\ncontact point and subscription channel combination.", + "heading": "Description" + } + ], + "signature": "static updateSubscription(contactPointValue: string, subscriptionId: string, channel: string, status: string): void", + "source": "script-api", + "tags": [ + "updatesubscription", + "shopperconsentmgr.updatesubscription" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or update fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.updateSubscription" + }, + { + "description": "Updates consent status for a subscription.", + "id": "script-api:dw/customer/consent/ShopperConsentMgr#updateSubscription", + "kind": "method", + "packagePath": "dw/customer/consent", + "params": [ + { + "name": "contactPointValue", + "type": "string" + }, + { + "name": "subscriptionId", + "type": "string" + }, + { + "name": "channel", + "type": "string" + }, + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/consent/ShopperConsentMgr", + "qualifiedName": "dw.customer.consent.ShopperConsentMgr.updateSubscription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates consent status for a subscription.\n\nThis method updates the consent status in Salesforce Core for the specified\ncontact point and subscription channel combination.", + "heading": "Description" + } + ], + "signature": "static updateSubscription(contactPointValue: string, subscriptionId: string, channel: string, status: string): void", + "source": "script-api", + "tags": [ + "updatesubscription", + "shopperconsentmgr.updatesubscription" + ], + "throws": [ + { + "description": "if the consent feature is not enabled or update fails.", + "type": "ShopperConsentException" + } + ], + "title": "ShopperConsentMgr.updateSubscription" + }, + { + "description": "4 declarations", + "id": "script-api:dw/customer/oauth", + "kind": "package", + "packagePath": "dw/customer/oauth", + "qualifiedName": "dw.customer.oauth", + "source": "script-api", + "tags": [ + "dw/customer/oauth", + "dw.customer.oauth" + ], + "title": "dw.customer.oauth" + }, + { + "description": "Contains OAuth-related artifacts from the HTTP response from the third-party OAuth server when requesting an access token", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse", + "sections": [ + { + "body": "Contains OAuth-related artifacts from the HTTP response from the third-party\nOAuth server when requesting an access token", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "oauthaccesstokenresponse", + "dw.customer.oauth.oauthaccesstokenresponse", + "dw/customer/oauth" + ], + "title": "OAuthAccessTokenResponse" + }, + { + "description": "Returns the ID token, if available", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#IDToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.IDToken", + "sections": [ + { + "body": "Returns the ID token, if available", + "heading": "Description" + } + ], + "signature": "readonly IDToken: string | null", + "source": "script-api", + "tags": [ + "idtoken", + "oauthaccesstokenresponse.idtoken" + ], + "title": "OAuthAccessTokenResponse.IDToken" + }, + { + "description": "Returns the access token", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#accessToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.accessToken", + "sections": [ + { + "body": "Returns the access token", + "heading": "Description" + } + ], + "signature": "readonly accessToken: string | null", + "source": "script-api", + "tags": [ + "accesstoken", + "oauthaccesstokenresponse.accesstoken" + ], + "title": "OAuthAccessTokenResponse.accessToken" + }, + { + "description": "Returns the access token expiration", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#accessTokenExpiry", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.accessTokenExpiry", + "sections": [ + { + "body": "Returns the access token expiration", + "heading": "Description" + } + ], + "signature": "readonly accessTokenExpiry: number", + "source": "script-api", + "tags": [ + "accesstokenexpiry", + "oauthaccesstokenresponse.accesstokenexpiry" + ], + "title": "OAuthAccessTokenResponse.accessTokenExpiry" + }, + { + "description": "Returns the error status. In cases of errors - more detailed error information can be seen in the error log files (specifity of error details vary by OAuth provider).", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#errorStatus", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.errorStatus", + "sections": [ + { + "body": "Returns the error status.\nIn cases of errors - more detailed error information\ncan be seen in the error log files (specifity of error details vary by OAuth provider).", + "heading": "Description" + } + ], + "signature": "readonly errorStatus: string | null", + "source": "script-api", + "tags": [ + "errorstatus", + "oauthaccesstokenresponse.errorstatus" + ], + "title": "OAuthAccessTokenResponse.errorStatus" + }, + { + "description": "Returns a map of additional tokens found in the response.", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#extraTokens", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.extraTokens", + "sections": [ + { + "body": "Returns a map of additional tokens found in the response.", + "heading": "Description" + } + ], + "signature": "readonly extraTokens: utilMap | null", + "source": "script-api", + "tags": [ + "extratokens", + "oauthaccesstokenresponse.extratokens" + ], + "title": "OAuthAccessTokenResponse.extraTokens" + }, + { + "description": "Returns the access token", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getAccessToken", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the access token", + "heading": "Description" + } + ], + "signature": "getAccessToken(): string | null", + "source": "script-api", + "tags": [ + "getaccesstoken", + "oauthaccesstokenresponse.getaccesstoken" + ], + "title": "OAuthAccessTokenResponse.getAccessToken" + }, + { + "description": "Returns the access token expiration", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getAccessTokenExpiry", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getAccessTokenExpiry", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the access token expiration", + "heading": "Description" + } + ], + "signature": "getAccessTokenExpiry(): number", + "source": "script-api", + "tags": [ + "getaccesstokenexpiry", + "oauthaccesstokenresponse.getaccesstokenexpiry" + ], + "title": "OAuthAccessTokenResponse.getAccessTokenExpiry" + }, + { + "description": "Returns the error status. In cases of errors - more detailed error information can be seen in the error log files (specifity of error details vary by OAuth provider).", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getErrorStatus", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getErrorStatus", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the error status.\nIn cases of errors - more detailed error information\ncan be seen in the error log files (specifity of error details vary by OAuth provider).", + "heading": "Description" + } + ], + "signature": "getErrorStatus(): string | null", + "source": "script-api", + "tags": [ + "geterrorstatus", + "oauthaccesstokenresponse.geterrorstatus" + ], + "title": "OAuthAccessTokenResponse.getErrorStatus" + }, + { + "description": "Returns a map of additional tokens found in the response.", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getExtraTokens", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getExtraTokens", + "returns": { + "type": "utilMap | null" + }, + "sections": [ + { + "body": "Returns a map of additional tokens found in the response.", + "heading": "Description" + } + ], + "signature": "getExtraTokens(): utilMap | null", + "source": "script-api", + "tags": [ + "getextratokens", + "oauthaccesstokenresponse.getextratokens" + ], + "title": "OAuthAccessTokenResponse.getExtraTokens" + }, + { + "description": "Returns the ID token, if available", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getIDToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getIDToken", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID token, if available", + "heading": "Description" + } + ], + "signature": "getIDToken(): string | null", + "source": "script-api", + "tags": [ + "getidtoken", + "oauthaccesstokenresponse.getidtoken" + ], + "title": "OAuthAccessTokenResponse.getIDToken" + }, + { + "description": "Returns the OAuth provider id", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getOauthProviderId", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getOauthProviderId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the OAuth provider id", + "heading": "Description" + } + ], + "signature": "getOauthProviderId(): string", + "source": "script-api", + "tags": [ + "getoauthproviderid", + "oauthaccesstokenresponse.getoauthproviderid" + ], + "title": "OAuthAccessTokenResponse.getOauthProviderId" + }, + { + "description": "Returns the refresh token", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#getRefreshToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.getRefreshToken", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the refresh token", + "heading": "Description" + } + ], + "signature": "getRefreshToken(): string | null", + "source": "script-api", + "tags": [ + "getrefreshtoken", + "oauthaccesstokenresponse.getrefreshtoken" + ], + "title": "OAuthAccessTokenResponse.getRefreshToken" + }, + { + "description": "Returns the OAuth provider id", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#oauthProviderId", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.oauthProviderId", + "sections": [ + { + "body": "Returns the OAuth provider id", + "heading": "Description" + } + ], + "signature": "readonly oauthProviderId: string", + "source": "script-api", + "tags": [ + "oauthproviderid", + "oauthaccesstokenresponse.oauthproviderid" + ], + "title": "OAuthAccessTokenResponse.oauthProviderId" + }, + { + "description": "Returns the refresh token", + "id": "script-api:dw/customer/oauth/OAuthAccessTokenResponse#refreshToken", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthAccessTokenResponse", + "qualifiedName": "dw.customer.oauth.OAuthAccessTokenResponse.refreshToken", + "sections": [ + { + "body": "Returns the refresh token", + "heading": "Description" + } + ], + "signature": "readonly refreshToken: string | null", + "source": "script-api", + "tags": [ + "refreshtoken", + "oauthaccesstokenresponse.refreshtoken" + ], + "title": "OAuthAccessTokenResponse.refreshToken" + }, + { + "description": "Contains the combined responses from the third-party OAuth server when finalizing the authentication.", + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse", + "sections": [ + { + "body": "Contains the combined responses from the third-party OAuth server when\nfinalizing the authentication.\n\nContains both the dw.customer.oauth.OAuthAccessTokenResponse\n\nand the dw.customer.oauth.OAuthUserInfoResponse", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "oauthfinalizedresponse", + "dw.customer.oauth.oauthfinalizedresponse", + "dw/customer/oauth" + ], + "title": "OAuthFinalizedResponse" + }, + { + "description": "Returns the access token response", + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#accessTokenResponse", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.accessTokenResponse", + "sections": [ + { + "body": "Returns the access token response", + "heading": "Description" + } + ], + "signature": "readonly accessTokenResponse: OAuthAccessTokenResponse", + "source": "script-api", + "tags": [ + "accesstokenresponse", + "oauthfinalizedresponse.accesstokenresponse" + ], + "title": "OAuthFinalizedResponse.accessTokenResponse" + }, + { + "description": "Returns the access token response", + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#getAccessTokenResponse", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.getAccessTokenResponse", + "returns": { + "type": "OAuthAccessTokenResponse" + }, + "sections": [ + { + "body": "Returns the access token response", + "heading": "Description" + } + ], + "signature": "getAccessTokenResponse(): OAuthAccessTokenResponse", + "source": "script-api", + "tags": [ + "getaccesstokenresponse", + "oauthfinalizedresponse.getaccesstokenresponse" + ], + "title": "OAuthFinalizedResponse.getAccessTokenResponse" + }, + { + "description": "Returns the user info response", + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#getUserInfoResponse", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.getUserInfoResponse", + "returns": { + "type": "OAuthUserInfoResponse" + }, + "sections": [ + { + "body": "Returns the user info response", + "heading": "Description" + } + ], + "signature": "getUserInfoResponse(): OAuthUserInfoResponse", + "source": "script-api", + "tags": [ + "getuserinforesponse", + "oauthfinalizedresponse.getuserinforesponse" + ], + "title": "OAuthFinalizedResponse.getUserInfoResponse" + }, + { + "description": "Returns the user info response", + "id": "script-api:dw/customer/oauth/OAuthFinalizedResponse#userInfoResponse", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthFinalizedResponse", + "qualifiedName": "dw.customer.oauth.OAuthFinalizedResponse.userInfoResponse", + "sections": [ + { + "body": "Returns the user info response", + "heading": "Description" + } + ], + "signature": "readonly userInfoResponse: OAuthUserInfoResponse", + "source": "script-api", + "tags": [ + "userinforesponse", + "oauthfinalizedresponse.userinforesponse" + ], + "title": "OAuthFinalizedResponse.userInfoResponse" + }, + { + "description": "The OAuthLoginFlowMgr encapsulates interactions with third party OAuth providers to support the Authorization Code Flow.", + "examples": [ + "`\nvar finalizedResponse : OAuthFinalizedResponse = OAuthLoginFlowMgr.finalizeOAuthLogin();\nvar userInfo = finalizedResponse.userInfoResponse.userInfo;\n`" + ], + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr", + "sections": [ + { + "body": "The OAuthLoginFlowMgr encapsulates interactions with third party\nOAuth providers to support the Authorization Code Flow.\n\nThe way to use is:\n\n- call initiateOAuthLogin\n- redirect the user to the returned link\n- when the user authenticates there the server will call back to\na URL configured on the provider's web site\n- when processing the request made from the provider's web site\nyou have two choices - either call the obtainAccessToken\nand obtainUserInfo\nmethods one after another separately (gives you more flexibility),\nor call the finalizeOAuthLogin method which internally\ncalls the other two (simpler to use).\n\nSample code for using it:\n\n\nor:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "oauthloginflowmgr", + "dw.customer.oauth.oauthloginflowmgr", + "dw/customer/oauth" + ], + "title": "OAuthLoginFlowMgr" + }, + { + "description": "This method works in tandem with the initiateOAuthLogin method. After the user has been redirected to the URL returned by that method to the external OAuth2 provider and the user has interacted with the provider's site, the browser is redirected to a URL configured on the provider's web site. This URL should be that of a pipeline that contains a script invoking the finalizeOAuthLogin method.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#finalizeOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin", + "returns": { + "type": "OAuthFinalizedResponse | null" + }, + "sections": [ + { + "body": "This method works in tandem with the initiateOAuthLogin method.\nAfter the user has been redirected to the URL returned by that method\nto the external OAuth2 provider and the user has interacted with the provider's\nsite, the browser is redirected to a URL configured on the provider's web\nsite. This URL should be that of a pipeline that contains\na script invoking the finalizeOAuthLogin method.\n\nAt this point the user has either been authenticated by the external provider\nor not (forgot password, or simply refused to provide credentials). If the user\nhas been authenticated by the external provider and the provider returns an\nauthentication code, this method exchanges the code for a token and with that\ntoken it requests from the provider the user information specified by the\nconfigured scope (id, first/last name, email, etc.).\n\nThe method is aggregation of two other methods - obtainAccessToken\nand obtainUserInfo\nand is provided for convenience. You may want to\nuse the two individual methods instead if you need more flexibility.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static finalizeOAuthLogin(): OAuthFinalizedResponse | null", + "source": "script-api", + "tags": [ + "finalizeoauthlogin", + "oauthloginflowmgr.finalizeoauthlogin" + ], + "title": "OAuthLoginFlowMgr.finalizeOAuthLogin" + }, + { + "description": "This method works in tandem with the initiateOAuthLogin method. After the user has been redirected to the URL returned by that method to the external OAuth2 provider and the user has interacted with the provider's site, the browser is redirected to a URL configured on the provider's web site. This URL should be that of a pipeline that contains a script invoking the finalizeOAuthLogin method.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#finalizeOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin", + "returns": { + "type": "OAuthFinalizedResponse | null" + }, + "sections": [ + { + "body": "This method works in tandem with the initiateOAuthLogin method.\nAfter the user has been redirected to the URL returned by that method\nto the external OAuth2 provider and the user has interacted with the provider's\nsite, the browser is redirected to a URL configured on the provider's web\nsite. This URL should be that of a pipeline that contains\na script invoking the finalizeOAuthLogin method.\n\nAt this point the user has either been authenticated by the external provider\nor not (forgot password, or simply refused to provide credentials). If the user\nhas been authenticated by the external provider and the provider returns an\nauthentication code, this method exchanges the code for a token and with that\ntoken it requests from the provider the user information specified by the\nconfigured scope (id, first/last name, email, etc.).\n\nThe method is aggregation of two other methods - obtainAccessToken\nand obtainUserInfo\nand is provided for convenience. You may want to\nuse the two individual methods instead if you need more flexibility.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static finalizeOAuthLogin(): OAuthFinalizedResponse | null", + "source": "script-api", + "tags": [ + "finalizeoauthlogin", + "oauthloginflowmgr.finalizeoauthlogin" + ], + "title": "OAuthLoginFlowMgr.finalizeOAuthLogin" + }, + { + "description": "This method works in tandem with another method - finalizeOAuthLogin. It starts the process of authentication via an external OAuth2 provider. It takes one parameter - OAuthProviderId (as configured in the system). Outputs an URL pointing to the OAuth2 provider's web page to which the browser should redirect to initiate the actual user authentication or NULL if there is an invalid configuration or an error occurs. The method stores a few key/values in the session (dw.system.Session.getPrivacy, implementation specific parameters and may change at any time) to be picked up by the finalizeOAuthLogin method when the provider redirects back.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#initiateOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "params": [ + { + "name": "oauthProviderId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.initiateOAuthLogin", + "returns": { + "type": "URLRedirect | null" + }, + "sections": [ + { + "body": "This method works in tandem with another method - finalizeOAuthLogin.\nIt starts the process of authentication via an external OAuth2 provider. It\ntakes one parameter - OAuthProviderId (as configured in the system). Outputs\nan URL pointing to the OAuth2 provider's web page to which the browser should\nredirect to initiate the actual user authentication or NULL if there is an\ninvalid configuration or an error occurs.\nThe method stores a few key/values in the session\n(dw.system.Session.getPrivacy, implementation specific parameters and may change at any time)\nto be picked up by the finalizeOAuthLogin method when the provider redirects back.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static initiateOAuthLogin(oauthProviderId: string): URLRedirect | null", + "source": "script-api", + "tags": [ + "initiateoauthlogin", + "oauthloginflowmgr.initiateoauthlogin" + ], + "title": "OAuthLoginFlowMgr.initiateOAuthLogin" + }, + { + "description": "This method works in tandem with another method - finalizeOAuthLogin. It starts the process of authentication via an external OAuth2 provider. It takes one parameter - OAuthProviderId (as configured in the system). Outputs an URL pointing to the OAuth2 provider's web page to which the browser should redirect to initiate the actual user authentication or NULL if there is an invalid configuration or an error occurs. The method stores a few key/values in the session (dw.system.Session.getPrivacy, implementation specific parameters and may change at any time) to be picked up by the finalizeOAuthLogin method when the provider redirects back.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#initiateOAuthLogin", + "kind": "method", + "packagePath": "dw/customer/oauth", + "params": [ + { + "name": "oauthProviderId", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.initiateOAuthLogin", + "returns": { + "type": "URLRedirect | null" + }, + "sections": [ + { + "body": "This method works in tandem with another method - finalizeOAuthLogin.\nIt starts the process of authentication via an external OAuth2 provider. It\ntakes one parameter - OAuthProviderId (as configured in the system). Outputs\nan URL pointing to the OAuth2 provider's web page to which the browser should\nredirect to initiate the actual user authentication or NULL if there is an\ninvalid configuration or an error occurs.\nThe method stores a few key/values in the session\n(dw.system.Session.getPrivacy, implementation specific parameters and may change at any time)\nto be picked up by the finalizeOAuthLogin method when the provider redirects back.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static initiateOAuthLogin(oauthProviderId: string): URLRedirect | null", + "source": "script-api", + "tags": [ + "initiateoauthlogin", + "oauthloginflowmgr.initiateoauthlogin" + ], + "title": "OAuthLoginFlowMgr.initiateOAuthLogin" + }, + { + "description": "This method is called internally by finalizeOAuthLogin. There are customer requests to expose a more granular way of doing the interactions that finalizeOAuthLogin is currently doing with the third party OAuth server to accommodate certain providers.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainAccessToken", + "returns": { + "type": "OAuthAccessTokenResponse" + }, + "sections": [ + { + "body": "This method is called internally by finalizeOAuthLogin.\nThere are customer requests to expose a more granular way of\ndoing the interactions that finalizeOAuthLogin is currently doing\nwith the third party OAuth server to accommodate certain providers.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static obtainAccessToken(): OAuthAccessTokenResponse", + "source": "script-api", + "tags": [ + "obtainaccesstoken", + "oauthloginflowmgr.obtainaccesstoken" + ], + "title": "OAuthLoginFlowMgr.obtainAccessToken" + }, + { + "description": "This method is called internally by finalizeOAuthLogin. There are customer requests to expose a more granular way of doing the interactions that finalizeOAuthLogin is currently doing with the third party OAuth server to accommodate certain providers.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainAccessToken", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainAccessToken", + "returns": { + "type": "OAuthAccessTokenResponse" + }, + "sections": [ + { + "body": "This method is called internally by finalizeOAuthLogin.\nThere are customer requests to expose a more granular way of\ndoing the interactions that finalizeOAuthLogin is currently doing\nwith the third party OAuth server to accommodate certain providers.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static obtainAccessToken(): OAuthAccessTokenResponse", + "source": "script-api", + "tags": [ + "obtainaccesstoken", + "oauthloginflowmgr.obtainaccesstoken" + ], + "title": "OAuthLoginFlowMgr.obtainAccessToken" + }, + { + "description": "This method is called internally by finalizeOAuthLogin. There are customer requests to expose a more granular way of doing the interactions that finalizeOAuthLogin is currently doing with the third party OAuth server to accommodate certain providers.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "params": [ + { + "name": "oauthProviderId", + "type": "string" + }, + { + "name": "accessToken", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainUserInfo", + "returns": { + "type": "OAuthUserInfoResponse" + }, + "sections": [ + { + "body": "This method is called internally by finalizeOAuthLogin.\nThere are customer requests to expose a more granular way of\ndoing the interactions that finalizeOAuthLogin is currently doing\nwith the third party OAuth server to accommodate certain providers.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static obtainUserInfo(oauthProviderId: string, accessToken: string): OAuthUserInfoResponse", + "source": "script-api", + "tags": [ + "obtainuserinfo", + "oauthloginflowmgr.obtainuserinfo" + ], + "title": "OAuthLoginFlowMgr.obtainUserInfo" + }, + { + "description": "This method is called internally by finalizeOAuthLogin. There are customer requests to expose a more granular way of doing the interactions that finalizeOAuthLogin is currently doing with the third party OAuth server to accommodate certain providers.", + "id": "script-api:dw/customer/oauth/OAuthLoginFlowMgr#obtainUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "params": [ + { + "name": "oauthProviderId", + "type": "string" + }, + { + "name": "accessToken", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/oauth/OAuthLoginFlowMgr", + "qualifiedName": "dw.customer.oauth.OAuthLoginFlowMgr.obtainUserInfo", + "returns": { + "type": "OAuthUserInfoResponse" + }, + "sections": [ + { + "body": "This method is called internally by finalizeOAuthLogin.\nThere are customer requests to expose a more granular way of\ndoing the interactions that finalizeOAuthLogin is currently doing\nwith the third party OAuth server to accommodate certain providers.\n\nThis supports the Authorization Code Flow.", + "heading": "Description" + } + ], + "signature": "static obtainUserInfo(oauthProviderId: string, accessToken: string): OAuthUserInfoResponse", + "source": "script-api", + "tags": [ + "obtainuserinfo", + "oauthloginflowmgr.obtainuserinfo" + ], + "title": "OAuthLoginFlowMgr.obtainUserInfo" + }, + { + "description": "Contains the response from the third-party OAuth server when requesting user info. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the scope.", + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "kind": "class", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse", + "sections": [ + { + "body": "Contains the response from the third-party OAuth server when\nrequesting user info. Refer to the corresponding OAuth provider documentation\nregarding what the format might be (in most cases it would be JSON).\nThe data returned would also vary depending on the scope.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "oauthuserinforesponse", + "dw.customer.oauth.oauthuserinforesponse", + "dw/customer/oauth" + ], + "title": "OAuthUserInfoResponse" + }, + { + "description": "Returns the error status In cases of errors - more detailed error information can be seen in the error log files (specificity of error details vary by OAuth provider).", + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#errorStatus", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.errorStatus", + "sections": [ + { + "body": "Returns the error status\nIn cases of errors - more detailed error information\ncan be seen in the error log files (specificity of error details vary by OAuth provider).", + "heading": "Description" + } + ], + "signature": "readonly errorStatus: string", + "source": "script-api", + "tags": [ + "errorstatus", + "oauthuserinforesponse.errorstatus" + ], + "title": "OAuthUserInfoResponse.errorStatus" + }, + { + "description": "Returns the error status In cases of errors - more detailed error information can be seen in the error log files (specificity of error details vary by OAuth provider).", + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#getErrorStatus", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.getErrorStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the error status\nIn cases of errors - more detailed error information\ncan be seen in the error log files (specificity of error details vary by OAuth provider).", + "heading": "Description" + } + ], + "signature": "getErrorStatus(): string", + "source": "script-api", + "tags": [ + "geterrorstatus", + "oauthuserinforesponse.geterrorstatus" + ], + "title": "OAuthUserInfoResponse.getErrorStatus" + }, + { + "description": "Returns the user info as a String. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the configured 'scope'.", + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#getUserInfo", + "kind": "method", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.getUserInfo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the user info as a String. Refer to the corresponding OAuth provider documentation\nregarding what the format might be (in most cases it would be JSON).\nThe data returned would also vary depending on the configured 'scope'.", + "heading": "Description" + } + ], + "signature": "getUserInfo(): string", + "source": "script-api", + "tags": [ + "getuserinfo", + "oauthuserinforesponse.getuserinfo" + ], + "title": "OAuthUserInfoResponse.getUserInfo" + }, + { + "description": "Returns the user info as a String. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the configured 'scope'.", + "id": "script-api:dw/customer/oauth/OAuthUserInfoResponse#userInfo", + "kind": "property", + "packagePath": "dw/customer/oauth", + "parentId": "script-api:dw/customer/oauth/OAuthUserInfoResponse", + "qualifiedName": "dw.customer.oauth.OAuthUserInfoResponse.userInfo", + "sections": [ + { + "body": "Returns the user info as a String. Refer to the corresponding OAuth provider documentation\nregarding what the format might be (in most cases it would be JSON).\nThe data returned would also vary depending on the configured 'scope'.", + "heading": "Description" + } + ], + "signature": "readonly userInfo: string", + "source": "script-api", + "tags": [ + "userinfo", + "oauthuserinforesponse.userinfo" + ], + "title": "OAuthUserInfoResponse.userInfo" + }, + { + "description": "4 declarations", + "id": "script-api:dw/customer/shoppercontext", + "kind": "package", + "packagePath": "dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext", + "source": "script-api", + "tags": [ + "dw/customer/shoppercontext", + "dw.customer.shoppercontext" + ], + "title": "dw.customer.shoppercontext" + }, + { + "description": "The class represents Shopper Context. It is used to manage personalized shopping experiences on your storefront.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext", + "sections": [ + { + "body": "The class represents Shopper Context. It is used to manage personalized shopping experiences on your storefront.\n\nShopper Context is used to personalize shopper experiences with context values such as custom session attributes,\nassignment qualifiers, geolocation, clientIP address, effective date time, source code, coupon code and customer\ngroups.\n\nWhen Shopper Context is set for a shopper, the context is applied in the next request and can activate promotions or\nprice books assigned to customer groups, source codes, or stores (via assignments).\nAlso see: dw.customer.shoppercontext.ShopperContextMgr", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shoppercontext", + "dw.customer.shoppercontext.shoppercontext", + "dw/customer/shoppercontext" + ], + "title": "ShopperContext" + }, + { + "description": "Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the assignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping methods etc.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#assignmentQualifiers", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.assignmentQualifiers", + "sections": [ + { + "body": "Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the\nassignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping\nmethods etc.", + "heading": "Description" + } + ], + "signature": "assignmentQualifiers: utilMap", + "source": "script-api", + "tags": [ + "assignmentqualifiers", + "shoppercontext.assignmentqualifiers" + ], + "title": "ShopperContext.assignmentQualifiers" + }, + { + "description": "Returns the IP address of the client from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#clientIP", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.clientIP", + "sections": [ + { + "body": "Returns the IP address of the client from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "clientIP: string", + "source": "script-api", + "tags": [ + "clientip", + "shoppercontext.clientip" + ], + "title": "ShopperContext.clientIP" + }, + { + "description": "Returns the Coupon codes from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#couponCodes", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.couponCodes", + "sections": [ + { + "body": "Returns the Coupon codes from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "couponCodes: utilSet", + "source": "script-api", + "tags": [ + "couponcodes", + "shoppercontext.couponcodes" + ], + "title": "ShopperContext.couponCodes" + }, + { + "description": "Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes set in the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#customQualifiers", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.customQualifiers", + "sections": [ + { + "body": "Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes\nset in the Shopper Context.", + "heading": "Description" + } + ], + "signature": "customQualifiers: utilMap", + "source": "script-api", + "tags": [ + "customqualifiers", + "shoppercontext.customqualifiers" + ], + "title": "ShopperContext.customQualifiers" + }, + { + "description": "Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context evaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#customerGroupIDs", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.customerGroupIDs", + "sections": [ + { + "body": "Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context\nevaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "heading": "Description" + } + ], + "signature": "customerGroupIDs: utilSet", + "source": "script-api", + "tags": [ + "customergroupids", + "shoppercontext.customergroupids" + ], + "title": "ShopperContext.customerGroupIDs" + }, + { + "description": "Returns the effective date time from the Shopper Context. With the effective date time you can retrieve promotions that are active at a particular time. For example, \"Shop the Future\" use cases.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#effectiveDateTime", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.effectiveDateTime", + "sections": [ + { + "body": "Returns the effective date time from the Shopper Context. With the effective date time you can retrieve\npromotions that are active at a particular time. For example, \"Shop the Future\" use cases.", + "heading": "Description" + } + ], + "signature": "effectiveDateTime: Date", + "source": "script-api", + "tags": [ + "effectivedatetime", + "shoppercontext.effectivedatetime" + ], + "title": "ShopperContext.effectiveDateTime" + }, + { + "description": "Returns the geographic location from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.geolocation", + "sections": [ + { + "body": "Returns the geographic location from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "geolocation: Geolocation", + "source": "script-api", + "tags": [ + "geolocation", + "shoppercontext.geolocation" + ], + "title": "ShopperContext.geolocation" + }, + { + "description": "Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the assignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping methods etc.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getAssignmentQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getAssignmentQualifiers", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the\nassignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping\nmethods etc.", + "heading": "Description" + } + ], + "signature": "getAssignmentQualifiers(): utilMap", + "source": "script-api", + "tags": [ + "getassignmentqualifiers", + "shoppercontext.getassignmentqualifiers" + ], + "title": "ShopperContext.getAssignmentQualifiers" + }, + { + "description": "Returns the IP address of the client from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getClientIP", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getClientIP", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the IP address of the client from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "getClientIP(): string", + "source": "script-api", + "tags": [ + "getclientip", + "shoppercontext.getclientip" + ], + "title": "ShopperContext.getClientIP" + }, + { + "description": "Returns the Coupon codes from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCouponCodes", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCouponCodes", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns the Coupon codes from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "getCouponCodes(): utilSet", + "source": "script-api", + "tags": [ + "getcouponcodes", + "shoppercontext.getcouponcodes" + ], + "title": "ShopperContext.getCouponCodes" + }, + { + "description": "Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes set in the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCustomQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCustomQualifiers", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes\nset in the Shopper Context.", + "heading": "Description" + } + ], + "signature": "getCustomQualifiers(): utilMap", + "source": "script-api", + "tags": [ + "getcustomqualifiers", + "shoppercontext.getcustomqualifiers" + ], + "title": "ShopperContext.getCustomQualifiers" + }, + { + "description": "Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context evaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getCustomerGroupIDs", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getCustomerGroupIDs", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context\nevaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "heading": "Description" + } + ], + "signature": "getCustomerGroupIDs(): utilSet", + "source": "script-api", + "tags": [ + "getcustomergroupids", + "shoppercontext.getcustomergroupids" + ], + "title": "ShopperContext.getCustomerGroupIDs" + }, + { + "description": "Returns the effective date time from the Shopper Context. With the effective date time you can retrieve promotions that are active at a particular time. For example, \"Shop the Future\" use cases.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getEffectiveDateTime", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getEffectiveDateTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the effective date time from the Shopper Context. With the effective date time you can retrieve\npromotions that are active at a particular time. For example, \"Shop the Future\" use cases.", + "heading": "Description" + } + ], + "signature": "getEffectiveDateTime(): Date", + "source": "script-api", + "tags": [ + "geteffectivedatetime", + "shoppercontext.geteffectivedatetime" + ], + "title": "ShopperContext.getEffectiveDateTime" + }, + { + "description": "Returns the geographic location from the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getGeolocation", + "returns": { + "type": "Geolocation" + }, + "sections": [ + { + "body": "Returns the geographic location from the Shopper Context.", + "heading": "Description" + } + ], + "signature": "getGeolocation(): Geolocation", + "source": "script-api", + "tags": [ + "getgeolocation", + "shoppercontext.getgeolocation" + ], + "title": "ShopperContext.getGeolocation" + }, + { + "description": "Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code group that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#getSourceCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.getSourceCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code\ngroup that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "heading": "Description" + } + ], + "signature": "getSourceCode(): string", + "source": "script-api", + "tags": [ + "getsourcecode", + "shoppercontext.getsourcecode" + ], + "title": "ShopperContext.getSourceCode" + }, + { + "description": "Sets the assignment qualifiers in the Shopper Context. Assignment qualifiers are set when using the assignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping methods etc.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setAssignmentQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "assignmentQualifiers", + "type": "utilMap" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setAssignmentQualifiers", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the assignment qualifiers in the Shopper Context. Assignment qualifiers are set when using the assignment\nframework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping methods\netc.\n\nExample: Assignment qualifier for store can be set as follows:", + "heading": "Description" + } + ], + "signature": "setAssignmentQualifiers(assignmentQualifiers: utilMap): void", + "source": "script-api", + "tags": [ + "setassignmentqualifiers", + "shoppercontext.setassignmentqualifiers" + ], + "title": "ShopperContext.setAssignmentQualifiers" + }, + { + "description": "Sets the IP address of the client in the Shopper Context. The client IP evaluates to a geolocation. If the client IP address is not a valid IPv4/IPv6 address an error is thrown.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setClientIP", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "clientIP", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setClientIP", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the IP address of the client in the Shopper Context. The client IP evaluates to a geolocation. If the client\nIP address is not a valid IPv4/IPv6 address an error is thrown.", + "heading": "Description" + } + ], + "signature": "setClientIP(clientIP: string): void", + "source": "script-api", + "tags": [ + "setclientip", + "shoppercontext.setclientip" + ], + "title": "ShopperContext.setClientIP" + }, + { + "description": "Sets the Coupon codes in the Shopper Context. When you set coupon codes, it is saved as context for subsequent requests and can then trigger promotions via the campaign which are tied to the coupon. A maximum of 5 coupon codes can be set in the ShopperContext.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCouponCodes", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "couponCodes", + "type": "utilSet" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCouponCodes", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Coupon codes in the Shopper Context. When you set coupon codes, it is saved as context for subsequent\nrequests and can then trigger promotions via the campaign which are tied to the coupon. A maximum of 5 coupon\ncodes can be set in the ShopperContext.", + "heading": "Description" + } + ], + "signature": "setCouponCodes(couponCodes: utilSet): void", + "source": "script-api", + "tags": [ + "setcouponcodes", + "shoppercontext.setcouponcodes" + ], + "title": "ShopperContext.setCouponCodes" + }, + { + "description": "Sets the session custom attributes as custom qualifiers in the Shopper Context. Custom qualifiers are set when you want to trigger pricing and promotion experiences using a dynamic session-based customer groups.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCustomQualifiers", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "customQualifiers", + "type": "utilMap" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCustomQualifiers", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the session custom attributes as custom qualifiers in the Shopper Context. Custom qualifiers are set when\nyou want to trigger pricing and promotion experiences using a dynamic session-based customer groups.\n\nExample: A session custom attribute 'device_type' can be saved as follows:", + "heading": "Description" + } + ], + "signature": "setCustomQualifiers(customQualifiers: utilMap): void", + "source": "script-api", + "tags": [ + "setcustomqualifiers", + "shoppercontext.setcustomqualifiers" + ], + "title": "ShopperContext.setCustomQualifiers" + }, + { + "description": "Sets the customer group IDs for the Shopper Context to apply. Set the customer group IDs to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setCustomerGroupIDs", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "customerGroupIDs", + "type": "utilSet" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setCustomerGroupIDs", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer group IDs for the Shopper Context to apply. Set the customer group IDs to evaluate customer\ngroups that trigger the promotions (campaign assignment) assigned to the customer groups.", + "heading": "Description" + } + ], + "signature": "setCustomerGroupIDs(customerGroupIDs: utilSet): void", + "source": "script-api", + "tags": [ + "setcustomergroupids", + "shoppercontext.setcustomergroupids" + ], + "title": "ShopperContext.setCustomerGroupIDs" + }, + { + "description": "Sets the effective date time for the context to apply. With the effective date time you can retrieve promotions that are active at a particular time. For example, \"Shop the Future\" use cases.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setEffectiveDateTime", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "effectiveDateTime", + "type": "Date" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setEffectiveDateTime", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the effective date time for the context to apply. With the effective date time you can retrieve promotions\nthat are active at a particular time. For example, \"Shop the Future\" use cases.", + "heading": "Description" + } + ], + "signature": "setEffectiveDateTime(effectiveDateTime: Date): void", + "source": "script-api", + "tags": [ + "seteffectivedatetime", + "shoppercontext.seteffectivedatetime" + ], + "title": "ShopperContext.setEffectiveDateTime" + }, + { + "description": "Sets the geographic location of the client in the Shopper Context. When you set a geolocation, it is saved as context for subsequent requests. This overrides any context previously saved using clientIP in the Shopper Context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "geolocation", + "type": "Geolocation" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setGeolocation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the geographic location of the client in the Shopper Context. When you set a geolocation, it is saved as\ncontext for subsequent requests. This overrides any context previously saved using clientIP in the Shopper\nContext.", + "heading": "Description" + } + ], + "signature": "setGeolocation(geolocation: Geolocation): void", + "source": "script-api", + "tags": [ + "setgeolocation", + "shoppercontext.setgeolocation" + ], + "title": "ShopperContext.setGeolocation" + }, + { + "description": "Sets the source code for the Shopper Context to apply. Set the source code to evaluate source code group that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#setSourceCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "sourceCode", + "type": "string" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.setSourceCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the source code for the Shopper Context to apply. Set the source code to evaluate source code group that\ntriggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "heading": "Description" + } + ], + "signature": "setSourceCode(sourceCode: string): void", + "source": "script-api", + "tags": [ + "setsourcecode", + "shoppercontext.setsourcecode" + ], + "title": "ShopperContext.setSourceCode" + }, + { + "description": "Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code group that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "id": "script-api:dw/customer/shoppercontext/ShopperContext#sourceCode", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContext.sourceCode", + "sections": [ + { + "body": "Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code\ngroup that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).", + "heading": "Description" + } + ], + "signature": "sourceCode: string", + "source": "script-api", + "tags": [ + "sourcecode", + "shoppercontext.sourcecode" + ], + "title": "ShopperContext.sourceCode" + }, + { + "description": "Helper class containing error codes to indicate why a Shopper Context cannot be accessed, set or modified.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes", + "sections": [ + { + "body": "Helper class containing error codes to indicate why a Shopper Context cannot be accessed, set or modified.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shoppercontexterrorcodes", + "dw.customer.shoppercontext.shoppercontexterrorcodes", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextErrorCodes" + }, + { + "description": "Indicates that the assignment qualifiers limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the assignment qualifiers limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED = \"ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "assignment_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.assignment_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the assignment qualifiers limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the assignment qualifiers limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED = \"ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "assignment_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.assignment_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the coupon codes limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#COUPON_CODES_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the coupon codes limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODES_LIMIT_EXCEEDED = \"COUPON_CODES_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "coupon_codes_limit_exceeded", + "shoppercontexterrorcodes.coupon_codes_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the coupon codes limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#COUPON_CODES_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the coupon codes limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_CODES_LIMIT_EXCEEDED = \"COUPON_CODES_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "coupon_codes_limit_exceeded", + "shoppercontexterrorcodes.coupon_codes_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.COUPON_CODES_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the custom qualifiers limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the custom qualifiers limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOM_QUALIFIERS_LIMIT_EXCEEDED = \"CUSTOM_QUALIFIERS_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "custom_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.custom_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the custom qualifiers limit exceeded", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the custom qualifiers limit exceeded", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOM_QUALIFIERS_LIMIT_EXCEEDED = \"CUSTOM_QUALIFIERS_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "custom_qualifiers_limit_exceeded", + "shoppercontexterrorcodes.custom_qualifiers_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the feature toggle 'ShopperContextEnabled' is not enabled.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED", + "sections": [ + { + "body": "Indicates that the feature toggle 'ShopperContextEnabled' is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly FEATURE_DISABLED = \"FEATURE_DISABLED\"", + "source": "script-api", + "tags": [ + "feature_disabled", + "shoppercontexterrorcodes.feature_disabled" + ], + "title": "ShopperContextErrorCodes.FEATURE_DISABLED" + }, + { + "description": "Indicates that the feature toggle 'ShopperContextEnabled' is not enabled.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#FEATURE_DISABLED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED", + "sections": [ + { + "body": "Indicates that the feature toggle 'ShopperContextEnabled' is not enabled.", + "heading": "Description" + } + ], + "signature": "static readonly FEATURE_DISABLED = \"FEATURE_DISABLED\"", + "source": "script-api", + "tags": [ + "feature_disabled", + "shoppercontexterrorcodes.feature_disabled" + ], + "title": "ShopperContextErrorCodes.FEATURE_DISABLED" + }, + { + "description": "Indicates that an internal error occurred while setting, retrieving or deleting the shopper context", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR", + "sections": [ + { + "body": "Indicates that an internal error occurred while setting, retrieving or deleting the shopper context", + "heading": "Description" + } + ], + "signature": "static readonly INTERNAL_ERROR = \"INTERNAL_ERROR\"", + "source": "script-api", + "tags": [ + "internal_error", + "shoppercontexterrorcodes.internal_error" + ], + "title": "ShopperContextErrorCodes.INTERNAL_ERROR" + }, + { + "description": "Indicates that an internal error occurred while setting, retrieving or deleting the shopper context", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INTERNAL_ERROR", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR", + "sections": [ + { + "body": "Indicates that an internal error occurred while setting, retrieving or deleting the shopper context", + "heading": "Description" + } + ], + "signature": "static readonly INTERNAL_ERROR = \"INTERNAL_ERROR\"", + "source": "script-api", + "tags": [ + "internal_error", + "shoppercontexterrorcodes.internal_error" + ], + "title": "ShopperContextErrorCodes.INTERNAL_ERROR" + }, + { + "description": "Indicates an invalid argument was provided", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_ARGUMENT", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT", + "sections": [ + { + "body": "Indicates an invalid argument was provided", + "heading": "Description" + } + ], + "signature": "static readonly INVALID_ARGUMENT = \"INVALID_ARGUMENT\"", + "source": "script-api", + "tags": [ + "invalid_argument", + "shoppercontexterrorcodes.invalid_argument" + ], + "title": "ShopperContextErrorCodes.INVALID_ARGUMENT" + }, + { + "description": "Indicates an invalid argument was provided", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_ARGUMENT", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT", + "sections": [ + { + "body": "Indicates an invalid argument was provided", + "heading": "Description" + } + ], + "signature": "static readonly INVALID_ARGUMENT = \"INVALID_ARGUMENT\"", + "source": "script-api", + "tags": [ + "invalid_argument", + "shoppercontexterrorcodes.invalid_argument" + ], + "title": "ShopperContextErrorCodes.INVALID_ARGUMENT" + }, + { + "description": "Indicates that the request type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or an ocapi request using a SLAS token.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_REQUEST_TYPE", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE", + "sections": [ + { + "body": "Indicates that the request type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or\nan ocapi request using a SLAS token.", + "heading": "Description" + } + ], + "signature": "static readonly INVALID_REQUEST_TYPE = \"INVALID_REQUEST_TYPE\"", + "source": "script-api", + "tags": [ + "invalid_request_type", + "shoppercontexterrorcodes.invalid_request_type" + ], + "title": "ShopperContextErrorCodes.INVALID_REQUEST_TYPE" + }, + { + "description": "Indicates that the request type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or an ocapi request using a SLAS token.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#INVALID_REQUEST_TYPE", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE", + "sections": [ + { + "body": "Indicates that the request type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or\nan ocapi request using a SLAS token.", + "heading": "Description" + } + ], + "signature": "static readonly INVALID_REQUEST_TYPE = \"INVALID_REQUEST_TYPE\"", + "source": "script-api", + "tags": [ + "invalid_request_type", + "shoppercontexterrorcodes.invalid_request_type" + ], + "title": "ShopperContextErrorCodes.INVALID_REQUEST_TYPE" + }, + { + "description": "Indicates that the quota limit for the shopper context has been reached.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#QUOTA_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the quota limit for the shopper context has been reached.", + "heading": "Description" + } + ], + "signature": "static readonly QUOTA_LIMIT_EXCEEDED = \"QUOTA_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "quota_limit_exceeded", + "shoppercontexterrorcodes.quota_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED" + }, + { + "description": "Indicates that the quota limit for the shopper context has been reached.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes#QUOTA_LIMIT_EXCEEDED", + "kind": "constant", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextErrorCodes", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED", + "sections": [ + { + "body": "Indicates that the quota limit for the shopper context has been reached.", + "heading": "Description" + } + ], + "signature": "static readonly QUOTA_LIMIT_EXCEEDED = \"QUOTA_LIMIT_EXCEEDED\"", + "source": "script-api", + "tags": [ + "quota_limit_exceeded", + "shoppercontexterrorcodes.quota_limit_exceeded" + ], + "title": "ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED" + }, + { + "description": "This exception could be thrown by dw.customer.shoppercontext.ShopperContextMgr.setShopperContext, dw.customer.shoppercontext.ShopperContextMgr.getShopperContext and ShopperContextMgr.removeShopperContext when an error occurs.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextException", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException", + "sections": [ + { + "body": "This exception could be thrown by\ndw.customer.shoppercontext.ShopperContextMgr.setShopperContext,\ndw.customer.shoppercontext.ShopperContextMgr.getShopperContext and\nShopperContextMgr.removeShopperContext when an error occurs.\n\n'errorCode' property is set to one of the following values:\n\n- dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED = Indicates that the Shopper Context\nFeature is not enabled.\n- dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED = Indicates that the\nnumber of custom qualifiers in dw.customer.shoppercontext.ShopperContext has exceeded the allowed limit.\n- dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED = Indicates that\nthe number of assignment qualifiers in dw.customer.shoppercontext.ShopperContext has exceeded the allowed\nlimit.\n- dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED = Indicates that the quota limit\nfor the Shopper Context has been reached.\n\nFor more information on shopper context quota limits please refer to:\nShopper Context Quota Limits\n\n- dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR = Indicates that an error occurred\nwhile setting, retrieving or deleting the shopper context.\n- dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT = Indicates that an invalid client\nIP address was set in the Shopper Context.\n- dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE = Indicates that the request\ntype is invalid. Request must be a SCAPI request, or a hybrid storefront request, or an OCAPI request using a SLAS\ntoken.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shoppercontextexception", + "dw.customer.shoppercontext.shoppercontextexception", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextException" + }, + { + "description": "Indicates reason why the following methods failed: dw.customer.shoppercontext.ShopperContextMgr.setShopperContext or dw.customer.shoppercontext.ShopperContextMgr.getShopperContext or dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextException#errorCode", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextException", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException.errorCode", + "sections": [ + { + "body": "Indicates reason why the following methods failed:\ndw.customer.shoppercontext.ShopperContextMgr.setShopperContext or\ndw.customer.shoppercontext.ShopperContextMgr.getShopperContext or\ndw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.", + "heading": "Description" + } + ], + "signature": "readonly errorCode: string", + "source": "script-api", + "tags": [ + "errorcode", + "shoppercontextexception.errorcode" + ], + "title": "ShopperContextException.errorCode" + }, + { + "description": "Indicates reason why the following methods failed: dw.customer.shoppercontext.ShopperContextMgr.setShopperContext or dw.customer.shoppercontext.ShopperContextMgr.getShopperContext or dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextException#getErrorCode", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextException", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextException.getErrorCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Indicates reason why the following methods failed:\ndw.customer.shoppercontext.ShopperContextMgr.setShopperContext or\ndw.customer.shoppercontext.ShopperContextMgr.getShopperContext or\ndw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.", + "heading": "Description" + } + ], + "signature": "getErrorCode(): string", + "source": "script-api", + "tags": [ + "geterrorcode", + "shoppercontextexception.geterrorcode" + ], + "title": "ShopperContextException.getErrorCode" + }, + { + "description": "Provides static helper methods for managing Shopper Context.", + "examples": [ + "`\n// get the ShopperContext if it exists\nShopperContext context = ShopperContextMgr.getShopperContext();\nif (context == null) {\ncontext = new ShopperContext();\n}\n// set the values in the ShopperContext object\ncontext.setSourceCode( \"sourcecode\" );\nvar customQualifiers = new dw.util.HashMap();\ncustomQualifiers.put( \"deviceType\", \"iPad\" );\ncontext.setCustomQualifiers( customQualifiers );\n// Save the ShopperContext\nShopperContextMgr.setShopperContext( context, true );\n`" + ], + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "kind": "class", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr", + "sections": [ + { + "body": "Provides static helper methods for managing Shopper Context.\n\nShopper Context is used to personalize shopper experiences with context values such as custom session attributes,\nassignment qualifiers, geolocation, effective datetime, source code and more. When Shopper Context is set for a\nshopper, it can activate promotions or price books assigned to customer groups, source codes, or stores (via\nassignments) in the subsequent requests, not the current request.\n\nShopper Context is used to personalize the shopper experience in case of Composable/Headless or Hybrid storefront\nimplementations that use Shopper Login and API Access Service (SLAS).\n\nNOTE: This script API is not intended to be used for standard server-side storefront implementations. Only for\nComposable/Headless or Hybrid storefront implementations.\n\nUnlike dw.customer.CustomerContextMgr which is used to set just Effective Time for which the customer is\nshopping at, Shopper Context API provides a way to set many types of contexts such as custom session attributes,\nassignment qualifiers, geolocation, effective datetime, source code etc.\n\nThe following feature toggles and site preferences must be enabled in order to use this script API:\n\n- Enable Shopper Context Feature\n- Hybrid Auth Settings' site preference - only in case of Hybrid storefront implementations\n\nFor more details on Shopper Context please refer to: Shopper Context\nAPI Overview\n\nFor more details on Hybrid Authentication for Hybrid storefronts please refer to:\nHybrid\nAuthentication\n\ndw.customer.shoppercontext.ShopperContextMgr is used to create, access and delete Shopper Context.\n\n- To add Shopper Context, use methods setShopperContext.\n- To access Shopper Context, use method getShopperContext.\n- To delete Shopper Context, use methods removeShopperContext.\n- To fetch Geolocation based on clientIP already set in Shopper Context, use method getGeolocation\n\nTypical usage:\n\n\nNOTE: Ensure the ShopperContext object is saved using setShopperContext after\nsetting or updating the context values.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shoppercontextmgr", + "dw.customer.shoppercontext.shoppercontextmgr", + "dw/customer/shoppercontext" + ], + "title": "ShopperContextMgr" + }, + { + "description": "Gets the dw.util.Geolocation object for the clientIP set in dw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set or Geolocation for the clientIP was not found.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.geolocation", + "sections": [ + { + "body": "Gets the dw.util.Geolocation object for the clientIP set in\ndw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set\nor Geolocation for the clientIP was not found.\n\nThe method throws an exception if the call fails.", + "heading": "Description" + } + ], + "signature": "static readonly geolocation: Geolocation | null", + "source": "script-api", + "tags": [ + "geolocation", + "shoppercontextmgr.geolocation" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while trying to retrieve Geolocation string from the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.geolocation" + }, + { + "description": "Gets the dw.util.Geolocation object for the clientIP set in dw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set or Geolocation for the clientIP was not found.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#geolocation", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.geolocation", + "sections": [ + { + "body": "Gets the dw.util.Geolocation object for the clientIP set in\ndw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set\nor Geolocation for the clientIP was not found.\n\nThe method throws an exception if the call fails.", + "heading": "Description" + } + ], + "signature": "static readonly geolocation: Geolocation | null", + "source": "script-api", + "tags": [ + "geolocation", + "shoppercontextmgr.geolocation" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while trying to retrieve Geolocation string from the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.geolocation" + }, + { + "description": "Gets the dw.util.Geolocation object for the clientIP set in dw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set or Geolocation for the clientIP was not found.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getGeolocation", + "returns": { + "type": "Geolocation | null" + }, + "sections": [ + { + "body": "Gets the dw.util.Geolocation object for the clientIP set in\ndw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set\nor Geolocation for the clientIP was not found.\n\nThe method throws an exception if the call fails.", + "heading": "Description" + } + ], + "signature": "static getGeolocation(): Geolocation | null", + "source": "script-api", + "tags": [ + "getgeolocation", + "shoppercontextmgr.getgeolocation" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while trying to retrieve Geolocation string from the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.getGeolocation" + }, + { + "description": "Gets the dw.util.Geolocation object for the clientIP set in dw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set or Geolocation for the clientIP was not found.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getGeolocation", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getGeolocation", + "returns": { + "type": "Geolocation | null" + }, + "sections": [ + { + "body": "Gets the dw.util.Geolocation object for the clientIP set in\ndw.customer.shoppercontext.ShopperContext or null if no shopperContext is found, or no clientIP was set\nor Geolocation for the clientIP was not found.\n\nThe method throws an exception if the call fails.", + "heading": "Description" + } + ], + "signature": "static getGeolocation(): Geolocation | null", + "source": "script-api", + "tags": [ + "getgeolocation", + "shoppercontextmgr.getgeolocation" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while trying to retrieve Geolocation string from the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.getGeolocation" + }, + { + "description": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it does not exist.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getShopperContext", + "returns": { + "type": "ShopperContext | null" + }, + "sections": [ + { + "body": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it\ndoes not exist.", + "heading": "Description" + } + ], + "signature": "static getShopperContext(): ShopperContext | null", + "source": "script-api", + "tags": [ + "getshoppercontext", + "shoppercontextmgr.getshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if an error occurs while fetching the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.getShopperContext" + }, + { + "description": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it does not exist.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#getShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.getShopperContext", + "returns": { + "type": "ShopperContext | null" + }, + "sections": [ + { + "body": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it\ndoes not exist.", + "heading": "Description" + } + ], + "signature": "static getShopperContext(): ShopperContext | null", + "source": "script-api", + "tags": [ + "getshoppercontext", + "shoppercontextmgr.getshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if an error occurs while fetching the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.getShopperContext" + }, + { + "description": "Removes the dw.customer.shoppercontext.ShopperContext for the customer.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#removeShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the dw.customer.shoppercontext.ShopperContext for the customer.\n\nThe method throws an exception if the deletion of Shopper Context fails.", + "heading": "Description" + } + ], + "signature": "static removeShopperContext(): void", + "source": "script-api", + "tags": [ + "removeshoppercontext", + "shoppercontextmgr.removeshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while deleting the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.removeShopperContext" + }, + { + "description": "Removes the dw.customer.shoppercontext.ShopperContext for the customer.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#removeShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the dw.customer.shoppercontext.ShopperContext for the customer.\n\nThe method throws an exception if the deletion of Shopper Context fails.", + "heading": "Description" + } + ], + "signature": "static removeShopperContext(): void", + "source": "script-api", + "tags": [ + "removeshoppercontext", + "shoppercontextmgr.removeshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if error occurs while deleting the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.removeShopperContext" + }, + { + "description": "Sets new dw.customer.shoppercontext.ShopperContext for the customer or overwrites the existing context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#setShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "shopperContext", + "type": "ShopperContext" + }, + { + "name": "evaluateContextWithClientIP", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.setShopperContext", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets new dw.customer.shoppercontext.ShopperContext for the customer or overwrites the existing context.\n\nNote: This method does not save the attributes from the given Shopper Context such as - custom session\nattributes, source code, effective date time etc., - in the current session object. These attributes are read\nfrom Shopper Context and stored in the corresponding session attributes during subsequent requests and not in the\ncurrent request. Hence, promotions, price books etc., are triggered in subsequent requests.\n\nIf `clientIP` is set in dw.customer.shoppercontext.ShopperContext, the geolocation information\nis retrieved and set in `x-geolocation` header.\n\nAnd if the parameter `evaluateContextWithClientIP` is set to true, the `clientIP` will be\nsaved to the Shopper Context.\n\nIf parameter `evaluateContextWithClientIP` is set to false, the `clientIP` will not be\nsaved to the Shopper Context.\n\nIf the `geoLocation` attribute is set, it overrides any geolocation context set by\n`clientIP`.", + "heading": "Description" + } + ], + "signature": "static setShopperContext(shopperContext: ShopperContext, evaluateContextWithClientIP: boolean): void", + "source": "script-api", + "tags": [ + "setshoppercontext", + "shoppercontextmgr.setshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if the Shopper Context is not saved or if validation fails.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.setShopperContext" + }, + { + "description": "Sets new dw.customer.shoppercontext.ShopperContext for the customer or overwrites the existing context.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#setShopperContext", + "kind": "method", + "packagePath": "dw/customer/shoppercontext", + "params": [ + { + "name": "shopperContext", + "type": "ShopperContext" + }, + { + "name": "evaluateContextWithClientIP", + "type": "boolean" + } + ], + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.setShopperContext", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets new dw.customer.shoppercontext.ShopperContext for the customer or overwrites the existing context.\n\nNote: This method does not save the attributes from the given Shopper Context such as - custom session\nattributes, source code, effective date time etc., - in the current session object. These attributes are read\nfrom Shopper Context and stored in the corresponding session attributes during subsequent requests and not in the\ncurrent request. Hence, promotions, price books etc., are triggered in subsequent requests.\n\nIf `clientIP` is set in dw.customer.shoppercontext.ShopperContext, the geolocation information\nis retrieved and set in `x-geolocation` header.\n\nAnd if the parameter `evaluateContextWithClientIP` is set to true, the `clientIP` will be\nsaved to the Shopper Context.\n\nIf parameter `evaluateContextWithClientIP` is set to false, the `clientIP` will not be\nsaved to the Shopper Context.\n\nIf the `geoLocation` attribute is set, it overrides any geolocation context set by\n`clientIP`.", + "heading": "Description" + } + ], + "signature": "static setShopperContext(shopperContext: ShopperContext, evaluateContextWithClientIP: boolean): void", + "source": "script-api", + "tags": [ + "setshoppercontext", + "shoppercontextmgr.setshoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if the Shopper Context is not saved or if validation fails.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.setShopperContext" + }, + { + "description": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it does not exist.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#shopperContext", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.shopperContext", + "sections": [ + { + "body": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it\ndoes not exist.", + "heading": "Description" + } + ], + "signature": "static readonly shopperContext: ShopperContext | null", + "source": "script-api", + "tags": [ + "shoppercontext", + "shoppercontextmgr.shoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if an error occurs while fetching the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.shopperContext" + }, + { + "description": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it does not exist.", + "id": "script-api:dw/customer/shoppercontext/ShopperContextMgr#shopperContext", + "kind": "property", + "packagePath": "dw/customer/shoppercontext", + "parentId": "script-api:dw/customer/shoppercontext/ShopperContextMgr", + "qualifiedName": "dw.customer.shoppercontext.ShopperContextMgr.shopperContext", + "sections": [ + { + "body": "Returns the dw.customer.shoppercontext.ShopperContext if it exists for the customer. Returns null if it\ndoes not exist.", + "heading": "Description" + } + ], + "signature": "static readonly shopperContext: ShopperContext | null", + "source": "script-api", + "tags": [ + "shoppercontext", + "shoppercontextmgr.shoppercontext" + ], + "throws": [ + { + "description": "This exception is thrown if an error occurs while fetching the Shopper Context.", + "type": "dw.customer.shoppercontext.ShopperContextException" + } + ], + "title": "ShopperContextMgr.shopperContext" + }, + { + "description": "11 declarations", + "id": "script-api:dw/experience", + "kind": "package", + "packagePath": "dw/experience", + "qualifiedName": "dw.experience", + "source": "script-api", + "tags": [ + "dw/experience", + "dw.experience" + ], + "title": "dw.experience" + }, + { + "description": "This APIException is thrown by method PageMgr.renderPage and PageMgr.serializePage to indicate that the passed aspect attributes failed during validation against the definition provided through the aspect type of the page.", + "id": "script-api:dw/experience/AspectAttributeValidationException", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.AspectAttributeValidationException", + "sections": [ + { + "body": "This APIException is thrown by method PageMgr.renderPage\nand PageMgr.serializePage\nto indicate that the passed aspect attributes failed during validation against the\ndefinition provided through the aspect type of the page.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "aspectattributevalidationexception", + "dw.experience.aspectattributevalidationexception", + "dw/experience" + ], + "title": "AspectAttributeValidationException" + }, + { + "description": "This class represents a page designer managed component as part of a page. A component comprises of multiple regions that again hold components, thus spanning a hierarchical tree of components. Using the PageMgr.renderRegion or PageMgr.renderRegion a region can be rendered which implicitly includes rendering of all contained visible components. All content attributes (defined by the corresponding component type) can be accessed, reading the accordant persisted values as provided by the content editor who created this component.", + "id": "script-api:dw/experience/Component", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Component", + "sections": [ + { + "body": "This class represents a page designer managed component as part of a\npage. A component comprises of multiple regions that again hold components,\nthus spanning a hierarchical tree of components. Using the PageMgr.renderRegion or\nPageMgr.renderRegion a region can be rendered which\nimplicitly includes rendering of all contained visible components. All\ncontent attributes (defined by the corresponding component type) can be\naccessed, reading the accordant persisted values as provided by the content editor\nwho created this component.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "component", + "dw.experience.component", + "dw/experience" + ], + "title": "Component" + }, + { + "description": "Returns the id of this component.", + "id": "script-api:dw/experience/Component#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.ID", + "sections": [ + { + "body": "Returns the id of this component.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "component.id" + ], + "title": "Component.ID" + }, + { + "description": "Returns the raw attribute value identified by the specified attribute id. By raw attribute value we denote the unprocessed value as provided for the attribute driven by the type of the respective attribute definition:", + "id": "script-api:dw/experience/Component#getAttribute", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getAttribute", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Returns the raw attribute value identified by the specified attribute id.\nBy raw attribute value we denote the unprocessed value as provided for the attribute\ndriven by the type of the respective attribute definition:\n\n- `boolean` -> boolean\n- `category` -> string representing a catalog category ID\n- `custom` -> dw.util.Map that originates from a stringified curly brackets {} JSON object\n- `cms_record` -> dw.util.Map that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `cmsrecord.json` schema\n- `enum` -> either string or integer\n- `file` -> string representing a file path within a library\n- `image` -> dw.util.Map that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `content/schema/image.json` schema\n- `integer` -> integer\n- `markup` -> string representing HTML markup\n- `page` -> string representing a page ID\n- `product` -> string representing a product SKU\n- `string` -> string\n- `text` -> string\n- `url` -> string representing a URL\n\nThere is two places an attribute value can come from - either it was persisted at design time (e.g.\nby the merchant by editing a component in Page Designer) or it was injected in shape of an aspect attribute at rendering time\nthrough the execution of code. The persistent value, if existing, takes precedence over the injected aspect\nattribute one. Injection of a value through an aspect attribute will only occur if the component attribute's\nattribute definition was declared using the `\"dynamic_lookup\"` property and its aspect attribute alias matches\nthe ID of the respective aspect attribute.\n\nAccessing the raw value can be helpful if render and serialization logic of the\ncomponent needs to operate on these unprocessed values. An unprocessed value\nmight be fundamentally different from its processed counterpart, the latter being\nprovided through the content dictionary (see ComponentScriptContext.getContent)\nwhen the render/serialize function of the component is invoked.", + "heading": "Description" + } + ], + "signature": "getAttribute(attributeID: string): any | null", + "source": "script-api", + "tags": [ + "getattribute", + "component.getattribute" + ], + "title": "Component.getAttribute" + }, + { + "description": "Returns the id of this component.", + "id": "script-api:dw/experience/Component#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of this component.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "component.getid" + ], + "title": "Component.getID" + }, + { + "description": "Returns the name of this component", + "id": "script-api:dw/experience/Component#getName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of this component", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "component.getname" + ], + "title": "Component.getName" + }, + { + "description": "Returns the component region that matches the given id.", + "id": "script-api:dw/experience/Component#getRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getRegion", + "returns": { + "type": "Region | null" + }, + "sections": [ + { + "body": "Returns the component region that matches the given id.", + "heading": "Description" + } + ], + "signature": "getRegion(id: string): Region | null", + "source": "script-api", + "tags": [ + "getregion", + "component.getregion" + ], + "title": "Component.getRegion" + }, + { + "description": "Returns the type id of this component.", + "id": "script-api:dw/experience/Component#getTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.getTypeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type id of this component.", + "heading": "Description" + } + ], + "signature": "getTypeID(): string", + "source": "script-api", + "tags": [ + "gettypeid", + "component.gettypeid" + ], + "title": "Component.getTypeID" + }, + { + "description": "Returns the name of this component", + "id": "script-api:dw/experience/Component#name", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.name", + "sections": [ + { + "body": "Returns the name of this component", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "component.name" + ], + "title": "Component.name" + }, + { + "description": "Returns the type id of this component.", + "id": "script-api:dw/experience/Component#typeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Component", + "qualifiedName": "dw.experience.Component.typeID", + "sections": [ + { + "body": "Returns the type id of this component.", + "heading": "Description" + } + ], + "signature": "readonly typeID: string", + "source": "script-api", + "tags": [ + "typeid", + "component.typeid" + ], + "title": "Component.typeID" + }, + { + "description": "A config that drives how the component is rendered. One can basically decide which kind of tag is used as wrapper element (e.g. `
    ...
    `) and which attributes are to be placed into this wrapper element (e.g. `class=\"foo bar\"`). In case no attributes are provided then the system default settings will apply. In case no tag name is provided then the system default one will apply.", + "id": "script-api:dw/experience/ComponentRenderSettings", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.ComponentRenderSettings", + "sections": [ + { + "body": "A config that drives how the component is rendered. One can basically decide which kind of tag is used as wrapper\nelement (e.g. `
    ...
    `) and which attributes are to be placed into this wrapper\nelement (e.g. `class=\"foo bar\"`). In case no attributes are provided then the system default settings will\napply. In case no tag name is provided then the system default one will apply.\n\n- tag_name : div\n- attributes : {\"class\":\"experience-component experience-[COMPONENT_TYPE_ID]\"}\n\nAs the [COMPONENT_TYPE_ID] can contain dots due to its package like naming scheme (e.g. assets.image)\nany occurrences of these dots will be replaced by dashes (e.g. assets-image) so that CSS selectors\ndo not have to be escaped.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "componentrendersettings", + "dw.experience.componentrendersettings", + "dw/experience" + ], + "title": "ComponentRenderSettings" + }, + { + "description": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "id": "script-api:dw/experience/ComponentRenderSettings#attributes", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.attributes", + "sections": [ + { + "body": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "heading": "Description" + } + ], + "signature": "attributes: any", + "source": "script-api", + "tags": [ + "attributes", + "componentrendersettings.attributes" + ], + "title": "ComponentRenderSettings.attributes" + }, + { + "description": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "id": "script-api:dw/experience/ComponentRenderSettings#getAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.getAttributes", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "heading": "Description" + } + ], + "signature": "getAttributes(): any", + "source": "script-api", + "tags": [ + "getattributes", + "componentrendersettings.getattributes" + ], + "title": "ComponentRenderSettings.getAttributes" + }, + { + "description": "Returns the tag name of the component wrapper element. Defaults to 'div'.", + "id": "script-api:dw/experience/ComponentRenderSettings#getTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.getTagName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tag name of the component wrapper element. Defaults to 'div'.", + "heading": "Description" + } + ], + "signature": "getTagName(): string", + "source": "script-api", + "tags": [ + "gettagname", + "componentrendersettings.gettagname" + ], + "title": "ComponentRenderSettings.getTagName" + }, + { + "description": "Sets the to be configured attributes of the wrapper element. Set it to `null` in case you want to system defaults to be applied.", + "id": "script-api:dw/experience/ComponentRenderSettings#setAttributes", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "attributes", + "type": "Object" + } + ], + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.setAttributes", + "returns": { + "type": "ComponentRenderSettings" + }, + "sections": [ + { + "body": "Sets the to be configured attributes of the wrapper element. Set it to `null` in case\nyou want to system defaults to be applied.", + "heading": "Description" + } + ], + "signature": "setAttributes(attributes: Object): ComponentRenderSettings", + "source": "script-api", + "tags": [ + "setattributes", + "componentrendersettings.setattributes" + ], + "title": "ComponentRenderSettings.setAttributes" + }, + { + "description": "Sets the tag name of the component wrapper element. Must not be empty.", + "id": "script-api:dw/experience/ComponentRenderSettings#setTagName", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "tagName", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.setTagName", + "returns": { + "type": "ComponentRenderSettings" + }, + "sections": [ + { + "body": "Sets the tag name of the component wrapper element. Must not be empty.", + "heading": "Description" + } + ], + "signature": "setTagName(tagName: string): ComponentRenderSettings", + "source": "script-api", + "tags": [ + "settagname", + "componentrendersettings.settagname" + ], + "title": "ComponentRenderSettings.setTagName" + }, + { + "description": "Returns the tag name of the component wrapper element. Defaults to 'div'.", + "id": "script-api:dw/experience/ComponentRenderSettings#tagName", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentRenderSettings", + "qualifiedName": "dw.experience.ComponentRenderSettings.tagName", + "sections": [ + { + "body": "Returns the tag name of the component wrapper element. Defaults to 'div'.", + "heading": "Description" + } + ], + "signature": "tagName: string", + "source": "script-api", + "tags": [ + "tagname", + "componentrendersettings.tagname" + ], + "title": "ComponentRenderSettings.tagName" + }, + { + "description": "This is the context that is handed over to the `render` and `serialize` function of the respective component type script.", + "id": "script-api:dw/experience/ComponentScriptContext", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.ComponentScriptContext", + "sections": [ + { + "body": "This is the context that is handed over to the `render` and `serialize` function of the respective component type\nscript.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "componentscriptcontext", + "dw.experience.componentscriptcontext", + "dw/experience" + ], + "title": "ComponentScriptContext" + }, + { + "description": "Returns the component for which the corresponding component type script is currently executed.", + "id": "script-api:dw/experience/ComponentScriptContext#component", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.component", + "sections": [ + { + "body": "Returns the component for which the corresponding component type script is currently executed.", + "heading": "Description" + } + ], + "signature": "readonly component: Component", + "source": "script-api", + "tags": [ + "component", + "componentscriptcontext.component" + ], + "title": "ComponentScriptContext.component" + }, + { + "description": "As components are implicitly rendered as part of their hosting region via PageMgr.renderRegion there is the possibility to define render settings for the region itself but also for its contained components. The latter will be provided here so you further set or refine them for your component as part of the `render` function, i.e. to drive the shape of the component wrapper element.", + "id": "script-api:dw/experience/ComponentScriptContext#componentRenderSettings", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.componentRenderSettings", + "sections": [ + { + "body": "As components are implicitly rendered as part of their hosting region via\nPageMgr.renderRegion there is the possibility\nto define render settings for the region itself but also for its contained components.\nThe latter will be provided here so you further set or refine them for your component\nas part of the `render` function, i.e. to drive the shape of the\ncomponent wrapper element.", + "heading": "Description" + } + ], + "signature": "readonly componentRenderSettings: ComponentRenderSettings", + "source": "script-api", + "tags": [ + "componentrendersettings", + "componentscriptcontext.componentrendersettings" + ], + "title": "ComponentScriptContext.componentRenderSettings" + }, + { + "description": "Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute) of this component's attributes which you can use in your respective component type `render` and `serialize` function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.", + "id": "script-api:dw/experience/ComponentScriptContext#content", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.content", + "sections": [ + { + "body": "Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute)\nof this component's attributes which you can use in your respective component type `render` and `serialize` function\nimplementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion\nand conversion, in this order.\n\n- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in\nmarkup text are resolved to real URLs\n- conversion - the raw value (see Component.getAttribute) is resolved into an actual\nDWScript object depending on the type of the attribute as specified in its respective attribute definition\n\n- `boolean` -> boolean\n- `category` -> dw.catalog.Category\n- `custom` -> dw.util.Map\n- `cms_record` -> dw.experience.cms.CMSRecord\n- `enum` -> either string or integer\n- `file` -> dw.content.MediaFile\n- `image` -> dw.experience.image.Image\n- `integer` -> integer\n- `markup` -> string\n- `page` -> string\n- `product` -> dw.catalog.Product\n- `string` -> string\n- `text` -> string\n- `url` -> string", + "heading": "Description" + } + ], + "signature": "readonly content: utilMap", + "source": "script-api", + "tags": [ + "content", + "componentscriptcontext.content" + ], + "title": "ComponentScriptContext.content" + }, + { + "description": "Returns the component for which the corresponding component type script is currently executed.", + "id": "script-api:dw/experience/ComponentScriptContext#getComponent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getComponent", + "returns": { + "type": "Component" + }, + "sections": [ + { + "body": "Returns the component for which the corresponding component type script is currently executed.", + "heading": "Description" + } + ], + "signature": "getComponent(): Component", + "source": "script-api", + "tags": [ + "getcomponent", + "componentscriptcontext.getcomponent" + ], + "title": "ComponentScriptContext.getComponent" + }, + { + "description": "As components are implicitly rendered as part of their hosting region via PageMgr.renderRegion there is the possibility to define render settings for the region itself but also for its contained components. The latter will be provided here so you further set or refine them for your component as part of the `render` function, i.e. to drive the shape of the component wrapper element.", + "id": "script-api:dw/experience/ComponentScriptContext#getComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getComponentRenderSettings", + "returns": { + "type": "ComponentRenderSettings" + }, + "sections": [ + { + "body": "As components are implicitly rendered as part of their hosting region via\nPageMgr.renderRegion there is the possibility\nto define render settings for the region itself but also for its contained components.\nThe latter will be provided here so you further set or refine them for your component\nas part of the `render` function, i.e. to drive the shape of the\ncomponent wrapper element.", + "heading": "Description" + } + ], + "signature": "getComponentRenderSettings(): ComponentRenderSettings", + "source": "script-api", + "tags": [ + "getcomponentrendersettings", + "componentscriptcontext.getcomponentrendersettings" + ], + "title": "ComponentScriptContext.getComponentRenderSettings" + }, + { + "description": "Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute) of this component's attributes which you can use in your respective component type `render` and `serialize` function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.", + "id": "script-api:dw/experience/ComponentScriptContext#getContent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/ComponentScriptContext", + "qualifiedName": "dw.experience.ComponentScriptContext.getContent", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the processed version of the underlying unprocessed raw values (also see Component.getAttribute)\nof this component's attributes which you can use in your respective component type `render` and `serialize` function\nimplementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion\nand conversion, in this order.\n\n- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in\nmarkup text are resolved to real URLs\n- conversion - the raw value (see Component.getAttribute) is resolved into an actual\nDWScript object depending on the type of the attribute as specified in its respective attribute definition\n\n- `boolean` -> boolean\n- `category` -> dw.catalog.Category\n- `custom` -> dw.util.Map\n- `cms_record` -> dw.experience.cms.CMSRecord\n- `enum` -> either string or integer\n- `file` -> dw.content.MediaFile\n- `image` -> dw.experience.image.Image\n- `integer` -> integer\n- `markup` -> string\n- `page` -> string\n- `product` -> dw.catalog.Product\n- `string` -> string\n- `text` -> string\n- `url` -> string", + "heading": "Description" + } + ], + "signature": "getContent(): utilMap", + "source": "script-api", + "tags": [ + "getcontent", + "componentscriptcontext.getcontent" + ], + "title": "ComponentScriptContext.getContent" + }, + { + "description": "This class represents a custom editor for component attributes of type `custom`. It is instantiated by Page Designer and is subsequently used there for editing of such attributes by the merchant in a visual manner. It therefore serves the Page Designer with all information required by such UI. What exactly this information will be is up to the developer of the respective custom editor UI, i.e. depends on the respective json and js files written for both the attribute definition as well as the custom editor type. Currently a configuration can be served (basically values passed to Page Designer so that it can bootstrap the custom editor UI on the client side). Furthermore resources can be served, which are URLs to scripts and styles required by the same UI (you will likely require your own Javascript and CSS there).", + "id": "script-api:dw/experience/CustomEditor", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.CustomEditor", + "sections": [ + { + "body": "This class represents a custom editor for component attributes of type `custom`. It is instantiated\nby Page Designer and is subsequently used there for editing of such attributes by the merchant in a visual manner.\nIt therefore serves the Page Designer with all information required by such UI. What exactly\nthis information will be is up to the developer of the respective custom editor UI, i.e. depends on the respective\njson and js files written for both the attribute definition as well as the custom editor type. Currently a configuration can be\nserved (basically values passed to Page Designer so that it can bootstrap the custom editor UI on the client side).\nFurthermore resources can be served, which are URLs to scripts and styles required by the same UI (you will\nlikely require your own Javascript and CSS there).\n\nYou can access the aforementioned configuration as provided through the editor definition of the respective attribute\ndefinition, which you can also adjust in the `init` function (see corresponding js file of your custom editor\ntype) that is called during initialization of the custom editor, i.e. right before it is passed to the Page Designer UI.\nThe same applies for the script and style resources which you specified as part of your custom editor type and which you\ncan refine with the `init` function as needed.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customeditor", + "dw.experience.customeditor", + "dw/experience" + ], + "title": "CustomEditor" + }, + { + "description": "Returns the configuration of the custom editor. This is initialized with the values as provided through the editor definition of the respective attribute definition of type `custom`. Be aware that this configuration will have to be serializable to JSON itself as it will be passed to Page Designer for processing in the UI. So you must not add any values in this map that are not properly serializable. Do not use complex DWScript classes that do not support JSON serialization like for instance dw.catalog.Product.", + "id": "script-api:dw/experience/CustomEditor#configuration", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.configuration", + "sections": [ + { + "body": "Returns the configuration of the custom editor. This is initialized with the values as provided\nthrough the editor definition of the respective attribute definition of type `custom`.\nBe aware that this configuration will have to be serializable to JSON itself as it will be passed\nto Page Designer for processing in the UI. So you must not add any values in this map that are not\nproperly serializable. Do not use complex DWScript classes that do not support JSON serialization\nlike for instance dw.catalog.Product.", + "heading": "Description" + } + ], + "signature": "readonly configuration: utilMap", + "source": "script-api", + "tags": [ + "configuration", + "customeditor.configuration" + ], + "title": "CustomEditor.configuration" + }, + { + "description": "Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use this mapping to add more custom editor dependencies as needed. For this purpose you want to create a CustomEditor instance via PageMgr.getCustomEditor) and then add it to the dependencies mapping with an ID of your choice. In the client side logic of Page Designer you will then be able to access these dependencies again by using the corresponding ID.", + "id": "script-api:dw/experience/CustomEditor#dependencies", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.dependencies", + "sections": [ + { + "body": "Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use\nthis mapping to add more custom editor dependencies as needed. For this purpose you want to create\na CustomEditor instance via PageMgr.getCustomEditor) and then add it\nto the dependencies mapping with an ID of your choice. In the client side logic of Page Designer\nyou will then be able to access these dependencies again by using the corresponding ID.\n\nThis is especially helpful if your custom editor for an attribute requires to open a breakout panel,\ne.g. for a separate picker required by your custom editor. This picker could be another custom editor,\ni.e. the one you declare as dependency here.", + "heading": "Description" + } + ], + "signature": "readonly dependencies: utilMap", + "source": "script-api", + "tags": [ + "dependencies", + "customeditor.dependencies" + ], + "title": "CustomEditor.dependencies" + }, + { + "description": "Returns the configuration of the custom editor. This is initialized with the values as provided through the editor definition of the respective attribute definition of type `custom`. Be aware that this configuration will have to be serializable to JSON itself as it will be passed to Page Designer for processing in the UI. So you must not add any values in this map that are not properly serializable. Do not use complex DWScript classes that do not support JSON serialization like for instance dw.catalog.Product.", + "id": "script-api:dw/experience/CustomEditor#getConfiguration", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getConfiguration", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the configuration of the custom editor. This is initialized with the values as provided\nthrough the editor definition of the respective attribute definition of type `custom`.\nBe aware that this configuration will have to be serializable to JSON itself as it will be passed\nto Page Designer for processing in the UI. So you must not add any values in this map that are not\nproperly serializable. Do not use complex DWScript classes that do not support JSON serialization\nlike for instance dw.catalog.Product.", + "heading": "Description" + } + ], + "signature": "getConfiguration(): utilMap", + "source": "script-api", + "tags": [ + "getconfiguration", + "customeditor.getconfiguration" + ], + "title": "CustomEditor.getConfiguration" + }, + { + "description": "Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use this mapping to add more custom editor dependencies as needed. For this purpose you want to create a CustomEditor instance via PageMgr.getCustomEditor) and then add it to the dependencies mapping with an ID of your choice. In the client side logic of Page Designer you will then be able to access these dependencies again by using the corresponding ID.", + "id": "script-api:dw/experience/CustomEditor#getDependencies", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getDependencies", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use\nthis mapping to add more custom editor dependencies as needed. For this purpose you want to create\na CustomEditor instance via PageMgr.getCustomEditor) and then add it\nto the dependencies mapping with an ID of your choice. In the client side logic of Page Designer\nyou will then be able to access these dependencies again by using the corresponding ID.\n\nThis is especially helpful if your custom editor for an attribute requires to open a breakout panel,\ne.g. for a separate picker required by your custom editor. This picker could be another custom editor,\ni.e. the one you declare as dependency here.", + "heading": "Description" + } + ], + "signature": "getDependencies(): utilMap", + "source": "script-api", + "tags": [ + "getdependencies", + "customeditor.getdependencies" + ], + "title": "CustomEditor.getDependencies" + }, + { + "description": "Returns the resources of the custom editor. This is initialized with the values as specified by the custom editor type json (see the respective styles and scripts section).", + "id": "script-api:dw/experience/CustomEditor#getResources", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.getResources", + "returns": { + "type": "CustomEditorResources" + }, + "sections": [ + { + "body": "Returns the resources of the custom editor. This is initialized with the values as specified\nby the custom editor type json (see the respective styles and scripts section).", + "heading": "Description" + } + ], + "signature": "getResources(): CustomEditorResources", + "source": "script-api", + "tags": [ + "getresources", + "customeditor.getresources" + ], + "title": "CustomEditor.getResources" + }, + { + "description": "Returns the resources of the custom editor. This is initialized with the values as specified by the custom editor type json (see the respective styles and scripts section).", + "id": "script-api:dw/experience/CustomEditor#resources", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditor", + "qualifiedName": "dw.experience.CustomEditor.resources", + "sections": [ + { + "body": "Returns the resources of the custom editor. This is initialized with the values as specified\nby the custom editor type json (see the respective styles and scripts section).", + "heading": "Description" + } + ], + "signature": "readonly resources: CustomEditorResources", + "source": "script-api", + "tags": [ + "resources", + "customeditor.resources" + ], + "title": "CustomEditor.resources" + }, + { + "description": "This class represents the resources of a custom editor, i.e. URLs to scripts and styles which are required for client side functionality in Page Designer in context of the corresponding custom attribute UI. These resources are initially specified as part of your custom editor type (i.e. the respective json file). If needed you can revise and refine them as part of the `init` function that is called during initialization of the CustomEditor, i.e. is subject to your implementation of the respective custom editor type js file.", + "id": "script-api:dw/experience/CustomEditorResources", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.CustomEditorResources", + "sections": [ + { + "body": "This class represents the resources of a custom editor, i.e. URLs to scripts and styles which are required for\nclient side functionality in Page Designer in context of the corresponding custom attribute UI. These resources\nare initially specified as part of your custom editor type (i.e. the respective json file). If needed you can\nrevise and refine them as part of the `init` function that is called during initialization of the\nCustomEditor, i.e. is subject to your implementation of the respective custom editor type js file.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customeditorresources", + "dw.experience.customeditorresources", + "dw/experience" + ], + "title": "CustomEditorResources" + }, + { + "description": "Returns the specified script resource URLs. You can further modify this list at runtime of your `init` function to add more required scripts. Absolute URLs will be retained, relative paths will be resolved to absolute ones based on the cartridge path for static resources (e.g. similar to what dw.web.URLUtils.httpStatic or dw.web.URLUtils.httpsStatic) does.", + "id": "script-api:dw/experience/CustomEditorResources#getScripts", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.getScripts", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the specified script resource URLs. You can further modify this list\nat runtime of your `init` function to add more required scripts.\nAbsolute URLs will be retained, relative paths will be resolved to absolute\nones based on the cartridge path for static resources (e.g. similar to\nwhat dw.web.URLUtils.httpStatic or\ndw.web.URLUtils.httpsStatic) does.", + "heading": "Description" + } + ], + "signature": "getScripts(): List", + "source": "script-api", + "tags": [ + "getscripts", + "customeditorresources.getscripts" + ], + "title": "CustomEditorResources.getScripts" + }, + { + "description": "Returns the specified style URLs. You can further modify this list at runtime of your `init` function to add more required styles. Absolute URLs will be retained, relative paths will be resolved to absolute ones based on the cartridge path for static resources (e.g. similar to what dw.web.URLUtils.httpStatic or dw.web.URLUtils.httpsStatic) does.", + "id": "script-api:dw/experience/CustomEditorResources#getStyles", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.getStyles", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the specified style URLs. You can further modify this list\nat runtime of your `init` function to add more required styles.\nAbsolute URLs will be retained, relative paths will be resolved to absolute\nones based on the cartridge path for static resources (e.g. similar to\nwhat dw.web.URLUtils.httpStatic or\ndw.web.URLUtils.httpsStatic) does.", + "heading": "Description" + } + ], + "signature": "getStyles(): List", + "source": "script-api", + "tags": [ + "getstyles", + "customeditorresources.getstyles" + ], + "title": "CustomEditorResources.getStyles" + }, + { + "description": "Returns the specified script resource URLs. You can further modify this list at runtime of your `init` function to add more required scripts. Absolute URLs will be retained, relative paths will be resolved to absolute ones based on the cartridge path for static resources (e.g. similar to what dw.web.URLUtils.httpStatic or dw.web.URLUtils.httpsStatic) does.", + "id": "script-api:dw/experience/CustomEditorResources#scripts", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.scripts", + "sections": [ + { + "body": "Returns the specified script resource URLs. You can further modify this list\nat runtime of your `init` function to add more required scripts.\nAbsolute URLs will be retained, relative paths will be resolved to absolute\nones based on the cartridge path for static resources (e.g. similar to\nwhat dw.web.URLUtils.httpStatic or\ndw.web.URLUtils.httpsStatic) does.", + "heading": "Description" + } + ], + "signature": "readonly scripts: List", + "source": "script-api", + "tags": [ + "scripts", + "customeditorresources.scripts" + ], + "title": "CustomEditorResources.scripts" + }, + { + "description": "Returns the specified style URLs. You can further modify this list at runtime of your `init` function to add more required styles. Absolute URLs will be retained, relative paths will be resolved to absolute ones based on the cartridge path for static resources (e.g. similar to what dw.web.URLUtils.httpStatic or dw.web.URLUtils.httpsStatic) does.", + "id": "script-api:dw/experience/CustomEditorResources#styles", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/CustomEditorResources", + "qualifiedName": "dw.experience.CustomEditorResources.styles", + "sections": [ + { + "body": "Returns the specified style URLs. You can further modify this list\nat runtime of your `init` function to add more required styles.\nAbsolute URLs will be retained, relative paths will be resolved to absolute\nones based on the cartridge path for static resources (e.g. similar to\nwhat dw.web.URLUtils.httpStatic or\ndw.web.URLUtils.httpsStatic) does.", + "heading": "Description" + } + ], + "signature": "readonly styles: List", + "source": "script-api", + "tags": [ + "styles", + "customeditorresources.styles" + ], + "title": "CustomEditorResources.styles" + }, + { + "description": "This class represents a page designer managed page. A page comprises of multiple regions that hold components, which themselves again can have regions holding components, i.e. spanning a hierarchical tree of components.", + "id": "script-api:dw/experience/Page", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Page", + "sections": [ + { + "body": "This class represents a page designer managed page. A page comprises of\nmultiple regions that hold components, which themselves again can have\nregions holding components, i.e. spanning a hierarchical tree of components.\n\nUsing\n\n- PageMgr.renderPage\n- PageMgr.renderPage\n\na page can be rendered. As such page implements a render function for creating\nrender output the render function of the page itself will also want to access\nits various properties like the SEO title etc.\n\nApart from rendering to markup a page can also be serialized, i.e. transformed\ninto a json string using\n\n- PageMgr.serializePage\n- PageMgr.serializePage", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "page", + "dw.experience.page", + "dw/experience" + ], + "title": "Page" + }, + { + "description": "Returns the id of this page.", + "id": "script-api:dw/experience/Page#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.ID", + "sections": [ + { + "body": "Returns the id of this page.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "page.id" + ], + "title": "Page.ID" + }, + { + "description": "Get the aspect type of the page. If an aspect type is set for this page (and is found in the deployed code version), then the page is treated as dynamic page during rendering and serialization.", + "id": "script-api:dw/experience/Page#aspectTypeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.aspectTypeID", + "sections": [ + { + "body": "Get the aspect type of the page.\nIf an aspect type is set for this page (and is found in the deployed code version), then the page is treated as dynamic page during\nrendering and serialization.", + "heading": "Description" + } + ], + "signature": "readonly aspectTypeID: string", + "source": "script-api", + "tags": [ + "aspecttypeid", + "page.aspecttypeid" + ], + "title": "Page.aspectTypeID" + }, + { + "description": "Returns the classification dw.content.Folder associated with this page.", + "id": "script-api:dw/experience/Page#classificationFolder", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.classificationFolder", + "sections": [ + { + "body": "Returns the classification dw.content.Folder associated with this page.", + "heading": "Description" + } + ], + "signature": "readonly classificationFolder: Folder | null", + "source": "script-api", + "tags": [ + "classificationfolder", + "page.classificationfolder" + ], + "title": "Page.classificationFolder" + }, + { + "description": "Returns the description of this page.", + "id": "script-api:dw/experience/Page#description", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.description", + "sections": [ + { + "body": "Returns the description of this page.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "page.description" + ], + "title": "Page.description" + }, + { + "description": "Returns all folders to which this page is assigned.", + "id": "script-api:dw/experience/Page#folders", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.folders", + "sections": [ + { + "body": "Returns all folders to which this page is assigned.", + "heading": "Description" + } + ], + "signature": "readonly folders: Collection", + "source": "script-api", + "tags": [ + "folders", + "page.folders" + ], + "title": "Page.folders" + }, + { + "description": "Get the aspect type of the page. If an aspect type is set for this page (and is found in the deployed code version), then the page is treated as dynamic page during rendering and serialization.", + "id": "script-api:dw/experience/Page#getAspectTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getAspectTypeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the aspect type of the page.\nIf an aspect type is set for this page (and is found in the deployed code version), then the page is treated as dynamic page during\nrendering and serialization.", + "heading": "Description" + } + ], + "signature": "getAspectTypeID(): string", + "source": "script-api", + "tags": [ + "getaspecttypeid", + "page.getaspecttypeid" + ], + "title": "Page.getAspectTypeID" + }, + { + "description": "Returns the raw attribute value identified by the specified attribute id. By raw attribute value we denote the unprocessed value as provided for the attribute driven by the type of the respective attribute definition:", + "id": "script-api:dw/experience/Page#getAttribute", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "attributeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getAttribute", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Returns the raw attribute value identified by the specified attribute id.\nBy raw attribute value we denote the unprocessed value as provided for the attribute\ndriven by the type of the respective attribute definition:\n\n- `boolean` -> boolean\n- `category` -> string representing a catalog category ID\n- `custom` -> dw.util.Map that originates from a stringified curly brackets {} JSON object\n- `cms_record` -> dw.util.Map that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `cmsrecord.json` schema\n- `enum` -> either string or integer\n- `file` -> string representing a file path within a library\n- `image` -> dw.util.Map that originates from a stringified curly brackets {} JSON object whose entries must adhere to the `content/schema/image.json` schema\n- `integer` -> integer\n- `markup` -> string representing HTML markup\n- `page` -> string representing a page ID\n- `product` -> string representing a product SKU\n- `string` -> string\n- `text` -> string\n- `url` -> string representing a URL\n\nThere is two places an attribute value can come from - either it was persisted at design time (e.g.\nby the merchant by editing a component in Page Designer) or it was injected in shape of an aspect attribute at rendering time\nthrough the execution of code. The persistent value, if existing, takes precedence over the injected aspect\nattribute one. Injection of a value through an aspect attribute will only occur if the page attribute's\nattribute definition was declared using the `\"dynamic_lookup\"` property and its aspect attribute alias matches\nthe ID of the respective aspect attribute.\n\nAccessing the raw value can be helpful if render and serialization logic of the\npage needs to operate on these unprocessed values. An unprocessed value\nmight be fundamentally different from its processed counterpart, the latter being\nprovided through the content dictionary (see PageScriptContext.getContent)\nwhen the render/serialize function of the page is invoked.", + "heading": "Description" + } + ], + "signature": "getAttribute(attributeID: string): any | null", + "source": "script-api", + "tags": [ + "getattribute", + "page.getattribute" + ], + "title": "Page.getAttribute" + }, + { + "description": "Returns the classification dw.content.Folder associated with this page.", + "id": "script-api:dw/experience/Page#getClassificationFolder", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getClassificationFolder", + "returns": { + "type": "Folder | null" + }, + "sections": [ + { + "body": "Returns the classification dw.content.Folder associated with this page.", + "heading": "Description" + } + ], + "signature": "getClassificationFolder(): Folder | null", + "source": "script-api", + "tags": [ + "getclassificationfolder", + "page.getclassificationfolder" + ], + "title": "Page.getClassificationFolder" + }, + { + "description": "Returns the description of this page.", + "id": "script-api:dw/experience/Page#getDescription", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description of this page.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "page.getdescription" + ], + "title": "Page.getDescription" + }, + { + "description": "Returns all folders to which this page is assigned.", + "id": "script-api:dw/experience/Page#getFolders", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getFolders", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all folders to which this page is assigned.", + "heading": "Description" + } + ], + "signature": "getFolders(): Collection", + "source": "script-api", + "tags": [ + "getfolders", + "page.getfolders" + ], + "title": "Page.getFolders" + }, + { + "description": "Returns the id of this page.", + "id": "script-api:dw/experience/Page#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of this page.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "page.getid" + ], + "title": "Page.getID" + }, + { + "description": "Returns the name of this page.", + "id": "script-api:dw/experience/Page#getName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of this page.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "page.getname" + ], + "title": "Page.getName" + }, + { + "description": "Returns the SEO description of this page.", + "id": "script-api:dw/experience/Page#getPageDescription", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the SEO description of this page.", + "heading": "Description" + } + ], + "signature": "getPageDescription(): string", + "source": "script-api", + "tags": [ + "getpagedescription", + "page.getpagedescription" + ], + "title": "Page.getPageDescription" + }, + { + "description": "Returns the SEO keywords of this page.", + "id": "script-api:dw/experience/Page#getPageKeywords", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageKeywords", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the SEO keywords of this page.", + "heading": "Description" + } + ], + "signature": "getPageKeywords(): string", + "source": "script-api", + "tags": [ + "getpagekeywords", + "page.getpagekeywords" + ], + "title": "Page.getPageKeywords" + }, + { + "description": "Returns the SEO title of this page.", + "id": "script-api:dw/experience/Page#getPageTitle", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getPageTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the SEO title of this page.", + "heading": "Description" + } + ], + "signature": "getPageTitle(): string", + "source": "script-api", + "tags": [ + "getpagetitle", + "page.getpagetitle" + ], + "title": "Page.getPageTitle" + }, + { + "description": "Returns the page region that matches the given id.", + "id": "script-api:dw/experience/Page#getRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getRegion", + "returns": { + "type": "Region | null" + }, + "sections": [ + { + "body": "Returns the page region that matches the given id.", + "heading": "Description" + } + ], + "signature": "getRegion(id: string): Region | null", + "source": "script-api", + "tags": [ + "getregion", + "page.getregion" + ], + "title": "Page.getRegion" + }, + { + "description": "Returns the search words of the page used for the search index.", + "id": "script-api:dw/experience/Page#getSearchWords", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getSearchWords", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the search words of the page used for the search index.", + "heading": "Description" + } + ], + "signature": "getSearchWords(): string", + "source": "script-api", + "tags": [ + "getsearchwords", + "page.getsearchwords" + ], + "title": "Page.getSearchWords" + }, + { + "description": "Returns the type id of this page.", + "id": "script-api:dw/experience/Page#getTypeID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.getTypeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type id of this page.", + "heading": "Description" + } + ], + "signature": "getTypeID(): string", + "source": "script-api", + "tags": [ + "gettypeid", + "page.gettypeid" + ], + "title": "Page.getTypeID" + }, + { + "description": "Returns `true` if the page has visibility rules (scheduling, customer groups, aspect attribute qualifiers, campaign and promotion qualifiers) applied, otherwise `false`. Use this method prior to isVisible, so you do not call the latter in a pagecached context.", + "id": "script-api:dw/experience/Page#hasVisibilityRules", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.hasVisibilityRules", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the page has visibility rules (scheduling, customer groups, aspect attribute qualifiers,\ncampaign and promotion qualifiers) applied, otherwise `false`. Use this\nmethod prior to isVisible, so you do not call the latter in a pagecached context.", + "heading": "Description" + } + ], + "signature": "hasVisibilityRules(): boolean", + "source": "script-api", + "tags": [ + "hasvisibilityrules", + "page.hasvisibilityrules" + ], + "title": "Page.hasVisibilityRules" + }, + { + "description": "Returns `true` if the page is currently visible which is the case if:", + "id": "script-api:dw/experience/Page#isVisible", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.isVisible", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the page is currently visible which is the case if:\n\n- page is published\n- the page is set to visible in the current locale\n- all visibility rules apply, requiring that\n\n- schedule matches\n- customer group matches\n- aspect attribute qualifiers match\n- campaign and promotion qualifiers match\n\nIf any of these is not the case then `false` will be returned.\n

    \nAs visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this\ncall should NOT happen in a pagecached context outside of the processing induced by rendering/serialization (see the corresponding\nmethods in PageMgr).\n\nUse hasVisibilityRules prior to calling this method in order to check for the existence of visibility rules. If there are\nvisibility rules then do not apply pagecaching. Otherwise the visibility decision making would end up in the pagecache and any subsequent\ncall would just return from the pagecache instead of performing the isVisible check again as desired.", + "heading": "Description" + } + ], + "signature": "isVisible(): boolean", + "source": "script-api", + "tags": [ + "isvisible", + "page.isvisible" + ], + "title": "Page.isVisible" + }, + { + "description": "Returns the name of this page.", + "id": "script-api:dw/experience/Page#name", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.name", + "sections": [ + { + "body": "Returns the name of this page.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "page.name" + ], + "title": "Page.name" + }, + { + "description": "Returns the SEO description of this page.", + "id": "script-api:dw/experience/Page#pageDescription", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageDescription", + "sections": [ + { + "body": "Returns the SEO description of this page.", + "heading": "Description" + } + ], + "signature": "readonly pageDescription: string", + "source": "script-api", + "tags": [ + "pagedescription", + "page.pagedescription" + ], + "title": "Page.pageDescription" + }, + { + "description": "Returns the SEO keywords of this page.", + "id": "script-api:dw/experience/Page#pageKeywords", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageKeywords", + "sections": [ + { + "body": "Returns the SEO keywords of this page.", + "heading": "Description" + } + ], + "signature": "readonly pageKeywords: string", + "source": "script-api", + "tags": [ + "pagekeywords", + "page.pagekeywords" + ], + "title": "Page.pageKeywords" + }, + { + "description": "Returns the SEO title of this page.", + "id": "script-api:dw/experience/Page#pageTitle", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.pageTitle", + "sections": [ + { + "body": "Returns the SEO title of this page.", + "heading": "Description" + } + ], + "signature": "readonly pageTitle: string", + "source": "script-api", + "tags": [ + "pagetitle", + "page.pagetitle" + ], + "title": "Page.pageTitle" + }, + { + "description": "Returns the search words of the page used for the search index.", + "id": "script-api:dw/experience/Page#searchWords", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.searchWords", + "sections": [ + { + "body": "Returns the search words of the page used for the search index.", + "heading": "Description" + } + ], + "signature": "readonly searchWords: string", + "source": "script-api", + "tags": [ + "searchwords", + "page.searchwords" + ], + "title": "Page.searchWords" + }, + { + "description": "Returns the type id of this page.", + "id": "script-api:dw/experience/Page#typeID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.typeID", + "sections": [ + { + "body": "Returns the type id of this page.", + "heading": "Description" + } + ], + "signature": "readonly typeID: string", + "source": "script-api", + "tags": [ + "typeid", + "page.typeid" + ], + "title": "Page.typeID" + }, + { + "description": "Returns `true` if the page is currently visible which is the case if:", + "id": "script-api:dw/experience/Page#visible", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Page", + "qualifiedName": "dw.experience.Page.visible", + "sections": [ + { + "body": "Returns `true` if the page is currently visible which is the case if:\n\n- page is published\n- the page is set to visible in the current locale\n- all visibility rules apply, requiring that\n\n- schedule matches\n- customer group matches\n- aspect attribute qualifiers match\n- campaign and promotion qualifiers match\n\nIf any of these is not the case then `false` will be returned.\n

    \nAs visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this\ncall should NOT happen in a pagecached context outside of the processing induced by rendering/serialization (see the corresponding\nmethods in PageMgr).\n\nUse hasVisibilityRules prior to calling this method in order to check for the existence of visibility rules. If there are\nvisibility rules then do not apply pagecaching. Otherwise the visibility decision making would end up in the pagecache and any subsequent\ncall would just return from the pagecache instead of performing the isVisible check again as desired.", + "heading": "Description" + } + ], + "signature": "readonly visible: boolean", + "source": "script-api", + "tags": [ + "visible", + "page.visible" + ], + "title": "Page.visible" + }, + { + "description": "Provides functionality for getting, rendering and serializing page designer managed pages.", + "id": "script-api:dw/experience/PageMgr", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.PageMgr", + "sections": [ + { + "body": "Provides functionality for getting, rendering and serializing page designer managed pages.\n\nThe basic flow is to determine a page by either id, category or product\n\n- getPage\n- getPageByCategory\n- getPageByProduct\n\nand then to initiate rendering of this page via\n\n- renderPage\n- renderPage\n\nThis will trigger page rendering from a top level perspective, i.e. the page serves as entry point and root container of components.\n\nAs a related page or component template will likely want to trigger rendering of nested components\nwithin its regions it can do this by first fetching the desired region by ID via\nPage.getRegion or Component.getRegion and then call to PageMgr.renderRegion\nwith the recently retrieved region (and optionally provide RegionRenderSettings for customized\nrendering of region and component wrapper elements).\n\nSimilar to the rendering you can also serialize such page to json via\n\n- serializePage\n- serializePage\n\nThis will trigger page serialization from a top level perspective, i.e. the page serves as entry point and root container of components,\nwhich will automatically traverse all visible components and attach their serialization result to the emitted json.\n\nVarious attributes required for rendering and serialization in the corresponding template can be accessed with the\naccordant methods of Page and Component.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pagemgr", + "dw.experience.pagemgr", + "dw/experience" + ], + "title": "PageMgr" + }, + { + "description": "Initialize the custom editor of given type id using the passed configuration. The initialization will trigger the `init` function of the respective custom editor type for which the passed custom editor object is being preinitialized with the given configuration (similar to what would happen through the `editor_definition` reference by any component type attribute definition).", + "id": "script-api:dw/experience/PageMgr#getCustomEditor", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "customEditorTypeID", + "type": "string" + }, + { + "name": "configuration", + "type": "utilMap" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getCustomEditor", + "returns": { + "type": "CustomEditor" + }, + "sections": [ + { + "body": "Initialize the custom editor of given type id using the passed configuration. The initialization\nwill trigger the `init` function of the respective custom editor type for which the passed\ncustom editor object is being preinitialized with the given configuration (similar to what would\nhappen through the `editor_definition` reference by any component type attribute definition).\n\nThis method is useful to obtain any custom editor instance you want to reuse within the `init`\nmethod of another custom editor, e.g. as dependent breakout element.", + "heading": "Description" + } + ], + "signature": "static getCustomEditor(customEditorTypeID: string, configuration: utilMap): CustomEditor", + "source": "script-api", + "tags": [ + "getcustomeditor", + "pagemgr.getcustomeditor" + ], + "title": "PageMgr.getCustomEditor" + }, + { + "description": "Initialize the custom editor of given type id using the passed configuration. The initialization will trigger the `init` function of the respective custom editor type for which the passed custom editor object is being preinitialized with the given configuration (similar to what would happen through the `editor_definition` reference by any component type attribute definition).", + "id": "script-api:dw/experience/PageMgr#getCustomEditor", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "customEditorTypeID", + "type": "string" + }, + { + "name": "configuration", + "type": "utilMap" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getCustomEditor", + "returns": { + "type": "CustomEditor" + }, + "sections": [ + { + "body": "Initialize the custom editor of given type id using the passed configuration. The initialization\nwill trigger the `init` function of the respective custom editor type for which the passed\ncustom editor object is being preinitialized with the given configuration (similar to what would\nhappen through the `editor_definition` reference by any component type attribute definition).\n\nThis method is useful to obtain any custom editor instance you want to reuse within the `init`\nmethod of another custom editor, e.g. as dependent breakout element.", + "heading": "Description" + } + ], + "signature": "static getCustomEditor(customEditorTypeID: string, configuration: utilMap): CustomEditor", + "source": "script-api", + "tags": [ + "getcustomeditor", + "pagemgr.getcustomeditor" + ], + "title": "PageMgr.getCustomEditor" + }, + { + "description": "Returns the page identified by the specified id.", + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Returns the page identified by the specified id.", + "heading": "Description" + } + ], + "signature": "static getPage(pageID: string): Page | null", + "source": "script-api", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "deprecated": { + "message": "Please use getPageByCategory instead." + }, + "description": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "category", + "type": "Category" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "heading": "Description" + } + ], + "signature": "static getPage(category: Category, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "description": "Returns the page identified by the specified id.", + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Returns the page identified by the specified id.", + "heading": "Description" + } + ], + "signature": "static getPage(pageID: string): Page | null", + "source": "script-api", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "deprecated": { + "message": "Please use getPageByCategory instead." + }, + "description": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "category", + "type": "Category" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPage", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "heading": "Description" + } + ], + "signature": "static getPage(category: Category, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpage", + "pagemgr.getpage" + ], + "title": "PageMgr.getPage" + }, + { + "description": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPageByCategory", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "category", + "type": "Category" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByCategory", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "heading": "Description" + } + ], + "signature": "static getPageByCategory(category: Category, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpagebycategory", + "pagemgr.getpagebycategory" + ], + "title": "PageMgr.getPageByCategory" + }, + { + "description": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPageByCategory", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "category", + "type": "Category" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByCategory", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given category (including bottom up traversal of the category tree) and aspect type.", + "heading": "Description" + } + ], + "signature": "static getPageByCategory(category: Category, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpagebycategory", + "pagemgr.getpagebycategory" + ], + "title": "PageMgr.getPageByCategory" + }, + { + "description": "Get the dynamic page for the given product and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPageByProduct", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByProduct", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given product and aspect type.\n\nNo bottom up traversal of the product's category tree is performed. If you require this then a\nseparate call to getPageByCategory (with the category of your choice, e.g. the default\ncategory of the product) needs to be made.", + "heading": "Description" + } + ], + "signature": "static getPageByProduct(product: Product, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpagebyproduct", + "pagemgr.getpagebyproduct" + ], + "title": "PageMgr.getPageByProduct" + }, + { + "description": "Get the dynamic page for the given product and aspect type.", + "id": "script-api:dw/experience/PageMgr#getPageByProduct", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "pageMustBeVisible", + "type": "boolean" + }, + { + "name": "aspectTypeID", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.getPageByProduct", + "returns": { + "type": "Page | null" + }, + "sections": [ + { + "body": "Get the dynamic page for the given product and aspect type.\n\nNo bottom up traversal of the product's category tree is performed. If you require this then a\nseparate call to getPageByCategory (with the category of your choice, e.g. the default\ncategory of the product) needs to be made.", + "heading": "Description" + } + ], + "signature": "static getPageByProduct(product: Product, pageMustBeVisible: boolean, aspectTypeID: string): Page | null", + "source": "script-api", + "tags": [ + "getpagebyproduct", + "pagemgr.getpagebyproduct" + ], + "title": "PageMgr.getPageByProduct" + }, + { + "description": "Render a page. All of this is going to happen in two layers of remote includes, therefore pagecaching of page rendering is separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.", + "examples": [ + "`String : render( PageScriptContext context)`" + ], + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Render a page. All of this is going to happen in two layers of remote includes, therefore pagecaching of page rendering\nis separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.\n\n- layer 1 - determines visibility fingerprint for the page and all its nested components driven by its visibility rules. This remote include will only be pagecached for a fixed duration if neither the page nor any of its\nnested components carries a visibility rule (configurable in Business Manager via the site's page caching settings). It will then delegate to layer 2.\n- layer 2 - does the actual rendering of the page by invoking its render function. This remote include will factor the previously determined visibility fingerprint in to the pagecache key, in case you decide to use pagecaching.\n\nThe layer 1 remote include is what is returned when calling this method.\n\nThe provided `parameters` argument is passed through till the layer 2 remote include which does the actual rendering so that it will be available\nfor the `render` function of the invoked page as part of PageScriptContext.getRuntimeParameters. You probably want to\nprovide caller parameters from the outside in shape of a json String to the inside of the page rendering, e.g. to loop through query parameters.\n\nThe layer 2 remote include performs the rendering of the page and all its nested components within one request. Thus data sharing between\nthe page and its nested components can happen in scope of this request.\n\nThe rendering of a page invokes the `render` function of the respective page type.\n\n\nThe return value of the `render` function finally represents the markup produced by this page type.\n\nNested page rendering, i.e. rendering a page within a page (or respectively its components), is not a supported use case.\n\nDue to the nature of the remote includes mentioned above this comes with the url length restriction as you already know it from\nremote includes you implement by hand within your templates. Thus the size of the `parameters` parameter of this\nmethod has a length limitation accordingly because it just translates into a url parameter of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static renderPage(pageID: string, parameters: string): string", + "source": "script-api", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "description": "Render a page. This is an extension of renderPage for the purpose of rendering a page that needs to determine pieces of its content at rendering time instead of design time only. Therefore it is possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the eligible aspect attribute definitions which the passed in aspect attributes will be validated against. If the validation fails for any of the following reasons an AspectAttributeValidationException will be thrown:", + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "aspectAttributes", + "type": "utilMap" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Render a page. This is an extension of renderPage for the purpose of rendering a\npage that needs to determine pieces of its content at rendering time instead of design time only. Therefore it\nis possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the\neligible aspect attribute definitions which the passed in aspect attributes will be validated against.\nIf the validation fails for any of the following reasons an AspectAttributeValidationException\nwill be thrown:\n\n- any aspect attribute value violates the value domain of the corresponding attribute definition\n- any required aspect attribute value is `null`\n\nAspect attributes without corresponding attribute definition will be omitted. Once they made it into the rendering\nthey will apply if no persistent attribute value exists (taking precedence over default attribute values\nas coming from the attribute definition json) and the attribute has the `dynamic_lookup`\nproperty defined which contains the aspect attribute alias. The aspect attribute value lookup then happens by taking\nthis aspect attribute alias and using it as attribute identifier within the given map of aspect attributes.\n\nDue to the nature of using remote includes, also see renderPage, this comes with the url length\nrestriction as you already know it from remote includes you implement by hand within your templates. Thus the size of both the\n`aspectAttributes` (keys and values) as well as the `parameters` parameter of this method\nare subject to a length limitation accordingly because they just translate into url parameters of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static renderPage(pageID: string, aspectAttributes: utilMap, parameters: string): string", + "source": "script-api", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "throws": [ + { + "description": "if any given aspect attribute value does fulfill its respective attribute definition", + "type": "dw.experience.AspectAttributeValidationException" + } + ], + "title": "PageMgr.renderPage" + }, + { + "description": "Render a page. All of this is going to happen in two layers of remote includes, therefore pagecaching of page rendering is separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.", + "examples": [ + "`String : render( PageScriptContext context)`" + ], + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Render a page. All of this is going to happen in two layers of remote includes, therefore pagecaching of page rendering\nis separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.\n\n- layer 1 - determines visibility fingerprint for the page and all its nested components driven by its visibility rules. This remote include will only be pagecached for a fixed duration if neither the page nor any of its\nnested components carries a visibility rule (configurable in Business Manager via the site's page caching settings). It will then delegate to layer 2.\n- layer 2 - does the actual rendering of the page by invoking its render function. This remote include will factor the previously determined visibility fingerprint in to the pagecache key, in case you decide to use pagecaching.\n\nThe layer 1 remote include is what is returned when calling this method.\n\nThe provided `parameters` argument is passed through till the layer 2 remote include which does the actual rendering so that it will be available\nfor the `render` function of the invoked page as part of PageScriptContext.getRuntimeParameters. You probably want to\nprovide caller parameters from the outside in shape of a json String to the inside of the page rendering, e.g. to loop through query parameters.\n\nThe layer 2 remote include performs the rendering of the page and all its nested components within one request. Thus data sharing between\nthe page and its nested components can happen in scope of this request.\n\nThe rendering of a page invokes the `render` function of the respective page type.\n\n\nThe return value of the `render` function finally represents the markup produced by this page type.\n\nNested page rendering, i.e. rendering a page within a page (or respectively its components), is not a supported use case.\n\nDue to the nature of the remote includes mentioned above this comes with the url length restriction as you already know it from\nremote includes you implement by hand within your templates. Thus the size of the `parameters` parameter of this\nmethod has a length limitation accordingly because it just translates into a url parameter of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static renderPage(pageID: string, parameters: string): string", + "source": "script-api", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "title": "PageMgr.renderPage" + }, + { + "description": "Render a page. This is an extension of renderPage for the purpose of rendering a page that needs to determine pieces of its content at rendering time instead of design time only. Therefore it is possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the eligible aspect attribute definitions which the passed in aspect attributes will be validated against. If the validation fails for any of the following reasons an AspectAttributeValidationException will be thrown:", + "id": "script-api:dw/experience/PageMgr#renderPage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "aspectAttributes", + "type": "utilMap" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderPage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Render a page. This is an extension of renderPage for the purpose of rendering a\npage that needs to determine pieces of its content at rendering time instead of design time only. Therefore it\nis possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the\neligible aspect attribute definitions which the passed in aspect attributes will be validated against.\nIf the validation fails for any of the following reasons an AspectAttributeValidationException\nwill be thrown:\n\n- any aspect attribute value violates the value domain of the corresponding attribute definition\n- any required aspect attribute value is `null`\n\nAspect attributes without corresponding attribute definition will be omitted. Once they made it into the rendering\nthey will apply if no persistent attribute value exists (taking precedence over default attribute values\nas coming from the attribute definition json) and the attribute has the `dynamic_lookup`\nproperty defined which contains the aspect attribute alias. The aspect attribute value lookup then happens by taking\nthis aspect attribute alias and using it as attribute identifier within the given map of aspect attributes.\n\nDue to the nature of using remote includes, also see renderPage, this comes with the url length\nrestriction as you already know it from remote includes you implement by hand within your templates. Thus the size of both the\n`aspectAttributes` (keys and values) as well as the `parameters` parameter of this method\nare subject to a length limitation accordingly because they just translate into url parameters of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static renderPage(pageID: string, aspectAttributes: utilMap, parameters: string): string", + "source": "script-api", + "tags": [ + "renderpage", + "pagemgr.renderpage" + ], + "throws": [ + { + "description": "if any given aspect attribute value does fulfill its respective attribute definition", + "type": "dw.experience.AspectAttributeValidationException" + } + ], + "title": "PageMgr.renderPage" + }, + { + "description": "Renders a region by triggering rendering of all visible components within this region. For each of these components the render function of the respective component type is invoked.", + "examples": [ + "String : render( ComponentScriptContext context)", + "

    \n\n...\n\n\n...\n\n

    " + ], + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "region", + "type": "Region" + }, + { + "name": "regionRenderSettings", + "type": "RegionRenderSettings" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Renders a region by triggering rendering of all visible components within\nthis region. For each of these components the render function of the respective component\ntype is invoked.\n\n\nThe return value of the `render` function will be wrapped by an HTML element - this\nfinally represents the markup produced by this component type. The markup of the region\naccordingly represents the concatenation of all the components markup within an\nown wrapper element.\n\nIn order to provide styling for these wrapper\nelements of the components and the region some render settings can optionally be provided,\nwhich basically allows to configure which kind of tag is used for the wrapper element and\nwhich attributes the wrapper element contains. A sample output could look like this if\nRegionRenderSettings are applied with customized tag names and attributes\nfor the region and component wrapper elements.\n\n\nIn order to go with the default settings for the wrapper elements see\nPageMgr.renderRegion.\n\n

    \nYou must NOT call this method outside of the processing induced by PageMgr.renderPage.", + "heading": "Description" + } + ], + "signature": "static renderRegion(region: Region, regionRenderSettings: RegionRenderSettings): string", + "source": "script-api", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "description": "Renders a region by triggering rendering of all visible components within this region. For each of these components the render function of the respective component type is invoked.", + "examples": [ + "String : render( ComponentScriptContext params)", + "

    \n
    \n...\n
    \n
    \n..\n
    \n
    " + ], + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "region", + "type": "Region" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Renders a region by triggering rendering of all visible components within\nthis region. For each of these components the render function of the respective component\ntype is invoked.\n\n\nThe return value of the `render` function will be wrapped by an HTML element - this\nfinally represents the markup produced by this component type. The markup of the region\naccordingly represents the concatenation of all the components markup within an\nown wrapper element.\n\nThe following sample shows how this would look like for a 'pictures' region\nthat contains two components of type 'assets.image'.\n\n\nThe system default for region render settings are:\n\n- tag_name : div\n- attributes : {\"class\":\"experience-region experience-[REGION_ID]\"}\n\nThe system default for component render settings are:\n\n- tag name : div\n- attributes : {\"class\":\"experience-component experience-[COMPONENT_TYPE_ID]\"}\n\nAs the [COMPONENT_TYPE_ID] can contain dots due to its package like naming scheme (e.g. assets.image)\nany occurrences of these dots will be replaced by dashes (e.g. assets-image) so that CSS selectors\ndo not have to be escaped.\n\nIn order to provide your own settings for the wrapper elements see\nPageMgr.renderRegion.\n\n

    \nYou must NOT call this method outside of the processing induced by PageMgr.renderPage.", + "heading": "Description" + } + ], + "signature": "static renderRegion(region: Region): string", + "source": "script-api", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "description": "Renders a region by triggering rendering of all visible components within this region. For each of these components the render function of the respective component type is invoked.", + "examples": [ + "String : render( ComponentScriptContext context)", + "

    \n\n...\n\n\n...\n\n

    " + ], + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "region", + "type": "Region" + }, + { + "name": "regionRenderSettings", + "type": "RegionRenderSettings" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Renders a region by triggering rendering of all visible components within\nthis region. For each of these components the render function of the respective component\ntype is invoked.\n\n\nThe return value of the `render` function will be wrapped by an HTML element - this\nfinally represents the markup produced by this component type. The markup of the region\naccordingly represents the concatenation of all the components markup within an\nown wrapper element.\n\nIn order to provide styling for these wrapper\nelements of the components and the region some render settings can optionally be provided,\nwhich basically allows to configure which kind of tag is used for the wrapper element and\nwhich attributes the wrapper element contains. A sample output could look like this if\nRegionRenderSettings are applied with customized tag names and attributes\nfor the region and component wrapper elements.\n\n\nIn order to go with the default settings for the wrapper elements see\nPageMgr.renderRegion.\n\n

    \nYou must NOT call this method outside of the processing induced by PageMgr.renderPage.", + "heading": "Description" + } + ], + "signature": "static renderRegion(region: Region, regionRenderSettings: RegionRenderSettings): string", + "source": "script-api", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "description": "Renders a region by triggering rendering of all visible components within this region. For each of these components the render function of the respective component type is invoked.", + "examples": [ + "String : render( ComponentScriptContext params)", + "

    \n
    \n...\n
    \n
    \n..\n
    \n
    " + ], + "id": "script-api:dw/experience/PageMgr#renderRegion", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "region", + "type": "Region" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.renderRegion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Renders a region by triggering rendering of all visible components within\nthis region. For each of these components the render function of the respective component\ntype is invoked.\n\n\nThe return value of the `render` function will be wrapped by an HTML element - this\nfinally represents the markup produced by this component type. The markup of the region\naccordingly represents the concatenation of all the components markup within an\nown wrapper element.\n\nThe following sample shows how this would look like for a 'pictures' region\nthat contains two components of type 'assets.image'.\n\n\nThe system default for region render settings are:\n\n- tag_name : div\n- attributes : {\"class\":\"experience-region experience-[REGION_ID]\"}\n\nThe system default for component render settings are:\n\n- tag name : div\n- attributes : {\"class\":\"experience-component experience-[COMPONENT_TYPE_ID]\"}\n\nAs the [COMPONENT_TYPE_ID] can contain dots due to its package like naming scheme (e.g. assets.image)\nany occurrences of these dots will be replaced by dashes (e.g. assets-image) so that CSS selectors\ndo not have to be escaped.\n\nIn order to provide your own settings for the wrapper elements see\nPageMgr.renderRegion.\n\n

    \nYou must NOT call this method outside of the processing induced by PageMgr.renderPage.", + "heading": "Description" + } + ], + "signature": "static renderRegion(region: Region): string", + "source": "script-api", + "tags": [ + "renderregion", + "pagemgr.renderregion" + ], + "title": "PageMgr.renderRegion" + }, + { + "description": "Serialize a page as json string with the following properties:", + "examples": [ + "`Object : serialize( PageScriptContext context)`" + ], + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Serialize a page as json string with the following properties:\n\n- `String id` - the id of the page\n- `String type_id` - the id of the page type\n- `Map data` - the content attribute key value pairs\n- `Map custom` - the custom key value pairs as produced by the optional page type `serialize` function\n- `List regions` - the regions of this page. A region consists of the following properties\n\n- `String id` - the id of the region\n- `List components` - the components of this region. A component consists of the following properties\n\n- `String id` - the id of the component\n- `String type_id` - the id of the component type\n- `Map data` - the content attribute key value pairs\n- `Map custom` - the custom key value pairs as produced by the optional component type `serialize` function\n- `List regions` - the regions of this component\n\nAll of this is going to happen in two layers of remote includes, therefore pagecaching of page serialization\nis separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.\n\n- layer 1 - determines visibility fingerprint for the page and all its nested components driven by its visibility rules. This remote include will only be pagecached for a fixed duration if neither the page nor any of its\nnested components carries a visibility rule (configurable in Business Manager via the site's page caching settings). It will then delegate to layer 2.\n- layer 2 - does the actual rendering of the page by invoking its render function. This remote include will factor the previously determined visibility fingerprint in to the pagecache key, in case you decide to use pagecaching.\n\nThe layer 1 remote include is what is returned when calling this method.\n\nThe provided `parameters` argument is passed through till the layer 2 remote include which does the actual serialization so that it will be available\nfor the `serialize` function of the invoked page as part of PageScriptContext.getRuntimeParameters. You probably want to\nprovide caller parameters from the outside in shape of a json String to the inside of the page serialization, e.g. to loop through query parameters.\n\nThe layer 2 remote include performs the serialization of the page and all its nested components within one request. Thus data sharing between\nthe page and its nested components can happen in scope of this request.\n\nThe serialization of a page also invokes the `serialize` function of the respective page type.\n\n\nThe return value of the `serialize` function will be injected as property `custom`\ninto the json string produced as serialization result for this page type.\n\nNested page serialization, i.e. serializing a page within a page (or respectively its components), is not a supported use case.\n\nDue to the nature of the remote includes mentioned above this comes with the url length restriction as you already know it from\nremote includes you implement by hand within your templates. Thus the size of the `parameters` parameter of this\nmethod has a length limitation accordingly because it just translates into a url parameter of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static serializePage(pageID: string, parameters: string): string", + "source": "script-api", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "description": "Serialize a page as json string. This is an extension of serializePage for the purpose of serializing a page that needs to determine pieces of its content at serialization time instead of design time only. Therefore it is possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the eligible aspect attribute definitions which the passed in aspect attributes will be validated against. If the validation fails for any of the following reasons an AspectAttributeValidationException will be thrown:", + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "aspectAttributes", + "type": "utilMap" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Serialize a page as json string. This is an extension of serializePage for the purpose of serializing a\npage that needs to determine pieces of its content at serialization time instead of design time only. Therefore it\nis possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the\neligible aspect attribute definitions which the passed in aspect attributes will be validated against.\nIf the validation fails for any of the following reasons an AspectAttributeValidationException\nwill be thrown:\n\n- any aspect attribute value violates the value domain of the corresponding attribute definition\n- any required aspect attribute value is `null`\n\nAspect attributes without corresponding attribute definition will be omitted. Once they made it into the serialization\nthey will apply if no persistent attribute value exists (taking precedence over default attribute values\nas coming from the attribute definition json) and the attribute has the `dynamic_lookup`\nproperty defined which contains the aspect attribute alias. The aspect attribute value lookup then happens by taking\nthis aspect attribute alias and using it as attribute identifier within the given map of aspect attributes.\n\nDue to the nature of using remote includes, also see serializePage, this comes with the url length\nrestriction as you already know it from remote includes you implement by hand within your templates. Thus the size of both the\n`aspectAttributes` (keys and values) as well as the `parameters` parameter of this method\nare subject to a length limitation accordingly because they just translate into url parameters of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static serializePage(pageID: string, aspectAttributes: utilMap, parameters: string): string", + "source": "script-api", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "throws": [ + { + "description": "if any given aspect attribute value doesn't fulfill its respective attribute definition", + "type": "dw.experience.AspectAttributeValidationException" + } + ], + "title": "PageMgr.serializePage" + }, + { + "description": "Serialize a page as json string with the following properties:", + "examples": [ + "`Object : serialize( PageScriptContext context)`" + ], + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Serialize a page as json string with the following properties:\n\n- `String id` - the id of the page\n- `String type_id` - the id of the page type\n- `Map data` - the content attribute key value pairs\n- `Map custom` - the custom key value pairs as produced by the optional page type `serialize` function\n- `List regions` - the regions of this page. A region consists of the following properties\n\n- `String id` - the id of the region\n- `List components` - the components of this region. A component consists of the following properties\n\n- `String id` - the id of the component\n- `String type_id` - the id of the component type\n- `Map data` - the content attribute key value pairs\n- `Map custom` - the custom key value pairs as produced by the optional component type `serialize` function\n- `List regions` - the regions of this component\n\nAll of this is going to happen in two layers of remote includes, therefore pagecaching of page serialization\nis separated from the pagecache lifecycle of the caller. The first one is going to be returned by this method.\n\n- layer 1 - determines visibility fingerprint for the page and all its nested components driven by its visibility rules. This remote include will only be pagecached for a fixed duration if neither the page nor any of its\nnested components carries a visibility rule (configurable in Business Manager via the site's page caching settings). It will then delegate to layer 2.\n- layer 2 - does the actual rendering of the page by invoking its render function. This remote include will factor the previously determined visibility fingerprint in to the pagecache key, in case you decide to use pagecaching.\n\nThe layer 1 remote include is what is returned when calling this method.\n\nThe provided `parameters` argument is passed through till the layer 2 remote include which does the actual serialization so that it will be available\nfor the `serialize` function of the invoked page as part of PageScriptContext.getRuntimeParameters. You probably want to\nprovide caller parameters from the outside in shape of a json String to the inside of the page serialization, e.g. to loop through query parameters.\n\nThe layer 2 remote include performs the serialization of the page and all its nested components within one request. Thus data sharing between\nthe page and its nested components can happen in scope of this request.\n\nThe serialization of a page also invokes the `serialize` function of the respective page type.\n\n\nThe return value of the `serialize` function will be injected as property `custom`\ninto the json string produced as serialization result for this page type.\n\nNested page serialization, i.e. serializing a page within a page (or respectively its components), is not a supported use case.\n\nDue to the nature of the remote includes mentioned above this comes with the url length restriction as you already know it from\nremote includes you implement by hand within your templates. Thus the size of the `parameters` parameter of this\nmethod has a length limitation accordingly because it just translates into a url parameter of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static serializePage(pageID: string, parameters: string): string", + "source": "script-api", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "title": "PageMgr.serializePage" + }, + { + "description": "Serialize a page as json string. This is an extension of serializePage for the purpose of serializing a page that needs to determine pieces of its content at serialization time instead of design time only. Therefore it is possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the eligible aspect attribute definitions which the passed in aspect attributes will be validated against. If the validation fails for any of the following reasons an AspectAttributeValidationException will be thrown:", + "id": "script-api:dw/experience/PageMgr#serializePage", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "pageID", + "type": "string" + }, + { + "name": "aspectAttributes", + "type": "utilMap" + }, + { + "name": "parameters", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/PageMgr", + "qualifiedName": "dw.experience.PageMgr.serializePage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Serialize a page as json string. This is an extension of serializePage for the purpose of serializing a\npage that needs to determine pieces of its content at serialization time instead of design time only. Therefore it\nis possible to pass aspect attributes in case the given page is subject to an aspect type. The latter specifies the\neligible aspect attribute definitions which the passed in aspect attributes will be validated against.\nIf the validation fails for any of the following reasons an AspectAttributeValidationException\nwill be thrown:\n\n- any aspect attribute value violates the value domain of the corresponding attribute definition\n- any required aspect attribute value is `null`\n\nAspect attributes without corresponding attribute definition will be omitted. Once they made it into the serialization\nthey will apply if no persistent attribute value exists (taking precedence over default attribute values\nas coming from the attribute definition json) and the attribute has the `dynamic_lookup`\nproperty defined which contains the aspect attribute alias. The aspect attribute value lookup then happens by taking\nthis aspect attribute alias and using it as attribute identifier within the given map of aspect attributes.\n\nDue to the nature of using remote includes, also see serializePage, this comes with the url length\nrestriction as you already know it from remote includes you implement by hand within your templates. Thus the size of both the\n`aspectAttributes` (keys and values) as well as the `parameters` parameter of this method\nare subject to a length limitation accordingly because they just translate into url parameters of the aforementioned remote includes.\nAs a best practice refrain from passing complex objects (e.g. full blown product models) but keep it rather slim (e.g. only product IDs).", + "heading": "Description" + } + ], + "signature": "static serializePage(pageID: string, aspectAttributes: utilMap, parameters: string): string", + "source": "script-api", + "tags": [ + "serializepage", + "pagemgr.serializepage" + ], + "throws": [ + { + "description": "if any given aspect attribute value doesn't fulfill its respective attribute definition", + "type": "dw.experience.AspectAttributeValidationException" + } + ], + "title": "PageMgr.serializePage" + }, + { + "description": "This is the context that is handed over to the `render` and `serialize` function of the respective page type script.", + "id": "script-api:dw/experience/PageScriptContext", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.PageScriptContext", + "sections": [ + { + "body": "This is the context that is handed over to the `render` and `serialize` function of the respective page type\nscript.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pagescriptcontext", + "dw.experience.pagescriptcontext", + "dw/experience" + ], + "title": "PageScriptContext" + }, + { + "description": "Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute) of this page's attributes which you can use in your respective page type `render` and `serialize` function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.", + "id": "script-api:dw/experience/PageScriptContext#content", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.content", + "sections": [ + { + "body": "Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute)\nof this page's attributes which you can use in your respective page type `render` and `serialize` function\nimplementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion\nand conversion, in this order.\n\n- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in\nmarkup text are resolved to real URLs\n- conversion - the raw value (see Page.getAttribute) is resolved into an actual\nDWScript object depending on the type of the attribute as specified in its respective attribute definition\n\n- `boolean` -> boolean\n- `category` -> dw.catalog.Category\n- `custom` -> dw.util.Map\n- `cms_record` -> dw.experience.cms.CMSRecord\n- `enum` -> either string or integer\n- `file` -> dw.content.MediaFile\n- `image` -> dw.experience.image.Image\n- `integer` -> integer\n- `markup` -> string\n- `page` -> string\n- `product` -> dw.catalog.Product\n- `string` -> string\n- `text` -> string\n- `url` -> string", + "heading": "Description" + } + ], + "signature": "readonly content: utilMap", + "source": "script-api", + "tags": [ + "content", + "pagescriptcontext.content" + ], + "title": "PageScriptContext.content" + }, + { + "description": "Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute) of this page's attributes which you can use in your respective page type `render` and `serialize` function implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion and conversion, in this order.", + "id": "script-api:dw/experience/PageScriptContext#getContent", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getContent", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute)\nof this page's attributes which you can use in your respective page type `render` and `serialize` function\nimplementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion\nand conversion, in this order.\n\n- expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in\nmarkup text are resolved to real URLs\n- conversion - the raw value (see Page.getAttribute) is resolved into an actual\nDWScript object depending on the type of the attribute as specified in its respective attribute definition\n\n- `boolean` -> boolean\n- `category` -> dw.catalog.Category\n- `custom` -> dw.util.Map\n- `cms_record` -> dw.experience.cms.CMSRecord\n- `enum` -> either string or integer\n- `file` -> dw.content.MediaFile\n- `image` -> dw.experience.image.Image\n- `integer` -> integer\n- `markup` -> string\n- `page` -> string\n- `product` -> dw.catalog.Product\n- `string` -> string\n- `text` -> string\n- `url` -> string", + "heading": "Description" + } + ], + "signature": "getContent(): utilMap", + "source": "script-api", + "tags": [ + "getcontent", + "pagescriptcontext.getcontent" + ], + "title": "PageScriptContext.getContent" + }, + { + "description": "Returns the page for which the corresponding page type script is currently executed.", + "id": "script-api:dw/experience/PageScriptContext#getPage", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getPage", + "returns": { + "type": "Page" + }, + "sections": [ + { + "body": "Returns the page for which the corresponding page type script is currently executed.", + "heading": "Description" + } + ], + "signature": "getPage(): Page", + "source": "script-api", + "tags": [ + "getpage", + "pagescriptcontext.getpage" + ], + "title": "PageScriptContext.getPage" + }, + { + "deprecated": { + "message": "Please use getRuntimeParameters instead." + }, + "description": "Returns the `parameters` argument as passed when kicking off page rendering via", + "id": "script-api:dw/experience/PageScriptContext#getRenderParameters", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getRenderParameters", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the `parameters` argument as passed when kicking off page rendering via\n\n- PageMgr.renderPage\n- PageMgr.renderPage\n\nand serialization\n\n- PageMgr.serializePage\n- PageMgr.serializePage", + "heading": "Description" + } + ], + "signature": "getRenderParameters(): string", + "source": "script-api", + "tags": [ + "getrenderparameters", + "pagescriptcontext.getrenderparameters" + ], + "title": "PageScriptContext.getRenderParameters" + }, + { + "description": "Returns the `parameters` argument as passed when kicking off page rendering via", + "id": "script-api:dw/experience/PageScriptContext#getRuntimeParameters", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.getRuntimeParameters", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the `parameters` argument as passed when kicking off page rendering via\n\n- PageMgr.renderPage\n- PageMgr.renderPage\n\nand page serialization via\n\n- PageMgr.serializePage\n- PageMgr.serializePage", + "heading": "Description" + } + ], + "signature": "getRuntimeParameters(): string", + "source": "script-api", + "tags": [ + "getruntimeparameters", + "pagescriptcontext.getruntimeparameters" + ], + "title": "PageScriptContext.getRuntimeParameters" + }, + { + "description": "Returns the page for which the corresponding page type script is currently executed.", + "id": "script-api:dw/experience/PageScriptContext#page", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.page", + "sections": [ + { + "body": "Returns the page for which the corresponding page type script is currently executed.", + "heading": "Description" + } + ], + "signature": "readonly page: Page", + "source": "script-api", + "tags": [ + "page", + "pagescriptcontext.page" + ], + "title": "PageScriptContext.page" + }, + { + "deprecated": { + "message": "Please use getRuntimeParameters instead." + }, + "description": "Returns the `parameters` argument as passed when kicking off page rendering via", + "id": "script-api:dw/experience/PageScriptContext#renderParameters", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.renderParameters", + "sections": [ + { + "body": "Returns the `parameters` argument as passed when kicking off page rendering via\n\n- PageMgr.renderPage\n- PageMgr.renderPage\n\nand serialization\n\n- PageMgr.serializePage\n- PageMgr.serializePage", + "heading": "Description" + } + ], + "signature": "readonly renderParameters: string", + "source": "script-api", + "tags": [ + "renderparameters", + "pagescriptcontext.renderparameters" + ], + "title": "PageScriptContext.renderParameters" + }, + { + "description": "Returns the `parameters` argument as passed when kicking off page rendering via", + "id": "script-api:dw/experience/PageScriptContext#runtimeParameters", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/PageScriptContext", + "qualifiedName": "dw.experience.PageScriptContext.runtimeParameters", + "sections": [ + { + "body": "Returns the `parameters` argument as passed when kicking off page rendering via\n\n- PageMgr.renderPage\n- PageMgr.renderPage\n\nand page serialization via\n\n- PageMgr.serializePage\n- PageMgr.serializePage", + "heading": "Description" + } + ], + "signature": "readonly runtimeParameters: string", + "source": "script-api", + "tags": [ + "runtimeparameters", + "pagescriptcontext.runtimeparameters" + ], + "title": "PageScriptContext.runtimeParameters" + }, + { + "description": "This class represents a region which serves as container of components. Using the PageMgr.renderRegion or PageMgr.renderRegion a region can be rendered.", + "id": "script-api:dw/experience/Region", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.Region", + "sections": [ + { + "body": "This class represents a region which serves as container of components.\nUsing the PageMgr.renderRegion or PageMgr.renderRegion\na region can be rendered.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "region", + "dw.experience.region", + "dw/experience" + ], + "title": "Region" + }, + { + "description": "Returns the id of this region.", + "id": "script-api:dw/experience/Region#ID", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.ID", + "sections": [ + { + "body": "Returns the id of this region.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "region.id" + ], + "title": "Region.ID" + }, + { + "description": "Returns the id of this region.", + "id": "script-api:dw/experience/Region#getID", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of this region.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "region.getid" + ], + "title": "Region.getID" + }, + { + "description": "Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion or PageMgr.renderRegion.

    Due to its time and customer group depending nature this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "id": "script-api:dw/experience/Region#getSize", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getSize", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of components that would be rendered by this region\nwhen calling PageMgr.renderRegion or PageMgr.renderRegion.\n

    \nDue to its time and customer group depending nature this call should NOT happen in a pagecached context\noutside of the processing induced by the above mentioned render methods.", + "heading": "Description" + } + ], + "signature": "getSize(): number", + "source": "script-api", + "tags": [ + "getsize", + "region.getsize" + ], + "title": "Region.getSize" + }, + { + "description": "Returns the components that would be rendered by this region when calling PageMgr.renderRegion or PageMgr.renderRegion.

    As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "id": "script-api:dw/experience/Region#getVisibleComponents", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.getVisibleComponents", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the components that would be rendered by this region\nwhen calling PageMgr.renderRegion or PageMgr.renderRegion.\n

    \nAs visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this\ncall should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "heading": "Description" + } + ], + "signature": "getVisibleComponents(): Collection", + "source": "script-api", + "tags": [ + "getvisiblecomponents", + "region.getvisiblecomponents" + ], + "title": "Region.getVisibleComponents" + }, + { + "description": "Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion or PageMgr.renderRegion.

    Due to its time and customer group depending nature this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "id": "script-api:dw/experience/Region#size", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.size", + "sections": [ + { + "body": "Returns the number of components that would be rendered by this region\nwhen calling PageMgr.renderRegion or PageMgr.renderRegion.\n

    \nDue to its time and customer group depending nature this call should NOT happen in a pagecached context\noutside of the processing induced by the above mentioned render methods.", + "heading": "Description" + } + ], + "signature": "readonly size: number", + "source": "script-api", + "tags": [ + "size", + "region.size" + ], + "title": "Region.size" + }, + { + "description": "Returns the components that would be rendered by this region when calling PageMgr.renderRegion or PageMgr.renderRegion.

    As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "id": "script-api:dw/experience/Region#visibleComponents", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/Region", + "qualifiedName": "dw.experience.Region.visibleComponents", + "sections": [ + { + "body": "Returns the components that would be rendered by this region\nwhen calling PageMgr.renderRegion or PageMgr.renderRegion.\n

    \nAs visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this\ncall should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.", + "heading": "Description" + } + ], + "signature": "readonly visibleComponents: Collection", + "source": "script-api", + "tags": [ + "visiblecomponents", + "region.visiblecomponents" + ], + "title": "Region.visibleComponents" + }, + { + "description": "A config that drives how the region is rendered. One can basically decide which kind of tag is used as wrapper element (e.g. `

    ...
    `) and which attributes are to be placed into this wrapper element (e.g. `class=\"foo bar\"`).", + "id": "script-api:dw/experience/RegionRenderSettings", + "kind": "class", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience", + "qualifiedName": "dw.experience.RegionRenderSettings", + "sections": [ + { + "body": "A config that drives how the region is rendered. One can basically decide which kind of tag is used as wrapper\nelement (e.g. `
    ...
    `) and which attributes are to be placed into this wrapper\nelement (e.g. `class=\"foo bar\"`).\n\nIf no attributes are provided for the region render settings then the system default ones will apply. Also if no tag\nname is provided then the system default one will apply.\n\n- tag_name : div\n- attributes : {\"class\":\"experience-region experience-[REGION_ID]\"}\n\nFurthermore the render settings for components in this region can be specified - in case nothing is set per component\nthen the default component render setting will be applied during rendering. If also no default component render\nsetting is provided then the system default one will apply (see ComponentRenderSettings).", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "regionrendersettings", + "dw.experience.regionrendersettings", + "dw/experience" + ], + "title": "RegionRenderSettings" + }, + { + "description": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "id": "script-api:dw/experience/RegionRenderSettings#attributes", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.attributes", + "sections": [ + { + "body": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "heading": "Description" + } + ], + "signature": "attributes: any", + "source": "script-api", + "tags": [ + "attributes", + "regionrendersettings.attributes" + ], + "title": "RegionRenderSettings.attributes" + }, + { + "description": "Returns the default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component. If also no default is supplied then the system default will be used during rendering.", + "id": "script-api:dw/experience/RegionRenderSettings#defaultComponentRenderSettings", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.defaultComponentRenderSettings", + "sections": [ + { + "body": "Returns the default component render settings. These will be used during rendering of the components contained in\nthe region in case no dedicated component render settings were provided per component. If also no default is\nsupplied then the system default will be used during rendering.", + "heading": "Description" + } + ], + "signature": "defaultComponentRenderSettings: ComponentRenderSettings", + "source": "script-api", + "tags": [ + "defaultcomponentrendersettings", + "regionrendersettings.defaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.defaultComponentRenderSettings" + }, + { + "description": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "id": "script-api:dw/experience/RegionRenderSettings#getAttributes", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getAttributes", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the configured attributes of the wrapper element as set by setAttributes.", + "heading": "Description" + } + ], + "signature": "getAttributes(): any", + "source": "script-api", + "tags": [ + "getattributes", + "regionrendersettings.getattributes" + ], + "title": "RegionRenderSettings.getAttributes" + }, + { + "description": "Returns the component render settings for the given component. In case no explicitly specified settings are found for this component then the default one will be provided.", + "id": "script-api:dw/experience/RegionRenderSettings#getComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "component", + "type": "Component" + } + ], + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getComponentRenderSettings", + "returns": { + "type": "ComponentRenderSettings" + }, + "sections": [ + { + "body": "Returns the component render settings for the given component. In case no explicitly specified settings are found\nfor this component then the default one will be provided.", + "heading": "Description" + } + ], + "signature": "getComponentRenderSettings(component: Component): ComponentRenderSettings", + "source": "script-api", + "tags": [ + "getcomponentrendersettings", + "regionrendersettings.getcomponentrendersettings" + ], + "title": "RegionRenderSettings.getComponentRenderSettings" + }, + { + "description": "Returns the default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component. If also no default is supplied then the system default will be used during rendering.", + "id": "script-api:dw/experience/RegionRenderSettings#getDefaultComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getDefaultComponentRenderSettings", + "returns": { + "type": "ComponentRenderSettings" + }, + "sections": [ + { + "body": "Returns the default component render settings. These will be used during rendering of the components contained in\nthe region in case no dedicated component render settings were provided per component. If also no default is\nsupplied then the system default will be used during rendering.", + "heading": "Description" + } + ], + "signature": "getDefaultComponentRenderSettings(): ComponentRenderSettings", + "source": "script-api", + "tags": [ + "getdefaultcomponentrendersettings", + "regionrendersettings.getdefaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.getDefaultComponentRenderSettings" + }, + { + "description": "Returns the tag name of the region wrapper element. Defaults to 'div'.", + "id": "script-api:dw/experience/RegionRenderSettings#getTagName", + "kind": "method", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.getTagName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tag name of the region wrapper element. Defaults to 'div'.", + "heading": "Description" + } + ], + "signature": "getTagName(): string", + "source": "script-api", + "tags": [ + "gettagname", + "regionrendersettings.gettagname" + ], + "title": "RegionRenderSettings.getTagName" + }, + { + "description": "Sets the to be configured attributes of the wrapper element. Set to `null` in case you want to system defaults to be applied.", + "id": "script-api:dw/experience/RegionRenderSettings#setAttributes", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "attributes", + "type": "Object" + } + ], + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setAttributes", + "returns": { + "type": "RegionRenderSettings" + }, + "sections": [ + { + "body": "Sets the to be configured attributes of the wrapper element. Set to `null` in case you\nwant to system defaults to be applied.", + "heading": "Description" + } + ], + "signature": "setAttributes(attributes: Object): RegionRenderSettings", + "source": "script-api", + "tags": [ + "setattributes", + "regionrendersettings.setattributes" + ], + "title": "RegionRenderSettings.setAttributes" + }, + { + "description": "Sets the component render settings for the given component.", + "id": "script-api:dw/experience/RegionRenderSettings#setComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "component", + "type": "Component" + }, + { + "name": "componentRenderSettings", + "type": "ComponentRenderSettings" + } + ], + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setComponentRenderSettings", + "returns": { + "type": "RegionRenderSettings" + }, + "sections": [ + { + "body": "Sets the component render settings for the given component.", + "heading": "Description" + } + ], + "signature": "setComponentRenderSettings(component: Component, componentRenderSettings: ComponentRenderSettings): RegionRenderSettings", + "source": "script-api", + "tags": [ + "setcomponentrendersettings", + "regionrendersettings.setcomponentrendersettings" + ], + "title": "RegionRenderSettings.setComponentRenderSettings" + }, + { + "description": "Sets the default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component.", + "id": "script-api:dw/experience/RegionRenderSettings#setDefaultComponentRenderSettings", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "defaultComponentRenderSettings", + "type": "ComponentRenderSettings" + } + ], + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setDefaultComponentRenderSettings", + "returns": { + "type": "RegionRenderSettings" + }, + "sections": [ + { + "body": "Sets the default component render settings. These will be used during rendering of the components contained in\nthe region in case no dedicated component render settings were provided per component.", + "heading": "Description" + } + ], + "signature": "setDefaultComponentRenderSettings(defaultComponentRenderSettings: ComponentRenderSettings): RegionRenderSettings", + "source": "script-api", + "tags": [ + "setdefaultcomponentrendersettings", + "regionrendersettings.setdefaultcomponentrendersettings" + ], + "title": "RegionRenderSettings.setDefaultComponentRenderSettings" + }, + { + "description": "Sets the tag name of the region wrapper element. Must not be empty.", + "id": "script-api:dw/experience/RegionRenderSettings#setTagName", + "kind": "method", + "packagePath": "dw/experience", + "params": [ + { + "name": "tagName", + "type": "string" + } + ], + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.setTagName", + "returns": { + "type": "RegionRenderSettings" + }, + "sections": [ + { + "body": "Sets the tag name of the region wrapper element. Must not be empty.", + "heading": "Description" + } + ], + "signature": "setTagName(tagName: string): RegionRenderSettings", + "source": "script-api", + "tags": [ + "settagname", + "regionrendersettings.settagname" + ], + "title": "RegionRenderSettings.setTagName" + }, + { + "description": "Returns the tag name of the region wrapper element. Defaults to 'div'.", + "id": "script-api:dw/experience/RegionRenderSettings#tagName", + "kind": "property", + "packagePath": "dw/experience", + "parentId": "script-api:dw/experience/RegionRenderSettings", + "qualifiedName": "dw.experience.RegionRenderSettings.tagName", + "sections": [ + { + "body": "Returns the tag name of the region wrapper element. Defaults to 'div'.", + "heading": "Description" + } + ], + "signature": "tagName: string", + "source": "script-api", + "tags": [ + "tagname", + "regionrendersettings.tagname" + ], + "title": "RegionRenderSettings.tagName" + }, + { + "description": "1 declaration", + "id": "script-api:dw/experience/cms", + "kind": "package", + "packagePath": "dw/experience/cms", + "qualifiedName": "dw.experience.cms", + "source": "script-api", + "tags": [ + "dw/experience/cms", + "dw.experience.cms" + ], + "title": "dw.experience.cms" + }, + { + "description": "This class represents a Salesforce CMS record, exposing its:", + "id": "script-api:dw/experience/cms/CMSRecord", + "kind": "class", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms", + "qualifiedName": "dw.experience.cms.CMSRecord", + "sections": [ + { + "body": "This class represents a Salesforce CMS record, exposing its:\n\n- `id`, see getID\n- `type`, see getType\n- `attributes`, see getAttributes\n\nThe `attributes` are key value pairs:\n\n- the key being the attribute id as given in the `type.attribute_definitions` entries\n- the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `type.attribute_definitions` entries\n(similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "cmsrecord", + "dw.experience.cms.cmsrecord", + "dw/experience/cms" + ], + "title": "CMSRecord" + }, + { + "description": "Return the id of the Salesforce CMS record.", + "id": "script-api:dw/experience/cms/CMSRecord#ID", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.ID", + "sections": [ + { + "body": "Return the id of the Salesforce CMS record.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "cmsrecord.id" + ], + "title": "CMSRecord.ID" + }, + { + "description": "Return the Salesforce CMS record attributes as key value pairs:", + "id": "script-api:dw/experience/cms/CMSRecord#attributes", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.attributes", + "sections": [ + { + "body": "Return the Salesforce CMS record attributes as key value pairs:\n\n- the key being the attribute id as given in the `getType.attribute_definitions` entries\n- the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `getType.attribute_definitions` entries\n(similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)\n\nThe attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,\nthen `myCmsRecord.foo` will give the same results.", + "heading": "Description" + } + ], + "signature": "readonly attributes: utilMap", + "source": "script-api", + "tags": [ + "attributes", + "cmsrecord.attributes" + ], + "title": "CMSRecord.attributes" + }, + { + "description": "Return the Salesforce CMS record attributes as key value pairs:", + "id": "script-api:dw/experience/cms/CMSRecord#getAttributes", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getAttributes", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Return the Salesforce CMS record attributes as key value pairs:\n\n- the key being the attribute id as given in the `getType.attribute_definitions` entries\n- the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `getType.attribute_definitions` entries\n(similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)\n\nThe attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,\nthen `myCmsRecord.foo` will give the same results.", + "heading": "Description" + } + ], + "signature": "getAttributes(): utilMap", + "source": "script-api", + "tags": [ + "getattributes", + "cmsrecord.getattributes" + ], + "title": "CMSRecord.getAttributes" + }, + { + "description": "Return the id of the Salesforce CMS record.", + "id": "script-api:dw/experience/cms/CMSRecord#getID", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the id of the Salesforce CMS record.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "cmsrecord.getid" + ], + "title": "CMSRecord.getID" + }, + { + "description": "Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties can be accessed accordingly:", + "id": "script-api:dw/experience/cms/CMSRecord#getType", + "kind": "method", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.getType", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties\ncan be accessed accordingly:\n\n- `getType().id : string`\n- `getType().name : string`\n- `getType().attribute_definitions : Map` (see `content/schema/attributedefinition.json`)", + "heading": "Description" + } + ], + "signature": "getType(): utilMap", + "source": "script-api", + "tags": [ + "gettype", + "cmsrecord.gettype" + ], + "title": "CMSRecord.getType" + }, + { + "description": "Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties can be accessed accordingly:", + "id": "script-api:dw/experience/cms/CMSRecord#type", + "kind": "property", + "packagePath": "dw/experience/cms", + "parentId": "script-api:dw/experience/cms/CMSRecord", + "qualifiedName": "dw.experience.cms.CMSRecord.type", + "sections": [ + { + "body": "Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties\ncan be accessed accordingly:\n\n- `getType().id : string`\n- `getType().name : string`\n- `getType().attribute_definitions : Map` (see `content/schema/attributedefinition.json`)", + "heading": "Description" + } + ], + "signature": "readonly type: utilMap", + "source": "script-api", + "tags": [ + "type", + "cmsrecord.type" + ], + "title": "CMSRecord.type" + }, + { + "description": "3 declarations", + "id": "script-api:dw/experience/image", + "kind": "package", + "packagePath": "dw/experience/image", + "qualifiedName": "dw.experience.image", + "source": "script-api", + "tags": [ + "dw/experience/image", + "dw.experience.image" + ], + "title": "dw.experience.image" + }, + { + "description": "This class represents an image focal point.", + "id": "script-api:dw/experience/image/FocalPoint", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.FocalPoint", + "sections": [ + { + "body": "This class represents an image focal point.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "focalpoint", + "dw.experience.image.focalpoint", + "dw/experience/image" + ], + "title": "FocalPoint" + }, + { + "description": "Returns the focal point abscissa.", + "id": "script-api:dw/experience/image/FocalPoint#getX", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.getX", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the focal point abscissa.", + "heading": "Description" + } + ], + "signature": "getX(): number", + "source": "script-api", + "tags": [ + "getx", + "focalpoint.getx" + ], + "title": "FocalPoint.getX" + }, + { + "description": "Returns the focal point ordinate.", + "id": "script-api:dw/experience/image/FocalPoint#getY", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.getY", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the focal point ordinate.", + "heading": "Description" + } + ], + "signature": "getY(): number", + "source": "script-api", + "tags": [ + "gety", + "focalpoint.gety" + ], + "title": "FocalPoint.getY" + }, + { + "description": "Returns the focal point abscissa.", + "id": "script-api:dw/experience/image/FocalPoint#x", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.x", + "sections": [ + { + "body": "Returns the focal point abscissa.", + "heading": "Description" + } + ], + "signature": "readonly x: number", + "source": "script-api", + "tags": [ + "x", + "focalpoint.x" + ], + "title": "FocalPoint.x" + }, + { + "description": "Returns the focal point ordinate.", + "id": "script-api:dw/experience/image/FocalPoint#y", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/FocalPoint", + "qualifiedName": "dw.experience.image.FocalPoint.y", + "sections": [ + { + "body": "Returns the focal point ordinate.", + "heading": "Description" + } + ], + "signature": "readonly y: number", + "source": "script-api", + "tags": [ + "y", + "focalpoint.y" + ], + "title": "FocalPoint.y" + }, + { + "description": "This class represents an image with additional configuration capabilities (e.g. optional focal point). Furthermore it provides access to meta data of the referenced image file.", + "id": "script-api:dw/experience/image/Image", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.Image", + "sections": [ + { + "body": "This class represents an image with additional configuration capabilities (e.g. optional focal point).\nFurthermore it provides access to meta data of the referenced image file.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "image", + "dw.experience.image.image", + "dw/experience/image" + ], + "title": "Image" + }, + { + "description": "Returns the image media file from the current site's library.", + "id": "script-api:dw/experience/image/Image#file", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.file", + "sections": [ + { + "body": "Returns the image media file from the current site's library.", + "heading": "Description" + } + ], + "signature": "readonly file: MediaFile | null", + "source": "script-api", + "tags": [ + "file", + "image.file" + ], + "title": "Image.file" + }, + { + "description": "Returns the focal point of the image.", + "id": "script-api:dw/experience/image/Image#focalPoint", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.focalPoint", + "sections": [ + { + "body": "Returns the focal point of the image.", + "heading": "Description" + } + ], + "signature": "readonly focalPoint: FocalPoint | null", + "source": "script-api", + "tags": [ + "focalpoint", + "image.focalpoint" + ], + "title": "Image.focalPoint" + }, + { + "description": "Returns the image media file from the current site's library.", + "id": "script-api:dw/experience/image/Image#getFile", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getFile", + "returns": { + "type": "MediaFile | null" + }, + "sections": [ + { + "body": "Returns the image media file from the current site's library.", + "heading": "Description" + } + ], + "signature": "getFile(): MediaFile | null", + "source": "script-api", + "tags": [ + "getfile", + "image.getfile" + ], + "title": "Image.getFile" + }, + { + "description": "Returns the focal point of the image.", + "id": "script-api:dw/experience/image/Image#getFocalPoint", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getFocalPoint", + "returns": { + "type": "FocalPoint | null" + }, + "sections": [ + { + "body": "Returns the focal point of the image.", + "heading": "Description" + } + ], + "signature": "getFocalPoint(): FocalPoint | null", + "source": "script-api", + "tags": [ + "getfocalpoint", + "image.getfocalpoint" + ], + "title": "Image.getFocalPoint" + }, + { + "description": "Returns the meta data of the physical image file. This meta data is obtained when the respective component attribute was saved from Page Designer, i.e. the underlying image is not queried for the meta data every time getMetaData is called but only on store of the related component attribute.", + "id": "script-api:dw/experience/image/Image#getMetaData", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.getMetaData", + "returns": { + "type": "ImageMetaData | null" + }, + "sections": [ + { + "body": "Returns the meta data of the physical image file. This meta data is obtained when\nthe respective component attribute was saved from Page Designer, i.e. the underlying\nimage is not queried for the meta data every time getMetaData is called\nbut only on store of the related component attribute.", + "heading": "Description" + } + ], + "signature": "getMetaData(): ImageMetaData | null", + "source": "script-api", + "tags": [ + "getmetadata", + "image.getmetadata" + ], + "title": "Image.getMetaData" + }, + { + "description": "Returns the meta data of the physical image file. This meta data is obtained when the respective component attribute was saved from Page Designer, i.e. the underlying image is not queried for the meta data every time getMetaData is called but only on store of the related component attribute.", + "id": "script-api:dw/experience/image/Image#metaData", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/Image", + "qualifiedName": "dw.experience.image.Image.metaData", + "sections": [ + { + "body": "Returns the meta data of the physical image file. This meta data is obtained when\nthe respective component attribute was saved from Page Designer, i.e. the underlying\nimage is not queried for the meta data every time getMetaData is called\nbut only on store of the related component attribute.", + "heading": "Description" + } + ], + "signature": "readonly metaData: ImageMetaData | null", + "source": "script-api", + "tags": [ + "metadata", + "image.metadata" + ], + "title": "Image.metaData" + }, + { + "description": "This class represents the image meta data, e.g. width and height.", + "id": "script-api:dw/experience/image/ImageMetaData", + "kind": "class", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image", + "qualifiedName": "dw.experience.image.ImageMetaData", + "sections": [ + { + "body": "This class represents the image meta data, e.g. width and height.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "imagemetadata", + "dw.experience.image.imagemetadata", + "dw/experience/image" + ], + "title": "ImageMetaData" + }, + { + "description": "Returns the image height.", + "id": "script-api:dw/experience/image/ImageMetaData#getHeight", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.getHeight", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the image height.", + "heading": "Description" + } + ], + "signature": "getHeight(): number", + "source": "script-api", + "tags": [ + "getheight", + "imagemetadata.getheight" + ], + "title": "ImageMetaData.getHeight" + }, + { + "description": "Returns the image width.", + "id": "script-api:dw/experience/image/ImageMetaData#getWidth", + "kind": "method", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.getWidth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the image width.", + "heading": "Description" + } + ], + "signature": "getWidth(): number", + "source": "script-api", + "tags": [ + "getwidth", + "imagemetadata.getwidth" + ], + "title": "ImageMetaData.getWidth" + }, + { + "description": "Returns the image height.", + "id": "script-api:dw/experience/image/ImageMetaData#height", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.height", + "sections": [ + { + "body": "Returns the image height.", + "heading": "Description" + } + ], + "signature": "readonly height: number", + "source": "script-api", + "tags": [ + "height", + "imagemetadata.height" + ], + "title": "ImageMetaData.height" + }, + { + "description": "Returns the image width.", + "id": "script-api:dw/experience/image/ImageMetaData#width", + "kind": "property", + "packagePath": "dw/experience/image", + "parentId": "script-api:dw/experience/image/ImageMetaData", + "qualifiedName": "dw.experience.image.ImageMetaData.width", + "sections": [ + { + "body": "Returns the image width.", + "heading": "Description" + } + ], + "signature": "readonly width: number", + "source": "script-api", + "tags": [ + "width", + "imagemetadata.width" + ], + "title": "ImageMetaData.width" + }, + { + "description": "2 declarations", + "id": "script-api:dw/extensions/applepay", + "kind": "package", + "packagePath": "dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay", + "source": "script-api", + "tags": [ + "dw/extensions/applepay", + "dw.extensions.applepay" + ], + "title": "dw.extensions.applepay" + }, + { + "description": "Result of a hook handling an Apple Pay request.", + "examples": [ + "var ApplePayHookResult = require('dw/extensions/applepay/ApplePayHookResult');\nvar Status = require('dw/system/Status');\n\nvar error = new Status(Status.ERROR);\nerror.addDetail(ApplePayHookResult.STATUS_REASON_DETAIL_KEY, ApplePayHookResult.REASON_SHIPPING_CONTACT);" + ], + "id": "script-api:dw/extensions/applepay/ApplePayHookResult", + "kind": "class", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult", + "sections": [ + { + "body": "Result of a hook handling an Apple Pay request.\n\nUse the constants in this type to indicate specific error reasons to be provided\nto Apple Pay JS. For example, the following code creates a dw.system.Status\nthat indicates the shipping contact information provided by Apple Pay is invalid:\n\n\nIf a specific error reason is not provided, the generic Apple Pay `STATUS_FAILURE`\nreason will be used when necessary.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "applepayhookresult", + "dw.extensions.applepay.applepayhookresult", + "dw/extensions/applepay" + ], + "title": "ApplePayHookResult" + }, + { + "description": "Error reason code representing an invalid billing address.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_BILLING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_BILLING_ADDRESS", + "sections": [ + { + "body": "Error reason code representing an invalid billing address.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_BILLING_ADDRESS = \"InvalidBillingPostalAddress\"", + "source": "script-api", + "tags": [ + "reason_billing_address", + "applepayhookresult.reason_billing_address" + ], + "title": "ApplePayHookResult.REASON_BILLING_ADDRESS" + }, + { + "description": "Error reason code representing an invalid billing address.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_BILLING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_BILLING_ADDRESS", + "sections": [ + { + "body": "Error reason code representing an invalid billing address.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_BILLING_ADDRESS = \"InvalidBillingPostalAddress\"", + "source": "script-api", + "tags": [ + "reason_billing_address", + "applepayhookresult.reason_billing_address" + ], + "title": "ApplePayHookResult.REASON_BILLING_ADDRESS" + }, + { + "description": "Error reason code representing an error or failure not otherwise specified.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_FAILURE", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_FAILURE", + "sections": [ + { + "body": "Error reason code representing an error or failure not otherwise specified.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_FAILURE = \"Failure\"", + "source": "script-api", + "tags": [ + "reason_failure", + "applepayhookresult.reason_failure" + ], + "title": "ApplePayHookResult.REASON_FAILURE" + }, + { + "description": "Error reason code representing an error or failure not otherwise specified.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_FAILURE", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_FAILURE", + "sections": [ + { + "body": "Error reason code representing an error or failure not otherwise specified.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_FAILURE = \"Failure\"", + "source": "script-api", + "tags": [ + "reason_failure", + "applepayhookresult.reason_failure" + ], + "title": "ApplePayHookResult.REASON_FAILURE" + }, + { + "description": "Error reason code representing the PIN is incorrect.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_INCORRECT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_INCORRECT", + "sections": [ + { + "body": "Error reason code representing the PIN is incorrect.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_INCORRECT = \"PINIncorrect\"", + "source": "script-api", + "tags": [ + "reason_pin_incorrect", + "applepayhookresult.reason_pin_incorrect" + ], + "title": "ApplePayHookResult.REASON_PIN_INCORRECT" + }, + { + "description": "Error reason code representing the PIN is incorrect.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_INCORRECT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_INCORRECT", + "sections": [ + { + "body": "Error reason code representing the PIN is incorrect.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_INCORRECT = \"PINIncorrect\"", + "source": "script-api", + "tags": [ + "reason_pin_incorrect", + "applepayhookresult.reason_pin_incorrect" + ], + "title": "ApplePayHookResult.REASON_PIN_INCORRECT" + }, + { + "description": "Error reason code representing a PIN lockout.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_LOCKOUT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_LOCKOUT", + "sections": [ + { + "body": "Error reason code representing a PIN lockout.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_LOCKOUT = \"PINLockout\"", + "source": "script-api", + "tags": [ + "reason_pin_lockout", + "applepayhookresult.reason_pin_lockout" + ], + "title": "ApplePayHookResult.REASON_PIN_LOCKOUT" + }, + { + "description": "Error reason code representing a PIN lockout.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_LOCKOUT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_LOCKOUT", + "sections": [ + { + "body": "Error reason code representing a PIN lockout.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_LOCKOUT = \"PINLockout\"", + "source": "script-api", + "tags": [ + "reason_pin_lockout", + "applepayhookresult.reason_pin_lockout" + ], + "title": "ApplePayHookResult.REASON_PIN_LOCKOUT" + }, + { + "description": "Error reason code representing a PIN is required.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_REQUIRED", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_REQUIRED", + "sections": [ + { + "body": "Error reason code representing a PIN is required.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_REQUIRED = \"PINRequired\"", + "source": "script-api", + "tags": [ + "reason_pin_required", + "applepayhookresult.reason_pin_required" + ], + "title": "ApplePayHookResult.REASON_PIN_REQUIRED" + }, + { + "description": "Error reason code representing a PIN is required.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_PIN_REQUIRED", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_PIN_REQUIRED", + "sections": [ + { + "body": "Error reason code representing a PIN is required.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_PIN_REQUIRED = \"PINRequired\"", + "source": "script-api", + "tags": [ + "reason_pin_required", + "applepayhookresult.reason_pin_required" + ], + "title": "ApplePayHookResult.REASON_PIN_REQUIRED" + }, + { + "description": "Error reason code representing an invalid shipping address.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_ADDRESS", + "sections": [ + { + "body": "Error reason code representing an invalid shipping address.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_SHIPPING_ADDRESS = \"InvalidShippingPostalAddress\"", + "source": "script-api", + "tags": [ + "reason_shipping_address", + "applepayhookresult.reason_shipping_address" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_ADDRESS" + }, + { + "description": "Error reason code representing an invalid shipping address.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_ADDRESS", + "sections": [ + { + "body": "Error reason code representing an invalid shipping address.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_SHIPPING_ADDRESS = \"InvalidShippingPostalAddress\"", + "source": "script-api", + "tags": [ + "reason_shipping_address", + "applepayhookresult.reason_shipping_address" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_ADDRESS" + }, + { + "description": "Error reason code representing invalid shipping contact information.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_CONTACT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_CONTACT", + "sections": [ + { + "body": "Error reason code representing invalid shipping contact information.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_SHIPPING_CONTACT = \"InvalidShippingContact\"", + "source": "script-api", + "tags": [ + "reason_shipping_contact", + "applepayhookresult.reason_shipping_contact" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_CONTACT" + }, + { + "description": "Error reason code representing invalid shipping contact information.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#REASON_SHIPPING_CONTACT", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.REASON_SHIPPING_CONTACT", + "sections": [ + { + "body": "Error reason code representing invalid shipping contact information.", + "heading": "Description" + } + ], + "signature": "static readonly REASON_SHIPPING_CONTACT = \"InvalidShippingContact\"", + "source": "script-api", + "tags": [ + "reason_shipping_contact", + "applepayhookresult.reason_shipping_contact" + ], + "title": "ApplePayHookResult.REASON_SHIPPING_CONTACT" + }, + { + "description": "Key for the detail to be used in dw.system.Status objects to indicate the reason to communicate to Apple Pay for errors.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#STATUS_REASON_DETAIL_KEY", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.STATUS_REASON_DETAIL_KEY", + "sections": [ + { + "body": "Key for the detail to be used in dw.system.Status objects to indicate\nthe reason to communicate to Apple Pay for errors.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_REASON_DETAIL_KEY = \"reason\"", + "source": "script-api", + "tags": [ + "status_reason_detail_key", + "applepayhookresult.status_reason_detail_key" + ], + "title": "ApplePayHookResult.STATUS_REASON_DETAIL_KEY" + }, + { + "description": "Key for the detail to be used in dw.system.Status objects to indicate the reason to communicate to Apple Pay for errors.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#STATUS_REASON_DETAIL_KEY", + "kind": "constant", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.STATUS_REASON_DETAIL_KEY", + "sections": [ + { + "body": "Key for the detail to be used in dw.system.Status objects to indicate\nthe reason to communicate to Apple Pay for errors.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_REASON_DETAIL_KEY = \"reason\"", + "source": "script-api", + "tags": [ + "status_reason_detail_key", + "applepayhookresult.status_reason_detail_key" + ], + "title": "ApplePayHookResult.STATUS_REASON_DETAIL_KEY" + }, + { + "description": "Detail to the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#eventDetail", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.eventDetail", + "sections": [ + { + "body": "Detail to the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly eventDetail: Object", + "source": "script-api", + "tags": [ + "eventdetail", + "applepayhookresult.eventdetail" + ], + "title": "ApplePayHookResult.eventDetail" + }, + { + "description": "Name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#eventName", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.eventName", + "sections": [ + { + "body": "Name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly eventName: string", + "source": "script-api", + "tags": [ + "eventname", + "applepayhookresult.eventname" + ], + "title": "ApplePayHookResult.eventName" + }, + { + "description": "Detail to the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getEventDetail", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getEventDetail", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Detail to the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "getEventDetail(): Object", + "source": "script-api", + "tags": [ + "geteventdetail", + "applepayhookresult.geteventdetail" + ], + "title": "ApplePayHookResult.getEventDetail" + }, + { + "description": "Name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getEventName", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getEventName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "getEventName(): string", + "source": "script-api", + "tags": [ + "geteventname", + "applepayhookresult.geteventname" + ], + "title": "ApplePayHookResult.getEventName" + }, + { + "description": "URL to navigate to in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getRedirect", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getRedirect", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "URL to navigate to in response to this result.", + "heading": "Description" + } + ], + "signature": "getRedirect(): URL", + "source": "script-api", + "tags": [ + "getredirect", + "applepayhookresult.getredirect" + ], + "title": "ApplePayHookResult.getRedirect" + }, + { + "description": "Status describing the outcome of this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#getStatus", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.getStatus", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Status describing the outcome of this result.", + "heading": "Description" + } + ], + "signature": "getStatus(): Status", + "source": "script-api", + "tags": [ + "getstatus", + "applepayhookresult.getstatus" + ], + "title": "ApplePayHookResult.getStatus" + }, + { + "description": "URL to navigate to in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#redirect", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.redirect", + "sections": [ + { + "body": "URL to navigate to in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly redirect: URL", + "source": "script-api", + "tags": [ + "redirect", + "applepayhookresult.redirect" + ], + "title": "ApplePayHookResult.redirect" + }, + { + "description": "Sets the name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.setEvent", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "setEvent(name: string): void", + "source": "script-api", + "tags": [ + "setevent", + "applepayhookresult.setevent" + ], + "title": "ApplePayHookResult.setEvent" + }, + { + "description": "Sets the name and detail of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "detail", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.setEvent", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name and detail of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "setEvent(name: string, detail: Object): void", + "source": "script-api", + "tags": [ + "setevent", + "applepayhookresult.setevent" + ], + "title": "ApplePayHookResult.setEvent" + }, + { + "description": "Status describing the outcome of this result.", + "id": "script-api:dw/extensions/applepay/ApplePayHookResult#status", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHookResult", + "qualifiedName": "dw.extensions.applepay.ApplePayHookResult.status", + "sections": [ + { + "body": "Status describing the outcome of this result.", + "heading": "Description" + } + ], + "signature": "readonly status: Status", + "source": "script-api", + "tags": [ + "status", + "applepayhookresult.status" + ], + "title": "ApplePayHookResult.status" + }, + { + "description": "ApplePayHooks interface containing extension points for customizing Apple Pay.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.applepay.getRequest\", \"script\": \"./applepay.ds\"}\n{\"name\": \"dw.extensions.applepay.shippingContactSelected\", \"script\": \"./applepay.ds\"}\n]" + ], + "id": "script-api:dw/extensions/applepay/ApplePayHooks", + "kind": "interface", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks", + "sections": [ + { + "body": "ApplePayHooks interface containing extension points for customizing Apple Pay.\n\nThese hooks are executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "applepayhooks", + "dw.extensions.applepay.applepayhooks", + "dw/extensions/applepay" + ], + "title": "ApplePayHooks" + }, + { + "description": "Called to authorize the Apple Pay payment for the order. The given order will have been created by the extensionPointPaymentAuthorizedCreateOrder hook, after the basket was populated with data from the `ApplePayPaymentAuthorizedEvent`.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#authorizeOrderPayment", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "event", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.authorizeOrderPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called to authorize the Apple Pay payment for the order. The given order will have been created by the\nextensionPointPaymentAuthorizedCreateOrder hook, after the basket was populated with data from\nthe `ApplePayPaymentAuthorizedEvent`.\n\nReturn a non-error status if you have successfully authorized the payment with your payment service provider.\nYour hook implementation must set the necessary payment status and transaction identifier data on the order as\nreturned by the provider.\n\nReturn an error status to indicate a problem, including unsuccessful authorization. See\ndw.extensions.applepay.ApplePayHookResult for how to indicate error statuses with detail information to\nbe provided to Apple Pay.\n\nSee the Apple Pay JS API Reference for more information.", + "heading": "Description" + } + ], + "signature": "authorizeOrderPayment(order: Order, event: Object): Status", + "source": "script-api", + "tags": [ + "authorizeorderpayment", + "applepayhooks.authorizeorderpayment" + ], + "title": "ApplePayHooks.authorizeOrderPayment" + }, + { + "description": "Called after the Apple Pay payment sheet was canceled. There is no Apple Pay JS event object for this case. The given basket is the one that was passed to other hooks earlier in the Apple Pay checkout process.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#cancel", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.cancel", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after the Apple Pay payment sheet was canceled. There is no Apple Pay JS event object for this case. The\ngiven basket is the one that was passed to other hooks earlier in the Apple Pay checkout process.\n\nIt is not guaranteed that this hook will be executed for all Apple Pay payment sheets canceled by shoppers or\notherwise ended without a successful order. Calls to this hook are provided on a best-effort basis.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if possible. It\nis not guaranteed that the response with the hook result will be handled in the shopper browser in all cases.", + "heading": "Description" + } + ], + "signature": "cancel(basket: Basket): ApplePayHookResult", + "source": "script-api", + "tags": [ + "cancel", + "applepayhooks.cancel" + ], + "title": "ApplePayHooks.cancel" + }, + { + "description": "Called after handling the given `ApplePayPaymentAuthorizedEvent` for the given basket. Customer information, billing address, and/or shipping address for the default shipment will have already been updated to reflect the available contact information provided by Apple Pay based on the Apple Pay configuration for your site. Any preexisting payment instruments on the basket will have been removed, and a single `DW_APPLE_PAY` payment instrument added for the total amount.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#createOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "event", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.createOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Called after handling the given `ApplePayPaymentAuthorizedEvent` for the given basket. Customer\ninformation, billing address, and/or shipping address for the default shipment will have already been updated to\nreflect the available contact information provided by Apple Pay based on the Apple Pay configuration for your\nsite. Any preexisting payment instruments on the basket will have been removed, and a single\n`DW_APPLE_PAY` payment instrument added for the total amount.\n\nThe purpose of this hook is to populate the created order with any necessary information from the basket\nor the Apple Pay event. Do not use this hook for address verification, or any other validation. Instead\nuse the extensionPointPaymentAuthorizedAuthorizeOrderPayment hook which allows you to return\nan `ApplePayHookResult` with error status information.\n\nThe default implementation of this hook simply calls `OrderMgr.createOrder` and returns the created\norder.\n\nThrow an error to indicate a problem creating the order.", + "heading": "Description" + } + ], + "signature": "createOrder(basket: Basket, event: Object): Order", + "source": "script-api", + "tags": [ + "createorder", + "applepayhooks.createorder" + ], + "title": "ApplePayHooks.createOrder" + }, + { + "description": "The extension point name extensionPointCancel.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointCancel", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointCancel", + "sections": [ + { + "body": "The extension point name extensionPointCancel.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCancel: \"dw.extensions.applepay.cancel\"", + "source": "script-api", + "tags": [ + "extensionpointcancel", + "applepayhooks.extensionpointcancel" + ], + "title": "ApplePayHooks.extensionPointCancel" + }, + { + "description": "The extension point name extensionPointGetRequest.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointGetRequest", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointGetRequest", + "sections": [ + { + "body": "The extension point name extensionPointGetRequest.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointGetRequest: \"dw.extensions.applepay.getRequest\"", + "source": "script-api", + "tags": [ + "extensionpointgetrequest", + "applepayhooks.extensionpointgetrequest" + ], + "title": "ApplePayHooks.extensionPointGetRequest" + }, + { + "description": "The extension point name extensionPointPaymentAuthorizedAuthorizeOrderPayment.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedAuthorizeOrderPayment", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedAuthorizeOrderPayment", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAuthorizedAuthorizeOrderPayment.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAuthorizedAuthorizeOrderPayment: \"dw.extensions.applepay.paymentAuthorized.authorizeOrderPayment\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentauthorizedauthorizeorderpayment", + "applepayhooks.extensionpointpaymentauthorizedauthorizeorderpayment" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedAuthorizeOrderPayment" + }, + { + "description": "The extension point name extensionPointPaymentAuthorizedCreateOrder.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedCreateOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedCreateOrder", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAuthorizedCreateOrder.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAuthorizedCreateOrder: \"dw.extensions.applepay.paymentAuthorized.createOrder\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentauthorizedcreateorder", + "applepayhooks.extensionpointpaymentauthorizedcreateorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedCreateOrder" + }, + { + "description": "The extension point name extensionPointPaymentAuthorizedFailOrder.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedFailOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedFailOrder", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAuthorizedFailOrder.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAuthorizedFailOrder: \"dw.extensions.applepay.paymentAuthorized.failOrder\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentauthorizedfailorder", + "applepayhooks.extensionpointpaymentauthorizedfailorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedFailOrder" + }, + { + "description": "The extension point name extensionPointPaymentAuthorizedPlaceOrder.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentAuthorizedPlaceOrder", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentAuthorizedPlaceOrder", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAuthorizedPlaceOrder.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAuthorizedPlaceOrder: \"dw.extensions.applepay.paymentAuthorized.placeOrder\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentauthorizedplaceorder", + "applepayhooks.extensionpointpaymentauthorizedplaceorder" + ], + "title": "ApplePayHooks.extensionPointPaymentAuthorizedPlaceOrder" + }, + { + "description": "The extension point name extensionPointPaymentMethodSelected.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPaymentMethodSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPaymentMethodSelected", + "sections": [ + { + "body": "The extension point name extensionPointPaymentMethodSelected.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentMethodSelected: \"dw.extensions.applepay.paymentMethodSelected\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentmethodselected", + "applepayhooks.extensionpointpaymentmethodselected" + ], + "title": "ApplePayHooks.extensionPointPaymentMethodSelected" + }, + { + "description": "The extension point name extensionPointPrepareBasket.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointPrepareBasket", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointPrepareBasket", + "sections": [ + { + "body": "The extension point name extensionPointPrepareBasket.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPrepareBasket: \"dw.extensions.applepay.prepareBasket\"", + "source": "script-api", + "tags": [ + "extensionpointpreparebasket", + "applepayhooks.extensionpointpreparebasket" + ], + "title": "ApplePayHooks.extensionPointPrepareBasket" + }, + { + "description": "The extension point name extensionPointShippingContactSelected.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointShippingContactSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointShippingContactSelected", + "sections": [ + { + "body": "The extension point name extensionPointShippingContactSelected.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingContactSelected: \"dw.extensions.applepay.shippingContactSelected\"", + "source": "script-api", + "tags": [ + "extensionpointshippingcontactselected", + "applepayhooks.extensionpointshippingcontactselected" + ], + "title": "ApplePayHooks.extensionPointShippingContactSelected" + }, + { + "description": "The extension point name extensionPointShippingMethodSelected.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#extensionPointShippingMethodSelected", + "kind": "property", + "packagePath": "dw/extensions/applepay", + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.extensionPointShippingMethodSelected", + "sections": [ + { + "body": "The extension point name extensionPointShippingMethodSelected.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingMethodSelected: \"dw.extensions.applepay.shippingMethodSelected\"", + "source": "script-api", + "tags": [ + "extensionpointshippingmethodselected", + "applepayhooks.extensionpointshippingmethodselected" + ], + "title": "ApplePayHooks.extensionPointShippingMethodSelected" + }, + { + "description": "Called after payment authorization is unsuccessful and the given Apple Pay order must be failed. The purpose of this hook is to fail the order, or return a redirect URL that results in the order being failed when the shopper browser is navigated to it. The given status object is the result of calling the extensionPointPaymentAuthorizedAuthorizeOrderPayment hook.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#failOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "status", + "type": "Status" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.failOrder", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after payment authorization is unsuccessful and the given Apple Pay order must be failed. The purpose\nof this hook is to fail the order, or return a redirect URL that results in the order being failed when the shopper\nbrowser is navigated to it. The given status object is the result of calling the\nextensionPointPaymentAuthorizedAuthorizeOrderPayment hook.\n\nThe default implementation of this hook simply calls `OrderMgr.failOrder`, and returns a result\nwith the given status and no redirect URL.\n\nReturn a result with an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult\nfor how to indicate error statuses with detail information to be provided to Apple Pay. If the returned result includes\na redirect URL, the shopper browser will be navigated to that URL if the Apple Pay payment sheet is canceled.", + "heading": "Description" + } + ], + "signature": "failOrder(order: Order, status: Status): ApplePayHookResult", + "source": "script-api", + "tags": [ + "failorder", + "applepayhooks.failorder" + ], + "title": "ApplePayHooks.failOrder" + }, + { + "description": "Called to get the Apple Pay JS `PaymentRequest` for the given basket. You can set properties in the given request object to extend or override default properties set automatically based on the Apple Pay configuration for your site.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#getRequest", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "request", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.getRequest", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called to get the Apple Pay JS `PaymentRequest` for the given basket. You can set properties in the\ngiven request object to extend or override default properties set automatically based on the Apple Pay\nconfiguration for your site.\n\nReturn a result with an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult\nfor how to indicate error statuses with detail information to be provided to Apple Pay.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Apple\nPay payment sheet is canceled.\n\nSee the Apple Pay JS API Reference for more information.", + "heading": "Description" + } + ], + "signature": "getRequest(basket: Basket, request: Object): ApplePayHookResult", + "source": "script-api", + "tags": [ + "getrequest", + "applepayhooks.getrequest" + ], + "title": "ApplePayHooks.getRequest" + }, + { + "description": "Called after handling the given `ApplePayPaymentMethodSelectedEvent` for the given basket. This Apple Pay event does not contain payment card or device information.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#paymentMethodSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "event", + "type": "Object" + }, + { + "name": "response", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.paymentMethodSelected", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after handling the given `ApplePayPaymentMethodSelectedEvent` for the given basket. This Apple\nPay event does not contain payment card or device information.\n\nThe given response object will contain properties whose values are to be passed as parameters to the\n`ApplePaySession.completePaymentMethodSelection` event callback:\n\n- total - Updated total line item object\n- lineItems - Array of updated line item objects\n\nReturn a result with an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult\nfor how to indicate error statuses with detail information to be provided to Apple Pay.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Apple\nPay payment sheet is canceled.\n\nSee the Apple Pay JS API Reference for more information.", + "heading": "Description" + } + ], + "signature": "paymentMethodSelected(basket: Basket, event: Object, response: Object): ApplePayHookResult", + "source": "script-api", + "tags": [ + "paymentmethodselected", + "applepayhooks.paymentmethodselected" + ], + "title": "ApplePayHooks.paymentMethodSelected" + }, + { + "description": "Called after payment has been authorized and the given Apple Pay order is ready to be placed. The purpose of this hook is to place the order, or return a redirect URL that results in the order being placed when the shopper browser is navigated to it.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#placeOrder", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.placeOrder", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after payment has been authorized and the given Apple Pay order is ready to be placed. The purpose of this\nhook is to place the order, or return a redirect URL that results in the order being placed when the shopper\nbrowser is navigated to it.\n\nThe default implementation of this hook returns a redirect to `COPlaceOrder-Submit` with URL\nparameters `order_id` set to dw.order.Order.getOrderNo and `order_token` set to\ndw.order.Order.getOrderToken which corresponds to SiteGenesis-based implementations. Your hook\nimplementation should return a result with a different redirect URL as necessary to place the order and show an\norder confirmation.\n\nAlternatively, your hook implementation itself can place the order and return a result with a redirect URL to an\norder confirmation page that does not place the order. This is inconsistent with SiteGenesis-based\nimplementations so is not the default.\n\nReturn an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult for how to\nindicate error statuses with detail information to be provided to Apple Pay. If the returned result includes a\nredirect URL, the shopper browser will be navigated to that URL if the Apple Pay payment sheet is canceled.", + "heading": "Description" + } + ], + "signature": "placeOrder(order: Order): ApplePayHookResult", + "source": "script-api", + "tags": [ + "placeorder", + "applepayhooks.placeorder" + ], + "title": "ApplePayHooks.placeOrder" + }, + { + "description": "Called to prepare the given basket for an Apple Pay checkout. This hook will be executed after the user clicks the Apple Pay button.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#prepareBasket", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "parameters", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.prepareBasket", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called to prepare the given basket for an Apple Pay checkout. This hook will be executed after the user\nclicks the Apple Pay button.\n\nThe default implementation of this hook calculates the basket. A custom hook implementation that returns a\nnon-null result must calculate the basket.\n\nThe given parameters object will contain properties whose values are passed from the\n`` tag:\n\n- sku - SKU of product to checkout exclusively\n\nReturn a result with an error status to indicate a problem. For this hook there is no opportunity to provide user\nfeedback, so if any error status is returned, the Apple Pay payment sheet will be aborted.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL after the Apple\nPay payment sheet is aborted.", + "heading": "Description" + } + ], + "signature": "prepareBasket(basket: Basket, parameters: Object): ApplePayHookResult", + "source": "script-api", + "tags": [ + "preparebasket", + "applepayhooks.preparebasket" + ], + "title": "ApplePayHooks.prepareBasket" + }, + { + "description": "Called after handling the given `ApplePayShippingContactSelectedEvent` for the given basket. Basket customer information and/or shipping address for the default shipment will have already been updated to reflect the available shipping contact information provided by Apple Pay based on the Apple Pay configuration for your site. The basket will have already been calculated before this hook is called.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#shippingContactSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "event", + "type": "Object" + }, + { + "name": "response", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.shippingContactSelected", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after handling the given `ApplePayShippingContactSelectedEvent` for the given basket. Basket\ncustomer information and/or shipping address for the default shipment will have already been updated to reflect\nthe available shipping contact information provided by Apple Pay based on the Apple Pay configuration for your\nsite. The basket will have already been calculated before this hook is called.\n\nThe given response object will contain properties whose values are to be passed as parameters to the\n`ApplePaySession.completeShippingContactSelection` event callback:\n\n- shippingMethods - Array of applicable shipping method JS objects\n- total - Updated total line item object\n- lineItems - Array of updated line item objects\n\nReturn a result with an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult\nfor how to indicate error statuses with detail information to be provided to Apple Pay.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Apple\nPay payment sheet is canceled.\n\nSee the Apple Pay JS API Reference for more information.", + "heading": "Description" + } + ], + "signature": "shippingContactSelected(basket: Basket, event: Object, response: Object): ApplePayHookResult", + "source": "script-api", + "tags": [ + "shippingcontactselected", + "applepayhooks.shippingcontactselected" + ], + "title": "ApplePayHooks.shippingContactSelected" + }, + { + "description": "Called after handling the given `ApplePayShippingMethodSelectedEvent` for the given basket. The given shipping method will have already been set on the basket. The basket will have already been calculated before this hook is called.", + "id": "script-api:dw/extensions/applepay/ApplePayHooks#shippingMethodSelected", + "kind": "method", + "packagePath": "dw/extensions/applepay", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shippingMethod", + "type": "ShippingMethod" + }, + { + "name": "event", + "type": "Object" + }, + { + "name": "response", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/applepay/ApplePayHooks", + "qualifiedName": "dw.extensions.applepay.ApplePayHooks.shippingMethodSelected", + "returns": { + "type": "ApplePayHookResult" + }, + "sections": [ + { + "body": "Called after handling the given `ApplePayShippingMethodSelectedEvent` for the given basket. The given\nshipping method will have already been set on the basket. The basket will have already been calculated before\nthis hook is called.\n\nThe given response object will contain properties whose values are to be passed as parameters to the\n`ApplePaySession.completeShippingMethodSelection` event callback:\n\n- total - Updated total line item object\n- lineItems - Array of updated line item objects\n\nReturn a result with an error status to indicate a problem. See dw.extensions.applepay.ApplePayHookResult\nfor how to indicate error statuses with detail information to be provided to Apple Pay.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Apple\nPay payment sheet is canceled.\n\nSee the Apple Pay JS API Reference for more information.", + "heading": "Description" + } + ], + "signature": "shippingMethodSelected(basket: Basket, shippingMethod: ShippingMethod, event: Object, response: Object): ApplePayHookResult", + "source": "script-api", + "tags": [ + "shippingmethodselected", + "applepayhooks.shippingmethodselected" + ], + "title": "ApplePayHooks.shippingMethodSelected" + }, + { + "description": "2 declarations", + "id": "script-api:dw/extensions/facebook", + "kind": "package", + "packagePath": "dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook", + "source": "script-api", + "tags": [ + "dw/extensions/facebook", + "dw.extensions.facebook" + ], + "title": "dw.extensions.facebook" + }, + { + "description": "FacebookFeedHooks interface containing extension points for customizing Facebook export feeds.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.facebook.feed.transformProduct\", \"script\": \"./hooks.ds\"}\n]" + ], + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "kind": "interface", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks", + "sections": [ + { + "body": "FacebookFeedHooks interface containing extension points for customizing Facebook export feeds.\n\nThese hooks are not executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "facebookfeedhooks", + "dw.extensions.facebook.facebookfeedhooks", + "dw/extensions/facebook" + ], + "title": "FacebookFeedHooks" + }, + { + "description": "The extension point name extensionPointTransformProduct.", + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks#extensionPointTransformProduct", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks.extensionPointTransformProduct", + "sections": [ + { + "body": "The extension point name extensionPointTransformProduct.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointTransformProduct: \"dw.extensions.facebook.feed.transformProduct\"", + "source": "script-api", + "tags": [ + "extensionpointtransformproduct", + "facebookfeedhooks.extensionpointtransformproduct" + ], + "title": "FacebookFeedHooks.extensionPointTransformProduct" + }, + { + "description": "Called after default transformation of given Demandware product to Facebook product as part of the catalog feed export.", + "id": "script-api:dw/extensions/facebook/FacebookFeedHooks#transformProduct", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "facebookProduct", + "type": "FacebookProduct" + }, + { + "name": "feedId", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookFeedHooks", + "qualifiedName": "dw.extensions.facebook.FacebookFeedHooks.transformProduct", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after default transformation of given Demandware product to Facebook product as part of the catalog feed\nexport.\n\nTo customize multiple feeds differently, for example if one is for Facebook Dynamic Ads and the other is for\nInstagram Commerce, use the `feedId` parameter to determine which feed is being exported. If the same\ncustomization should apply to all feeds, ignore the parameter.", + "heading": "Description" + } + ], + "signature": "transformProduct(product: Product, facebookProduct: FacebookProduct, feedId: string): Status", + "source": "script-api", + "tags": [ + "transformproduct", + "facebookfeedhooks.transformproduct" + ], + "title": "FacebookFeedHooks.transformProduct" + }, + { + "description": "Represents a row in the Facebook catalog feed export.", + "id": "script-api:dw/extensions/facebook/FacebookProduct", + "kind": "class", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook", + "qualifiedName": "dw.extensions.facebook.FacebookProduct", + "sections": [ + { + "body": "Represents a row in the Facebook catalog feed export.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "facebookproduct", + "dw.extensions.facebook.facebookproduct", + "dw/extensions/facebook" + ], + "title": "FacebookProduct" + }, + { + "description": "Indicates that the product is for adults.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_ADULT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT", + "sections": [ + { + "body": "Indicates that the product is for adults.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_ADULT: string", + "source": "script-api", + "tags": [ + "age_group_adult", + "facebookproduct.age_group_adult" + ], + "title": "FacebookProduct.AGE_GROUP_ADULT" + }, + { + "description": "Indicates that the product is for adults.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_ADULT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT", + "sections": [ + { + "body": "Indicates that the product is for adults.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_ADULT: string", + "source": "script-api", + "tags": [ + "age_group_adult", + "facebookproduct.age_group_adult" + ], + "title": "FacebookProduct.AGE_GROUP_ADULT" + }, + { + "description": "Indicates that the product is for infant children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_INFANT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT", + "sections": [ + { + "body": "Indicates that the product is for infant children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_INFANT: string", + "source": "script-api", + "tags": [ + "age_group_infant", + "facebookproduct.age_group_infant" + ], + "title": "FacebookProduct.AGE_GROUP_INFANT" + }, + { + "description": "Indicates that the product is for infant children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_INFANT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT", + "sections": [ + { + "body": "Indicates that the product is for infant children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_INFANT: string", + "source": "script-api", + "tags": [ + "age_group_infant", + "facebookproduct.age_group_infant" + ], + "title": "FacebookProduct.AGE_GROUP_INFANT" + }, + { + "description": "Indicates that the product is for children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_KIDS", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS", + "sections": [ + { + "body": "Indicates that the product is for children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_KIDS: string", + "source": "script-api", + "tags": [ + "age_group_kids", + "facebookproduct.age_group_kids" + ], + "title": "FacebookProduct.AGE_GROUP_KIDS" + }, + { + "description": "Indicates that the product is for children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_KIDS", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS", + "sections": [ + { + "body": "Indicates that the product is for children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_KIDS: string", + "source": "script-api", + "tags": [ + "age_group_kids", + "facebookproduct.age_group_kids" + ], + "title": "FacebookProduct.AGE_GROUP_KIDS" + }, + { + "description": "Indicates that the product is for newborn children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_NEWBORN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN", + "sections": [ + { + "body": "Indicates that the product is for newborn children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_NEWBORN: string", + "source": "script-api", + "tags": [ + "age_group_newborn", + "facebookproduct.age_group_newborn" + ], + "title": "FacebookProduct.AGE_GROUP_NEWBORN" + }, + { + "description": "Indicates that the product is for newborn children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_NEWBORN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN", + "sections": [ + { + "body": "Indicates that the product is for newborn children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_NEWBORN: string", + "source": "script-api", + "tags": [ + "age_group_newborn", + "facebookproduct.age_group_newborn" + ], + "title": "FacebookProduct.AGE_GROUP_NEWBORN" + }, + { + "description": "Indicates that the product is for toddler children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_TODDLER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER", + "sections": [ + { + "body": "Indicates that the product is for toddler children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_TODDLER: string", + "source": "script-api", + "tags": [ + "age_group_toddler", + "facebookproduct.age_group_toddler" + ], + "title": "FacebookProduct.AGE_GROUP_TODDLER" + }, + { + "description": "Indicates that the product is for toddler children.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AGE_GROUP_TODDLER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER", + "sections": [ + { + "body": "Indicates that the product is for toddler children.", + "heading": "Description" + } + ], + "signature": "static readonly AGE_GROUP_TODDLER: string", + "source": "script-api", + "tags": [ + "age_group_toddler", + "facebookproduct.age_group_toddler" + ], + "title": "FacebookProduct.AGE_GROUP_TODDLER" + }, + { + "description": "Indicates that the product can be ordered for later shipment.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_AVAILABLE_FOR_ORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER", + "sections": [ + { + "body": "Indicates that the product can be ordered for later shipment.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_AVAILABLE_FOR_ORDER: string", + "source": "script-api", + "tags": [ + "availability_available_for_order", + "facebookproduct.availability_available_for_order" + ], + "title": "FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER" + }, + { + "description": "Indicates that the product can be ordered for later shipment.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_AVAILABLE_FOR_ORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER", + "sections": [ + { + "body": "Indicates that the product can be ordered for later shipment.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_AVAILABLE_FOR_ORDER: string", + "source": "script-api", + "tags": [ + "availability_available_for_order", + "facebookproduct.availability_available_for_order" + ], + "title": "FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER" + }, + { + "description": "Indicates that the product is available to ship immediately.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is available to ship immediately.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_in_stock", + "facebookproduct.availability_in_stock" + ], + "title": "FacebookProduct.AVAILABILITY_IN_STOCK" + }, + { + "description": "Indicates that the product is available to ship immediately.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is available to ship immediately.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_in_stock", + "facebookproduct.availability_in_stock" + ], + "title": "FacebookProduct.AVAILABILITY_IN_STOCK" + }, + { + "description": "Indicates that the product is out of stock.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK", + "sections": [ + { + "body": "Indicates that the product is out of stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_OUT_OF_STOCK: string", + "source": "script-api", + "tags": [ + "availability_out_of_stock", + "facebookproduct.availability_out_of_stock" + ], + "title": "FacebookProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "description": "Indicates that the product is out of stock.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK", + "sections": [ + { + "body": "Indicates that the product is out of stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_OUT_OF_STOCK: string", + "source": "script-api", + "tags": [ + "availability_out_of_stock", + "facebookproduct.availability_out_of_stock" + ], + "title": "FacebookProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "description": "Indicates that the product will be available in the future.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "sections": [ + { + "body": "Indicates that the product will be available in the future.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_preorder", + "facebookproduct.availability_preorder" + ], + "title": "FacebookProduct.AVAILABILITY_PREORDER" + }, + { + "description": "Indicates that the product will be available in the future.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "sections": [ + { + "body": "Indicates that the product will be available in the future.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_preorder", + "facebookproduct.availability_preorder" + ], + "title": "FacebookProduct.AVAILABILITY_PREORDER" + }, + { + "description": "Indicates that the product is new.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_NEW", + "sections": [ + { + "body": "Indicates that the product is new.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_NEW: string", + "source": "script-api", + "tags": [ + "condition_new", + "facebookproduct.condition_new" + ], + "title": "FacebookProduct.CONDITION_NEW" + }, + { + "description": "Indicates that the product is new.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_NEW", + "sections": [ + { + "body": "Indicates that the product is new.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_NEW: string", + "source": "script-api", + "tags": [ + "condition_new", + "facebookproduct.condition_new" + ], + "title": "FacebookProduct.CONDITION_NEW" + }, + { + "description": "Indicates that the product is used but has been refurbished.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED", + "sections": [ + { + "body": "Indicates that the product is used but has been refurbished.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_REFURBISHED: string", + "source": "script-api", + "tags": [ + "condition_refurbished", + "facebookproduct.condition_refurbished" + ], + "title": "FacebookProduct.CONDITION_REFURBISHED" + }, + { + "description": "Indicates that the product is used but has been refurbished.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED", + "sections": [ + { + "body": "Indicates that the product is used but has been refurbished.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_REFURBISHED: string", + "source": "script-api", + "tags": [ + "condition_refurbished", + "facebookproduct.condition_refurbished" + ], + "title": "FacebookProduct.CONDITION_REFURBISHED" + }, + { + "description": "Indicates that the product has been used.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_USED", + "sections": [ + { + "body": "Indicates that the product has been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_USED: string", + "source": "script-api", + "tags": [ + "condition_used", + "facebookproduct.condition_used" + ], + "title": "FacebookProduct.CONDITION_USED" + }, + { + "description": "Indicates that the product has been used.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.CONDITION_USED", + "sections": [ + { + "body": "Indicates that the product has been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_USED: string", + "source": "script-api", + "tags": [ + "condition_used", + "facebookproduct.condition_used" + ], + "title": "FacebookProduct.CONDITION_USED" + }, + { + "description": "Indicates that the product is for females.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_FEMALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_FEMALE", + "sections": [ + { + "body": "Indicates that the product is for females.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_FEMALE: string", + "source": "script-api", + "tags": [ + "gender_female", + "facebookproduct.gender_female" + ], + "title": "FacebookProduct.GENDER_FEMALE" + }, + { + "description": "Indicates that the product is for females.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_FEMALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_FEMALE", + "sections": [ + { + "body": "Indicates that the product is for females.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_FEMALE: string", + "source": "script-api", + "tags": [ + "gender_female", + "facebookproduct.gender_female" + ], + "title": "FacebookProduct.GENDER_FEMALE" + }, + { + "description": "Indicates that the product is for males.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_MALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_MALE", + "sections": [ + { + "body": "Indicates that the product is for males.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_MALE: string", + "source": "script-api", + "tags": [ + "gender_male", + "facebookproduct.gender_male" + ], + "title": "FacebookProduct.GENDER_MALE" + }, + { + "description": "Indicates that the product is for males.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_MALE", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_MALE", + "sections": [ + { + "body": "Indicates that the product is for males.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_MALE: string", + "source": "script-api", + "tags": [ + "gender_male", + "facebookproduct.gender_male" + ], + "title": "FacebookProduct.GENDER_MALE" + }, + { + "description": "Indicates that the product is for both males and females.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_UNISEX", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_UNISEX", + "sections": [ + { + "body": "Indicates that the product is for both males and females.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_UNISEX: string", + "source": "script-api", + "tags": [ + "gender_unisex", + "facebookproduct.gender_unisex" + ], + "title": "FacebookProduct.GENDER_UNISEX" + }, + { + "description": "Indicates that the product is for both males and females.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#GENDER_UNISEX", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.GENDER_UNISEX", + "sections": [ + { + "body": "Indicates that the product is for both males and females.", + "heading": "Description" + } + ], + "signature": "static readonly GENDER_UNISEX: string", + "source": "script-api", + "tags": [ + "gender_unisex", + "facebookproduct.gender_unisex" + ], + "title": "FacebookProduct.GENDER_UNISEX" + }, + { + "description": "Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#ID", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.ID", + "sections": [ + { + "body": "Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "facebookproduct.id" + ], + "title": "FacebookProduct.ID" + }, + { + "description": "Indicates that the product is measured in centimeters.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_CM", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_CM", + "sections": [ + { + "body": "Indicates that the product is measured in centimeters.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_CM: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_cm", + "facebookproduct.shipping_size_unit_cm" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_CM" + }, + { + "description": "Indicates that the product is measured in centimeters.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_CM", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_CM", + "sections": [ + { + "body": "Indicates that the product is measured in centimeters.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_CM: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_cm", + "facebookproduct.shipping_size_unit_cm" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_CM" + }, + { + "description": "Indicates that the product is measured in feet.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_FT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_FT", + "sections": [ + { + "body": "Indicates that the product is measured in feet.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_FT: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_ft", + "facebookproduct.shipping_size_unit_ft" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_FT" + }, + { + "description": "Indicates that the product is measured in feet.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_FT", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_FT", + "sections": [ + { + "body": "Indicates that the product is measured in feet.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_FT: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_ft", + "facebookproduct.shipping_size_unit_ft" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_FT" + }, + { + "description": "Indicates that the product is measured in inches.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_IN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_IN", + "sections": [ + { + "body": "Indicates that the product is measured in inches.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_IN: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_in", + "facebookproduct.shipping_size_unit_in" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_IN" + }, + { + "description": "Indicates that the product is measured in inches.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_IN", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_IN", + "sections": [ + { + "body": "Indicates that the product is measured in inches.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_IN: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_in", + "facebookproduct.shipping_size_unit_in" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_IN" + }, + { + "description": "Indicates that the product is measured in meters.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_M", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_M", + "sections": [ + { + "body": "Indicates that the product is measured in meters.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_M: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_m", + "facebookproduct.shipping_size_unit_m" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_M" + }, + { + "description": "Indicates that the product is measured in meters.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_SIZE_UNIT_M", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_SIZE_UNIT_M", + "sections": [ + { + "body": "Indicates that the product is measured in meters.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_SIZE_UNIT_M: string", + "source": "script-api", + "tags": [ + "shipping_size_unit_m", + "facebookproduct.shipping_size_unit_m" + ], + "title": "FacebookProduct.SHIPPING_SIZE_UNIT_M" + }, + { + "description": "Indicates that the product is weighed in grams.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_G", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G", + "sections": [ + { + "body": "Indicates that the product is weighed in grams.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_G: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_g", + "facebookproduct.shipping_weight_unit_g" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_G" + }, + { + "description": "Indicates that the product is weighed in grams.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_G", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G", + "sections": [ + { + "body": "Indicates that the product is weighed in grams.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_G: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_g", + "facebookproduct.shipping_weight_unit_g" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_G" + }, + { + "description": "Indicates that the product is weighed in kilograms.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_KG", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG", + "sections": [ + { + "body": "Indicates that the product is weighed in kilograms.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_KG: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_kg", + "facebookproduct.shipping_weight_unit_kg" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_KG" + }, + { + "description": "Indicates that the product is weighed in kilograms.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_KG", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG", + "sections": [ + { + "body": "Indicates that the product is weighed in kilograms.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_KG: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_kg", + "facebookproduct.shipping_weight_unit_kg" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_KG" + }, + { + "description": "Indicates that the product is weighed in pounds.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_LB", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB", + "sections": [ + { + "body": "Indicates that the product is weighed in pounds.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_LB: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_lb", + "facebookproduct.shipping_weight_unit_lb" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_LB" + }, + { + "description": "Indicates that the product is weighed in pounds.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_LB", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB", + "sections": [ + { + "body": "Indicates that the product is weighed in pounds.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_LB: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_lb", + "facebookproduct.shipping_weight_unit_lb" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_LB" + }, + { + "description": "Indicates that the product is weighed in ounces.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_OZ", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ", + "sections": [ + { + "body": "Indicates that the product is weighed in ounces.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_OZ: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_oz", + "facebookproduct.shipping_weight_unit_oz" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ" + }, + { + "description": "Indicates that the product is weighed in ounces.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#SHIPPING_WEIGHT_UNIT_OZ", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ", + "sections": [ + { + "body": "Indicates that the product is weighed in ounces.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_WEIGHT_UNIT_OZ: string", + "source": "script-api", + "tags": [ + "shipping_weight_unit_oz", + "facebookproduct.shipping_weight_unit_oz" + ], + "title": "FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ" + }, + { + "description": "Returns the age group for the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#ageGroup", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.ageGroup", + "sections": [ + { + "body": "Returns the age group for the Facebook product.", + "heading": "Description" + } + ], + "signature": "ageGroup: string", + "source": "script-api", + "tags": [ + "agegroup", + "facebookproduct.agegroup" + ], + "title": "FacebookProduct.ageGroup" + }, + { + "description": "Returns the availability of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#availability", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.availability", + "sections": [ + { + "body": "Returns the availability of the Facebook product.", + "heading": "Description" + } + ], + "signature": "availability: string", + "source": "script-api", + "tags": [ + "availability", + "facebookproduct.availability" + ], + "title": "FacebookProduct.availability" + }, + { + "description": "Returns the Facebook brand of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#brand", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.brand", + "sections": [ + { + "body": "Returns the Facebook brand of the product.", + "heading": "Description" + } + ], + "signature": "brand: string", + "source": "script-api", + "tags": [ + "brand", + "facebookproduct.brand" + ], + "title": "FacebookProduct.brand" + }, + { + "description": "Returns the Facebook color value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#color", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.color", + "sections": [ + { + "body": "Returns the Facebook color value label of the product.", + "heading": "Description" + } + ], + "signature": "color: string", + "source": "script-api", + "tags": [ + "color", + "facebookproduct.color" + ], + "title": "FacebookProduct.color" + }, + { + "description": "Returns the condition of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#condition", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.condition", + "sections": [ + { + "body": "Returns the condition of the Facebook product.", + "heading": "Description" + } + ], + "signature": "condition: string", + "source": "script-api", + "tags": [ + "condition", + "facebookproduct.condition" + ], + "title": "FacebookProduct.condition" + }, + { + "description": "Returns the Facebook custom label 0 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel0", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel0", + "sections": [ + { + "body": "Returns the Facebook custom label 0 value of the product.", + "heading": "Description" + } + ], + "signature": "customLabel0: string", + "source": "script-api", + "tags": [ + "customlabel0", + "facebookproduct.customlabel0" + ], + "title": "FacebookProduct.customLabel0" + }, + { + "description": "Returns the Facebook custom label 1 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel1", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel1", + "sections": [ + { + "body": "Returns the Facebook custom label 1 value of the product.", + "heading": "Description" + } + ], + "signature": "customLabel1: string", + "source": "script-api", + "tags": [ + "customlabel1", + "facebookproduct.customlabel1" + ], + "title": "FacebookProduct.customLabel1" + }, + { + "description": "Returns the Facebook custom label 2 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel2", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel2", + "sections": [ + { + "body": "Returns the Facebook custom label 2 value of the product.", + "heading": "Description" + } + ], + "signature": "customLabel2: string", + "source": "script-api", + "tags": [ + "customlabel2", + "facebookproduct.customlabel2" + ], + "title": "FacebookProduct.customLabel2" + }, + { + "description": "Returns the Facebook custom label 3 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel3", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel3", + "sections": [ + { + "body": "Returns the Facebook custom label 3 value of the product.", + "heading": "Description" + } + ], + "signature": "customLabel3: string", + "source": "script-api", + "tags": [ + "customlabel3", + "facebookproduct.customlabel3" + ], + "title": "FacebookProduct.customLabel3" + }, + { + "description": "Returns the Facebook custom label 4 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#customLabel4", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.customLabel4", + "sections": [ + { + "body": "Returns the Facebook custom label 4 value of the product.", + "heading": "Description" + } + ], + "signature": "customLabel4: string", + "source": "script-api", + "tags": [ + "customlabel4", + "facebookproduct.customlabel4" + ], + "title": "FacebookProduct.customLabel4" + }, + { + "description": "Returns the description of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#description", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.description", + "sections": [ + { + "body": "Returns the description of the Facebook product.", + "heading": "Description" + } + ], + "signature": "description: string", + "source": "script-api", + "tags": [ + "description", + "facebookproduct.description" + ], + "title": "FacebookProduct.description" + }, + { + "description": "Returns the Facebook expiration date of the product. If the product is expired it will not be shown.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#expirationDate", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.expirationDate", + "sections": [ + { + "body": "Returns the Facebook expiration date of the product. If the product is expired it will not be shown.", + "heading": "Description" + } + ], + "signature": "expirationDate: Date", + "source": "script-api", + "tags": [ + "expirationdate", + "facebookproduct.expirationdate" + ], + "title": "FacebookProduct.expirationDate" + }, + { + "description": "Returns the gender for the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#gender", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.gender", + "sections": [ + { + "body": "Returns the gender for the Facebook product.", + "heading": "Description" + } + ], + "signature": "gender: string", + "source": "script-api", + "tags": [ + "gender", + "facebookproduct.gender" + ], + "title": "FacebookProduct.gender" + }, + { + "description": "Returns the age group for the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getAgeGroup", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getAgeGroup", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the age group for the Facebook product.", + "heading": "Description" + } + ], + "signature": "getAgeGroup(): string", + "source": "script-api", + "tags": [ + "getagegroup", + "facebookproduct.getagegroup" + ], + "title": "FacebookProduct.getAgeGroup" + }, + { + "description": "Returns the availability of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getAvailability", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the availability of the Facebook product.", + "heading": "Description" + } + ], + "signature": "getAvailability(): string", + "source": "script-api", + "tags": [ + "getavailability", + "facebookproduct.getavailability" + ], + "title": "FacebookProduct.getAvailability" + }, + { + "description": "Returns the Facebook brand of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getBrand", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getBrand", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook brand of the product.", + "heading": "Description" + } + ], + "signature": "getBrand(): string", + "source": "script-api", + "tags": [ + "getbrand", + "facebookproduct.getbrand" + ], + "title": "FacebookProduct.getBrand" + }, + { + "description": "Returns the Facebook color value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getColor", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getColor", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook color value label of the product.", + "heading": "Description" + } + ], + "signature": "getColor(): string", + "source": "script-api", + "tags": [ + "getcolor", + "facebookproduct.getcolor" + ], + "title": "FacebookProduct.getColor" + }, + { + "description": "Returns the condition of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCondition", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCondition", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the condition of the Facebook product.", + "heading": "Description" + } + ], + "signature": "getCondition(): string", + "source": "script-api", + "tags": [ + "getcondition", + "facebookproduct.getcondition" + ], + "title": "FacebookProduct.getCondition" + }, + { + "description": "Returns the Facebook custom label 0 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel0", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel0", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook custom label 0 value of the product.", + "heading": "Description" + } + ], + "signature": "getCustomLabel0(): string", + "source": "script-api", + "tags": [ + "getcustomlabel0", + "facebookproduct.getcustomlabel0" + ], + "title": "FacebookProduct.getCustomLabel0" + }, + { + "description": "Returns the Facebook custom label 1 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel1", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook custom label 1 value of the product.", + "heading": "Description" + } + ], + "signature": "getCustomLabel1(): string", + "source": "script-api", + "tags": [ + "getcustomlabel1", + "facebookproduct.getcustomlabel1" + ], + "title": "FacebookProduct.getCustomLabel1" + }, + { + "description": "Returns the Facebook custom label 2 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel2", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook custom label 2 value of the product.", + "heading": "Description" + } + ], + "signature": "getCustomLabel2(): string", + "source": "script-api", + "tags": [ + "getcustomlabel2", + "facebookproduct.getcustomlabel2" + ], + "title": "FacebookProduct.getCustomLabel2" + }, + { + "description": "Returns the Facebook custom label 3 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel3", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel3", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook custom label 3 value of the product.", + "heading": "Description" + } + ], + "signature": "getCustomLabel3(): string", + "source": "script-api", + "tags": [ + "getcustomlabel3", + "facebookproduct.getcustomlabel3" + ], + "title": "FacebookProduct.getCustomLabel3" + }, + { + "description": "Returns the Facebook custom label 4 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getCustomLabel4", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getCustomLabel4", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook custom label 4 value of the product.", + "heading": "Description" + } + ], + "signature": "getCustomLabel4(): string", + "source": "script-api", + "tags": [ + "getcustomlabel4", + "facebookproduct.getcustomlabel4" + ], + "title": "FacebookProduct.getCustomLabel4" + }, + { + "description": "Returns the description of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getDescription", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description of the Facebook product.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "facebookproduct.getdescription" + ], + "title": "FacebookProduct.getDescription" + }, + { + "description": "Returns the Facebook expiration date of the product. If the product is expired it will not be shown.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getExpirationDate", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getExpirationDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the Facebook expiration date of the product. If the product is expired it will not be shown.", + "heading": "Description" + } + ], + "signature": "getExpirationDate(): Date", + "source": "script-api", + "tags": [ + "getexpirationdate", + "facebookproduct.getexpirationdate" + ], + "title": "FacebookProduct.getExpirationDate" + }, + { + "description": "Returns the gender for the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGender", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGender", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the gender for the Facebook product.", + "heading": "Description" + } + ], + "signature": "getGender(): string", + "source": "script-api", + "tags": [ + "getgender", + "facebookproduct.getgender" + ], + "title": "FacebookProduct.getGender" + }, + { + "description": "Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGoogleProductCategory", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters\nit is truncated.", + "heading": "Description" + } + ], + "signature": "getGoogleProductCategory(): string", + "source": "script-api", + "tags": [ + "getgoogleproductcategory", + "facebookproduct.getgoogleproductcategory" + ], + "title": "FacebookProduct.getGoogleProductCategory" + }, + { + "description": "Returns the Facebook GTIN of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getGtin", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getGtin", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook GTIN of the product.", + "heading": "Description" + } + ], + "signature": "getGtin(): string", + "source": "script-api", + "tags": [ + "getgtin", + "facebookproduct.getgtin" + ], + "title": "FacebookProduct.getGtin" + }, + { + "description": "Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "facebookproduct.getid" + ], + "title": "FacebookProduct.getID" + }, + { + "description": "Returns a list containing the URLs of the images to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getImageLinks", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getImageLinks", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list containing the URLs of the images to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "getImageLinks(): List", + "source": "script-api", + "tags": [ + "getimagelinks", + "facebookproduct.getimagelinks" + ], + "title": "FacebookProduct.getImageLinks" + }, + { + "description": "Returns the ID of the Facebook item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getItemGroupID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Facebook item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "getItemGroupID(): string", + "source": "script-api", + "tags": [ + "getitemgroupid", + "facebookproduct.getitemgroupid" + ], + "title": "FacebookProduct.getItemGroupID" + }, + { + "description": "Returns the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getLink", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getLink", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "getLink(): URL", + "source": "script-api", + "tags": [ + "getlink", + "facebookproduct.getlink" + ], + "title": "FacebookProduct.getLink" + }, + { + "description": "Returns the Facebook material value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getMaterial", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getMaterial", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook material value label of the product.", + "heading": "Description" + } + ], + "signature": "getMaterial(): string", + "source": "script-api", + "tags": [ + "getmaterial", + "facebookproduct.getmaterial" + ], + "title": "FacebookProduct.getMaterial" + }, + { + "description": "Returns the Facebook MPN of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getMpn", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getMpn", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook MPN of the product.", + "heading": "Description" + } + ], + "signature": "getMpn(): string", + "source": "script-api", + "tags": [ + "getmpn", + "facebookproduct.getmpn" + ], + "title": "FacebookProduct.getMpn" + }, + { + "description": "Returns the Facebook pattern value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getPattern", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getPattern", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook pattern value label of the product.", + "heading": "Description" + } + ], + "signature": "getPattern(): string", + "source": "script-api", + "tags": [ + "getpattern", + "facebookproduct.getpattern" + ], + "title": "FacebookProduct.getPattern" + }, + { + "description": "Returns the price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getPrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "getPrice(): Money", + "source": "script-api", + "tags": [ + "getprice", + "facebookproduct.getprice" + ], + "title": "FacebookProduct.getPrice" + }, + { + "description": "Returns the Facebook product type. This is the retailer-defined category of the item.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getProductType", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getProductType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook product type. This is the retailer-defined category of the item.", + "heading": "Description" + } + ], + "signature": "getProductType(): string", + "source": "script-api", + "tags": [ + "getproducttype", + "facebookproduct.getproducttype" + ], + "title": "FacebookProduct.getProductType" + }, + { + "description": "Returns the sale price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sale price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "getSalePrice(): Money", + "source": "script-api", + "tags": [ + "getsaleprice", + "facebookproduct.getsaleprice" + ], + "title": "FacebookProduct.getSalePrice" + }, + { + "description": "Returns the end date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePriceEffectiveDateEnd", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePriceEffectiveDateEnd", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the end date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "getSalePriceEffectiveDateEnd(): Date", + "source": "script-api", + "tags": [ + "getsalepriceeffectivedateend", + "facebookproduct.getsalepriceeffectivedateend" + ], + "title": "FacebookProduct.getSalePriceEffectiveDateEnd" + }, + { + "description": "Returns the start date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSalePriceEffectiveDateStart", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSalePriceEffectiveDateStart", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the start date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "getSalePriceEffectiveDateStart(): Date", + "source": "script-api", + "tags": [ + "getsalepriceeffectivedatestart", + "facebookproduct.getsalepriceeffectivedatestart" + ], + "title": "FacebookProduct.getSalePriceEffectiveDateStart" + }, + { + "description": "Returns the shipping height of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingHeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingHeight", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the shipping height of the product.", + "heading": "Description" + } + ], + "signature": "getShippingHeight(): number", + "source": "script-api", + "tags": [ + "getshippingheight", + "facebookproduct.getshippingheight" + ], + "title": "FacebookProduct.getShippingHeight" + }, + { + "description": "Returns the shipping length of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingLength", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the shipping length of the product.", + "heading": "Description" + } + ], + "signature": "getShippingLength(): number", + "source": "script-api", + "tags": [ + "getshippinglength", + "facebookproduct.getshippinglength" + ], + "title": "FacebookProduct.getShippingLength" + }, + { + "description": "Returns the shipping size unit of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingSizeUnit", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingSizeUnit", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping size unit of the product.", + "heading": "Description" + } + ], + "signature": "getShippingSizeUnit(): string", + "source": "script-api", + "tags": [ + "getshippingsizeunit", + "facebookproduct.getshippingsizeunit" + ], + "title": "FacebookProduct.getShippingSizeUnit" + }, + { + "description": "Returns the shipping weight for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingWeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingWeight", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the shipping weight for the product.", + "heading": "Description" + } + ], + "signature": "getShippingWeight(): Quantity", + "source": "script-api", + "tags": [ + "getshippingweight", + "facebookproduct.getshippingweight" + ], + "title": "FacebookProduct.getShippingWeight" + }, + { + "description": "Returns the shipping width of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getShippingWidth", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getShippingWidth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the shipping width of the product.", + "heading": "Description" + } + ], + "signature": "getShippingWidth(): number", + "source": "script-api", + "tags": [ + "getshippingwidth", + "facebookproduct.getshippingwidth" + ], + "title": "FacebookProduct.getShippingWidth" + }, + { + "description": "Returns the Facebook size value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getSize", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getSize", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Facebook size value label of the product.", + "heading": "Description" + } + ], + "signature": "getSize(): string", + "source": "script-api", + "tags": [ + "getsize", + "facebookproduct.getsize" + ], + "title": "FacebookProduct.getSize" + }, + { + "description": "Returns the title of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#getTitle", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the title of the Facebook product.", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "facebookproduct.gettitle" + ], + "title": "FacebookProduct.getTitle" + }, + { + "description": "Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#googleProductCategory", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.googleProductCategory", + "sections": [ + { + "body": "Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters\nit is truncated.", + "heading": "Description" + } + ], + "signature": "googleProductCategory: string", + "source": "script-api", + "tags": [ + "googleproductcategory", + "facebookproduct.googleproductcategory" + ], + "title": "FacebookProduct.googleProductCategory" + }, + { + "description": "Returns the Facebook GTIN of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#gtin", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.gtin", + "sections": [ + { + "body": "Returns the Facebook GTIN of the product.", + "heading": "Description" + } + ], + "signature": "gtin: string", + "source": "script-api", + "tags": [ + "gtin", + "facebookproduct.gtin" + ], + "title": "FacebookProduct.gtin" + }, + { + "description": "Returns a list containing the URLs of the images to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#imageLinks", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.imageLinks", + "sections": [ + { + "body": "Returns a list containing the URLs of the images to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "imageLinks: List", + "source": "script-api", + "tags": [ + "imagelinks", + "facebookproduct.imagelinks" + ], + "title": "FacebookProduct.imageLinks" + }, + { + "description": "Returns the ID of the Facebook item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#itemGroupID", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.itemGroupID", + "sections": [ + { + "body": "Returns the ID of the Facebook item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "itemGroupID: string", + "source": "script-api", + "tags": [ + "itemgroupid", + "facebookproduct.itemgroupid" + ], + "title": "FacebookProduct.itemGroupID" + }, + { + "description": "Returns the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#link", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.link", + "sections": [ + { + "body": "Returns the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "link: URL", + "source": "script-api", + "tags": [ + "link", + "facebookproduct.link" + ], + "title": "FacebookProduct.link" + }, + { + "description": "Returns the Facebook material value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#material", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.material", + "sections": [ + { + "body": "Returns the Facebook material value label of the product.", + "heading": "Description" + } + ], + "signature": "material: string", + "source": "script-api", + "tags": [ + "material", + "facebookproduct.material" + ], + "title": "FacebookProduct.material" + }, + { + "description": "Returns the Facebook MPN of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#mpn", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.mpn", + "sections": [ + { + "body": "Returns the Facebook MPN of the product.", + "heading": "Description" + } + ], + "signature": "mpn: string", + "source": "script-api", + "tags": [ + "mpn", + "facebookproduct.mpn" + ], + "title": "FacebookProduct.mpn" + }, + { + "description": "Returns the Facebook pattern value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#pattern", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.pattern", + "sections": [ + { + "body": "Returns the Facebook pattern value label of the product.", + "heading": "Description" + } + ], + "signature": "pattern: string", + "source": "script-api", + "tags": [ + "pattern", + "facebookproduct.pattern" + ], + "title": "FacebookProduct.pattern" + }, + { + "description": "Returns the price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#price", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.price", + "sections": [ + { + "body": "Returns the price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "price: Money", + "source": "script-api", + "tags": [ + "price", + "facebookproduct.price" + ], + "title": "FacebookProduct.price" + }, + { + "description": "Returns the Facebook product type. This is the retailer-defined category of the item.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#productType", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.productType", + "sections": [ + { + "body": "Returns the Facebook product type. This is the retailer-defined category of the item.", + "heading": "Description" + } + ], + "signature": "productType: string", + "source": "script-api", + "tags": [ + "producttype", + "facebookproduct.producttype" + ], + "title": "FacebookProduct.productType" + }, + { + "description": "Returns the sale price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePrice", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePrice", + "sections": [ + { + "body": "Returns the sale price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "salePrice: Money", + "source": "script-api", + "tags": [ + "saleprice", + "facebookproduct.saleprice" + ], + "title": "FacebookProduct.salePrice" + }, + { + "description": "Returns the end date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePriceEffectiveDateEnd", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePriceEffectiveDateEnd", + "sections": [ + { + "body": "Returns the end date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "salePriceEffectiveDateEnd: Date", + "source": "script-api", + "tags": [ + "salepriceeffectivedateend", + "facebookproduct.salepriceeffectivedateend" + ], + "title": "FacebookProduct.salePriceEffectiveDateEnd" + }, + { + "description": "Returns the start date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#salePriceEffectiveDateStart", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.salePriceEffectiveDateStart", + "sections": [ + { + "body": "Returns the start date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "salePriceEffectiveDateStart: Date", + "source": "script-api", + "tags": [ + "salepriceeffectivedatestart", + "facebookproduct.salepriceeffectivedatestart" + ], + "title": "FacebookProduct.salePriceEffectiveDateStart" + }, + { + "description": "Sets the age group for the Facebook product. Possible values are dw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT, dw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT, dw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS, dw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN, dw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER, or `null`.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setAgeGroup", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "ageGroup", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setAgeGroup", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the age group for the Facebook product. Possible values are\ndw.extensions.facebook.FacebookProduct.AGE_GROUP_ADULT,\ndw.extensions.facebook.FacebookProduct.AGE_GROUP_INFANT,\ndw.extensions.facebook.FacebookProduct.AGE_GROUP_KIDS,\ndw.extensions.facebook.FacebookProduct.AGE_GROUP_NEWBORN,\ndw.extensions.facebook.FacebookProduct.AGE_GROUP_TODDLER, or `null`.", + "heading": "Description" + } + ], + "signature": "setAgeGroup(ageGroup: string): void", + "source": "script-api", + "tags": [ + "setagegroup", + "facebookproduct.setagegroup" + ], + "title": "FacebookProduct.setAgeGroup" + }, + { + "description": "Sets the availability of the Facebook product. Possible values are dw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER, dw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK, dw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK, or dw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "availability", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setAvailability", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the availability of the Facebook product. Possible values are\ndw.extensions.facebook.FacebookProduct.AVAILABILITY_AVAILABLE_FOR_ORDER,\ndw.extensions.facebook.FacebookProduct.AVAILABILITY_IN_STOCK,\ndw.extensions.facebook.FacebookProduct.AVAILABILITY_OUT_OF_STOCK, or\ndw.extensions.facebook.FacebookProduct.AVAILABILITY_PREORDER", + "heading": "Description" + } + ], + "signature": "setAvailability(availability: string): void", + "source": "script-api", + "tags": [ + "setavailability", + "facebookproduct.setavailability" + ], + "title": "FacebookProduct.setAvailability" + }, + { + "description": "Sets the Facebook brand of the product. If the value is longer than 70 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setBrand", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "brand", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setBrand", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook brand of the product. If the value is longer than 70 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setBrand(brand: string): void", + "source": "script-api", + "tags": [ + "setbrand", + "facebookproduct.setbrand" + ], + "title": "FacebookProduct.setBrand" + }, + { + "description": "Sets the Facebook color value label of the product. If the value is longer than 100 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setColor", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "color", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setColor", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook color value label of the product. If the value is longer than 100 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setColor(color: string): void", + "source": "script-api", + "tags": [ + "setcolor", + "facebookproduct.setcolor" + ], + "title": "FacebookProduct.setColor" + }, + { + "description": "Sets the condition of the Facebook product. Possible values are dw.extensions.facebook.FacebookProduct.CONDITION_NEW, dw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED, or dw.extensions.facebook.FacebookProduct.CONDITION_USED.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCondition", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "condition", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCondition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the condition of the Facebook product. Possible values are\ndw.extensions.facebook.FacebookProduct.CONDITION_NEW,\ndw.extensions.facebook.FacebookProduct.CONDITION_REFURBISHED, or\ndw.extensions.facebook.FacebookProduct.CONDITION_USED.", + "heading": "Description" + } + ], + "signature": "setCondition(condition: string): void", + "source": "script-api", + "tags": [ + "setcondition", + "facebookproduct.setcondition" + ], + "title": "FacebookProduct.setCondition" + }, + { + "description": "Sets the Facebook custom label 0 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel0", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "customLabel0", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel0", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook custom label 0 value of the product.", + "heading": "Description" + } + ], + "signature": "setCustomLabel0(customLabel0: string): void", + "source": "script-api", + "tags": [ + "setcustomlabel0", + "facebookproduct.setcustomlabel0" + ], + "title": "FacebookProduct.setCustomLabel0" + }, + { + "description": "Sets the Facebook custom label 1 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel1", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "customLabel1", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel1", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook custom label 1 value of the product.", + "heading": "Description" + } + ], + "signature": "setCustomLabel1(customLabel1: string): void", + "source": "script-api", + "tags": [ + "setcustomlabel1", + "facebookproduct.setcustomlabel1" + ], + "title": "FacebookProduct.setCustomLabel1" + }, + { + "description": "Sets the Facebook custom label 2 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel2", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "customLabel2", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel2", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook custom label 2 value of the product.", + "heading": "Description" + } + ], + "signature": "setCustomLabel2(customLabel2: string): void", + "source": "script-api", + "tags": [ + "setcustomlabel2", + "facebookproduct.setcustomlabel2" + ], + "title": "FacebookProduct.setCustomLabel2" + }, + { + "description": "Sets the Facebook custom label 3 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel3", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "customLabel3", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel3", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook custom label 3 value of the product.", + "heading": "Description" + } + ], + "signature": "setCustomLabel3(customLabel3: string): void", + "source": "script-api", + "tags": [ + "setcustomlabel3", + "facebookproduct.setcustomlabel3" + ], + "title": "FacebookProduct.setCustomLabel3" + }, + { + "description": "Sets the Facebook custom label 4 value of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setCustomLabel4", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "customLabel4", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setCustomLabel4", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook custom label 4 value of the product.", + "heading": "Description" + } + ], + "signature": "setCustomLabel4(customLabel4: string): void", + "source": "script-api", + "tags": [ + "setcustomlabel4", + "facebookproduct.setcustomlabel4" + ], + "title": "FacebookProduct.setCustomLabel4" + }, + { + "description": "Sets the description of the Facebook product. If the value is longer than 5000 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setDescription", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "description", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the description of the Facebook product. If the value is longer than 5000 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setDescription(description: string): void", + "source": "script-api", + "tags": [ + "setdescription", + "facebookproduct.setdescription" + ], + "title": "FacebookProduct.setDescription" + }, + { + "description": "Sets the Facebook expiration date of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setExpirationDate", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "expirationDate", + "type": "Date" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setExpirationDate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook expiration date of the product.", + "heading": "Description" + } + ], + "signature": "setExpirationDate(expirationDate: Date): void", + "source": "script-api", + "tags": [ + "setexpirationdate", + "facebookproduct.setexpirationdate" + ], + "title": "FacebookProduct.setExpirationDate" + }, + { + "description": "Sets the gender for the Facebook product. Possible values are dw.extensions.facebook.FacebookProduct.GENDER_MALE, dw.extensions.facebook.FacebookProduct.GENDER_FEMALE, dw.extensions.facebook.FacebookProduct.GENDER_UNISEX, or `null`.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGender", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "gender", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGender", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the gender for the Facebook product. Possible values are\ndw.extensions.facebook.FacebookProduct.GENDER_MALE,\ndw.extensions.facebook.FacebookProduct.GENDER_FEMALE,\ndw.extensions.facebook.FacebookProduct.GENDER_UNISEX, or `null`.", + "heading": "Description" + } + ], + "signature": "setGender(gender: string): void", + "source": "script-api", + "tags": [ + "setgender", + "facebookproduct.setgender" + ], + "title": "FacebookProduct.setGender" + }, + { + "description": "Sets the category of this product in the Google category taxonomy.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "googleProductCategory", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGoogleProductCategory", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the category of this product in the Google category taxonomy.", + "heading": "Description" + } + ], + "signature": "setGoogleProductCategory(googleProductCategory: string): void", + "source": "script-api", + "tags": [ + "setgoogleproductcategory", + "facebookproduct.setgoogleproductcategory" + ], + "title": "FacebookProduct.setGoogleProductCategory" + }, + { + "description": "Sets the Facebook GTIN of the product. If the value is longer than 70 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setGtin", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "gtin", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setGtin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook GTIN of the product. If the value is longer than 70 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setGtin(gtin: string): void", + "source": "script-api", + "tags": [ + "setgtin", + "facebookproduct.setgtin" + ], + "title": "FacebookProduct.setGtin" + }, + { + "description": "Sets the list of URLs of images to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setImageLinks", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "imageLinks", + "type": "List" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setImageLinks", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the list of URLs of images to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "setImageLinks(imageLinks: List): void", + "source": "script-api", + "tags": [ + "setimagelinks", + "facebookproduct.setimagelinks" + ], + "title": "FacebookProduct.setImageLinks" + }, + { + "description": "Sets the ID of the Facebook item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "itemGroupID", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setItemGroupID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the ID of the Facebook item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "setItemGroupID(itemGroupID: string): void", + "source": "script-api", + "tags": [ + "setitemgroupid", + "facebookproduct.setitemgroupid" + ], + "title": "FacebookProduct.setItemGroupID" + }, + { + "description": "Sets the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setLink", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "link", + "type": "URL" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setLink", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "setLink(link: URL): void", + "source": "script-api", + "tags": [ + "setlink", + "facebookproduct.setlink" + ], + "title": "FacebookProduct.setLink" + }, + { + "description": "Sets the Facebook material value label of the product. If the value is longer than 200 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setMaterial", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "material", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setMaterial", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook material value label of the product. If the value is longer than 200 characters it is\ntruncated.", + "heading": "Description" + } + ], + "signature": "setMaterial(material: string): void", + "source": "script-api", + "tags": [ + "setmaterial", + "facebookproduct.setmaterial" + ], + "title": "FacebookProduct.setMaterial" + }, + { + "description": "Sets the Facebook MPN of the product. If the value is longer than 70 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setMpn", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "mpn", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setMpn", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook MPN of the product. If the value is longer than 70 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setMpn(mpn: string): void", + "source": "script-api", + "tags": [ + "setmpn", + "facebookproduct.setmpn" + ], + "title": "FacebookProduct.setMpn" + }, + { + "description": "Sets the Facebook pattern value label of the product. If the value is longer than 100 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setPattern", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "pattern", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setPattern", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook pattern value label of the product. If the value is longer than 100 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setPattern(pattern: string): void", + "source": "script-api", + "tags": [ + "setpattern", + "facebookproduct.setpattern" + ], + "title": "FacebookProduct.setPattern" + }, + { + "description": "Sets the price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setPrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "price", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "setPrice(price: Money): void", + "source": "script-api", + "tags": [ + "setprice", + "facebookproduct.setprice" + ], + "title": "FacebookProduct.setPrice" + }, + { + "description": "Sets the Facebook product type. If the value is longer than 750 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setProductType", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "productType", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setProductType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook product type. If the value is longer than 750 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setProductType(productType: string): void", + "source": "script-api", + "tags": [ + "setproducttype", + "facebookproduct.setproducttype" + ], + "title": "FacebookProduct.setProductType" + }, + { + "description": "Sets the sale price to show in Facebook for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePrice", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "salePrice", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sale price to show in Facebook for the product.", + "heading": "Description" + } + ], + "signature": "setSalePrice(salePrice: Money): void", + "source": "script-api", + "tags": [ + "setsaleprice", + "facebookproduct.setsaleprice" + ], + "title": "FacebookProduct.setSalePrice" + }, + { + "description": "Sets the end date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePriceEffectiveDateEnd", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "salePriceEffectiveDateEnd", + "type": "Date" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePriceEffectiveDateEnd", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the end date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "setSalePriceEffectiveDateEnd(salePriceEffectiveDateEnd: Date): void", + "source": "script-api", + "tags": [ + "setsalepriceeffectivedateend", + "facebookproduct.setsalepriceeffectivedateend" + ], + "title": "FacebookProduct.setSalePriceEffectiveDateEnd" + }, + { + "description": "Sets the start date of the Facebook sale price of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSalePriceEffectiveDateStart", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "salePriceEffectiveDateStart", + "type": "Date" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSalePriceEffectiveDateStart", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the start date of the Facebook sale price of the product.", + "heading": "Description" + } + ], + "signature": "setSalePriceEffectiveDateStart(salePriceEffectiveDateStart: Date): void", + "source": "script-api", + "tags": [ + "setsalepriceeffectivedatestart", + "facebookproduct.setsalepriceeffectivedatestart" + ], + "title": "FacebookProduct.setSalePriceEffectiveDateStart" + }, + { + "description": "Sets the shipping height of the product. If the value is negative it is truncated to 0.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingHeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "shippingHeight", + "type": "number" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingHeight", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping height of the product. If the value is negative it is truncated to 0.", + "heading": "Description" + } + ], + "signature": "setShippingHeight(shippingHeight: number): void", + "source": "script-api", + "tags": [ + "setshippingheight", + "facebookproduct.setshippingheight" + ], + "title": "FacebookProduct.setShippingHeight" + }, + { + "description": "Sets the shipping length of the product. If the value is negative it is truncated to 0.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingLength", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "shippingLength", + "type": "number" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingLength", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping length of the product. If the value is negative it is truncated to 0.", + "heading": "Description" + } + ], + "signature": "setShippingLength(shippingLength: number): void", + "source": "script-api", + "tags": [ + "setshippinglength", + "facebookproduct.setshippinglength" + ], + "title": "FacebookProduct.setShippingLength" + }, + { + "description": "Sets the shipping size unit of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingSizeUnit", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "shippingSizeUnit", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingSizeUnit", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping size unit of the product.", + "heading": "Description" + } + ], + "signature": "setShippingSizeUnit(shippingSizeUnit: string): void", + "source": "script-api", + "tags": [ + "setshippingsizeunit", + "facebookproduct.setshippingsizeunit" + ], + "title": "FacebookProduct.setShippingSizeUnit" + }, + { + "description": "Sets the shipping weight for the product. Possible unit values are dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB, dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ, dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G, or dw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingWeight", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "shippingWeight", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingWeight", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping weight for the product. Possible unit values are\ndw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_LB,\ndw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_OZ,\ndw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_G, or\ndw.extensions.facebook.FacebookProduct.SHIPPING_WEIGHT_UNIT_KG.", + "heading": "Description" + } + ], + "signature": "setShippingWeight(shippingWeight: Quantity): void", + "source": "script-api", + "tags": [ + "setshippingweight", + "facebookproduct.setshippingweight" + ], + "title": "FacebookProduct.setShippingWeight" + }, + { + "description": "Sets the shipping width of the product. If the value is negative it is truncated to 0.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setShippingWidth", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "shippingWidth", + "type": "number" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setShippingWidth", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping width of the product. If the value is negative it is truncated to 0.", + "heading": "Description" + } + ], + "signature": "setShippingWidth(shippingWidth: number): void", + "source": "script-api", + "tags": [ + "setshippingwidth", + "facebookproduct.setshippingwidth" + ], + "title": "FacebookProduct.setShippingWidth" + }, + { + "description": "Sets the Facebook size value label of the product. If the value is longer than 100 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setSize", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "size", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setSize", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Facebook size value label of the product. If the value is longer than 100 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setSize(size: string): void", + "source": "script-api", + "tags": [ + "setsize", + "facebookproduct.setsize" + ], + "title": "FacebookProduct.setSize" + }, + { + "description": "Sets the title of the Facebook product. If the value is longer than 100 characters it is truncated.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#setTitle", + "kind": "method", + "packagePath": "dw/extensions/facebook", + "params": [ + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.setTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the title of the Facebook product. If the value is longer than 100 characters it is truncated.", + "heading": "Description" + } + ], + "signature": "setTitle(title: string): void", + "source": "script-api", + "tags": [ + "settitle", + "facebookproduct.settitle" + ], + "title": "FacebookProduct.setTitle" + }, + { + "description": "Returns the shipping height of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingHeight", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingHeight", + "sections": [ + { + "body": "Returns the shipping height of the product.", + "heading": "Description" + } + ], + "signature": "shippingHeight: number", + "source": "script-api", + "tags": [ + "shippingheight", + "facebookproduct.shippingheight" + ], + "title": "FacebookProduct.shippingHeight" + }, + { + "description": "Returns the shipping length of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingLength", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingLength", + "sections": [ + { + "body": "Returns the shipping length of the product.", + "heading": "Description" + } + ], + "signature": "shippingLength: number", + "source": "script-api", + "tags": [ + "shippinglength", + "facebookproduct.shippinglength" + ], + "title": "FacebookProduct.shippingLength" + }, + { + "description": "Returns the shipping size unit of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingSizeUnit", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingSizeUnit", + "sections": [ + { + "body": "Returns the shipping size unit of the product.", + "heading": "Description" + } + ], + "signature": "shippingSizeUnit: string", + "source": "script-api", + "tags": [ + "shippingsizeunit", + "facebookproduct.shippingsizeunit" + ], + "title": "FacebookProduct.shippingSizeUnit" + }, + { + "description": "Returns the shipping weight for the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingWeight", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingWeight", + "sections": [ + { + "body": "Returns the shipping weight for the product.", + "heading": "Description" + } + ], + "signature": "shippingWeight: Quantity", + "source": "script-api", + "tags": [ + "shippingweight", + "facebookproduct.shippingweight" + ], + "title": "FacebookProduct.shippingWeight" + }, + { + "description": "Returns the shipping width of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#shippingWidth", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.shippingWidth", + "sections": [ + { + "body": "Returns the shipping width of the product.", + "heading": "Description" + } + ], + "signature": "shippingWidth: number", + "source": "script-api", + "tags": [ + "shippingwidth", + "facebookproduct.shippingwidth" + ], + "title": "FacebookProduct.shippingWidth" + }, + { + "description": "Returns the Facebook size value label of the product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#size", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.size", + "sections": [ + { + "body": "Returns the Facebook size value label of the product.", + "heading": "Description" + } + ], + "signature": "size: string", + "source": "script-api", + "tags": [ + "size", + "facebookproduct.size" + ], + "title": "FacebookProduct.size" + }, + { + "description": "Returns the title of the Facebook product.", + "id": "script-api:dw/extensions/facebook/FacebookProduct#title", + "kind": "property", + "packagePath": "dw/extensions/facebook", + "parentId": "script-api:dw/extensions/facebook/FacebookProduct", + "qualifiedName": "dw.extensions.facebook.FacebookProduct.title", + "sections": [ + { + "body": "Returns the title of the Facebook product.", + "heading": "Description" + } + ], + "signature": "title: string", + "source": "script-api", + "tags": [ + "title", + "facebookproduct.title" + ], + "title": "FacebookProduct.title" + }, + { + "description": "1 declaration", + "id": "script-api:dw/extensions/paymentapi", + "kind": "package", + "packagePath": "dw/extensions/paymentapi", + "qualifiedName": "dw.extensions.paymentapi", + "source": "script-api", + "tags": [ + "dw/extensions/paymentapi", + "dw.extensions.paymentapi" + ], + "title": "dw.extensions.paymentapi" + }, + { + "description": "PaymentApiHooks interface containing extension points for customizing Payment API requests for authorization, and their responses.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.paymentapi.beforeAuthorization\", \"script\": \"./payment.ds\"}\n{\"name\": \"dw.extensions.paymentapi.afterAuthorization\", \"script\": \"./payment.ds\"}\n]" + ], + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "kind": "interface", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks", + "sections": [ + { + "body": "PaymentApiHooks interface containing extension points for customizing Payment API requests for authorization,\nand their responses.\n\nThese hooks are executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymentapihooks", + "dw.extensions.paymentapi.paymentapihooks", + "dw/extensions/paymentapi" + ], + "title": "PaymentApiHooks" + }, + { + "description": "Called after the response has been handled for a request to authorize payment for the given order.", + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#afterAuthorization", + "kind": "method", + "packagePath": "dw/extensions/paymentapi", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "payment", + "type": "OrderPaymentInstrument" + }, + { + "name": "custom", + "type": "Object" + }, + { + "name": "status", + "type": "Status" + } + ], + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.afterAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after the response has been handled for a request to authorize payment for the given order.\n\nThe given status is the result of handling the response without customization. That status will be\nused unless an implementation of this hook returns an alternative status.", + "heading": "Description" + } + ], + "signature": "afterAuthorization(order: Order, payment: OrderPaymentInstrument, custom: Object, status: Status): Status", + "source": "script-api", + "tags": [ + "afterauthorization", + "paymentapihooks.afterauthorization" + ], + "title": "PaymentApiHooks.afterAuthorization" + }, + { + "description": "Called when a request is to be made to authorize payment for the given order.", + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#beforeAuthorization", + "kind": "method", + "packagePath": "dw/extensions/paymentapi", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "payment", + "type": "OrderPaymentInstrument" + }, + { + "name": "custom", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.beforeAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called when a request is to be made to authorize payment for the given order.\n\nReturn an error status to indicate a problem. The request will not be made to the payment provider.", + "heading": "Description" + } + ], + "signature": "beforeAuthorization(order: Order, payment: OrderPaymentInstrument, custom: Object): Status", + "source": "script-api", + "tags": [ + "beforeauthorization", + "paymentapihooks.beforeauthorization" + ], + "title": "PaymentApiHooks.beforeAuthorization" + }, + { + "description": "The extension point name extensionPointAfterAuthorization.", + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#extensionPointAfterAuthorization", + "kind": "property", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.extensionPointAfterAuthorization", + "sections": [ + { + "body": "The extension point name extensionPointAfterAuthorization.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAfterAuthorization: \"dw.extensions.paymentapi.afterAuthorization\"", + "source": "script-api", + "tags": [ + "extensionpointafterauthorization", + "paymentapihooks.extensionpointafterauthorization" + ], + "title": "PaymentApiHooks.extensionPointAfterAuthorization" + }, + { + "description": "The extension point name extensionPointBeforeAuthorization.", + "id": "script-api:dw/extensions/paymentapi/PaymentApiHooks#extensionPointBeforeAuthorization", + "kind": "property", + "packagePath": "dw/extensions/paymentapi", + "parentId": "script-api:dw/extensions/paymentapi/PaymentApiHooks", + "qualifiedName": "dw.extensions.paymentapi.PaymentApiHooks.extensionPointBeforeAuthorization", + "sections": [ + { + "body": "The extension point name extensionPointBeforeAuthorization.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointBeforeAuthorization: \"dw.extensions.paymentapi.beforeAuthorization\"", + "source": "script-api", + "tags": [ + "extensionpointbeforeauthorization", + "paymentapihooks.extensionpointbeforeauthorization" + ], + "title": "PaymentApiHooks.extensionPointBeforeAuthorization" + }, + { + "description": "2 declarations", + "id": "script-api:dw/extensions/paymentrequest", + "kind": "package", + "packagePath": "dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest", + "source": "script-api", + "tags": [ + "dw/extensions/paymentrequest", + "dw.extensions.paymentrequest" + ], + "title": "dw.extensions.paymentrequest" + }, + { + "deprecated": { + "message": "Salesforce Payments includes support for Google Pay" + }, + "description": "Result of a hook handling a Payment Request request", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "kind": "class", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult", + "sections": [ + { + "body": "Result of a hook handling a Payment Request request", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymentrequesthookresult", + "dw.extensions.paymentrequest.paymentrequesthookresult", + "dw/extensions/paymentrequest" + ], + "title": "PaymentRequestHookResult" + }, + { + "description": "Detail to the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#eventDetail", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.eventDetail", + "sections": [ + { + "body": "Detail to the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly eventDetail: Object", + "source": "script-api", + "tags": [ + "eventdetail", + "paymentrequesthookresult.eventdetail" + ], + "title": "PaymentRequestHookResult.eventDetail" + }, + { + "description": "Name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#eventName", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.eventName", + "sections": [ + { + "body": "Name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly eventName: string", + "source": "script-api", + "tags": [ + "eventname", + "paymentrequesthookresult.eventname" + ], + "title": "PaymentRequestHookResult.eventName" + }, + { + "description": "Detail to the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getEventDetail", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getEventDetail", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Detail to the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "getEventDetail(): Object", + "source": "script-api", + "tags": [ + "geteventdetail", + "paymentrequesthookresult.geteventdetail" + ], + "title": "PaymentRequestHookResult.getEventDetail" + }, + { + "description": "Name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getEventName", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getEventName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "getEventName(): string", + "source": "script-api", + "tags": [ + "geteventname", + "paymentrequesthookresult.geteventname" + ], + "title": "PaymentRequestHookResult.getEventName" + }, + { + "description": "URL to navigate to in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getRedirect", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getRedirect", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "URL to navigate to in response to this result.", + "heading": "Description" + } + ], + "signature": "getRedirect(): URL", + "source": "script-api", + "tags": [ + "getredirect", + "paymentrequesthookresult.getredirect" + ], + "title": "PaymentRequestHookResult.getRedirect" + }, + { + "description": "Status describing the outcome of this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#getStatus", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.getStatus", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Status describing the outcome of this result.", + "heading": "Description" + } + ], + "signature": "getStatus(): Status", + "source": "script-api", + "tags": [ + "getstatus", + "paymentrequesthookresult.getstatus" + ], + "title": "PaymentRequestHookResult.getStatus" + }, + { + "description": "URL to navigate to in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#redirect", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.redirect", + "sections": [ + { + "body": "URL to navigate to in response to this result.", + "heading": "Description" + } + ], + "signature": "readonly redirect: URL", + "source": "script-api", + "tags": [ + "redirect", + "paymentrequesthookresult.redirect" + ], + "title": "PaymentRequestHookResult.redirect" + }, + { + "description": "Sets the name of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.setEvent", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "setEvent(name: string): void", + "source": "script-api", + "tags": [ + "setevent", + "paymentrequesthookresult.setevent" + ], + "title": "PaymentRequestHookResult.setEvent" + }, + { + "description": "Sets the name and detail of the JS custom event to dispatch in response to this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#setEvent", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "detail", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.setEvent", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name and detail of the JS custom event to dispatch in response to this result.", + "heading": "Description" + } + ], + "signature": "setEvent(name: string, detail: Object): void", + "source": "script-api", + "tags": [ + "setevent", + "paymentrequesthookresult.setevent" + ], + "title": "PaymentRequestHookResult.setEvent" + }, + { + "description": "Status describing the outcome of this result.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult#status", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHookResult", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHookResult.status", + "sections": [ + { + "body": "Status describing the outcome of this result.", + "heading": "Description" + } + ], + "signature": "readonly status: Status", + "source": "script-api", + "tags": [ + "status", + "paymentrequesthookresult.status" + ], + "title": "PaymentRequestHookResult.status" + }, + { + "deprecated": { + "message": "Salesforce Payments includes support for Google Pay" + }, + "description": "PaymentRequestHooks interface containing extension points for customizing Payment Requests.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.paymentrequest.getPaymentRequest\", \"script\": \"./paymentrequest.ds\"}\n{\"name\": \"dw.extensions.paymentrequest.shippingAddressChange\", \"script\": \"./paymentrequest.ds\"}\n]" + ], + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "kind": "interface", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks", + "sections": [ + { + "body": "PaymentRequestHooks interface containing extension points for customizing Payment Requests.\n\nThese hooks are executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymentrequesthooks", + "dw.extensions.paymentrequest.paymentrequesthooks", + "dw/extensions/paymentrequest" + ], + "title": "PaymentRequestHooks" + }, + { + "description": "Called after the Payment Request user interface was canceled. The given basket is the one that was passed to other hooks earlier in the Payment Request checkout process.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#abort", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.abort", + "returns": { + "type": "PaymentRequestHookResult" + }, + "sections": [ + { + "body": "Called after the Payment Request user interface was canceled. The given basket is the one that was passed to other\nhooks earlier in the Payment Request checkout process.\n\nIt is not guaranteed that this hook will be executed for all Payment Request user interfaces canceled by shoppers or\notherwise ended without a successful order. Calls to this hook are provided on a best-effort basis.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if possible. It\nis not guaranteed that the response with the hook result will be handled in the shopper browser in all cases.", + "heading": "Description" + } + ], + "signature": "abort(basket: Basket): PaymentRequestHookResult", + "source": "script-api", + "tags": [ + "abort", + "paymentrequesthooks.abort" + ], + "title": "PaymentRequestHooks.abort" + }, + { + "description": "Called after the shopper accepts the Payment Request payment for the given order. Basket customer information, billing address, and/or shipping address for the default shipment will have already been updated to reflect the available contact information provided by Payment Request. Any preexisting payment instruments on the basket will have been removed, and a single `DW_ANDROID_PAY` payment instrument added for the total amount. The given order will have been created from this updated basket.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#authorizeOrderPayment", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "response", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.authorizeOrderPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after the shopper accepts the Payment Request payment for the given order. Basket customer information,\nbilling address, and/or shipping address for the default shipment will have already been updated to reflect the\navailable contact information provided by Payment Request. Any preexisting payment instruments on the basket will\nhave been removed, and a single `DW_ANDROID_PAY` payment instrument added for the total amount. The\ngiven order will have been created from this updated basket.\n\nThe purpose of this hook is to authorize the Payment Request payment for the order. If a non-error status is returned\nthat means that you have successfully authorized the payment with your payment service provider. Your hook\nimplementation must set the necessary payment status and transaction identifier data on the order as returned by\nthe provider.\n\nReturn an error status to indicate a problem, including unsuccessful authorization.\n\nSee the Payment Request API for more information.", + "heading": "Description" + } + ], + "signature": "authorizeOrderPayment(order: Order, response: Object): Status", + "source": "script-api", + "tags": [ + "authorizeorderpayment", + "paymentrequesthooks.authorizeorderpayment" + ], + "title": "PaymentRequestHooks.authorizeOrderPayment" + }, + { + "description": "The extension point name extensionPointAbort.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointAbort", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointAbort", + "sections": [ + { + "body": "The extension point name extensionPointAbort.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAbort: \"dw.extensions.paymentrequest.abort\"", + "source": "script-api", + "tags": [ + "extensionpointabort", + "paymentrequesthooks.extensionpointabort" + ], + "title": "PaymentRequestHooks.extensionPointAbort" + }, + { + "description": "The extension point name extensionPointGetPaymentRequest.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointGetPaymentRequest", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointGetPaymentRequest", + "sections": [ + { + "body": "The extension point name extensionPointGetPaymentRequest.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointGetPaymentRequest: \"dw.extensions.paymentrequest.getPaymentRequest\"", + "source": "script-api", + "tags": [ + "extensionpointgetpaymentrequest", + "paymentrequesthooks.extensionpointgetpaymentrequest" + ], + "title": "PaymentRequestHooks.extensionPointGetPaymentRequest" + }, + { + "description": "The extension point name extensionPointPaymentAcceptedAuthorizeOrderPayment.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointPaymentAcceptedAuthorizeOrderPayment", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointPaymentAcceptedAuthorizeOrderPayment", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAcceptedAuthorizeOrderPayment.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAcceptedAuthorizeOrderPayment: \"dw.extensions.paymentrequest.paymentAccepted.authorizeOrderPayment\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentacceptedauthorizeorderpayment", + "paymentrequesthooks.extensionpointpaymentacceptedauthorizeorderpayment" + ], + "title": "PaymentRequestHooks.extensionPointPaymentAcceptedAuthorizeOrderPayment" + }, + { + "description": "The extension point name extensionPointPaymentAcceptedPlaceOrder.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointPaymentAcceptedPlaceOrder", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointPaymentAcceptedPlaceOrder", + "sections": [ + { + "body": "The extension point name extensionPointPaymentAcceptedPlaceOrder.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPaymentAcceptedPlaceOrder: \"dw.extensions.paymentrequest.paymentAccepted.placeOrder\"", + "source": "script-api", + "tags": [ + "extensionpointpaymentacceptedplaceorder", + "paymentrequesthooks.extensionpointpaymentacceptedplaceorder" + ], + "title": "PaymentRequestHooks.extensionPointPaymentAcceptedPlaceOrder" + }, + { + "description": "The extension point name extensionPointShippingAddressChange.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointShippingAddressChange", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointShippingAddressChange", + "sections": [ + { + "body": "The extension point name extensionPointShippingAddressChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingAddressChange: \"dw.extensions.paymentrequest.shippingAddressChange\"", + "source": "script-api", + "tags": [ + "extensionpointshippingaddresschange", + "paymentrequesthooks.extensionpointshippingaddresschange" + ], + "title": "PaymentRequestHooks.extensionPointShippingAddressChange" + }, + { + "description": "The extension point name extensionPointShippingOptionChange.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#extensionPointShippingOptionChange", + "kind": "property", + "packagePath": "dw/extensions/paymentrequest", + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.extensionPointShippingOptionChange", + "sections": [ + { + "body": "The extension point name extensionPointShippingOptionChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingOptionChange: \"dw.extensions.paymentrequest.shippingOptionChange\"", + "source": "script-api", + "tags": [ + "extensionpointshippingoptionchange", + "paymentrequesthooks.extensionpointshippingoptionchange" + ], + "title": "PaymentRequestHooks.extensionPointShippingOptionChange" + }, + { + "description": "Called to get the `PaymentRequest` constructor parameters for the given basket. You can set properties in the given `parameters` object to extend or override default properties set automatically based on the Google Pay configuration for your site.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#getPaymentRequest", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "parameters", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.getPaymentRequest", + "returns": { + "type": "PaymentRequestHookResult" + }, + "sections": [ + { + "body": "Called to get the `PaymentRequest` constructor parameters for the given basket. You can\nset properties in the given `parameters` object to extend or override default properties set\nautomatically based on the Google Pay configuration for your site.\n\nThe `parameters` object will contain the following properties by default:\n\n- `methodData` - array containing payment methods the web site accepts\n- `details` - information about the transaction that the user is being asked to complete\n- `options` - information about what options the web page wishes to use from the payment request system\n\nReturn a result with an error status to indicate a problem.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Payment\nRequest user interaction is canceled.\n\nSee the Payment Request API for more information.", + "heading": "Description" + } + ], + "signature": "getPaymentRequest(basket: Basket, parameters: Object): PaymentRequestHookResult", + "source": "script-api", + "tags": [ + "getpaymentrequest", + "paymentrequesthooks.getpaymentrequest" + ], + "title": "PaymentRequestHooks.getPaymentRequest" + }, + { + "description": "Called after payment has been authorized and the given Payment Request order is ready to be placed. The purpose of this hook is to place the order, or return a redirect URL that results in the order being placed when the shopper browser is navigated to it.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#placeOrder", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.placeOrder", + "returns": { + "type": "PaymentRequestHookResult" + }, + "sections": [ + { + "body": "Called after payment has been authorized and the given Payment Request order is ready to be placed. The purpose of\nthis hook is to place the order, or return a redirect URL that results in the order being placed when the shopper\nbrowser is navigated to it.\n\nThe default implementation of this hook returns a redirect to `COPlaceOrder-Submit` with URL\nparameters `order_id` set to dw.order.Order.getOrderNo and `order_token` set to\ndw.order.Order.getOrderToken which corresponds to SiteGenesis-based implementations. Your hook\nimplementation should return a result with a different redirect URL as necessary to place the order and show an\norder confirmation.\n\nAlternatively, your hook implementation itself can place the order and return a result with a redirect URL to an\norder confirmation page that does not place the order. This is inconsistent with SiteGenesis-based\nimplementations so is not the default.\n\nReturn an error status to indicate a problem. If the returned result includes a redirect URL, the shopper browser\nwill be navigated to that URL if the Payment Request user interface is canceled.", + "heading": "Description" + } + ], + "signature": "placeOrder(order: Order): PaymentRequestHookResult", + "source": "script-api", + "tags": [ + "placeorder", + "paymentrequesthooks.placeorder" + ], + "title": "PaymentRequestHooks.placeOrder" + }, + { + "description": "Called after handling the Payment Request `shippingaddresschange` event for the given basket. Basket customer information and/or shipping address for the default shipment will have already been updated to reflect the available shipping address information provided by Payment Request. The basket will have already been calculated before this hook is called.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#shippingAddressChange", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "details", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.shippingAddressChange", + "returns": { + "type": "PaymentRequestHookResult" + }, + "sections": [ + { + "body": "Called after handling the Payment Request `shippingaddresschange` event for the given basket. Basket\ncustomer information and/or shipping address for the default shipment will have already been updated to reflect\nthe available shipping address information provided by Payment Request. The basket will have already been\ncalculated before this hook is called.\n\nReturn a result with an error status to indicate a problem.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Payment\nRequest user interface is canceled.\n\nSee the Payment Request API for more information.", + "heading": "Description" + } + ], + "signature": "shippingAddressChange(basket: Basket, details: Object): PaymentRequestHookResult", + "source": "script-api", + "tags": [ + "shippingaddresschange", + "paymentrequesthooks.shippingaddresschange" + ], + "title": "PaymentRequestHooks.shippingAddressChange" + }, + { + "description": "Called after handling the Payment Request `shippingoptionchange` event for the given basket. The given shipping method will have already been set on the basket. The basket will have already been calculated before this hook is called.", + "id": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks#shippingOptionChange", + "kind": "method", + "packagePath": "dw/extensions/paymentrequest", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shippingMethod", + "type": "ShippingMethod" + }, + { + "name": "details", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/paymentrequest/PaymentRequestHooks", + "qualifiedName": "dw.extensions.paymentrequest.PaymentRequestHooks.shippingOptionChange", + "returns": { + "type": "PaymentRequestHookResult" + }, + "sections": [ + { + "body": "Called after handling the Payment Request `shippingoptionchange` event for the given basket. The given\nshipping method will have already been set on the basket. The basket will have already been calculated before\nthis hook is called.\n\nReturn a result with an error status to indicate a problem.\n\nIf the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the\nPayment Request user interface is canceled.\n\nSee the Payment Request API for more information.", + "heading": "Description" + } + ], + "signature": "shippingOptionChange(basket: Basket, shippingMethod: ShippingMethod, details: Object): PaymentRequestHookResult", + "source": "script-api", + "tags": [ + "shippingoptionchange", + "paymentrequesthooks.shippingoptionchange" + ], + "title": "PaymentRequestHooks.shippingOptionChange" + }, + { + "description": "23 declarations", + "id": "script-api:dw/extensions/payments", + "kind": "package", + "packagePath": "dw/extensions/payments", + "qualifiedName": "dw.extensions.payments", + "source": "script-api", + "tags": [ + "dw/extensions/payments", + "dw.extensions.payments" + ], + "title": "dw.extensions.payments" + }, + { + "description": "Salesforce Payments representation of an Adyen payment intent object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent", + "sections": [ + { + "body": "Salesforce Payments representation of an Adyen payment intent object. See Salesforce Payments documentation for how\nto gain access and configure it for use on your sites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforceadyenpaymentintent", + "dw.extensions.payments.salesforceadyenpaymentintent", + "dw/extensions/payments" + ], + "title": "SalesforceAdyenPaymentIntent" + }, + { + "description": "Returns the identifier of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.ID", + "sections": [ + { + "body": "Returns the identifier of this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforceadyenpaymentintent.id" + ], + "title": "SalesforceAdyenPaymentIntent.ID" + }, + { + "description": "Returns the payment action for this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#action", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.action", + "sections": [ + { + "body": "Returns the payment action for this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly action: Object", + "source": "script-api", + "tags": [ + "action", + "salesforceadyenpaymentintent.action" + ], + "title": "SalesforceAdyenPaymentIntent.action" + }, + { + "description": "Returns the payment action for this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getAction", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns the payment action for this payment intent.", + "heading": "Description" + } + ], + "signature": "getAction(): Object", + "source": "script-api", + "tags": [ + "getaction", + "salesforceadyenpaymentintent.getaction" + ], + "title": "SalesforceAdyenPaymentIntent.getAction" + }, + { + "description": "Returns the identifier of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this payment intent.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforceadyenpaymentintent.getid" + ], + "title": "SalesforceAdyenPaymentIntent.getID" + }, + { + "description": "Returns the payment instrument for this payment intent in the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this payment intent in the given basket, or `null` if the given\nbasket has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(basket: Basket): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforceadyenpaymentintent.getpaymentinstrument" + ], + "title": "SalesforceAdyenPaymentIntent.getPaymentInstrument" + }, + { + "description": "Returns the payment instrument for this payment intent in the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this payment intent in the given order, or `null` if the given\norder has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(order: Order): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforceadyenpaymentintent.getpaymentinstrument" + ], + "title": "SalesforceAdyenPaymentIntent.getPaymentInstrument" + }, + { + "description": "Returns the Adyen result code for this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#getResultCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.getResultCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Adyen result code for this payment intent.", + "heading": "Description" + } + ], + "signature": "getResultCode(): string", + "source": "script-api", + "tags": [ + "getresultcode", + "salesforceadyenpaymentintent.getresultcode" + ], + "title": "SalesforceAdyenPaymentIntent.getResultCode" + }, + { + "description": "Returns `true` if this payment intent has an action, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#hasAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.hasAction", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if this payment intent has an action, or `false` if not.", + "heading": "Description" + } + ], + "signature": "hasAction(): boolean", + "source": "script-api", + "tags": [ + "hasaction", + "salesforceadyenpaymentintent.hasaction" + ], + "title": "SalesforceAdyenPaymentIntent.hasAction" + }, + { + "description": "Returns the Adyen result code for this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent#resultCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenPaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenPaymentIntent.resultCode", + "sections": [ + { + "body": "Returns the Adyen result code for this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly resultCode: string", + "source": "script-api", + "tags": [ + "resultcode", + "salesforceadyenpaymentintent.resultcode" + ], + "title": "SalesforceAdyenPaymentIntent.resultCode" + }, + { + "description": "Salesforce Payments representation of an Adyen saved payment method object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod", + "sections": [ + { + "body": "Salesforce Payments representation of an Adyen saved payment method object. See Salesforce Payments documentation for\nhow to gain access and configure it for use on your sites.\n\nAn Adyen saved payment method contains information about a credential used by a shopper to attempt payment, such as a\npayment card or bank account. The available information differs for each type of payment method. It includes only\nlimited information that can be safely presented to a shopper to remind them what credential they used, and\nspecifically not complete card, account, or other numbers that could be used to make future payments.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforceadyensavedpaymentmethod", + "dw.extensions.payments.salesforceadyensavedpaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforceAdyenSavedPaymentMethod" + }, + { + "description": "Returns the identifier of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.ID", + "sections": [ + { + "body": "Returns the identifier of this payment method.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforceadyensavedpaymentmethod.id" + ], + "title": "SalesforceAdyenSavedPaymentMethod.ID" + }, + { + "description": "Represents the Bancontact payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT", + "sections": [ + { + "body": "Represents the Bancontact payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "type_bancontact", + "salesforceadyensavedpaymentmethod.type_bancontact" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT" + }, + { + "description": "Represents the Bancontact payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT", + "sections": [ + { + "body": "Represents the Bancontact payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "type_bancontact", + "salesforceadyensavedpaymentmethod.type_bancontact" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT" + }, + { + "description": "Represents a credit card type of payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "type_card", + "salesforceadyensavedpaymentmethod.type_card" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_CARD" + }, + { + "description": "Represents a credit card type of payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "type_card", + "salesforceadyensavedpaymentmethod.type_card" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_CARD" + }, + { + "description": "Represents the iDEAL payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL", + "sections": [ + { + "body": "Represents the iDEAL payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "type_ideal", + "salesforceadyensavedpaymentmethod.type_ideal" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL" + }, + { + "description": "Represents the iDEAL payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL", + "sections": [ + { + "body": "Represents the iDEAL payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "type_ideal", + "salesforceadyensavedpaymentmethod.type_ideal" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL" + }, + { + "description": "Represents the SEPA Debit payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Represents the SEPA Debit payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "type_sepa_debit", + "salesforceadyensavedpaymentmethod.type_sepa_debit" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "description": "Represents the SEPA Debit payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Represents the SEPA Debit payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "type_sepa_debit", + "salesforceadyensavedpaymentmethod.type_sepa_debit" + ], + "title": "SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "description": "Returns the brand of this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.brand", + "sections": [ + { + "body": "Returns the brand of this payment method, or `null` if none is available. Available on\nSalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.", + "heading": "Description" + } + ], + "signature": "readonly brand: string | null", + "source": "script-api", + "tags": [ + "brand", + "salesforceadyensavedpaymentmethod.brand" + ], + "title": "SalesforceAdyenSavedPaymentMethod.brand" + }, + { + "description": "Returns the expiry month of the card for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#expiryMonth", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.expiryMonth", + "sections": [ + { + "body": "Returns the expiry month of the card for this payment method, or `null` if none is available.\nAvailable on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly expiryMonth: string | null", + "source": "script-api", + "tags": [ + "expirymonth", + "salesforceadyensavedpaymentmethod.expirymonth" + ], + "title": "SalesforceAdyenSavedPaymentMethod.expiryMonth" + }, + { + "description": "Returns the expiry year of the card for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#expiryYear", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.expiryYear", + "sections": [ + { + "body": "Returns the expiry year of the card for this payment method, or `null` if none is available. Available\non SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly expiryYear: string | null", + "source": "script-api", + "tags": [ + "expiryyear", + "salesforceadyensavedpaymentmethod.expiryyear" + ], + "title": "SalesforceAdyenSavedPaymentMethod.expiryYear" + }, + { + "description": "Returns the brand of this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getBrand", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the brand of this payment method, or `null` if none is available. Available on\nSalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.", + "heading": "Description" + } + ], + "signature": "getBrand(): string | null", + "source": "script-api", + "tags": [ + "getbrand", + "salesforceadyensavedpaymentmethod.getbrand" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getBrand" + }, + { + "description": "Returns the expiry month of the card for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getExpiryMonth", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getExpiryMonth", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the expiry month of the card for this payment method, or `null` if none is available.\nAvailable on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getExpiryMonth(): string | null", + "source": "script-api", + "tags": [ + "getexpirymonth", + "salesforceadyensavedpaymentmethod.getexpirymonth" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getExpiryMonth" + }, + { + "description": "Returns the expiry year of the card for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getExpiryYear", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getExpiryYear", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the expiry year of the card for this payment method, or `null` if none is available. Available\non SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getExpiryYear(): string | null", + "source": "script-api", + "tags": [ + "getexpiryyear", + "salesforceadyensavedpaymentmethod.getexpiryyear" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getExpiryYear" + }, + { + "description": "Returns the cardholder name for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getHolderName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getHolderName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the cardholder name for this payment method, or `null` if none is available. Available on\nSalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT\ntype methods.", + "heading": "Description" + } + ], + "signature": "getHolderName(): string | null", + "source": "script-api", + "tags": [ + "getholdername", + "salesforceadyensavedpaymentmethod.getholdername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getHolderName" + }, + { + "description": "Returns the identifier of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this payment method.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforceadyensavedpaymentmethod.getid" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getID" + }, + { + "description": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getLast4", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available.\nAvailable on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getLast4(): string | null", + "source": "script-api", + "tags": [ + "getlast4", + "salesforceadyensavedpaymentmethod.getlast4" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getLast4" + }, + { + "description": "Returns the back account owner name for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getOwnerName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getOwnerName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the back account owner name for this payment method, or `null` if none is available. Available\non SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and\nSalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.", + "heading": "Description" + } + ], + "signature": "getOwnerName(): string | null", + "source": "script-api", + "tags": [ + "getownername", + "salesforceadyensavedpaymentmethod.getownername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getOwnerName" + }, + { + "description": "Returns the type of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of this payment method.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "salesforceadyensavedpaymentmethod.gettype" + ], + "title": "SalesforceAdyenSavedPaymentMethod.getType" + }, + { + "description": "Returns the cardholder name for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#holderName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.holderName", + "sections": [ + { + "body": "Returns the cardholder name for this payment method, or `null` if none is available. Available on\nSalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT\ntype methods.", + "heading": "Description" + } + ], + "signature": "readonly holderName: string | null", + "source": "script-api", + "tags": [ + "holdername", + "salesforceadyensavedpaymentmethod.holdername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.holderName" + }, + { + "description": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.last4", + "sections": [ + { + "body": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available.\nAvailable on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and\nSalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly last4: string | null", + "source": "script-api", + "tags": [ + "last4", + "salesforceadyensavedpaymentmethod.last4" + ], + "title": "SalesforceAdyenSavedPaymentMethod.last4" + }, + { + "description": "Returns the back account owner name for this payment method, or `null` if none is available. Available on SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#ownerName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.ownerName", + "sections": [ + { + "body": "Returns the back account owner name for this payment method, or `null` if none is available. Available\non SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and\nSalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.", + "heading": "Description" + } + ], + "signature": "readonly ownerName: string | null", + "source": "script-api", + "tags": [ + "ownername", + "salesforceadyensavedpaymentmethod.ownername" + ], + "title": "SalesforceAdyenSavedPaymentMethod.ownerName" + }, + { + "description": "Returns the type of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceAdyenSavedPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.type", + "sections": [ + { + "body": "Returns the type of this payment method.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "salesforceadyensavedpaymentmethod.type" + ], + "title": "SalesforceAdyenSavedPaymentMethod.type" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_BANCONTACT. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_BANCONTACT. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforcebancontactpaymentdetails", + "dw.extensions.payments.salesforcebancontactpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceBancontactPaymentDetails" + }, + { + "description": "Returns the bank name, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#bankName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.bankName", + "sections": [ + { + "body": "Returns the bank name, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly bankName: string | null", + "source": "script-api", + "tags": [ + "bankname", + "salesforcebancontactpaymentdetails.bankname" + ], + "title": "SalesforceBancontactPaymentDetails.bankName" + }, + { + "description": "Returns the bank name, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#getBankName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.getBankName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank name, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getBankName(): string | null", + "source": "script-api", + "tags": [ + "getbankname", + "salesforcebancontactpaymentdetails.getbankname" + ], + "title": "SalesforceBancontactPaymentDetails.getBankName" + }, + { + "description": "Returns the last 4 digits of the account number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.getLast4", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 digits of the account number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getLast4(): string | null", + "source": "script-api", + "tags": [ + "getlast4", + "salesforcebancontactpaymentdetails.getlast4" + ], + "title": "SalesforceBancontactPaymentDetails.getLast4" + }, + { + "description": "Returns the last 4 digits of the account number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceBancontactPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceBancontactPaymentDetails.last4", + "sections": [ + { + "body": "Returns the last 4 digits of the account number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly last4: string | null", + "source": "script-api", + "tags": [ + "last4", + "salesforcebancontactpaymentdetails.last4" + ], + "title": "SalesforceBancontactPaymentDetails.last4" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_CARD. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_CARD. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforcecardpaymentdetails", + "dw.extensions.payments.salesforcecardpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceCardPaymentDetails" + }, + { + "description": "Returns the card brand, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.brand", + "sections": [ + { + "body": "Returns the card brand, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly brand: string | null", + "source": "script-api", + "tags": [ + "brand", + "salesforcecardpaymentdetails.brand" + ], + "title": "SalesforceCardPaymentDetails.brand" + }, + { + "description": "Returns the card brand, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getBrand", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the card brand, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getBrand(): string | null", + "source": "script-api", + "tags": [ + "getbrand", + "salesforcecardpaymentdetails.getbrand" + ], + "title": "SalesforceCardPaymentDetails.getBrand" + }, + { + "description": "Returns the last 4 digits of the card number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getLast4", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 digits of the card number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getLast4(): string | null", + "source": "script-api", + "tags": [ + "getlast4", + "salesforcecardpaymentdetails.getlast4" + ], + "title": "SalesforceCardPaymentDetails.getLast4" + }, + { + "description": "Returns the type of wallet used to make the card payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#getWalletType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.getWalletType", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the type of wallet used to make the card payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getWalletType(): string | null", + "source": "script-api", + "tags": [ + "getwallettype", + "salesforcecardpaymentdetails.getwallettype" + ], + "title": "SalesforceCardPaymentDetails.getWalletType" + }, + { + "description": "Returns the last 4 digits of the card number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.last4", + "sections": [ + { + "body": "Returns the last 4 digits of the card number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly last4: string | null", + "source": "script-api", + "tags": [ + "last4", + "salesforcecardpaymentdetails.last4" + ], + "title": "SalesforceCardPaymentDetails.last4" + }, + { + "description": "Returns the type of wallet used to make the card payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails#walletType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceCardPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceCardPaymentDetails.walletType", + "sections": [ + { + "body": "Returns the type of wallet used to make the card payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly walletType: string | null", + "source": "script-api", + "tags": [ + "wallettype", + "salesforcecardpaymentdetails.wallettype" + ], + "title": "SalesforceCardPaymentDetails.walletType" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_EPS. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_EPS. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforceepspaymentdetails", + "dw.extensions.payments.salesforceepspaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceEpsPaymentDetails" + }, + { + "description": "Returns the bank used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails.bank", + "sections": [ + { + "body": "Returns the bank used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly bank: string | null", + "source": "script-api", + "tags": [ + "bank", + "salesforceepspaymentdetails.bank" + ], + "title": "SalesforceEpsPaymentDetails.bank" + }, + { + "description": "Returns the bank used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceEpsPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceEpsPaymentDetails.getBank", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getBank(): string | null", + "source": "script-api", + "tags": [ + "getbank", + "salesforceepspaymentdetails.getbank" + ], + "title": "SalesforceEpsPaymentDetails.getBank" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_IDEAL. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_IDEAL. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforceidealpaymentdetails", + "dw.extensions.payments.salesforceidealpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceIdealPaymentDetails" + }, + { + "description": "Returns the bank used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails.bank", + "sections": [ + { + "body": "Returns the bank used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly bank: string | null", + "source": "script-api", + "tags": [ + "bank", + "salesforceidealpaymentdetails.bank" + ], + "title": "SalesforceIdealPaymentDetails.bank" + }, + { + "description": "Returns the bank used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceIdealPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceIdealPaymentDetails.getBank", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getBank(): string | null", + "source": "script-api", + "tags": [ + "getbank", + "salesforceidealpaymentdetails.getbank" + ], + "title": "SalesforceIdealPaymentDetails.getBank" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_KLARNA. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_KLARNA. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforceklarnapaymentdetails", + "dw.extensions.payments.salesforceklarnapaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceKlarnaPaymentDetails" + }, + { + "description": "Returns the payment method category used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails#getPaymentMethodCategory", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails.getPaymentMethodCategory", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the payment method category used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getPaymentMethodCategory(): string | null", + "source": "script-api", + "tags": [ + "getpaymentmethodcategory", + "salesforceklarnapaymentdetails.getpaymentmethodcategory" + ], + "title": "SalesforceKlarnaPaymentDetails.getPaymentMethodCategory" + }, + { + "description": "Returns the payment method category used for the payment, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails#paymentMethodCategory", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceKlarnaPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceKlarnaPaymentDetails.paymentMethodCategory", + "sections": [ + { + "body": "Returns the payment method category used for the payment, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly paymentMethodCategory: string | null", + "source": "script-api", + "tags": [ + "paymentmethodcategory", + "salesforceklarnapaymentdetails.paymentmethodcategory" + ], + "title": "SalesforceKlarnaPaymentDetails.paymentMethodCategory" + }, + { + "description": "Salesforce Payments representation of a PayPal order object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder", + "sections": [ + { + "body": "Salesforce Payments representation of a PayPal order object. See Salesforce Payments documentation for how\nto gain access and configure it for use on your sites.\n\nA PayPal order is automatically created when a shopper is ready to pay for items in their basket. It becomes\ncompleted when the shopper provides information to the payment provider that is acceptable to authorize payment for a\ngiven amount.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaypalorder", + "dw.extensions.payments.salesforcepaypalorder", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrder" + }, + { + "description": "Returns the identifier of this PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.ID", + "sections": [ + { + "body": "Returns the identifier of this PayPal order.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforcepaypalorder.id" + ], + "title": "SalesforcePayPalOrder.ID" + }, + { + "description": "Represents the `\"AUTHORIZE\"` intent, meaning manual capture.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_AUTHORIZE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_AUTHORIZE", + "sections": [ + { + "body": "Represents the `\"AUTHORIZE\"` intent, meaning manual capture.", + "heading": "Description" + } + ], + "signature": "static readonly INTENT_AUTHORIZE = \"AUTHORIZE\"", + "source": "script-api", + "tags": [ + "intent_authorize", + "salesforcepaypalorder.intent_authorize" + ], + "title": "SalesforcePayPalOrder.INTENT_AUTHORIZE" + }, + { + "description": "Represents the `\"AUTHORIZE\"` intent, meaning manual capture.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_AUTHORIZE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_AUTHORIZE", + "sections": [ + { + "body": "Represents the `\"AUTHORIZE\"` intent, meaning manual capture.", + "heading": "Description" + } + ], + "signature": "static readonly INTENT_AUTHORIZE = \"AUTHORIZE\"", + "source": "script-api", + "tags": [ + "intent_authorize", + "salesforcepaypalorder.intent_authorize" + ], + "title": "SalesforcePayPalOrder.INTENT_AUTHORIZE" + }, + { + "description": "Represents the `\"CAPTURE\"` intent, meaning automatic capture.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_CAPTURE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_CAPTURE", + "sections": [ + { + "body": "Represents the `\"CAPTURE\"` intent, meaning automatic capture.", + "heading": "Description" + } + ], + "signature": "static readonly INTENT_CAPTURE = \"CAPTURE\"", + "source": "script-api", + "tags": [ + "intent_capture", + "salesforcepaypalorder.intent_capture" + ], + "title": "SalesforcePayPalOrder.INTENT_CAPTURE" + }, + { + "description": "Represents the `\"CAPTURE\"` intent, meaning automatic capture.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#INTENT_CAPTURE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.INTENT_CAPTURE", + "sections": [ + { + "body": "Represents the `\"CAPTURE\"` intent, meaning automatic capture.", + "heading": "Description" + } + ], + "signature": "static readonly INTENT_CAPTURE = \"CAPTURE\"", + "source": "script-api", + "tags": [ + "intent_capture", + "salesforcepaypalorder.intent_capture" + ], + "title": "SalesforcePayPalOrder.INTENT_CAPTURE" + }, + { + "description": "Represents the PayPal funding source.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_PAYPAL", + "sections": [ + { + "body": "Represents the PayPal funding source.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PAYPAL = \"paypal\"", + "source": "script-api", + "tags": [ + "type_paypal", + "salesforcepaypalorder.type_paypal" + ], + "title": "SalesforcePayPalOrder.TYPE_PAYPAL" + }, + { + "description": "Represents the PayPal funding source.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_PAYPAL", + "sections": [ + { + "body": "Represents the PayPal funding source.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PAYPAL = \"paypal\"", + "source": "script-api", + "tags": [ + "type_paypal", + "salesforcepaypalorder.type_paypal" + ], + "title": "SalesforcePayPalOrder.TYPE_PAYPAL" + }, + { + "description": "Represents the Venmo funding source.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_VENMO", + "sections": [ + { + "body": "Represents the Venmo funding source.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_VENMO = \"venmo\"", + "source": "script-api", + "tags": [ + "type_venmo", + "salesforcepaypalorder.type_venmo" + ], + "title": "SalesforcePayPalOrder.TYPE_VENMO" + }, + { + "description": "Represents the Venmo funding source.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.TYPE_VENMO", + "sections": [ + { + "body": "Represents the Venmo funding source.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_VENMO = \"venmo\"", + "source": "script-api", + "tags": [ + "type_venmo", + "salesforcepaypalorder.type_venmo" + ], + "title": "SalesforcePayPalOrder.TYPE_VENMO" + }, + { + "description": "Returns the amount of this PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#amount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.amount", + "sections": [ + { + "body": "Returns the amount of this PayPal order.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "salesforcepaypalorder.amount" + ], + "title": "SalesforcePayPalOrder.amount" + }, + { + "description": "Returns the ID of the authorization against this order, or `null` if not available.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#authorizationID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.authorizationID", + "sections": [ + { + "body": "Returns the ID of the authorization against this order, or `null` if not available.", + "heading": "Description" + } + ], + "signature": "readonly authorizationID: string | null", + "source": "script-api", + "tags": [ + "authorizationid", + "salesforcepaypalorder.authorizationid" + ], + "title": "SalesforcePayPalOrder.authorizationID" + }, + { + "description": "Returns the ID of the capture against this order, or `null` if not available.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.captureID", + "sections": [ + { + "body": "Returns the ID of the capture against this order, or `null` if not available.", + "heading": "Description" + } + ], + "signature": "readonly captureID: string | null", + "source": "script-api", + "tags": [ + "captureid", + "salesforcepaypalorder.captureid" + ], + "title": "SalesforcePayPalOrder.captureID" + }, + { + "description": "Returns `true` if this PayPal order has been completed, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#completed", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.completed", + "sections": [ + { + "body": "Returns `true` if this PayPal order has been completed, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly completed: boolean", + "source": "script-api", + "tags": [ + "completed", + "salesforcepaypalorder.completed" + ], + "title": "SalesforcePayPalOrder.completed" + }, + { + "description": "Returns the amount of this PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getAmount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the amount of this PayPal order.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "salesforcepaypalorder.getamount" + ], + "title": "SalesforcePayPalOrder.getAmount" + }, + { + "description": "Returns the ID of the authorization against this order, or `null` if not available.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getAuthorizationID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getAuthorizationID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the authorization against this order, or `null` if not available.", + "heading": "Description" + } + ], + "signature": "getAuthorizationID(): string | null", + "source": "script-api", + "tags": [ + "getauthorizationid", + "salesforcepaypalorder.getauthorizationid" + ], + "title": "SalesforcePayPalOrder.getAuthorizationID" + }, + { + "description": "Returns the ID of the capture against this order, or `null` if not available.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getCaptureID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the capture against this order, or `null` if not available.", + "heading": "Description" + } + ], + "signature": "getCaptureID(): string | null", + "source": "script-api", + "tags": [ + "getcaptureid", + "salesforcepaypalorder.getcaptureid" + ], + "title": "SalesforcePayPalOrder.getCaptureID" + }, + { + "description": "Returns the identifier of this PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this PayPal order.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforcepaypalorder.getid" + ], + "title": "SalesforcePayPalOrder.getID" + }, + { + "description": "Returns the payer information for this PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPayer", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPayer", + "returns": { + "type": "SalesforcePayPalOrderPayer | null" + }, + "sections": [ + { + "body": "Returns the payer information for this PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getPayer(): SalesforcePayPalOrderPayer | null", + "source": "script-api", + "tags": [ + "getpayer", + "salesforcepaypalorder.getpayer" + ], + "title": "SalesforcePayPalOrder.getPayer" + }, + { + "description": "Returns the details to the Salesforce Payments payment for this PayPal order, using the given payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentDetails", + "returns": { + "type": "SalesforcePaymentDetails" + }, + "sections": [ + { + "body": "Returns the details to the Salesforce Payments payment for this PayPal order, using the given payment instrument.", + "heading": "Description" + } + ], + "signature": "getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails", + "source": "script-api", + "tags": [ + "getpaymentdetails", + "salesforcepaypalorder.getpaymentdetails" + ], + "title": "SalesforcePayPalOrder.getPaymentDetails" + }, + { + "description": "Returns the payment instrument for this PayPal order in the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this PayPal order in the given basket, or `null` if the given\nbasket has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(basket: Basket): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforcepaypalorder.getpaymentinstrument" + ], + "title": "SalesforcePayPalOrder.getPaymentInstrument" + }, + { + "description": "Returns the payment instrument for this PayPal order in the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this PayPal order in the given order, or `null` if the given\norder has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(order: Order): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforcepaypalorder.getpaymentinstrument" + ], + "title": "SalesforcePayPalOrder.getPaymentInstrument" + }, + { + "description": "Returns the shipping address for this PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#getShipping", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.getShipping", + "returns": { + "type": "SalesforcePayPalOrderAddress | null" + }, + "sections": [ + { + "body": "Returns the shipping address for this PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getShipping(): SalesforcePayPalOrderAddress | null", + "source": "script-api", + "tags": [ + "getshipping", + "salesforcepaypalorder.getshipping" + ], + "title": "SalesforcePayPalOrder.getShipping" + }, + { + "description": "Returns `true` if this PayPal order has been completed, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#isCompleted", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.isCompleted", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if this PayPal order has been completed, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isCompleted(): boolean", + "source": "script-api", + "tags": [ + "iscompleted", + "salesforcepaypalorder.iscompleted" + ], + "title": "SalesforcePayPalOrder.isCompleted" + }, + { + "description": "Returns the payer information for this PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#payer", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.payer", + "sections": [ + { + "body": "Returns the payer information for this PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly payer: SalesforcePayPalOrderPayer | null", + "source": "script-api", + "tags": [ + "payer", + "salesforcepaypalorder.payer" + ], + "title": "SalesforcePayPalOrder.payer" + }, + { + "description": "Returns the shipping address for this PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrder#shipping", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrder", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrder.shipping", + "sections": [ + { + "body": "Returns the shipping address for this PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly shipping: SalesforcePayPalOrderAddress | null", + "source": "script-api", + "tags": [ + "shipping", + "salesforcepaypalorder.shipping" + ], + "title": "SalesforcePayPalOrder.shipping" + }, + { + "description": "Salesforce Payments representation of a PayPal order address object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress", + "sections": [ + { + "body": "Salesforce Payments representation of a PayPal order address object. See Salesforce Payments documentation\nfor how to gain access and configure it for use on your sites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaypalorderaddress", + "dw.extensions.payments.salesforcepaypalorderaddress", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrderAddress" + }, + { + "description": "Returns the address line 1.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#addressLine1", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.addressLine1", + "sections": [ + { + "body": "Returns the address line 1.", + "heading": "Description" + } + ], + "signature": "readonly addressLine1: string", + "source": "script-api", + "tags": [ + "addressline1", + "salesforcepaypalorderaddress.addressline1" + ], + "title": "SalesforcePayPalOrderAddress.addressLine1" + }, + { + "description": "Returns the address line 2.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#addressLine2", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.addressLine2", + "sections": [ + { + "body": "Returns the address line 2.", + "heading": "Description" + } + ], + "signature": "readonly addressLine2: string", + "source": "script-api", + "tags": [ + "addressline2", + "salesforcepaypalorderaddress.addressline2" + ], + "title": "SalesforcePayPalOrderAddress.addressLine2" + }, + { + "description": "Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#adminArea1", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.adminArea1", + "sections": [ + { + "body": "Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2\nsubdivision.", + "heading": "Description" + } + ], + "signature": "readonly adminArea1: string", + "source": "script-api", + "tags": [ + "adminarea1", + "salesforcepaypalorderaddress.adminarea1" + ], + "title": "SalesforcePayPalOrderAddress.adminArea1" + }, + { + "description": "Returns the address city, town, or village.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#adminArea2", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.adminArea2", + "sections": [ + { + "body": "Returns the address city, town, or village.", + "heading": "Description" + } + ], + "signature": "readonly adminArea2: string", + "source": "script-api", + "tags": [ + "adminarea2", + "salesforcepaypalorderaddress.adminarea2" + ], + "title": "SalesforcePayPalOrderAddress.adminArea2" + }, + { + "description": "Returns the address two-character ISO 3166-1 code that identifies the country or region.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#countryCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.countryCode", + "sections": [ + { + "body": "Returns the address two-character ISO 3166-1 code that identifies the country or region.", + "heading": "Description" + } + ], + "signature": "readonly countryCode: string", + "source": "script-api", + "tags": [ + "countrycode", + "salesforcepaypalorderaddress.countrycode" + ], + "title": "SalesforcePayPalOrderAddress.countryCode" + }, + { + "description": "Returns the address full name.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#fullName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.fullName", + "sections": [ + { + "body": "Returns the address full name.", + "heading": "Description" + } + ], + "signature": "readonly fullName: string", + "source": "script-api", + "tags": [ + "fullname", + "salesforcepaypalorderaddress.fullname" + ], + "title": "SalesforcePayPalOrderAddress.fullName" + }, + { + "description": "Returns the address line 1.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAddressLine1", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAddressLine1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address line 1.", + "heading": "Description" + } + ], + "signature": "getAddressLine1(): string", + "source": "script-api", + "tags": [ + "getaddressline1", + "salesforcepaypalorderaddress.getaddressline1" + ], + "title": "SalesforcePayPalOrderAddress.getAddressLine1" + }, + { + "description": "Returns the address line 2.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAddressLine2", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAddressLine2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address line 2.", + "heading": "Description" + } + ], + "signature": "getAddressLine2(): string", + "source": "script-api", + "tags": [ + "getaddressline2", + "salesforcepaypalorderaddress.getaddressline2" + ], + "title": "SalesforcePayPalOrderAddress.getAddressLine2" + }, + { + "description": "Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAdminArea1", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAdminArea1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2\nsubdivision.", + "heading": "Description" + } + ], + "signature": "getAdminArea1(): string", + "source": "script-api", + "tags": [ + "getadminarea1", + "salesforcepaypalorderaddress.getadminarea1" + ], + "title": "SalesforcePayPalOrderAddress.getAdminArea1" + }, + { + "description": "Returns the address city, town, or village.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getAdminArea2", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getAdminArea2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address city, town, or village.", + "heading": "Description" + } + ], + "signature": "getAdminArea2(): string", + "source": "script-api", + "tags": [ + "getadminarea2", + "salesforcepaypalorderaddress.getadminarea2" + ], + "title": "SalesforcePayPalOrderAddress.getAdminArea2" + }, + { + "description": "Returns the address two-character ISO 3166-1 code that identifies the country or region.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getCountryCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address two-character ISO 3166-1 code that identifies the country or region.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): string", + "source": "script-api", + "tags": [ + "getcountrycode", + "salesforcepaypalorderaddress.getcountrycode" + ], + "title": "SalesforcePayPalOrderAddress.getCountryCode" + }, + { + "description": "Returns the address full name.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getFullName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getFullName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address full name.", + "heading": "Description" + } + ], + "signature": "getFullName(): string", + "source": "script-api", + "tags": [ + "getfullname", + "salesforcepaypalorderaddress.getfullname" + ], + "title": "SalesforcePayPalOrderAddress.getFullName" + }, + { + "description": "Returns the address postal code.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the address postal code.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "salesforcepaypalorderaddress.getpostalcode" + ], + "title": "SalesforcePayPalOrderAddress.getPostalCode" + }, + { + "description": "Returns the address postal code.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress#postalCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderAddress", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderAddress.postalCode", + "sections": [ + { + "body": "Returns the address postal code.", + "heading": "Description" + } + ], + "signature": "readonly postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "salesforcepaypalorderaddress.postalcode" + ], + "title": "SalesforcePayPalOrderAddress.postalCode" + }, + { + "description": "Salesforce Payments representation of a PayPal order's payer object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer", + "sections": [ + { + "body": "Salesforce Payments representation of a PayPal order's payer object. See Salesforce Payments documentation\nfor how to gain access and configure it for use on your sites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaypalorderpayer", + "dw.extensions.payments.salesforcepaypalorderpayer", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalOrderPayer" + }, + { + "description": "Returns the payer's email address.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#emailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.emailAddress", + "sections": [ + { + "body": "Returns the payer's email address.", + "heading": "Description" + } + ], + "signature": "readonly emailAddress: string", + "source": "script-api", + "tags": [ + "emailaddress", + "salesforcepaypalorderpayer.emailaddress" + ], + "title": "SalesforcePayPalOrderPayer.emailAddress" + }, + { + "description": "Returns the payer's email address.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getEmailAddress", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payer's email address.", + "heading": "Description" + } + ], + "signature": "getEmailAddress(): string", + "source": "script-api", + "tags": [ + "getemailaddress", + "salesforcepaypalorderpayer.getemailaddress" + ], + "title": "SalesforcePayPalOrderPayer.getEmailAddress" + }, + { + "description": "Returns the payer's given name.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getGivenName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getGivenName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payer's given name.", + "heading": "Description" + } + ], + "signature": "getGivenName(): string", + "source": "script-api", + "tags": [ + "getgivenname", + "salesforcepaypalorderpayer.getgivenname" + ], + "title": "SalesforcePayPalOrderPayer.getGivenName" + }, + { + "description": "Returns the payer's national phone number.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getPhone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getPhone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payer's national phone number.", + "heading": "Description" + } + ], + "signature": "getPhone(): string", + "source": "script-api", + "tags": [ + "getphone", + "salesforcepaypalorderpayer.getphone" + ], + "title": "SalesforcePayPalOrderPayer.getPhone" + }, + { + "description": "Returns the payer's surname.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#getSurname", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.getSurname", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payer's surname.", + "heading": "Description" + } + ], + "signature": "getSurname(): string", + "source": "script-api", + "tags": [ + "getsurname", + "salesforcepaypalorderpayer.getsurname" + ], + "title": "SalesforcePayPalOrderPayer.getSurname" + }, + { + "description": "Returns the payer's given name.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#givenName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.givenName", + "sections": [ + { + "body": "Returns the payer's given name.", + "heading": "Description" + } + ], + "signature": "readonly givenName: string", + "source": "script-api", + "tags": [ + "givenname", + "salesforcepaypalorderpayer.givenname" + ], + "title": "SalesforcePayPalOrderPayer.givenName" + }, + { + "description": "Returns the payer's national phone number.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#phone", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.phone", + "sections": [ + { + "body": "Returns the payer's national phone number.", + "heading": "Description" + } + ], + "signature": "readonly phone: string", + "source": "script-api", + "tags": [ + "phone", + "salesforcepaypalorderpayer.phone" + ], + "title": "SalesforcePayPalOrderPayer.phone" + }, + { + "description": "Returns the payer's surname.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer#surname", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalOrderPayer", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalOrderPayer.surname", + "sections": [ + { + "body": "Returns the payer's surname.", + "heading": "Description" + } + ], + "signature": "readonly surname: string", + "source": "script-api", + "tags": [ + "surname", + "salesforcepaypalorderpayer.surname" + ], + "title": "SalesforcePayPalOrderPayer.surname" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_PAYPAL. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_PAYPAL. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaypalpaymentdetails", + "dw.extensions.payments.salesforcepaypalpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforcePayPalPaymentDetails" + }, + { + "description": "Returns the ID of the capture against the PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.captureID", + "sections": [ + { + "body": "Returns the ID of the capture against the PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly captureID: string | null", + "source": "script-api", + "tags": [ + "captureid", + "salesforcepaypalpaymentdetails.captureid" + ], + "title": "SalesforcePayPalPaymentDetails.captureID" + }, + { + "description": "Returns the ID of the capture against the PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.getCaptureID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the capture against the PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getCaptureID(): string | null", + "source": "script-api", + "tags": [ + "getcaptureid", + "salesforcepaypalpaymentdetails.getcaptureid" + ], + "title": "SalesforcePayPalPaymentDetails.getCaptureID" + }, + { + "description": "Returns the email address of the payer for the PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#getPayerEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.getPayerEmailAddress", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the email address of the payer for the PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getPayerEmailAddress(): string | null", + "source": "script-api", + "tags": [ + "getpayeremailaddress", + "salesforcepaypalpaymentdetails.getpayeremailaddress" + ], + "title": "SalesforcePayPalPaymentDetails.getPayerEmailAddress" + }, + { + "description": "Returns the email address of the payer for the PayPal order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails#payerEmailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePayPalPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePayPalPaymentDetails.payerEmailAddress", + "sections": [ + { + "body": "Returns the email address of the payer for the PayPal order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly payerEmailAddress: string | null", + "source": "script-api", + "tags": [ + "payeremailaddress", + "salesforcepaypalpaymentdetails.payeremailaddress" + ], + "title": "SalesforcePayPalPaymentDetails.payerEmailAddress" + }, + { + "description": "Base class details to a Salesforce Payments payment. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails", + "sections": [ + { + "body": "Base class details to a Salesforce Payments payment. See Salesforce Payments documentation for how to gain access and\nconfigure it for use on your sites.\n\nSome payment types like SalesforcePaymentMethod.TYPE_CARD contain additional details like the card brand, or\nthe last 4 digits of the card number. Details to those payments will be of a specific subclass of this class like\nSalesforceCardPaymentDetails. Other payment types have no additional information so their details are\nrepresented by an object of this base type.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentdetails", + "dw.extensions.payments.salesforcepaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentDetails" + }, + { + "description": "Returns the payment type.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payment type.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "salesforcepaymentdetails.gettype" + ], + "title": "SalesforcePaymentDetails.getType" + }, + { + "description": "Returns the payment type.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentDetails#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentDetails.type", + "sections": [ + { + "body": "Returns the payment type.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "salesforcepaymentdetails.type" + ], + "title": "SalesforcePaymentDetails.type" + }, + { + "description": "Salesforce Payments representation of a Stripe payment intent object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent", + "sections": [ + { + "body": "Salesforce Payments representation of a Stripe payment intent object. See Salesforce Payments documentation for how\nto gain access and configure it for use on your sites.\n\nA payment intent is automatically created when a shopper is ready to pay for items in their basket. It becomes\nconfirmed when the shopper provides information to the payment provider that is acceptable to authorize payment for a\ngiven amount. Once that information has been provided it becomes available as the payment method associated with the\npayment intent.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentintent", + "dw.extensions.payments.salesforcepaymentintent", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentIntent" + }, + { + "description": "Returns the identifier of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.ID", + "sections": [ + { + "body": "Returns the identifier of this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforcepaymentintent.id" + ], + "title": "SalesforcePaymentIntent.ID" + }, + { + "description": "Represents the payment method setup future usage is off session.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_OFF_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION", + "sections": [ + { + "body": "Represents the payment method setup future usage is off session.", + "heading": "Description" + } + ], + "signature": "static readonly SETUP_FUTURE_USAGE_OFF_SESSION = \"off_session\"", + "source": "script-api", + "tags": [ + "setup_future_usage_off_session", + "salesforcepaymentintent.setup_future_usage_off_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION" + }, + { + "description": "Represents the payment method setup future usage is off session.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_OFF_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION", + "sections": [ + { + "body": "Represents the payment method setup future usage is off session.", + "heading": "Description" + } + ], + "signature": "static readonly SETUP_FUTURE_USAGE_OFF_SESSION = \"off_session\"", + "source": "script-api", + "tags": [ + "setup_future_usage_off_session", + "salesforcepaymentintent.setup_future_usage_off_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION" + }, + { + "description": "Represents the payment method setup future usage is on session.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_ON_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION", + "sections": [ + { + "body": "Represents the payment method setup future usage is on session.", + "heading": "Description" + } + ], + "signature": "static readonly SETUP_FUTURE_USAGE_ON_SESSION = \"on_session\"", + "source": "script-api", + "tags": [ + "setup_future_usage_on_session", + "salesforcepaymentintent.setup_future_usage_on_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION" + }, + { + "description": "Represents the payment method setup future usage is on session.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#SETUP_FUTURE_USAGE_ON_SESSION", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION", + "sections": [ + { + "body": "Represents the payment method setup future usage is on session.", + "heading": "Description" + } + ], + "signature": "static readonly SETUP_FUTURE_USAGE_ON_SESSION = \"on_session\"", + "source": "script-api", + "tags": [ + "setup_future_usage_on_session", + "salesforcepaymentintent.setup_future_usage_on_session" + ], + "title": "SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION" + }, + { + "description": "Returns the amount of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#amount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.amount", + "sections": [ + { + "body": "Returns the amount of this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "salesforcepaymentintent.amount" + ], + "title": "SalesforcePaymentIntent.amount" + }, + { + "description": "Returns `true` if this payment intent has a status which indicates it can be canceled, or `false` if its status does not indicate it can be canceled.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#cancelable", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.cancelable", + "sections": [ + { + "body": "Returns `true` if this payment intent has a status which indicates it can be canceled,\nor `false` if its status does not indicate it can be canceled.", + "heading": "Description" + } + ], + "signature": "readonly cancelable: boolean", + "source": "script-api", + "tags": [ + "cancelable", + "salesforcepaymentintent.cancelable" + ], + "title": "SalesforcePaymentIntent.cancelable" + }, + { + "description": "Returns the client secret of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#clientSecret", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.clientSecret", + "sections": [ + { + "body": "Returns the client secret of this payment intent.", + "heading": "Description" + } + ], + "signature": "readonly clientSecret: string", + "source": "script-api", + "tags": [ + "clientsecret", + "salesforcepaymentintent.clientsecret" + ], + "title": "SalesforcePaymentIntent.clientSecret" + }, + { + "description": "Returns `true` if this payment intent has been confirmed, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#confirmed", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.confirmed", + "sections": [ + { + "body": "Returns `true` if this payment intent has been confirmed, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly confirmed: boolean", + "source": "script-api", + "tags": [ + "confirmed", + "salesforcepaymentintent.confirmed" + ], + "title": "SalesforcePaymentIntent.confirmed" + }, + { + "description": "Returns the amount of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getAmount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the amount of this payment intent.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "salesforcepaymentintent.getamount" + ], + "title": "SalesforcePaymentIntent.getAmount" + }, + { + "description": "Returns the client secret of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getClientSecret", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getClientSecret", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the client secret of this payment intent.", + "heading": "Description" + } + ], + "signature": "getClientSecret(): string", + "source": "script-api", + "tags": [ + "getclientsecret", + "salesforcepaymentintent.getclientsecret" + ], + "title": "SalesforcePaymentIntent.getClientSecret" + }, + { + "description": "Returns the identifier of this payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this payment intent.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforcepaymentintent.getid" + ], + "title": "SalesforcePaymentIntent.getID" + }, + { + "description": "Returns the payment instrument for this payment intent in the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this payment intent in the given basket, or `null` if the given\nbasket has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(basket: Basket): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforcepaymentintent.getpaymentinstrument" + ], + "title": "SalesforcePaymentIntent.getPaymentInstrument" + }, + { + "description": "Returns the payment instrument for this payment intent in the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument for this payment intent in the given order, or `null` if the given\norder has none.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(order: Order): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "salesforcepaymentintent.getpaymentinstrument" + ], + "title": "SalesforcePaymentIntent.getPaymentInstrument" + }, + { + "description": "Returns the payment method for this payment intent, or `null` if none has been established.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getPaymentMethod", + "returns": { + "type": "SalesforcePaymentMethod | null" + }, + "sections": [ + { + "body": "Returns the payment method for this payment intent, or `null` if none has been established.", + "heading": "Description" + } + ], + "signature": "getPaymentMethod(): SalesforcePaymentMethod | null", + "source": "script-api", + "tags": [ + "getpaymentmethod", + "salesforcepaymentintent.getpaymentmethod" + ], + "title": "SalesforcePaymentIntent.getPaymentMethod" + }, + { + "description": "Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns `null` if future usage is not set up.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#getSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.getSetupFutureUsage", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment\nintent can be used in the future or returns `null` if future usage is not set up.", + "heading": "Description" + } + ], + "signature": "getSetupFutureUsage(): string | null", + "source": "script-api", + "tags": [ + "getsetupfutureusage", + "salesforcepaymentintent.getsetupfutureusage" + ], + "title": "SalesforcePaymentIntent.getSetupFutureUsage" + }, + { + "description": "Returns `true` if this payment intent has a status which indicates it can be canceled, or `false` if its status does not indicate it can be canceled.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isCancelable", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isCancelable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if this payment intent has a status which indicates it can be canceled,\nor `false` if its status does not indicate it can be canceled.", + "heading": "Description" + } + ], + "signature": "isCancelable(): boolean", + "source": "script-api", + "tags": [ + "iscancelable", + "salesforcepaymentintent.iscancelable" + ], + "title": "SalesforcePaymentIntent.isCancelable" + }, + { + "description": "Returns `true` if this payment intent has been confirmed, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isConfirmed", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isConfirmed", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if this payment intent has been confirmed, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isConfirmed(): boolean", + "source": "script-api", + "tags": [ + "isconfirmed", + "salesforcepaymentintent.isconfirmed" + ], + "title": "SalesforcePaymentIntent.isConfirmed" + }, + { + "description": "Returns `true` if this payment intent has a status and other state which indicate it can be refunded, or `false` if it cannot be refunded.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#isRefundable", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.isRefundable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if this payment intent has a status and other state which indicate it can be refunded,\nor `false` if it cannot be refunded.", + "heading": "Description" + } + ], + "signature": "isRefundable(): boolean", + "source": "script-api", + "tags": [ + "isrefundable", + "salesforcepaymentintent.isrefundable" + ], + "title": "SalesforcePaymentIntent.isRefundable" + }, + { + "description": "Returns the payment method for this payment intent, or `null` if none has been established.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#paymentMethod", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.paymentMethod", + "sections": [ + { + "body": "Returns the payment method for this payment intent, or `null` if none has been established.", + "heading": "Description" + } + ], + "signature": "readonly paymentMethod: SalesforcePaymentMethod | null", + "source": "script-api", + "tags": [ + "paymentmethod", + "salesforcepaymentintent.paymentmethod" + ], + "title": "SalesforcePaymentIntent.paymentMethod" + }, + { + "description": "Returns `true` if this payment intent has a status and other state which indicate it can be refunded, or `false` if it cannot be refunded.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#refundable", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.refundable", + "sections": [ + { + "body": "Returns `true` if this payment intent has a status and other state which indicate it can be refunded,\nor `false` if it cannot be refunded.", + "heading": "Description" + } + ], + "signature": "readonly refundable: boolean", + "source": "script-api", + "tags": [ + "refundable", + "salesforcepaymentintent.refundable" + ], + "title": "SalesforcePaymentIntent.refundable" + }, + { + "description": "Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns `null` if future usage is not set up.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentIntent#setupFutureUsage", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentIntent", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentIntent.setupFutureUsage", + "sections": [ + { + "body": "Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment\nintent can be used in the future or returns `null` if future usage is not set up.", + "heading": "Description" + } + ], + "signature": "readonly setupFutureUsage: string | null", + "source": "script-api", + "tags": [ + "setupfutureusage", + "salesforcepaymentintent.setupfutureusage" + ], + "title": "SalesforcePaymentIntent.setupFutureUsage" + }, + { + "description": "Salesforce Payments representation of a payment method object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod", + "sections": [ + { + "body": "Salesforce Payments representation of a payment method object. See Salesforce Payments documentation for how\nto gain access and configure it for use on your sites.\n\nA payment method contains information about a credential used by a shopper to attempt payment, such as a payment card\nor bank account. The available information differs for each type of payment method. It includes only limited\ninformation that can be safely presented to a shopper to remind them what credential they used, and specifically not\ncomplete card, account, or other numbers that could be used to make future payments.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentmethod", + "dw.extensions.payments.salesforcepaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentMethod" + }, + { + "description": "Returns the identifier of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.ID", + "sections": [ + { + "body": "Returns the identifier of this payment method.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforcepaymentmethod.id" + ], + "title": "SalesforcePaymentMethod.ID" + }, + { + "description": "Represents the Afterpay Clearpay payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY", + "sections": [ + { + "body": "Represents the Afterpay Clearpay payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AFTERPAY_CLEARPAY = \"afterpay_clearpay\"", + "source": "script-api", + "tags": [ + "type_afterpay_clearpay", + "salesforcepaymentmethod.type_afterpay_clearpay" + ], + "title": "SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY" + }, + { + "description": "Represents the Afterpay Clearpay payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY", + "sections": [ + { + "body": "Represents the Afterpay Clearpay payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AFTERPAY_CLEARPAY = \"afterpay_clearpay\"", + "source": "script-api", + "tags": [ + "type_afterpay_clearpay", + "salesforcepaymentmethod.type_afterpay_clearpay" + ], + "title": "SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY" + }, + { + "description": "Represents the Bancontact payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_BANCONTACT", + "sections": [ + { + "body": "Represents the Bancontact payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "type_bancontact", + "salesforcepaymentmethod.type_bancontact" + ], + "title": "SalesforcePaymentMethod.TYPE_BANCONTACT" + }, + { + "description": "Represents the Bancontact payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_BANCONTACT", + "sections": [ + { + "body": "Represents the Bancontact payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "type_bancontact", + "salesforcepaymentmethod.type_bancontact" + ], + "title": "SalesforcePaymentMethod.TYPE_BANCONTACT" + }, + { + "description": "Represents a credit card type of payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "type_card", + "salesforcepaymentmethod.type_card" + ], + "title": "SalesforcePaymentMethod.TYPE_CARD" + }, + { + "description": "Represents a credit card type of payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "type_card", + "salesforcepaymentmethod.type_card" + ], + "title": "SalesforcePaymentMethod.TYPE_CARD" + }, + { + "description": "Represents the EPS (Electronic Payment Standard) payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_EPS", + "sections": [ + { + "body": "Represents the EPS (Electronic Payment Standard) payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_EPS = \"eps\"", + "source": "script-api", + "tags": [ + "type_eps", + "salesforcepaymentmethod.type_eps" + ], + "title": "SalesforcePaymentMethod.TYPE_EPS" + }, + { + "description": "Represents the EPS (Electronic Payment Standard) payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_EPS", + "sections": [ + { + "body": "Represents the EPS (Electronic Payment Standard) payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_EPS = \"eps\"", + "source": "script-api", + "tags": [ + "type_eps", + "salesforcepaymentmethod.type_eps" + ], + "title": "SalesforcePaymentMethod.TYPE_EPS" + }, + { + "description": "Represents the iDEAL payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_IDEAL", + "sections": [ + { + "body": "Represents the iDEAL payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "type_ideal", + "salesforcepaymentmethod.type_ideal" + ], + "title": "SalesforcePaymentMethod.TYPE_IDEAL" + }, + { + "description": "Represents the iDEAL payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_IDEAL", + "sections": [ + { + "body": "Represents the iDEAL payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "type_ideal", + "salesforcepaymentmethod.type_ideal" + ], + "title": "SalesforcePaymentMethod.TYPE_IDEAL" + }, + { + "description": "Represents the Klarna payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_KLARNA", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_KLARNA", + "sections": [ + { + "body": "Represents the Klarna payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_KLARNA = \"klarna\"", + "source": "script-api", + "tags": [ + "type_klarna", + "salesforcepaymentmethod.type_klarna" + ], + "title": "SalesforcePaymentMethod.TYPE_KLARNA" + }, + { + "description": "Represents the Klarna payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_KLARNA", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_KLARNA", + "sections": [ + { + "body": "Represents the Klarna payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_KLARNA = \"klarna\"", + "source": "script-api", + "tags": [ + "type_klarna", + "salesforcepaymentmethod.type_klarna" + ], + "title": "SalesforcePaymentMethod.TYPE_KLARNA" + }, + { + "description": "Represents the SEPA Debit payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Represents the SEPA Debit payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "type_sepa_debit", + "salesforcepaymentmethod.type_sepa_debit" + ], + "title": "SalesforcePaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "description": "Represents the SEPA Debit payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Represents the SEPA Debit payment method.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "type_sepa_debit", + "salesforcepaymentmethod.type_sepa_debit" + ], + "title": "SalesforcePaymentMethod.TYPE_SEPA_DEBIT" + }, + { + "description": "Returns the bank of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bank", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bank", + "sections": [ + { + "body": "Returns the bank of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.", + "heading": "Description" + } + ], + "signature": "readonly bank: string | null", + "source": "script-api", + "tags": [ + "bank", + "salesforcepaymentmethod.bank" + ], + "title": "SalesforcePaymentMethod.bank" + }, + { + "description": "Returns the bank code of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bankCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bankCode", + "sections": [ + { + "body": "Returns the bank code of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly bankCode: string | null", + "source": "script-api", + "tags": [ + "bankcode", + "salesforcepaymentmethod.bankcode" + ], + "title": "SalesforcePaymentMethod.bankCode" + }, + { + "description": "Returns the bank name of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#bankName", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.bankName", + "sections": [ + { + "body": "Returns the bank name of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly bankName: string | null", + "source": "script-api", + "tags": [ + "bankname", + "salesforcepaymentmethod.bankname" + ], + "title": "SalesforcePaymentMethod.bankName" + }, + { + "description": "Returns the bank branch code of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#branchCode", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.branchCode", + "sections": [ + { + "body": "Returns the bank branch code of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "heading": "Description" + } + ], + "signature": "readonly branchCode: string | null", + "source": "script-api", + "tags": [ + "branchcode", + "salesforcepaymentmethod.branchcode" + ], + "title": "SalesforcePaymentMethod.branchCode" + }, + { + "description": "Returns the brand of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_CARD type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#brand", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.brand", + "sections": [ + { + "body": "Returns the brand of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_CARD type methods.", + "heading": "Description" + } + ], + "signature": "readonly brand: string | null", + "source": "script-api", + "tags": [ + "brand", + "salesforcepaymentmethod.brand" + ], + "title": "SalesforcePaymentMethod.brand" + }, + { + "description": "Returns the country of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#country", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.country", + "sections": [ + { + "body": "Returns the country of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "heading": "Description" + } + ], + "signature": "readonly country: string | null", + "source": "script-api", + "tags": [ + "country", + "salesforcepaymentmethod.country" + ], + "title": "SalesforcePaymentMethod.country" + }, + { + "description": "Returns the bank of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBank", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBank", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.", + "heading": "Description" + } + ], + "signature": "getBank(): string | null", + "source": "script-api", + "tags": [ + "getbank", + "salesforcepaymentmethod.getbank" + ], + "title": "SalesforcePaymentMethod.getBank" + }, + { + "description": "Returns the bank code of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBankCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBankCode", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank code of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getBankCode(): string | null", + "source": "script-api", + "tags": [ + "getbankcode", + "salesforcepaymentmethod.getbankcode" + ], + "title": "SalesforcePaymentMethod.getBankCode" + }, + { + "description": "Returns the bank name of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBankName", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBankName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank name of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getBankName(): string | null", + "source": "script-api", + "tags": [ + "getbankname", + "salesforcepaymentmethod.getbankname" + ], + "title": "SalesforcePaymentMethod.getBankName" + }, + { + "description": "Returns the bank branch code of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBranchCode", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBranchCode", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the bank branch code of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "heading": "Description" + } + ], + "signature": "getBranchCode(): string | null", + "source": "script-api", + "tags": [ + "getbranchcode", + "salesforcepaymentmethod.getbranchcode" + ], + "title": "SalesforcePaymentMethod.getBranchCode" + }, + { + "description": "Returns the brand of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_CARD type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getBrand", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getBrand", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the brand of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_CARD type methods.", + "heading": "Description" + } + ], + "signature": "getBrand(): string | null", + "source": "script-api", + "tags": [ + "getbrand", + "salesforcepaymentmethod.getbrand" + ], + "title": "SalesforcePaymentMethod.getBrand" + }, + { + "description": "Returns the country of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getCountry", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getCountry", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the country of this payment method, or `null` if none is available. Available on\nSalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.", + "heading": "Description" + } + ], + "signature": "getCountry(): string | null", + "source": "script-api", + "tags": [ + "getcountry", + "salesforcepaymentmethod.getcountry" + ], + "title": "SalesforcePaymentMethod.getCountry" + }, + { + "description": "Returns the identifier of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this payment method.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforcepaymentmethod.getid" + ], + "title": "SalesforcePaymentMethod.getID" + }, + { + "description": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getLast4", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available.\nAvailable on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and\nSalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "getLast4(): string | null", + "source": "script-api", + "tags": [ + "getlast4", + "salesforcepaymentmethod.getlast4" + ], + "title": "SalesforcePaymentMethod.getLast4" + }, + { + "description": "Returns the details to the Salesforce Payments payment for this payment method, using the given payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getPaymentDetails", + "returns": { + "type": "SalesforcePaymentDetails" + }, + "sections": [ + { + "body": "Returns the details to the Salesforce Payments payment for this payment method, using the given payment\ninstrument.", + "heading": "Description" + } + ], + "signature": "getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails", + "source": "script-api", + "tags": [ + "getpaymentdetails", + "salesforcepaymentmethod.getpaymentdetails" + ], + "title": "SalesforcePaymentMethod.getPaymentDetails" + }, + { + "description": "Returns the payment method category of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_KLARNA type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getPaymentMethodCategory", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getPaymentMethodCategory", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the payment method category of this payment method, or `null` if none is available. Available\non SalesforcePaymentMethod.TYPE_KLARNA type methods.", + "heading": "Description" + } + ], + "signature": "getPaymentMethodCategory(): string | null", + "source": "script-api", + "tags": [ + "getpaymentmethodcategory", + "salesforcepaymentmethod.getpaymentmethodcategory" + ], + "title": "SalesforcePaymentMethod.getPaymentMethodCategory" + }, + { + "description": "Returns the type of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#getType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of this payment method.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "salesforcepaymentmethod.gettype" + ], + "title": "SalesforcePaymentMethod.getType" + }, + { + "description": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.last4", + "sections": [ + { + "body": "Returns the last 4 digits of the credential for this payment method, or `null` if none is available.\nAvailable on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and\nSalesforcePaymentMethod.TYPE_BANCONTACT type methods.", + "heading": "Description" + } + ], + "signature": "readonly last4: string | null", + "source": "script-api", + "tags": [ + "last4", + "salesforcepaymentmethod.last4" + ], + "title": "SalesforcePaymentMethod.last4" + }, + { + "description": "Returns the payment method category of this payment method, or `null` if none is available. Available on SalesforcePaymentMethod.TYPE_KLARNA type methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#paymentMethodCategory", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.paymentMethodCategory", + "sections": [ + { + "body": "Returns the payment method category of this payment method, or `null` if none is available. Available\non SalesforcePaymentMethod.TYPE_KLARNA type methods.", + "heading": "Description" + } + ], + "signature": "readonly paymentMethodCategory: string | null", + "source": "script-api", + "tags": [ + "paymentmethodcategory", + "salesforcepaymentmethod.paymentmethodcategory" + ], + "title": "SalesforcePaymentMethod.paymentMethodCategory" + }, + { + "description": "Returns the type of this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentMethod#type", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentMethod.type", + "sections": [ + { + "body": "Returns the type of this payment method.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "salesforcepaymentmethod.type" + ], + "title": "SalesforcePaymentMethod.type" + }, + { + "description": "Salesforce Payments request for a shopper to make payment. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest", + "sections": [ + { + "body": "Salesforce Payments request for a shopper to make payment. See Salesforce Payments documentation for how to\ngain access and configure it for use on your sites.\n\nA request is required to render payment methods and/or express checkout buttons using ``\nor ``. You can call methods on the payment request to configure which payment methods\nand/or express checkout buttons may be presented, and customize their visual presentation.\n\nWhen used with `` you must provide the necessary data to prepare the shopper basket to buy\nthe product, and the necessary payment request options for the browser payment app.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentrequest", + "dw.extensions.payments.salesforcepaymentrequest", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentRequest" + }, + { + "description": "Element for the Stripe Afterpay/Clearpay message `\"afterpayClearpayMessage\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "sections": [ + { + "body": "Element for the Stripe Afterpay/Clearpay message `\"afterpayClearpayMessage\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_AFTERPAY_CLEARPAY_MESSAGE = \"afterpayClearpayMessage\"", + "source": "script-api", + "tags": [ + "element_afterpay_clearpay_message", + "salesforcepaymentrequest.element_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "description": "Element for the Stripe Afterpay/Clearpay message `\"afterpayClearpayMessage\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE", + "sections": [ + { + "body": "Element for the Stripe Afterpay/Clearpay message `\"afterpayClearpayMessage\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_AFTERPAY_CLEARPAY_MESSAGE = \"afterpayClearpayMessage\"", + "source": "script-api", + "tags": [ + "element_afterpay_clearpay_message", + "salesforcepaymentrequest.element_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "description": "Element for the Stripe credit card CVC field `\"cardCvc\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_CVC", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_CVC", + "sections": [ + { + "body": "Element for the Stripe credit card CVC field `\"cardCvc\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_CVC = \"cardCvc\"", + "source": "script-api", + "tags": [ + "element_card_cvc", + "salesforcepaymentrequest.element_card_cvc" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_CVC" + }, + { + "description": "Element for the Stripe credit card CVC field `\"cardCvc\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_CVC", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_CVC", + "sections": [ + { + "body": "Element for the Stripe credit card CVC field `\"cardCvc\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_CVC = \"cardCvc\"", + "source": "script-api", + "tags": [ + "element_card_cvc", + "salesforcepaymentrequest.element_card_cvc" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_CVC" + }, + { + "description": "Element for the Stripe credit card expiration date field `\"cardExpiry\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_EXPIRY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY", + "sections": [ + { + "body": "Element for the Stripe credit card expiration date field `\"cardExpiry\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_EXPIRY = \"cardExpiry\"", + "source": "script-api", + "tags": [ + "element_card_expiry", + "salesforcepaymentrequest.element_card_expiry" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY" + }, + { + "description": "Element for the Stripe credit card expiration date field `\"cardExpiry\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_EXPIRY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY", + "sections": [ + { + "body": "Element for the Stripe credit card expiration date field `\"cardExpiry\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_EXPIRY = \"cardExpiry\"", + "source": "script-api", + "tags": [ + "element_card_expiry", + "salesforcepaymentrequest.element_card_expiry" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_EXPIRY" + }, + { + "description": "Element for the Stripe credit card number field `\"cardNumber\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_NUMBER", + "sections": [ + { + "body": "Element for the Stripe credit card number field `\"cardNumber\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_NUMBER = \"cardNumber\"", + "source": "script-api", + "tags": [ + "element_card_number", + "salesforcepaymentrequest.element_card_number" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_NUMBER" + }, + { + "description": "Element for the Stripe credit card number field `\"cardNumber\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_CARD_NUMBER", + "sections": [ + { + "body": "Element for the Stripe credit card number field `\"cardNumber\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_CARD_NUMBER = \"cardNumber\"", + "source": "script-api", + "tags": [ + "element_card_number", + "salesforcepaymentrequest.element_card_number" + ], + "title": "SalesforcePaymentRequest.ELEMENT_CARD_NUMBER" + }, + { + "description": "Element for the Stripe EPS bank selection field `\"epsBank\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_EPS_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_EPS_BANK", + "sections": [ + { + "body": "Element for the Stripe EPS bank selection field `\"epsBank\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_EPS_BANK = \"epsBank\"", + "source": "script-api", + "tags": [ + "element_eps_bank", + "salesforcepaymentrequest.element_eps_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_EPS_BANK" + }, + { + "description": "Element for the Stripe EPS bank selection field `\"epsBank\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_EPS_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_EPS_BANK", + "sections": [ + { + "body": "Element for the Stripe EPS bank selection field `\"epsBank\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_EPS_BANK = \"epsBank\"", + "source": "script-api", + "tags": [ + "element_eps_bank", + "salesforcepaymentrequest.element_eps_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_EPS_BANK" + }, + { + "description": "Element for the Stripe IBAN field `\"iban\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IBAN", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IBAN", + "sections": [ + { + "body": "Element for the Stripe IBAN field `\"iban\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_IBAN = \"iban\"", + "source": "script-api", + "tags": [ + "element_iban", + "salesforcepaymentrequest.element_iban" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IBAN" + }, + { + "description": "Element for the Stripe IBAN field `\"iban\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IBAN", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IBAN", + "sections": [ + { + "body": "Element for the Stripe IBAN field `\"iban\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_IBAN = \"iban\"", + "source": "script-api", + "tags": [ + "element_iban", + "salesforcepaymentrequest.element_iban" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IBAN" + }, + { + "description": "Element for the Stripe iDEAL bank selection field `\"idealBank\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IDEAL_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IDEAL_BANK", + "sections": [ + { + "body": "Element for the Stripe iDEAL bank selection field `\"idealBank\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_IDEAL_BANK = \"idealBank\"", + "source": "script-api", + "tags": [ + "element_ideal_bank", + "salesforcepaymentrequest.element_ideal_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IDEAL_BANK" + }, + { + "description": "Element for the Stripe iDEAL bank selection field `\"idealBank\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_IDEAL_BANK", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_IDEAL_BANK", + "sections": [ + { + "body": "Element for the Stripe iDEAL bank selection field `\"idealBank\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_IDEAL_BANK = \"idealBank\"", + "source": "script-api", + "tags": [ + "element_ideal_bank", + "salesforcepaymentrequest.element_ideal_bank" + ], + "title": "SalesforcePaymentRequest.ELEMENT_IDEAL_BANK" + }, + { + "description": "Element for the Stripe payment request button `\"paymentRequestButton\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_PAYMENT_REQUEST_BUTTON", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON", + "sections": [ + { + "body": "Element for the Stripe payment request button `\"paymentRequestButton\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_PAYMENT_REQUEST_BUTTON = \"paymentRequestButton\"", + "source": "script-api", + "tags": [ + "element_payment_request_button", + "salesforcepaymentrequest.element_payment_request_button" + ], + "title": "SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON" + }, + { + "description": "Element for the Stripe payment request button `\"paymentRequestButton\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_PAYMENT_REQUEST_BUTTON", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON", + "sections": [ + { + "body": "Element for the Stripe payment request button `\"paymentRequestButton\"`.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_PAYMENT_REQUEST_BUTTON = \"paymentRequestButton\"", + "source": "script-api", + "tags": [ + "element_payment_request_button", + "salesforcepaymentrequest.element_payment_request_button" + ], + "title": "SalesforcePaymentRequest.ELEMENT_PAYMENT_REQUEST_BUTTON" + }, + { + "description": "Element type name for Afterpay.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "sections": [ + { + "body": "Element type name for Afterpay.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_AFTERPAY_CLEARPAY = \"afterpay_clearpay\"", + "source": "script-api", + "tags": [ + "element_type_afterpay_clearpay", + "salesforcepaymentrequest.element_type_afterpay_clearpay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY" + }, + { + "description": "Element type name for Afterpay.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY", + "sections": [ + { + "body": "Element type name for Afterpay.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_AFTERPAY_CLEARPAY = \"afterpay_clearpay\"", + "source": "script-api", + "tags": [ + "element_type_afterpay_clearpay", + "salesforcepaymentrequest.element_type_afterpay_clearpay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY" + }, + { + "description": "Element type name for Afterpay/Clearpay message.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "sections": [ + { + "body": "Element type name for Afterpay/Clearpay message.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE = \"afterpayclearpaymessage\"", + "source": "script-api", + "tags": [ + "element_type_afterpay_clearpay_message", + "salesforcepaymentrequest.element_type_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "description": "Element type name for Afterpay/Clearpay message.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE", + "sections": [ + { + "body": "Element type name for Afterpay/Clearpay message.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE = \"afterpayclearpaymessage\"", + "source": "script-api", + "tags": [ + "element_type_afterpay_clearpay_message", + "salesforcepaymentrequest.element_type_afterpay_clearpay_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_AFTERPAY_CLEARPAY_MESSAGE" + }, + { + "description": "Element type name for Apple Pay payment request buttons.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_APPLEPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY", + "sections": [ + { + "body": "Element type name for Apple Pay payment request buttons.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_APPLEPAY = \"applepay\"", + "source": "script-api", + "tags": [ + "element_type_applepay", + "salesforcepaymentrequest.element_type_applepay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY" + }, + { + "description": "Element type name for Apple Pay payment request buttons.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_APPLEPAY", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY", + "sections": [ + { + "body": "Element type name for Apple Pay payment request buttons.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_APPLEPAY = \"applepay\"", + "source": "script-api", + "tags": [ + "element_type_applepay", + "salesforcepaymentrequest.element_type_applepay" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_APPLEPAY" + }, + { + "description": "Element type name for Bancontact.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT", + "sections": [ + { + "body": "Element type name for Bancontact.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "element_type_bancontact", + "salesforcepaymentrequest.element_type_bancontact" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT" + }, + { + "description": "Element type name for Bancontact.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_BANCONTACT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT", + "sections": [ + { + "body": "Element type name for Bancontact.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_BANCONTACT = \"bancontact\"", + "source": "script-api", + "tags": [ + "element_type_bancontact", + "salesforcepaymentrequest.element_type_bancontact" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_BANCONTACT" + }, + { + "description": "Element type name for credit cards.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_CARD", + "sections": [ + { + "body": "Element type name for credit cards.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "element_type_card", + "salesforcepaymentrequest.element_type_card" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_CARD" + }, + { + "description": "Element type name for credit cards.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_CARD", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_CARD", + "sections": [ + { + "body": "Element type name for credit cards.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_CARD = \"card\"", + "source": "script-api", + "tags": [ + "element_type_card", + "salesforcepaymentrequest.element_type_card" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_CARD" + }, + { + "description": "Element type name for EPS.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_EPS", + "sections": [ + { + "body": "Element type name for EPS.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_EPS = \"eps\"", + "source": "script-api", + "tags": [ + "element_type_eps", + "salesforcepaymentrequest.element_type_eps" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_EPS" + }, + { + "description": "Element type name for EPS.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_EPS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_EPS", + "sections": [ + { + "body": "Element type name for EPS.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_EPS = \"eps\"", + "source": "script-api", + "tags": [ + "element_type_eps", + "salesforcepaymentrequest.element_type_eps" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_EPS" + }, + { + "description": "Element type name for iDEAL.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL", + "sections": [ + { + "body": "Element type name for iDEAL.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "element_type_ideal", + "salesforcepaymentrequest.element_type_ideal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL" + }, + { + "description": "Element type name for iDEAL.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_IDEAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL", + "sections": [ + { + "body": "Element type name for iDEAL.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_IDEAL = \"ideal\"", + "source": "script-api", + "tags": [ + "element_type_ideal", + "salesforcepaymentrequest.element_type_ideal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_IDEAL" + }, + { + "description": "Element type name for other payment request buttons besides Apple Pay, like Google Pay.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYMENTREQUEST", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST", + "sections": [ + { + "body": "Element type name for other payment request buttons besides Apple Pay, like Google Pay.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYMENTREQUEST = \"paymentrequest\"", + "source": "script-api", + "tags": [ + "element_type_paymentrequest", + "salesforcepaymentrequest.element_type_paymentrequest" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST" + }, + { + "description": "Element type name for other payment request buttons besides Apple Pay, like Google Pay.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYMENTREQUEST", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST", + "sections": [ + { + "body": "Element type name for other payment request buttons besides Apple Pay, like Google Pay.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYMENTREQUEST = \"paymentrequest\"", + "source": "script-api", + "tags": [ + "element_type_paymentrequest", + "salesforcepaymentrequest.element_type_paymentrequest" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYMENTREQUEST" + }, + { + "description": "Element type name for PayPal in multi-step checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL", + "sections": [ + { + "body": "Element type name for PayPal in multi-step checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL = \"paypal\"", + "source": "script-api", + "tags": [ + "element_type_paypal", + "salesforcepaymentrequest.element_type_paypal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL" + }, + { + "description": "Element type name for PayPal in multi-step checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL", + "sections": [ + { + "body": "Element type name for PayPal in multi-step checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL = \"paypal\"", + "source": "script-api", + "tags": [ + "element_type_paypal", + "salesforcepaymentrequest.element_type_paypal" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL" + }, + { + "description": "Element type name for PayPal in express checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS", + "sections": [ + { + "body": "Element type name for PayPal in express checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL_EXPRESS = \"paypalexpress\"", + "source": "script-api", + "tags": [ + "element_type_paypal_express", + "salesforcepaymentrequest.element_type_paypal_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS" + }, + { + "description": "Element type name for PayPal in express checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS", + "sections": [ + { + "body": "Element type name for PayPal in express checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL_EXPRESS = \"paypalexpress\"", + "source": "script-api", + "tags": [ + "element_type_paypal_express", + "salesforcepaymentrequest.element_type_paypal_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_EXPRESS" + }, + { + "description": "Element type name for the PayPal messages component.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE", + "sections": [ + { + "body": "Element type name for the PayPal messages component.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL_MESSAGE = \"paypalmessage\"", + "source": "script-api", + "tags": [ + "element_type_paypal_message", + "salesforcepaymentrequest.element_type_paypal_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE" + }, + { + "description": "Element type name for the PayPal messages component.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_PAYPAL_MESSAGE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE", + "sections": [ + { + "body": "Element type name for the PayPal messages component.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_PAYPAL_MESSAGE = \"paypalmessage\"", + "source": "script-api", + "tags": [ + "element_type_paypal_message", + "salesforcepaymentrequest.element_type_paypal_message" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_PAYPAL_MESSAGE" + }, + { + "description": "Element type name for SEPA debit.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Element type name for SEPA debit.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "element_type_sepa_debit", + "salesforcepaymentrequest.element_type_sepa_debit" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT" + }, + { + "description": "Element type name for SEPA debit.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_SEPA_DEBIT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT", + "sections": [ + { + "body": "Element type name for SEPA debit.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_SEPA_DEBIT = \"sepa_debit\"", + "source": "script-api", + "tags": [ + "element_type_sepa_debit", + "salesforcepaymentrequest.element_type_sepa_debit" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_SEPA_DEBIT" + }, + { + "description": "Element type name for Venmo in multi-step checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO", + "sections": [ + { + "body": "Element type name for Venmo in multi-step checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_VENMO = \"venmo\"", + "source": "script-api", + "tags": [ + "element_type_venmo", + "salesforcepaymentrequest.element_type_venmo" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO" + }, + { + "description": "Element type name for Venmo in multi-step checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO", + "sections": [ + { + "body": "Element type name for Venmo in multi-step checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_VENMO = \"venmo\"", + "source": "script-api", + "tags": [ + "element_type_venmo", + "salesforcepaymentrequest.element_type_venmo" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO" + }, + { + "description": "Element type name for Venmo in express checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS", + "sections": [ + { + "body": "Element type name for Venmo in express checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_VENMO_EXPRESS = \"venmoexpress\"", + "source": "script-api", + "tags": [ + "element_type_venmo_express", + "salesforcepaymentrequest.element_type_venmo_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS" + }, + { + "description": "Element type name for Venmo in express checkout.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ELEMENT_TYPE_VENMO_EXPRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS", + "sections": [ + { + "body": "Element type name for Venmo in express checkout.", + "heading": "Description" + } + ], + "signature": "static readonly ELEMENT_TYPE_VENMO_EXPRESS = \"venmoexpress\"", + "source": "script-api", + "tags": [ + "element_type_venmo_express", + "salesforcepaymentrequest.element_type_venmo_express" + ], + "title": "SalesforcePaymentRequest.ELEMENT_TYPE_VENMO_EXPRESS" + }, + { + "description": "Returns the identifier of this payment request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#ID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.ID", + "sections": [ + { + "body": "Returns the identifier of this payment request.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "salesforcepaymentrequest.id" + ], + "title": "SalesforcePaymentRequest.ID" + }, + { + "description": "PayPal application context `shipping_preference` value `\"GET_FROM_FILE\"`, to use the customer-provided shipping address on the PayPal site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"GET_FROM_FILE\"`, to use the\ncustomer-provided shipping address on the PayPal site.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE = \"GET_FROM_FILE\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_get_from_file", + "salesforcepaymentrequest.paypal_shipping_preference_get_from_file" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE" + }, + { + "description": "PayPal application context `shipping_preference` value `\"GET_FROM_FILE\"`, to use the customer-provided shipping address on the PayPal site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"GET_FROM_FILE\"`, to use the\ncustomer-provided shipping address on the PayPal site.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE = \"GET_FROM_FILE\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_get_from_file", + "salesforcepaymentrequest.paypal_shipping_preference_get_from_file" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_GET_FROM_FILE" + }, + { + "description": "PayPal application context `shipping_preference` value `\"NO_SHIPPING\"`, to redact the shipping address from the PayPal site. Recommended for digital goods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"NO_SHIPPING\"`, to redact the\nshipping address from the PayPal site. Recommended for digital goods.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING = \"NO_SHIPPING\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_no_shipping", + "salesforcepaymentrequest.paypal_shipping_preference_no_shipping" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING" + }, + { + "description": "PayPal application context `shipping_preference` value `\"NO_SHIPPING\"`, to redact the shipping address from the PayPal site. Recommended for digital goods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"NO_SHIPPING\"`, to redact the\nshipping address from the PayPal site. Recommended for digital goods.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING = \"NO_SHIPPING\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_no_shipping", + "salesforcepaymentrequest.paypal_shipping_preference_no_shipping" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_NO_SHIPPING" + }, + { + "description": "PayPal application context `shipping_preference` value `\"SET_PROVIDED_ADDRESS\"`, to use the merchant-provided address. The customer cannot change this address on the PayPal site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"SET_PROVIDED_ADDRESS\"`, to use the\nmerchant-provided address. The customer cannot change this address on the PayPal site.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS = \"SET_PROVIDED_ADDRESS\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_set_provided_address", + "salesforcepaymentrequest.paypal_shipping_preference_set_provided_address" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS" + }, + { + "description": "PayPal application context `shipping_preference` value `\"SET_PROVIDED_ADDRESS\"`, to use the merchant-provided address. The customer cannot change this address on the PayPal site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS", + "sections": [ + { + "body": "PayPal application context `shipping_preference` value `\"SET_PROVIDED_ADDRESS\"`, to use the\nmerchant-provided address. The customer cannot change this address on the PayPal site.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS = \"SET_PROVIDED_ADDRESS\"", + "source": "script-api", + "tags": [ + "paypal_shipping_preference_set_provided_address", + "salesforcepaymentrequest.paypal_shipping_preference_set_provided_address" + ], + "title": "SalesforcePaymentRequest.PAYPAL_SHIPPING_PREFERENCE_SET_PROVIDED_ADDRESS" + }, + { + "description": "PayPal application context `user_action` value `\"CONTINUE\"`. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_CONTINUE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE", + "sections": [ + { + "body": "PayPal application context `user_action` value `\"CONTINUE\"`. Use this option when the final\namount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant\npage without processing the payment.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_USER_ACTION_CONTINUE = \"CONTINUE\"", + "source": "script-api", + "tags": [ + "paypal_user_action_continue", + "salesforcepaymentrequest.paypal_user_action_continue" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE" + }, + { + "description": "PayPal application context `user_action` value `\"CONTINUE\"`. Use this option when the final amount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant page without processing the payment.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_CONTINUE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE", + "sections": [ + { + "body": "PayPal application context `user_action` value `\"CONTINUE\"`. Use this option when the final\namount is not known when the checkout flow is initiated and you want to redirect the customer to the merchant\npage without processing the payment.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_USER_ACTION_CONTINUE = \"CONTINUE\"", + "source": "script-api", + "tags": [ + "paypal_user_action_continue", + "salesforcepaymentrequest.paypal_user_action_continue" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_CONTINUE" + }, + { + "description": "PayPal application context `user_action` value `\"PAY_NOW\"`. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_PAY_NOW", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW", + "sections": [ + { + "body": "PayPal application context `user_action` value `\"PAY_NOW\"`. Use this option when the final\namount is known when the checkout is initiated and you want to process the payment immediately when the customer\nclicks Pay Now.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_USER_ACTION_PAY_NOW = \"PAY_NOW\"", + "source": "script-api", + "tags": [ + "paypal_user_action_pay_now", + "salesforcepaymentrequest.paypal_user_action_pay_now" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW" + }, + { + "description": "PayPal application context `user_action` value `\"PAY_NOW\"`. Use this option when the final amount is known when the checkout is initiated and you want to process the payment immediately when the customer clicks Pay Now.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#PAYPAL_USER_ACTION_PAY_NOW", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW", + "sections": [ + { + "body": "PayPal application context `user_action` value `\"PAY_NOW\"`. Use this option when the final\namount is known when the checkout is initiated and you want to process the payment immediately when the customer\nclicks Pay Now.", + "heading": "Description" + } + ], + "signature": "static readonly PAYPAL_USER_ACTION_PAY_NOW = \"PAY_NOW\"", + "source": "script-api", + "tags": [ + "paypal_user_action_pay_now", + "salesforcepaymentrequest.paypal_user_action_pay_now" + ], + "title": "SalesforcePaymentRequest.PAYPAL_USER_ACTION_PAY_NOW" + }, + { + "description": "Adds the given element type to explicitly exclude from mounted components. It is not necessary to explicitly exclude element types that are not enabled for the site, or are not applicable for the current shopper and/or their basket. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#addExclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "elementType", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.addExclude", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the given element type to explicitly exclude from mounted components. It is not necessary to explicitly\nexclude element types that are not enabled for the site, or are not applicable for the current shopper and/or\ntheir basket. See the element type constants in this class for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "addExclude(elementType: string): void", + "source": "script-api", + "tags": [ + "addexclude", + "salesforcepaymentrequest.addexclude" + ], + "title": "SalesforcePaymentRequest.addExclude" + }, + { + "description": "Adds the given element type to include in mounted components. Call this method to include only a specific list of element types to be presented when applicable and enabled for the site. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#addInclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "elementType", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.addInclude", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the given element type to include in mounted components. Call this method to include only a specific list of\nelement types to be presented when applicable and enabled for the site. See the element type constants in this\nclass for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "addInclude(elementType: string): void", + "source": "script-api", + "tags": [ + "addinclude", + "salesforcepaymentrequest.addinclude" + ], + "title": "SalesforcePaymentRequest.addInclude" + }, + { + "description": "Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#basketData", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.basketData", + "sections": [ + { + "body": "Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.", + "heading": "Description" + } + ], + "signature": "basketData: Object", + "source": "script-api", + "tags": [ + "basketdata", + "salesforcepaymentrequest.basketdata" + ], + "title": "SalesforcePaymentRequest.basketData" + }, + { + "description": "Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#billingDetails", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.billingDetails", + "sections": [ + { + "body": "Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.", + "heading": "Description" + } + ], + "signature": "billingDetails: Object", + "source": "script-api", + "tags": [ + "billingdetails", + "salesforcepaymentrequest.billingdetails" + ], + "title": "SalesforcePaymentRequest.billingDetails" + }, + { + "description": "Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the appropriate format for use in client side JavaScript, with data calculated from the given basket. This method is provided as a convenience to calculate updated payment request options when the shopper basket has changed. Data in the given `options` object like `total`, `displayItems`, and `shippingOptions` will be replaced in the returned object by values recalculated from the given `basket` and applicable shipping methods.", + "examples": [ + "`\nSalesforcePaymentRequest.calculatePaymentRequestOptions(basket, {\nrequestPayerName: true,\nrequestPayerEmail: true,\nrequestPayerPhone: false,\nrequestShipping: true\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#calculatePaymentRequestOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.calculatePaymentRequestOptions", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the\nappropriate format for use in client side JavaScript, with data calculated from the given basket. This method is\nprovided as a convenience to calculate updated payment request options when the shopper basket has changed. Data\nin the given `options` object like `total`, `displayItems`, and\n`shippingOptions` will be replaced in the returned object by values recalculated from the given\n`basket` and applicable shipping methods.\n\nThe following example shows the resulting output for a basket and sample options.\n\n\nreturns", + "heading": "Description" + } + ], + "signature": "static calculatePaymentRequestOptions(basket: Basket, options: Object): Object", + "source": "script-api", + "tags": [ + "calculatepaymentrequestoptions", + "salesforcepaymentrequest.calculatepaymentrequestoptions" + ], + "title": "SalesforcePaymentRequest.calculatePaymentRequestOptions" + }, + { + "description": "Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the appropriate format for use in client side JavaScript, with data calculated from the given basket. This method is provided as a convenience to calculate updated payment request options when the shopper basket has changed. Data in the given `options` object like `total`, `displayItems`, and `shippingOptions` will be replaced in the returned object by values recalculated from the given `basket` and applicable shipping methods.", + "examples": [ + "`\nSalesforcePaymentRequest.calculatePaymentRequestOptions(basket, {\nrequestPayerName: true,\nrequestPayerEmail: true,\nrequestPayerPhone: false,\nrequestShipping: true\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#calculatePaymentRequestOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.calculatePaymentRequestOptions", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the payment request options to use when a Pay Now button is tapped, in the\nappropriate format for use in client side JavaScript, with data calculated from the given basket. This method is\nprovided as a convenience to calculate updated payment request options when the shopper basket has changed. Data\nin the given `options` object like `total`, `displayItems`, and\n`shippingOptions` will be replaced in the returned object by values recalculated from the given\n`basket` and applicable shipping methods.\n\nThe following example shows the resulting output for a basket and sample options.\n\n\nreturns", + "heading": "Description" + } + ], + "signature": "static calculatePaymentRequestOptions(basket: Basket, options: Object): Object", + "source": "script-api", + "tags": [ + "calculatepaymentrequestoptions", + "salesforcepaymentrequest.calculatepaymentrequestoptions" + ], + "title": "SalesforcePaymentRequest.calculatePaymentRequestOptions" + }, + { + "description": "Returns `true` if the credit card payment should be automatically captured at the time of the sale, or `false` if the credit card payment should be captured later.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#cardCaptureAutomatic", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.cardCaptureAutomatic", + "sections": [ + { + "body": "Returns `true` if the credit card payment should be automatically captured at the time of the sale, or\n`false` if the credit card payment should be captured later.", + "heading": "Description" + } + ], + "signature": "cardCaptureAutomatic: boolean", + "source": "script-api", + "tags": [ + "cardcaptureautomatic", + "salesforcepaymentrequest.cardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.cardCaptureAutomatic" + }, + { + "description": "Returns a set containing the element types to be explicitly excluded from mounted components. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#exclude", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.exclude", + "sections": [ + { + "body": "Returns a set containing the element types to be explicitly excluded from mounted components. See the element\ntype constants in this class for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "readonly exclude: utilSet", + "source": "script-api", + "tags": [ + "exclude", + "salesforcepaymentrequest.exclude" + ], + "title": "SalesforcePaymentRequest.exclude" + }, + { + "description": "Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the appropriate format for use in client side JavaScript. This method is provided as a convenience to adjust values in B2C Commerce API standard formats to their equivalents as expected by Stripe JS APIs. The following example shows options set in B2C Commerce API format, and the resulting output.", + "examples": [ + "`\nSalesforcePaymentRequest.format({\ncurrency: 'GBP',\ntotal: {\nlabel: 'Total',\namount: '26.44'\n},\ndisplayItems: [{\nlabel: 'Subtotal',\namount: '19.19'\n}, {\nlabel: 'Tax',\namount: '1.26'\n}, {\nlabel: 'Ground',\namount: '5.99'\n}],\nrequestPayerPhone: false,\nshippingOptions: [{\nid: 'GBP001',\nlabel: 'Ground',\ndetail: 'Order received within 7-10 business days',\namount: '5.99'\n}]\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#format", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.format", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the\nappropriate format for use in client side JavaScript. This method is provided as a convenience to adjust values\nin B2C Commerce API standard formats to their equivalents as expected by Stripe JS APIs. The following example\nshows options set in B2C Commerce API format, and the resulting output.\n\n\nreturns", + "heading": "Description" + } + ], + "signature": "static format(options: Object): Object", + "source": "script-api", + "tags": [ + "format", + "salesforcepaymentrequest.format" + ], + "title": "SalesforcePaymentRequest.format" + }, + { + "description": "Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the appropriate format for use in client side JavaScript. This method is provided as a convenience to adjust values in B2C Commerce API standard formats to their equivalents as expected by Stripe JS APIs. The following example shows options set in B2C Commerce API format, and the resulting output.", + "examples": [ + "`\nSalesforcePaymentRequest.format({\ncurrency: 'GBP',\ntotal: {\nlabel: 'Total',\namount: '26.44'\n},\ndisplayItems: [{\nlabel: 'Subtotal',\namount: '19.19'\n}, {\nlabel: 'Tax',\namount: '1.26'\n}, {\nlabel: 'Ground',\namount: '5.99'\n}],\nrequestPayerPhone: false,\nshippingOptions: [{\nid: 'GBP001',\nlabel: 'Ground',\ndetail: 'Order received within 7-10 business days',\namount: '5.99'\n}]\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#format", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.format", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the payment request options to use when a Buy Now button is tapped, in the\nappropriate format for use in client side JavaScript. This method is provided as a convenience to adjust values\nin B2C Commerce API standard formats to their equivalents as expected by Stripe JS APIs. The following example\nshows options set in B2C Commerce API format, and the resulting output.\n\n\nreturns", + "heading": "Description" + } + ], + "signature": "static format(options: Object): Object", + "source": "script-api", + "tags": [ + "format", + "salesforcepaymentrequest.format" + ], + "title": "SalesforcePaymentRequest.format" + }, + { + "description": "Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getBasketData", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getBasketData", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the data used to prepare the shopper basket when a Buy Now button is tapped.", + "heading": "Description" + } + ], + "signature": "getBasketData(): Object", + "source": "script-api", + "tags": [ + "getbasketdata", + "salesforcepaymentrequest.getbasketdata" + ], + "title": "SalesforcePaymentRequest.getBasketData" + }, + { + "description": "Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getBillingDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getBillingDetails", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a JS object containing the billing details to use when a Stripe PaymentMethod is created.", + "heading": "Description" + } + ], + "signature": "getBillingDetails(): Object", + "source": "script-api", + "tags": [ + "getbillingdetails", + "salesforcepaymentrequest.getbillingdetails" + ], + "title": "SalesforcePaymentRequest.getBillingDetails" + }, + { + "description": "Returns `true` if the credit card payment should be automatically captured at the time of the sale, or `false` if the credit card payment should be captured later.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getCardCaptureAutomatic", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the credit card payment should be automatically captured at the time of the sale, or\n`false` if the credit card payment should be captured later.", + "heading": "Description" + } + ], + "signature": "getCardCaptureAutomatic(): boolean", + "source": "script-api", + "tags": [ + "getcardcaptureautomatic", + "salesforcepaymentrequest.getcardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.getCardCaptureAutomatic" + }, + { + "description": "Returns a set containing the element types to be explicitly excluded from mounted components. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getExclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getExclude", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns a set containing the element types to be explicitly excluded from mounted components. See the element\ntype constants in this class for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "getExclude(): utilSet", + "source": "script-api", + "tags": [ + "getexclude", + "salesforcepaymentrequest.getexclude" + ], + "title": "SalesforcePaymentRequest.getExclude" + }, + { + "description": "Returns the identifier of this payment request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of this payment request.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "salesforcepaymentrequest.getid" + ], + "title": "SalesforcePaymentRequest.getID" + }, + { + "description": "Returns a set containing the specific element types to include in mounted components. If the set is empty then all applicable and enabled element types will be included by default. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getInclude", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getInclude", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns a set containing the specific element types to include in mounted components. If the set is\nempty then all applicable and enabled element types will be included by default. See the element type constants\nin this class for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "getInclude(): utilSet", + "source": "script-api", + "tags": [ + "getinclude", + "salesforcepaymentrequest.getinclude" + ], + "title": "SalesforcePaymentRequest.getInclude" + }, + { + "description": "Returns the DOM element selector where to mount payment methods and/or express checkout buttons.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getSelector", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getSelector", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the DOM element selector where to mount payment methods and/or express checkout buttons.", + "heading": "Description" + } + ], + "signature": "getSelector(): string", + "source": "script-api", + "tags": [ + "getselector", + "salesforcepaymentrequest.getselector" + ], + "title": "SalesforcePaymentRequest.getSelector" + }, + { + "description": "Returns `true` if the payment method should be always saved for future use off session, or `false` if the payment method should be only saved for future use on session when appropriate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getSetupFutureUsage", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the payment method should be always saved for future use off session, or\n`false` if the payment method should be only saved for future use on session when appropriate.", + "heading": "Description" + } + ], + "signature": "getSetupFutureUsage(): boolean", + "source": "script-api", + "tags": [ + "getsetupfutureusage", + "salesforcepaymentrequest.getsetupfutureusage" + ], + "title": "SalesforcePaymentRequest.getSetupFutureUsage" + }, + { + "description": "Returns the complete description that appears on your customers' statements for payments made by this request, or `null` if the default statement descriptor for your account will be used.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#getStatementDescriptor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.getStatementDescriptor", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the complete description that appears on your customers' statements for payments made by this request, or\n`null` if the default statement descriptor for your account will be used.", + "heading": "Description" + } + ], + "signature": "getStatementDescriptor(): string | null", + "source": "script-api", + "tags": [ + "getstatementdescriptor", + "salesforcepaymentrequest.getstatementdescriptor" + ], + "title": "SalesforcePaymentRequest.getStatementDescriptor" + }, + { + "description": "Returns a set containing the specific element types to include in mounted components. If the set is empty then all applicable and enabled element types will be included by default. See the element type constants in this class for the full list of supported element types.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#include", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.include", + "sections": [ + { + "body": "Returns a set containing the specific element types to include in mounted components. If the set is\nempty then all applicable and enabled element types will be included by default. See the element type constants\nin this class for the full list of supported element types.\n\nNote: if an element type is both explicitly included and excluded, it will not be presented.", + "heading": "Description" + } + ], + "signature": "readonly include: utilSet", + "source": "script-api", + "tags": [ + "include", + "salesforcepaymentrequest.include" + ], + "title": "SalesforcePaymentRequest.include" + }, + { + "description": "Returns the DOM element selector where to mount payment methods and/or express checkout buttons.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#selector", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.selector", + "sections": [ + { + "body": "Returns the DOM element selector where to mount payment methods and/or express checkout buttons.", + "heading": "Description" + } + ], + "signature": "readonly selector: string", + "source": "script-api", + "tags": [ + "selector", + "salesforcepaymentrequest.selector" + ], + "title": "SalesforcePaymentRequest.selector" + }, + { + "description": "Sets the data used to prepare the shopper basket when a Buy Now button is tapped. For convenience this method accepts a JS object to set all of the following properties at once:", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setBasketData", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basketData", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setBasketData", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the data used to prepare the shopper basket when a Buy Now button is tapped. For convenience this method\naccepts a JS object to set all of the following properties at once:\n\n- `sku` - SKU of the product to add exclusively to the basket (required)\n- `quantity` - integer quantity of the product, default is 1\n- `shippingMethod` - ID of the shipping method to set on the shipment, default is the site default\nshipping method for the basket currency\n- `options` - JS array containing one JS object per selected product option, default is no selected options\n\n- `id` - product option ID\n- `valueId` - product option value ID\n\nThe following example shows how to set all of the supported basket data.", + "heading": "Description" + } + ], + "signature": "setBasketData(basketData: Object): void", + "source": "script-api", + "tags": [ + "setbasketdata", + "salesforcepaymentrequest.setbasketdata" + ], + "title": "SalesforcePaymentRequest.setBasketData" + }, + { + "description": "Sets the billing details to use when a Stripe PaymentMethod is created. For convenience this method accepts a JS object to set all details at once. The following example shows how to set details including address.", + "examples": [ + "`\nrequest.setBillingDetails({\naddress: {\ncity: 'Wien',\ncountry: 'AT',\nline1: 'Opernring 2',\npostal_code: '1010'\n},\nemail: 'jhummel@salesforce.com',\nname: 'Johann Hummel'\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setBillingDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "billingDetails", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setBillingDetails", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the billing details to use when a Stripe PaymentMethod is created. For convenience this method accepts a\nJS object to set all details at once. The following example shows how to set details including address.\n\n\nFor more information on the available billing details see the Stripe create PaymentMethod API\ndocumentation.", + "heading": "Description" + } + ], + "signature": "setBillingDetails(billingDetails: Object): void", + "source": "script-api", + "tags": [ + "setbillingdetails", + "salesforcepaymentrequest.setbillingdetails" + ], + "title": "SalesforcePaymentRequest.setBillingDetails" + }, + { + "description": "Sets if the credit card payment should be automatically captured at the time of the sale.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "cardCaptureAutomatic", + "type": "boolean" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setCardCaptureAutomatic", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets if the credit card payment should be automatically captured at the time of the sale.", + "heading": "Description" + } + ], + "signature": "setCardCaptureAutomatic(cardCaptureAutomatic: boolean): void", + "source": "script-api", + "tags": [ + "setcardcaptureautomatic", + "salesforcepaymentrequest.setcardcaptureautomatic" + ], + "title": "SalesforcePaymentRequest.setCardCaptureAutomatic" + }, + { + "description": "Sets the payment request options to use when a Buy Now button is tapped. For convenience this method accepts a JS object to set all options at once. The following example shows how to set options including currency, labels, and amounts, in B2C Commerce API format.", + "examples": [ + "`\nrequest.setOptions({\ncurrency: 'GBP',\ntotal: {\nlabel: 'Total',\namount: '26.44'\n},\ndisplayItems: [{\nlabel: 'Subtotal',\namount: '19.19'\n}, {\nlabel: 'Tax',\namount: '1.26'\n}, {\nlabel: 'Ground',\namount: '5.99'\n}],\nrequestPayerPhone: false,\nshippingOptions: [{\nid: 'GBP001',\nlabel: 'Ground',\ndetail: 'Order received within 7-10 business days',\namount: '5.99'\n}]\n});\n`" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setOptions", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the payment request options to use when a Buy Now button is tapped. For convenience this method accepts a\nJS object to set all options at once. The following example shows how to set options including currency,\nlabels, and amounts, in B2C Commerce API format.\n\n\nThe `total` option must match the total that will result from preparing the shopper basket using the\ndata provided to setBasketData in this request. The `id` of each JS object in the\n`shippingOptions` array must equal the ID of the corresponding site shipping method that the shopper\nmay select in the browser payment app.\n\nFor more information on the available payment request options see the Stripe Payment Request object API\ndocumentation.\n\nNote: The Stripe Payment Request `country` option will be set automatically to the country of the\nSalesforce Payments account associated with the Commerce Cloud instance and is not included here.", + "heading": "Description" + } + ], + "signature": "setOptions(options: Object): void", + "source": "script-api", + "tags": [ + "setoptions", + "salesforcepaymentrequest.setoptions" + ], + "title": "SalesforcePaymentRequest.setOptions" + }, + { + "description": "Sets the the options to pass into the `paypal.Buttons` call. For more information see the PayPal Buttons API documentation.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalButtonsOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalButtonsOptions", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the the options to pass into the `paypal.Buttons` call. For more information see the PayPal\nButtons API documentation.", + "heading": "Description" + } + ], + "signature": "setPayPalButtonsOptions(options: Object): void", + "source": "script-api", + "tags": [ + "setpaypalbuttonsoptions", + "salesforcepaymentrequest.setpaypalbuttonsoptions" + ], + "title": "SalesforcePaymentRequest.setPayPalButtonsOptions" + }, + { + "description": "Sets the PayPal order application context `shipping_preference` value. For more information see the PayPal Orders API documentation.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalShippingPreference", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "shippingPreference", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalShippingPreference", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the PayPal order application context `shipping_preference` value. For more information see the\nPayPal Orders API documentation.", + "heading": "Description" + } + ], + "signature": "setPayPalShippingPreference(shippingPreference: string): void", + "source": "script-api", + "tags": [ + "setpaypalshippingpreference", + "salesforcepaymentrequest.setpaypalshippingpreference" + ], + "title": "SalesforcePaymentRequest.setPayPalShippingPreference" + }, + { + "description": "Sets the PayPal order application context `user_action` value. For more information see the PayPal Orders API documentation.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setPayPalUserAction", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "userAction", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setPayPalUserAction", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the PayPal order application context `user_action` value. For more information see the PayPal\nOrders API documentation.", + "heading": "Description" + } + ], + "signature": "setPayPalUserAction(userAction: string): void", + "source": "script-api", + "tags": [ + "setpaypaluseraction", + "salesforcepaymentrequest.setpaypaluseraction" + ], + "title": "SalesforcePaymentRequest.setPayPalUserAction" + }, + { + "description": "Sets the controller to which to redirect when the shopper returns from a 3rd party payment website. Default is the controller for the current page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setReturnController", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "returnController", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setReturnController", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the controller to which to redirect when the shopper returns from a 3rd party payment website. Default is\nthe controller for the current page.", + "heading": "Description" + } + ], + "signature": "setReturnController(returnController: string): void", + "source": "script-api", + "tags": [ + "setreturncontroller", + "salesforcepaymentrequest.setreturncontroller" + ], + "title": "SalesforcePaymentRequest.setReturnController" + }, + { + "description": "Sets if mounted components may provide a control for the shopper to save their payment method for later use. When set to `false` no control will be provided. When set to `true` a control may be provided, if applicable for the shopper and presented payment method, but is not guaranteed.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setSavePaymentMethodEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "savePaymentMethodEnabled", + "type": "boolean" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setSavePaymentMethodEnabled", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets if mounted components may provide a control for the shopper to save their payment method for later use. When\nset to `false` no control will be provided. When set to `true` a control may be provided,\nif applicable for the shopper and presented payment method, but is not guaranteed.", + "heading": "Description" + } + ], + "signature": "setSavePaymentMethodEnabled(savePaymentMethodEnabled: boolean): void", + "source": "script-api", + "tags": [ + "setsavepaymentmethodenabled", + "salesforcepaymentrequest.setsavepaymentmethodenabled" + ], + "title": "SalesforcePaymentRequest.setSavePaymentMethodEnabled" + }, + { + "description": "Sets if the payment method should be always saved for future use off session.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setSetupFutureUsage", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "setupFutureUsage", + "type": "boolean" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setSetupFutureUsage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets if the payment method should be always saved for future use off session.", + "heading": "Description" + } + ], + "signature": "setSetupFutureUsage(setupFutureUsage: boolean): void", + "source": "script-api", + "tags": [ + "setsetupfutureusage", + "salesforcepaymentrequest.setsetupfutureusage" + ], + "title": "SalesforcePaymentRequest.setSetupFutureUsage" + }, + { + "description": "Sets the complete description that appears on your customers' statements for payments made by this request. Set this to `null` to use the default statement descriptor for your account.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStatementDescriptor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "statementDescriptor", + "type": "string | null" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStatementDescriptor", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the complete description that appears on your customers' statements for payments made by this request. Set\nthis to `null` to use the default statement descriptor for your account.", + "heading": "Description" + } + ], + "signature": "setStatementDescriptor(statementDescriptor: string | null): void", + "source": "script-api", + "tags": [ + "setstatementdescriptor", + "salesforcepaymentrequest.setstatementdescriptor" + ], + "title": "SalesforcePaymentRequest.setStatementDescriptor" + }, + { + "description": "Sets the the options to pass into the Stripe `elements.create` call for the given element type. For more information see the Stripe Elements API documentation.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStripeCreateElementOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "element", + "type": "string" + }, + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStripeCreateElementOptions", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the the options to pass into the Stripe `elements.create` call for the given element type. For\nmore information see the Stripe Elements API documentation.", + "heading": "Description" + } + ], + "signature": "setStripeCreateElementOptions(element: string, options: Object): void", + "source": "script-api", + "tags": [ + "setstripecreateelementoptions", + "salesforcepaymentrequest.setstripecreateelementoptions" + ], + "title": "SalesforcePaymentRequest.setStripeCreateElementOptions" + }, + { + "description": "Sets the the options to pass into the `stripe.elements` call. For more information see the Stripe Elements API documentation.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setStripeElementsOptions", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "options", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setStripeElementsOptions", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the the options to pass into the `stripe.elements` call. For more information see the Stripe\nElements API documentation.", + "heading": "Description" + } + ], + "signature": "setStripeElementsOptions(options: Object): void", + "source": "script-api", + "tags": [ + "setstripeelementsoptions", + "salesforcepaymentrequest.setstripeelementsoptions" + ], + "title": "SalesforcePaymentRequest.setStripeElementsOptions" + }, + { + "description": "Returns `true` if the payment method should be always saved for future use off session, or `false` if the payment method should be only saved for future use on session when appropriate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#setupFutureUsage", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.setupFutureUsage", + "sections": [ + { + "body": "Returns `true` if the payment method should be always saved for future use off session, or\n`false` if the payment method should be only saved for future use on session when appropriate.", + "heading": "Description" + } + ], + "signature": "setupFutureUsage: boolean", + "source": "script-api", + "tags": [ + "setupfutureusage", + "salesforcepaymentrequest.setupfutureusage" + ], + "title": "SalesforcePaymentRequest.setupFutureUsage" + }, + { + "description": "Returns the complete description that appears on your customers' statements for payments made by this request, or `null` if the default statement descriptor for your account will be used.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentRequest#statementDescriptor", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentRequest", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentRequest.statementDescriptor", + "sections": [ + { + "body": "Returns the complete description that appears on your customers' statements for payments made by this request, or\n`null` if the default statement descriptor for your account will be used.", + "heading": "Description" + } + ], + "signature": "statementDescriptor: string | null", + "source": "script-api", + "tags": [ + "statementdescriptor", + "salesforcepaymentrequest.statementdescriptor" + ], + "title": "SalesforcePaymentRequest.statementDescriptor" + }, + { + "description": "This interface represents all script hooks that can be registered to customize the Salesforce Payments functionality. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.payments.asyncPaymentSucceeded\", \"script\": \"./payments.js\"},\n{\"name\": \"dw.extensions.payments.adyenNotification\", \"script\": \"./payments.js\"},\n{\"name\": \"dw.extensions.payments.adyenFailureNotification\", \"script\": \"./payments.js\"},\n{\"name\": \"dw.extensions.payments.sendOrderConfirmationEmail\", \"script\": \"./emails.js\"}\n]" + ], + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "kind": "interface", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to customize the Salesforce Payments functionality.\nSee Salesforce Payments documentation for how to gain access and configure it for use on your sites.\n\nIt contains the extension points (hook names), and the functions that are called by each extension point. A function\nmust be defined inside a JavaScript source and must be exported. The script with the exported hook function must be\nlocated inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentshooks", + "dw.extensions.payments.salesforcepaymentshooks", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsHooks" + }, + { + "description": "Called when an Adyen webhook notification with a failed payment is received for the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#adyenFailureNotification", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.adyenFailureNotification", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called when an Adyen webhook notification with a failed payment is received for the given order.", + "heading": "Description" + } + ], + "signature": "adyenFailureNotification(order: Order): Status", + "source": "script-api", + "tags": [ + "adyenfailurenotification", + "salesforcepaymentshooks.adyenfailurenotification" + ], + "title": "SalesforcePaymentsHooks.adyenFailureNotification" + }, + { + "description": "Called when an Adyen webhook notification is received for the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#adyenNotification", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.adyenNotification", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called when an Adyen webhook notification is received for the given order.", + "heading": "Description" + } + ], + "signature": "adyenNotification(order: Order): Status", + "source": "script-api", + "tags": [ + "adyennotification", + "salesforcepaymentshooks.adyennotification" + ], + "title": "SalesforcePaymentsHooks.adyenNotification" + }, + { + "description": "Called when asynchronous payment succeeded for the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#asyncPaymentSucceeded", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.asyncPaymentSucceeded", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called when asynchronous payment succeeded for the given order.", + "heading": "Description" + } + ], + "signature": "asyncPaymentSucceeded(order: Order): Status", + "source": "script-api", + "tags": [ + "asyncpaymentsucceeded", + "salesforcepaymentshooks.asyncpaymentsucceeded" + ], + "title": "SalesforcePaymentsHooks.asyncPaymentSucceeded" + }, + { + "description": "The extension point name extensionPointAdyenFailureNotification.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAdyenFailureNotification", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAdyenFailureNotification", + "sections": [ + { + "body": "The extension point name extensionPointAdyenFailureNotification.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAdyenFailureNotification: \"dw.extensions.payments.adyenFailureNotification\"", + "source": "script-api", + "tags": [ + "extensionpointadyenfailurenotification", + "salesforcepaymentshooks.extensionpointadyenfailurenotification" + ], + "title": "SalesforcePaymentsHooks.extensionPointAdyenFailureNotification" + }, + { + "description": "The extension point name extensionPointAdyenNotification.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAdyenNotification", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAdyenNotification", + "sections": [ + { + "body": "The extension point name extensionPointAdyenNotification.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAdyenNotification: \"dw.extensions.payments.adyenNotification\"", + "source": "script-api", + "tags": [ + "extensionpointadyennotification", + "salesforcepaymentshooks.extensionpointadyennotification" + ], + "title": "SalesforcePaymentsHooks.extensionPointAdyenNotification" + }, + { + "description": "The extension point name extensionPointAsyncPaymentSucceeded.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointAsyncPaymentSucceeded", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointAsyncPaymentSucceeded", + "sections": [ + { + "body": "The extension point name extensionPointAsyncPaymentSucceeded.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAsyncPaymentSucceeded: \"dw.extensions.payments.asyncPaymentSucceeded\"", + "source": "script-api", + "tags": [ + "extensionpointasyncpaymentsucceeded", + "salesforcepaymentshooks.extensionpointasyncpaymentsucceeded" + ], + "title": "SalesforcePaymentsHooks.extensionPointAsyncPaymentSucceeded" + }, + { + "description": "The extension point name extensionPointSendOrderConfirmationEmail.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointSendOrderConfirmationEmail", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointSendOrderConfirmationEmail", + "sections": [ + { + "body": "The extension point name extensionPointSendOrderConfirmationEmail.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointSendOrderConfirmationEmail: \"dw.extensions.payments.sendOrderConfirmationEmail\"", + "source": "script-api", + "tags": [ + "extensionpointsendorderconfirmationemail", + "salesforcepaymentshooks.extensionpointsendorderconfirmationemail" + ], + "title": "SalesforcePaymentsHooks.extensionPointSendOrderConfirmationEmail" + }, + { + "description": "The extension point name extensionPointStripePaymentEvent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#extensionPointStripePaymentEvent", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.extensionPointStripePaymentEvent", + "sections": [ + { + "body": "The extension point name extensionPointStripePaymentEvent.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointStripePaymentEvent: \"dw.extensions.payments.stripePaymentEvent\"", + "source": "script-api", + "tags": [ + "extensionpointstripepaymentevent", + "salesforcepaymentshooks.extensionpointstripepaymentevent" + ], + "title": "SalesforcePaymentsHooks.extensionPointStripePaymentEvent" + }, + { + "description": "Called to send order confirmation email after successful payment processing.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#sendOrderConfirmationEmail", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.sendOrderConfirmationEmail", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called to send order confirmation email after successful payment processing.", + "heading": "Description" + } + ], + "signature": "sendOrderConfirmationEmail(order: Order): Status", + "source": "script-api", + "tags": [ + "sendorderconfirmationemail", + "salesforcepaymentshooks.sendorderconfirmationemail" + ], + "title": "SalesforcePaymentsHooks.sendOrderConfirmationEmail" + }, + { + "description": "Called when a Stripe payment event is received for the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsHooks#stripePaymentEvent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "eventName", + "type": "string" + }, + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsHooks", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsHooks.stripePaymentEvent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called when a Stripe payment event is received for the given order.", + "heading": "Description" + } + ], + "signature": "stripePaymentEvent(eventName: string, order: Order): Status", + "source": "script-api", + "tags": [ + "stripepaymentevent", + "salesforcepaymentshooks.stripepaymentevent" + ], + "title": "SalesforcePaymentsHooks.stripePaymentEvent" + }, + { + "description": "Contains information about a merchant account configured for use with Salesforce Payments. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount", + "sections": [ + { + "body": "Contains information about a merchant account configured for use with Salesforce Payments. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentsmerchantaccount", + "dw.extensions.payments.salesforcepaymentsmerchantaccount", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMerchantAccount" + }, + { + "description": "Returns the ID of the Salesforce Payments merchant account.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#accountId", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.accountId", + "sections": [ + { + "body": "Returns the ID of the Salesforce Payments merchant account.", + "heading": "Description" + } + ], + "signature": "readonly accountId: string", + "source": "script-api", + "tags": [ + "accountid", + "salesforcepaymentsmerchantaccount.accountid" + ], + "title": "SalesforcePaymentsMerchantAccount.accountId" + }, + { + "description": "Returns the type of the Salesforce Payments merchant account and environment, such as `\"STRIPE_TEST\"` or `\"ADYEN_LIVE\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#accountType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.accountType", + "sections": [ + { + "body": "Returns the type of the Salesforce Payments merchant account and environment, such as `\"STRIPE_TEST\"`\nor `\"ADYEN_LIVE\"`.", + "heading": "Description" + } + ], + "signature": "readonly accountType: string", + "source": "script-api", + "tags": [ + "accounttype", + "salesforcepaymentsmerchantaccount.accounttype" + ], + "title": "SalesforcePaymentsMerchantAccount.accountType" + }, + { + "description": "Returns an opaque configuration object containing gateway-specific information. Do not depend on the structure or contents of this object as they may change at any time.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#config", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.config", + "sections": [ + { + "body": "Returns an opaque configuration object containing gateway-specific information. Do not depend on the structure or\ncontents of this object as they may change at any time.", + "heading": "Description" + } + ], + "signature": "readonly config: Object", + "source": "script-api", + "tags": [ + "config", + "salesforcepaymentsmerchantaccount.config" + ], + "title": "SalesforcePaymentsMerchantAccount.config" + }, + { + "description": "Returns the ID of the Salesforce Payments merchant account.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getAccountId", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getAccountId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Salesforce Payments merchant account.", + "heading": "Description" + } + ], + "signature": "getAccountId(): string", + "source": "script-api", + "tags": [ + "getaccountid", + "salesforcepaymentsmerchantaccount.getaccountid" + ], + "title": "SalesforcePaymentsMerchantAccount.getAccountId" + }, + { + "description": "Returns the type of the Salesforce Payments merchant account and environment, such as `\"STRIPE_TEST\"` or `\"ADYEN_LIVE\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getAccountType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getAccountType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the Salesforce Payments merchant account and environment, such as `\"STRIPE_TEST\"`\nor `\"ADYEN_LIVE\"`.", + "heading": "Description" + } + ], + "signature": "getAccountType(): string", + "source": "script-api", + "tags": [ + "getaccounttype", + "salesforcepaymentsmerchantaccount.getaccounttype" + ], + "title": "SalesforcePaymentsMerchantAccount.getAccountType" + }, + { + "description": "Returns an opaque configuration object containing gateway-specific information. Do not depend on the structure or contents of this object as they may change at any time.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getConfig", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns an opaque configuration object containing gateway-specific information. Do not depend on the structure or\ncontents of this object as they may change at any time.", + "heading": "Description" + } + ], + "signature": "getConfig(): Object", + "source": "script-api", + "tags": [ + "getconfig", + "salesforcepaymentsmerchantaccount.getconfig" + ], + "title": "SalesforcePaymentsMerchantAccount.getConfig" + }, + { + "description": "Returns the name of the gateway vendor, such as `\"Stripe\"` or `\"Adyen\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#getVendor", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.getVendor", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the gateway vendor, such as `\"Stripe\"` or `\"Adyen\"`.", + "heading": "Description" + } + ], + "signature": "getVendor(): string", + "source": "script-api", + "tags": [ + "getvendor", + "salesforcepaymentsmerchantaccount.getvendor" + ], + "title": "SalesforcePaymentsMerchantAccount.getVendor" + }, + { + "description": "Returns `true` if the account takes live payments, or `false` if it takes test payments.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#isLive", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.isLive", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the account takes live payments, or `false` if it takes test payments.", + "heading": "Description" + } + ], + "signature": "isLive(): boolean", + "source": "script-api", + "tags": [ + "islive", + "salesforcepaymentsmerchantaccount.islive" + ], + "title": "SalesforcePaymentsMerchantAccount.isLive" + }, + { + "description": "Returns `true` if the account takes live payments, or `false` if it takes test payments.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#live", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.live", + "sections": [ + { + "body": "Returns `true` if the account takes live payments, or `false` if it takes test payments.", + "heading": "Description" + } + ], + "signature": "readonly live: boolean", + "source": "script-api", + "tags": [ + "live", + "salesforcepaymentsmerchantaccount.live" + ], + "title": "SalesforcePaymentsMerchantAccount.live" + }, + { + "description": "Returns the name of the gateway vendor, such as `\"Stripe\"` or `\"Adyen\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount#vendor", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccount", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccount.vendor", + "sections": [ + { + "body": "Returns the name of the gateway vendor, such as `\"Stripe\"` or `\"Adyen\"`.", + "heading": "Description" + } + ], + "signature": "readonly vendor: string", + "source": "script-api", + "tags": [ + "vendor", + "salesforcepaymentsmerchantaccount.vendor" + ], + "title": "SalesforcePaymentsMerchantAccount.vendor" + }, + { + "description": "Contains information about a payment method to be presented to a payer, as configured for a Salesforce Payments merchant account. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod", + "sections": [ + { + "body": "Contains information about a payment method to be presented to a payer, as configured for a Salesforce Payments\nmerchant account. See Salesforce Payments documentation for how to gain access and configure it for use on your\nsites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentsmerchantaccountpaymentmethod", + "dw.extensions.payments.salesforcepaymentsmerchantaccountpaymentmethod", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod" + }, + { + "description": "Returns the merchant account configured for this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getMerchantAccount", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getMerchantAccount", + "returns": { + "type": "SalesforcePaymentsMerchantAccount" + }, + "sections": [ + { + "body": "Returns the merchant account configured for this payment method.", + "heading": "Description" + } + ], + "signature": "getMerchantAccount(): SalesforcePaymentsMerchantAccount", + "source": "script-api", + "tags": [ + "getmerchantaccount", + "salesforcepaymentsmerchantaccountpaymentmethod.getmerchantaccount" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getMerchantAccount" + }, + { + "description": "Returns the constant indicating the type of payment method to be presented, such as SalesforcePaymentMethod.TYPE_CARD.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getPaymentMethodType", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentMethodType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the constant indicating the type of payment method to be presented, such as\nSalesforcePaymentMethod.TYPE_CARD.", + "heading": "Description" + } + ], + "signature": "getPaymentMethodType(): string", + "source": "script-api", + "tags": [ + "getpaymentmethodtype", + "salesforcepaymentsmerchantaccountpaymentmethod.getpaymentmethodtype" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentMethodType" + }, + { + "description": "Returns a collection containing the payment modes for which this payment method is to be presented, such as `\"Express\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#getPaymentModes", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentModes", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment modes for which this payment method is to be presented, such as\n`\"Express\"`.", + "heading": "Description" + } + ], + "signature": "getPaymentModes(): Collection", + "source": "script-api", + "tags": [ + "getpaymentmodes", + "salesforcepaymentsmerchantaccountpaymentmethod.getpaymentmodes" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.getPaymentModes" + }, + { + "description": "Returns the merchant account configured for this payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#merchantAccount", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.merchantAccount", + "sections": [ + { + "body": "Returns the merchant account configured for this payment method.", + "heading": "Description" + } + ], + "signature": "readonly merchantAccount: SalesforcePaymentsMerchantAccount", + "source": "script-api", + "tags": [ + "merchantaccount", + "salesforcepaymentsmerchantaccountpaymentmethod.merchantaccount" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.merchantAccount" + }, + { + "description": "Returns the constant indicating the type of payment method to be presented, such as SalesforcePaymentMethod.TYPE_CARD.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#paymentMethodType", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.paymentMethodType", + "sections": [ + { + "body": "Returns the constant indicating the type of payment method to be presented, such as\nSalesforcePaymentMethod.TYPE_CARD.", + "heading": "Description" + } + ], + "signature": "readonly paymentMethodType: string", + "source": "script-api", + "tags": [ + "paymentmethodtype", + "salesforcepaymentsmerchantaccountpaymentmethod.paymentmethodtype" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.paymentMethodType" + }, + { + "description": "Returns a collection containing the payment modes for which this payment method is to be presented, such as `\"Express\"`.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod#paymentModes", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMerchantAccountPaymentMethod", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.paymentModes", + "sections": [ + { + "body": "Returns a collection containing the payment modes for which this payment method is to be presented, such as\n`\"Express\"`.", + "heading": "Description" + } + ], + "signature": "readonly paymentModes: Collection", + "source": "script-api", + "tags": [ + "paymentmodes", + "salesforcepaymentsmerchantaccountpaymentmethod.paymentmodes" + ], + "title": "SalesforcePaymentsMerchantAccountPaymentMethod.paymentModes" + }, + { + "description": "Contains functionality for use with Salesforce Payments. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr", + "sections": [ + { + "body": "Contains functionality for use with Salesforce Payments. See Salesforce Payments documentation for how to gain access\nand configure it for use on your sites.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentsmgr", + "dw.extensions.payments.salesforcepaymentsmgr", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsMgr" + }, + { + "description": "Cancellation reason indicating customer abandoned payment.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_ABANDONED", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED", + "sections": [ + { + "body": "Cancellation reason indicating customer abandoned payment.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_ABANDONED = \"abandoned\"", + "source": "script-api", + "tags": [ + "cancellation_reason_abandoned", + "salesforcepaymentsmgr.cancellation_reason_abandoned" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED" + }, + { + "description": "Cancellation reason indicating customer abandoned payment.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_ABANDONED", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED", + "sections": [ + { + "body": "Cancellation reason indicating customer abandoned payment.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_ABANDONED = \"abandoned\"", + "source": "script-api", + "tags": [ + "cancellation_reason_abandoned", + "salesforcepaymentsmgr.cancellation_reason_abandoned" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_ABANDONED" + }, + { + "description": "Cancellation reason indicating payment intent was a duplicate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE", + "sections": [ + { + "body": "Cancellation reason indicating payment intent was a duplicate.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_DUPLICATE = \"duplicate\"", + "source": "script-api", + "tags": [ + "cancellation_reason_duplicate", + "salesforcepaymentsmgr.cancellation_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE" + }, + { + "description": "Cancellation reason indicating payment intent was a duplicate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE", + "sections": [ + { + "body": "Cancellation reason indicating payment intent was a duplicate.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_DUPLICATE = \"duplicate\"", + "source": "script-api", + "tags": [ + "cancellation_reason_duplicate", + "salesforcepaymentsmgr.cancellation_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_DUPLICATE" + }, + { + "description": "Cancellation reason indicating payment was fraudulent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT", + "sections": [ + { + "body": "Cancellation reason indicating payment was fraudulent.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_FRAUDULENT = \"fraudulent\"", + "source": "script-api", + "tags": [ + "cancellation_reason_fraudulent", + "salesforcepaymentsmgr.cancellation_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT" + }, + { + "description": "Cancellation reason indicating payment was fraudulent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT", + "sections": [ + { + "body": "Cancellation reason indicating payment was fraudulent.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_FRAUDULENT = \"fraudulent\"", + "source": "script-api", + "tags": [ + "cancellation_reason_fraudulent", + "salesforcepaymentsmgr.cancellation_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_FRAUDULENT" + }, + { + "description": "Cancellation reason indicating customer action or request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "sections": [ + { + "body": "Cancellation reason indicating customer action or request.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_REQUESTED_BY_CUSTOMER = \"requested_by_customer\"", + "source": "script-api", + "tags": [ + "cancellation_reason_requested_by_customer", + "salesforcepaymentsmgr.cancellation_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "description": "Cancellation reason indicating customer action or request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER", + "sections": [ + { + "body": "Cancellation reason indicating customer action or request.", + "heading": "Description" + } + ], + "signature": "static readonly CANCELLATION_REASON_REQUESTED_BY_CUSTOMER = \"requested_by_customer\"", + "source": "script-api", + "tags": [ + "cancellation_reason_requested_by_customer", + "salesforcepaymentsmgr.cancellation_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.CANCELLATION_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "description": "Refund reason indicating payment intent was a duplicate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE", + "sections": [ + { + "body": "Refund reason indicating payment intent was a duplicate.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_DUPLICATE = \"duplicate\"", + "source": "script-api", + "tags": [ + "refund_reason_duplicate", + "salesforcepaymentsmgr.refund_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE" + }, + { + "description": "Refund reason indicating payment intent was a duplicate.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_DUPLICATE", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE", + "sections": [ + { + "body": "Refund reason indicating payment intent was a duplicate.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_DUPLICATE = \"duplicate\"", + "source": "script-api", + "tags": [ + "refund_reason_duplicate", + "salesforcepaymentsmgr.refund_reason_duplicate" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_DUPLICATE" + }, + { + "description": "Refund reason indicating payment was fraudulent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT", + "sections": [ + { + "body": "Refund reason indicating payment was fraudulent.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_FRAUDULENT = \"fraudulent\"", + "source": "script-api", + "tags": [ + "refund_reason_fraudulent", + "salesforcepaymentsmgr.refund_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT" + }, + { + "description": "Refund reason indicating payment was fraudulent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_FRAUDULENT", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT", + "sections": [ + { + "body": "Refund reason indicating payment was fraudulent.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_FRAUDULENT = \"fraudulent\"", + "source": "script-api", + "tags": [ + "refund_reason_fraudulent", + "salesforcepaymentsmgr.refund_reason_fraudulent" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_FRAUDULENT" + }, + { + "description": "Refund reason indicating customer action or request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER", + "sections": [ + { + "body": "Refund reason indicating customer action or request.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_REQUESTED_BY_CUSTOMER = \"requested_by_customer\"", + "source": "script-api", + "tags": [ + "refund_reason_requested_by_customer", + "salesforcepaymentsmgr.refund_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "description": "Refund reason indicating customer action or request.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#REFUND_REASON_REQUESTED_BY_CUSTOMER", + "kind": "constant", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER", + "sections": [ + { + "body": "Refund reason indicating customer action or request.", + "heading": "Description" + } + ], + "signature": "static readonly REFUND_REASON_REQUESTED_BY_CUSTOMER = \"requested_by_customer\"", + "source": "script-api", + "tags": [ + "refund_reason_requested_by_customer", + "salesforcepaymentsmgr.refund_reason_requested_by_customer" + ], + "title": "SalesforcePaymentsMgr.REFUND_REASON_REQUESTED_BY_CUSTOMER" + }, + { + "deprecated": { + "message": "use onCustomerRegistered and\nsavePaymentMethod" + }, + "description": "Attaches the given payment method to the given customer. Use this method to attach a payment method of type SalesforcePaymentMethod.TYPE_CARD to a shopper who registers as a customer after placing an order, and has affirmatively elected to save their card as part of the registration process. This method will throw an error if passed incompatible payment method and/or customer objects.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#attachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + }, + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.attachPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Attaches the given payment method to the given customer. Use this method to attach a payment method of type\nSalesforcePaymentMethod.TYPE_CARD to a shopper who registers as a customer after placing an order, and\nhas affirmatively elected to save their card as part of the registration process. This method will throw an error\nif passed incompatible payment method and/or customer objects.", + "heading": "Description" + } + ], + "signature": "static attachPaymentMethod(paymentMethod: SalesforcePaymentMethod, customer: Customer): void", + "source": "script-api", + "tags": [ + "attachpaymentmethod", + "salesforcepaymentsmgr.attachpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error attaching the payment method to the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.attachPaymentMethod" + }, + { + "deprecated": { + "message": "use onCustomerRegistered and\nsavePaymentMethod" + }, + "description": "Attaches the given payment method to the given customer. Use this method to attach a payment method of type SalesforcePaymentMethod.TYPE_CARD to a shopper who registers as a customer after placing an order, and has affirmatively elected to save their card as part of the registration process. This method will throw an error if passed incompatible payment method and/or customer objects.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#attachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + }, + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.attachPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Attaches the given payment method to the given customer. Use this method to attach a payment method of type\nSalesforcePaymentMethod.TYPE_CARD to a shopper who registers as a customer after placing an order, and\nhas affirmatively elected to save their card as part of the registration process. This method will throw an error\nif passed incompatible payment method and/or customer objects.", + "heading": "Description" + } + ], + "signature": "static attachPaymentMethod(paymentMethod: SalesforcePaymentMethod, customer: Customer): void", + "source": "script-api", + "tags": [ + "attachpaymentmethod", + "salesforcepaymentsmgr.attachpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error attaching the payment method to the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.attachPaymentMethod" + }, + { + "description": "Authorizes the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#authorizePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.authorizePayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Authorizes the given PayPal order.\n\nThe PayPal order must be in a status that supports authorization. See the PayPal documentation for more details.", + "heading": "Description" + } + ], + "signature": "static authorizePayPalOrder(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "authorizepaypalorder", + "salesforcepaymentsmgr.authorizepaypalorder" + ], + "throws": [ + { + "description": "if there was an error authorizing the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.authorizePayPalOrder" + }, + { + "description": "Authorizes the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#authorizePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.authorizePayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Authorizes the given PayPal order.\n\nThe PayPal order must be in a status that supports authorization. See the PayPal documentation for more details.", + "heading": "Description" + } + ], + "signature": "static authorizePayPalOrder(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "authorizepaypalorder", + "salesforcepaymentsmgr.authorizepaypalorder" + ], + "throws": [ + { + "description": "if there was an error authorizing the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.authorizePayPalOrder" + }, + { + "description": "Cancels the given payment intent. If a payment authorization has been made for the payment intent, the authorization is removed.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#cancelPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.cancelPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Cancels the given payment intent. If a payment authorization has been made for the payment intent, the\nauthorization is removed.\n\nThe payment intent must be in a status that supports cancel. See the Stripe documentation for more details.\n\nThe following Payment Intent property is supported:\n\n- `cancellationReason` - optional payment intent cancellation reason", + "heading": "Description" + } + ], + "signature": "static cancelPaymentIntent(paymentIntent: SalesforcePaymentIntent, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "cancelpaymentintent", + "salesforcepaymentsmgr.cancelpaymentintent" + ], + "throws": [ + { + "description": "if there was an error canceling the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.cancelPaymentIntent" + }, + { + "description": "Cancels the given payment intent. If a payment authorization has been made for the payment intent, the authorization is removed.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#cancelPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.cancelPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Cancels the given payment intent. If a payment authorization has been made for the payment intent, the\nauthorization is removed.\n\nThe payment intent must be in a status that supports cancel. See the Stripe documentation for more details.\n\nThe following Payment Intent property is supported:\n\n- `cancellationReason` - optional payment intent cancellation reason", + "heading": "Description" + } + ], + "signature": "static cancelPaymentIntent(paymentIntent: SalesforcePaymentIntent, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "cancelpaymentintent", + "salesforcepaymentsmgr.cancelpaymentintent" + ], + "throws": [ + { + "description": "if there was an error canceling the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.cancelPaymentIntent" + }, + { + "description": "Captures funds for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#captureAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.captureAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports capture.\n\nThe `amount` must be less than or equal to the amount available to capture.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static captureAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, amount: Money, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "captureadyenpayment", + "salesforcepaymentsmgr.captureadyenpayment" + ], + "throws": [ + { + "description": "if there was an error capturing the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.captureAdyenPayment" + }, + { + "description": "Captures funds for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#captureAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.captureAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports capture.\n\nThe `amount` must be less than or equal to the amount available to capture.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static captureAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, amount: Money, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "captureadyenpayment", + "salesforcepaymentsmgr.captureadyenpayment" + ], + "throws": [ + { + "description": "if there was an error capturing the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.captureAdyenPayment" + }, + { + "description": "Captures funds for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given PayPal order.\n\nThe PayPal order must be in a status that supports capture. See the PayPal documentation for more details.", + "heading": "Description" + } + ], + "signature": "static capturePayPalOrder(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "capturepaypalorder", + "salesforcepaymentsmgr.capturepaypalorder" + ], + "throws": [ + { + "description": "if there was an error capturing the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.capturePayPalOrder" + }, + { + "description": "Captures funds for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given PayPal order.\n\nThe PayPal order must be in a status that supports capture. See the PayPal documentation for more details.", + "heading": "Description" + } + ], + "signature": "static capturePayPalOrder(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "capturepaypalorder", + "salesforcepaymentsmgr.capturepaypalorder" + ], + "throws": [ + { + "description": "if there was an error capturing the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.capturePayPalOrder" + }, + { + "description": "Captures funds for the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "amount", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given payment intent.\n\nThe payment intent must be in a status that supports capture. See the Stripe documentation for more details.\n\nIf `amount` is not specified, the default is the full amount available to capture. If specified, the\namount must be less than or equal to the amount available to capture.", + "heading": "Description" + } + ], + "signature": "static capturePaymentIntent(paymentIntent: SalesforcePaymentIntent, amount: Money): Status", + "source": "script-api", + "tags": [ + "capturepaymentintent", + "salesforcepaymentsmgr.capturepaymentintent" + ], + "throws": [ + { + "description": "if there was an error capturing the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.capturePaymentIntent" + }, + { + "description": "Captures funds for the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#capturePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "amount", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.capturePaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Captures funds for the given payment intent.\n\nThe payment intent must be in a status that supports capture. See the Stripe documentation for more details.\n\nIf `amount` is not specified, the default is the full amount available to capture. If specified, the\namount must be less than or equal to the amount available to capture.", + "heading": "Description" + } + ], + "signature": "static capturePaymentIntent(paymentIntent: SalesforcePaymentIntent, amount: Money): Status", + "source": "script-api", + "tags": [ + "capturepaymentintent", + "salesforcepaymentsmgr.capturepaymentintent" + ], + "throws": [ + { + "description": "if there was an error capturing the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.capturePaymentIntent" + }, + { + "description": "Confirms a new payment intent using the given payment method, and associates it with the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#confirmPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.confirmPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Confirms a new payment intent using the given payment method, and associates it with the given order.\n\nThe order must be prepared to contain products, shipments, and any other necessary data, and must be calculated\nto reflect the correct total amounts. If the order is not for the same dw.customer.Customer as the given\npayment method, an error is thrown.\n\nThe specified payment method must be set up for off session future use or an error is thrown. iDeal and\nBancontact implement reuse differently than other payment methods, but they can't be reused themselves.\n\nThe following Payment Intent properties are supported:\n\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.", + "heading": "Description" + } + ], + "signature": "static confirmPaymentIntent(order: Order, paymentMethod: SalesforcePaymentMethod, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "confirmpaymentintent", + "salesforcepaymentsmgr.confirmpaymentintent" + ], + "throws": [ + { + "description": "if the parameter validation failed or there's an error confirming the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.confirmPaymentIntent" + }, + { + "description": "Confirms a new payment intent using the given payment method, and associates it with the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#confirmPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.confirmPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Confirms a new payment intent using the given payment method, and associates it with the given order.\n\nThe order must be prepared to contain products, shipments, and any other necessary data, and must be calculated\nto reflect the correct total amounts. If the order is not for the same dw.customer.Customer as the given\npayment method, an error is thrown.\n\nThe specified payment method must be set up for off session future use or an error is thrown. iDeal and\nBancontact implement reuse differently than other payment methods, but they can't be reused themselves.\n\nThe following Payment Intent properties are supported:\n\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.", + "heading": "Description" + } + ], + "signature": "static confirmPaymentIntent(order: Order, paymentMethod: SalesforcePaymentMethod, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "confirmpaymentintent", + "salesforcepaymentsmgr.confirmpaymentintent" + ], + "throws": [ + { + "description": "if the parameter validation failed or there's an error confirming the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.confirmPaymentIntent" + }, + { + "description": "Creates an Adyen payment intent using the given information, and associates it with the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createAdyenPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "customerRequired", + "type": "boolean" + }, + { + "name": "paymentData", + "type": "Object" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createAdyenPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates an Adyen payment intent using the given information, and associates it with the given order.\n\nThe following Payment Intent properties are supported:\n\n- `type` - required payment method type, such as SalesforcePaymentMethod.TYPE_CARD\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n- `storePaymentMethod` - optional `true` if the payment method should be stored for\nfuture usage, or `false` if not\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.", + "heading": "Description" + } + ], + "signature": "static createAdyenPaymentIntent(order: Order, shipment: Shipment, zoneId: string, amount: Money, customerRequired: boolean, paymentData: Object, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "createadyenpaymentintent", + "salesforcepaymentsmgr.createadyenpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createAdyenPaymentIntent" + }, + { + "description": "Creates an Adyen payment intent using the given information, and associates it with the given order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createAdyenPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "customerRequired", + "type": "boolean" + }, + { + "name": "paymentData", + "type": "Object" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createAdyenPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates an Adyen payment intent using the given information, and associates it with the given order.\n\nThe following Payment Intent properties are supported:\n\n- `type` - required payment method type, such as SalesforcePaymentMethod.TYPE_CARD\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n- `storePaymentMethod` - optional `true` if the payment method should be stored for\nfuture usage, or `false` if not\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.", + "heading": "Description" + } + ], + "signature": "static createAdyenPaymentIntent(order: Order, shipment: Shipment, zoneId: string, amount: Money, customerRequired: boolean, paymentData: Object, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "createadyenpaymentintent", + "salesforcepaymentsmgr.createadyenpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createAdyenPaymentIntent" + }, + { + "description": "Creates a PayPal order using the given information, and associates it with the given basket.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "paypalOrderProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates a PayPal order using the given information, and associates it with the given basket.\n\nThe following PayPal order properties are supported:\n\n- `fundingSource` - required funding source, such as SalesforcePayPalOrder.TYPE_PAYPAL\n- `intent` - optional order capture timing intent, such as\nSalesforcePayPalOrder.INTENT_AUTHORIZE or SalesforcePayPalOrder.INTENT_CAPTURE\n- `shippingPreference` - optional shipping preference, such as `\"GET_FROM_FILE\"`\n- `userAction` - optional user action, such as `\"PAY_NOW\"`\n\nIf `intent` is provided it is used to determine manual or automatic capture, and otherwise the default\ncard capture timing set for the site is used.", + "heading": "Description" + } + ], + "signature": "static createPayPalOrder(basket: Basket, shipment: Shipment, zoneId: string, amount: Money, paypalOrderProperties: Object): Status", + "source": "script-api", + "tags": [ + "createpaypalorder", + "salesforcepaymentsmgr.createpaypalorder" + ], + "title": "SalesforcePaymentsMgr.createPayPalOrder" + }, + { + "description": "Creates a PayPal order using the given information, and associates it with the given basket.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "paypalOrderProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPayPalOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates a PayPal order using the given information, and associates it with the given basket.\n\nThe following PayPal order properties are supported:\n\n- `fundingSource` - required funding source, such as SalesforcePayPalOrder.TYPE_PAYPAL\n- `intent` - optional order capture timing intent, such as\nSalesforcePayPalOrder.INTENT_AUTHORIZE or SalesforcePayPalOrder.INTENT_CAPTURE\n- `shippingPreference` - optional shipping preference, such as `\"GET_FROM_FILE\"`\n- `userAction` - optional user action, such as `\"PAY_NOW\"`\n\nIf `intent` is provided it is used to determine manual or automatic capture, and otherwise the default\ncard capture timing set for the site is used.", + "heading": "Description" + } + ], + "signature": "static createPayPalOrder(basket: Basket, shipment: Shipment, zoneId: string, amount: Money, paypalOrderProperties: Object): Status", + "source": "script-api", + "tags": [ + "createpaypalorder", + "salesforcepaymentsmgr.createpaypalorder" + ], + "title": "SalesforcePaymentsMgr.createPayPalOrder" + }, + { + "description": "Creates a payment intent using the given information, and associates it with the given basket.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "stripeCustomerRequired", + "type": "boolean" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates a payment intent using the given information, and associates it with the given basket.\n\nThe following Payment Intent properties are supported:\n\n- `type` - required payment method type, such as SalesforcePaymentMethod.TYPE_CARD\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n- `setupFutureUsage` - optional future usage setup value, such as\nSalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION\n\nThe `stripeCustomerRequired` must be set to `true` if the payment will be set up for future\nusage, whether on session or off session. If `true` then if a Stripe Customer is associated with the\nshopper then it will be used, and otherwise a new Stripe Customer will be created. The new Stripe Customer will\nbe associated with the shopper if logged into a registered customer account for the site.\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.\n\nIf `setupFutureUsage` is provided it will be used to prepare the payment to be set up for future usage\nat confirmation time. When set, this future usage setup value must match the value used at confirmation time.", + "heading": "Description" + } + ], + "signature": "static createPaymentIntent(basket: Basket, shipment: Shipment, zoneId: string, amount: Money, stripeCustomerRequired: boolean, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "createpaymentintent", + "salesforcepaymentsmgr.createpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createPaymentIntent" + }, + { + "description": "Creates a payment intent using the given information, and associates it with the given basket.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#createPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "stripeCustomerRequired", + "type": "boolean" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.createPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Creates a payment intent using the given information, and associates it with the given basket.\n\nThe following Payment Intent properties are supported:\n\n- `type` - required payment method type, such as SalesforcePaymentMethod.TYPE_CARD\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n- `setupFutureUsage` - optional future usage setup value, such as\nSalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION\n\nThe `stripeCustomerRequired` must be set to `true` if the payment will be set up for future\nusage, whether on session or off session. If `true` then if a Stripe Customer is associated with the\nshopper then it will be used, and otherwise a new Stripe Customer will be created. The new Stripe Customer will\nbe associated with the shopper if logged into a registered customer account for the site.\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.\n\nIf `setupFutureUsage` is provided it will be used to prepare the payment to be set up for future usage\nat confirmation time. When set, this future usage setup value must match the value used at confirmation time.", + "heading": "Description" + } + ], + "signature": "static createPaymentIntent(basket: Basket, shipment: Shipment, zoneId: string, amount: Money, stripeCustomerRequired: boolean, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "createpaymentintent", + "salesforcepaymentsmgr.createpaymentintent" + ], + "title": "SalesforcePaymentsMgr.createPaymentIntent" + }, + { + "deprecated": { + "message": "use removeSavedPaymentMethod" + }, + "description": "Detaches the given payment method from its associated customer. Once detached the payment method remains associated with payment intents in the payment account, but is no longer saved for use by the customer in future orders.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#detachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.detachPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Detaches the given payment method from its associated customer. Once detached the payment method remains\nassociated with payment intents in the payment account, but is no longer saved for use by the customer in future\norders.", + "heading": "Description" + } + ], + "signature": "static detachPaymentMethod(paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "detachpaymentmethod", + "salesforcepaymentsmgr.detachpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error detaching the payment method from its customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.detachPaymentMethod" + }, + { + "deprecated": { + "message": "use removeSavedPaymentMethod" + }, + "description": "Detaches the given payment method from its associated customer. Once detached the payment method remains associated with payment intents in the payment account, but is no longer saved for use by the customer in future orders.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#detachPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.detachPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Detaches the given payment method from its associated customer. Once detached the payment method remains\nassociated with payment intents in the payment account, but is no longer saved for use by the customer in future\norders.", + "heading": "Description" + } + ], + "signature": "static detachPaymentMethod(paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "detachpaymentmethod", + "salesforcepaymentsmgr.detachpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error detaching the payment method from its customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.detachPaymentMethod" + }, + { + "description": "Returns a collection containing the Adyen payment methods saved to be presented to the given customer for reuse in checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was an error retrieving the saved payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAdyenSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAdyenSavedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the Adyen payment methods saved to be presented to the given customer for reuse\nin checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was\nan error retrieving the saved payment methods.", + "heading": "Description" + } + ], + "signature": "static getAdyenSavedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getadyensavedpaymentmethods", + "salesforcepaymentsmgr.getadyensavedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is configuration missing that is required to retrieve the saved payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getAdyenSavedPaymentMethods" + }, + { + "description": "Returns a collection containing the Adyen payment methods saved to be presented to the given customer for reuse in checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was an error retrieving the saved payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAdyenSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAdyenSavedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the Adyen payment methods saved to be presented to the given customer for reuse\nin checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was\nan error retrieving the saved payment methods.", + "heading": "Description" + } + ], + "signature": "static getAdyenSavedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getadyensavedpaymentmethods", + "salesforcepaymentsmgr.getadyensavedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is configuration missing that is required to retrieve the saved payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getAdyenSavedPaymentMethods" + }, + { + "deprecated": { + "message": "use getSavedPaymentMethods" + }, + "description": "Returns a collection containing the payment methods attached to the given customer. The collection will be empty if there are no payment methods attached to the customer, or there was an error retrieving the attached payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAttachedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAttachedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods attached to the given customer. The collection will be empty\nif there are no payment methods attached to the customer, or there was an error retrieving the attached payment\nmethods.", + "heading": "Description" + } + ], + "signature": "static getAttachedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getattachedpaymentmethods", + "salesforcepaymentsmgr.getattachedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getAttachedPaymentMethods" + }, + { + "deprecated": { + "message": "use getSavedPaymentMethods" + }, + "description": "Returns a collection containing the payment methods attached to the given customer. The collection will be empty if there are no payment methods attached to the customer, or there was an error retrieving the attached payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getAttachedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getAttachedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods attached to the given customer. The collection will be empty\nif there are no payment methods attached to the customer, or there was an error retrieving the attached payment\nmethods.", + "heading": "Description" + } + ], + "signature": "static getAttachedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getattachedpaymentmethods", + "salesforcepaymentsmgr.getattachedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getAttachedPaymentMethods" + }, + { + "description": "Returns a collection containing the payment methods for the given customer set up for future off session reuse. The collection will be empty if there are no off session payment methods for the customer, or there was an error retrieving the off session payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getOffSessionPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getOffSessionPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods for the given customer set up for future off session reuse.\nThe collection will be empty if there are no off session payment methods for the customer, or there was an error\nretrieving the off session payment methods.", + "heading": "Description" + } + ], + "signature": "static getOffSessionPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getoffsessionpaymentmethods", + "salesforcepaymentsmgr.getoffsessionpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is an error getting the off session payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getOffSessionPaymentMethods" + }, + { + "description": "Returns a collection containing the payment methods for the given customer set up for future off session reuse. The collection will be empty if there are no off session payment methods for the customer, or there was an error retrieving the off session payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getOffSessionPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getOffSessionPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods for the given customer set up for future off session reuse.\nThe collection will be empty if there are no off session payment methods for the customer, or there was an error\nretrieving the off session payment methods.", + "heading": "Description" + } + ], + "signature": "static getOffSessionPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getoffsessionpaymentmethods", + "salesforcepaymentsmgr.getoffsessionpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is an error getting the off session payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getOffSessionPaymentMethods" + }, + { + "description": "Returns the PayPal order for the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "returns": { + "type": "SalesforcePayPalOrder | null" + }, + "sections": [ + { + "body": "Returns the PayPal order for the given basket, or `null` if the given basket has none.", + "heading": "Description" + } + ], + "signature": "static getPayPalOrder(basket: Basket): SalesforcePayPalOrder | null", + "source": "script-api", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "throws": [ + { + "description": "if there was an error retrieving the PayPal order for the basket", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "description": "Returns the PayPal order for the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "returns": { + "type": "SalesforcePayPalOrder | null" + }, + "sections": [ + { + "body": "Returns the PayPal order for the given order, or `null` if the given order has none.", + "heading": "Description" + } + ], + "signature": "static getPayPalOrder(order: Order): SalesforcePayPalOrder | null", + "source": "script-api", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "throws": [ + { + "description": "if there was an error retrieving the PayPal order for the order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "description": "Returns the PayPal order for the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "returns": { + "type": "SalesforcePayPalOrder | null" + }, + "sections": [ + { + "body": "Returns the PayPal order for the given basket, or `null` if the given basket has none.", + "heading": "Description" + } + ], + "signature": "static getPayPalOrder(basket: Basket): SalesforcePayPalOrder | null", + "source": "script-api", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "throws": [ + { + "description": "if there was an error retrieving the PayPal order for the basket", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "description": "Returns the PayPal order for the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPayPalOrder", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPayPalOrder", + "returns": { + "type": "SalesforcePayPalOrder | null" + }, + "sections": [ + { + "body": "Returns the PayPal order for the given order, or `null` if the given order has none.", + "heading": "Description" + } + ], + "signature": "static getPayPalOrder(order: Order): SalesforcePayPalOrder | null", + "source": "script-api", + "tags": [ + "getpaypalorder", + "salesforcepaymentsmgr.getpaypalorder" + ], + "throws": [ + { + "description": "if there was an error retrieving the PayPal order for the order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPayPalOrder" + }, + { + "description": "Returns the details to the Salesforce Payments payment associated with the given payment instrument, or `null` if the given payment instrument has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentDetails", + "returns": { + "type": "SalesforcePaymentDetails | null" + }, + "sections": [ + { + "body": "Returns the details to the Salesforce Payments payment associated with the given payment instrument, or\n`null` if the given payment instrument has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails | null", + "source": "script-api", + "tags": [ + "getpaymentdetails", + "salesforcepaymentsmgr.getpaymentdetails" + ], + "throws": [ + { + "description": "if paymentInstrument is null", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentDetails" + }, + { + "description": "Returns the details to the Salesforce Payments payment associated with the given payment instrument, or `null` if the given payment instrument has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentDetails", + "returns": { + "type": "SalesforcePaymentDetails | null" + }, + "sections": [ + { + "body": "Returns the details to the Salesforce Payments payment associated with the given payment instrument, or\n`null` if the given payment instrument has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails | null", + "source": "script-api", + "tags": [ + "getpaymentdetails", + "salesforcepaymentsmgr.getpaymentdetails" + ], + "throws": [ + { + "description": "if paymentInstrument is null", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentDetails" + }, + { + "description": "Returns the payment intent for the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "returns": { + "type": "SalesforcePaymentIntent | null" + }, + "sections": [ + { + "body": "Returns the payment intent for the given basket, or `null` if the given basket has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentIntent(basket: Basket): SalesforcePaymentIntent | null", + "source": "script-api", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "throws": [ + { + "description": "if there was an error retrieving the payment intent for the basket", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "description": "Returns the payment intent for the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "returns": { + "type": "SalesforcePaymentIntent | null" + }, + "sections": [ + { + "body": "Returns the payment intent for the given order, or `null` if the given order has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentIntent(order: Order): SalesforcePaymentIntent | null", + "source": "script-api", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "throws": [ + { + "description": "if there was an error retrieving the payment intent for the order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "description": "Returns the payment intent for the given basket, or `null` if the given basket has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "returns": { + "type": "SalesforcePaymentIntent | null" + }, + "sections": [ + { + "body": "Returns the payment intent for the given basket, or `null` if the given basket has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentIntent(basket: Basket): SalesforcePaymentIntent | null", + "source": "script-api", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "throws": [ + { + "description": "if there was an error retrieving the payment intent for the basket", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "description": "Returns the payment intent for the given order, or `null` if the given order has none.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentIntent", + "returns": { + "type": "SalesforcePaymentIntent | null" + }, + "sections": [ + { + "body": "Returns the payment intent for the given order, or `null` if the given order has none.", + "heading": "Description" + } + ], + "signature": "static getPaymentIntent(order: Order): SalesforcePaymentIntent | null", + "source": "script-api", + "tags": [ + "getpaymentintent", + "salesforcepaymentsmgr.getpaymentintent" + ], + "throws": [ + { + "description": "if there was an error retrieving the payment intent for the order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentIntent" + }, + { + "description": "Returns a payments site configuration object for the current site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsSiteConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsSiteConfig", + "returns": { + "type": "SalesforcePaymentsSiteConfiguration | null" + }, + "sections": [ + { + "body": "Returns a payments site configuration object for the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentsSiteConfig(): SalesforcePaymentsSiteConfiguration | null", + "source": "script-api", + "tags": [ + "getpaymentssiteconfig", + "salesforcepaymentsmgr.getpaymentssiteconfig" + ], + "throws": [ + { + "description": "if there is no current site", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentsSiteConfig" + }, + { + "description": "Returns a payments site configuration object for the current site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsSiteConfig", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsSiteConfig", + "returns": { + "type": "SalesforcePaymentsSiteConfiguration | null" + }, + "sections": [ + { + "body": "Returns a payments site configuration object for the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentsSiteConfig(): SalesforcePaymentsSiteConfiguration | null", + "source": "script-api", + "tags": [ + "getpaymentssiteconfig", + "salesforcepaymentsmgr.getpaymentssiteconfig" + ], + "throws": [ + { + "description": "if there is no current site", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getPaymentsSiteConfig" + }, + { + "description": "Returns a payments zone object for the passed in payments zone ID.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "zoneId", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsZone", + "returns": { + "type": "SalesforcePaymentsZone | null" + }, + "sections": [ + { + "body": "Returns a payments zone object for the passed in payments zone ID.", + "heading": "Description" + } + ], + "signature": "static getPaymentsZone(zoneId: string): SalesforcePaymentsZone | null", + "source": "script-api", + "tags": [ + "getpaymentszone", + "salesforcepaymentsmgr.getpaymentszone" + ], + "title": "SalesforcePaymentsMgr.getPaymentsZone" + }, + { + "description": "Returns a payments zone object for the passed in payments zone ID.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getPaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "zoneId", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getPaymentsZone", + "returns": { + "type": "SalesforcePaymentsZone | null" + }, + "sections": [ + { + "body": "Returns a payments zone object for the passed in payments zone ID.", + "heading": "Description" + } + ], + "signature": "static getPaymentsZone(zoneId: string): SalesforcePaymentsZone | null", + "source": "script-api", + "tags": [ + "getpaymentszone", + "salesforcepaymentsmgr.getpaymentszone" + ], + "title": "SalesforcePaymentsMgr.getPaymentsZone" + }, + { + "description": "Returns a collection containing the payment methods saved to be presented to the given customer for reuse in checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was an error retrieving the saved payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getSavedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods saved to be presented to the given customer for reuse in\ncheckouts. The collection will be empty if there are no payment methods saved for the customer, or there was an\nerror retrieving the saved payment methods.", + "heading": "Description" + } + ], + "signature": "static getSavedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getsavedpaymentmethods", + "salesforcepaymentsmgr.getsavedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is configuration missing that is required to retrieve the saved payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getSavedPaymentMethods" + }, + { + "description": "Returns a collection containing the payment methods saved to be presented to the given customer for reuse in checkouts. The collection will be empty if there are no payment methods saved for the customer, or there was an error retrieving the saved payment methods.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#getSavedPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.getSavedPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the payment methods saved to be presented to the given customer for reuse in\ncheckouts. The collection will be empty if there are no payment methods saved for the customer, or there was an\nerror retrieving the saved payment methods.", + "heading": "Description" + } + ], + "signature": "static getSavedPaymentMethods(customer: Customer): Collection", + "source": "script-api", + "tags": [ + "getsavedpaymentmethods", + "salesforcepaymentsmgr.getsavedpaymentmethods" + ], + "throws": [ + { + "description": "if the given customer is null or undefined , or there is configuration missing that is required to retrieve the saved payment methods", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.getSavedPaymentMethods" + }, + { + "description": "Handles the given additional Adyen payment details and associates the associated payment with the given order, if applicable.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#handleAdyenAdditionalDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "data", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.handleAdyenAdditionalDetails", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Handles the given additional Adyen payment details and associates the associated payment with the given order, if\napplicable.\n\nPass the state data from the Adyen `onAdditionalDetails` event as-is, without any encoding or other\nchanges to the data or its structure. See the Adyen documentation for more information.", + "heading": "Description" + } + ], + "signature": "static handleAdyenAdditionalDetails(order: Order, zoneId: string, data: Object): Status", + "source": "script-api", + "tags": [ + "handleadyenadditionaldetails", + "salesforcepaymentsmgr.handleadyenadditionaldetails" + ], + "title": "SalesforcePaymentsMgr.handleAdyenAdditionalDetails" + }, + { + "description": "Handles the given additional Adyen payment details and associates the associated payment with the given order, if applicable.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#handleAdyenAdditionalDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "zoneId", + "type": "string" + }, + { + "name": "data", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.handleAdyenAdditionalDetails", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Handles the given additional Adyen payment details and associates the associated payment with the given order, if\napplicable.\n\nPass the state data from the Adyen `onAdditionalDetails` event as-is, without any encoding or other\nchanges to the data or its structure. See the Adyen documentation for more information.", + "heading": "Description" + } + ], + "signature": "static handleAdyenAdditionalDetails(order: Order, zoneId: string, data: Object): Status", + "source": "script-api", + "tags": [ + "handleadyenadditionaldetails", + "salesforcepaymentsmgr.handleadyenadditionaldetails" + ], + "title": "SalesforcePaymentsMgr.handleAdyenAdditionalDetails" + }, + { + "description": "Handles the account registration of the shopper who placed the given order. Use this method to ensure the registered customer profile is associated with the order in Salesforce Payments.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#onCustomerRegistered", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.onCustomerRegistered", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Handles the account registration of the shopper who placed the given order. Use this method to ensure the\nregistered customer profile is associated with the order in Salesforce Payments.", + "heading": "Description" + } + ], + "signature": "static onCustomerRegistered(order: Order): void", + "source": "script-api", + "tags": [ + "oncustomerregistered", + "salesforcepaymentsmgr.oncustomerregistered" + ], + "throws": [ + { + "description": "if there was an error attaching the payment method to the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.onCustomerRegistered" + }, + { + "description": "Handles the account registration of the shopper who placed the given order. Use this method to ensure the registered customer profile is associated with the order in Salesforce Payments.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#onCustomerRegistered", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.onCustomerRegistered", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Handles the account registration of the shopper who placed the given order. Use this method to ensure the\nregistered customer profile is associated with the order in Salesforce Payments.", + "heading": "Description" + } + ], + "signature": "static onCustomerRegistered(order: Order): void", + "source": "script-api", + "tags": [ + "oncustomerregistered", + "salesforcepaymentsmgr.oncustomerregistered" + ], + "throws": [ + { + "description": "if there was an error attaching the payment method to the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.onCustomerRegistered" + }, + { + "description": "Returns a payments site configuration object for the current site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#paymentsSiteConfig", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.paymentsSiteConfig", + "sections": [ + { + "body": "Returns a payments site configuration object for the current site.", + "heading": "Description" + } + ], + "signature": "static readonly paymentsSiteConfig: SalesforcePaymentsSiteConfiguration | null", + "source": "script-api", + "tags": [ + "paymentssiteconfig", + "salesforcepaymentsmgr.paymentssiteconfig" + ], + "throws": [ + { + "description": "if there is no current site", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.paymentsSiteConfig" + }, + { + "description": "Returns a payments site configuration object for the current site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#paymentsSiteConfig", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.paymentsSiteConfig", + "sections": [ + { + "body": "Returns a payments site configuration object for the current site.", + "heading": "Description" + } + ], + "signature": "static readonly paymentsSiteConfig: SalesforcePaymentsSiteConfiguration | null", + "source": "script-api", + "tags": [ + "paymentssiteconfig", + "salesforcepaymentsmgr.paymentssiteconfig" + ], + "throws": [ + { + "description": "if there is no current site", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.paymentsSiteConfig" + }, + { + "description": "Refunds previously captured funds for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds previously captured funds for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports refund.\n\nThe `amount` must be less than or equal to the amount available to refund.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static refundAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, amount: Money, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "refundadyenpayment", + "salesforcepaymentsmgr.refundadyenpayment" + ], + "throws": [ + { + "description": "if there was an error refunding the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundAdyenPayment" + }, + { + "description": "Refunds previously captured funds for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds previously captured funds for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports refund.\n\nThe `amount` must be less than or equal to the amount available to refund.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static refundAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, amount: Money, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "refundadyenpayment", + "salesforcepaymentsmgr.refundadyenpayment" + ], + "throws": [ + { + "description": "if there was an error refunding the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundAdyenPayment" + }, + { + "description": "Refunds the capture for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPayPalOrderCapture", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPayPalOrderCapture", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds the capture for the given PayPal order.\n\nThe PayPal order must have a capture in a status that supports refund. See the PayPal documentation for more\ndetails.", + "heading": "Description" + } + ], + "signature": "static refundPayPalOrderCapture(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "refundpaypalordercapture", + "salesforcepaymentsmgr.refundpaypalordercapture" + ], + "throws": [ + { + "description": "if there was an error refunding the capture for the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundPayPalOrderCapture" + }, + { + "description": "Refunds the capture for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPayPalOrderCapture", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPayPalOrderCapture", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds the capture for the given PayPal order.\n\nThe PayPal order must have a capture in a status that supports refund. See the PayPal documentation for more\ndetails.", + "heading": "Description" + } + ], + "signature": "static refundPayPalOrderCapture(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "refundpaypalordercapture", + "salesforcepaymentsmgr.refundpaypalordercapture" + ], + "throws": [ + { + "description": "if there was an error refunding the capture for the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundPayPalOrderCapture" + }, + { + "description": "Refunds previously captured funds for the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "refundProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds previously captured funds for the given payment intent.\n\nThe payment intent must be in a state that supports refund. This includes its status as well as any previous\nrefunds. See the Stripe documentation for more details.\n\nThe following Payment Intent property is supported:\n\n- `reason` - optional payment intent refund reason\n\nIf `amount` is not specified, the default is the full amount available to refund. If specified, the\namount must be less than or equal to the amount available to refund.", + "heading": "Description" + } + ], + "signature": "static refundPaymentIntent(paymentIntent: SalesforcePaymentIntent, amount: Money, refundProperties: Object): Status", + "source": "script-api", + "tags": [ + "refundpaymentintent", + "salesforcepaymentsmgr.refundpaymentintent" + ], + "throws": [ + { + "description": "if there was an error refunding the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundPaymentIntent" + }, + { + "description": "Refunds previously captured funds for the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#refundPaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "refundProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.refundPaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Refunds previously captured funds for the given payment intent.\n\nThe payment intent must be in a state that supports refund. This includes its status as well as any previous\nrefunds. See the Stripe documentation for more details.\n\nThe following Payment Intent property is supported:\n\n- `reason` - optional payment intent refund reason\n\nIf `amount` is not specified, the default is the full amount available to refund. If specified, the\namount must be less than or equal to the amount available to refund.", + "heading": "Description" + } + ], + "signature": "static refundPaymentIntent(paymentIntent: SalesforcePaymentIntent, amount: Money, refundProperties: Object): Status", + "source": "script-api", + "tags": [ + "refundpaymentintent", + "salesforcepaymentsmgr.refundpaymentintent" + ], + "throws": [ + { + "description": "if there was an error refunding the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.refundPaymentIntent" + }, + { + "description": "Deletes an Adyen saved payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeAdyenSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "savedPaymentMethod", + "type": "SalesforceAdyenSavedPaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes an Adyen saved payment method.", + "heading": "Description" + } + ], + "signature": "static removeAdyenSavedPaymentMethod(savedPaymentMethod: SalesforceAdyenSavedPaymentMethod): void", + "source": "script-api", + "tags": [ + "removeadyensavedpaymentmethod", + "salesforcepaymentsmgr.removeadyensavedpaymentmethod" + ], + "throws": [ + { + "description": "if the saved payment method is null or undefined , or there is configuration missing that is required to delete the saved payment method", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod" + }, + { + "description": "Deletes an Adyen saved payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeAdyenSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "savedPaymentMethod", + "type": "SalesforceAdyenSavedPaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes an Adyen saved payment method.", + "heading": "Description" + } + ], + "signature": "static removeAdyenSavedPaymentMethod(savedPaymentMethod: SalesforceAdyenSavedPaymentMethod): void", + "source": "script-api", + "tags": [ + "removeadyensavedpaymentmethod", + "salesforcepaymentsmgr.removeadyensavedpaymentmethod" + ], + "throws": [ + { + "description": "if the saved payment method is null or undefined , or there is configuration missing that is required to delete the saved payment method", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.removeAdyenSavedPaymentMethod" + }, + { + "description": "Removes the given saved payment method so that it is no longer presented to the given customer for reuse in checkouts. The payment method remains in the payment account, but is no longer saved for use by the customer.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeSavedPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the given saved payment method so that it is no longer presented to the given customer for reuse in\ncheckouts. The payment method remains in the payment account, but is no longer saved for use by the customer.", + "heading": "Description" + } + ], + "signature": "static removeSavedPaymentMethod(paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "removesavedpaymentmethod", + "salesforcepaymentsmgr.removesavedpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error removing the saved payment method from its customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.removeSavedPaymentMethod" + }, + { + "description": "Removes the given saved payment method so that it is no longer presented to the given customer for reuse in checkouts. The payment method remains in the payment account, but is no longer saved for use by the customer.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#removeSavedPaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.removeSavedPaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the given saved payment method so that it is no longer presented to the given customer for reuse in\ncheckouts. The payment method remains in the payment account, but is no longer saved for use by the customer.", + "heading": "Description" + } + ], + "signature": "static removeSavedPaymentMethod(paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "removesavedpaymentmethod", + "salesforcepaymentsmgr.removesavedpaymentmethod" + ], + "throws": [ + { + "description": "if there was an error removing the saved payment method from its customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.removeSavedPaymentMethod" + }, + { + "description": "Resolves and returns the payments zone object for the passed in payments zone properties object. If an empty object is provided, the default payments zone will be returned if it exists.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#resolvePaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentsZoneProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.resolvePaymentsZone", + "returns": { + "type": "SalesforcePaymentsZone | null" + }, + "sections": [ + { + "body": "Resolves and returns the payments zone object for the passed in payments zone properties object. If an empty\nobject is provided, the default payments zone will be returned if it exists.\n\nThe following payments zone properties are supported:\n\n- `countryCode` - optional country code of the shopper, or `null` if not known\n- `currency` - optional basket currency, or `null` if not known", + "heading": "Description" + } + ], + "signature": "static resolvePaymentsZone(paymentsZoneProperties: Object): SalesforcePaymentsZone | null", + "source": "script-api", + "tags": [ + "resolvepaymentszone", + "salesforcepaymentsmgr.resolvepaymentszone" + ], + "throws": [ + { + "description": "if no default payments zone exists", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.resolvePaymentsZone" + }, + { + "description": "Resolves and returns the payments zone object for the passed in payments zone properties object. If an empty object is provided, the default payments zone will be returned if it exists.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#resolvePaymentsZone", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentsZoneProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.resolvePaymentsZone", + "returns": { + "type": "SalesforcePaymentsZone | null" + }, + "sections": [ + { + "body": "Resolves and returns the payments zone object for the passed in payments zone properties object. If an empty\nobject is provided, the default payments zone will be returned if it exists.\n\nThe following payments zone properties are supported:\n\n- `countryCode` - optional country code of the shopper, or `null` if not known\n- `currency` - optional basket currency, or `null` if not known", + "heading": "Description" + } + ], + "signature": "static resolvePaymentsZone(paymentsZoneProperties: Object): SalesforcePaymentsZone | null", + "source": "script-api", + "tags": [ + "resolvepaymentszone", + "salesforcepaymentsmgr.resolvepaymentszone" + ], + "throws": [ + { + "description": "if no default payments zone exists", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.resolvePaymentsZone" + }, + { + "description": "Reverses the authorisation for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#reverseAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.reverseAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Reverses the authorisation for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports reversal.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static reverseAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "reverseadyenpayment", + "salesforcepaymentsmgr.reverseadyenpayment" + ], + "throws": [ + { + "description": "if there was an error reversing the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.reverseAdyenPayment" + }, + { + "description": "Reverses the authorisation for the given order payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#reverseAdyenPayment", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "orderPaymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "transactionProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.reverseAdyenPayment", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Reverses the authorisation for the given order payment instrument.\n\nThe order payment instrument must be in a state that supports reversal.\n\nThe following Transaction properties are supported:\n\n- `reference` - optional reference for the transaction, for example order number", + "heading": "Description" + } + ], + "signature": "static reverseAdyenPayment(orderPaymentInstrument: OrderPaymentInstrument, transactionProperties: Object): Status", + "source": "script-api", + "tags": [ + "reverseadyenpayment", + "salesforcepaymentsmgr.reverseadyenpayment" + ], + "throws": [ + { + "description": "if there was an error reversing the payment instrument", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.reverseAdyenPayment" + }, + { + "description": "Saves the given payment method to be presented to the given customer for reuse in subsequent checkouts. This method will throw an error if passed incompatible payment method and/or customer objects.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#savePaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.savePaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Saves the given payment method to be presented to the given customer for reuse in subsequent checkouts. This\nmethod will throw an error if passed incompatible payment method and/or customer objects.", + "heading": "Description" + } + ], + "signature": "static savePaymentMethod(customer: Customer, paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "savepaymentmethod", + "salesforcepaymentsmgr.savepaymentmethod" + ], + "throws": [ + { + "description": "if there was an error saving the payment method for the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.savePaymentMethod" + }, + { + "description": "Saves the given payment method to be presented to the given customer for reuse in subsequent checkouts. This method will throw an error if passed incompatible payment method and/or customer objects.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#savePaymentMethod", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "customer", + "type": "Customer" + }, + { + "name": "paymentMethod", + "type": "SalesforcePaymentMethod" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.savePaymentMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Saves the given payment method to be presented to the given customer for reuse in subsequent checkouts. This\nmethod will throw an error if passed incompatible payment method and/or customer objects.", + "heading": "Description" + } + ], + "signature": "static savePaymentMethod(customer: Customer, paymentMethod: SalesforcePaymentMethod): void", + "source": "script-api", + "tags": [ + "savepaymentmethod", + "salesforcepaymentsmgr.savepaymentmethod" + ], + "throws": [ + { + "description": "if there was an error saving the payment method for the customer", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.savePaymentMethod" + }, + { + "description": "Sets the details to the Salesforce Payments payment associated with the given payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#setPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "paymentDetails", + "type": "SalesforcePaymentDetails" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.setPaymentDetails", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the details to the Salesforce Payments payment associated with the given payment instrument.", + "heading": "Description" + } + ], + "signature": "static setPaymentDetails(paymentInstrument: OrderPaymentInstrument, paymentDetails: SalesforcePaymentDetails): void", + "source": "script-api", + "tags": [ + "setpaymentdetails", + "salesforcepaymentsmgr.setpaymentdetails" + ], + "throws": [ + { + "description": "if either paymentInstrument or paymentDetails is null", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.setPaymentDetails" + }, + { + "description": "Sets the details to the Salesforce Payments payment associated with the given payment instrument.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#setPaymentDetails", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "paymentDetails", + "type": "SalesforcePaymentDetails" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.setPaymentDetails", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the details to the Salesforce Payments payment associated with the given payment instrument.", + "heading": "Description" + } + ], + "signature": "static setPaymentDetails(paymentInstrument: OrderPaymentInstrument, paymentDetails: SalesforcePaymentDetails): void", + "source": "script-api", + "tags": [ + "setpaymentdetails", + "salesforcepaymentsmgr.setpaymentdetails" + ], + "throws": [ + { + "description": "if either paymentInstrument or paymentDetails is null", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.setPaymentDetails" + }, + { + "description": "Updates the provided information in the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#updatePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "orderNo", + "type": "string" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.updatePaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Updates the provided information in the given payment intent.\n\nThe payment intent must be in a status that supports update. See the Stripe documentation for more details.\n\nThe following Payment Intent properties are supported:\n\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.", + "heading": "Description" + } + ], + "signature": "static updatePaymentIntent(paymentIntent: SalesforcePaymentIntent, shipment: Shipment, amount: Money, orderNo: string, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "updatepaymentintent", + "salesforcepaymentsmgr.updatepaymentintent" + ], + "throws": [ + { + "description": "if the parameter validation failed or there's an error updating the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.updatePaymentIntent" + }, + { + "description": "Updates the provided information in the given payment intent.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#updatePaymentIntent", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paymentIntent", + "type": "SalesforcePaymentIntent" + }, + { + "name": "shipment", + "type": "Shipment" + }, + { + "name": "amount", + "type": "Money" + }, + { + "name": "orderNo", + "type": "string" + }, + { + "name": "paymentIntentProperties", + "type": "Object" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.updatePaymentIntent", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Updates the provided information in the given payment intent.\n\nThe payment intent must be in a status that supports update. See the Stripe documentation for more details.\n\nThe following Payment Intent properties are supported:\n\n- `statementDescriptor` - optional statement descriptor\n- `cardCaptureAutomatic` - optional `true` if the credit card payment should be\nautomatically captured at the time of the sale, or `false` if the credit card payment should be\ncaptured later\n\nIf `cardCaptureAutomatic` is provided it is used to determine card capture timing, and otherwise the\ndefault card capture timing set for the site is used.\n\nIf `statementDescriptor` is provided it is used as the complete description that appears on your\ncustomers' statements for the payment, and if not a default statement descriptor is used. If a default statement\ndescriptor is set for the site it is used as the default, and otherwise the default statement descriptor for the\naccount will apply.", + "heading": "Description" + } + ], + "signature": "static updatePaymentIntent(paymentIntent: SalesforcePaymentIntent, shipment: Shipment, amount: Money, orderNo: string, paymentIntentProperties: Object): Status", + "source": "script-api", + "tags": [ + "updatepaymentintent", + "salesforcepaymentsmgr.updatepaymentintent" + ], + "throws": [ + { + "description": "if the parameter validation failed or there's an error updating the payment intent", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.updatePaymentIntent" + }, + { + "description": "Voids the authorization for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#voidPayPalOrderAuthorization", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.voidPayPalOrderAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Voids the authorization for the given PayPal order.\n\nThe PayPal order must have an authorization in a status that supports voiding. See the PayPal documentation for\nmore details.", + "heading": "Description" + } + ], + "signature": "static voidPayPalOrderAuthorization(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "voidpaypalorderauthorization", + "salesforcepaymentsmgr.voidpaypalorderauthorization" + ], + "throws": [ + { + "description": "if there was an error voiding the authorization for the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.voidPayPalOrderAuthorization" + }, + { + "description": "Voids the authorization for the given PayPal order.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsMgr#voidPayPalOrderAuthorization", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "paypalOrder", + "type": "SalesforcePayPalOrder" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsMgr", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsMgr.voidPayPalOrderAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Voids the authorization for the given PayPal order.\n\nThe PayPal order must have an authorization in a status that supports voiding. See the PayPal documentation for\nmore details.", + "heading": "Description" + } + ], + "signature": "static voidPayPalOrderAuthorization(paypalOrder: SalesforcePayPalOrder): Status", + "source": "script-api", + "tags": [ + "voidpaypalorderauthorization", + "salesforcepaymentsmgr.voidpaypalorderauthorization" + ], + "throws": [ + { + "description": "if there was an error voiding the authorization for the PayPal order", + "type": "Exception" + } + ], + "title": "SalesforcePaymentsMgr.voidPayPalOrderAuthorization" + }, + { + "description": "Salesforce Payments representation of a payment site configuration object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration", + "sections": [ + { + "body": "Salesforce Payments representation of a payment site configuration object. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.\n\nA payment site configuration contains information about the configuration of the site such as\nwhether the site is activated with Express Checkout, Multi-Step Checkout or both.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentssiteconfiguration", + "dw.extensions.payments.salesforcepaymentssiteconfiguration", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsSiteConfiguration" + }, + { + "description": "Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#cardCaptureAutomatic", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.cardCaptureAutomatic", + "sections": [ + { + "body": "Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or\nfalse if the capture method is set to manual.", + "heading": "Description" + } + ], + "signature": "readonly cardCaptureAutomatic: boolean", + "source": "script-api", + "tags": [ + "cardcaptureautomatic", + "salesforcepaymentssiteconfiguration.cardcaptureautomatic" + ], + "title": "SalesforcePaymentsSiteConfiguration.cardCaptureAutomatic" + }, + { + "description": "Returns true if Express Checkout is enabled for the site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressCheckoutEnabled", + "sections": [ + { + "body": "Returns true if Express Checkout is enabled for the site.", + "heading": "Description" + } + ], + "signature": "readonly expressCheckoutEnabled: boolean", + "source": "script-api", + "tags": [ + "expresscheckoutenabled", + "salesforcepaymentssiteconfiguration.expresscheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressCheckoutEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Cart page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnCartEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnCartEnabled", + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Cart page.", + "heading": "Description" + } + ], + "signature": "readonly expressOnCartEnabled: boolean", + "source": "script-api", + "tags": [ + "expressoncartenabled", + "salesforcepaymentssiteconfiguration.expressoncartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnCartEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Checkout page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnCheckoutEnabled", + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Checkout page.", + "heading": "Description" + } + ], + "signature": "readonly expressOnCheckoutEnabled: boolean", + "source": "script-api", + "tags": [ + "expressoncheckoutenabled", + "salesforcepaymentssiteconfiguration.expressoncheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnCheckoutEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Mini-Cart.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnMiniCartEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnMiniCartEnabled", + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Mini-Cart.", + "heading": "Description" + } + ], + "signature": "readonly expressOnMiniCartEnabled: boolean", + "source": "script-api", + "tags": [ + "expressonminicartenabled", + "salesforcepaymentssiteconfiguration.expressonminicartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnMiniCartEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Product Detail Page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#expressOnPdpEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.expressOnPdpEnabled", + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Product Detail Page.", + "heading": "Description" + } + ], + "signature": "readonly expressOnPdpEnabled: boolean", + "source": "script-api", + "tags": [ + "expressonpdpenabled", + "salesforcepaymentssiteconfiguration.expressonpdpenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.expressOnPdpEnabled" + }, + { + "description": "Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#futureUsageOffSession", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.futureUsageOffSession", + "sections": [ + { + "body": "Returns true if the payment card credential storage is configured to set up all applicable payments for off\nsession reuse, or false if the credential storage is configured to set up for on session reuse only the payments\nfor which the shopper actively confirms use of saved credentials.", + "heading": "Description" + } + ], + "signature": "readonly futureUsageOffSession: boolean", + "source": "script-api", + "tags": [ + "futureusageoffsession", + "salesforcepaymentssiteconfiguration.futureusageoffsession" + ], + "title": "SalesforcePaymentsSiteConfiguration.futureUsageOffSession" + }, + { + "description": "Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isCardCaptureAutomatic", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isCardCaptureAutomatic", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or\nfalse if the capture method is set to manual.", + "heading": "Description" + } + ], + "signature": "isCardCaptureAutomatic(): boolean", + "source": "script-api", + "tags": [ + "iscardcaptureautomatic", + "salesforcepaymentssiteconfiguration.iscardcaptureautomatic" + ], + "title": "SalesforcePaymentsSiteConfiguration.isCardCaptureAutomatic" + }, + { + "description": "Returns true if Express Checkout is enabled for the site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressCheckoutEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Express Checkout is enabled for the site.", + "heading": "Description" + } + ], + "signature": "isExpressCheckoutEnabled(): boolean", + "source": "script-api", + "tags": [ + "isexpresscheckoutenabled", + "salesforcepaymentssiteconfiguration.isexpresscheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressCheckoutEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Cart page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnCartEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnCartEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Cart page.", + "heading": "Description" + } + ], + "signature": "isExpressOnCartEnabled(): boolean", + "source": "script-api", + "tags": [ + "isexpressoncartenabled", + "salesforcepaymentssiteconfiguration.isexpressoncartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnCartEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Checkout page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnCheckoutEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Checkout page.", + "heading": "Description" + } + ], + "signature": "isExpressOnCheckoutEnabled(): boolean", + "source": "script-api", + "tags": [ + "isexpressoncheckoutenabled", + "salesforcepaymentssiteconfiguration.isexpressoncheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnCheckoutEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Mini-Cart.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnMiniCartEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnMiniCartEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Mini-Cart.", + "heading": "Description" + } + ], + "signature": "isExpressOnMiniCartEnabled(): boolean", + "source": "script-api", + "tags": [ + "isexpressonminicartenabled", + "salesforcepaymentssiteconfiguration.isexpressonminicartenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnMiniCartEnabled" + }, + { + "description": "Returns true if Express Checkout is enabled on the Product Detail Page.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isExpressOnPdpEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isExpressOnPdpEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Express Checkout is enabled on the Product Detail Page.", + "heading": "Description" + } + ], + "signature": "isExpressOnPdpEnabled(): boolean", + "source": "script-api", + "tags": [ + "isexpressonpdpenabled", + "salesforcepaymentssiteconfiguration.isexpressonpdpenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isExpressOnPdpEnabled" + }, + { + "description": "Returns true if the payment card credential storage is configured to set up all applicable payments for off session reuse, or false if the credential storage is configured to set up for on session reuse only the payments for which the shopper actively confirms use of saved credentials.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isFutureUsageOffSession", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isFutureUsageOffSession", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the payment card credential storage is configured to set up all applicable payments for off\nsession reuse, or false if the credential storage is configured to set up for on session reuse only the payments\nfor which the shopper actively confirms use of saved credentials.", + "heading": "Description" + } + ], + "signature": "isFutureUsageOffSession(): boolean", + "source": "script-api", + "tags": [ + "isfutureusageoffsession", + "salesforcepaymentssiteconfiguration.isfutureusageoffsession" + ], + "title": "SalesforcePaymentsSiteConfiguration.isFutureUsageOffSession" + }, + { + "description": "Returns true if Multi-Step Checkout is enabled for the site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#isMultiStepCheckoutEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.isMultiStepCheckoutEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if Multi-Step Checkout is enabled for the site.", + "heading": "Description" + } + ], + "signature": "isMultiStepCheckoutEnabled(): boolean", + "source": "script-api", + "tags": [ + "ismultistepcheckoutenabled", + "salesforcepaymentssiteconfiguration.ismultistepcheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.isMultiStepCheckoutEnabled" + }, + { + "description": "Returns true if Multi-Step Checkout is enabled for the site.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration#multiStepCheckoutEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsSiteConfiguration", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsSiteConfiguration.multiStepCheckoutEnabled", + "sections": [ + { + "body": "Returns true if Multi-Step Checkout is enabled for the site.", + "heading": "Description" + } + ], + "signature": "readonly multiStepCheckoutEnabled: boolean", + "source": "script-api", + "tags": [ + "multistepcheckoutenabled", + "salesforcepaymentssiteconfiguration.multistepcheckoutenabled" + ], + "title": "SalesforcePaymentsSiteConfiguration.multiStepCheckoutEnabled" + }, + { + "description": "Salesforce Payments representation of a payments zone. See Salesforce Payments documentation for how to gain access and configure payment zones and assign them to sites.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone", + "sections": [ + { + "body": "Salesforce Payments representation of a payments zone. See Salesforce Payments documentation for how to gain access\nand configure payment zones and assign them to sites.\n\nA payments zone contains information about the payment zone for a site and country.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "salesforcepaymentszone", + "dw.extensions.payments.salesforcepaymentszone", + "dw/extensions/payments" + ], + "title": "SalesforcePaymentsZone" + }, + { + "description": "Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#afterpayClearpayEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.afterpayClearpayEnabled", + "sections": [ + { + "body": "Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly afterpayClearpayEnabled: boolean", + "source": "script-api", + "tags": [ + "afterpayclearpayenabled", + "salesforcepaymentszone.afterpayclearpayenabled" + ], + "title": "SalesforcePaymentsZone.afterpayClearpayEnabled" + }, + { + "description": "Returns `true` if Apple Pay presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#applePayEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.applePayEnabled", + "sections": [ + { + "body": "Returns `true` if Apple Pay presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly applePayEnabled: boolean", + "source": "script-api", + "tags": [ + "applepayenabled", + "salesforcepaymentszone.applepayenabled" + ], + "title": "SalesforcePaymentsZone.applePayEnabled" + }, + { + "description": "Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen merchant accounts, this setting refers to the \"Bancontact Card\" payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#bancontactEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.bancontactEnabled", + "sections": [ + { + "body": "Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen\nmerchant accounts, this setting refers to the \"Bancontact Card\" payment method.", + "heading": "Description" + } + ], + "signature": "readonly bancontactEnabled: boolean", + "source": "script-api", + "tags": [ + "bancontactenabled", + "salesforcepaymentszone.bancontactenabled" + ], + "title": "SalesforcePaymentsZone.bancontactEnabled" + }, + { + "description": "Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#bancontactMobileEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.bancontactMobileEnabled", + "sections": [ + { + "body": "Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This\nsetting is only applicable for Adyen Merchant Accounts", + "heading": "Description" + } + ], + "signature": "readonly bancontactMobileEnabled: boolean", + "source": "script-api", + "tags": [ + "bancontactmobileenabled", + "salesforcepaymentszone.bancontactmobileenabled" + ], + "title": "SalesforcePaymentsZone.bancontactMobileEnabled" + }, + { + "description": "Returns `true` if credit card presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#cardEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.cardEnabled", + "sections": [ + { + "body": "Returns `true` if credit card presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly cardEnabled: boolean", + "source": "script-api", + "tags": [ + "cardenabled", + "salesforcepaymentszone.cardenabled" + ], + "title": "SalesforcePaymentsZone.cardEnabled" + }, + { + "description": "Returns `true` if EPS presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#epsEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.epsEnabled", + "sections": [ + { + "body": "Returns `true` if EPS presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly epsEnabled: boolean", + "source": "script-api", + "tags": [ + "epsenabled", + "salesforcepaymentszone.epsenabled" + ], + "title": "SalesforcePaymentsZone.epsEnabled" + }, + { + "description": "Returns a collection containing the merchant account payment methods to be presented for this payments zone.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#getPaymentMethods", + "kind": "method", + "packagePath": "dw/extensions/payments", + "params": [ + { + "name": "countryCode", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.getPaymentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the merchant account payment methods to be presented for this payments zone.", + "heading": "Description" + } + ], + "signature": "getPaymentMethods(countryCode: string, amount: Money): Collection", + "source": "script-api", + "tags": [ + "getpaymentmethods", + "salesforcepaymentszone.getpaymentmethods" + ], + "title": "SalesforcePaymentsZone.getPaymentMethods" + }, + { + "description": "Returns the id of the payments zone.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#getZoneId", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.getZoneId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of the payments zone.", + "heading": "Description" + } + ], + "signature": "getZoneId(): string", + "source": "script-api", + "tags": [ + "getzoneid", + "salesforcepaymentszone.getzoneid" + ], + "title": "SalesforcePaymentsZone.getZoneId" + }, + { + "description": "Returns `true` if iDEAL presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#idealEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.idealEnabled", + "sections": [ + { + "body": "Returns `true` if iDEAL presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly idealEnabled: boolean", + "source": "script-api", + "tags": [ + "idealenabled", + "salesforcepaymentszone.idealenabled" + ], + "title": "SalesforcePaymentsZone.idealEnabled" + }, + { + "description": "Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isAfterpayClearpayEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isAfterpayClearpayEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isAfterpayClearpayEnabled(): boolean", + "source": "script-api", + "tags": [ + "isafterpayclearpayenabled", + "salesforcepaymentszone.isafterpayclearpayenabled" + ], + "title": "SalesforcePaymentsZone.isAfterpayClearpayEnabled" + }, + { + "description": "Returns `true` if Apple Pay presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isApplePayEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isApplePayEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Apple Pay presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isApplePayEnabled(): boolean", + "source": "script-api", + "tags": [ + "isapplepayenabled", + "salesforcepaymentszone.isapplepayenabled" + ], + "title": "SalesforcePaymentsZone.isApplePayEnabled" + }, + { + "description": "Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen merchant accounts, this setting refers to the \"Bancontact Card\" payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isBancontactEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isBancontactEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen\nmerchant accounts, this setting refers to the \"Bancontact Card\" payment method.", + "heading": "Description" + } + ], + "signature": "isBancontactEnabled(): boolean", + "source": "script-api", + "tags": [ + "isbancontactenabled", + "salesforcepaymentszone.isbancontactenabled" + ], + "title": "SalesforcePaymentsZone.isBancontactEnabled" + }, + { + "description": "Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isBancontactMobileEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isBancontactMobileEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This\nsetting is only applicable for Adyen Merchant Accounts", + "heading": "Description" + } + ], + "signature": "isBancontactMobileEnabled(): boolean", + "source": "script-api", + "tags": [ + "isbancontactmobileenabled", + "salesforcepaymentszone.isbancontactmobileenabled" + ], + "title": "SalesforcePaymentsZone.isBancontactMobileEnabled" + }, + { + "description": "Returns `true` if credit card presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isCardEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isCardEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if credit card presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isCardEnabled(): boolean", + "source": "script-api", + "tags": [ + "iscardenabled", + "salesforcepaymentszone.iscardenabled" + ], + "title": "SalesforcePaymentsZone.isCardEnabled" + }, + { + "description": "Returns `true` if EPS presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isEpsEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isEpsEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if EPS presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isEpsEnabled(): boolean", + "source": "script-api", + "tags": [ + "isepsenabled", + "salesforcepaymentszone.isepsenabled" + ], + "title": "SalesforcePaymentsZone.isEpsEnabled" + }, + { + "description": "Returns `true` if iDEAL presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isIdealEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isIdealEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if iDEAL presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isIdealEnabled(): boolean", + "source": "script-api", + "tags": [ + "isidealenabled", + "salesforcepaymentszone.isidealenabled" + ], + "title": "SalesforcePaymentsZone.isIdealEnabled" + }, + { + "description": "Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen merchant accounts, this setting applies to the Klarna Pay Later payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen\nmerchant accounts, this setting applies to the Klarna Pay Later payment method.", + "heading": "Description" + } + ], + "signature": "isKlarnaEnabled(): boolean", + "source": "script-api", + "tags": [ + "isklarnaenabled", + "salesforcepaymentszone.isklarnaenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaEnabled" + }, + { + "description": "Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaPayInInstallmentsEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaPayInInstallmentsEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not.\nNote: This setting is only applicable for Adyen Merchant Accounts.", + "heading": "Description" + } + ], + "signature": "isKlarnaPayInInstallmentsEnabled(): boolean", + "source": "script-api", + "tags": [ + "isklarnapayininstallmentsenabled", + "salesforcepaymentszone.isklarnapayininstallmentsenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaPayInInstallmentsEnabled" + }, + { + "description": "Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isKlarnaPayNowEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isKlarnaPayNowEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This\nsetting is only applicable for Adyen Merchant Accounts.", + "heading": "Description" + } + ], + "signature": "isKlarnaPayNowEnabled(): boolean", + "source": "script-api", + "tags": [ + "isklarnapaynowenabled", + "salesforcepaymentszone.isklarnapaynowenabled" + ], + "title": "SalesforcePaymentsZone.isKlarnaPayNowEnabled" + }, + { + "description": "Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPayPalEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPayPalEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isPayPalEnabled(): boolean", + "source": "script-api", + "tags": [ + "ispaypalenabled", + "salesforcepaymentszone.ispaypalenabled" + ], + "title": "SalesforcePaymentsZone.isPayPalEnabled" + }, + { + "description": "Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPayPalExpressEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPayPalExpressEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isPayPalExpressEnabled(): boolean", + "source": "script-api", + "tags": [ + "ispaypalexpressenabled", + "salesforcepaymentszone.ispaypalexpressenabled" + ], + "title": "SalesforcePaymentsZone.isPayPalExpressEnabled" + }, + { + "description": "Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isPaymentRequestEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isPaymentRequestEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isPaymentRequestEnabled(): boolean", + "source": "script-api", + "tags": [ + "ispaymentrequestenabled", + "salesforcepaymentszone.ispaymentrequestenabled" + ], + "title": "SalesforcePaymentsZone.isPaymentRequestEnabled" + }, + { + "description": "Returns `true` if SEPA Debit presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isSepaDebitEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isSepaDebitEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if SEPA Debit presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isSepaDebitEnabled(): boolean", + "source": "script-api", + "tags": [ + "issepadebitenabled", + "salesforcepaymentszone.issepadebitenabled" + ], + "title": "SalesforcePaymentsZone.isSepaDebitEnabled" + }, + { + "description": "Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isVenmoEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isVenmoEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isVenmoEnabled(): boolean", + "source": "script-api", + "tags": [ + "isvenmoenabled", + "salesforcepaymentszone.isvenmoenabled" + ], + "title": "SalesforcePaymentsZone.isVenmoEnabled" + }, + { + "description": "Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#isVenmoExpressEnabled", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.isVenmoExpressEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "isVenmoExpressEnabled(): boolean", + "source": "script-api", + "tags": [ + "isvenmoexpressenabled", + "salesforcepaymentszone.isvenmoexpressenabled" + ], + "title": "SalesforcePaymentsZone.isVenmoExpressEnabled" + }, + { + "description": "Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen merchant accounts, this setting applies to the Klarna Pay Later payment method.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaEnabled", + "sections": [ + { + "body": "Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen\nmerchant accounts, this setting applies to the Klarna Pay Later payment method.", + "heading": "Description" + } + ], + "signature": "readonly klarnaEnabled: boolean", + "source": "script-api", + "tags": [ + "klarnaenabled", + "salesforcepaymentszone.klarnaenabled" + ], + "title": "SalesforcePaymentsZone.klarnaEnabled" + }, + { + "description": "Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaPayInInstallmentsEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaPayInInstallmentsEnabled", + "sections": [ + { + "body": "Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not.\nNote: This setting is only applicable for Adyen Merchant Accounts.", + "heading": "Description" + } + ], + "signature": "readonly klarnaPayInInstallmentsEnabled: boolean", + "source": "script-api", + "tags": [ + "klarnapayininstallmentsenabled", + "salesforcepaymentszone.klarnapayininstallmentsenabled" + ], + "title": "SalesforcePaymentsZone.klarnaPayInInstallmentsEnabled" + }, + { + "description": "Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This setting is only applicable for Adyen Merchant Accounts.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#klarnaPayNowEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.klarnaPayNowEnabled", + "sections": [ + { + "body": "Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This\nsetting is only applicable for Adyen Merchant Accounts.", + "heading": "Description" + } + ], + "signature": "readonly klarnaPayNowEnabled: boolean", + "source": "script-api", + "tags": [ + "klarnapaynowenabled", + "salesforcepaymentszone.klarnapaynowenabled" + ], + "title": "SalesforcePaymentsZone.klarnaPayNowEnabled" + }, + { + "description": "Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#payPalEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.payPalEnabled", + "sections": [ + { + "body": "Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly payPalEnabled: boolean", + "source": "script-api", + "tags": [ + "paypalenabled", + "salesforcepaymentszone.paypalenabled" + ], + "title": "SalesforcePaymentsZone.payPalEnabled" + }, + { + "description": "Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#payPalExpressEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.payPalExpressEnabled", + "sections": [ + { + "body": "Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly payPalExpressEnabled: boolean", + "source": "script-api", + "tags": [ + "paypalexpressenabled", + "salesforcepaymentszone.paypalexpressenabled" + ], + "title": "SalesforcePaymentsZone.payPalExpressEnabled" + }, + { + "description": "Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#paymentRequestEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.paymentRequestEnabled", + "sections": [ + { + "body": "Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly paymentRequestEnabled: boolean", + "source": "script-api", + "tags": [ + "paymentrequestenabled", + "salesforcepaymentszone.paymentrequestenabled" + ], + "title": "SalesforcePaymentsZone.paymentRequestEnabled" + }, + { + "description": "Returns `true` if SEPA Debit presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#sepaDebitEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.sepaDebitEnabled", + "sections": [ + { + "body": "Returns `true` if SEPA Debit presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly sepaDebitEnabled: boolean", + "source": "script-api", + "tags": [ + "sepadebitenabled", + "salesforcepaymentszone.sepadebitenabled" + ], + "title": "SalesforcePaymentsZone.sepaDebitEnabled" + }, + { + "description": "Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#venmoEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.venmoEnabled", + "sections": [ + { + "body": "Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly venmoEnabled: boolean", + "source": "script-api", + "tags": [ + "venmoenabled", + "salesforcepaymentszone.venmoenabled" + ], + "title": "SalesforcePaymentsZone.venmoEnabled" + }, + { + "description": "Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#venmoExpressEnabled", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.venmoExpressEnabled", + "sections": [ + { + "body": "Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.", + "heading": "Description" + } + ], + "signature": "readonly venmoExpressEnabled: boolean", + "source": "script-api", + "tags": [ + "venmoexpressenabled", + "salesforcepaymentszone.venmoexpressenabled" + ], + "title": "SalesforcePaymentsZone.venmoExpressEnabled" + }, + { + "description": "Returns the id of the payments zone.", + "id": "script-api:dw/extensions/payments/SalesforcePaymentsZone#zoneId", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforcePaymentsZone", + "qualifiedName": "dw.extensions.payments.SalesforcePaymentsZone.zoneId", + "sections": [ + { + "body": "Returns the id of the payments zone.", + "heading": "Description" + } + ], + "signature": "readonly zoneId: string", + "source": "script-api", + "tags": [ + "zoneid", + "salesforcepaymentszone.zoneid" + ], + "title": "SalesforcePaymentsZone.zoneId" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_SEPA_DEBIT. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_SEPA_DEBIT. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforcesepadebitpaymentdetails", + "dw.extensions.payments.salesforcesepadebitpaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceSepaDebitPaymentDetails" + }, + { + "description": "Returns the last 4 digits of the account number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails#getLast4", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails.getLast4", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 digits of the account number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getLast4(): string | null", + "source": "script-api", + "tags": [ + "getlast4", + "salesforcesepadebitpaymentdetails.getlast4" + ], + "title": "SalesforceSepaDebitPaymentDetails.getLast4" + }, + { + "description": "Returns the last 4 digits of the account number, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails#last4", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceSepaDebitPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceSepaDebitPaymentDetails.last4", + "sections": [ + { + "body": "Returns the last 4 digits of the account number, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly last4: string | null", + "source": "script-api", + "tags": [ + "last4", + "salesforcesepadebitpaymentdetails.last4" + ], + "title": "SalesforceSepaDebitPaymentDetails.last4" + }, + { + "description": "Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_VENMO. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.", + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "kind": "class", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails", + "sections": [ + { + "body": "Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_VENMO. See Salesforce Payments\ndocumentation for how to gain access and configure it for use on your sites.", + "heading": "Description" + }, + { + "body": "Extends `SalesforcePaymentDetails`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "salesforcevenmopaymentdetails", + "dw.extensions.payments.salesforcevenmopaymentdetails", + "dw/extensions/payments" + ], + "title": "SalesforceVenmoPaymentDetails" + }, + { + "description": "Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#captureID", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.captureID", + "sections": [ + { + "body": "Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly captureID: string | null", + "source": "script-api", + "tags": [ + "captureid", + "salesforcevenmopaymentdetails.captureid" + ], + "title": "SalesforceVenmoPaymentDetails.captureID" + }, + { + "description": "Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#getCaptureID", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.getCaptureID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getCaptureID(): string | null", + "source": "script-api", + "tags": [ + "getcaptureid", + "salesforcevenmopaymentdetails.getcaptureid" + ], + "title": "SalesforceVenmoPaymentDetails.getCaptureID" + }, + { + "description": "Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#getPayerEmailAddress", + "kind": "method", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.getPayerEmailAddress", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "getPayerEmailAddress(): string | null", + "source": "script-api", + "tags": [ + "getpayeremailaddress", + "salesforcevenmopaymentdetails.getpayeremailaddress" + ], + "title": "SalesforceVenmoPaymentDetails.getPayerEmailAddress" + }, + { + "description": "Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.", + "id": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails#payerEmailAddress", + "kind": "property", + "packagePath": "dw/extensions/payments", + "parentId": "script-api:dw/extensions/payments/SalesforceVenmoPaymentDetails", + "qualifiedName": "dw.extensions.payments.SalesforceVenmoPaymentDetails.payerEmailAddress", + "sections": [ + { + "body": "Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.", + "heading": "Description" + } + ], + "signature": "readonly payerEmailAddress: string | null", + "source": "script-api", + "tags": [ + "payeremailaddress", + "salesforcevenmopaymentdetails.payeremailaddress" + ], + "title": "SalesforceVenmoPaymentDetails.payerEmailAddress" + }, + { + "description": "5 declarations", + "id": "script-api:dw/extensions/pinterest", + "kind": "package", + "packagePath": "dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest", + "source": "script-api", + "tags": [ + "dw/extensions/pinterest", + "dw.extensions.pinterest" + ], + "title": "dw.extensions.pinterest" + }, + { + "description": "Represents a row in the Pinterest availability feed export file.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability", + "sections": [ + { + "body": "Represents a row in the Pinterest availability feed export file.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pinterestavailability", + "dw.extensions.pinterest.pinterestavailability", + "dw/extensions/pinterest" + ], + "title": "PinterestAvailability" + }, + { + "description": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#ID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.ID", + "sections": [ + { + "body": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "pinterestavailability.id" + ], + "title": "PinterestAvailability.ID" + }, + { + "description": "Returns the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#availability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.availability", + "sections": [ + { + "body": "Returns the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "availability: string", + "source": "script-api", + "tags": [ + "availability", + "pinterestavailability.availability" + ], + "title": "PinterestAvailability.availability" + }, + { + "description": "Returns the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.getAvailability", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "getAvailability(): string", + "source": "script-api", + "tags": [ + "getavailability", + "pinterestavailability.getavailability" + ], + "title": "PinterestAvailability.getAvailability" + }, + { + "description": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#getID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "pinterestavailability.getid" + ], + "title": "PinterestAvailability.getID" + }, + { + "description": "Sets the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestAvailability#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "availability", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestAvailability", + "qualifiedName": "dw.extensions.pinterest.PinterestAvailability.setAvailability", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "setAvailability(availability: string): void", + "source": "script-api", + "tags": [ + "setavailability", + "pinterestavailability.setavailability" + ], + "title": "PinterestAvailability.setAvailability" + }, + { + "description": "PinterestFeedHooks interface containing extension points for customizing Pinterest export feeds.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.pinterest.feed.transformProduct\", \"script\": \"./hooks.ds\"}\n]" + ], + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "kind": "interface", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks", + "sections": [ + { + "body": "PinterestFeedHooks interface containing extension points for customizing Pinterest export feeds.\n\nThese hooks are not executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pinterestfeedhooks", + "dw.extensions.pinterest.pinterestfeedhooks", + "dw/extensions/pinterest" + ], + "title": "PinterestFeedHooks" + }, + { + "description": "The extension point name extensionPointTransformAvailability.", + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#extensionPointTransformAvailability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.extensionPointTransformAvailability", + "sections": [ + { + "body": "The extension point name extensionPointTransformAvailability.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointTransformAvailability: \"dw.extensions.pinterest.feed.transformAvailability\"", + "source": "script-api", + "tags": [ + "extensionpointtransformavailability", + "pinterestfeedhooks.extensionpointtransformavailability" + ], + "title": "PinterestFeedHooks.extensionPointTransformAvailability" + }, + { + "description": "The extension point name extensionPointTransformProduct.", + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#extensionPointTransformProduct", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.extensionPointTransformProduct", + "sections": [ + { + "body": "The extension point name extensionPointTransformProduct.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointTransformProduct: \"dw.extensions.pinterest.feed.transformProduct\"", + "source": "script-api", + "tags": [ + "extensionpointtransformproduct", + "pinterestfeedhooks.extensionpointtransformproduct" + ], + "title": "PinterestFeedHooks.extensionPointTransformProduct" + }, + { + "description": "Called after default transformation of given Demandware product to Pinterest availability as part of the availability feed export.", + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#transformAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "pinterestAvailability", + "type": "PinterestAvailability" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.transformAvailability", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after default transformation of given Demandware product to Pinterest availability as part of the\navailability feed export.", + "heading": "Description" + } + ], + "signature": "transformAvailability(product: Product, pinterestAvailability: PinterestAvailability): Status", + "source": "script-api", + "tags": [ + "transformavailability", + "pinterestfeedhooks.transformavailability" + ], + "title": "PinterestFeedHooks.transformAvailability" + }, + { + "description": "Called after default transformation of given Demandware product to Pinterest product as part of the catalog feed export.", + "id": "script-api:dw/extensions/pinterest/PinterestFeedHooks#transformProduct", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "pinterestProduct", + "type": "PinterestProduct" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestFeedHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestFeedHooks.transformProduct", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after default transformation of given Demandware product to Pinterest product as part of the catalog feed\nexport.", + "heading": "Description" + } + ], + "signature": "transformProduct(product: Product, pinterestProduct: PinterestProduct): Status", + "source": "script-api", + "tags": [ + "transformproduct", + "pinterestfeedhooks.transformproduct" + ], + "title": "PinterestFeedHooks.transformProduct" + }, + { + "description": "An order that was placed through Pinterest.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder", + "sections": [ + { + "body": "An order that was placed through Pinterest.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pinterestorder", + "dw.extensions.pinterest.pinterestorder", + "dw/extensions/pinterest" + ], + "title": "PinterestOrder" + }, + { + "description": "Indicates that payment has not been made.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID", + "sections": [ + { + "body": "Indicates that payment has not been made.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_NOT_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_not_paid", + "pinterestorder.payment_status_not_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_NOT_PAID" + }, + { + "description": "Indicates that payment has not been made.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID", + "sections": [ + { + "body": "Indicates that payment has not been made.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_NOT_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_not_paid", + "pinterestorder.payment_status_not_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_NOT_PAID" + }, + { + "description": "Indicates that payment is complete.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID", + "sections": [ + { + "body": "Indicates that payment is complete.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_paid", + "pinterestorder.payment_status_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PAID" + }, + { + "description": "Indicates that payment is complete.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID", + "sections": [ + { + "body": "Indicates that payment is complete.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_paid", + "pinterestorder.payment_status_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PAID" + }, + { + "description": "Indicates that payment is incomplete.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PART_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID", + "sections": [ + { + "body": "Indicates that payment is incomplete.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PART_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_part_paid", + "pinterestorder.payment_status_part_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PART_PAID" + }, + { + "description": "Indicates that payment is incomplete.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#PAYMENT_STATUS_PART_PAID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID", + "sections": [ + { + "body": "Indicates that payment is incomplete.", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PART_PAID: string", + "source": "script-api", + "tags": [ + "payment_status_part_paid", + "pinterestorder.payment_status_part_paid" + ], + "title": "PinterestOrder.PAYMENT_STATUS_PART_PAID" + }, + { + "description": "Indicates an order on backorder.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER", + "sections": [ + { + "body": "Indicates an order on backorder.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "status_backorder", + "pinterestorder.status_backorder" + ], + "title": "PinterestOrder.STATUS_BACKORDER" + }, + { + "description": "Indicates an order on backorder.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER", + "sections": [ + { + "body": "Indicates an order on backorder.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "status_backorder", + "pinterestorder.status_backorder" + ], + "title": "PinterestOrder.STATUS_BACKORDER" + }, + { + "description": "Indicates an order that has been canceled.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED", + "sections": [ + { + "body": "Indicates an order that has been canceled.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "pinterestorder.status_cancelled" + ], + "title": "PinterestOrder.STATUS_CANCELLED" + }, + { + "description": "Indicates an order that has been canceled.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED", + "sections": [ + { + "body": "Indicates an order that has been canceled.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "pinterestorder.status_cancelled" + ], + "title": "PinterestOrder.STATUS_CANCELLED" + }, + { + "description": "Indicates an order that has been delivered.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_DELIVERED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED", + "sections": [ + { + "body": "Indicates an order that has been delivered.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_DELIVERED: string", + "source": "script-api", + "tags": [ + "status_delivered", + "pinterestorder.status_delivered" + ], + "title": "PinterestOrder.STATUS_DELIVERED" + }, + { + "description": "Indicates an order that has been delivered.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_DELIVERED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED", + "sections": [ + { + "body": "Indicates an order that has been delivered.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_DELIVERED: string", + "source": "script-api", + "tags": [ + "status_delivered", + "pinterestorder.status_delivered" + ], + "title": "PinterestOrder.STATUS_DELIVERED" + }, + { + "description": "Indicates an order in progress.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_IN_PROGRESS", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS", + "sections": [ + { + "body": "Indicates an order in progress.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_IN_PROGRESS: string", + "source": "script-api", + "tags": [ + "status_in_progress", + "pinterestorder.status_in_progress" + ], + "title": "PinterestOrder.STATUS_IN_PROGRESS" + }, + { + "description": "Indicates an order in progress.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_IN_PROGRESS", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS", + "sections": [ + { + "body": "Indicates an order in progress.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_IN_PROGRESS: string", + "source": "script-api", + "tags": [ + "status_in_progress", + "pinterestorder.status_in_progress" + ], + "title": "PinterestOrder.STATUS_IN_PROGRESS" + }, + { + "description": "Indicates a new order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_NEW", + "sections": [ + { + "body": "Indicates a new order.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "pinterestorder.status_new" + ], + "title": "PinterestOrder.STATUS_NEW" + }, + { + "description": "Indicates a new order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_NEW", + "sections": [ + { + "body": "Indicates a new order.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "pinterestorder.status_new" + ], + "title": "PinterestOrder.STATUS_NEW" + }, + { + "description": "Indicates an order that has been returned.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED", + "sections": [ + { + "body": "Indicates an order that has been returned.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "pinterestorder.status_returned" + ], + "title": "PinterestOrder.STATUS_RETURNED" + }, + { + "description": "Indicates an order that has been returned.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED", + "sections": [ + { + "body": "Indicates an order that has been returned.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "pinterestorder.status_returned" + ], + "title": "PinterestOrder.STATUS_RETURNED" + }, + { + "description": "Indicates an order that has shipped.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED", + "sections": [ + { + "body": "Indicates an order that has shipped.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "pinterestorder.status_shipped" + ], + "title": "PinterestOrder.STATUS_SHIPPED" + }, + { + "description": "Indicates an order that has shipped.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED", + "sections": [ + { + "body": "Indicates an order that has shipped.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "pinterestorder.status_shipped" + ], + "title": "PinterestOrder.STATUS_SHIPPED" + }, + { + "description": "Returns the item ID for this Pinterest order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getItemId", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getItemId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the item ID for this Pinterest order.", + "heading": "Description" + } + ], + "signature": "getItemId(): string", + "source": "script-api", + "tags": [ + "getitemid", + "pinterestorder.getitemid" + ], + "title": "PinterestOrder.getItemId" + }, + { + "description": "Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getOrderNo", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.", + "heading": "Description" + } + ], + "signature": "getOrderNo(): string", + "source": "script-api", + "tags": [ + "getorderno", + "pinterestorder.getorderno" + ], + "title": "PinterestOrder.getOrderNo" + }, + { + "description": "Returns the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID, dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID, or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getPaymentStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getPaymentStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,\nor dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "heading": "Description" + } + ], + "signature": "getPaymentStatus(): string", + "source": "script-api", + "tags": [ + "getpaymentstatus", + "pinterestorder.getpaymentstatus" + ], + "title": "PinterestOrder.getPaymentStatus" + }, + { + "description": "Returns the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.STATUS_NEW, dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS, dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED, dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER, dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED, dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED, or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#getStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.getStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.STATUS_NEW,\ndw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,\ndw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,\ndw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,\ndw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,\ndw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,\nor dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "heading": "Description" + } + ], + "signature": "getStatus(): string", + "source": "script-api", + "tags": [ + "getstatus", + "pinterestorder.getstatus" + ], + "title": "PinterestOrder.getStatus" + }, + { + "description": "Returns the item ID for this Pinterest order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#itemId", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.itemId", + "sections": [ + { + "body": "Returns the item ID for this Pinterest order.", + "heading": "Description" + } + ], + "signature": "itemId: string", + "source": "script-api", + "tags": [ + "itemid", + "pinterestorder.itemid" + ], + "title": "PinterestOrder.itemId" + }, + { + "description": "Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#orderNo", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.orderNo", + "sections": [ + { + "body": "Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.", + "heading": "Description" + } + ], + "signature": "readonly orderNo: string", + "source": "script-api", + "tags": [ + "orderno", + "pinterestorder.orderno" + ], + "title": "PinterestOrder.orderNo" + }, + { + "description": "Returns the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID, dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID, or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#paymentStatus", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.paymentStatus", + "sections": [ + { + "body": "Returns the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,\nor dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "heading": "Description" + } + ], + "signature": "paymentStatus: string", + "source": "script-api", + "tags": [ + "paymentstatus", + "pinterestorder.paymentstatus" + ], + "title": "PinterestOrder.paymentStatus" + }, + { + "description": "Sets the item ID for this Pinterest order.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setItemId", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "itemId", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setItemId", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the item ID for this Pinterest order.", + "heading": "Description" + } + ], + "signature": "setItemId(itemId: string): void", + "source": "script-api", + "tags": [ + "setitemid", + "pinterestorder.setitemid" + ], + "title": "PinterestOrder.setItemId" + }, + { + "description": "Sets the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID, dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID, or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setPaymentStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setPaymentStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,\ndw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,\nor dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.", + "heading": "Description" + } + ], + "signature": "setPaymentStatus(status: string): void", + "source": "script-api", + "tags": [ + "setpaymentstatus", + "pinterestorder.setpaymentstatus" + ], + "title": "PinterestOrder.setPaymentStatus" + }, + { + "description": "Sets the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.STATUS_NEW, dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS, dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED, dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER, dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED, dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED, or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#setStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.STATUS_NEW,\ndw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,\ndw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,\ndw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,\ndw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,\ndw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,\nor dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "heading": "Description" + } + ], + "signature": "setStatus(status: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "pinterestorder.setstatus" + ], + "title": "PinterestOrder.setStatus" + }, + { + "description": "Returns the status of this Pinterest order. Possible values are dw.extensions.pinterest.PinterestOrder.STATUS_NEW, dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS, dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED, dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER, dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED, dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED, or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "id": "script-api:dw/extensions/pinterest/PinterestOrder#status", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrder", + "qualifiedName": "dw.extensions.pinterest.PinterestOrder.status", + "sections": [ + { + "body": "Returns the status of this Pinterest order. Possible values are\ndw.extensions.pinterest.PinterestOrder.STATUS_NEW,\ndw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,\ndw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,\ndw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,\ndw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,\ndw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,\nor dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.", + "heading": "Description" + } + ], + "signature": "status: string", + "source": "script-api", + "tags": [ + "status", + "pinterestorder.status" + ], + "title": "PinterestOrder.status" + }, + { + "description": "PinterestOrderHooks interface containing extension points for customizing Pinterest order status.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.extensions.pinterest.order.getStatus\", \"script\": \"./hooks.ds\"}\n]" + ], + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "kind": "interface", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks", + "sections": [ + { + "body": "PinterestOrderHooks interface containing extension points for customizing Pinterest order status.\n\nThese hooks are not executed in a transaction.\n\nThe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pinterestorderhooks", + "dw.extensions.pinterest.pinterestorderhooks", + "dw/extensions/pinterest" + ], + "title": "PinterestOrderHooks" + }, + { + "description": "The extension point name extensionPointGetStatus.", + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks#extensionPointGetStatus", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks.extensionPointGetStatus", + "sections": [ + { + "body": "The extension point name extensionPointGetStatus.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointGetStatus: \"dw.extensions.pinterest.order.getStatus\"", + "source": "script-api", + "tags": [ + "extensionpointgetstatus", + "pinterestorderhooks.extensionpointgetstatus" + ], + "title": "PinterestOrderHooks.extensionPointGetStatus" + }, + { + "description": "Called to retrieve status for the given order. Return a `null` status for unknown orders.", + "id": "script-api:dw/extensions/pinterest/PinterestOrderHooks#getStatus", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "order", + "type": "PinterestOrder" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestOrderHooks", + "qualifiedName": "dw.extensions.pinterest.PinterestOrderHooks.getStatus", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called to retrieve status for the given order. Return a `null` status for unknown orders.", + "heading": "Description" + } + ], + "signature": "getStatus(order: PinterestOrder): Status", + "source": "script-api", + "tags": [ + "getstatus", + "pinterestorderhooks.getstatus" + ], + "title": "PinterestOrderHooks.getStatus" + }, + { + "description": "Represents a row in the Pinterest catalog feed export.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct", + "kind": "class", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct", + "sections": [ + { + "body": "Represents a row in the Pinterest catalog feed export.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pinterestproduct", + "dw.extensions.pinterest.pinterestproduct", + "dw/extensions/pinterest" + ], + "title": "PinterestProduct" + }, + { + "description": "Indicates that the product is in stock.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is in stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_in_stock", + "pinterestproduct.availability_in_stock" + ], + "title": "PinterestProduct.AVAILABILITY_IN_STOCK" + }, + { + "description": "Indicates that the product is in stock.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_IN_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK", + "sections": [ + { + "body": "Indicates that the product is in stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_IN_STOCK: string", + "source": "script-api", + "tags": [ + "availability_in_stock", + "pinterestproduct.availability_in_stock" + ], + "title": "PinterestProduct.AVAILABILITY_IN_STOCK" + }, + { + "description": "Indicates that the product is not in stock.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK", + "sections": [ + { + "body": "Indicates that the product is not in stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_OUT_OF_STOCK: string", + "source": "script-api", + "tags": [ + "availability_out_of_stock", + "pinterestproduct.availability_out_of_stock" + ], + "title": "PinterestProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "description": "Indicates that the product is not in stock.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_OUT_OF_STOCK", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK", + "sections": [ + { + "body": "Indicates that the product is not in stock.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_OUT_OF_STOCK: string", + "source": "script-api", + "tags": [ + "availability_out_of_stock", + "pinterestproduct.availability_out_of_stock" + ], + "title": "PinterestProduct.AVAILABILITY_OUT_OF_STOCK" + }, + { + "description": "Indicates that the product is availabile in preorder.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_PREORDER", + "sections": [ + { + "body": "Indicates that the product is availabile in preorder.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_preorder", + "pinterestproduct.availability_preorder" + ], + "title": "PinterestProduct.AVAILABILITY_PREORDER" + }, + { + "description": "Indicates that the product is availabile in preorder.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#AVAILABILITY_PREORDER", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.AVAILABILITY_PREORDER", + "sections": [ + { + "body": "Indicates that the product is availabile in preorder.", + "heading": "Description" + } + ], + "signature": "static readonly AVAILABILITY_PREORDER: string", + "source": "script-api", + "tags": [ + "availability_preorder", + "pinterestproduct.availability_preorder" + ], + "title": "PinterestProduct.AVAILABILITY_PREORDER" + }, + { + "description": "Indicates that the product has never been used.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_NEW", + "sections": [ + { + "body": "Indicates that the product has never been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_NEW: string", + "source": "script-api", + "tags": [ + "condition_new", + "pinterestproduct.condition_new" + ], + "title": "PinterestProduct.CONDITION_NEW" + }, + { + "description": "Indicates that the product has never been used.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_NEW", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_NEW", + "sections": [ + { + "body": "Indicates that the product has never been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_NEW: string", + "source": "script-api", + "tags": [ + "condition_new", + "pinterestproduct.condition_new" + ], + "title": "PinterestProduct.CONDITION_NEW" + }, + { + "description": "Indicates that the product has been used but refurbished.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED", + "sections": [ + { + "body": "Indicates that the product has been used but refurbished.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_REFURBISHED: string", + "source": "script-api", + "tags": [ + "condition_refurbished", + "pinterestproduct.condition_refurbished" + ], + "title": "PinterestProduct.CONDITION_REFURBISHED" + }, + { + "description": "Indicates that the product has been used but refurbished.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_REFURBISHED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED", + "sections": [ + { + "body": "Indicates that the product has been used but refurbished.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_REFURBISHED: string", + "source": "script-api", + "tags": [ + "condition_refurbished", + "pinterestproduct.condition_refurbished" + ], + "title": "PinterestProduct.CONDITION_REFURBISHED" + }, + { + "description": "Indicates that the product has been used.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_USED", + "sections": [ + { + "body": "Indicates that the product has been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_USED: string", + "source": "script-api", + "tags": [ + "condition_used", + "pinterestproduct.condition_used" + ], + "title": "PinterestProduct.CONDITION_USED" + }, + { + "description": "Indicates that the product has been used.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#CONDITION_USED", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.CONDITION_USED", + "sections": [ + { + "body": "Indicates that the product has been used.", + "heading": "Description" + } + ], + "signature": "static readonly CONDITION_USED: string", + "source": "script-api", + "tags": [ + "condition_used", + "pinterestproduct.condition_used" + ], + "title": "PinterestProduct.CONDITION_USED" + }, + { + "description": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#ID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.ID", + "sections": [ + { + "body": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "pinterestproduct.id" + ], + "title": "PinterestProduct.ID" + }, + { + "description": "Returns the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#availability", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.availability", + "sections": [ + { + "body": "Returns the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "availability: string", + "source": "script-api", + "tags": [ + "availability", + "pinterestproduct.availability" + ], + "title": "PinterestProduct.availability" + }, + { + "description": "Returns the Pinterest brand of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#brand", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.brand", + "sections": [ + { + "body": "Returns the Pinterest brand of the product.", + "heading": "Description" + } + ], + "signature": "brand: string", + "source": "script-api", + "tags": [ + "brand", + "pinterestproduct.brand" + ], + "title": "PinterestProduct.brand" + }, + { + "description": "Returns the Pinterest color value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#color", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.color", + "sections": [ + { + "body": "Returns the Pinterest color value label of the product.", + "heading": "Description" + } + ], + "signature": "color: string", + "source": "script-api", + "tags": [ + "color", + "pinterestproduct.color" + ], + "title": "PinterestProduct.color" + }, + { + "description": "Returns the Pinterest color hex value of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#colorHex", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.colorHex", + "sections": [ + { + "body": "Returns the Pinterest color hex value of the product.", + "heading": "Description" + } + ], + "signature": "colorHex: string", + "source": "script-api", + "tags": [ + "colorhex", + "pinterestproduct.colorhex" + ], + "title": "PinterestProduct.colorHex" + }, + { + "description": "Returns the URL of the image to show in Pinterest for the product color (swatch).", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#colorImage", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.colorImage", + "sections": [ + { + "body": "Returns the URL of the image to show in Pinterest for the product color (swatch).", + "heading": "Description" + } + ], + "signature": "colorImage: URL", + "source": "script-api", + "tags": [ + "colorimage", + "pinterestproduct.colorimage" + ], + "title": "PinterestProduct.colorImage" + }, + { + "description": "Returns the condition of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.CONDITION_NEW, dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or dw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#condition", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.condition", + "sections": [ + { + "body": "Returns the condition of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.CONDITION_NEW,\ndw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or\ndw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "heading": "Description" + } + ], + "signature": "condition: string", + "source": "script-api", + "tags": [ + "condition", + "pinterestproduct.condition" + ], + "title": "PinterestProduct.condition" + }, + { + "description": "Returns the Pinterest description of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#description", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.description", + "sections": [ + { + "body": "Returns the Pinterest description of the product.", + "heading": "Description" + } + ], + "signature": "description: string", + "source": "script-api", + "tags": [ + "description", + "pinterestproduct.description" + ], + "title": "PinterestProduct.description" + }, + { + "description": "Returns the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getAvailability", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "getAvailability(): string", + "source": "script-api", + "tags": [ + "getavailability", + "pinterestproduct.getavailability" + ], + "title": "PinterestProduct.getAvailability" + }, + { + "description": "Returns the Pinterest brand of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getBrand", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getBrand", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest brand of the product.", + "heading": "Description" + } + ], + "signature": "getBrand(): string", + "source": "script-api", + "tags": [ + "getbrand", + "pinterestproduct.getbrand" + ], + "title": "PinterestProduct.getBrand" + }, + { + "description": "Returns the Pinterest color value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColor", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColor", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest color value label of the product.", + "heading": "Description" + } + ], + "signature": "getColor(): string", + "source": "script-api", + "tags": [ + "getcolor", + "pinterestproduct.getcolor" + ], + "title": "PinterestProduct.getColor" + }, + { + "description": "Returns the Pinterest color hex value of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColorHex", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColorHex", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest color hex value of the product.", + "heading": "Description" + } + ], + "signature": "getColorHex(): string", + "source": "script-api", + "tags": [ + "getcolorhex", + "pinterestproduct.getcolorhex" + ], + "title": "PinterestProduct.getColorHex" + }, + { + "description": "Returns the URL of the image to show in Pinterest for the product color (swatch).", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getColorImage", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getColorImage", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns the URL of the image to show in Pinterest for the product color (swatch).", + "heading": "Description" + } + ], + "signature": "getColorImage(): URL", + "source": "script-api", + "tags": [ + "getcolorimage", + "pinterestproduct.getcolorimage" + ], + "title": "PinterestProduct.getColorImage" + }, + { + "description": "Returns the condition of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.CONDITION_NEW, dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or dw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getCondition", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getCondition", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the condition of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.CONDITION_NEW,\ndw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or\ndw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "heading": "Description" + } + ], + "signature": "getCondition(): string", + "source": "script-api", + "tags": [ + "getcondition", + "pinterestproduct.getcondition" + ], + "title": "PinterestProduct.getCondition" + }, + { + "description": "Returns the Pinterest description of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getDescription", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest description of the product.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "pinterestproduct.getdescription" + ], + "title": "PinterestProduct.getDescription" + }, + { + "description": "Returns the category of this product in the Google category taxonomy.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getGoogleProductCategory", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the category of this product in the Google category taxonomy.", + "heading": "Description" + } + ], + "signature": "getGoogleProductCategory(): string", + "source": "script-api", + "tags": [ + "getgoogleproductcategory", + "pinterestproduct.getgoogleproductcategory" + ], + "title": "PinterestProduct.getGoogleProductCategory" + }, + { + "description": "Returns the Pinterest GTIN of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getGtin", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getGtin", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest GTIN of the product.", + "heading": "Description" + } + ], + "signature": "getGtin(): string", + "source": "script-api", + "tags": [ + "getgtin", + "pinterestproduct.getgtin" + ], + "title": "PinterestProduct.getGtin" + }, + { + "description": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "pinterestproduct.getid" + ], + "title": "PinterestProduct.getID" + }, + { + "description": "Returns a list containing the URLs of the image to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getImageLinks", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getImageLinks", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list containing the URLs of the image to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "getImageLinks(): List", + "source": "script-api", + "tags": [ + "getimagelinks", + "pinterestproduct.getimagelinks" + ], + "title": "PinterestProduct.getImageLinks" + }, + { + "description": "Returns the ID of the Pinterest item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getItemGroupID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the Pinterest item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "getItemGroupID(): string", + "source": "script-api", + "tags": [ + "getitemgroupid", + "pinterestproduct.getitemgroupid" + ], + "title": "PinterestProduct.getItemGroupID" + }, + { + "description": "Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getItemGroupLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getItemGroupLink", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the\nDemandware storefront.", + "heading": "Description" + } + ], + "signature": "getItemGroupLink(): URL", + "source": "script-api", + "tags": [ + "getitemgrouplink", + "pinterestproduct.getitemgrouplink" + ], + "title": "PinterestProduct.getItemGroupLink" + }, + { + "description": "Returns the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getLink", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "getLink(): URL", + "source": "script-api", + "tags": [ + "getlink", + "pinterestproduct.getlink" + ], + "title": "PinterestProduct.getLink" + }, + { + "description": "Returns the maximum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getMaxPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getMaxPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the maximum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "getMaxPrice(): Money", + "source": "script-api", + "tags": [ + "getmaxprice", + "pinterestproduct.getmaxprice" + ], + "title": "PinterestProduct.getMaxPrice" + }, + { + "description": "Returns the minimum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getMinPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getMinPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the minimum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "getMinPrice(): Money", + "source": "script-api", + "tags": [ + "getminprice", + "pinterestproduct.getminprice" + ], + "title": "PinterestProduct.getMinPrice" + }, + { + "description": "Returns the price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "getPrice(): Money", + "source": "script-api", + "tags": [ + "getprice", + "pinterestproduct.getprice" + ], + "title": "PinterestProduct.getPrice" + }, + { + "description": "Returns the Pinterest category path of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getProductCategory", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest category path of the product.", + "heading": "Description" + } + ], + "signature": "getProductCategory(): string", + "source": "script-api", + "tags": [ + "getproductcategory", + "pinterestproduct.getproductcategory" + ], + "title": "PinterestProduct.getProductCategory" + }, + { + "description": "Returns the Pinterest return policy of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getReturnPolicy", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getReturnPolicy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest return policy of the product.", + "heading": "Description" + } + ], + "signature": "getReturnPolicy(): string", + "source": "script-api", + "tags": [ + "getreturnpolicy", + "pinterestproduct.getreturnpolicy" + ], + "title": "PinterestProduct.getReturnPolicy" + }, + { + "description": "Returns the Pinterest size value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getSize", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getSize", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest size value label of the product.", + "heading": "Description" + } + ], + "signature": "getSize(): string", + "source": "script-api", + "tags": [ + "getsize", + "pinterestproduct.getsize" + ], + "title": "PinterestProduct.getSize" + }, + { + "description": "Returns the Pinterest title of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#getTitle", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Pinterest title of the product.", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "pinterestproduct.gettitle" + ], + "title": "PinterestProduct.getTitle" + }, + { + "description": "Returns the category of this product in the Google category taxonomy.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#googleProductCategory", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.googleProductCategory", + "sections": [ + { + "body": "Returns the category of this product in the Google category taxonomy.", + "heading": "Description" + } + ], + "signature": "googleProductCategory: string", + "source": "script-api", + "tags": [ + "googleproductcategory", + "pinterestproduct.googleproductcategory" + ], + "title": "PinterestProduct.googleProductCategory" + }, + { + "description": "Returns the Pinterest GTIN of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#gtin", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.gtin", + "sections": [ + { + "body": "Returns the Pinterest GTIN of the product.", + "heading": "Description" + } + ], + "signature": "gtin: string", + "source": "script-api", + "tags": [ + "gtin", + "pinterestproduct.gtin" + ], + "title": "PinterestProduct.gtin" + }, + { + "description": "Returns a list containing the URLs of the image to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#imageLinks", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.imageLinks", + "sections": [ + { + "body": "Returns a list containing the URLs of the image to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "imageLinks: List", + "source": "script-api", + "tags": [ + "imagelinks", + "pinterestproduct.imagelinks" + ], + "title": "PinterestProduct.imageLinks" + }, + { + "description": "Returns the ID of the Pinterest item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#itemGroupID", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.itemGroupID", + "sections": [ + { + "body": "Returns the ID of the Pinterest item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "itemGroupID: string", + "source": "script-api", + "tags": [ + "itemgroupid", + "pinterestproduct.itemgroupid" + ], + "title": "PinterestProduct.itemGroupID" + }, + { + "description": "Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#itemGroupLink", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.itemGroupLink", + "sections": [ + { + "body": "Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the\nDemandware storefront.", + "heading": "Description" + } + ], + "signature": "itemGroupLink: URL", + "source": "script-api", + "tags": [ + "itemgrouplink", + "pinterestproduct.itemgrouplink" + ], + "title": "PinterestProduct.itemGroupLink" + }, + { + "description": "Returns the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#link", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.link", + "sections": [ + { + "body": "Returns the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "link: URL", + "source": "script-api", + "tags": [ + "link", + "pinterestproduct.link" + ], + "title": "PinterestProduct.link" + }, + { + "description": "Returns the maximum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#maxPrice", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.maxPrice", + "sections": [ + { + "body": "Returns the maximum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "maxPrice: Money", + "source": "script-api", + "tags": [ + "maxprice", + "pinterestproduct.maxprice" + ], + "title": "PinterestProduct.maxPrice" + }, + { + "description": "Returns the minimum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#minPrice", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.minPrice", + "sections": [ + { + "body": "Returns the minimum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "minPrice: Money", + "source": "script-api", + "tags": [ + "minprice", + "pinterestproduct.minprice" + ], + "title": "PinterestProduct.minPrice" + }, + { + "description": "Returns the price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#price", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.price", + "sections": [ + { + "body": "Returns the price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "price: Money", + "source": "script-api", + "tags": [ + "price", + "pinterestproduct.price" + ], + "title": "PinterestProduct.price" + }, + { + "description": "Returns the Pinterest category path of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#productCategory", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.productCategory", + "sections": [ + { + "body": "Returns the Pinterest category path of the product.", + "heading": "Description" + } + ], + "signature": "productCategory: string", + "source": "script-api", + "tags": [ + "productcategory", + "pinterestproduct.productcategory" + ], + "title": "PinterestProduct.productCategory" + }, + { + "description": "Returns the Pinterest return policy of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#returnPolicy", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.returnPolicy", + "sections": [ + { + "body": "Returns the Pinterest return policy of the product.", + "heading": "Description" + } + ], + "signature": "returnPolicy: string", + "source": "script-api", + "tags": [ + "returnpolicy", + "pinterestproduct.returnpolicy" + ], + "title": "PinterestProduct.returnPolicy" + }, + { + "description": "Sets the availability of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setAvailability", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "availability", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setAvailability", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the availability of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or\ndw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.", + "heading": "Description" + } + ], + "signature": "setAvailability(availability: string): void", + "source": "script-api", + "tags": [ + "setavailability", + "pinterestproduct.setavailability" + ], + "title": "PinterestProduct.setAvailability" + }, + { + "description": "Sets the Pinterest brand of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setBrand", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "brand", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setBrand", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest brand of the product.", + "heading": "Description" + } + ], + "signature": "setBrand(brand: string): void", + "source": "script-api", + "tags": [ + "setbrand", + "pinterestproduct.setbrand" + ], + "title": "PinterestProduct.setBrand" + }, + { + "description": "Sets the Pinterest color value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColor", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "color", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColor", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest color value label of the product.", + "heading": "Description" + } + ], + "signature": "setColor(color: string): void", + "source": "script-api", + "tags": [ + "setcolor", + "pinterestproduct.setcolor" + ], + "title": "PinterestProduct.setColor" + }, + { + "description": "Sets the Pinterest color hex value of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColorHex", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "colorHex", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColorHex", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest color hex value of the product.", + "heading": "Description" + } + ], + "signature": "setColorHex(colorHex: string): void", + "source": "script-api", + "tags": [ + "setcolorhex", + "pinterestproduct.setcolorhex" + ], + "title": "PinterestProduct.setColorHex" + }, + { + "description": "Sets the URL of the image to show in Pinterest for the product color (swatch).", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setColorImage", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "colorImage", + "type": "URL" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setColorImage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the URL of the image to show in Pinterest for the product color (swatch).", + "heading": "Description" + } + ], + "signature": "setColorImage(colorImage: URL): void", + "source": "script-api", + "tags": [ + "setcolorimage", + "pinterestproduct.setcolorimage" + ], + "title": "PinterestProduct.setColorImage" + }, + { + "description": "Sets the condition of the Pinterest product. Possible values are dw.extensions.pinterest.PinterestProduct.CONDITION_NEW, dw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or dw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setCondition", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "condition", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setCondition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the condition of the Pinterest product. Possible values are\ndw.extensions.pinterest.PinterestProduct.CONDITION_NEW,\ndw.extensions.pinterest.PinterestProduct.CONDITION_REFURBISHED, or\ndw.extensions.pinterest.PinterestProduct.CONDITION_USED.", + "heading": "Description" + } + ], + "signature": "setCondition(condition: string): void", + "source": "script-api", + "tags": [ + "setcondition", + "pinterestproduct.setcondition" + ], + "title": "PinterestProduct.setCondition" + }, + { + "description": "Sets the Pinterest description of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setDescription", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "description", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest description of the product.", + "heading": "Description" + } + ], + "signature": "setDescription(description: string): void", + "source": "script-api", + "tags": [ + "setdescription", + "pinterestproduct.setdescription" + ], + "title": "PinterestProduct.setDescription" + }, + { + "description": "Sets the category of this product in the Google category taxonomy.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setGoogleProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "googleProductCategory", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setGoogleProductCategory", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the category of this product in the Google category taxonomy.", + "heading": "Description" + } + ], + "signature": "setGoogleProductCategory(googleProductCategory: string): void", + "source": "script-api", + "tags": [ + "setgoogleproductcategory", + "pinterestproduct.setgoogleproductcategory" + ], + "title": "PinterestProduct.setGoogleProductCategory" + }, + { + "description": "Sets the Pinterest GTIN of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setGtin", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "gtin", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setGtin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest GTIN of the product.", + "heading": "Description" + } + ], + "signature": "setGtin(gtin: string): void", + "source": "script-api", + "tags": [ + "setgtin", + "pinterestproduct.setgtin" + ], + "title": "PinterestProduct.setGtin" + }, + { + "description": "Sets the list of URLs of images to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setImageLinks", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "imageLinks", + "type": "List" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setImageLinks", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the list of URLs of images to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "setImageLinks(imageLinks: List): void", + "source": "script-api", + "tags": [ + "setimagelinks", + "pinterestproduct.setimagelinks" + ], + "title": "PinterestProduct.setImageLinks" + }, + { + "description": "Sets the ID of the Pinterest item group for the product, that is, its master product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setItemGroupID", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "itemGroupID", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setItemGroupID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the ID of the Pinterest item group for the product, that is, its master product.", + "heading": "Description" + } + ], + "signature": "setItemGroupID(itemGroupID: string): void", + "source": "script-api", + "tags": [ + "setitemgroupid", + "pinterestproduct.setitemgroupid" + ], + "title": "PinterestProduct.setItemGroupID" + }, + { + "description": "Sets the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setItemGroupLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "itemGroupLink", + "type": "URL" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setItemGroupLink", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the URL of the Pinterest item group for the product, that is, the link to its master product in the\nDemandware storefront.", + "heading": "Description" + } + ], + "signature": "setItemGroupLink(itemGroupLink: URL): void", + "source": "script-api", + "tags": [ + "setitemgrouplink", + "pinterestproduct.setitemgrouplink" + ], + "title": "PinterestProduct.setItemGroupLink" + }, + { + "description": "Sets the URL of the Demandware storefront link to the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setLink", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "link", + "type": "URL" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setLink", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the URL of the Demandware storefront link to the product.", + "heading": "Description" + } + ], + "signature": "setLink(link: URL): void", + "source": "script-api", + "tags": [ + "setlink", + "pinterestproduct.setlink" + ], + "title": "PinterestProduct.setLink" + }, + { + "description": "Sets the maximum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setMaxPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "maxPrice", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setMaxPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the maximum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "setMaxPrice(maxPrice: Money): void", + "source": "script-api", + "tags": [ + "setmaxprice", + "pinterestproduct.setmaxprice" + ], + "title": "PinterestProduct.setMaxPrice" + }, + { + "description": "Sets the minimum price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setMinPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "minPrice", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setMinPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the minimum price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "setMinPrice(minPrice: Money): void", + "source": "script-api", + "tags": [ + "setminprice", + "pinterestproduct.setminprice" + ], + "title": "PinterestProduct.setMinPrice" + }, + { + "description": "Sets the price to show in Pinterest for the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setPrice", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "price", + "type": "Money" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the price to show in Pinterest for the product.", + "heading": "Description" + } + ], + "signature": "setPrice(price: Money): void", + "source": "script-api", + "tags": [ + "setprice", + "pinterestproduct.setprice" + ], + "title": "PinterestProduct.setPrice" + }, + { + "description": "Sets the Pinterest category path of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setProductCategory", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "productCategory", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setProductCategory", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest category path of the product.", + "heading": "Description" + } + ], + "signature": "setProductCategory(productCategory: string): void", + "source": "script-api", + "tags": [ + "setproductcategory", + "pinterestproduct.setproductcategory" + ], + "title": "PinterestProduct.setProductCategory" + }, + { + "description": "Sets the Pinterest return policy of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setReturnPolicy", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "returnPolicy", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setReturnPolicy", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest return policy of the product.", + "heading": "Description" + } + ], + "signature": "setReturnPolicy(returnPolicy: string): void", + "source": "script-api", + "tags": [ + "setreturnpolicy", + "pinterestproduct.setreturnpolicy" + ], + "title": "PinterestProduct.setReturnPolicy" + }, + { + "description": "Sets the Pinterest size value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setSize", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "size", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setSize", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest size value label of the product.", + "heading": "Description" + } + ], + "signature": "setSize(size: string): void", + "source": "script-api", + "tags": [ + "setsize", + "pinterestproduct.setsize" + ], + "title": "PinterestProduct.setSize" + }, + { + "description": "Sets the Pinterest title of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#setTitle", + "kind": "method", + "packagePath": "dw/extensions/pinterest", + "params": [ + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.setTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Pinterest title of the product.", + "heading": "Description" + } + ], + "signature": "setTitle(title: string): void", + "source": "script-api", + "tags": [ + "settitle", + "pinterestproduct.settitle" + ], + "title": "PinterestProduct.setTitle" + }, + { + "description": "Returns the Pinterest size value label of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#size", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.size", + "sections": [ + { + "body": "Returns the Pinterest size value label of the product.", + "heading": "Description" + } + ], + "signature": "size: string", + "source": "script-api", + "tags": [ + "size", + "pinterestproduct.size" + ], + "title": "PinterestProduct.size" + }, + { + "description": "Returns the Pinterest title of the product.", + "id": "script-api:dw/extensions/pinterest/PinterestProduct#title", + "kind": "property", + "packagePath": "dw/extensions/pinterest", + "parentId": "script-api:dw/extensions/pinterest/PinterestProduct", + "qualifiedName": "dw.extensions.pinterest.PinterestProduct.title", + "sections": [ + { + "body": "Returns the Pinterest title of the product.", + "heading": "Description" + } + ], + "signature": "title: string", + "source": "script-api", + "tags": [ + "title", + "pinterestproduct.title" + ], + "title": "PinterestProduct.title" + }, + { + "description": "16 declarations", + "id": "script-api:dw/io", + "kind": "package", + "packagePath": "dw/io", + "qualifiedName": "dw.io", + "source": "script-api", + "tags": [ + "dw/io", + "dw.io" + ], + "title": "dw.io" + }, + { + "description": "The class supports reading a CSV file. The reader supports handling CSV entries where the separator is contained in quotes and also CSV entries where a quoted entry contains newline characters.", + "id": "script-api:dw/io/CSVStreamReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.CSVStreamReader", + "sections": [ + { + "body": "The class supports reading a CSV file. The reader supports handling CSV\nentries where the separator is contained in quotes and also CSV entries where\na quoted entry contains newline characters.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "csvstreamreader", + "dw.io.csvstreamreader", + "dw/io" + ], + "title": "CSVStreamReader" + }, + { + "description": "Closes the underlying reader.", + "id": "script-api:dw/io/CSVStreamReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the underlying reader.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "csvstreamreader.close" + ], + "title": "CSVStreamReader.close" + }, + { + "description": "Returns a list of lines representing the entire CSV file. Each line is a array of strings.", + "id": "script-api:dw/io/CSVStreamReader#readAll", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.readAll", + "returns": { + "type": "List>" + }, + "sections": [ + { + "body": "Returns a list of lines representing the entire CSV file. Each line is a\narray of strings.\n\nUsing this method on large feeds is inherently unsafe and may lead to an\nout-of-memory condition. Instead use method readNext and\nprocess entries line by line.", + "heading": "Description" + } + ], + "signature": "readAll(): List>", + "source": "script-api", + "tags": [ + "readall", + "csvstreamreader.readall" + ], + "title": "CSVStreamReader.readAll" + }, + { + "description": "Returns the next line from the input stream. The line is returned as an array of strings. The method returns null if the end of the stream is reached.", + "id": "script-api:dw/io/CSVStreamReader#readNext", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamReader", + "qualifiedName": "dw.io.CSVStreamReader.readNext", + "returns": { + "type": "string[] | null" + }, + "sections": [ + { + "body": "Returns the next line from the input stream. The line is returned as an\narray of strings. The method returns null if the end of the stream is\nreached.", + "heading": "Description" + } + ], + "signature": "readNext(): string[] | null", + "source": "script-api", + "tags": [ + "readnext", + "csvstreamreader.readnext" + ], + "title": "CSVStreamReader.readNext" + }, + { + "description": "The class writes a CSV file.", + "id": "script-api:dw/io/CSVStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.CSVStreamWriter", + "sections": [ + { + "body": "The class writes a CSV file.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "csvstreamwriter", + "dw.io.csvstreamwriter", + "dw/io" + ], + "title": "CSVStreamWriter" + }, + { + "description": "Closes the underlying writer.", + "id": "script-api:dw/io/CSVStreamWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/CSVStreamWriter", + "qualifiedName": "dw.io.CSVStreamWriter.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the underlying writer.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "csvstreamwriter.close" + ], + "title": "CSVStreamWriter.close" + }, + { + "description": "Write a single line to the CSV file.", + "id": "script-api:dw/io/CSVStreamWriter#writeNext", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "line", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/io/CSVStreamWriter", + "qualifiedName": "dw.io.CSVStreamWriter.writeNext", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write a single line to the CSV file.", + "heading": "Description" + } + ], + "signature": "writeNext(line?: string[]): void", + "source": "script-api", + "tags": [ + "writenext", + "csvstreamwriter.writenext" + ], + "title": "CSVStreamWriter.writeNext" + }, + { + "description": "Represents a file resource accessible from scripting. As with `java.io.File`, a `File` is essentially an \"abstract pathname\" which may or may not denote an actual file on the file system. Methods `createNewFile`, `mkdir`, `mkdirs`, and `remove` are provided to actually manipulate physical files.", + "id": "script-api:dw/io/File", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.File", + "sections": [ + { + "body": "Represents a file resource accessible from scripting. As with\n`java.io.File`, a `File` is essentially an\n\"abstract pathname\" which may or may not denote an actual file on the file\nsystem. Methods `createNewFile`,\n`mkdir`, `mkdirs`, and `remove` are provided\nto actually manipulate physical files.\n\nFile access is limited to certain virtual directories. These directories are\na subset of those accessible through WebDAV. As a result of this\nrestriction, pathnames must be one of the following forms:\n\n- `/TEMP(/...)`\n- `/IMPEX(/...)`\n- `/REALMDATA(/...)`\n- `/CATALOGS/[Catalog Name](/...)`\n- `/LIBRARIES/[Library Name](/...)`\n\nNote, that these paths are analogous to the WebDAV URIs used to access the\nsame directories.\n\nThe files are stored in a shared file system where multiple processes could\naccess the same file. The programmer has to make sure no more than one process\nwrites to a file at a given time.\n\nThis class provides other useful methods for listing the\nchildren of a directory and for working with zip files.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information.\n\nFor performance reasons no more than 100,000 files (regular files and directories) should be stored in a\ndirectory.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "file", + "dw.io.file", + "dw/io" + ], + "title": "File" + }, + { + "description": "Catalogs root directory.", + "id": "script-api:dw/io/File#CATALOGS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CATALOGS", + "sections": [ + { + "body": "Catalogs root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CATALOGS: string", + "source": "script-api", + "tags": [ + "catalogs", + "file.catalogs" + ], + "title": "File.CATALOGS" + }, + { + "description": "Catalogs root directory.", + "id": "script-api:dw/io/File#CATALOGS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CATALOGS", + "sections": [ + { + "body": "Catalogs root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CATALOGS: string", + "source": "script-api", + "tags": [ + "catalogs", + "file.catalogs" + ], + "title": "File.CATALOGS" + }, + { + "description": "Customer Payment Instrument root directory.", + "id": "script-api:dw/io/File#CUSTOMERPI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMERPI", + "sections": [ + { + "body": "Customer Payment Instrument root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMERPI: string", + "source": "script-api", + "tags": [ + "customerpi", + "file.customerpi" + ], + "title": "File.CUSTOMERPI" + }, + { + "description": "Customer Payment Instrument root directory.", + "id": "script-api:dw/io/File#CUSTOMERPI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMERPI", + "sections": [ + { + "body": "Customer Payment Instrument root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMERPI: string", + "source": "script-api", + "tags": [ + "customerpi", + "file.customerpi" + ], + "title": "File.CUSTOMERPI" + }, + { + "description": "Customer snapshots root directory.", + "id": "script-api:dw/io/File#CUSTOMER_SNAPSHOTS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMER_SNAPSHOTS", + "sections": [ + { + "body": "Customer snapshots root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_SNAPSHOTS: string", + "source": "script-api", + "tags": [ + "customer_snapshots", + "file.customer_snapshots" + ], + "title": "File.CUSTOMER_SNAPSHOTS" + }, + { + "description": "Customer snapshots root directory.", + "id": "script-api:dw/io/File#CUSTOMER_SNAPSHOTS", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.CUSTOMER_SNAPSHOTS", + "sections": [ + { + "body": "Customer snapshots root directory.", + "heading": "Description" + } + ], + "signature": "static readonly CUSTOMER_SNAPSHOTS: string", + "source": "script-api", + "tags": [ + "customer_snapshots", + "file.customer_snapshots" + ], + "title": "File.CUSTOMER_SNAPSHOTS" + }, + { + "description": "Reserved for future use.", + "id": "script-api:dw/io/File#DYNAMIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.DYNAMIC", + "sections": [ + { + "body": "Reserved for future use.", + "heading": "Description" + } + ], + "signature": "static readonly DYNAMIC: string", + "source": "script-api", + "tags": [ + "dynamic", + "file.dynamic" + ], + "title": "File.DYNAMIC" + }, + { + "description": "Reserved for future use.", + "id": "script-api:dw/io/File#DYNAMIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.DYNAMIC", + "sections": [ + { + "body": "Reserved for future use.", + "heading": "Description" + } + ], + "signature": "static readonly DYNAMIC: string", + "source": "script-api", + "tags": [ + "dynamic", + "file.dynamic" + ], + "title": "File.DYNAMIC" + }, + { + "description": "Import/export root directory.", + "id": "script-api:dw/io/File#IMPEX", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.IMPEX", + "sections": [ + { + "body": "Import/export root directory.", + "heading": "Description" + } + ], + "signature": "static readonly IMPEX: string", + "source": "script-api", + "tags": [ + "impex", + "file.impex" + ], + "title": "File.IMPEX" + }, + { + "description": "Import/export root directory.", + "id": "script-api:dw/io/File#IMPEX", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.IMPEX", + "sections": [ + { + "body": "Import/export root directory.", + "heading": "Description" + } + ], + "signature": "static readonly IMPEX: string", + "source": "script-api", + "tags": [ + "impex", + "file.impex" + ], + "title": "File.IMPEX" + }, + { + "description": "Libraries root directory.", + "id": "script-api:dw/io/File#LIBRARIES", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.LIBRARIES", + "sections": [ + { + "body": "Libraries root directory.", + "heading": "Description" + } + ], + "signature": "static readonly LIBRARIES: string", + "source": "script-api", + "tags": [ + "libraries", + "file.libraries" + ], + "title": "File.LIBRARIES" + }, + { + "description": "Libraries root directory.", + "id": "script-api:dw/io/File#LIBRARIES", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.LIBRARIES", + "sections": [ + { + "body": "Libraries root directory.", + "heading": "Description" + } + ], + "signature": "static readonly LIBRARIES: string", + "source": "script-api", + "tags": [ + "libraries", + "file.libraries" + ], + "title": "File.LIBRARIES" + }, + { + "deprecated": { + "message": "Folder to be removed." + }, + "description": "RealmData root directory.", + "id": "script-api:dw/io/File#REALMDATA", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.REALMDATA", + "sections": [ + { + "body": "RealmData root directory.", + "heading": "Description" + } + ], + "signature": "static readonly REALMDATA: string", + "source": "script-api", + "tags": [ + "realmdata", + "file.realmdata" + ], + "title": "File.REALMDATA" + }, + { + "deprecated": { + "message": "Folder to be removed." + }, + "description": "RealmData root directory.", + "id": "script-api:dw/io/File#REALMDATA", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.REALMDATA", + "sections": [ + { + "body": "RealmData root directory.", + "heading": "Description" + } + ], + "signature": "static readonly REALMDATA: string", + "source": "script-api", + "tags": [ + "realmdata", + "file.realmdata" + ], + "title": "File.REALMDATA" + }, + { + "description": "The UNIX style '/' path separator, which must be used for files paths.", + "id": "script-api:dw/io/File#SEPARATOR", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.SEPARATOR", + "sections": [ + { + "body": "The UNIX style '/' path separator, which must be used for files paths.", + "heading": "Description" + } + ], + "signature": "static readonly SEPARATOR = \"/\"", + "source": "script-api", + "tags": [ + "separator", + "file.separator" + ], + "title": "File.SEPARATOR" + }, + { + "description": "The UNIX style '/' path separator, which must be used for files paths.", + "id": "script-api:dw/io/File#SEPARATOR", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.SEPARATOR", + "sections": [ + { + "body": "The UNIX style '/' path separator, which must be used for files paths.", + "heading": "Description" + } + ], + "signature": "static readonly SEPARATOR = \"/\"", + "source": "script-api", + "tags": [ + "separator", + "file.separator" + ], + "title": "File.SEPARATOR" + }, + { + "description": "Static content root directory.", + "id": "script-api:dw/io/File#STATIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.STATIC", + "sections": [ + { + "body": "Static content root directory.", + "heading": "Description" + } + ], + "signature": "static readonly STATIC: string", + "source": "script-api", + "tags": [ + "static", + "file.static" + ], + "title": "File.STATIC" + }, + { + "description": "Static content root directory.", + "id": "script-api:dw/io/File#STATIC", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.STATIC", + "sections": [ + { + "body": "Static content root directory.", + "heading": "Description" + } + ], + "signature": "static readonly STATIC: string", + "source": "script-api", + "tags": [ + "static", + "file.static" + ], + "title": "File.STATIC" + }, + { + "description": "Temp root directory.", + "id": "script-api:dw/io/File#TEMP", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.TEMP", + "sections": [ + { + "body": "Temp root directory.", + "heading": "Description" + } + ], + "signature": "static readonly TEMP: string", + "source": "script-api", + "tags": [ + "temp", + "file.temp" + ], + "title": "File.TEMP" + }, + { + "description": "Temp root directory.", + "id": "script-api:dw/io/File#TEMP", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.TEMP", + "sections": [ + { + "body": "Temp root directory.", + "heading": "Description" + } + ], + "signature": "static readonly TEMP: string", + "source": "script-api", + "tags": [ + "temp", + "file.temp" + ], + "title": "File.TEMP" + }, + { + "description": "Copy a file. Directories cannot be copied. This method cannot be used from storefront requests.", + "id": "script-api:dw/io/File#copyTo", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.copyTo", + "returns": { + "type": "File" + }, + "sections": [ + { + "body": "Copy a file. Directories cannot be copied. This method cannot be used from storefront requests.", + "heading": "Description" + } + ], + "signature": "copyTo(file: File): File", + "source": "script-api", + "tags": [ + "copyto", + "file.copyto" + ], + "throws": [ + { + "description": "if there is an interruption during file copy.", + "type": "IOException" + }, + { + "description": "if the file to copy to already exists", + "type": "FileAlreadyExistsException" + }, + { + "description": "if invoked from a storefront request", + "type": "UnsupportedOperationException" + } + ], + "title": "File.copyTo" + }, + { + "description": "Create file.", + "id": "script-api:dw/io/File#createNewFile", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.createNewFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Create file.", + "heading": "Description" + } + ], + "signature": "createNewFile(): boolean", + "source": "script-api", + "tags": [ + "createnewfile", + "file.createnewfile" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "File.createNewFile" + }, + { + "description": "Indicates that this file is a directory.", + "id": "script-api:dw/io/File#directory", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.directory", + "sections": [ + { + "body": "Indicates that this file is a directory.", + "heading": "Description" + } + ], + "signature": "readonly directory: boolean", + "source": "script-api", + "tags": [ + "directory", + "file.directory" + ], + "title": "File.directory" + }, + { + "description": "Indicates if the file exists.", + "id": "script-api:dw/io/File#exists", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.exists", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the file exists.", + "heading": "Description" + } + ], + "signature": "exists(): boolean", + "source": "script-api", + "tags": [ + "exists", + "file.exists" + ], + "title": "File.exists" + }, + { + "description": "Indicates if this file is a file.", + "id": "script-api:dw/io/File#file", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.file", + "sections": [ + { + "body": "Indicates if this file is a file.", + "heading": "Description" + } + ], + "signature": "readonly file: boolean", + "source": "script-api", + "tags": [ + "file", + "file.file" + ], + "title": "File.file" + }, + { + "description": "Return the full file path denoted by this `File`. This value will be the same regardless of which constructor was used to create this `File`.", + "id": "script-api:dw/io/File#fullPath", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.fullPath", + "sections": [ + { + "body": "Return the full file path denoted by this `File`.\nThis value will be the same regardless of which constructor was\nused to create this `File`.", + "heading": "Description" + } + ], + "signature": "readonly fullPath: string", + "source": "script-api", + "tags": [ + "fullpath", + "file.fullpath" + ], + "title": "File.fullPath" + }, + { + "description": "Return the full file path denoted by this `File`. This value will be the same regardless of which constructor was used to create this `File`.", + "id": "script-api:dw/io/File#getFullPath", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getFullPath", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the full file path denoted by this `File`.\nThis value will be the same regardless of which constructor was\nused to create this `File`.", + "heading": "Description" + } + ], + "signature": "getFullPath(): string", + "source": "script-api", + "tags": [ + "getfullpath", + "file.getfullpath" + ], + "title": "File.getFullPath" + }, + { + "description": "Returns the name of the file or directory denoted by this object. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.", + "id": "script-api:dw/io/File#getName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the file or directory denoted by this object. This is\njust the last name in the pathname's name sequence. If the pathname's\nname sequence is empty, then the empty string is returned.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "file.getname" + ], + "title": "File.getName" + }, + { + "deprecated": { + "message": "Use getFullPath to access the full path.\nThis method does not return the correct path for files\nin the CATALOGS or LIBRARIES virtual directories." + }, + "description": "Returns the portion of the path relative to the root directory.", + "id": "script-api:dw/io/File#getPath", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getPath", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the portion of the path relative to the root directory.", + "heading": "Description" + } + ], + "signature": "getPath(): string", + "source": "script-api", + "tags": [ + "getpath", + "file.getpath" + ], + "title": "File.getPath" + }, + { + "description": "Returns a `File` representing a directory for the specified root directory type. If the root directory type is CATALOGS or LIBRARIES, then an additional argument representing the specific catalog or library must be provided. Otherwise, no additional arguments are needed.", + "id": "script-api:dw/io/File#getRootDirectory", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "rootDir", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectory", + "returns": { + "type": "File" + }, + "sections": [ + { + "body": "Returns a `File` representing a directory for the specified\nroot directory type. If the root directory\ntype is CATALOGS or LIBRARIES, then an additional argument representing\nthe specific catalog or library must be provided. Otherwise, no\nadditional arguments are needed.", + "heading": "Description" + } + ], + "signature": "static getRootDirectory(rootDir: string, args?: string[]): File", + "source": "script-api", + "tags": [ + "getrootdirectory", + "file.getrootdirectory" + ], + "title": "File.getRootDirectory" + }, + { + "description": "Returns a `File` representing a directory for the specified root directory type. If the root directory type is CATALOGS or LIBRARIES, then an additional argument representing the specific catalog or library must be provided. Otherwise, no additional arguments are needed.", + "id": "script-api:dw/io/File#getRootDirectory", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "rootDir", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectory", + "returns": { + "type": "File" + }, + "sections": [ + { + "body": "Returns a `File` representing a directory for the specified\nroot directory type. If the root directory\ntype is CATALOGS or LIBRARIES, then an additional argument representing\nthe specific catalog or library must be provided. Otherwise, no\nadditional arguments are needed.", + "heading": "Description" + } + ], + "signature": "static getRootDirectory(rootDir: string, args?: string[]): File", + "source": "script-api", + "tags": [ + "getrootdirectory", + "file.getrootdirectory" + ], + "title": "File.getRootDirectory" + }, + { + "description": "Returns the root directory type, e.g. \"IMPEX\" represented by this `File`.", + "id": "script-api:dw/io/File#getRootDirectoryType", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.getRootDirectoryType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the root directory type, e.g. \"IMPEX\" represented by this\n`File`.", + "heading": "Description" + } + ], + "signature": "getRootDirectoryType(): string", + "source": "script-api", + "tags": [ + "getrootdirectorytype", + "file.getrootdirectorytype" + ], + "title": "File.getRootDirectoryType" + }, + { + "description": "Assumes this instance is a gzip file. Unzipping it will explode the contents in the directory passed in (root).", + "id": "script-api:dw/io/File#gunzip", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "root", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.gunzip", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Assumes this instance is a gzip file. Unzipping it will\nexplode the contents in the directory passed in (root).", + "heading": "Description" + } + ], + "signature": "gunzip(root: File): void", + "source": "script-api", + "tags": [ + "gunzip", + "file.gunzip" + ], + "throws": [ + { + "description": "if the zip files contents can't be exploded.", + "type": "Exception" + } + ], + "title": "File.gunzip" + }, + { + "description": "GZip this instance into a new gzip file. If you're zipping a file, then a single entry, the instance, is included in the output gzip file. Note that a new File is created. GZipping directories is not supported. This file is never modified.", + "id": "script-api:dw/io/File#gzip", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "outputZipFile", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.gzip", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "GZip this instance into a new gzip file. If you're zipping a file, then a single entry, the instance,\nis included in the output gzip file. Note that a new File is created. GZipping directories is not supported.\nThis file is never modified.", + "heading": "Description" + } + ], + "signature": "gzip(outputZipFile: File): void", + "source": "script-api", + "tags": [ + "gzip", + "file.gzip" + ], + "throws": [ + { + "description": "if the zip file can't be created.", + "type": "IOException" + } + ], + "title": "File.gzip" + }, + { + "description": "Indicates that this file is a directory.", + "id": "script-api:dw/io/File#isDirectory", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.isDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates that this file is a directory.", + "heading": "Description" + } + ], + "signature": "isDirectory(): boolean", + "source": "script-api", + "tags": [ + "isdirectory", + "file.isdirectory" + ], + "title": "File.isDirectory" + }, + { + "description": "Indicates if this file is a file.", + "id": "script-api:dw/io/File#isFile", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.isFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if this file is a file.", + "heading": "Description" + } + ], + "signature": "isFile(): boolean", + "source": "script-api", + "tags": [ + "isfile", + "file.isfile" + ], + "title": "File.isFile" + }, + { + "description": "Return the time, in milliseconds, that this file was last modified.", + "id": "script-api:dw/io/File#lastModified", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.lastModified", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Return the time, in milliseconds, that this file was last modified.", + "heading": "Description" + } + ], + "signature": "lastModified(): number", + "source": "script-api", + "tags": [ + "lastmodified", + "file.lastmodified" + ], + "title": "File.lastModified" + }, + { + "description": "Return the length of the file in bytes.", + "id": "script-api:dw/io/File#length", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.length", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Return the length of the file in bytes.", + "heading": "Description" + } + ], + "signature": "length(): number", + "source": "script-api", + "tags": [ + "length", + "file.length" + ], + "title": "File.length" + }, + { + "description": "Returns an array of strings naming the files and directories in the directory denoted by this object.", + "id": "script-api:dw/io/File#list", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.list", + "returns": { + "type": "string[] | null" + }, + "sections": [ + { + "body": "Returns an array of strings naming the files and directories in the\ndirectory denoted by this object.\n\nIf this object does not denote a directory, then this method returns\n`null`. Otherwise an array of strings is returned, one for\neach file or directory in the directory. Names denoting the directory\nitself and the directory's parent directory are not included in the\nresult. Each string is a file name rather than a complete path.\n\nThere is no guarantee that the name strings in the resulting array will\nappear in any specific order; they are not, in particular, guaranteed to\nappear in alphabetical order.", + "heading": "Description" + } + ], + "signature": "list(): string[] | null", + "source": "script-api", + "tags": [ + "list", + "file.list" + ], + "title": "File.list" + }, + { + "description": "Returns an array of `File` objects in the directory denoted by this `File`.", + "id": "script-api:dw/io/File#listFiles", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.listFiles", + "returns": { + "type": "List | null" + }, + "sections": [ + { + "body": "Returns an array of `File` objects in the directory denoted\nby this `File`.\n\nIf this `File` does not denote a directory, then this method\nreturns `null`. Otherwise an array of `File`\nobjects is returned, one for each file or directory in the directory.\nFiles denoting the directory itself and the directory's parent directory\nare not included in the result.\n\nThere is no guarantee that the files in the resulting array will appear\nin any specific order; they are not, in particular, guaranteed to appear\nin alphabetical order. Example usage:\n\n`\n// Assume \"foo\" is an accessible directory.\n\nvar this_directory : dw.io.File = new File(\"foo\");\n\n// Find all files in directory foo, one level \"down\".\n\n// listFiles() will not traverse subdirectories.\n\nvar folder : dw.util.List = this_directory.listFiles();\n\nvar first_element : dw.io.File = folder[0];\n\nfunction modification_comparison(lhs : File, rhs : File)\n\n{\n\nreturn lhs.lastModified() < rhs.lastModified();\n\n}\n\nfunction lexigraphic_comparison(lhs: File, rhs : File)\n\n{\n\nreturn lhs.getName() < rhs.getName();\n\n}\n\nvar time_ordered_folder : dw.util.ArrayList = folder.sort(modification_comparison);\n\nvar alphabetic_folder : dw.util.ArrayList = folder.sort(lexigraphic_comparison);\n\n`", + "heading": "Description" + } + ], + "signature": "listFiles(): List | null", + "source": "script-api", + "tags": [ + "listfiles", + "file.listfiles" + ], + "title": "File.listFiles" + }, + { + "description": "Returns an array of `File` objects denoting the files and directories in the directory denoted by this object that satisfy the specified filter. The behavior of this method is the same as that of the `listFiles` method, except that the files in the returned array must satisfy the filter. The filter is a Javascript function which accepts one argument, a `File`, and returns true or false depending on whether the file meets the filter conditions. If the given `filter` is `null` then all files are accepted. Otherwise, a file satisfies the filter if and only if the filter returns `true`. Example usage:", + "id": "script-api:dw/io/File#listFiles", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "filter", + "type": "Function" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.listFiles", + "returns": { + "type": "List | null" + }, + "sections": [ + { + "body": "Returns an array of `File` objects denoting the files and\ndirectories in the directory denoted by this object that satisfy the\nspecified filter. The behavior of this method is the same as that of the\n`listFiles` method, except that the files in the\nreturned array must satisfy the filter. The filter is a Javascript\nfunction which accepts one argument, a `File`, and returns\ntrue or false depending on whether the file meets the filter conditions.\nIf the given `filter` is `null` then all files\nare accepted. Otherwise, a file satisfies the filter if and only if the\nfilter returns `true`. Example usage:\n\n`\n// Assume \"foo\" is an accessible directory.\n\nvar this_directory : dw.io.File = new File(\"foo\");\n\nfunction longer_than_3(candidate : dw.io.File)\n\n{\n\nreturn candidate.getName().length > 3;\n\n}\n\n// Find all files in directory foo, one level \"down\",\n\n// such that the filename is longer than 3 characters.\n\nvar folder_long_names : dw.util.List = this_directory.listFiles(longer_than_3);\n\n`", + "heading": "Description" + } + ], + "signature": "listFiles(filter: Function): List | null", + "source": "script-api", + "tags": [ + "listfiles", + "file.listfiles" + ], + "title": "File.listFiles" + }, + { + "description": "Returns an MD5 hash of the content of the file of this instance.", + "id": "script-api:dw/io/File#md5", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.md5", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an MD5 hash of the content of the file of this instance.", + "heading": "Description" + } + ], + "signature": "md5(): string", + "source": "script-api", + "tags": [ + "md5", + "file.md5" + ], + "throws": [ + { + "description": "if the file could not be read or is a directory.", + "type": "Exception" + } + ], + "title": "File.md5" + }, + { + "description": "Creates a directory.", + "id": "script-api:dw/io/File#mkdir", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.mkdir", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Creates a directory.", + "heading": "Description" + } + ], + "signature": "mkdir(): boolean", + "source": "script-api", + "tags": [ + "mkdir", + "file.mkdir" + ], + "title": "File.mkdir" + }, + { + "description": "Creates a directory, including, its parent directories, as needed.", + "id": "script-api:dw/io/File#mkdirs", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.mkdirs", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Creates a directory, including, its parent directories, as needed.", + "heading": "Description" + } + ], + "signature": "mkdirs(): boolean", + "source": "script-api", + "tags": [ + "mkdirs", + "file.mkdirs" + ], + "title": "File.mkdirs" + }, + { + "description": "Returns the name of the file or directory denoted by this object. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.", + "id": "script-api:dw/io/File#name", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.name", + "sections": [ + { + "body": "Returns the name of the file or directory denoted by this object. This is\njust the last name in the pathname's name sequence. If the pathname's\nname sequence is empty, then the empty string is returned.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "file.name" + ], + "title": "File.name" + }, + { + "deprecated": { + "message": "Use getFullPath to access the full path.\nThis method does not return the correct path for files\nin the CATALOGS or LIBRARIES virtual directories." + }, + "description": "Returns the portion of the path relative to the root directory.", + "id": "script-api:dw/io/File#path", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.path", + "sections": [ + { + "body": "Returns the portion of the path relative to the root directory.", + "heading": "Description" + } + ], + "signature": "readonly path: string", + "source": "script-api", + "tags": [ + "path", + "file.path" + ], + "title": "File.path" + }, + { + "description": "Deletes the file or directory denoted by this object. If this File represents a directory, then the directory must be empty in order to be deleted.", + "id": "script-api:dw/io/File#remove", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.remove", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes the file or directory denoted by this object. If this File\nrepresents a directory, then the directory must be empty in order to be\ndeleted.", + "heading": "Description" + } + ], + "signature": "remove(): boolean", + "source": "script-api", + "tags": [ + "remove", + "file.remove" + ], + "title": "File.remove" + }, + { + "description": "Rename file.", + "id": "script-api:dw/io/File#renameTo", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.renameTo", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Rename file.", + "heading": "Description" + } + ], + "signature": "renameTo(file: File): boolean", + "source": "script-api", + "tags": [ + "renameto", + "file.renameto" + ], + "title": "File.renameTo" + }, + { + "description": "Returns the root directory type, e.g. \"IMPEX\" represented by this `File`.", + "id": "script-api:dw/io/File#rootDirectoryType", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.rootDirectoryType", + "sections": [ + { + "body": "Returns the root directory type, e.g. \"IMPEX\" represented by this\n`File`.", + "heading": "Description" + } + ], + "signature": "readonly rootDirectoryType: string", + "source": "script-api", + "tags": [ + "rootdirectorytype", + "file.rootdirectorytype" + ], + "title": "File.rootDirectoryType" + }, + { + "description": "Assumes this instance is a zip file. Unzipping it will explode the contents in the directory passed in (root).", + "id": "script-api:dw/io/File#unzip", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "root", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.unzip", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Assumes this instance is a zip file. Unzipping it will\nexplode the contents in the directory passed in (root).", + "heading": "Description" + } + ], + "signature": "unzip(root: File): void", + "source": "script-api", + "tags": [ + "unzip", + "file.unzip" + ], + "throws": [ + { + "description": "if the zip files contents can't be exploded.", + "type": "Exception" + } + ], + "title": "File.unzip" + }, + { + "description": "Zip this instance into a new zip file. If you're zipping a directory, the directory itself and all its children files to any level (any number of subdirectories) are included in the zip file. The directory will be the only entry in the archive (single root). If you're zipping a file, then a single entry, the instance, is included in the output zip file. Note that a new File is created. This file is never modified.", + "id": "script-api:dw/io/File#zip", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "outputZipFile", + "type": "File" + } + ], + "parentId": "script-api:dw/io/File", + "qualifiedName": "dw.io.File.zip", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Zip this instance into a new zip file. If you're zipping a directory,\nthe directory itself and all its children files to any level (any number of subdirectories)\nare included in the zip file. The directory will be the only entry in the archive (single root).\nIf you're zipping a file, then a single entry, the instance,\nis included in the output zip file. Note that a new File is created.\nThis file is never modified.", + "heading": "Description" + } + ], + "signature": "zip(outputZipFile: File): void", + "source": "script-api", + "tags": [ + "zip", + "file.zip" + ], + "throws": [ + { + "description": "if the zip file can't be created.", + "type": "IOException" + } + ], + "title": "File.zip" + }, + { + "description": "File reader class.", + "id": "script-api:dw/io/FileReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.FileReader", + "sections": [ + { + "body": "File reader class.", + "heading": "Description" + }, + { + "body": "Extends `Reader`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "filereader", + "dw.io.filereader", + "dw/io" + ], + "title": "FileReader" + }, + { + "description": "Closes the reader.", + "id": "script-api:dw/io/FileReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileReader", + "qualifiedName": "dw.io.FileReader.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the reader.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "filereader.close" + ], + "title": "FileReader.close" + }, + { + "description": "Convenience class for writing character files.", + "id": "script-api:dw/io/FileWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.FileWriter", + "sections": [ + { + "body": "Convenience class for writing character files.\n\nFiles are stored in a shared file system where multiple processes could\naccess the same file. The client code is responsible for ensuring that no\nmore than one process writes to a file at a given time.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + }, + { + "body": "Extends `Writer`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "filewriter", + "dw.io.filewriter", + "dw/io" + ], + "title": "FileWriter" + }, + { + "description": "Closes the writer.", + "id": "script-api:dw/io/FileWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the writer.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "filewriter.close" + ], + "title": "FileWriter.close" + }, + { + "description": "Get the current line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "id": "script-api:dw/io/FileWriter#getLineSeparator", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.getLineSeparator", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the current line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "heading": "Description" + } + ], + "signature": "getLineSeparator(): string", + "source": "script-api", + "tags": [ + "getlineseparator", + "filewriter.getlineseparator" + ], + "title": "FileWriter.getLineSeparator" + }, + { + "description": "Get the current line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "id": "script-api:dw/io/FileWriter#lineSeparator", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.lineSeparator", + "sections": [ + { + "body": "Get the current line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "heading": "Description" + } + ], + "signature": "lineSeparator: string", + "source": "script-api", + "tags": [ + "lineseparator", + "filewriter.lineseparator" + ], + "title": "FileWriter.lineSeparator" + }, + { + "description": "Set the line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "id": "script-api:dw/io/FileWriter#setLineSeparator", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "lineSeparator", + "type": "string" + } + ], + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.setLineSeparator", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the line separator (e.g. '\\n' or '\\r\\n'), if no value is set the system default '\\n' will be used.", + "heading": "Description" + } + ], + "signature": "setLineSeparator(lineSeparator: string): void", + "source": "script-api", + "tags": [ + "setlineseparator", + "filewriter.setlineseparator" + ], + "title": "FileWriter.setLineSeparator" + }, + { + "description": "Writes the specified line and appends the line separator.", + "id": "script-api:dw/io/FileWriter#writeLine", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/FileWriter", + "qualifiedName": "dw.io.FileWriter.writeLine", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes the specified line and appends the line separator.", + "heading": "Description" + } + ], + "signature": "writeLine(str: string): void", + "source": "script-api", + "tags": [ + "writeline", + "filewriter.writeline" + ], + "title": "FileWriter.writeLine" + }, + { + "description": "The class represent a stream of bytes that can be read from the application. The InputStream itself doesn't provide any methods to read the data. Instead the InputStream can be chained with other classes like a XMLStreamReader to read data.", + "id": "script-api:dw/io/InputStream", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.InputStream", + "sections": [ + { + "body": "The class represent a stream of bytes that can be read from the\napplication. The InputStream itself doesn't provide any methods\nto read the data. Instead the InputStream can be chained with\nother classes like a XMLStreamReader to read data.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "inputstream", + "dw.io.inputstream", + "dw/io" + ], + "title": "InputStream" + }, + { + "description": "Closes the input stream.", + "id": "script-api:dw/io/InputStream#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/InputStream", + "qualifiedName": "dw.io.InputStream.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the input stream.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "inputstream.close" + ], + "title": "InputStream.close" + }, + { + "description": "The class represent a stream of bytes that can be written from the application. The OutputStream itself doesn't provide any methods to write the data. Instead the OutputStream can be chained with other classes like a XMLStreamWriter to write data.", + "id": "script-api:dw/io/OutputStream", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.OutputStream", + "sections": [ + { + "body": "The class represent a stream of bytes that can be written from the\napplication. The OutputStream itself doesn't provide any methods\nto write the data. Instead the OutputStream can be chained with\nother classes like a XMLStreamWriter to write data.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "outputstream", + "dw.io.outputstream", + "dw/io" + ], + "title": "OutputStream" + }, + { + "description": "Closes the output stream.", + "id": "script-api:dw/io/OutputStream#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/OutputStream", + "qualifiedName": "dw.io.OutputStream.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the output stream.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "outputstream.close" + ], + "title": "OutputStream.close" + }, + { + "description": "Template output stream writer.", + "id": "script-api:dw/io/PrintWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.PrintWriter", + "sections": [ + { + "body": "Template output stream writer.\n\nPrintwriter is available in the template scripting context and is used\nto write data into the template output stream. You cannot instantiate this class\ndirectly. Instead, the system assigns the object to variable named 'out' in the script context\nto be used by the template scripts.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + }, + { + "body": "Extends `Writer`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "printwriter", + "dw.io.printwriter", + "dw/io" + ], + "title": "PrintWriter" + }, + { + "description": "Prints the given string into the output stream.", + "id": "script-api:dw/io/PrintWriter#print", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.print", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Prints the given string into the output stream.", + "heading": "Description" + } + ], + "signature": "print(str: string): void", + "source": "script-api", + "tags": [ + "print", + "printwriter.print" + ], + "title": "PrintWriter.print" + }, + { + "description": "Print the given string followed by a line break into the output stream.", + "id": "script-api:dw/io/PrintWriter#println", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.println", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Print the given string followed by a line break into the output stream.", + "heading": "Description" + } + ], + "signature": "println(str: string): void", + "source": "script-api", + "tags": [ + "println", + "printwriter.println" + ], + "title": "PrintWriter.println" + }, + { + "description": "Prints a line break into the output stream.", + "id": "script-api:dw/io/PrintWriter#println", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/PrintWriter", + "qualifiedName": "dw.io.PrintWriter.println", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Prints a line break into the output stream.", + "heading": "Description" + } + ], + "signature": "println(): void", + "source": "script-api", + "tags": [ + "println", + "printwriter.println" + ], + "title": "PrintWriter.println" + }, + { + "description": "Instances of this class support reading from a random access file. A random access file behaves like a large array of bytes stored in the file system. There is a kind of cursor, or index into the implied array, called the file pointer. Read operations read bytes starting at the file pointer and advance the file pointer past the bytes read. The file pointer can be read by the getPosition method and set by the setPosition method.", + "id": "script-api:dw/io/RandomAccessFileReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.RandomAccessFileReader", + "sections": [ + { + "body": "Instances of this class support reading from a random access file. A random\naccess file behaves like a large array of bytes stored in the file system.\nThere is a kind of cursor, or index into the implied array, called the file\npointer. Read operations read bytes starting at the file pointer and advance\nthe file pointer past the bytes read. The file pointer can be read by the\ngetPosition method and set by the setPosition method.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "randomaccessfilereader", + "dw.io.randomaccessfilereader", + "dw/io" + ], + "title": "RandomAccessFileReader" + }, + { + "description": "The maximum number of bytes that a single call to readBytes can return == 10KB", + "id": "script-api:dw/io/RandomAccessFileReader#MAX_READ_BYTES", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.MAX_READ_BYTES", + "sections": [ + { + "body": "The maximum number of bytes that a single call to readBytes can return == 10KB", + "heading": "Description" + } + ], + "signature": "static readonly MAX_READ_BYTES = 10240", + "source": "script-api", + "tags": [ + "max_read_bytes", + "randomaccessfilereader.max_read_bytes" + ], + "title": "RandomAccessFileReader.MAX_READ_BYTES" + }, + { + "description": "The maximum number of bytes that a single call to readBytes can return == 10KB", + "id": "script-api:dw/io/RandomAccessFileReader#MAX_READ_BYTES", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.MAX_READ_BYTES", + "sections": [ + { + "body": "The maximum number of bytes that a single call to readBytes can return == 10KB", + "heading": "Description" + } + ], + "signature": "static readonly MAX_READ_BYTES = 10240", + "source": "script-api", + "tags": [ + "max_read_bytes", + "randomaccessfilereader.max_read_bytes" + ], + "title": "RandomAccessFileReader.MAX_READ_BYTES" + }, + { + "description": "Closes this random access file reader and releases any system resources associated with the stream.", + "id": "script-api:dw/io/RandomAccessFileReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes this random access file reader and releases any system resources\nassociated with the stream.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "randomaccessfilereader.close" + ], + "throws": [ + { + "description": "if an I/O error occurs.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.close" + }, + { + "description": "Returns the current offset in this file.", + "id": "script-api:dw/io/RandomAccessFileReader#getPosition", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.getPosition", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the current offset in this file.", + "heading": "Description" + } + ], + "signature": "getPosition(): number", + "source": "script-api", + "tags": [ + "getposition", + "randomaccessfilereader.getposition" + ], + "throws": [ + { + "description": "if an I/O error occurs.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.getPosition" + }, + { + "description": "Returns the length of this file.", + "id": "script-api:dw/io/RandomAccessFileReader#length", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.length", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the length of this file.", + "heading": "Description" + } + ], + "signature": "length(): number", + "source": "script-api", + "tags": [ + "length", + "randomaccessfilereader.length" + ], + "throws": [ + { + "description": "if an I/O error occurs.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.length" + }, + { + "description": "Returns the current offset in this file.", + "id": "script-api:dw/io/RandomAccessFileReader#position", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.position", + "sections": [ + { + "body": "Returns the current offset in this file.", + "heading": "Description" + } + ], + "signature": "position: number", + "source": "script-api", + "tags": [ + "position", + "randomaccessfilereader.position" + ], + "throws": [ + { + "description": "if an I/O error occurs.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.position" + }, + { + "description": "Reads a signed eight-bit value from the file starting from the current file pointer. Since the byte is interpreted as signed, the value returned will always be between -128 and +127.", + "id": "script-api:dw/io/RandomAccessFileReader#readByte", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.readByte", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Reads a signed eight-bit value from the file starting from the current\nfile pointer. Since the byte is interpreted as signed, the value returned\nwill always be between -128 and +127.", + "heading": "Description" + } + ], + "signature": "readByte(): number", + "source": "script-api", + "tags": [ + "readbyte", + "randomaccessfilereader.readbyte" + ], + "throws": [ + { + "description": "if an I/O error occurs or if this file has reached the end.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.readByte" + }, + { + "description": "Reads up to n bytes from the file starting at the current file pointer. If there are fewer than n bytes remaining in the file, then as many bytes as possible are read. If no bytes remain in the file, then null is returned.", + "id": "script-api:dw/io/RandomAccessFileReader#readBytes", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "numBytes", + "type": "number" + } + ], + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.readBytes", + "returns": { + "type": "Bytes | null" + }, + "sections": [ + { + "body": "Reads up to n bytes from the file starting at the current file pointer.\nIf there are fewer than n bytes remaining in the file, then as many bytes\nas possible are read. If no bytes remain in the file, then null is\nreturned.", + "heading": "Description" + } + ], + "signature": "readBytes(numBytes: number): Bytes | null", + "source": "script-api", + "tags": [ + "readbytes", + "randomaccessfilereader.readbytes" + ], + "throws": [ + { + "description": "if an I/O error occurs.", + "type": "IOException" + }, + { + "description": "if numBytes < 0 or numBytes > MAX_READ_BYTES.", + "type": "IllegalArgumentException" + } + ], + "title": "RandomAccessFileReader.readBytes" + }, + { + "description": "Sets the file-pointer offset, measured from the beginning of this file, at which the next read occurs. The offset may be set beyond the end of the file.", + "id": "script-api:dw/io/RandomAccessFileReader#setPosition", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "position", + "type": "number" + } + ], + "parentId": "script-api:dw/io/RandomAccessFileReader", + "qualifiedName": "dw.io.RandomAccessFileReader.setPosition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the file-pointer offset, measured from the beginning of this file,\nat which the next read occurs. The offset may be set beyond the end of\nthe file.", + "heading": "Description" + } + ], + "signature": "setPosition(position: number): void", + "source": "script-api", + "tags": [ + "setposition", + "randomaccessfilereader.setposition" + ], + "throws": [ + { + "description": "if position is less than 0 or if an I/O error occurs.", + "type": "IOException" + } + ], + "title": "RandomAccessFileReader.setPosition" + }, + { + "description": "The class supports reading characters from a stream.", + "id": "script-api:dw/io/Reader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.Reader", + "sections": [ + { + "body": "The class supports reading characters from a stream.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "reader", + "dw.io.reader", + "dw/io" + ], + "title": "Reader" + }, + { + "description": "Closes the reader.", + "id": "script-api:dw/io/Reader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the reader.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "reader.close" + ], + "title": "Reader.close" + }, + { + "deprecated": { + "message": "Use readLines" + }, + "description": "The method reads the whole input stream, parses it and returns a list of strings.", + "id": "script-api:dw/io/Reader#getLines", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.getLines", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "The method reads the whole input stream, parses it and returns a list of strings.\n\nUsing this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use\nmethod readLine and process one line at a time.", + "heading": "Description" + } + ], + "signature": "getLines(): List", + "source": "script-api", + "tags": [ + "getlines", + "reader.getlines" + ], + "title": "Reader.getLines" + }, + { + "deprecated": { + "message": "Use readString" + }, + "description": "The method reads the whole input stream as one string and returns it.", + "id": "script-api:dw/io/Reader#getString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.getString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The method reads the whole input stream as one string and returns it.\n\nUsing this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory\ncondition. Instead use method readN.", + "heading": "Description" + } + ], + "signature": "getString(): string", + "source": "script-api", + "tags": [ + "getstring", + "reader.getstring" + ], + "throws": [ + { + "description": "if something went wrong while reading from the underlying stream", + "type": "IOException" + } + ], + "title": "Reader.getString" + }, + { + "deprecated": { + "message": "Use readLines" + }, + "description": "The method reads the whole input stream, parses it and returns a list of strings.", + "id": "script-api:dw/io/Reader#lines", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.lines", + "sections": [ + { + "body": "The method reads the whole input stream, parses it and returns a list of strings.\n\nUsing this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use\nmethod readLine and process one line at a time.", + "heading": "Description" + } + ], + "signature": "readonly lines: List", + "source": "script-api", + "tags": [ + "lines", + "reader.lines" + ], + "title": "Reader.lines" + }, + { + "description": "Reads a single character from the stream. The method returns null if the end of the stream is reached.", + "id": "script-api:dw/io/Reader#read", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.read", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads a single character from the stream. The method returns null if the end of the stream is reached.", + "heading": "Description" + } + ], + "signature": "read(): string | null", + "source": "script-api", + "tags": [ + "read", + "reader.read" + ], + "title": "Reader.read" + }, + { + "deprecated": { + "message": "use readN instead which does not throw an exception if the stream is exhausted" + }, + "description": "Reads multiple characters from the stream as string. The actual number of characters that were read can be determined from the length of the returned string. If the end of the stream is reached and no more characters can be read, the method exits with an exception.", + "id": "script-api:dw/io/Reader#read", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "length", + "type": "number" + } + ], + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.read", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads multiple characters from the stream as string. The actual number of characters that were read can be\ndetermined from the length of the returned string. If the end of the stream is reached and no more characters can\nbe read, the method exits with an exception.", + "heading": "Description" + } + ], + "signature": "read(length: number): string", + "source": "script-api", + "tags": [ + "read", + "reader.read" + ], + "throws": [ + { + "description": "exception if the stream is exhausted", + "type": "an" + } + ], + "title": "Reader.read" + }, + { + "description": "Reads the next line.", + "id": "script-api:dw/io/Reader#readLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readLine", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the next line.", + "heading": "Description" + } + ], + "signature": "readLine(): string | null", + "source": "script-api", + "tags": [ + "readline", + "reader.readline" + ], + "title": "Reader.readLine" + }, + { + "description": "The method reads the whole input stream, parses it and returns a list of strings.", + "id": "script-api:dw/io/Reader#readLines", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readLines", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "The method reads the whole input stream, parses it and returns a list of strings.\n\nUsing this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use\nmethod readLine and process one line at a time.", + "heading": "Description" + } + ], + "signature": "readLines(): List", + "source": "script-api", + "tags": [ + "readlines", + "reader.readlines" + ], + "title": "Reader.readLines" + }, + { + "description": "Reads n characters from the stream as string. The actual number of characters that were read can be determined from the length of the returned string. If the end of the stream is reached and no more characters can be read, the method returns null.", + "id": "script-api:dw/io/Reader#readN", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "n", + "type": "number" + } + ], + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readN", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads n characters from the stream as string. The actual number of characters that were read can be determined\nfrom the length of the returned string. If the end of the stream is reached and no more characters can be read,\nthe method returns null.", + "heading": "Description" + } + ], + "signature": "readN(n: number): string | null", + "source": "script-api", + "tags": [ + "readn", + "reader.readn" + ], + "title": "Reader.readN" + }, + { + "description": "The method reads the whole input stream as one string and returns it.", + "id": "script-api:dw/io/Reader#readString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.readString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The method reads the whole input stream as one string and returns it.\n\nUsing this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory\ncondition. Instead use method readN.", + "heading": "Description" + } + ], + "signature": "readString(): string", + "source": "script-api", + "tags": [ + "readstring", + "reader.readstring" + ], + "throws": [ + { + "description": "if something went wrong while reading from the underlying stream", + "type": "IOException" + } + ], + "title": "Reader.readString" + }, + { + "description": "Identifies if this stream is ready to be read.", + "id": "script-api:dw/io/Reader#ready", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.ready", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this stream is ready to be read.", + "heading": "Description" + } + ], + "signature": "ready(): boolean", + "source": "script-api", + "tags": [ + "ready", + "reader.ready" + ], + "title": "Reader.ready" + }, + { + "description": "Skips the specified number of characters in the stream.", + "id": "script-api:dw/io/Reader#skip", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "n", + "type": "number" + } + ], + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.skip", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Skips the specified number of characters in the stream.", + "heading": "Description" + } + ], + "signature": "skip(n: number): void", + "source": "script-api", + "tags": [ + "skip", + "reader.skip" + ], + "title": "Reader.skip" + }, + { + "deprecated": { + "message": "Use readString" + }, + "description": "The method reads the whole input stream as one string and returns it.", + "id": "script-api:dw/io/Reader#string", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Reader", + "qualifiedName": "dw.io.Reader.string", + "sections": [ + { + "body": "The method reads the whole input stream as one string and returns it.\n\nUsing this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory\ncondition. Instead use method readN.", + "heading": "Description" + } + ], + "signature": "readonly string: string", + "source": "script-api", + "tags": [ + "string", + "reader.string" + ], + "throws": [ + { + "description": "if something went wrong while reading from the underlying stream", + "type": "IOException" + } + ], + "title": "Reader.string" + }, + { + "description": "A Writer that can be used to generate a String.", + "id": "script-api:dw/io/StringWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.StringWriter", + "sections": [ + { + "body": "A Writer that can be used to generate a String.\n\nIn most cases it is not necessary to use StringWriter. If the final\ndestination of the output is a file, use dw.io.FileWriter directly.\nThis will help to reduce memory usage. If you wish to transfer a feed to a\nremote FTP, SFTP or WebDAV server, first write the feed to the file system\nusing FileWriter and optionally dw.io.CSVStreamWriter or\ndw.io.XMLStreamWriter, then upload the file with\ndw.net.FTPClient.putBinary,\ndw.net.SFTPClient.putBinary, or\ndw.net.WebDAVClient.put.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + }, + { + "body": "Extends `Writer`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "stringwriter", + "dw.io.stringwriter", + "dw/io" + ], + "title": "StringWriter" + }, + { + "description": "Returns a string representation of this writer.", + "id": "script-api:dw/io/StringWriter#toString", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this writer.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "stringwriter.tostring" + ], + "title": "StringWriter.toString" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + }, + { + "name": "off", + "type": "number" + }, + { + "name": "len", + "type": "number" + } + ], + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "returns": { + "type": "void" + }, + "signature": "write(str: string, off: number, len: number): void", + "source": "script-api", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "description": "Write the given string to the stream.", + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the given string to the stream.", + "heading": "Description" + } + ], + "signature": "write(str: string): void", + "source": "script-api", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "returns": { + "type": "void" + }, + "signature": "write(str: string): void", + "source": "script-api", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "description": "Write the given string to the stream.", + "id": "script-api:dw/io/StringWriter#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + }, + { + "name": "off", + "type": "number" + }, + { + "name": "len", + "type": "number" + } + ], + "parentId": "script-api:dw/io/StringWriter", + "qualifiedName": "dw.io.StringWriter.write", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the given string to the stream.", + "heading": "Description" + } + ], + "signature": "write(str: string, off: number, len: number): void", + "source": "script-api", + "tags": [ + "write", + "stringwriter.write" + ], + "title": "StringWriter.write" + }, + { + "description": "The class supports writing characters to a stream.", + "id": "script-api:dw/io/Writer", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.Writer", + "sections": [ + { + "body": "The class supports writing characters to a stream.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "writer", + "dw.io.writer", + "dw/io" + ], + "title": "Writer" + }, + { + "description": "Closes the writer.", + "id": "script-api:dw/io/Writer#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the writer.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "writer.close" + ], + "title": "Writer.close" + }, + { + "description": "Flushes the buffer.", + "id": "script-api:dw/io/Writer#flush", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.flush", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Flushes the buffer.", + "heading": "Description" + } + ], + "signature": "flush(): void", + "source": "script-api", + "tags": [ + "flush", + "writer.flush" + ], + "title": "Writer.flush" + }, + { + "description": "Write the given string to the stream.", + "id": "script-api:dw/io/Writer#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + } + ], + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.write", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the given string to the stream.", + "heading": "Description" + } + ], + "signature": "write(str: string): void", + "source": "script-api", + "tags": [ + "write", + "writer.write" + ], + "title": "Writer.write" + }, + { + "description": "Write the given string to the stream.", + "id": "script-api:dw/io/Writer#write", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "str", + "type": "string" + }, + { + "name": "off", + "type": "number" + }, + { + "name": "len", + "type": "number" + } + ], + "parentId": "script-api:dw/io/Writer", + "qualifiedName": "dw.io.Writer.write", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the given string to the stream.", + "heading": "Description" + } + ], + "signature": "write(str: string, off: number, len: number): void", + "source": "script-api", + "tags": [ + "write", + "writer.write" + ], + "title": "Writer.write" + }, + { + "description": "A XMLIndentingStreamWriter writes the XML output formatted for good readability.", + "id": "script-api:dw/io/XMLIndentingStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLIndentingStreamWriter", + "sections": [ + { + "body": "A XMLIndentingStreamWriter writes the XML output formatted for good\nreadability.\n\nNote: when this class is used with sensitive data, be careful\nin persisting sensitive information to disk.", + "heading": "Description" + }, + { + "body": "Extends `XMLStreamWriter`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "xmlindentingstreamwriter", + "dw.io.xmlindentingstreamwriter", + "dw/io" + ], + "title": "XMLIndentingStreamWriter" + }, + { + "description": "Returns the indent.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#getIndent", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.getIndent", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the indent.", + "heading": "Description" + } + ], + "signature": "getIndent(): string", + "source": "script-api", + "tags": [ + "getindent", + "xmlindentingstreamwriter.getindent" + ], + "title": "XMLIndentingStreamWriter.getIndent" + }, + { + "description": "Returns the string that is used for a new line character. The default is the normal new line character.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#getNewLine", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.getNewLine", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the string that is used for a new line character. The\ndefault is the normal new line character.", + "heading": "Description" + } + ], + "signature": "getNewLine(): string", + "source": "script-api", + "tags": [ + "getnewline", + "xmlindentingstreamwriter.getnewline" + ], + "title": "XMLIndentingStreamWriter.getNewLine" + }, + { + "description": "Returns the indent.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#indent", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.indent", + "sections": [ + { + "body": "Returns the indent.", + "heading": "Description" + } + ], + "signature": "indent: string", + "source": "script-api", + "tags": [ + "indent", + "xmlindentingstreamwriter.indent" + ], + "title": "XMLIndentingStreamWriter.indent" + }, + { + "description": "Returns the string that is used for a new line character. The default is the normal new line character.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#newLine", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.newLine", + "sections": [ + { + "body": "Returns the string that is used for a new line character. The\ndefault is the normal new line character.", + "heading": "Description" + } + ], + "signature": "newLine: string", + "source": "script-api", + "tags": [ + "newline", + "xmlindentingstreamwriter.newline" + ], + "title": "XMLIndentingStreamWriter.newLine" + }, + { + "description": "Specifies a string that will be used as identing characters. The default are two space characters.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#setIndent", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "indent", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.setIndent", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Specifies a string that will be used as identing characters. The\ndefault are two space characters.", + "heading": "Description" + } + ], + "signature": "setIndent(indent: string): void", + "source": "script-api", + "tags": [ + "setindent", + "xmlindentingstreamwriter.setindent" + ], + "title": "XMLIndentingStreamWriter.setIndent" + }, + { + "description": "Sets the string that is used for a new line character.", + "id": "script-api:dw/io/XMLIndentingStreamWriter#setNewLine", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "newLine", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLIndentingStreamWriter", + "qualifiedName": "dw.io.XMLIndentingStreamWriter.setNewLine", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the string that is used for a new line character.", + "heading": "Description" + } + ], + "signature": "setNewLine(newLine: string): void", + "source": "script-api", + "tags": [ + "setnewline", + "xmlindentingstreamwriter.setnewline" + ], + "title": "XMLIndentingStreamWriter.setNewLine" + }, + { + "description": "Useful constants for working with XML streams.", + "id": "script-api:dw/io/XMLStreamConstants", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamConstants", + "sections": [ + { + "body": "Useful constants for working with XML streams.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "xmlstreamconstants", + "dw.io.xmlstreamconstants", + "dw/io" + ], + "title": "XMLStreamConstants" + }, + { + "description": "Represents an attribute in an element.", + "id": "script-api:dw/io/XMLStreamConstants#ATTRIBUTE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ATTRIBUTE", + "sections": [ + { + "body": "Represents an attribute in an element.", + "heading": "Description" + } + ], + "signature": "static readonly ATTRIBUTE = 10", + "source": "script-api", + "tags": [ + "attribute", + "xmlstreamconstants.attribute" + ], + "title": "XMLStreamConstants.ATTRIBUTE" + }, + { + "description": "Represents an attribute in an element.", + "id": "script-api:dw/io/XMLStreamConstants#ATTRIBUTE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ATTRIBUTE", + "sections": [ + { + "body": "Represents an attribute in an element.", + "heading": "Description" + } + ], + "signature": "static readonly ATTRIBUTE = 10", + "source": "script-api", + "tags": [ + "attribute", + "xmlstreamconstants.attribute" + ], + "title": "XMLStreamConstants.ATTRIBUTE" + }, + { + "description": "Represents a CDATA section in an element.", + "id": "script-api:dw/io/XMLStreamConstants#CDATA", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CDATA", + "sections": [ + { + "body": "Represents a CDATA section in an element.", + "heading": "Description" + } + ], + "signature": "static readonly CDATA = 12", + "source": "script-api", + "tags": [ + "cdata", + "xmlstreamconstants.cdata" + ], + "title": "XMLStreamConstants.CDATA" + }, + { + "description": "Represents a CDATA section in an element.", + "id": "script-api:dw/io/XMLStreamConstants#CDATA", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CDATA", + "sections": [ + { + "body": "Represents a CDATA section in an element.", + "heading": "Description" + } + ], + "signature": "static readonly CDATA = 12", + "source": "script-api", + "tags": [ + "cdata", + "xmlstreamconstants.cdata" + ], + "title": "XMLStreamConstants.CDATA" + }, + { + "description": "Represents the character data in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#CHARACTERS", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CHARACTERS", + "sections": [ + { + "body": "Represents the character data in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly CHARACTERS = 4", + "source": "script-api", + "tags": [ + "characters", + "xmlstreamconstants.characters" + ], + "title": "XMLStreamConstants.CHARACTERS" + }, + { + "description": "Represents the character data in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#CHARACTERS", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.CHARACTERS", + "sections": [ + { + "body": "Represents the character data in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly CHARACTERS = 4", + "source": "script-api", + "tags": [ + "characters", + "xmlstreamconstants.characters" + ], + "title": "XMLStreamConstants.CHARACTERS" + }, + { + "description": "Represents a comment in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#COMMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.COMMENT", + "sections": [ + { + "body": "Represents a comment in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly COMMENT = 5", + "source": "script-api", + "tags": [ + "comment", + "xmlstreamconstants.comment" + ], + "title": "XMLStreamConstants.COMMENT" + }, + { + "description": "Represents a comment in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#COMMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.COMMENT", + "sections": [ + { + "body": "Represents a comment in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly COMMENT = 5", + "source": "script-api", + "tags": [ + "comment", + "xmlstreamconstants.comment" + ], + "title": "XMLStreamConstants.COMMENT" + }, + { + "description": "Represents the document type definition.", + "id": "script-api:dw/io/XMLStreamConstants#DTD", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.DTD", + "sections": [ + { + "body": "Represents the document type definition.", + "heading": "Description" + } + ], + "signature": "static readonly DTD = 11", + "source": "script-api", + "tags": [ + "dtd", + "xmlstreamconstants.dtd" + ], + "title": "XMLStreamConstants.DTD" + }, + { + "description": "Represents the document type definition.", + "id": "script-api:dw/io/XMLStreamConstants#DTD", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.DTD", + "sections": [ + { + "body": "Represents the document type definition.", + "heading": "Description" + } + ], + "signature": "static readonly DTD = 11", + "source": "script-api", + "tags": [ + "dtd", + "xmlstreamconstants.dtd" + ], + "title": "XMLStreamConstants.DTD" + }, + { + "description": "Represents the end of an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#END_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_DOCUMENT", + "sections": [ + { + "body": "Represents the end of an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly END_DOCUMENT = 8", + "source": "script-api", + "tags": [ + "end_document", + "xmlstreamconstants.end_document" + ], + "title": "XMLStreamConstants.END_DOCUMENT" + }, + { + "description": "Represents the end of an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#END_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_DOCUMENT", + "sections": [ + { + "body": "Represents the end of an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly END_DOCUMENT = 8", + "source": "script-api", + "tags": [ + "end_document", + "xmlstreamconstants.end_document" + ], + "title": "XMLStreamConstants.END_DOCUMENT" + }, + { + "description": "Represents the end of an element in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#END_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_ELEMENT", + "sections": [ + { + "body": "Represents the end of an element in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly END_ELEMENT = 2", + "source": "script-api", + "tags": [ + "end_element", + "xmlstreamconstants.end_element" + ], + "title": "XMLStreamConstants.END_ELEMENT" + }, + { + "description": "Represents the end of an element in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#END_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.END_ELEMENT", + "sections": [ + { + "body": "Represents the end of an element in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly END_ELEMENT = 2", + "source": "script-api", + "tags": [ + "end_element", + "xmlstreamconstants.end_element" + ], + "title": "XMLStreamConstants.END_ELEMENT" + }, + { + "description": "Represents the entity declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_DECLARATION", + "sections": [ + { + "body": "Represents the entity declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly ENTITY_DECLARATION = 15", + "source": "script-api", + "tags": [ + "entity_declaration", + "xmlstreamconstants.entity_declaration" + ], + "title": "XMLStreamConstants.ENTITY_DECLARATION" + }, + { + "description": "Represents the entity declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_DECLARATION", + "sections": [ + { + "body": "Represents the entity declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly ENTITY_DECLARATION = 15", + "source": "script-api", + "tags": [ + "entity_declaration", + "xmlstreamconstants.entity_declaration" + ], + "title": "XMLStreamConstants.ENTITY_DECLARATION" + }, + { + "description": "Represents an entity reference in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_REFERENCE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_REFERENCE", + "sections": [ + { + "body": "Represents an entity reference in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly ENTITY_REFERENCE = 9", + "source": "script-api", + "tags": [ + "entity_reference", + "xmlstreamconstants.entity_reference" + ], + "title": "XMLStreamConstants.ENTITY_REFERENCE" + }, + { + "description": "Represents an entity reference in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#ENTITY_REFERENCE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.ENTITY_REFERENCE", + "sections": [ + { + "body": "Represents an entity reference in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly ENTITY_REFERENCE = 9", + "source": "script-api", + "tags": [ + "entity_reference", + "xmlstreamconstants.entity_reference" + ], + "title": "XMLStreamConstants.ENTITY_REFERENCE" + }, + { + "description": "Represents a namespace declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#NAMESPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NAMESPACE", + "sections": [ + { + "body": "Represents a namespace declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly NAMESPACE = 13", + "source": "script-api", + "tags": [ + "namespace", + "xmlstreamconstants.namespace" + ], + "title": "XMLStreamConstants.NAMESPACE" + }, + { + "description": "Represents a namespace declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#NAMESPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NAMESPACE", + "sections": [ + { + "body": "Represents a namespace declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly NAMESPACE = 13", + "source": "script-api", + "tags": [ + "namespace", + "xmlstreamconstants.namespace" + ], + "title": "XMLStreamConstants.NAMESPACE" + }, + { + "description": "Represents the notation declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#NOTATION_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NOTATION_DECLARATION", + "sections": [ + { + "body": "Represents the notation declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly NOTATION_DECLARATION = 14", + "source": "script-api", + "tags": [ + "notation_declaration", + "xmlstreamconstants.notation_declaration" + ], + "title": "XMLStreamConstants.NOTATION_DECLARATION" + }, + { + "description": "Represents the notation declaration in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#NOTATION_DECLARATION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.NOTATION_DECLARATION", + "sections": [ + { + "body": "Represents the notation declaration in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly NOTATION_DECLARATION = 14", + "source": "script-api", + "tags": [ + "notation_declaration", + "xmlstreamconstants.notation_declaration" + ], + "title": "XMLStreamConstants.NOTATION_DECLARATION" + }, + { + "description": "Represents processing instruction in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#PROCESSING_INSTRUCTION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.PROCESSING_INSTRUCTION", + "sections": [ + { + "body": "Represents processing instruction in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly PROCESSING_INSTRUCTION = 3", + "source": "script-api", + "tags": [ + "processing_instruction", + "xmlstreamconstants.processing_instruction" + ], + "title": "XMLStreamConstants.PROCESSING_INSTRUCTION" + }, + { + "description": "Represents processing instruction in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#PROCESSING_INSTRUCTION", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.PROCESSING_INSTRUCTION", + "sections": [ + { + "body": "Represents processing instruction in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly PROCESSING_INSTRUCTION = 3", + "source": "script-api", + "tags": [ + "processing_instruction", + "xmlstreamconstants.processing_instruction" + ], + "title": "XMLStreamConstants.PROCESSING_INSTRUCTION" + }, + { + "description": "Represents a space in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#SPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.SPACE", + "sections": [ + { + "body": "Represents a space in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly SPACE = 6", + "source": "script-api", + "tags": [ + "space", + "xmlstreamconstants.space" + ], + "title": "XMLStreamConstants.SPACE" + }, + { + "description": "Represents a space in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#SPACE", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.SPACE", + "sections": [ + { + "body": "Represents a space in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly SPACE = 6", + "source": "script-api", + "tags": [ + "space", + "xmlstreamconstants.space" + ], + "title": "XMLStreamConstants.SPACE" + }, + { + "description": "Represents the start of an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#START_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_DOCUMENT", + "sections": [ + { + "body": "Represents the start of an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly START_DOCUMENT = 7", + "source": "script-api", + "tags": [ + "start_document", + "xmlstreamconstants.start_document" + ], + "title": "XMLStreamConstants.START_DOCUMENT" + }, + { + "description": "Represents the start of an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#START_DOCUMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_DOCUMENT", + "sections": [ + { + "body": "Represents the start of an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly START_DOCUMENT = 7", + "source": "script-api", + "tags": [ + "start_document", + "xmlstreamconstants.start_document" + ], + "title": "XMLStreamConstants.START_DOCUMENT" + }, + { + "description": "Represents the start of an element in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#START_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_ELEMENT", + "sections": [ + { + "body": "Represents the start of an element in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly START_ELEMENT = 1", + "source": "script-api", + "tags": [ + "start_element", + "xmlstreamconstants.start_element" + ], + "title": "XMLStreamConstants.START_ELEMENT" + }, + { + "description": "Represents the start of an element in an XML document.", + "id": "script-api:dw/io/XMLStreamConstants#START_ELEMENT", + "kind": "constant", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamConstants", + "qualifiedName": "dw.io.XMLStreamConstants.START_ELEMENT", + "sections": [ + { + "body": "Represents the start of an element in an XML document.", + "heading": "Description" + } + ], + "signature": "static readonly START_ELEMENT = 1", + "source": "script-api", + "tags": [ + "start_element", + "xmlstreamconstants.start_element" + ], + "title": "XMLStreamConstants.START_ELEMENT" + }, + { + "description": "The XMLStreamReader allows forward, read-only access to XML. It is designed to be the lowest level and most efficient way to read XML data.", + "id": "script-api:dw/io/XMLStreamReader", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamReader", + "sections": [ + { + "body": "The XMLStreamReader allows forward, read-only access to XML. It is designed\nto be the lowest level and most efficient way to read XML data.\n\nThe XMLStreamReader is designed to iterate over XML using\nnext() and hasNext(). The data can be accessed using methods such as getEventType(),\ngetNamespaceURI(), getLocalName() and getText();\n\nThe next method causes the reader to read the next parse event.\nThe next() method returns an integer which identifies the type of event just read.\n\nThe event type can be determined using getEventType.\n\nParsing events are defined as the XML Declaration, a DTD,\nstart tag, character data, white space, end tag, comment,\nor processing instruction. An attribute or namespace event may be encountered\nat the root level of a document as the result of a query operation.\n\nThe following table describes which methods are valid in what state.\nIf a method is called in an invalid state the method will throw a\njava.lang.IllegalStateException.\n\nValid methods for each state\n\nEvent Type\nValid Methods\n\nAll States\ngetProperty(), hasNext(), require(), close(),\ngetNamespaceURI(), isStartElement(),\nisEndElement(), isCharacters(), isWhiteSpace(),\ngetNamespaceContext(), getEventType(),getLocation(),\nhasText(), hasName()\n\nSTART_ELEMENT\nnext(), getName(), getLocalName(), hasName(), getPrefix(),\ngetAttributeXXX(), isAttributeSpecified(),\ngetNamespaceXXX(),\ngetElementText(), nextTag(), getXMLObject()\n\nATTRIBUTE\nnext(), nextTag()\ngetAttributeXXX(), isAttributeSpecified(),\n\nNAMESPACE\nnext(), nextTag()\ngetNamespaceXXX()\n\nEND_ELEMENT\nnext(), getName(), getLocalName(), hasName(), getPrefix(),\ngetNamespaceXXX(), nextTag()\n\nCHARACTERS\nnext(), getTextXXX(), nextTag()\n\nCDATA\nnext(), getTextXXX(), nextTag()\n\nCOMMENT\nnext(), getTextXXX(), nextTag()\n\nSPACE\nnext(), getTextXXX(), nextTag()\n\nSTART_DOCUMENT\nnext(), getEncoding(), getVersion(), isStandalone(), standaloneSet(),\ngetCharacterEncodingScheme(), nextTag()\n\nEND_DOCUMENT\nclose()\n\nPROCESSING_INSTRUCTION\nnext(), getPITarget(), getPIData(), nextTag()\n\nENTITY_REFERENCE\nnext(), getLocalName(), getText(), nextTag()\n\nDTD\nnext(), getText(), nextTag()\n\nThe following is a code sample to read an XML file containing multiple\n\"myobject\" sub-elements. Only one myObject instance is kept in memory at\nany given time to keep memory consumption low:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "xmlstreamreader", + "dw.io.xmlstreamreader", + "dw/io" + ], + "title": "XMLStreamReader" + }, + { + "description": "Get the data section of a processing instruction.", + "id": "script-api:dw/io/XMLStreamReader#PIData", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.PIData", + "sections": [ + { + "body": "Get the data section of a processing instruction.", + "heading": "Description" + } + ], + "signature": "readonly PIData: string | null", + "source": "script-api", + "tags": [ + "pidata", + "xmlstreamreader.pidata" + ], + "title": "XMLStreamReader.PIData" + }, + { + "description": "Get the target of a processing instruction.", + "id": "script-api:dw/io/XMLStreamReader#PITarget", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.PITarget", + "sections": [ + { + "body": "Get the target of a processing instruction.", + "heading": "Description" + } + ], + "signature": "readonly PITarget: string | null", + "source": "script-api", + "tags": [ + "pitarget", + "xmlstreamreader.pitarget" + ], + "title": "XMLStreamReader.PITarget" + }, + { + "deprecated": { + "message": "Use readXMLObject" + }, + "description": "Reads a sub-tree of the XML document and parses it as XML object.", + "id": "script-api:dw/io/XMLStreamReader#XMLObject", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.XMLObject", + "sections": [ + { + "body": "Reads a sub-tree of the XML document and parses it as XML object.\n\nThe stream must be positioned on a START_ELEMENT. Do not call the method\nwhen the stream is positioned at document's root element. This would\ncause the whole document to be parsed into a single XML what may lead to\nan out-of-memory condition. Instead use #next() to navigate to\nsub-elements and invoke getXMLObject() there. Do not keep references to\nmore than the currently processed XML to keep memory consumption low. The\nmethod reads the stream up to the matching END_ELEMENT. When the method\nreturns the current event is the END_ELEMENT event.", + "heading": "Description" + } + ], + "signature": "readonly XMLObject: any", + "source": "script-api", + "tags": [ + "xmlobject", + "xmlstreamreader.xmlobject" + ], + "title": "XMLStreamReader.XMLObject" + }, + { + "description": "Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. This count excludes namespace definitions. Attribute indices are zero-based.", + "id": "script-api:dw/io/XMLStreamReader#attributeCount", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.attributeCount", + "sections": [ + { + "body": "Returns the count of attributes on this START_ELEMENT,\nthis method is only valid on a START_ELEMENT or ATTRIBUTE. This\ncount excludes namespace definitions. Attribute indices are\nzero-based.", + "heading": "Description" + } + ], + "signature": "readonly attributeCount: number", + "source": "script-api", + "tags": [ + "attributecount", + "xmlstreamreader.attributecount" + ], + "title": "XMLStreamReader.attributeCount" + }, + { + "description": "Returns the character encoding declared on the XML declaration Returns null if none was declared.", + "id": "script-api:dw/io/XMLStreamReader#characterEncodingScheme", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.characterEncodingScheme", + "sections": [ + { + "body": "Returns the character encoding declared on the XML declaration\nReturns null if none was declared.", + "heading": "Description" + } + ], + "signature": "readonly characterEncodingScheme: string | null", + "source": "script-api", + "tags": [ + "characterencodingscheme", + "xmlstreamreader.characterencodingscheme" + ], + "title": "XMLStreamReader.characterEncodingScheme" + }, + { + "description": "Identifies if the cursor points to a character data event.", + "id": "script-api:dw/io/XMLStreamReader#characters", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.characters", + "sections": [ + { + "body": "Identifies if the cursor points to a character data event.", + "heading": "Description" + } + ], + "signature": "readonly characters: boolean", + "source": "script-api", + "tags": [ + "characters", + "xmlstreamreader.characters" + ], + "title": "XMLStreamReader.characters" + }, + { + "description": "Frees any resources associated with this Reader. This method does not close the underlying reader.", + "id": "script-api:dw/io/XMLStreamReader#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Frees any resources associated with this Reader. This method does not close the\nunderlying reader.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "xmlstreamreader.close" + ], + "title": "XMLStreamReader.close" + }, + { + "description": "Returns the column number where the current event ends or -1 if none is available.", + "id": "script-api:dw/io/XMLStreamReader#columnNumber", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.columnNumber", + "sections": [ + { + "body": "Returns the column number where the current event ends or -1 if none is\navailable.", + "heading": "Description" + } + ], + "signature": "readonly columnNumber: number", + "source": "script-api", + "tags": [ + "columnnumber", + "xmlstreamreader.columnnumber" + ], + "title": "XMLStreamReader.columnNumber" + }, + { + "deprecated": { + "message": "Use readElementText" + }, + "description": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method always returns coalesced content.", + "id": "script-api:dw/io/XMLStreamReader#elementText", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.elementText", + "sections": [ + { + "body": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method\nalways returns coalesced content.\n\nPrecondition: the current event is START_ELEMENT.\n\nPostcondition: the current event is the corresponding END_ELEMENT.\n\nThe method does the following (implementations are free to be optimized but must do equivalent processing):", + "heading": "Description" + } + ], + "signature": "readonly elementText: string", + "source": "script-api", + "tags": [ + "elementtext", + "xmlstreamreader.elementtext" + ], + "title": "XMLStreamReader.elementText" + }, + { + "description": "Return input encoding if known or null if unknown.", + "id": "script-api:dw/io/XMLStreamReader#encoding", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.encoding", + "sections": [ + { + "body": "Return input encoding if known or null if unknown.", + "heading": "Description" + } + ], + "signature": "readonly encoding: string | null", + "source": "script-api", + "tags": [ + "encoding", + "xmlstreamreader.encoding" + ], + "title": "XMLStreamReader.encoding" + }, + { + "description": "Identifies if the cursor points to an end tag.", + "id": "script-api:dw/io/XMLStreamReader#endElement", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.endElement", + "sections": [ + { + "body": "Identifies if the cursor points to an end tag.", + "heading": "Description" + } + ], + "signature": "readonly endElement: boolean", + "source": "script-api", + "tags": [ + "endelement", + "xmlstreamreader.endelement" + ], + "title": "XMLStreamReader.endElement" + }, + { + "description": "Returns an integer code that indicates the type of the event the cursor is pointing to.", + "id": "script-api:dw/io/XMLStreamReader#eventType", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.eventType", + "sections": [ + { + "body": "Returns an integer code that indicates the type\nof the event the cursor is pointing to.", + "heading": "Description" + } + ], + "signature": "readonly eventType: number", + "source": "script-api", + "tags": [ + "eventtype", + "xmlstreamreader.eventtype" + ], + "title": "XMLStreamReader.eventType" + }, + { + "description": "Returns the count of attributes on this START_ELEMENT, this method is only valid on a START_ELEMENT or ATTRIBUTE. This count excludes namespace definitions. Attribute indices are zero-based.", + "id": "script-api:dw/io/XMLStreamReader#getAttributeCount", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the count of attributes on this START_ELEMENT,\nthis method is only valid on a START_ELEMENT or ATTRIBUTE. This\ncount excludes namespace definitions. Attribute indices are\nzero-based.", + "heading": "Description" + } + ], + "signature": "getAttributeCount(): number", + "source": "script-api", + "tags": [ + "getattributecount", + "xmlstreamreader.getattributecount" + ], + "title": "XMLStreamReader.getAttributeCount" + }, + { + "description": "Returns the localName of the attribute at the provided index.", + "id": "script-api:dw/io/XMLStreamReader#getAttributeLocalName", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeLocalName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the localName of the attribute at the provided\nindex.", + "heading": "Description" + } + ], + "signature": "getAttributeLocalName(index: number): string", + "source": "script-api", + "tags": [ + "getattributelocalname", + "xmlstreamreader.getattributelocalname" + ], + "title": "XMLStreamReader.getAttributeLocalName" + }, + { + "description": "Returns the namespace of the attribute at the provided index.", + "id": "script-api:dw/io/XMLStreamReader#getAttributeNamespace", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeNamespace", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the namespace of the attribute at the provided\nindex.", + "heading": "Description" + } + ], + "signature": "getAttributeNamespace(index: number): string", + "source": "script-api", + "tags": [ + "getattributenamespace", + "xmlstreamreader.getattributenamespace" + ], + "title": "XMLStreamReader.getAttributeNamespace" + }, + { + "description": "Returns the prefix of this attribute at the provided index.", + "id": "script-api:dw/io/XMLStreamReader#getAttributePrefix", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributePrefix", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the prefix of this attribute at the\nprovided index.", + "heading": "Description" + } + ], + "signature": "getAttributePrefix(index: number): string", + "source": "script-api", + "tags": [ + "getattributeprefix", + "xmlstreamreader.getattributeprefix" + ], + "title": "XMLStreamReader.getAttributePrefix" + }, + { + "description": "Returns the XML type of the attribute at the provided index.", + "id": "script-api:dw/io/XMLStreamReader#getAttributeType", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the XML type of the attribute at the provided\nindex.", + "heading": "Description" + } + ], + "signature": "getAttributeType(index: number): string", + "source": "script-api", + "tags": [ + "getattributetype", + "xmlstreamreader.getattributetype" + ], + "title": "XMLStreamReader.getAttributeType" + }, + { + "description": "Returns the normalized attribute value of the attribute with the namespace and localName If the namespaceURI is null the namespace is not checked for equality", + "id": "script-api:dw/io/XMLStreamReader#getAttributeValue", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "namespaceURI", + "type": "string" + }, + { + "name": "localName", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the normalized attribute value of the\nattribute with the namespace and localName\nIf the namespaceURI is null the namespace\nis not checked for equality", + "heading": "Description" + } + ], + "signature": "getAttributeValue(namespaceURI: string, localName: string): string | null", + "source": "script-api", + "tags": [ + "getattributevalue", + "xmlstreamreader.getattributevalue" + ], + "title": "XMLStreamReader.getAttributeValue" + }, + { + "description": "Returns the value of the attribute at the index.", + "id": "script-api:dw/io/XMLStreamReader#getAttributeValue", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getAttributeValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the value of the attribute at the\nindex.", + "heading": "Description" + } + ], + "signature": "getAttributeValue(index: number): string", + "source": "script-api", + "tags": [ + "getattributevalue", + "xmlstreamreader.getattributevalue" + ], + "title": "XMLStreamReader.getAttributeValue" + }, + { + "description": "Returns the character encoding declared on the XML declaration Returns null if none was declared.", + "id": "script-api:dw/io/XMLStreamReader#getCharacterEncodingScheme", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getCharacterEncodingScheme", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the character encoding declared on the XML declaration\nReturns null if none was declared.", + "heading": "Description" + } + ], + "signature": "getCharacterEncodingScheme(): string | null", + "source": "script-api", + "tags": [ + "getcharacterencodingscheme", + "xmlstreamreader.getcharacterencodingscheme" + ], + "title": "XMLStreamReader.getCharacterEncodingScheme" + }, + { + "description": "Returns the column number where the current event ends or -1 if none is available.", + "id": "script-api:dw/io/XMLStreamReader#getColumnNumber", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getColumnNumber", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the column number where the current event ends or -1 if none is\navailable.", + "heading": "Description" + } + ], + "signature": "getColumnNumber(): number", + "source": "script-api", + "tags": [ + "getcolumnnumber", + "xmlstreamreader.getcolumnnumber" + ], + "title": "XMLStreamReader.getColumnNumber" + }, + { + "deprecated": { + "message": "Use readElementText" + }, + "description": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method always returns coalesced content.", + "id": "script-api:dw/io/XMLStreamReader#getElementText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getElementText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method\nalways returns coalesced content.\n\nPrecondition: the current event is START_ELEMENT.\n\nPostcondition: the current event is the corresponding END_ELEMENT.\n\nThe method does the following (implementations are free to be optimized but must do equivalent processing):", + "heading": "Description" + } + ], + "signature": "getElementText(): string", + "source": "script-api", + "tags": [ + "getelementtext", + "xmlstreamreader.getelementtext" + ], + "title": "XMLStreamReader.getElementText" + }, + { + "description": "Return input encoding if known or null if unknown.", + "id": "script-api:dw/io/XMLStreamReader#getEncoding", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getEncoding", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Return input encoding if known or null if unknown.", + "heading": "Description" + } + ], + "signature": "getEncoding(): string | null", + "source": "script-api", + "tags": [ + "getencoding", + "xmlstreamreader.getencoding" + ], + "title": "XMLStreamReader.getEncoding" + }, + { + "description": "Returns an integer code that indicates the type of the event the cursor is pointing to.", + "id": "script-api:dw/io/XMLStreamReader#getEventType", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getEventType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns an integer code that indicates the type\nof the event the cursor is pointing to.", + "heading": "Description" + } + ], + "signature": "getEventType(): number", + "source": "script-api", + "tags": [ + "geteventtype", + "xmlstreamreader.geteventtype" + ], + "title": "XMLStreamReader.getEventType" + }, + { + "description": "Returns the line number where the current event ends or -1 if none is available.", + "id": "script-api:dw/io/XMLStreamReader#getLineNumber", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getLineNumber", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the line number where the current event ends or -1 if none is\navailable.", + "heading": "Description" + } + ], + "signature": "getLineNumber(): number", + "source": "script-api", + "tags": [ + "getlinenumber", + "xmlstreamreader.getlinenumber" + ], + "title": "XMLStreamReader.getLineNumber" + }, + { + "description": "Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE.", + "id": "script-api:dw/io/XMLStreamReader#getLocalName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getLocalName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the (local) name of the current event.\nFor START_ELEMENT or END_ELEMENT returns the (local) name of the current element.\nFor ENTITY_REFERENCE it returns entity name.\nThe current event must be START_ELEMENT or END_ELEMENT,\nor ENTITY_REFERENCE.", + "heading": "Description" + } + ], + "signature": "getLocalName(): string", + "source": "script-api", + "tags": [ + "getlocalname", + "xmlstreamreader.getlocalname" + ], + "title": "XMLStreamReader.getLocalName" + }, + { + "description": "Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT, this method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE. On an END_ELEMENT the count is of the namespaces that are about to go out of scope. This is the equivalent of the information reported by SAX callback for an end element event.", + "id": "script-api:dw/io/XMLStreamReader#getNamespaceCount", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceCount", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT,\nthis method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE. On\nan END_ELEMENT the count is of the namespaces that are about to go\nout of scope. This is the equivalent of the information reported\nby SAX callback for an end element event.", + "heading": "Description" + } + ], + "signature": "getNamespaceCount(): number", + "source": "script-api", + "tags": [ + "getnamespacecount", + "xmlstreamreader.getnamespacecount" + ], + "title": "XMLStreamReader.getNamespaceCount" + }, + { + "description": "Returns the prefix for the namespace declared at the index. Returns null if this is the default namespace declaration.", + "id": "script-api:dw/io/XMLStreamReader#getNamespacePrefix", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespacePrefix", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the prefix for the namespace declared at the\nindex. Returns null if this is the default namespace\ndeclaration.", + "heading": "Description" + } + ], + "signature": "getNamespacePrefix(index: number): string | null", + "source": "script-api", + "tags": [ + "getnamespaceprefix", + "xmlstreamreader.getnamespaceprefix" + ], + "title": "XMLStreamReader.getNamespacePrefix" + }, + { + "description": "Return the uri for the given prefix. The uri returned depends on the current state of the processor.", + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Return the uri for the given prefix.\nThe uri returned depends on the current state of the processor.\n\nNOTE:The 'xml' prefix is bound as defined in\nNamespaces in XML\nspecification to \"http://www.w3.org/XML/1998/namespace\".\n\nNOTE: The 'xmlns' prefix must be resolved to following namespace\nhttp://www.w3.org/2000/xmlns/", + "heading": "Description" + } + ], + "signature": "getNamespaceURI(prefix: string): string | null", + "source": "script-api", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "description": "Returns the uri for the namespace declared at the index.", + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the uri for the namespace declared at the\nindex.", + "heading": "Description" + } + ], + "signature": "getNamespaceURI(index: number): string", + "source": "script-api", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "description": "If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace. Returns null if the event does not have a prefix.", + "id": "script-api:dw/io/XMLStreamReader#getNamespaceURI", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getNamespaceURI", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "If the current event is a START_ELEMENT or END_ELEMENT this method\nreturns the URI of the prefix or the default namespace.\nReturns null if the event does not have a prefix.", + "heading": "Description" + } + ], + "signature": "getNamespaceURI(): string | null", + "source": "script-api", + "tags": [ + "getnamespaceuri", + "xmlstreamreader.getnamespaceuri" + ], + "title": "XMLStreamReader.getNamespaceURI" + }, + { + "description": "Get the data section of a processing instruction.", + "id": "script-api:dw/io/XMLStreamReader#getPIData", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPIData", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the data section of a processing instruction.", + "heading": "Description" + } + ], + "signature": "getPIData(): string | null", + "source": "script-api", + "tags": [ + "getpidata", + "xmlstreamreader.getpidata" + ], + "title": "XMLStreamReader.getPIData" + }, + { + "description": "Get the target of a processing instruction.", + "id": "script-api:dw/io/XMLStreamReader#getPITarget", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPITarget", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the target of a processing instruction.", + "heading": "Description" + } + ], + "signature": "getPITarget(): string | null", + "source": "script-api", + "tags": [ + "getpitarget", + "xmlstreamreader.getpitarget" + ], + "title": "XMLStreamReader.getPITarget" + }, + { + "description": "Returns the prefix of the current event or null if the event does not have a prefix", + "id": "script-api:dw/io/XMLStreamReader#getPrefix", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getPrefix", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the prefix of the current event or null if the event does not have a prefix", + "heading": "Description" + } + ], + "signature": "getPrefix(): string | null", + "source": "script-api", + "tags": [ + "getprefix", + "xmlstreamreader.getprefix" + ], + "title": "XMLStreamReader.getPrefix" + }, + { + "description": "Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD. If an ENTITY_REFERENCE has been resolved, any character data will be reported as CHARACTERS events.", + "id": "script-api:dw/io/XMLStreamReader#getText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getText", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the current value of the parse event as a string,\nthis returns the string value of a CHARACTERS event,\nreturns the value of a COMMENT, the replacement value\nfor an ENTITY_REFERENCE, the string value of a CDATA section,\nthe string value for a SPACE event,\nor the String value of the internal subset of the DTD.\nIf an ENTITY_REFERENCE has been resolved, any character data\nwill be reported as CHARACTERS events.", + "heading": "Description" + } + ], + "signature": "getText(): string | null", + "source": "script-api", + "tags": [ + "gettext", + "xmlstreamreader.gettext" + ], + "title": "XMLStreamReader.getText" + }, + { + "description": "Returns the length of the sequence of characters for this Text event within the text character array.", + "id": "script-api:dw/io/XMLStreamReader#getTextLength", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getTextLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the length of the sequence of characters for this\nText event within the text character array.", + "heading": "Description" + } + ], + "signature": "getTextLength(): number", + "source": "script-api", + "tags": [ + "gettextlength", + "xmlstreamreader.gettextlength" + ], + "title": "XMLStreamReader.getTextLength" + }, + { + "description": "Returns the offset into the text character array where the first character (of this text event) is stored.", + "id": "script-api:dw/io/XMLStreamReader#getTextStart", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getTextStart", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the offset into the text character array where the first\ncharacter (of this text event) is stored.", + "heading": "Description" + } + ], + "signature": "getTextStart(): number", + "source": "script-api", + "tags": [ + "gettextstart", + "xmlstreamreader.gettextstart" + ], + "title": "XMLStreamReader.getTextStart" + }, + { + "description": "Get the xml version declared on the xml declaration. Returns null if none was declared.", + "id": "script-api:dw/io/XMLStreamReader#getVersion", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getVersion", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the xml version declared on the xml declaration.\nReturns null if none was declared.", + "heading": "Description" + } + ], + "signature": "getVersion(): string | null", + "source": "script-api", + "tags": [ + "getversion", + "xmlstreamreader.getversion" + ], + "title": "XMLStreamReader.getVersion" + }, + { + "deprecated": { + "message": "Use readXMLObject" + }, + "description": "Reads a sub-tree of the XML document and parses it as XML object.", + "id": "script-api:dw/io/XMLStreamReader#getXMLObject", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.getXMLObject", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Reads a sub-tree of the XML document and parses it as XML object.\n\nThe stream must be positioned on a START_ELEMENT. Do not call the method\nwhen the stream is positioned at document's root element. This would\ncause the whole document to be parsed into a single XML what may lead to\nan out-of-memory condition. Instead use #next() to navigate to\nsub-elements and invoke getXMLObject() there. Do not keep references to\nmore than the currently processed XML to keep memory consumption low. The\nmethod reads the stream up to the matching END_ELEMENT. When the method\nreturns the current event is the END_ELEMENT event.", + "heading": "Description" + } + ], + "signature": "getXMLObject(): any", + "source": "script-api", + "tags": [ + "getxmlobject", + "xmlstreamreader.getxmlobject" + ], + "title": "XMLStreamReader.getXMLObject" + }, + { + "description": "Identifies if the current event has a name (is a START_ELEMENT or END_ELEMENT)", + "id": "script-api:dw/io/XMLStreamReader#hasName", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasName", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the current event has a name (is a START_ELEMENT or END_ELEMENT)", + "heading": "Description" + } + ], + "signature": "hasName(): boolean", + "source": "script-api", + "tags": [ + "hasname", + "xmlstreamreader.hasname" + ], + "title": "XMLStreamReader.hasName" + }, + { + "description": "Returns true if there are more parsing events and false if there are no more events. This method will return false if the current state of the XMLStreamReader is END_DOCUMENT", + "id": "script-api:dw/io/XMLStreamReader#hasNext", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasNext", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if there are more parsing events and false\nif there are no more events. This method will return\nfalse if the current state of the XMLStreamReader is\nEND_DOCUMENT", + "heading": "Description" + } + ], + "signature": "hasNext(): boolean", + "source": "script-api", + "tags": [ + "hasnext", + "xmlstreamreader.hasnext" + ], + "title": "XMLStreamReader.hasNext" + }, + { + "description": "Indicates if the current event has text. The following events have text: CHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE.", + "id": "script-api:dw/io/XMLStreamReader#hasText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.hasText", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the current event has text.\nThe following events have text:\nCHARACTERS,DTD ,ENTITY_REFERENCE, COMMENT, SPACE.", + "heading": "Description" + } + ], + "signature": "hasText(): boolean", + "source": "script-api", + "tags": [ + "hastext", + "xmlstreamreader.hastext" + ], + "title": "XMLStreamReader.hasText" + }, + { + "description": "Identifies if this attribute was created by default.", + "id": "script-api:dw/io/XMLStreamReader#isAttributeSpecified", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isAttributeSpecified", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this\nattribute was created by default.", + "heading": "Description" + } + ], + "signature": "isAttributeSpecified(index: number): boolean", + "source": "script-api", + "tags": [ + "isattributespecified", + "xmlstreamreader.isattributespecified" + ], + "title": "XMLStreamReader.isAttributeSpecified" + }, + { + "description": "Identifies if the cursor points to a character data event.", + "id": "script-api:dw/io/XMLStreamReader#isCharacters", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isCharacters", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the cursor points to a character data event.", + "heading": "Description" + } + ], + "signature": "isCharacters(): boolean", + "source": "script-api", + "tags": [ + "ischaracters", + "xmlstreamreader.ischaracters" + ], + "title": "XMLStreamReader.isCharacters" + }, + { + "description": "Identifies if the cursor points to an end tag.", + "id": "script-api:dw/io/XMLStreamReader#isEndElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isEndElement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the cursor points to an end tag.", + "heading": "Description" + } + ], + "signature": "isEndElement(): boolean", + "source": "script-api", + "tags": [ + "isendelement", + "xmlstreamreader.isendelement" + ], + "title": "XMLStreamReader.isEndElement" + }, + { + "description": "Get the standalone declaration from the xml declaration.", + "id": "script-api:dw/io/XMLStreamReader#isStandalone", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isStandalone", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Get the standalone declaration from the xml declaration.", + "heading": "Description" + } + ], + "signature": "isStandalone(): boolean", + "source": "script-api", + "tags": [ + "isstandalone", + "xmlstreamreader.isstandalone" + ], + "title": "XMLStreamReader.isStandalone" + }, + { + "description": "Identifies if the cursor points to a start tag.", + "id": "script-api:dw/io/XMLStreamReader#isStartElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isStartElement", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the cursor points to a start tag.", + "heading": "Description" + } + ], + "signature": "isStartElement(): boolean", + "source": "script-api", + "tags": [ + "isstartelement", + "xmlstreamreader.isstartelement" + ], + "title": "XMLStreamReader.isStartElement" + }, + { + "description": "Identifies if the cursor points to a character data event that consists of all whitespace.", + "id": "script-api:dw/io/XMLStreamReader#isWhiteSpace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.isWhiteSpace", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the cursor points to a character data event\nthat consists of all whitespace.", + "heading": "Description" + } + ], + "signature": "isWhiteSpace(): boolean", + "source": "script-api", + "tags": [ + "iswhitespace", + "xmlstreamreader.iswhitespace" + ], + "title": "XMLStreamReader.isWhiteSpace" + }, + { + "description": "Returns the line number where the current event ends or -1 if none is available.", + "id": "script-api:dw/io/XMLStreamReader#lineNumber", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.lineNumber", + "sections": [ + { + "body": "Returns the line number where the current event ends or -1 if none is\navailable.", + "heading": "Description" + } + ], + "signature": "readonly lineNumber: number", + "source": "script-api", + "tags": [ + "linenumber", + "xmlstreamreader.linenumber" + ], + "title": "XMLStreamReader.lineNumber" + }, + { + "description": "Returns the (local) name of the current event. For START_ELEMENT or END_ELEMENT returns the (local) name of the current element. For ENTITY_REFERENCE it returns entity name. The current event must be START_ELEMENT or END_ELEMENT, or ENTITY_REFERENCE.", + "id": "script-api:dw/io/XMLStreamReader#localName", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.localName", + "sections": [ + { + "body": "Returns the (local) name of the current event.\nFor START_ELEMENT or END_ELEMENT returns the (local) name of the current element.\nFor ENTITY_REFERENCE it returns entity name.\nThe current event must be START_ELEMENT or END_ELEMENT,\nor ENTITY_REFERENCE.", + "heading": "Description" + } + ], + "signature": "readonly localName: string", + "source": "script-api", + "tags": [ + "localname", + "xmlstreamreader.localname" + ], + "title": "XMLStreamReader.localName" + }, + { + "description": "Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT, this method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE. On an END_ELEMENT the count is of the namespaces that are about to go out of scope. This is the equivalent of the information reported by SAX callback for an end element event.", + "id": "script-api:dw/io/XMLStreamReader#namespaceCount", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.namespaceCount", + "sections": [ + { + "body": "Returns the count of namespaces declared on this START_ELEMENT or END_ELEMENT,\nthis method is only valid on a START_ELEMENT, END_ELEMENT or NAMESPACE. On\nan END_ELEMENT the count is of the namespaces that are about to go\nout of scope. This is the equivalent of the information reported\nby SAX callback for an end element event.", + "heading": "Description" + } + ], + "signature": "readonly namespaceCount: number", + "source": "script-api", + "tags": [ + "namespacecount", + "xmlstreamreader.namespacecount" + ], + "title": "XMLStreamReader.namespaceCount" + }, + { + "description": "If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace. Returns null if the event does not have a prefix.", + "id": "script-api:dw/io/XMLStreamReader#namespaceURI", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.namespaceURI", + "sections": [ + { + "body": "If the current event is a START_ELEMENT or END_ELEMENT this method\nreturns the URI of the prefix or the default namespace.\nReturns null if the event does not have a prefix.", + "heading": "Description" + } + ], + "signature": "readonly namespaceURI: string | null", + "source": "script-api", + "tags": [ + "namespaceuri", + "xmlstreamreader.namespaceuri" + ], + "title": "XMLStreamReader.namespaceURI" + }, + { + "description": "Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks. If the property javax.xml.stream.isCoalescing is set to true element content must be coalesced and only one CHARACTERS event must be returned for contiguous element content or CDATA Sections.", + "id": "script-api:dw/io/XMLStreamReader#next", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.next", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Get next parsing event - a processor may return all contiguous\ncharacter data in a single chunk, or it may split it into several chunks.\nIf the property javax.xml.stream.isCoalescing is set to true\nelement content must be coalesced and only one CHARACTERS event\nmust be returned for contiguous element content or\nCDATA Sections.\n\nBy default entity references must be\nexpanded and reported transparently to the application.\nAn exception will be thrown if an entity reference cannot be expanded.\nIf element content is empty (i.e. content is \"\") then no CHARACTERS event will be reported.\n\nGiven the following XML:\n\ncontent textHello]]>other content\n\nThe behavior of calling next() when being on foo will be:\n\n1- the comment (COMMENT)\n\n2- then the characters section (CHARACTERS)\n\n3- then the CDATA section (another CHARACTERS)\n\n4- then the next characters section (another CHARACTERS)\n\n5- then the END_ELEMENT\n\nNOTE: empty element (such as ) will be reported\nwith two separate events: START_ELEMENT, END_ELEMENT - This preserves\nparsing equivalency of empty element to .\n\nThis method will throw an IllegalStateException if it is called after hasNext() returns false.", + "heading": "Description" + } + ], + "signature": "next(): number", + "source": "script-api", + "tags": [ + "next", + "xmlstreamreader.next" + ], + "title": "XMLStreamReader.next" + }, + { + "description": "Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached. If other than white space characters, COMMENT, PROCESSING_INSTRUCTION, START_ELEMENT, END_ELEMENT are encountered, an exception is thrown. This method should be used when processing element-only content separated by white space.", + "id": "script-api:dw/io/XMLStreamReader#nextTag", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.nextTag", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Skips any white space (isWhiteSpace() returns true), COMMENT,\nor PROCESSING_INSTRUCTION,\nuntil a START_ELEMENT or END_ELEMENT is reached.\nIf other than white space characters, COMMENT, PROCESSING_INSTRUCTION, START_ELEMENT, END_ELEMENT\nare encountered, an exception is thrown. This method should\nbe used when processing element-only content separated by white space.\n\nPrecondition: none\n\nPostcondition: the current event is START_ELEMENT or END_ELEMENT\nand cursor may have moved over any whitespace event.\n\nEssentially it does the following (implementations are free to optimized\nbut must do equivalent processing):", + "heading": "Description" + } + ], + "signature": "nextTag(): number", + "source": "script-api", + "tags": [ + "nexttag", + "xmlstreamreader.nexttag" + ], + "title": "XMLStreamReader.nextTag" + }, + { + "description": "Returns the prefix of the current event or null if the event does not have a prefix", + "id": "script-api:dw/io/XMLStreamReader#prefix", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.prefix", + "sections": [ + { + "body": "Returns the prefix of the current event or null if the event does not have a prefix", + "heading": "Description" + } + ], + "signature": "readonly prefix: string | null", + "source": "script-api", + "tags": [ + "prefix", + "xmlstreamreader.prefix" + ], + "title": "XMLStreamReader.prefix" + }, + { + "description": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method always returns coalesced content.", + "id": "script-api:dw/io/XMLStreamReader#readElementText", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.readElementText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads the content of a text-only element, an exception is thrown if this is not a text-only element. This method\nalways returns coalesced content.\n\nPrecondition: the current event is START_ELEMENT.\n\nPostcondition: the current event is the corresponding END_ELEMENT.\n\nThe method does the following (implementations are free to be optimized but must do equivalent processing):", + "heading": "Description" + } + ], + "signature": "readElementText(): string", + "source": "script-api", + "tags": [ + "readelementtext", + "xmlstreamreader.readelementtext" + ], + "title": "XMLStreamReader.readElementText" + }, + { + "description": "Reads a sub-tree of the XML document and parses it as XML object.", + "id": "script-api:dw/io/XMLStreamReader#readXMLObject", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.readXMLObject", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Reads a sub-tree of the XML document and parses it as XML object.\n\nThe stream must be positioned on a START_ELEMENT. Do not call the method\nwhen the stream is positioned at document's root element. This would\ncause the whole document to be parsed into a single XML what may lead to\nan out-of-memory condition. Instead use #next() to navigate to\nsub-elements and invoke getXMLObject() there. Do not keep references to\nmore than the currently processed XML to keep memory consumption low. The\nmethod reads the stream up to the matching END_ELEMENT. When the method\nreturns the current event is the END_ELEMENT event.", + "heading": "Description" + } + ], + "signature": "readXMLObject(): any", + "source": "script-api", + "tags": [ + "readxmlobject", + "xmlstreamreader.readxmlobject" + ], + "title": "XMLStreamReader.readXMLObject" + }, + { + "description": "Test if the current event is of the given type and if the namespace and name match the current namespace and name of the current event. If the namespaceURI is null it is not checked for equality, if the localName is null it is not checked for equality.", + "id": "script-api:dw/io/XMLStreamReader#require", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "type", + "type": "number" + }, + { + "name": "namespaceURI", + "type": "string | null" + }, + { + "name": "localName", + "type": "string | null" + } + ], + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.require", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Test if the current event is of the given type and if the namespace and name match the current\nnamespace and name of the current event. If the namespaceURI is null it is not checked for equality,\nif the localName is null it is not checked for equality.", + "heading": "Description" + } + ], + "signature": "require(type: number, namespaceURI: string | null, localName: string | null): void", + "source": "script-api", + "tags": [ + "require", + "xmlstreamreader.require" + ], + "title": "XMLStreamReader.require" + }, + { + "description": "Get the standalone declaration from the xml declaration.", + "id": "script-api:dw/io/XMLStreamReader#standalone", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.standalone", + "sections": [ + { + "body": "Get the standalone declaration from the xml declaration.", + "heading": "Description" + } + ], + "signature": "readonly standalone: boolean", + "source": "script-api", + "tags": [ + "standalone", + "xmlstreamreader.standalone" + ], + "title": "XMLStreamReader.standalone" + }, + { + "description": "Identifies if standalone was set in the document.", + "id": "script-api:dw/io/XMLStreamReader#standaloneSet", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.standaloneSet", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if standalone was set in the document.", + "heading": "Description" + } + ], + "signature": "standaloneSet(): boolean", + "source": "script-api", + "tags": [ + "standaloneset", + "xmlstreamreader.standaloneset" + ], + "title": "XMLStreamReader.standaloneSet" + }, + { + "description": "Identifies if the cursor points to a start tag.", + "id": "script-api:dw/io/XMLStreamReader#startElement", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.startElement", + "sections": [ + { + "body": "Identifies if the cursor points to a start tag.", + "heading": "Description" + } + ], + "signature": "readonly startElement: boolean", + "source": "script-api", + "tags": [ + "startelement", + "xmlstreamreader.startelement" + ], + "title": "XMLStreamReader.startElement" + }, + { + "description": "Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD. If an ENTITY_REFERENCE has been resolved, any character data will be reported as CHARACTERS events.", + "id": "script-api:dw/io/XMLStreamReader#text", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.text", + "sections": [ + { + "body": "Returns the current value of the parse event as a string,\nthis returns the string value of a CHARACTERS event,\nreturns the value of a COMMENT, the replacement value\nfor an ENTITY_REFERENCE, the string value of a CDATA section,\nthe string value for a SPACE event,\nor the String value of the internal subset of the DTD.\nIf an ENTITY_REFERENCE has been resolved, any character data\nwill be reported as CHARACTERS events.", + "heading": "Description" + } + ], + "signature": "readonly text: string | null", + "source": "script-api", + "tags": [ + "text", + "xmlstreamreader.text" + ], + "title": "XMLStreamReader.text" + }, + { + "description": "Returns the length of the sequence of characters for this Text event within the text character array.", + "id": "script-api:dw/io/XMLStreamReader#textLength", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.textLength", + "sections": [ + { + "body": "Returns the length of the sequence of characters for this\nText event within the text character array.", + "heading": "Description" + } + ], + "signature": "readonly textLength: number", + "source": "script-api", + "tags": [ + "textlength", + "xmlstreamreader.textlength" + ], + "title": "XMLStreamReader.textLength" + }, + { + "description": "Returns the offset into the text character array where the first character (of this text event) is stored.", + "id": "script-api:dw/io/XMLStreamReader#textStart", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.textStart", + "sections": [ + { + "body": "Returns the offset into the text character array where the first\ncharacter (of this text event) is stored.", + "heading": "Description" + } + ], + "signature": "readonly textStart: number", + "source": "script-api", + "tags": [ + "textstart", + "xmlstreamreader.textstart" + ], + "title": "XMLStreamReader.textStart" + }, + { + "description": "Get the xml version declared on the xml declaration. Returns null if none was declared.", + "id": "script-api:dw/io/XMLStreamReader#version", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.version", + "sections": [ + { + "body": "Get the xml version declared on the xml declaration.\nReturns null if none was declared.", + "heading": "Description" + } + ], + "signature": "readonly version: string | null", + "source": "script-api", + "tags": [ + "version", + "xmlstreamreader.version" + ], + "title": "XMLStreamReader.version" + }, + { + "description": "Identifies if the cursor points to a character data event that consists of all whitespace.", + "id": "script-api:dw/io/XMLStreamReader#whiteSpace", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamReader", + "qualifiedName": "dw.io.XMLStreamReader.whiteSpace", + "sections": [ + { + "body": "Identifies if the cursor points to a character data event\nthat consists of all whitespace.", + "heading": "Description" + } + ], + "signature": "readonly whiteSpace: boolean", + "source": "script-api", + "tags": [ + "whitespace", + "xmlstreamreader.whitespace" + ], + "title": "XMLStreamReader.whiteSpace" + }, + { + "description": "The XMLStreamWriter can be used to write small and large XML feeds.", + "examples": [ + "var fileWriter : FileWriter = new FileWriter(file, \"UTF-8\");\nvar xsw : XMLStreamWriter = new XMLStreamWriter(fileWriter);\n\nxsw.writeStartDocument();\nxsw.writeStartElement(\"products\");\nxsw.writeStartElement(\"product\");\nxsw.writeAttribute(\"id\", \"p42\");\nxsw.writeStartElement(\"name\");\nxsw.writeCharacters(\"blue t-shirt\");\nxsw.writeEndElement();\nxsw.writeStartElement(\"rating\");\nxsw.writeCharacters(\"2.0\");\nxsw.writeEndElement();\nxsw.writeEndElement();\nxsw.writeEndElement();\nxsw.writeEndDocument();\n\nxsw.close();\nfileWriter.close();", + "\n\n\na blue t-shirt\n2.0\n\n" + ], + "id": "script-api:dw/io/XMLStreamWriter", + "kind": "class", + "packagePath": "dw/io", + "parentId": "script-api:dw/io", + "qualifiedName": "dw.io.XMLStreamWriter", + "sections": [ + { + "body": "The XMLStreamWriter can be used to write small and large XML feeds.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.\n\nThe XMLStreamWriter does not perform well-formedness checking on its input.\nHowever the writeCharacters method escapes '&' , '<' and '>'. For attribute\nvalues the writeAttribute method escapes the above characters plus '\"' to\nensure that all character content and attribute values are well formed.\n\nThe following example illustrates how to use this class:\n\n\nThe code above will write the following to file:\n\n\nNote: This output has been formatted for readability. See\ndw.io.XMLIndentingStreamWriter.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "xmlstreamwriter", + "dw.io.xmlstreamwriter", + "dw/io" + ], + "title": "XMLStreamWriter" + }, + { + "description": "Close this writer and free any resources associated with the writer. This method does not close the underlying writer.", + "id": "script-api:dw/io/XMLStreamWriter#close", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Close this writer and free any resources associated with the\nwriter. This method does not close the underlying writer.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "xmlstreamwriter.close" + ], + "title": "XMLStreamWriter.close" + }, + { + "description": "Returns the current default name space.", + "id": "script-api:dw/io/XMLStreamWriter#defaultNamespace", + "kind": "property", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.defaultNamespace", + "sections": [ + { + "body": "Returns the current default name space.", + "heading": "Description" + } + ], + "signature": "defaultNamespace: string", + "source": "script-api", + "tags": [ + "defaultnamespace", + "xmlstreamwriter.defaultnamespace" + ], + "title": "XMLStreamWriter.defaultNamespace" + }, + { + "description": "Write any cached data to the underlying output mechanism.", + "id": "script-api:dw/io/XMLStreamWriter#flush", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.flush", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write any cached data to the underlying output mechanism.", + "heading": "Description" + } + ], + "signature": "flush(): void", + "source": "script-api", + "tags": [ + "flush", + "xmlstreamwriter.flush" + ], + "title": "XMLStreamWriter.flush" + }, + { + "description": "Returns the current default name space.", + "id": "script-api:dw/io/XMLStreamWriter#getDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.getDefaultNamespace", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current default name space.", + "heading": "Description" + } + ], + "signature": "getDefaultNamespace(): string", + "source": "script-api", + "tags": [ + "getdefaultnamespace", + "xmlstreamwriter.getdefaultnamespace" + ], + "title": "XMLStreamWriter.getDefaultNamespace" + }, + { + "description": "Gets the prefix the URI is bound to.", + "id": "script-api:dw/io/XMLStreamWriter#getPrefix", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "uri", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.getPrefix", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Gets the prefix the URI is bound to.", + "heading": "Description" + } + ], + "signature": "getPrefix(uri: string): string | null", + "source": "script-api", + "tags": [ + "getprefix", + "xmlstreamwriter.getprefix" + ], + "title": "XMLStreamWriter.getPrefix" + }, + { + "description": "Binds a URI to the default namespace. This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.", + "id": "script-api:dw/io/XMLStreamWriter#setDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "uri", + "type": "string | null" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.setDefaultNamespace", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Binds a URI to the default namespace.\nThis URI is bound\nin the scope of the current START_ELEMENT / END_ELEMENT pair.\nIf this method is called before a START_ELEMENT has been written\nthe uri is bound in the root scope.", + "heading": "Description" + } + ], + "signature": "setDefaultNamespace(uri: string | null): void", + "source": "script-api", + "tags": [ + "setdefaultnamespace", + "xmlstreamwriter.setdefaultnamespace" + ], + "title": "XMLStreamWriter.setDefaultNamespace" + }, + { + "description": "Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.", + "id": "script-api:dw/io/XMLStreamWriter#setPrefix", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "uri", + "type": "string | null" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.setPrefix", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the prefix the uri is bound to. This prefix is bound\nin the scope of the current START_ELEMENT / END_ELEMENT pair.\nIf this method is called before a START_ELEMENT has been written\nthe prefix is bound in the root scope.", + "heading": "Description" + } + ], + "signature": "setPrefix(prefix: string, uri: string | null): void", + "source": "script-api", + "tags": [ + "setprefix", + "xmlstreamwriter.setprefix" + ], + "title": "XMLStreamWriter.setPrefix" + }, + { + "description": "Writes an attribute to the output stream without a prefix.", + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "localName", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an attribute to the output stream without\na prefix.", + "heading": "Description" + } + ], + "signature": "writeAttribute(localName: string, value: string): void", + "source": "script-api", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "description": "Writes an attribute to the output stream.", + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "namespaceURI", + "type": "string" + }, + { + "name": "localName", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an attribute to the output stream.", + "heading": "Description" + } + ], + "signature": "writeAttribute(prefix: string, namespaceURI: string, localName: string, value: string): void", + "source": "script-api", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "description": "Writes an attribute to the output stream.", + "id": "script-api:dw/io/XMLStreamWriter#writeAttribute", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "namespaceURI", + "type": "string" + }, + { + "name": "localName", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeAttribute", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an attribute to the output stream.", + "heading": "Description" + } + ], + "signature": "writeAttribute(namespaceURI: string, localName: string, value: string): void", + "source": "script-api", + "tags": [ + "writeattribute", + "xmlstreamwriter.writeattribute" + ], + "title": "XMLStreamWriter.writeAttribute" + }, + { + "description": "Writes a CData section.", + "id": "script-api:dw/io/XMLStreamWriter#writeCData", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "data", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeCData", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a CData section.", + "heading": "Description" + } + ], + "signature": "writeCData(data: string): void", + "source": "script-api", + "tags": [ + "writecdata", + "xmlstreamwriter.writecdata" + ], + "title": "XMLStreamWriter.writeCData" + }, + { + "description": "Write text to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeCharacters", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeCharacters", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write text to the output.", + "heading": "Description" + } + ], + "signature": "writeCharacters(text: string): void", + "source": "script-api", + "tags": [ + "writecharacters", + "xmlstreamwriter.writecharacters" + ], + "title": "XMLStreamWriter.writeCharacters" + }, + { + "description": "Writes an XML comment with the data enclosed.", + "id": "script-api:dw/io/XMLStreamWriter#writeComment", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "data", + "type": "string | null" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeComment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an XML comment with the data enclosed.", + "heading": "Description" + } + ], + "signature": "writeComment(data: string | null): void", + "source": "script-api", + "tags": [ + "writecomment", + "xmlstreamwriter.writecomment" + ], + "title": "XMLStreamWriter.writeComment" + }, + { + "description": "Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.", + "id": "script-api:dw/io/XMLStreamWriter#writeDTD", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "dtd", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeDTD", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write a DTD section. This string represents the entire doctypedecl production\nfrom the XML 1.0 specification.", + "heading": "Description" + } + ], + "signature": "writeDTD(dtd: string): void", + "source": "script-api", + "tags": [ + "writedtd", + "xmlstreamwriter.writedtd" + ], + "title": "XMLStreamWriter.writeDTD" + }, + { + "description": "Writes the default namespace to the stream.", + "id": "script-api:dw/io/XMLStreamWriter#writeDefaultNamespace", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "namespaceURI", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeDefaultNamespace", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes the default namespace to the stream.", + "heading": "Description" + } + ], + "signature": "writeDefaultNamespace(namespaceURI: string): void", + "source": "script-api", + "tags": [ + "writedefaultnamespace", + "xmlstreamwriter.writedefaultnamespace" + ], + "title": "XMLStreamWriter.writeDefaultNamespace" + }, + { + "description": "Writes an empty element tag to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "namespaceURI", + "type": "string" + }, + { + "name": "localName", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an empty element tag to the output.", + "heading": "Description" + } + ], + "signature": "writeEmptyElement(namespaceURI: string, localName: string): void", + "source": "script-api", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "description": "Writes an empty element tag to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "localName", + "type": "string" + }, + { + "name": "namespaceURI", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an empty element tag to the output.", + "heading": "Description" + } + ], + "signature": "writeEmptyElement(prefix: string, localName: string, namespaceURI: string): void", + "source": "script-api", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "description": "Writes an empty element tag to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeEmptyElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "localName", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEmptyElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an empty element tag to the output.", + "heading": "Description" + } + ], + "signature": "writeEmptyElement(localName: string): void", + "source": "script-api", + "tags": [ + "writeemptyelement", + "xmlstreamwriter.writeemptyelement" + ], + "title": "XMLStreamWriter.writeEmptyElement" + }, + { + "description": "Closes any start tags and writes corresponding end tags.", + "id": "script-api:dw/io/XMLStreamWriter#writeEndDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEndDocument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes any start tags and writes corresponding end tags.", + "heading": "Description" + } + ], + "signature": "writeEndDocument(): void", + "source": "script-api", + "tags": [ + "writeenddocument", + "xmlstreamwriter.writeenddocument" + ], + "title": "XMLStreamWriter.writeEndDocument" + }, + { + "description": "Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.", + "id": "script-api:dw/io/XMLStreamWriter#writeEndElement", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEndElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an end tag to the output relying on the internal\nstate of the writer to determine the prefix and local name\nof the event.", + "heading": "Description" + } + ], + "signature": "writeEndElement(): void", + "source": "script-api", + "tags": [ + "writeendelement", + "xmlstreamwriter.writeendelement" + ], + "title": "XMLStreamWriter.writeEndElement" + }, + { + "description": "Writes an entity reference.", + "id": "script-api:dw/io/XMLStreamWriter#writeEntityRef", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeEntityRef", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes an entity reference.", + "heading": "Description" + } + ], + "signature": "writeEntityRef(name: string): void", + "source": "script-api", + "tags": [ + "writeentityref", + "xmlstreamwriter.writeentityref" + ], + "title": "XMLStreamWriter.writeEntityRef" + }, + { + "description": "Writes a namespace to the output stream. If the prefix argument to this method is the empty string, \"xmlns\", or null this method will delegate to writeDefaultNamespace.", + "id": "script-api:dw/io/XMLStreamWriter#writeNamespace", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "namespaceURI", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeNamespace", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a namespace to the output stream.\nIf the prefix argument to this method is the empty string,\n\"xmlns\", or null this method will delegate to writeDefaultNamespace.", + "heading": "Description" + } + ], + "signature": "writeNamespace(prefix: string, namespaceURI: string): void", + "source": "script-api", + "tags": [ + "writenamespace", + "xmlstreamwriter.writenamespace" + ], + "title": "XMLStreamWriter.writeNamespace" + }, + { + "description": "Writes a processing instruction.", + "id": "script-api:dw/io/XMLStreamWriter#writeProcessingInstruction", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "target", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeProcessingInstruction", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a processing instruction.", + "heading": "Description" + } + ], + "signature": "writeProcessingInstruction(target: string): void", + "source": "script-api", + "tags": [ + "writeprocessinginstruction", + "xmlstreamwriter.writeprocessinginstruction" + ], + "title": "XMLStreamWriter.writeProcessingInstruction" + }, + { + "description": "Writes a processing instruction.", + "id": "script-api:dw/io/XMLStreamWriter#writeProcessingInstruction", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "target", + "type": "string" + }, + { + "name": "data", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeProcessingInstruction", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a processing instruction.", + "heading": "Description" + } + ], + "signature": "writeProcessingInstruction(target: string, data: string): void", + "source": "script-api", + "tags": [ + "writeprocessinginstruction", + "xmlstreamwriter.writeprocessinginstruction" + ], + "title": "XMLStreamWriter.writeProcessingInstruction" + }, + { + "description": "Writes the given string directly into the output stream. No checks regarding the correctness of the XML are done. The caller must ensure that the final result is a correct XML.", + "id": "script-api:dw/io/XMLStreamWriter#writeRaw", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "raw", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeRaw", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes the given string directly into the output stream. No checks\nregarding the correctness of the XML are done. The caller must ensure\nthat the final result is a correct XML.", + "heading": "Description" + } + ], + "signature": "writeRaw(raw: string): void", + "source": "script-api", + "tags": [ + "writeraw", + "xmlstreamwriter.writeraw" + ], + "title": "XMLStreamWriter.writeRaw" + }, + { + "description": "Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8", + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8", + "heading": "Description" + } + ], + "signature": "writeStartDocument(): void", + "source": "script-api", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "description": "Write the XML Declaration. Defaults the XML version to 1.0", + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "version", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the XML Declaration. Defaults the XML version to 1.0", + "heading": "Description" + } + ], + "signature": "writeStartDocument(version: string): void", + "source": "script-api", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "description": "Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory.", + "id": "script-api:dw/io/XMLStreamWriter#writeStartDocument", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "encoding", + "type": "string" + }, + { + "name": "version", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartDocument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Write the XML Declaration. Note that the encoding parameter does\nnot set the actual encoding of the underlying output. That must\nbe set when the instance of the XMLStreamWriter is created using the\nXMLOutputFactory.", + "heading": "Description" + } + ], + "signature": "writeStartDocument(encoding: string, version: string): void", + "source": "script-api", + "tags": [ + "writestartdocument", + "xmlstreamwriter.writestartdocument" + ], + "title": "XMLStreamWriter.writeStartDocument" + }, + { + "description": "Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.", + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "localName", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a start tag to the output. All writeStartElement methods\nopen a new scope in the internal namespace context. Writing the\ncorresponding EndElement causes the scope to be closed.", + "heading": "Description" + } + ], + "signature": "writeStartElement(localName: string): void", + "source": "script-api", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "description": "Writes a start tag to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "namespaceURI", + "type": "string" + }, + { + "name": "localName", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a start tag to the output.", + "heading": "Description" + } + ], + "signature": "writeStartElement(namespaceURI: string, localName: string): void", + "source": "script-api", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "description": "Writes a start tag to the output.", + "id": "script-api:dw/io/XMLStreamWriter#writeStartElement", + "kind": "method", + "packagePath": "dw/io", + "params": [ + { + "name": "prefix", + "type": "string" + }, + { + "name": "localName", + "type": "string" + }, + { + "name": "namespaceURI", + "type": "string" + } + ], + "parentId": "script-api:dw/io/XMLStreamWriter", + "qualifiedName": "dw.io.XMLStreamWriter.writeStartElement", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Writes a start tag to the output.", + "heading": "Description" + } + ], + "signature": "writeStartElement(prefix: string, localName: string, namespaceURI: string): void", + "source": "script-api", + "tags": [ + "writestartelement", + "xmlstreamwriter.writestartelement" + ], + "title": "XMLStreamWriter.writeStartElement" + }, + { + "description": "2 declarations", + "id": "script-api:dw/job", + "kind": "package", + "packagePath": "dw/job", + "qualifiedName": "dw.job", + "source": "script-api", + "tags": [ + "dw/job", + "dw.job" + ], + "title": "dw.job" + }, + { + "description": "Represents an execution of a job. The job execution can be accessed from a JobStepExecution via JobStepExecution.getJobExecution. If a pipeline is used to implement a step the step execution is available in the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step the step execution is available as the second parameter of the module's function that is used to execute the step, e.g.:", + "id": "script-api:dw/job/JobExecution", + "kind": "class", + "packagePath": "dw/job", + "parentId": "script-api:dw/job", + "qualifiedName": "dw.job.JobExecution", + "sections": [ + { + "body": "Represents an execution of a job. The job execution can be accessed from a JobStepExecution via\nJobStepExecution.getJobExecution. If a pipeline is used to implement a step the step execution is available\nin the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step the step\nexecution is available as the second parameter of the module's function that is used to execute the step, e.g.:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jobexecution", + "dw.job.jobexecution", + "dw/job" + ], + "title": "JobExecution" + }, + { + "description": "Returns the ID of this job execution.", + "id": "script-api:dw/job/JobExecution#ID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.ID", + "sections": [ + { + "body": "Returns the ID of this job execution.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "jobexecution.id" + ], + "title": "JobExecution.ID" + }, + { + "description": "Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the job context should only be used when necessary and with caution. If two steps which are running in parallel in the same job store data in the job context using the same key the result is undefined. Don't add any complex data to the job context since only simple data types are supported (for example, String and Integer).", + "id": "script-api:dw/job/JobExecution#context", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.context", + "sections": [ + { + "body": "Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the\njob context should only be used when necessary and with caution. If two steps which are running in parallel in\nthe same job store data in the job context using the same key the result is undefined. Don't add any complex data\nto the job context since only simple data types are supported (for example, String and Integer).", + "heading": "Description" + } + ], + "signature": "readonly context: utilMap", + "source": "script-api", + "tags": [ + "context", + "jobexecution.context" + ], + "title": "JobExecution.context" + }, + { + "description": "Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the job context should only be used when necessary and with caution. If two steps which are running in parallel in the same job store data in the job context using the same key the result is undefined. Don't add any complex data to the job context since only simple data types are supported (for example, String and Integer).", + "id": "script-api:dw/job/JobExecution#getContext", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getContext", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the\njob context should only be used when necessary and with caution. If two steps which are running in parallel in\nthe same job store data in the job context using the same key the result is undefined. Don't add any complex data\nto the job context since only simple data types are supported (for example, String and Integer).", + "heading": "Description" + } + ], + "signature": "getContext(): utilMap", + "source": "script-api", + "tags": [ + "getcontext", + "jobexecution.getcontext" + ], + "title": "JobExecution.getContext" + }, + { + "description": "Returns the ID of this job execution.", + "id": "script-api:dw/job/JobExecution#getID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this job execution.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "jobexecution.getid" + ], + "title": "JobExecution.getID" + }, + { + "description": "Returns the ID of the job this job execution belongs to.", + "id": "script-api:dw/job/JobExecution#getJobID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.getJobID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the job this job execution belongs to.", + "heading": "Description" + } + ], + "signature": "getJobID(): string", + "source": "script-api", + "tags": [ + "getjobid", + "jobexecution.getjobid" + ], + "title": "JobExecution.getJobID" + }, + { + "description": "Returns the ID of the job this job execution belongs to.", + "id": "script-api:dw/job/JobExecution#jobID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobExecution", + "qualifiedName": "dw.job.JobExecution.jobID", + "sections": [ + { + "body": "Returns the ID of the job this job execution belongs to.", + "heading": "Description" + } + ], + "signature": "readonly jobID: string", + "source": "script-api", + "tags": [ + "jobid", + "jobexecution.jobid" + ], + "title": "JobExecution.jobID" + }, + { + "description": "Represents an execution of a step that belongs to a job. The job execution this step execution belongs to can be accessed via getJobExecution. If a pipeline is used to implement a step this step execution is available in the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step this step execution is available as the second parameter of the module's function that is used to execute the step, e.g.:", + "id": "script-api:dw/job/JobStepExecution", + "kind": "class", + "packagePath": "dw/job", + "parentId": "script-api:dw/job", + "qualifiedName": "dw.job.JobStepExecution", + "sections": [ + { + "body": "Represents an execution of a step that belongs to a job. The job execution this step execution belongs to can be\naccessed via getJobExecution. If a pipeline is used to implement a step this step execution is available\nin the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step this step\nexecution is available as the second parameter of the module's function that is used to execute the step, e.g.:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jobstepexecution", + "dw.job.jobstepexecution", + "dw/job" + ], + "title": "JobStepExecution" + }, + { + "description": "Returns the ID of this step execution.", + "id": "script-api:dw/job/JobStepExecution#ID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.ID", + "sections": [ + { + "body": "Returns the ID of this step execution.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "jobstepexecution.id" + ], + "title": "JobStepExecution.ID" + }, + { + "description": "Returns the ID of this step execution.", + "id": "script-api:dw/job/JobStepExecution#getID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this step execution.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "jobstepexecution.getid" + ], + "title": "JobStepExecution.getID" + }, + { + "description": "Returns the job execution this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#getJobExecution", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getJobExecution", + "returns": { + "type": "JobExecution" + }, + "sections": [ + { + "body": "Returns the job execution this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "getJobExecution(): JobExecution", + "source": "script-api", + "tags": [ + "getjobexecution", + "jobstepexecution.getjobexecution" + ], + "title": "JobStepExecution.getJobExecution" + }, + { + "description": "Returns the value of the parameter of the step this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#getParameterValue", + "kind": "method", + "packagePath": "dw/job", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getParameterValue", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the value of the parameter of the step this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "getParameterValue(name: string): any", + "source": "script-api", + "tags": [ + "getparametervalue", + "jobstepexecution.getparametervalue" + ], + "title": "JobStepExecution.getParameterValue" + }, + { + "description": "Returns the ID of the step this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#getStepID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getStepID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the step this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "getStepID(): string", + "source": "script-api", + "tags": [ + "getstepid", + "jobstepexecution.getstepid" + ], + "title": "JobStepExecution.getStepID" + }, + { + "description": "Returns the ID of the step type of the step this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#getStepTypeID", + "kind": "method", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.getStepTypeID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the step type of the step this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "getStepTypeID(): string", + "source": "script-api", + "tags": [ + "getsteptypeid", + "jobstepexecution.getsteptypeid" + ], + "title": "JobStepExecution.getStepTypeID" + }, + { + "description": "Returns the job execution this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#jobExecution", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.jobExecution", + "sections": [ + { + "body": "Returns the job execution this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "readonly jobExecution: JobExecution", + "source": "script-api", + "tags": [ + "jobexecution", + "jobstepexecution.jobexecution" + ], + "title": "JobStepExecution.jobExecution" + }, + { + "description": "Returns the ID of the step this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#stepID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.stepID", + "sections": [ + { + "body": "Returns the ID of the step this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "readonly stepID: string", + "source": "script-api", + "tags": [ + "stepid", + "jobstepexecution.stepid" + ], + "title": "JobStepExecution.stepID" + }, + { + "description": "Returns the ID of the step type of the step this step execution belongs to.", + "id": "script-api:dw/job/JobStepExecution#stepTypeID", + "kind": "property", + "packagePath": "dw/job", + "parentId": "script-api:dw/job/JobStepExecution", + "qualifiedName": "dw.job.JobStepExecution.stepTypeID", + "sections": [ + { + "body": "Returns the ID of the step type of the step this step execution belongs to.", + "heading": "Description" + } + ], + "signature": "readonly stepTypeID: string", + "source": "script-api", + "tags": [ + "steptypeid", + "jobstepexecution.steptypeid" + ], + "title": "JobStepExecution.stepTypeID" + }, + { + "description": "10 declarations", + "id": "script-api:dw/net", + "kind": "package", + "packagePath": "dw/net", + "qualifiedName": "dw.net", + "source": "script-api", + "tags": [ + "dw/net", + "dw.net" + ], + "title": "dw.net" + }, + { + "deprecated": { + "message": "The FTPClient is deprecated. Use SFTPClient for a secure alternative." + }, + "description": "The FTPClient class supports the FTP commands CD, GET, PUT, DEL, MKDIR, RENAME, and LIST. The FTP connection is established using passive transfer mode (PASV). The transfer of files can be text or binary.", + "examples": [ + "`\nvar ftp : FTPClient = new dw.net.FTPClient();\nftp.connect(\"my.ftp-server.com\", \"username\", \"password\");\nvar data : String = ftp.get(\"simple.txt\");\nftp.disconnect();\n`" + ], + "id": "script-api:dw/net/FTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.FTPClient", + "sections": [ + { + "body": "The FTPClient class supports the FTP commands CD, GET, PUT, DEL, MKDIR, RENAME, and LIST. The FTP connection is\nestablished using passive transfer mode (PASV). The transfer of files can be text or binary.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.\n\nAn example usage is as follows:\n\n\nThe default connection timeout depends on the script context timeout and will be set to a maximum of 30 seconds\n(default script context timeout is 10 seconds within storefront requests and 15 minutes within jobs).\n\nIMPORTANT NOTE: Before you can make an outbound FTP connection, the FTP server IP address must be enabled for\noutbound traffic at the Commerce Cloud Digital firewall for your POD. Please file a support request to request a new firewall\nrule.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "ftpclient", + "dw.net.ftpclient", + "dw/net" + ], + "title": "FTPClient" + }, + { + "deprecated": { + "message": "The default size is not supported anymore. The `get()` methods returning a file will\nalways try to return MAX_GET_FILE_SIZE bytes instead." + }, + "description": "The default size for `get()` returning a File is 5MB", + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a File is 5MB", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE = 5242880", + "source": "script-api", + "tags": [ + "default_get_file_size", + "ftpclient.default_get_file_size" + ], + "title": "FTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "deprecated": { + "message": "The default size is not supported anymore. The `get()` methods returning a file will\nalways try to return MAX_GET_FILE_SIZE bytes instead." + }, + "description": "The default size for `get()` returning a File is 5MB", + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a File is 5MB", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE = 5242880", + "source": "script-api", + "tags": [ + "default_get_file_size", + "ftpclient.default_get_file_size" + ], + "title": "FTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "deprecated": { + "message": "The default size is not supported anymore. The `get()` methods returning a String will\nalways try to return MAX_GET_STRING_SIZE bytes instead." + }, + "description": "The default size for `get()` returning a String is 2MB", + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_STRING_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a String is 2MB", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_STRING_SIZE = 2097152", + "source": "script-api", + "tags": [ + "default_get_string_size", + "ftpclient.default_get_string_size" + ], + "title": "FTPClient.DEFAULT_GET_STRING_SIZE" + }, + { + "deprecated": { + "message": "The default size is not supported anymore. The `get()` methods returning a String will\nalways try to return MAX_GET_STRING_SIZE bytes instead." + }, + "description": "The default size for `get()` returning a String is 2MB", + "id": "script-api:dw/net/FTPClient#DEFAULT_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.DEFAULT_GET_STRING_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a String is 2MB", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_STRING_SIZE = 2097152", + "source": "script-api", + "tags": [ + "default_get_string_size", + "ftpclient.default_get_string_size" + ], + "title": "FTPClient.DEFAULT_GET_STRING_SIZE" + }, + { + "description": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The largest file allowed is 200MB.", + "id": "script-api:dw/net/FTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The\nlargest file allowed is 200MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE = 209715200", + "source": "script-api", + "tags": [ + "max_get_file_size", + "ftpclient.max_get_file_size" + ], + "title": "FTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The largest file allowed is 200MB.", + "id": "script-api:dw/net/FTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The\nlargest file allowed is 200MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE = 209715200", + "source": "script-api", + "tags": [ + "max_get_file_size", + "ftpclient.max_get_file_size" + ], + "title": "FTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for `get()` returning a String is five times the default size for getting a String. The largest String allowed is 10MB.", + "id": "script-api:dw/net/FTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a String is five times the default size for getting a String.\nThe largest String allowed is 10MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE = 10485760", + "source": "script-api", + "tags": [ + "max_get_string_size", + "ftpclient.max_get_string_size" + ], + "title": "FTPClient.MAX_GET_STRING_SIZE" + }, + { + "description": "The maximum size for `get()` returning a String is five times the default size for getting a String. The largest String allowed is 10MB.", + "id": "script-api:dw/net/FTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a String is five times the default size for getting a String.\nThe largest String allowed is 10MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE = 10485760", + "source": "script-api", + "tags": [ + "max_get_string_size", + "ftpclient.max_get_string_size" + ], + "title": "FTPClient.MAX_GET_STRING_SIZE" + }, + { + "description": "Changes the current directory on the remote server to the given path.", + "id": "script-api:dw/net/FTPClient#cd", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.cd", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Changes the current directory on the remote server to the given path.", + "heading": "Description" + } + ], + "signature": "cd(path: string): boolean", + "source": "script-api", + "tags": [ + "cd", + "ftpclient.cd" + ], + "title": "FTPClient.cd" + }, + { + "description": "Connects and logs on to an FTP Server as \"anonymous\" and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to an FTP Server as \"anonymous\" and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string): boolean", + "source": "script-api", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "description": "Connects and logs on to an FTP server and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to an FTP server and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string, user: string, password: string): boolean", + "source": "script-api", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "description": "Connects and logs on to an FTP Server as \"anonymous\" and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + }, + { + "name": "port", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to an FTP Server as \"anonymous\" and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string, port: number): boolean", + "source": "script-api", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "description": "Connects and logs on to an FTP server and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/FTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + }, + { + "name": "port", + "type": "number" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to an FTP server and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string, port: number, user: string, password: string): boolean", + "source": "script-api", + "tags": [ + "connect", + "ftpclient.connect" + ], + "title": "FTPClient.connect" + }, + { + "description": "Identifies if the FTP client is currently connected to the FTP server.", + "id": "script-api:dw/net/FTPClient#connected", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.connected", + "sections": [ + { + "body": "Identifies if the FTP client is currently connected to the FTP server.", + "heading": "Description" + } + ], + "signature": "readonly connected: boolean", + "source": "script-api", + "tags": [ + "connected", + "ftpclient.connected" + ], + "title": "FTPClient.connected" + }, + { + "description": "Deletes the remote file on the server identified by the path parameter.", + "id": "script-api:dw/net/FTPClient#del", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.del", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes the remote file on the server identified by the path parameter.", + "heading": "Description" + } + ], + "signature": "del(path: string): boolean", + "source": "script-api", + "tags": [ + "del", + "ftpclient.del" + ], + "title": "FTPClient.del" + }, + { + "description": "The method first logs the current user out from the server and then disconnects from the server.", + "id": "script-api:dw/net/FTPClient#disconnect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.disconnect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method first logs the current user out from the server and then disconnects from the server.", + "heading": "Description" + } + ], + "signature": "disconnect(): void", + "source": "script-api", + "tags": [ + "disconnect", + "ftpclient.disconnect" + ], + "title": "FTPClient.disconnect" + }, + { + "description": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Read at most MAX_GET_STRING_SIZE bytes.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Read at\nmost MAX_GET_STRING_SIZE bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string): string | null", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "description": "Reads the content of a remote file and returns it as string using the passed encoding. Read at most MAX_GET_STRING_SIZE characters.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as string using the passed encoding. Read at most\nMAX_GET_STRING_SIZE characters.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string): string | null", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "deprecated": { + "message": "The maxGetSize attribute is not supported anymore. Use the method get instead." + }, + "description": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Read at most maxGetSize characters.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "maxGetSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Read at\nmost maxGetSize characters.", + "heading": "Description" + } + ], + "signature": "get(path: string, maxGetSize: number): string | null", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "deprecated": { + "message": "The maxGetSize attribute is not supported anymore. Use the method get\ninstead." + }, + "description": "Reads the content of a remote file and returns it as a string using the specified encoding. Returns at most maxGetSize characters.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "maxGetSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as a string using the specified encoding. Returns at most\nmaxGetSize characters.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string, maxGetSize: number): string | null", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "description": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to read the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most MAX_GET_FILE_SIZE bytes.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to\nread the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most\nMAX_GET_FILE_SIZE bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string, file: File): boolean", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "deprecated": { + "message": "The maxGetSize attribute is not supported anymore. Use the method get\ninstead." + }, + "description": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to read the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most maxGetSize bytes.", + "id": "script-api:dw/net/FTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "file", + "type": "File" + }, + { + "name": "maxGetSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to\nread the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most maxGetSize\nbytes.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string, file: File, maxGetSize: number): boolean", + "source": "script-api", + "tags": [ + "get", + "ftpclient.get" + ], + "title": "FTPClient.get" + }, + { + "description": "Reads the content of a remote file and creates a local copy in the given file. Copies at most MAX_GET_FILE_SIZE bytes. The FTP transfer is done in Binary mode.", + "id": "script-api:dw/net/FTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file. Copies at most MAX_GET_FILE_SIZE\nbytes. The FTP transfer is done in Binary mode.", + "heading": "Description" + } + ], + "signature": "getBinary(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "getbinary", + "ftpclient.getbinary" + ], + "title": "FTPClient.getBinary" + }, + { + "deprecated": { + "message": "The maxGetSize attribute is not supported anymore. Use the method getBinary\ninstead." + }, + "description": "Reads the content of a remote file and creates a local copy in the given file. Copies at most maxGetSize bytes. The FTP transfer is done in Binary mode.", + "id": "script-api:dw/net/FTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + }, + { + "name": "maxGetSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file. Copies at most maxGetSize bytes.\nThe FTP transfer is done in Binary mode.", + "heading": "Description" + } + ], + "signature": "getBinary(path: string, file: File, maxGetSize: number): boolean", + "source": "script-api", + "tags": [ + "getbinary", + "ftpclient.getbinary" + ], + "title": "FTPClient.getBinary" + }, + { + "description": "Identifies if the FTP client is currently connected to the FTP server.", + "id": "script-api:dw/net/FTPClient#getConnected", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getConnected", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the FTP client is currently connected to the FTP server.", + "heading": "Description" + } + ], + "signature": "getConnected(): boolean", + "source": "script-api", + "tags": [ + "getconnected", + "ftpclient.getconnected" + ], + "title": "FTPClient.getConnected" + }, + { + "description": "Returns the reply code from the last FTP action.", + "id": "script-api:dw/net/FTPClient#getReplyCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getReplyCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the reply code from the last FTP action.", + "heading": "Description" + } + ], + "signature": "getReplyCode(): number", + "source": "script-api", + "tags": [ + "getreplycode", + "ftpclient.getreplycode" + ], + "title": "FTPClient.getReplyCode" + }, + { + "description": "Returns the string message from the last FTP action.", + "id": "script-api:dw/net/FTPClient#getReplyMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getReplyMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the string message from the last FTP action.", + "heading": "Description" + } + ], + "signature": "getReplyMessage(): string", + "source": "script-api", + "tags": [ + "getreplymessage", + "ftpclient.getreplymessage" + ], + "title": "FTPClient.getReplyMessage" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/FTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.getTimeout", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "getTimeout(): number", + "source": "script-api", + "tags": [ + "gettimeout", + "ftpclient.gettimeout" + ], + "title": "FTPClient.getTimeout" + }, + { + "description": "Returns a list of FTPFileInfo objects containing information about the files in the current directory.", + "id": "script-api:dw/net/FTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.list", + "returns": { + "type": "FTPFileInfo[]" + }, + "sections": [ + { + "body": "Returns a list of FTPFileInfo objects containing information about the files in the current directory.", + "heading": "Description" + } + ], + "signature": "list(): FTPFileInfo[]", + "source": "script-api", + "tags": [ + "list", + "ftpclient.list" + ], + "title": "FTPClient.list" + }, + { + "description": "Returns a list of FTPFileInfo objects containing information about the files in the remote directory defined by the given path.", + "id": "script-api:dw/net/FTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.list", + "returns": { + "type": "FTPFileInfo[]" + }, + "sections": [ + { + "body": "Returns a list of FTPFileInfo objects containing information about the files in the remote directory defined by\nthe given path.", + "heading": "Description" + } + ], + "signature": "list(path: string): FTPFileInfo[]", + "source": "script-api", + "tags": [ + "list", + "ftpclient.list" + ], + "title": "FTPClient.list" + }, + { + "description": "Creates a directory", + "id": "script-api:dw/net/FTPClient#mkdir", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.mkdir", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Creates a directory", + "heading": "Description" + } + ], + "signature": "mkdir(path: string): boolean", + "source": "script-api", + "tags": [ + "mkdir", + "ftpclient.mkdir" + ], + "title": "FTPClient.mkdir" + }, + { + "description": "Puts the specified content to the specified full path using \"ISO-8859-1\" encoding. The full path must include the path and the file name. If the content of a local file is to be uploaded, please use method putBinary instead.", + "id": "script-api:dw/net/FTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Puts the specified content to the specified full path using \"ISO-8859-1\" encoding. The full path must include the\npath and the file name. If the content of a local file is to be uploaded, please use method\nputBinary instead.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string): boolean", + "source": "script-api", + "tags": [ + "put", + "ftpclient.put" + ], + "title": "FTPClient.put" + }, + { + "description": "Put the given content to a file on the given full path on the FTP server. The full path must include the path and the file name. The transformation from String into binary data is done via the encoding provided with the method call. If the content of a local file is to be uploaded, please use method putBinary instead.", + "id": "script-api:dw/net/FTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Put the given content to a file on the given full path on the FTP server. The full path must include the path and\nthe file name. The transformation from String into binary data is done via the encoding provided with the method\ncall. If the content of a local file is to be uploaded, please use method putBinary\ninstead.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string, encoding: string): boolean", + "source": "script-api", + "tags": [ + "put", + "ftpclient.put" + ], + "title": "FTPClient.put" + }, + { + "description": "Put the content of the given file into a file on the remote FTP server with the given full path. The full path must include the path and the file name.", + "id": "script-api:dw/net/FTPClient#putBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.putBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Put the content of the given file into a file on the remote FTP server with the given full path. The full path\nmust include the path and the file name.", + "heading": "Description" + } + ], + "signature": "putBinary(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "putbinary", + "ftpclient.putbinary" + ], + "title": "FTPClient.putBinary" + }, + { + "description": "Deletes the remote directory on the server identified by the path parameter. In order to delete the directory successfully the directory needs to be empty, otherwise the removeDirectory() method will return false.", + "id": "script-api:dw/net/FTPClient#removeDirectory", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.removeDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes the remote directory on the server identified by the path parameter. In order to delete the directory\nsuccessfully the directory needs to be empty, otherwise the removeDirectory() method will return false.", + "heading": "Description" + } + ], + "signature": "removeDirectory(path: string): boolean", + "source": "script-api", + "tags": [ + "removedirectory", + "ftpclient.removedirectory" + ], + "title": "FTPClient.removeDirectory" + }, + { + "description": "Renames an existing file.", + "id": "script-api:dw/net/FTPClient#rename", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "from", + "type": "string" + }, + { + "name": "to", + "type": "string" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.rename", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Renames an existing file.", + "heading": "Description" + } + ], + "signature": "rename(from: string, to: string): boolean", + "source": "script-api", + "tags": [ + "rename", + "ftpclient.rename" + ], + "title": "FTPClient.rename" + }, + { + "description": "Returns the reply code from the last FTP action.", + "id": "script-api:dw/net/FTPClient#replyCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.replyCode", + "sections": [ + { + "body": "Returns the reply code from the last FTP action.", + "heading": "Description" + } + ], + "signature": "readonly replyCode: number", + "source": "script-api", + "tags": [ + "replycode", + "ftpclient.replycode" + ], + "title": "FTPClient.replyCode" + }, + { + "description": "Returns the string message from the last FTP action.", + "id": "script-api:dw/net/FTPClient#replyMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.replyMessage", + "sections": [ + { + "body": "Returns the string message from the last FTP action.", + "heading": "Description" + } + ], + "signature": "readonly replyMessage: string", + "source": "script-api", + "tags": [ + "replymessage", + "ftpclient.replymessage" + ], + "title": "FTPClient.replyMessage" + }, + { + "description": "Sets the timeout for connections made with the FTP client to the given number of milliseconds. If the given timeout is less than or equal to zero, the timeout is set to the same value as the script context timeout but will only be set to a maximum of 30 seconds.", + "id": "script-api:dw/net/FTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "timeoutMillis", + "type": "number" + } + ], + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.setTimeout", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the timeout for connections made with the FTP client to the given number of milliseconds. If the given\ntimeout is less than or equal to zero, the timeout is set to the same value as the script context timeout but\nwill only be set to a maximum of 30 seconds.\n\nThe maximum and default timeout depend on the script context timeout. The maximum timeout is set to a maximum of\n2 minutes. The default timeout for a new client is set to a maximum of 30 seconds.\n\nThis method can be called at any time, and will affect the next connection made with this client. It is not\npossible to set the timeout for an open connection.", + "heading": "Description" + } + ], + "signature": "setTimeout(timeoutMillis: number): void", + "source": "script-api", + "tags": [ + "settimeout", + "ftpclient.settimeout" + ], + "title": "FTPClient.setTimeout" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/FTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPClient", + "qualifiedName": "dw.net.FTPClient.timeout", + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "timeout: number", + "source": "script-api", + "tags": [ + "timeout", + "ftpclient.timeout" + ], + "title": "FTPClient.timeout" + }, + { + "deprecated": { + "message": "The FTPClient is deprecated. Use SFTPClient for a secure alternative." + }, + "description": "The class is used to store information about a remote file.", + "id": "script-api:dw/net/FTPFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.FTPFileInfo", + "sections": [ + { + "body": "The class is used to store information about a remote file.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "ftpfileinfo", + "dw.net.ftpfileinfo", + "dw/net" + ], + "title": "FTPFileInfo" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/FTPFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.directory", + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "readonly directory: boolean", + "source": "script-api", + "tags": [ + "directory", + "ftpfileinfo.directory" + ], + "title": "FTPFileInfo.directory" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/FTPFileInfo#getDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "getDirectory(): boolean", + "source": "script-api", + "tags": [ + "getdirectory", + "ftpfileinfo.getdirectory" + ], + "title": "FTPFileInfo.getDirectory" + }, + { + "description": "Returns the name of the file.", + "id": "script-api:dw/net/FTPFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the file.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "ftpfileinfo.getname" + ], + "title": "FTPFileInfo.getName" + }, + { + "description": "Returns the size of the file.", + "id": "script-api:dw/net/FTPFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getSize", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the file.", + "heading": "Description" + } + ], + "signature": "getSize(): number", + "source": "script-api", + "tags": [ + "getsize", + "ftpfileinfo.getsize" + ], + "title": "FTPFileInfo.getSize" + }, + { + "description": "Returns the timestamp of the file.", + "id": "script-api:dw/net/FTPFileInfo#getTimestamp", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.getTimestamp", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the timestamp of the file.", + "heading": "Description" + } + ], + "signature": "getTimestamp(): Date", + "source": "script-api", + "tags": [ + "gettimestamp", + "ftpfileinfo.gettimestamp" + ], + "title": "FTPFileInfo.getTimestamp" + }, + { + "description": "Returns the name of the file.", + "id": "script-api:dw/net/FTPFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.name", + "sections": [ + { + "body": "Returns the name of the file.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "ftpfileinfo.name" + ], + "title": "FTPFileInfo.name" + }, + { + "description": "Returns the size of the file.", + "id": "script-api:dw/net/FTPFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.size", + "sections": [ + { + "body": "Returns the size of the file.", + "heading": "Description" + } + ], + "signature": "readonly size: number", + "source": "script-api", + "tags": [ + "size", + "ftpfileinfo.size" + ], + "title": "FTPFileInfo.size" + }, + { + "description": "Returns the timestamp of the file.", + "id": "script-api:dw/net/FTPFileInfo#timestamp", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/FTPFileInfo", + "qualifiedName": "dw.net.FTPFileInfo.timestamp", + "sections": [ + { + "body": "Returns the timestamp of the file.", + "heading": "Description" + } + ], + "signature": "readonly timestamp: Date", + "source": "script-api", + "tags": [ + "timestamp", + "ftpfileinfo.timestamp" + ], + "title": "FTPFileInfo.timestamp" + }, + { + "description": "The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE. If a secure connection via HTTPS is established the used server certificate or the signing CAs certificate needs to be imported into the customer key store via Business Manager. Note: when this class is used with sensitive data, be careful in persisting sensitive information.", + "id": "script-api:dw/net/HTTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPClient", + "sections": [ + { + "body": "The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE.\nIf a secure connection via HTTPS is\nestablished the used server certificate or the signing CAs certificate needs to be imported into the customer key\nstore via Business Manager. Note: when this class is used with sensitive data, be careful in persisting\nsensitive information.\n\nKey selection for mutual TLS:\n\n- Check if there is an explicit identity requested dw.net.HTTPClient.setIdentity\n- Else, Check if there is a mapping for hostname in the keystore\n- Deprecated: Select an arbitrary private key from the keystore", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "httpclient", + "dw.net.httpclient", + "dw/net" + ], + "title": "HTTPClient" + }, + { + "deprecated": { + "message": "Use MAX_GET_FILE_SIZE instead." + }, + "description": "The default size for `sendAndReceiveToFile()` returning a File is 5MB deprecated in favor of MAX_GET_FILE_SIZE", + "id": "script-api:dw/net/HTTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `sendAndReceiveToFile()` returning a File is 5MB deprecated in favor of\nMAX_GET_FILE_SIZE", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_file_size", + "httpclient.default_get_file_size" + ], + "title": "HTTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "deprecated": { + "message": "Use MAX_GET_FILE_SIZE instead." + }, + "description": "The default size for `sendAndReceiveToFile()` returning a File is 5MB deprecated in favor of MAX_GET_FILE_SIZE", + "id": "script-api:dw/net/HTTPClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `sendAndReceiveToFile()` returning a File is 5MB deprecated in favor of\nMAX_GET_FILE_SIZE", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_file_size", + "httpclient.default_get_file_size" + ], + "title": "HTTPClient.DEFAULT_GET_FILE_SIZE" + }, + { + "description": "The maximum permitted size (in bytes) of an HTTP response when calling operations which write the response to file. (200MB)", + "id": "script-api:dw/net/HTTPClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum permitted size (in bytes) of an HTTP response when calling operations which write the response to\nfile. (200MB)", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_file_size", + "httpclient.max_get_file_size" + ], + "title": "HTTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum permitted size (in bytes) of an HTTP response when calling operations which write the response to file. (200MB)", + "id": "script-api:dw/net/HTTPClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum permitted size (in bytes) of an HTTP response when calling operations which write the response to\nfile. (200MB)", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_file_size", + "httpclient.max_get_file_size" + ], + "title": "HTTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum permitted size (in bytes) of an HTTP response when calling operations which store the response in memory. (10MB)", + "id": "script-api:dw/net/HTTPClient#MAX_GET_MEM_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_MEM_SIZE", + "sections": [ + { + "body": "The maximum permitted size (in bytes) of an HTTP response when calling operations which store the response in\nmemory. (10MB)", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_MEM_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_mem_size", + "httpclient.max_get_mem_size" + ], + "title": "HTTPClient.MAX_GET_MEM_SIZE" + }, + { + "description": "The maximum permitted size (in bytes) of an HTTP response when calling operations which store the response in memory. (10MB)", + "id": "script-api:dw/net/HTTPClient#MAX_GET_MEM_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.MAX_GET_MEM_SIZE", + "sections": [ + { + "body": "The maximum permitted size (in bytes) of an HTTP response when calling operations which store the response in\nmemory. (10MB)", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_MEM_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_mem_size", + "httpclient.max_get_mem_size" + ], + "title": "HTTPClient.MAX_GET_MEM_SIZE" + }, + { + "deprecated": { + "message": "Use getResponseHeaders instead." + }, + "description": "Returns all response headers as a map containing the name and value of the response header.", + "id": "script-api:dw/net/HTTPClient#allResponseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.allResponseHeaders", + "sections": [ + { + "body": "Returns all response headers as a map containing the name and value of the response header.", + "heading": "Description" + } + ], + "signature": "readonly allResponseHeaders: HashMap", + "source": "script-api", + "tags": [ + "allresponseheaders", + "httpclient.allresponseheaders" + ], + "title": "HTTPClient.allResponseHeaders" + }, + { + "description": "Determines whether redirect handling is enabled.", + "id": "script-api:dw/net/HTTPClient#allowRedirect", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.allowRedirect", + "sections": [ + { + "body": "Determines whether redirect handling is enabled.", + "heading": "Description" + } + ], + "signature": "allowRedirect: boolean", + "source": "script-api", + "tags": [ + "allowredirect", + "httpclient.allowredirect" + ], + "title": "HTTPClient.allowRedirect" + }, + { + "description": "Returns the bytes in the message body for HTTP status codes between 200 and 299.", + "id": "script-api:dw/net/HTTPClient#bytes", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.bytes", + "sections": [ + { + "body": "Returns the bytes in the message body for HTTP status codes between 200 and 299.", + "heading": "Description" + } + ], + "signature": "readonly bytes: Bytes", + "source": "script-api", + "tags": [ + "bytes", + "httpclient.bytes" + ], + "title": "HTTPClient.bytes" + }, + { + "description": "Calling this method enables caching for GET requests.", + "id": "script-api:dw/net/HTTPClient#enableCaching", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "ttl", + "type": "number" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.enableCaching", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Calling this method enables caching for GET requests.\n\nIt basically means that a response is cached, and before making a request the HTTP client looks into the cache to\ndetermine whether the response is already available. Only responses with a status code of 2xx, with a content\nlength, with a size less than 50k, and which are not intended to be immediately written to a file are cached.\n\nThe provided parameter defines the TTL (time to live) for the cached content. A value of 0 disables caching. The\nURL and the username are used as cache keys. The total size of the cacheable content and the number of cached\nitems is limited and automatically managed by the system. Cache control information send by the remote server is\nignored. Caching HTTP responses should be done very carefully. It is important to ensure that the response really\ndepends only on the URL and doesn't contain any remote state information or time information which is independent\nof the URL. It is also important to verify that the application sends exactly the same URL multiple times.", + "heading": "Description" + } + ], + "signature": "enableCaching(ttl: number): void", + "source": "script-api", + "tags": [ + "enablecaching", + "httpclient.enablecaching" + ], + "title": "HTTPClient.enableCaching" + }, + { + "description": "Returns the returned message body as bytes for HTTP status code greater or equal to 400. Error messages are not written to the response file.", + "id": "script-api:dw/net/HTTPClient#errorBytes", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.errorBytes", + "sections": [ + { + "body": "Returns the returned message body as bytes for HTTP status code greater or equal to 400. Error messages are not\nwritten to the response file.", + "heading": "Description" + } + ], + "signature": "readonly errorBytes: Bytes", + "source": "script-api", + "tags": [ + "errorbytes", + "httpclient.errorbytes" + ], + "title": "HTTPClient.errorBytes" + }, + { + "description": "Returns the returned message body as text for HTTP status code greater or equal to 400. Error messages are not written to the response file.", + "id": "script-api:dw/net/HTTPClient#errorText", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.errorText", + "sections": [ + { + "body": "Returns the returned message body as text for HTTP status code greater or equal to 400. Error messages are not\nwritten to the response file.", + "heading": "Description" + } + ], + "signature": "readonly errorText: string", + "source": "script-api", + "tags": [ + "errortext", + "httpclient.errortext" + ], + "title": "HTTPClient.errorText" + }, + { + "deprecated": { + "message": "Use getResponseHeaders instead." + }, + "description": "Returns all response headers as a map containing the name and value of the response header.", + "id": "script-api:dw/net/HTTPClient#getAllResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getAllResponseHeaders", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns all response headers as a map containing the name and value of the response header.", + "heading": "Description" + } + ], + "signature": "getAllResponseHeaders(): HashMap", + "source": "script-api", + "tags": [ + "getallresponseheaders", + "httpclient.getallresponseheaders" + ], + "title": "HTTPClient.getAllResponseHeaders" + }, + { + "description": "Determines whether redirect handling is enabled.", + "id": "script-api:dw/net/HTTPClient#getAllowRedirect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getAllowRedirect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines whether redirect handling is enabled.", + "heading": "Description" + } + ], + "signature": "getAllowRedirect(): boolean", + "source": "script-api", + "tags": [ + "getallowredirect", + "httpclient.getallowredirect" + ], + "title": "HTTPClient.getAllowRedirect" + }, + { + "description": "Returns the bytes in the message body for HTTP status codes between 200 and 299.", + "id": "script-api:dw/net/HTTPClient#getBytes", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Returns the bytes in the message body for HTTP status codes between 200 and 299.", + "heading": "Description" + } + ], + "signature": "getBytes(): Bytes", + "source": "script-api", + "tags": [ + "getbytes", + "httpclient.getbytes" + ], + "title": "HTTPClient.getBytes" + }, + { + "description": "Returns the returned message body as bytes for HTTP status code greater or equal to 400. Error messages are not written to the response file.", + "id": "script-api:dw/net/HTTPClient#getErrorBytes", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getErrorBytes", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Returns the returned message body as bytes for HTTP status code greater or equal to 400. Error messages are not\nwritten to the response file.", + "heading": "Description" + } + ], + "signature": "getErrorBytes(): Bytes", + "source": "script-api", + "tags": [ + "geterrorbytes", + "httpclient.geterrorbytes" + ], + "title": "HTTPClient.getErrorBytes" + }, + { + "description": "Returns the returned message body as text for HTTP status code greater or equal to 400. Error messages are not written to the response file.", + "id": "script-api:dw/net/HTTPClient#getErrorText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getErrorText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the returned message body as text for HTTP status code greater or equal to 400. Error messages are not\nwritten to the response file.", + "heading": "Description" + } + ], + "signature": "getErrorText(): string", + "source": "script-api", + "tags": [ + "geterrortext", + "httpclient.geterrortext" + ], + "title": "HTTPClient.getErrorText" + }, + { + "description": "Determines whether host name verification is enabled.", + "id": "script-api:dw/net/HTTPClient#getHostNameVerification", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getHostNameVerification", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines whether host name verification is enabled.", + "heading": "Description" + } + ], + "signature": "getHostNameVerification(): boolean", + "source": "script-api", + "tags": [ + "gethostnameverification", + "httpclient.gethostnameverification" + ], + "title": "HTTPClient.getHostNameVerification" + }, + { + "description": "Gets the identity used for mutual TLS (mTLS).", + "id": "script-api:dw/net/HTTPClient#getIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getIdentity", + "returns": { + "type": "KeyRef | null" + }, + "sections": [ + { + "body": "Gets the identity used for mutual TLS (mTLS).", + "heading": "Description" + } + ], + "signature": "getIdentity(): KeyRef | null", + "source": "script-api", + "tags": [ + "getidentity", + "httpclient.getidentity" + ], + "title": "HTTPClient.getIdentity" + }, + { + "description": "Gets the logging configuration for this HTTP client.", + "id": "script-api:dw/net/HTTPClient#getLoggingConfig", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getLoggingConfig", + "returns": { + "type": "HTTPClientLoggingConfig" + }, + "sections": [ + { + "body": "Gets the logging configuration for this HTTP client.", + "heading": "Description" + } + ], + "signature": "getLoggingConfig(): HTTPClientLoggingConfig", + "source": "script-api", + "tags": [ + "getloggingconfig", + "httpclient.getloggingconfig" + ], + "title": "HTTPClient.getLoggingConfig" + }, + { + "description": "Returns a specific response header from the last HTTP operation. The method returns null if the specific header was not returned.", + "id": "script-api:dw/net/HTTPClient#getResponseHeader", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "header", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeader", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns a specific response header from the last HTTP operation. The method returns null if the specific header\nwas not returned.", + "heading": "Description" + } + ], + "signature": "getResponseHeader(header: string): string | null", + "source": "script-api", + "tags": [ + "getresponseheader", + "httpclient.getresponseheader" + ], + "title": "HTTPClient.getResponseHeader" + }, + { + "description": "Returns all the values of a response header from the last HTTP operation as a list of strings. This reflects the fact that a specific header, e.g. `\"Set-Cookie\"`, may be set multiple times. In case there is no such header, the method returns an empty list.", + "id": "script-api:dw/net/HTTPClient#getResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeaders", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all the values of a response header from the last HTTP operation as a list of strings. This reflects the\nfact that a specific header, e.g. `\"Set-Cookie\"`, may be set multiple times. In case there is no such\nheader, the method returns an empty list.", + "heading": "Description" + } + ], + "signature": "getResponseHeaders(name: string): List", + "source": "script-api", + "tags": [ + "getresponseheaders", + "httpclient.getresponseheaders" + ], + "title": "HTTPClient.getResponseHeaders" + }, + { + "description": "Returns all response headers as a map in which each entry represents an individual header. The key of the entry holds the header name and the entry value holds a list of all header values.", + "id": "script-api:dw/net/HTTPClient#getResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getResponseHeaders", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns all response headers as a map in which each entry represents an individual header. The key of the entry\nholds the header name and the entry value holds a list of all header values.", + "heading": "Description" + } + ], + "signature": "getResponseHeaders(): utilMap", + "source": "script-api", + "tags": [ + "getresponseheaders", + "httpclient.getresponseheaders" + ], + "title": "HTTPClient.getResponseHeaders" + }, + { + "description": "Returns the status code of the last HTTP operation.", + "id": "script-api:dw/net/HTTPClient#getStatusCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getStatusCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status code of the last HTTP operation.", + "heading": "Description" + } + ], + "signature": "getStatusCode(): number", + "source": "script-api", + "tags": [ + "getstatuscode", + "httpclient.getstatuscode" + ], + "title": "HTTPClient.getStatusCode" + }, + { + "description": "Returns the message text of the last HTTP operation.", + "id": "script-api:dw/net/HTTPClient#getStatusMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getStatusMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the message text of the last HTTP operation.", + "heading": "Description" + } + ], + "signature": "getStatusMessage(): string", + "source": "script-api", + "tags": [ + "getstatusmessage", + "httpclient.getstatusmessage" + ], + "title": "HTTPClient.getStatusMessage" + }, + { + "description": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "id": "script-api:dw/net/HTTPClient#getText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "heading": "Description" + } + ], + "signature": "getText(): string", + "source": "script-api", + "tags": [ + "gettext", + "httpclient.gettext" + ], + "title": "HTTPClient.getText" + }, + { + "description": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "id": "script-api:dw/net/HTTPClient#getText", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "heading": "Description" + } + ], + "signature": "getText(encoding: string): string", + "source": "script-api", + "tags": [ + "gettext", + "httpclient.gettext" + ], + "title": "HTTPClient.getText" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/HTTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.getTimeout", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "getTimeout(): number", + "source": "script-api", + "tags": [ + "gettimeout", + "httpclient.gettimeout" + ], + "title": "HTTPClient.getTimeout" + }, + { + "description": "Determines whether host name verification is enabled.", + "id": "script-api:dw/net/HTTPClient#hostNameVerification", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.hostNameVerification", + "sections": [ + { + "body": "Determines whether host name verification is enabled.", + "heading": "Description" + } + ], + "signature": "hostNameVerification: boolean", + "source": "script-api", + "tags": [ + "hostnameverification", + "httpclient.hostnameverification" + ], + "title": "HTTPClient.hostNameVerification" + }, + { + "description": "Gets the identity used for mutual TLS (mTLS).", + "id": "script-api:dw/net/HTTPClient#identity", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.identity", + "sections": [ + { + "body": "Gets the identity used for mutual TLS (mTLS).", + "heading": "Description" + } + ], + "signature": "identity: KeyRef | null", + "source": "script-api", + "tags": [ + "identity", + "httpclient.identity" + ], + "title": "HTTPClient.identity" + }, + { + "description": "Gets the logging configuration for this HTTP client.", + "id": "script-api:dw/net/HTTPClient#loggingConfig", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.loggingConfig", + "sections": [ + { + "body": "Gets the logging configuration for this HTTP client.", + "heading": "Description" + } + ], + "signature": "loggingConfig: HTTPClientLoggingConfig", + "source": "script-api", + "tags": [ + "loggingconfig", + "httpclient.loggingconfig" + ], + "title": "HTTPClient.loggingConfig" + }, + { + "description": "Opens the specified URL using the specified method. The following methods are supported: GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE", + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "method", + "type": "string" + }, + { + "name": "url", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Opens the specified URL using the specified method. The following methods are supported: GET, POST, HEAD, PUT,\nPATCH, OPTIONS, and DELETE", + "heading": "Description" + } + ], + "signature": "open(method: string, url: string): void", + "source": "script-api", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "deprecated": { + "message": "Use open instead." + }, + "description": "Deprecated method.", + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "method", + "type": "string" + }, + { + "name": "url", + "type": "string" + }, + { + "name": "async", + "type": "boolean" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deprecated method.", + "heading": "Description" + } + ], + "signature": "open(method: string, url: string, async: boolean, user: string, password: string): void", + "source": "script-api", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "description": "Opens the specified URL with the in parameter method specified Http method with given credentials [user, password] using HTTP basic authentication. The following methods are supported: GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE", + "id": "script-api:dw/net/HTTPClient#open", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "method", + "type": "string" + }, + { + "name": "url", + "type": "string" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.open", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Opens the specified URL with the in parameter method specified Http method with given credentials [user,\npassword] using HTTP basic authentication. The following methods are supported: GET, POST, HEAD, PUT,\nPATCH, OPTIONS, and DELETE", + "heading": "Description" + } + ], + "signature": "open(method: string, url: string, user: string, password: string): void", + "source": "script-api", + "tags": [ + "open", + "httpclient.open" + ], + "title": "HTTPClient.open" + }, + { + "description": "Returns all response headers as a map in which each entry represents an individual header. The key of the entry holds the header name and the entry value holds a list of all header values.", + "id": "script-api:dw/net/HTTPClient#responseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.responseHeaders", + "sections": [ + { + "body": "Returns all response headers as a map in which each entry represents an individual header. The key of the entry\nholds the header name and the entry value holds a list of all header values.", + "heading": "Description" + } + ], + "signature": "readonly responseHeaders: utilMap", + "source": "script-api", + "tags": [ + "responseheaders", + "httpclient.responseheaders" + ], + "title": "HTTPClient.responseHeaders" + }, + { + "description": "Sends an HTTP request.", + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends an HTTP request.", + "heading": "Description" + } + ], + "signature": "send(): void", + "source": "script-api", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "description": "This method performs the actual HTTP communication. The text is sent as a request body. If the text is null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. The text is sent as a request body. If the text is null no\ndata will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "send(text: string): void", + "source": "script-api", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "description": "This method performs the actual HTTP communication. The text is sent as a request body. If the text is null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "text", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. The text is sent as a request body. If the text is null no\ndata will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "send(text: string, encoding: string): void", + "source": "script-api", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "description": "This method performs the actual HTTP communication. Sends the file to the HTTP server. The file content is sent as a request body and is sent \"as-is\" (text or binary).", + "id": "script-api:dw/net/HTTPClient#send", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.send", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. Sends the file to the HTTP server. The file content is sent\nas a request body and is sent \"as-is\" (text or binary).", + "heading": "Description" + } + ], + "signature": "send(file: File): void", + "source": "script-api", + "tags": [ + "send", + "httpclient.send" + ], + "title": "HTTPClient.send" + }, + { + "description": "This method performs the actual HTTP communication. If the file is null no data will be sent to the HTTP server. If this method is used with a GET then the file parameter will contain the contents retrieved. When using this method with a PUT/POST then the contents of the file parameter will be sent to the server.", + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. If the file is null no data will be sent to the HTTP server.\nIf this method is used with a GET then the file parameter will contain the contents retrieved. When using this\nmethod with a PUT/POST then the contents of the file parameter will be sent to the server.", + "heading": "Description" + } + ], + "signature": "sendAndReceiveToFile(file: File): boolean", + "source": "script-api", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "description": "This method performs the actual HTTP communication. If the text is null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "text", + "type": "string" + }, + { + "name": "outFile", + "type": "File" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. If the text is null no data will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "sendAndReceiveToFile(text: string, outFile: File): boolean", + "source": "script-api", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "description": "This method performs the actual HTTP communication. If the text is null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#sendAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "text", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "outFile", + "type": "File" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendAndReceiveToFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. If the text is null no data will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "sendAndReceiveToFile(text: string, encoding: string, outFile: File): boolean", + "source": "script-api", + "tags": [ + "sendandreceivetofile", + "httpclient.sendandreceivetofile" + ], + "title": "HTTPClient.sendAndReceiveToFile" + }, + { + "description": "This method performs the actual HTTP communication. The bytes are sent as a request body. If the bytes are null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#sendBytes", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "body", + "type": "Bytes" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendBytes", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. The bytes are sent as a request body. If the bytes are null no\ndata will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "sendBytes(body: Bytes): void", + "source": "script-api", + "tags": [ + "sendbytes", + "httpclient.sendbytes" + ], + "title": "HTTPClient.sendBytes" + }, + { + "description": "This method performs the actual HTTP communication. If the body is null no data will be sent to the HTTP server.", + "id": "script-api:dw/net/HTTPClient#sendBytesAndReceiveToFile", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "body", + "type": "Bytes" + }, + { + "name": "outFile", + "type": "File" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendBytesAndReceiveToFile", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method performs the actual HTTP communication. If the body is null no data will be sent to the HTTP server.", + "heading": "Description" + } + ], + "signature": "sendBytesAndReceiveToFile(body: Bytes, outFile: File): boolean", + "source": "script-api", + "tags": [ + "sendbytesandreceivetofile", + "httpclient.sendbytesandreceivetofile" + ], + "throws": [ + { + "type": "IOException" + } + ], + "title": "HTTPClient.sendBytesAndReceiveToFile" + }, + { + "description": "Sends a multipart HTTP request. This method should only be called if the connection to the remote URL was opened with a POST or PATCH method. All other methods will result in an exception being thrown. The request is constructed from the passed array of parts.", + "id": "script-api:dw/net/HTTPClient#sendMultiPart", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "parts", + "type": "HTTPRequestPart[]" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.sendMultiPart", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Sends a multipart HTTP request. This method should only be called if the connection to the remote URL was opened\nwith a POST or PATCH method. All other methods will result in an exception being thrown. The request is constructed\nfrom the passed array of parts.", + "heading": "Description" + } + ], + "signature": "sendMultiPart(parts: HTTPRequestPart[]): boolean", + "source": "script-api", + "tags": [ + "sendmultipart", + "httpclient.sendmultipart" + ], + "title": "HTTPClient.sendMultiPart" + }, + { + "description": "Sets whether automatic HTTP redirect handling is enabled. The default value is true. Set it to false to disable all redirects.", + "id": "script-api:dw/net/HTTPClient#setAllowRedirect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "allowRedirect", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setAllowRedirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets whether automatic HTTP redirect handling is enabled.\nThe default value is true. Set it to false to disable all redirects.", + "heading": "Description" + } + ], + "signature": "setAllowRedirect(allowRedirect: boolean): void", + "source": "script-api", + "tags": [ + "setallowredirect", + "httpclient.setallowredirect" + ], + "title": "HTTPClient.setAllowRedirect" + }, + { + "description": "Sets whether certificate host name verification is enabled. The default value is true. Set it to false to disable host name verification.", + "id": "script-api:dw/net/HTTPClient#setHostNameVerification", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "enable", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setHostNameVerification", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets whether certificate host name verification is enabled.\nThe default value is true. Set it to false to disable host name verification.", + "heading": "Description" + } + ], + "signature": "setHostNameVerification(enable: boolean): void", + "source": "script-api", + "tags": [ + "sethostnameverification", + "httpclient.sethostnameverification" + ], + "title": "HTTPClient.setHostNameVerification" + }, + { + "description": "Sets the identity (private key) to use when mutual TLS (mTLS) is configured.", + "id": "script-api:dw/net/HTTPClient#setIdentity", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setIdentity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the identity (private key) to use when mutual TLS (mTLS) is configured.\n\nIf this is not set and mTLS is used then the private key will be chosen from the key store based on the host\nname.\nIf this is set to a reference named \"__NONE__\" then no private key will be used even if one is requested by the remote server.", + "heading": "Description" + } + ], + "signature": "setIdentity(keyRef: KeyRef): void", + "source": "script-api", + "tags": [ + "setidentity", + "httpclient.setidentity" + ], + "title": "HTTPClient.setIdentity" + }, + { + "description": "Sets the logging configuration for this HTTP client.", + "id": "script-api:dw/net/HTTPClient#setLoggingConfig", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "config", + "type": "HTTPClientLoggingConfig" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setLoggingConfig", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the logging configuration for this HTTP client.", + "heading": "Description" + } + ], + "signature": "setLoggingConfig(config: HTTPClientLoggingConfig): void", + "source": "script-api", + "tags": [ + "setloggingconfig", + "httpclient.setloggingconfig" + ], + "title": "HTTPClient.setLoggingConfig" + }, + { + "description": "Sets a request header for the next HTTP operation.", + "id": "script-api:dw/net/HTTPClient#setRequestHeader", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setRequestHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a request header for the next HTTP operation.", + "heading": "Description" + } + ], + "signature": "setRequestHeader(key: string, value: string): void", + "source": "script-api", + "tags": [ + "setrequestheader", + "httpclient.setrequestheader" + ], + "title": "HTTPClient.setRequestHeader" + }, + { + "description": "Sets the timeout for connections made with this client to the given number of milliseconds. If the given timeout is less than or equal to zero, the timeout is set to a maximum value of 2 or 15 minutes, depending on the context.", + "id": "script-api:dw/net/HTTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "timeoutMillis", + "type": "number" + } + ], + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.setTimeout", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the timeout for connections made with this client to the given number of milliseconds. If the given timeout\nis less than or equal to zero, the timeout is set to a maximum value of 2 or 15 minutes, depending on the\ncontext.\n\nThis timeout value controls both the \"connection timeout\" (how long it takes to connect to the remote host) and\nthe \"socket timeout\" (how long, after connecting, it will wait without any data being read). Therefore, in the\nworst case scenario, the total time of inactivity could be twice as long as the specified value.\n\nThe maximum timeout is 15 minutes when the client is used in a job, and 2 minutes otherwise. The default timeout\nfor a new client is the maximum timeout value.\n\nThis method can be called at any time, and will affect the next connection made with this client. It is not\npossible to set the timeout for an open connection.\n\nYou should always set a reasonable timeout (e.g., a few seconds). Allowing connections to run long can result\nin thread exhaustion.", + "heading": "Description" + } + ], + "signature": "setTimeout(timeoutMillis: number): void", + "source": "script-api", + "tags": [ + "settimeout", + "httpclient.settimeout" + ], + "title": "HTTPClient.setTimeout" + }, + { + "description": "Returns the status code of the last HTTP operation.", + "id": "script-api:dw/net/HTTPClient#statusCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.statusCode", + "sections": [ + { + "body": "Returns the status code of the last HTTP operation.", + "heading": "Description" + } + ], + "signature": "readonly statusCode: number", + "source": "script-api", + "tags": [ + "statuscode", + "httpclient.statuscode" + ], + "title": "HTTPClient.statusCode" + }, + { + "description": "Returns the message text of the last HTTP operation.", + "id": "script-api:dw/net/HTTPClient#statusMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.statusMessage", + "sections": [ + { + "body": "Returns the message text of the last HTTP operation.", + "heading": "Description" + } + ], + "signature": "readonly statusMessage: string", + "source": "script-api", + "tags": [ + "statusmessage", + "httpclient.statusmessage" + ], + "title": "HTTPClient.statusMessage" + }, + { + "description": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "id": "script-api:dw/net/HTTPClient#text", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.text", + "sections": [ + { + "body": "Returns the returned message body as text for HTTP status codes between 200 and 299.", + "heading": "Description" + } + ], + "signature": "readonly text: string", + "source": "script-api", + "tags": [ + "text", + "httpclient.text" + ], + "title": "HTTPClient.text" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/HTTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClient", + "qualifiedName": "dw.net.HTTPClient.timeout", + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "timeout: number", + "source": "script-api", + "tags": [ + "timeout", + "httpclient.timeout" + ], + "title": "HTTPClient.timeout" + }, + { + "description": "Script API for configuring HTTP client logging and sensitive data redaction.", + "examples": [ + "var config = new dw.net.HTTPClientLoggingConfig();\n// Enable logging and set level\nconfig.setEnabled(true);\nconfig.setLevel(\"INFO\");\n// Configure sensitive JSON fields\nconfig.setSensitiveJsonFields([\"password\", \"creditCard\", \"ssn\"]);\n// Configure sensitive XML fields\nconfig.setSensitiveXmlFields([\"password\", \"creditCard\", \"ssn\"]);\n// Configure sensitive headers\nconfig.setSensitiveHeaders([\"authorization\", \"x-api-key\", \"cookie\"]);\n// Configure sensitive body fields (for form data)\nconfig.setSensitiveBodyFields([\"password\", \"creditCard\", \"ssn\"]);\n// Configure text patterns for plain text/HTML content\nconfig.setSensitiveTextPatterns([[\"password\\\\s*=\\\\s*[^\\\\s&]+\"]]);" + ], + "id": "script-api:dw/net/HTTPClientLoggingConfig", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPClientLoggingConfig", + "sections": [ + { + "body": "Script API for configuring HTTP client logging and sensitive data redaction.\n\nThis class provides a customer-facing interface for configuring HTTP client logging behavior, including\nenabling/disabling logging, setting log levels, and defining sensitive fields that should be redacted from HTTP\nrequest and response bodies.\n\nSecurity Note: This class handles sensitive security-related data and logging\nconfiguration. Pay special attention to PCI DSS requirements when configuring sensitive field redaction to ensure\nproper data protection.\nSensitive Fields of appropriate types MUST be set else logging will be skipped.\n\nUsage Example:\n\n\nContent Type Support:\n\n- JSON: Use setSensitiveJsonFields() to specify field names to redact\n- XML: Use setSensitiveXmlFields() to specify element/attribute names to redact\n- Form Data: Use setSensitiveBodyFields() to specify parameter names to redact\n- Plain Text/HTML: Use setSensitiveTextPatterns() to specify regex patterns\n- Binary/Multipart: Entire body is automatically treated as sensitive", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "httpclientloggingconfig", + "dw.net.httpclientloggingconfig", + "dw/net" + ], + "title": "HTTPClientLoggingConfig" + }, + { + "description": "Gets whether HTTP client logging is enabled.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#enabled", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.enabled", + "sections": [ + { + "body": "Gets whether HTTP client logging is enabled.", + "heading": "Description" + } + ], + "signature": "enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "httpclientloggingconfig.enabled" + ], + "title": "HTTPClientLoggingConfig.enabled" + }, + { + "description": "Gets the current log level for HTTP client logging.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#getLevel", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getLevel", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the current log level for HTTP client logging.", + "heading": "Description" + } + ], + "signature": "getLevel(): string", + "source": "script-api", + "tags": [ + "getlevel", + "httpclientloggingconfig.getlevel" + ], + "title": "HTTPClientLoggingConfig.getLevel" + }, + { + "description": "Gets the sensitive body fields configured for form data redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveBodyFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveBodyFields", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Gets the sensitive body fields configured for form data redaction.", + "heading": "Description" + } + ], + "signature": "getSensitiveBodyFields(): string[]", + "source": "script-api", + "tags": [ + "getsensitivebodyfields", + "httpclientloggingconfig.getsensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveBodyFields" + }, + { + "description": "Gets the sensitive headers configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveHeaders", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Gets the sensitive headers configured for redaction.", + "heading": "Description" + } + ], + "signature": "getSensitiveHeaders(): string[]", + "source": "script-api", + "tags": [ + "getsensitiveheaders", + "httpclientloggingconfig.getsensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.getSensitiveHeaders" + }, + { + "description": "Gets the sensitive JSON fields configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveJsonFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveJsonFields", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Gets the sensitive JSON fields configured for redaction.", + "heading": "Description" + } + ], + "signature": "getSensitiveJsonFields(): string[]", + "source": "script-api", + "tags": [ + "getsensitivejsonfields", + "httpclientloggingconfig.getsensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveJsonFields" + }, + { + "description": "Gets the sensitive XML fields configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#getSensitiveXmlFields", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.getSensitiveXmlFields", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Gets the sensitive XML fields configured for redaction.", + "heading": "Description" + } + ], + "signature": "getSensitiveXmlFields(): string[]", + "source": "script-api", + "tags": [ + "getsensitivexmlfields", + "httpclientloggingconfig.getsensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.getSensitiveXmlFields" + }, + { + "description": "Gets whether HTTP client logging is enabled.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#isEnabled", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Gets whether HTTP client logging is enabled.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "httpclientloggingconfig.isenabled" + ], + "title": "HTTPClientLoggingConfig.isEnabled" + }, + { + "description": "Gets the current log level for HTTP client logging.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#level", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.level", + "sections": [ + { + "body": "Gets the current log level for HTTP client logging.", + "heading": "Description" + } + ], + "signature": "level: string", + "source": "script-api", + "tags": [ + "level", + "httpclientloggingconfig.level" + ], + "title": "HTTPClientLoggingConfig.level" + }, + { + "description": "Gets the sensitive body fields configured for form data redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveBodyFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveBodyFields", + "sections": [ + { + "body": "Gets the sensitive body fields configured for form data redaction.", + "heading": "Description" + } + ], + "signature": "sensitiveBodyFields: string[]", + "source": "script-api", + "tags": [ + "sensitivebodyfields", + "httpclientloggingconfig.sensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveBodyFields" + }, + { + "description": "Gets the sensitive headers configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveHeaders", + "sections": [ + { + "body": "Gets the sensitive headers configured for redaction.", + "heading": "Description" + } + ], + "signature": "sensitiveHeaders: string[]", + "source": "script-api", + "tags": [ + "sensitiveheaders", + "httpclientloggingconfig.sensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.sensitiveHeaders" + }, + { + "description": "Gets the sensitive JSON fields configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveJsonFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveJsonFields", + "sections": [ + { + "body": "Gets the sensitive JSON fields configured for redaction.", + "heading": "Description" + } + ], + "signature": "sensitiveJsonFields: string[]", + "source": "script-api", + "tags": [ + "sensitivejsonfields", + "httpclientloggingconfig.sensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveJsonFields" + }, + { + "description": "Gets the sensitive XML fields configured for redaction.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#sensitiveXmlFields", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.sensitiveXmlFields", + "sections": [ + { + "body": "Gets the sensitive XML fields configured for redaction.", + "heading": "Description" + } + ], + "signature": "sensitiveXmlFields: string[]", + "source": "script-api", + "tags": [ + "sensitivexmlfields", + "httpclientloggingconfig.sensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.sensitiveXmlFields" + }, + { + "description": "Sets whether HTTP client logging is enabled.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setEnabled", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "enabled", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setEnabled", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets whether HTTP client logging is enabled.\n\nWhen enabled, HTTP requests and responses will be logged according to the configured log level and sensitive\nfield redaction settings. When disabled, no HTTP logging will occur.", + "heading": "Description" + } + ], + "signature": "setEnabled(enabled: boolean): void", + "source": "script-api", + "tags": [ + "setenabled", + "httpclientloggingconfig.setenabled" + ], + "title": "HTTPClientLoggingConfig.setEnabled" + }, + { + "description": "Sets the log level for HTTP client logging.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setLevel", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "level", + "type": "string" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setLevel", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the log level for HTTP client logging.\n\nThe log level determines the verbosity of HTTP logging output. Available levels:\n\n- DEBUG: Most verbose, includes detailed request/response information\n- INFO: Standard level, includes basic request/response details\n- WARN: Only logs warnings and errors\n- ERROR: Only logs errors", + "heading": "Description" + } + ], + "signature": "setLevel(level: string): void", + "source": "script-api", + "tags": [ + "setlevel", + "httpclientloggingconfig.setlevel" + ], + "title": "HTTPClientLoggingConfig.setLevel" + }, + { + "description": "Sets the sensitive body fields that should be redacted from HTTP form data.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveBodyFields", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "fields", + "type": "string[]" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveBodyFields", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sensitive body fields that should be redacted from HTTP form data.\n\nWhen HTTP requests or responses contain form data (application/x-www-form-urlencoded), any parameters matching\nthe specified field names will be redacted with \"****FILTERED****\" in the logs.\nSensitive Field MUST be set else logging will be skipped for form body type\nSetting with empty array will use default values [\"name\", \"email\", \"email_address\", \"ssn\", \"first_name\", \"last_name\"]\n\nExample:", + "heading": "Description" + } + ], + "signature": "setSensitiveBodyFields(fields: string[]): void", + "source": "script-api", + "tags": [ + "setsensitivebodyfields", + "httpclientloggingconfig.setsensitivebodyfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveBodyFields" + }, + { + "description": "Sets the sensitive headers that should be redacted from HTTP requests/responses.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveHeaders", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "headers", + "type": "string[]" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveHeaders", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sensitive headers that should be redacted from HTTP requests/responses.\n\nAny HTTP headers matching the specified names will be redacted with \"****FILTERED****\" in the logs. This is useful for\nprotecting sensitive authentication tokens, API keys, and session information.\nSensitive Headers MUST be set else logging will be skipped for headers\nSetting the sensitive headers with empty array will use default values [\"authorization\", \"cookie\"]\n\nExample:", + "heading": "Description" + } + ], + "signature": "setSensitiveHeaders(headers: string[]): void", + "source": "script-api", + "tags": [ + "setsensitiveheaders", + "httpclientloggingconfig.setsensitiveheaders" + ], + "title": "HTTPClientLoggingConfig.setSensitiveHeaders" + }, + { + "description": "Sets the sensitive JSON fields that should be redacted from HTTP request/response bodies.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveJsonFields", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "fields", + "type": "string[]" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveJsonFields", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sensitive JSON fields that should be redacted from HTTP request/response bodies.\n\nWhen HTTP requests or responses contain JSON content, any fields matching the specified names will be redacted\nwith \"****FILTERED****\" in the logs.\nSensitive Field MUST be set else logging will be skipped for JSON body type\nSetting with empty array will use default values [\"name\", \"email\", \"email_address\", \"ssn\", \"first_name\", \"last_name\", \"password\"]\n\nExample:", + "heading": "Description" + } + ], + "signature": "setSensitiveJsonFields(fields: string[]): void", + "source": "script-api", + "tags": [ + "setsensitivejsonfields", + "httpclientloggingconfig.setsensitivejsonfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveJsonFields" + }, + { + "description": "Sets the sensitive text patterns that should be redacted from HTTP request/response bodies.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveTextPatterns", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "patterns", + "type": "string[]" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveTextPatterns", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sensitive text patterns that should be redacted from HTTP request/response bodies.\n\nWhen HTTP requests or responses contain text content, any text matching the specified regex patterns will be\nredacted with \"****FILTERED****\" in the logs.\n\nExample:", + "heading": "Description" + } + ], + "signature": "setSensitiveTextPatterns(patterns: string[]): void", + "source": "script-api", + "tags": [ + "setsensitivetextpatterns", + "httpclientloggingconfig.setsensitivetextpatterns" + ], + "title": "HTTPClientLoggingConfig.setSensitiveTextPatterns" + }, + { + "description": "Sets the sensitive XML fields that should be redacted from HTTP request/response bodies.", + "id": "script-api:dw/net/HTTPClientLoggingConfig#setSensitiveXmlFields", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "fields", + "type": "string[]" + } + ], + "parentId": "script-api:dw/net/HTTPClientLoggingConfig", + "qualifiedName": "dw.net.HTTPClientLoggingConfig.setSensitiveXmlFields", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the sensitive XML fields that should be redacted from HTTP request/response bodies.\n\nWhen HTTP requests or responses contain XML content, any elements or attributes matching the specified names will\nbe redacted with \"****FILTERED****\" in the logs.\nSensitive Field MUST be set else logging will be skipped for XML body type\nSetting with empty array will use default values [\"name\", \"email\", \"email_address\", \"ssn\", \"first_name\", \"last_name\", \"password\"]\n\nExample:", + "heading": "Description" + } + ], + "signature": "setSensitiveXmlFields(fields: string[]): void", + "source": "script-api", + "tags": [ + "setsensitivexmlfields", + "httpclientloggingconfig.setsensitivexmlfields" + ], + "title": "HTTPClientLoggingConfig.setSensitiveXmlFields" + }, + { + "description": "This represents a part in a multi-part HTTP POST request.", + "id": "script-api:dw/net/HTTPRequestPart", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.HTTPRequestPart", + "sections": [ + { + "body": "This represents a part in a multi-part HTTP POST request.\n\nA part always has a name and value. The value may be a String, Bytes, or the contents of a File.\n\nA character encoding may be specified for any of these, and the content type and a file name may additionally be\nspecified for the Bytes and File types.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "httprequestpart", + "dw.net.httprequestpart", + "dw/net" + ], + "title": "HTTPRequestPart" + }, + { + "description": "Get the Bytes value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#bytesValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.bytesValue", + "sections": [ + { + "body": "Get the Bytes value of the part.", + "heading": "Description" + } + ], + "signature": "readonly bytesValue: Bytes | null", + "source": "script-api", + "tags": [ + "bytesvalue", + "httprequestpart.bytesvalue" + ], + "title": "HTTPRequestPart.bytesValue" + }, + { + "description": "Returns the content type of this part.", + "id": "script-api:dw/net/HTTPRequestPart#contentType", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.contentType", + "sections": [ + { + "body": "Returns the content type of this part.", + "heading": "Description" + } + ], + "signature": "readonly contentType: string | null", + "source": "script-api", + "tags": [ + "contenttype", + "httprequestpart.contenttype" + ], + "title": "HTTPRequestPart.contentType" + }, + { + "description": "Get the charset to be used to encode the string.", + "id": "script-api:dw/net/HTTPRequestPart#encoding", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.encoding", + "sections": [ + { + "body": "Get the charset to be used to encode the string.", + "heading": "Description" + } + ], + "signature": "readonly encoding: string | null", + "source": "script-api", + "tags": [ + "encoding", + "httprequestpart.encoding" + ], + "title": "HTTPRequestPart.encoding" + }, + { + "description": "Get the file name to use when sending a file part.", + "id": "script-api:dw/net/HTTPRequestPart#fileName", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.fileName", + "sections": [ + { + "body": "Get the file name to use when sending a file part.", + "heading": "Description" + } + ], + "signature": "readonly fileName: string | null", + "source": "script-api", + "tags": [ + "filename", + "httprequestpart.filename" + ], + "title": "HTTPRequestPart.fileName" + }, + { + "description": "Get the file value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#fileValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.fileValue", + "sections": [ + { + "body": "Get the file value of the part.", + "heading": "Description" + } + ], + "signature": "readonly fileValue: File | null", + "source": "script-api", + "tags": [ + "filevalue", + "httprequestpart.filevalue" + ], + "title": "HTTPRequestPart.fileValue" + }, + { + "description": "Get the Bytes value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#getBytesValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getBytesValue", + "returns": { + "type": "Bytes | null" + }, + "sections": [ + { + "body": "Get the Bytes value of the part.", + "heading": "Description" + } + ], + "signature": "getBytesValue(): Bytes | null", + "source": "script-api", + "tags": [ + "getbytesvalue", + "httprequestpart.getbytesvalue" + ], + "title": "HTTPRequestPart.getBytesValue" + }, + { + "description": "Returns the content type of this part.", + "id": "script-api:dw/net/HTTPRequestPart#getContentType", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getContentType", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the content type of this part.", + "heading": "Description" + } + ], + "signature": "getContentType(): string | null", + "source": "script-api", + "tags": [ + "getcontenttype", + "httprequestpart.getcontenttype" + ], + "title": "HTTPRequestPart.getContentType" + }, + { + "description": "Get the charset to be used to encode the string.", + "id": "script-api:dw/net/HTTPRequestPart#getEncoding", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getEncoding", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the charset to be used to encode the string.", + "heading": "Description" + } + ], + "signature": "getEncoding(): string | null", + "source": "script-api", + "tags": [ + "getencoding", + "httprequestpart.getencoding" + ], + "title": "HTTPRequestPart.getEncoding" + }, + { + "description": "Get the file name to use when sending a file part.", + "id": "script-api:dw/net/HTTPRequestPart#getFileName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getFileName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the file name to use when sending a file part.", + "heading": "Description" + } + ], + "signature": "getFileName(): string | null", + "source": "script-api", + "tags": [ + "getfilename", + "httprequestpart.getfilename" + ], + "title": "HTTPRequestPart.getFileName" + }, + { + "description": "Get the file value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#getFileValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getFileValue", + "returns": { + "type": "File | null" + }, + "sections": [ + { + "body": "Get the file value of the part.", + "heading": "Description" + } + ], + "signature": "getFileValue(): File | null", + "source": "script-api", + "tags": [ + "getfilevalue", + "httprequestpart.getfilevalue" + ], + "title": "HTTPRequestPart.getFileValue" + }, + { + "description": "Get the name of the part.", + "id": "script-api:dw/net/HTTPRequestPart#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the name of the part.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "httprequestpart.getname" + ], + "title": "HTTPRequestPart.getName" + }, + { + "description": "Get the string value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#getStringValue", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.getStringValue", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Get the string value of the part.", + "heading": "Description" + } + ], + "signature": "getStringValue(): string | null", + "source": "script-api", + "tags": [ + "getstringvalue", + "httprequestpart.getstringvalue" + ], + "title": "HTTPRequestPart.getStringValue" + }, + { + "description": "Get the name of the part.", + "id": "script-api:dw/net/HTTPRequestPart#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.name", + "sections": [ + { + "body": "Get the name of the part.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "httprequestpart.name" + ], + "title": "HTTPRequestPart.name" + }, + { + "description": "Get the string value of the part.", + "id": "script-api:dw/net/HTTPRequestPart#stringValue", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/HTTPRequestPart", + "qualifiedName": "dw.net.HTTPRequestPart.stringValue", + "sections": [ + { + "body": "Get the string value of the part.", + "heading": "Description" + } + ], + "signature": "readonly stringValue: string | null", + "source": "script-api", + "tags": [ + "stringvalue", + "httprequestpart.stringvalue" + ], + "title": "HTTPRequestPart.stringValue" + }, + { + "description": "This class is used to send an email with either plain text or MimeEncodedText content. Recipient data (from, to, cc, bcc) and subject are specified using setter methods. When the dw.net.Mail.send method is invoked, the email is put into an internal queue and sent asynchronously.", + "examples": [ + "`\nfunction sendMail() {\nvar template: Template = new dw.util.Template(\"myTemplate.isml\");\n\nvar o: Map = new dw.util.HashMap();\no.put(\"customer\",\"customer\");\no.put(\"product\",\"product\");\n\nvar content: MimeEncodedText = template.render(o);\nvar mail: Mail = new dw.net.Mail();\nmail.addTo(\"to@example.org\");\nmail.setFrom(\"from@example.org\");\nmail.setSubject(\"Example Email\");\nmail.setContent(content);\n\nmail.send();//returns either Status.ERROR or Status.OK, mail might not be sent yet, when this method returns\n}\n`" + ], + "id": "script-api:dw/net/Mail", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.Mail", + "sections": [ + { + "body": "This class is used to send an email with either plain text or MimeEncodedText content.\nRecipient data (from, to, cc, bcc) and subject are specified\nusing setter methods. When the dw.net.Mail.send method is invoked,\nthe email is put into an internal queue and sent asynchronously.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.\n\nThe following example script sends an email with MimeEncodedText content:\n\n\nSee Sending email via scripts or hooks in the documentation for additional examples.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mail", + "dw.net.mail", + "dw/net" + ], + "title": "Mail" + }, + { + "description": "Adds a file attachment to the email. This method is restricted to Job context only.", + "id": "script-api:dw/net/Mail#addAttachment", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addAttachment", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Adds a file attachment to the email. This method is restricted to Job context only.", + "heading": "Description" + } + ], + "signature": "addAttachment(file: File): Mail", + "source": "script-api", + "tags": [ + "addattachment", + "mail.addattachment" + ], + "throws": [ + { + "description": "if the file is null, doesn't exist, or is not a file", + "type": "IllegalArgumentException" + } + ], + "title": "Mail.addAttachment" + }, + { + "description": "Adds an address to the `bcc` List. Address must conform to the RFC822 standard.", + "id": "script-api:dw/net/Mail#addBcc", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "bcc", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addBcc", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Adds an address to the `bcc` List. Address must conform to the RFC822 standard.", + "heading": "Description" + } + ], + "signature": "addBcc(bcc: string): Mail", + "source": "script-api", + "tags": [ + "addbcc", + "mail.addbcc" + ], + "title": "Mail.addBcc" + }, + { + "description": "Adds an address to the `cc` List. The address must conform to RFC822 standard.", + "id": "script-api:dw/net/Mail#addCc", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "cc", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addCc", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Adds an address to the `cc` List. The address must conform to RFC822 standard.", + "heading": "Description" + } + ], + "signature": "addCc(cc: string): Mail", + "source": "script-api", + "tags": [ + "addcc", + "mail.addcc" + ], + "title": "Mail.addCc" + }, + { + "description": "Adds an address to the `replyTo` List. Address must conform to the RFC822 standard.", + "id": "script-api:dw/net/Mail#addReplyTo", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "replyTo", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addReplyTo", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Adds an address to the `replyTo` List. Address must conform to the RFC822 standard.", + "heading": "Description" + } + ], + "signature": "addReplyTo(replyTo: string): Mail", + "source": "script-api", + "tags": [ + "addreplyto", + "mail.addreplyto" + ], + "throws": [ + { + "description": "if the email address is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "Mail.addReplyTo" + }, + { + "description": "Adds an address to the `to` address List. The address must conform to the RFC822 standard.", + "id": "script-api:dw/net/Mail#addTo", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "to", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.addTo", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Adds an address to the `to` address List. The address must conform to the RFC822 standard.", + "heading": "Description" + } + ], + "signature": "addTo(to: string): Mail", + "source": "script-api", + "tags": [ + "addto", + "mail.addto" + ], + "title": "Mail.addTo" + }, + { + "description": "Gets the `bcc` address List.", + "id": "script-api:dw/net/Mail#bcc", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.bcc", + "sections": [ + { + "body": "Gets the `bcc` address List.", + "heading": "Description" + } + ], + "signature": "bcc: List", + "source": "script-api", + "tags": [ + "bcc", + "mail.bcc" + ], + "title": "Mail.bcc" + }, + { + "description": "Gets the `cc` address List.", + "id": "script-api:dw/net/Mail#cc", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.cc", + "sections": [ + { + "body": "Gets the `cc` address List.", + "heading": "Description" + } + ], + "signature": "cc: List", + "source": "script-api", + "tags": [ + "cc", + "mail.cc" + ], + "title": "Mail.cc" + }, + { + "description": "Gets the email address to use as the `from` address for the email.", + "id": "script-api:dw/net/Mail#from", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.from", + "sections": [ + { + "body": "Gets the email address to use as the `from` address for the\nemail.", + "heading": "Description" + } + ], + "signature": "from: string | null", + "source": "script-api", + "tags": [ + "from", + "mail.from" + ], + "title": "Mail.from" + }, + { + "description": "Gets the `bcc` address List.", + "id": "script-api:dw/net/Mail#getBcc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getBcc", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Gets the `bcc` address List.", + "heading": "Description" + } + ], + "signature": "getBcc(): List", + "source": "script-api", + "tags": [ + "getbcc", + "mail.getbcc" + ], + "title": "Mail.getBcc" + }, + { + "description": "Gets the `cc` address List.", + "id": "script-api:dw/net/Mail#getCc", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getCc", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Gets the `cc` address List.", + "heading": "Description" + } + ], + "signature": "getCc(): List", + "source": "script-api", + "tags": [ + "getcc", + "mail.getcc" + ], + "title": "Mail.getCc" + }, + { + "description": "Gets the email address to use as the `from` address for the email.", + "id": "script-api:dw/net/Mail#getFrom", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getFrom", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Gets the email address to use as the `from` address for the\nemail.", + "heading": "Description" + } + ], + "signature": "getFrom(): string | null", + "source": "script-api", + "tags": [ + "getfrom", + "mail.getfrom" + ], + "title": "Mail.getFrom" + }, + { + "description": "Gets the `replyTo` address List.", + "id": "script-api:dw/net/Mail#getReplyTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getReplyTo", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Gets the `replyTo` address List.", + "heading": "Description" + } + ], + "signature": "getReplyTo(): List", + "source": "script-api", + "tags": [ + "getreplyto", + "mail.getreplyto" + ], + "title": "Mail.getReplyTo" + }, + { + "description": "Gets the `subject` of the email.", + "id": "script-api:dw/net/Mail#getSubject", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getSubject", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Gets the `subject` of the email.", + "heading": "Description" + } + ], + "signature": "getSubject(): string | null", + "source": "script-api", + "tags": [ + "getsubject", + "mail.getsubject" + ], + "title": "Mail.getSubject" + }, + { + "description": "Gets the `to` address List where the email is sent.", + "id": "script-api:dw/net/Mail#getTo", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.getTo", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Gets the `to` address List where the email is sent.", + "heading": "Description" + } + ], + "signature": "getTo(): List", + "source": "script-api", + "tags": [ + "getto", + "mail.getto" + ], + "title": "Mail.getTo" + }, + { + "description": "Gets the `replyTo` address List.", + "id": "script-api:dw/net/Mail#replyTo", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.replyTo", + "sections": [ + { + "body": "Gets the `replyTo` address List.", + "heading": "Description" + } + ], + "signature": "readonly replyTo: List", + "source": "script-api", + "tags": [ + "replyto", + "mail.replyto" + ], + "title": "Mail.replyTo" + }, + { + "description": "prepares an email that is queued to the internal mail system for delivery.", + "id": "script-api:dw/net/Mail#send", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.send", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "prepares an email that is queued to the internal mail system for\ndelivery.", + "heading": "Description" + } + ], + "signature": "send(): Status", + "source": "script-api", + "tags": [ + "send", + "mail.send" + ], + "title": "Mail.send" + }, + { + "description": "Sets the `bcc` address List. If there are already `bcc` addresses they are overwritten.", + "id": "script-api:dw/net/Mail#setBcc", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "bcc", + "type": "List" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setBcc", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Sets the `bcc` address List. If there\nare already `bcc` addresses they are overwritten.", + "heading": "Description" + } + ], + "signature": "setBcc(bcc: List): Mail", + "source": "script-api", + "tags": [ + "setbcc", + "mail.setbcc" + ], + "title": "Mail.setBcc" + }, + { + "description": "Sets the `cc` address List where the email is sent. If there are already `cc` addresses set, they are overwritten. The address(es) must conform to the RFC822 standard.", + "id": "script-api:dw/net/Mail#setCc", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "cc", + "type": "List" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setCc", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Sets the `cc` address List where the email is sent. If there are\nalready `cc` addresses set, they are overwritten. The address(es) must\nconform to the RFC822 standard.", + "heading": "Description" + } + ], + "signature": "setCc(cc: List): Mail", + "source": "script-api", + "tags": [ + "setcc", + "mail.setcc" + ], + "title": "Mail.setCc" + }, + { + "description": "Mandatory Sets the email content. The MIME type is set to \"text/plain;charset=UTF-8\" and encoding set to \"UTF-8\".", + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "content", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Mandatory Sets the email content. The MIME type is set to\n\"text/plain;charset=UTF-8\" and encoding set to \"UTF-8\".", + "heading": "Description" + } + ], + "signature": "setContent(content: string): Mail", + "source": "script-api", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "description": "Mandatory Sets the email content, MIME type, and encoding. No validation of MIME type and encoding is done. It is the responsibility of the caller to specify a valid MIME type and encoding.", + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "content", + "type": "string" + }, + { + "name": "mimeType", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Mandatory Sets the email content, MIME type, and encoding. No\nvalidation of MIME type and encoding is done. It is the responsibility of\nthe caller to specify a valid MIME type and encoding.", + "heading": "Description" + } + ], + "signature": "setContent(content: string, mimeType: string, encoding: string): Mail", + "source": "script-api", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "description": "Mandatory Uses dw.value.MimeEncodedText to set the content, MIME type and encoding.", + "id": "script-api:dw/net/Mail#setContent", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "mimeEncodedText", + "type": "MimeEncodedText" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setContent", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Mandatory Uses dw.value.MimeEncodedText to set the\ncontent, MIME type and encoding.", + "heading": "Description" + } + ], + "signature": "setContent(mimeEncodedText: MimeEncodedText): Mail", + "source": "script-api", + "tags": [ + "setcontent", + "mail.setcontent" + ], + "title": "Mail.setContent" + }, + { + "description": "Mandatory Sets the sender address for this email. The address must conform to the RFC822 standard.", + "id": "script-api:dw/net/Mail#setFrom", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "from", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setFrom", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Mandatory Sets the sender address for this email. The address must\nconform to the RFC822 standard.", + "heading": "Description" + } + ], + "signature": "setFrom(from: string): Mail", + "source": "script-api", + "tags": [ + "setfrom", + "mail.setfrom" + ], + "title": "Mail.setFrom" + }, + { + "description": "Sets the List-Unsubscribe header value to work with List-Unsubscribe-Post to allow integration with an externally-managed mailing list.", + "id": "script-api:dw/net/Mail#setListUnsubscribe", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "listUnsubscribe", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setListUnsubscribe", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Sets the List-Unsubscribe header value to work with List-Unsubscribe-Post to allow integration with an\nexternally-managed mailing list.", + "heading": "Description" + } + ], + "signature": "setListUnsubscribe(listUnsubscribe: string): Mail", + "source": "script-api", + "tags": [ + "setlistunsubscribe", + "mail.setlistunsubscribe" + ], + "title": "Mail.setListUnsubscribe" + }, + { + "description": "Sets the List-Unsubscribe-Post header value. This header supports one-click unsubscribe functionality.", + "id": "script-api:dw/net/Mail#setListUnsubscribePost", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "listUnsubscribePost", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setListUnsubscribePost", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Sets the List-Unsubscribe-Post header value. This header supports one-click unsubscribe functionality.", + "heading": "Description" + } + ], + "signature": "setListUnsubscribePost(listUnsubscribePost: string): Mail", + "source": "script-api", + "tags": [ + "setlistunsubscribepost", + "mail.setlistunsubscribepost" + ], + "title": "Mail.setListUnsubscribePost" + }, + { + "description": "Mandatory sets the `subject` for the email. If the `subject` is not set or set to null at the time dw.net.Mail.send is invoked and IllegalArgumentException is thrown.", + "id": "script-api:dw/net/Mail#setSubject", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "subject", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setSubject", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Mandatory sets the `subject` for the email. If the `subject` is not set\nor set to null at the time dw.net.Mail.send is invoked and\nIllegalArgumentException is thrown.", + "heading": "Description" + } + ], + "signature": "setSubject(subject: string): Mail", + "source": "script-api", + "tags": [ + "setsubject", + "mail.setsubject" + ], + "title": "Mail.setSubject" + }, + { + "description": "Sets the `to` address List where the email is sent. If there are already `to` addresses, they are overwritten.", + "id": "script-api:dw/net/Mail#setTo", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "to", + "type": "List" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.setTo", + "returns": { + "type": "Mail" + }, + "sections": [ + { + "body": "Sets the `to` address List where the email is sent. If there are\nalready `to` addresses, they are overwritten.", + "heading": "Description" + } + ], + "signature": "setTo(to: List): Mail", + "source": "script-api", + "tags": [ + "setto", + "mail.setto" + ], + "title": "Mail.setTo" + }, + { + "description": "Gets the `subject` of the email.", + "id": "script-api:dw/net/Mail#subject", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.subject", + "sections": [ + { + "body": "Gets the `subject` of the email.", + "heading": "Description" + } + ], + "signature": "subject: string | null", + "source": "script-api", + "tags": [ + "subject", + "mail.subject" + ], + "title": "Mail.subject" + }, + { + "description": "Gets the `to` address List where the email is sent.", + "id": "script-api:dw/net/Mail#to", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.to", + "sections": [ + { + "body": "Gets the `to` address List where the email is sent.", + "heading": "Description" + } + ], + "signature": "to: List", + "source": "script-api", + "tags": [ + "to", + "mail.to" + ], + "title": "Mail.to" + }, + { + "description": "Validates the address that is sent as parameter. This validation includes:", + "id": "script-api:dw/net/Mail#validateAddress", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "address", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.validateAddress", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Validates the address that is sent as parameter.\nThis validation includes:\n\n- The format must match RFC822\n- The address must be 7-bit ASCII\n- The top-level domain must be IANA-registered\n- Sample domains such as example.com are not allowed", + "heading": "Description" + } + ], + "signature": "static validateAddress(address: string): boolean", + "source": "script-api", + "tags": [ + "validateaddress", + "mail.validateaddress" + ], + "title": "Mail.validateAddress" + }, + { + "description": "Validates the address that is sent as parameter. This validation includes:", + "id": "script-api:dw/net/Mail#validateAddress", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "address", + "type": "string" + } + ], + "parentId": "script-api:dw/net/Mail", + "qualifiedName": "dw.net.Mail.validateAddress", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Validates the address that is sent as parameter.\nThis validation includes:\n\n- The format must match RFC822\n- The address must be 7-bit ASCII\n- The top-level domain must be IANA-registered\n- Sample domains such as example.com are not allowed", + "heading": "Description" + } + ], + "signature": "static validateAddress(address: string): boolean", + "source": "script-api", + "tags": [ + "validateaddress", + "mail.validateaddress" + ], + "title": "Mail.validateAddress" + }, + { + "description": "The SFTPClient class supports the SFTP commands GET, PUT, DEL, MKDIR, RENAME, and LIST. The transfer of files can be text or binary.", + "examples": [ + "`\nvar sftp : SFTPClient = new dw.net.SFTPClient();\nsftp.connect(\"my.sftp-server.com\", \"username\", \"password\");\nvar data : String = sftp.get(\"simple.txt\");\nsftp.disconnect();\n`" + ], + "id": "script-api:dw/net/SFTPClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.SFTPClient", + "sections": [ + { + "body": "The SFTPClient class supports the SFTP commands GET, PUT, DEL, MKDIR, RENAME, and LIST. The transfer of files can be\ntext or binary.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information.\n\nAn example usage is as follows:\n\n\nThe default connection timeout depends on the script context timeout and will be set to a maximum of 30 seconds\n(default script context timeout is 10 seconds within storefront requests and 15 minutes within jobs).\n\nIMPORTANT NOTE: Before you can make an outbound SFTP connection to a port other than 22, the SFTP server IP address must be enabled\nfor outbound traffic at the Commerce Cloud Digital firewall for your POD. Please file a support request to request a new firewall\nrule.\n\nSSH Version 2 is supported with the following algorithms:\n\nType Algorithms\nHost Key ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521,\nrsa-sha2-512, rsa-sha2-256, ssh-rsa, ssh-dss\nKey Exchange (KEX) curve25519-sha256, curve25519-sha256@libssh.org, ecdh-sha2-nistp256,\necdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group-exchange-sha256,\ndiffie-hellman-group16-sha512, diffie-hellman-group18-sha512, diffie-hellman-group14-sha256,\ndiffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1\nCipher aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com,\naes256-gcm@openssh.com, aes128-cbc, 3des-ctr, 3des-cbc, blowfish-cbc, aes192-cbc,\naes256-cbc\nMessage Authentication Code (MAC) hmac-sha2-256-etm@openssh.com, hmac-sha2-512-etm@openssh.com,\nhmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-512, hmac-sha1, hmac-md5, hmac-sha1-96,\nhmac-md5-96\nPublic Key Authentication rsa-sha2-512, rsa-sha2-256, ssh-rsa", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sftpclient", + "dw.net.sftpclient", + "dw/net" + ], + "title": "SFTPClient" + }, + { + "description": "The maximum size for get() methods returning a File is 200 MB.", + "id": "script-api:dw/net/SFTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for get() methods returning a File is 200 MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE = 209715200", + "source": "script-api", + "tags": [ + "max_get_file_size", + "sftpclient.max_get_file_size" + ], + "title": "SFTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for get() methods returning a File is 200 MB.", + "id": "script-api:dw/net/SFTPClient#MAX_GET_FILE_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for get() methods returning a File is 200 MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE = 209715200", + "source": "script-api", + "tags": [ + "max_get_file_size", + "sftpclient.max_get_file_size" + ], + "title": "SFTPClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for get() methods returning a String is 10 MB.", + "id": "script-api:dw/net/SFTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for get() methods returning a String is 10 MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE = 10485760", + "source": "script-api", + "tags": [ + "max_get_string_size", + "sftpclient.max_get_string_size" + ], + "title": "SFTPClient.MAX_GET_STRING_SIZE" + }, + { + "description": "The maximum size for get() methods returning a String is 10 MB.", + "id": "script-api:dw/net/SFTPClient#MAX_GET_STRING_SIZE", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for get() methods returning a String is 10 MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE = 10485760", + "source": "script-api", + "tags": [ + "max_get_string_size", + "sftpclient.max_get_string_size" + ], + "title": "SFTPClient.MAX_GET_STRING_SIZE" + }, + { + "description": "Adds a known public host key for the next connection attempt.", + "id": "script-api:dw/net/SFTPClient#addKnownHostKey", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.addKnownHostKey", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a known public host key for the next connection attempt.\n\nThis method associates the key to the host used in the subsequent connect method, and must be called prior to connect.\nThe key is not persisted, and is only associated to this instance of the SFTP client.\n\nMultiple keys may be added, and the validation will succeed if the remote host matches any of them.\n\nThe default behavior is to persist and trust an unknown host key if there are no known host keys available.\nIf addKnownHostKey is later used to trust specific a specific key or keys, then any previously persisted keys\nwill be ignored.", + "heading": "Description" + } + ], + "signature": "addKnownHostKey(type: string, key: string): void", + "source": "script-api", + "tags": [ + "addknownhostkey", + "sftpclient.addknownhostkey" + ], + "title": "SFTPClient.addKnownHostKey" + }, + { + "description": "Changes the current directory on the remote server to the given path.", + "id": "script-api:dw/net/SFTPClient#cd", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.cd", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Changes the current directory on the remote server to the given path.", + "heading": "Description" + } + ], + "signature": "cd(path: string): boolean", + "source": "script-api", + "tags": [ + "cd", + "sftpclient.cd" + ], + "title": "SFTPClient.cd" + }, + { + "description": "Connects and logs on to a SFTP server and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/SFTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to a SFTP server and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string, user: string, password: string): boolean", + "source": "script-api", + "tags": [ + "connect", + "sftpclient.connect" + ], + "title": "SFTPClient.connect" + }, + { + "description": "Connects and logs on to a SFTP server and returns a boolean indicating success or failure.", + "id": "script-api:dw/net/SFTPClient#connect", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "host", + "type": "string" + }, + { + "name": "port", + "type": "number" + }, + { + "name": "user", + "type": "string" + }, + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Connects and logs on to a SFTP server and returns a boolean indicating success or failure.", + "heading": "Description" + } + ], + "signature": "connect(host: string, port: number, user: string, password: string): boolean", + "source": "script-api", + "tags": [ + "connect", + "sftpclient.connect" + ], + "title": "SFTPClient.connect" + }, + { + "description": "Identifies if the SFTP client is currently connected to the SFTP server.", + "id": "script-api:dw/net/SFTPClient#connected", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.connected", + "sections": [ + { + "body": "Identifies if the SFTP client is currently connected to the SFTP server.", + "heading": "Description" + } + ], + "signature": "readonly connected: boolean", + "source": "script-api", + "tags": [ + "connected", + "sftpclient.connected" + ], + "title": "SFTPClient.connected" + }, + { + "description": "Deletes the remote file on the server identified by the path parameter.", + "id": "script-api:dw/net/SFTPClient#del", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.del", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes the remote file on the server identified by the path parameter.", + "heading": "Description" + } + ], + "signature": "del(path: string): boolean", + "source": "script-api", + "tags": [ + "del", + "sftpclient.del" + ], + "title": "SFTPClient.del" + }, + { + "description": "The method first logs the current user out from the server and then disconnects from the server.", + "id": "script-api:dw/net/SFTPClient#disconnect", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.disconnect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method first logs the current user out from the server and then disconnects from the server.", + "heading": "Description" + } + ], + "signature": "disconnect(): void", + "source": "script-api", + "tags": [ + "disconnect", + "sftpclient.disconnect" + ], + "title": "SFTPClient.disconnect" + }, + { + "description": "Returns the error message from the last SFTP action.", + "id": "script-api:dw/net/SFTPClient#errorMessage", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.errorMessage", + "sections": [ + { + "body": "Returns the error message from the last SFTP action.", + "heading": "Description" + } + ], + "signature": "readonly errorMessage: string", + "source": "script-api", + "tags": [ + "errormessage", + "sftpclient.errormessage" + ], + "title": "SFTPClient.errorMessage" + }, + { + "description": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Files with at most MAX_GET_STRING_SIZE bytes are read.", + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as a string using \"ISO-8859-1\" encoding to read it. Files with\nat most MAX_GET_STRING_SIZE bytes are read.", + "heading": "Description" + } + ], + "signature": "get(path: string): string | null", + "source": "script-api", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "description": "Reads the content of a remote file and returns it as a string using the specified encoding. Files with at most MAX_GET_STRING_SIZE bytes are read.", + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Reads the content of a remote file and returns it as a string using the specified encoding. Files with at most\nMAX_GET_STRING_SIZE bytes are read.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string): string | null", + "source": "script-api", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "description": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to read the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most MAX_GET_FILE_SIZE bytes.", + "id": "script-api:dw/net/SFTPClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to\nread the file content and using the system standard encoding \"UTF-8\" to write the file. Copies at most\nMAX_GET_FILE_SIZE bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string, file: File): boolean", + "source": "script-api", + "tags": [ + "get", + "sftpclient.get" + ], + "title": "SFTPClient.get" + }, + { + "description": "Reads the content of a remote file and creates a local copy in the given file. Copies at most MAX_GET_FILE_SIZE bytes. The SFTP transfer is done in binary mode.", + "id": "script-api:dw/net/SFTPClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file and creates a local copy in the given file. Copies at most MAX_GET_FILE_SIZE\nbytes. The SFTP transfer is done in binary mode.", + "heading": "Description" + } + ], + "signature": "getBinary(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "getbinary", + "sftpclient.getbinary" + ], + "title": "SFTPClient.getBinary" + }, + { + "description": "Identifies if the SFTP client is currently connected to the SFTP server.", + "id": "script-api:dw/net/SFTPClient#getConnected", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getConnected", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the SFTP client is currently connected to the SFTP server.", + "heading": "Description" + } + ], + "signature": "getConnected(): boolean", + "source": "script-api", + "tags": [ + "getconnected", + "sftpclient.getconnected" + ], + "title": "SFTPClient.getConnected" + }, + { + "description": "Returns the error message from the last SFTP action.", + "id": "script-api:dw/net/SFTPClient#getErrorMessage", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getErrorMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the error message from the last SFTP action.", + "heading": "Description" + } + ], + "signature": "getErrorMessage(): string", + "source": "script-api", + "tags": [ + "geterrormessage", + "sftpclient.geterrormessage" + ], + "title": "SFTPClient.getErrorMessage" + }, + { + "description": "Returns a SFTPFileInfo objects containing information about the given file/directory path.", + "id": "script-api:dw/net/SFTPClient#getFileInfo", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getFileInfo", + "returns": { + "type": "SFTPFileInfo | null" + }, + "sections": [ + { + "body": "Returns a SFTPFileInfo objects containing information about the given file/directory path.", + "heading": "Description" + } + ], + "signature": "getFileInfo(path: string): SFTPFileInfo | null", + "source": "script-api", + "tags": [ + "getfileinfo", + "sftpclient.getfileinfo" + ], + "title": "SFTPClient.getFileInfo" + }, + { + "description": "Gets the identity (private key) used for the connection.", + "id": "script-api:dw/net/SFTPClient#getIdentity", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getIdentity", + "returns": { + "type": "KeyRef | null" + }, + "sections": [ + { + "body": "Gets the identity (private key) used for the connection.\n\nThe key is only associated to this instance of the SFTP client.", + "heading": "Description" + } + ], + "signature": "getIdentity(): KeyRef | null", + "source": "script-api", + "tags": [ + "getidentity", + "sftpclient.getidentity" + ], + "title": "SFTPClient.getIdentity" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/SFTPClient#getTimeout", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.getTimeout", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "getTimeout(): number", + "source": "script-api", + "tags": [ + "gettimeout", + "sftpclient.gettimeout" + ], + "title": "SFTPClient.getTimeout" + }, + { + "description": "Gets the identity (private key) used for the connection.", + "id": "script-api:dw/net/SFTPClient#identity", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.identity", + "sections": [ + { + "body": "Gets the identity (private key) used for the connection.\n\nThe key is only associated to this instance of the SFTP client.", + "heading": "Description" + } + ], + "signature": "identity: KeyRef | null", + "source": "script-api", + "tags": [ + "identity", + "sftpclient.identity" + ], + "title": "SFTPClient.identity" + }, + { + "description": "Returns a list of SFTPFileInfo objects containing information about the files in the current directory.", + "id": "script-api:dw/net/SFTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.list", + "returns": { + "type": "SFTPFileInfo[] | null" + }, + "sections": [ + { + "body": "Returns a list of SFTPFileInfo objects containing information about the files in the current directory.", + "heading": "Description" + } + ], + "signature": "list(): SFTPFileInfo[] | null", + "source": "script-api", + "tags": [ + "list", + "sftpclient.list" + ], + "title": "SFTPClient.list" + }, + { + "description": "Returns a list of SFTPFileInfo objects containing information about the files in the remote directory defined by the given path.", + "id": "script-api:dw/net/SFTPClient#list", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.list", + "returns": { + "type": "SFTPFileInfo[] | null" + }, + "sections": [ + { + "body": "Returns a list of SFTPFileInfo objects containing information about the files in the remote directory defined by\nthe given path.", + "heading": "Description" + } + ], + "signature": "list(path: string): SFTPFileInfo[] | null", + "source": "script-api", + "tags": [ + "list", + "sftpclient.list" + ], + "title": "SFTPClient.list" + }, + { + "description": "Creates a directory", + "id": "script-api:dw/net/SFTPClient#mkdir", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.mkdir", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Creates a directory", + "heading": "Description" + } + ], + "signature": "mkdir(path: string): boolean", + "source": "script-api", + "tags": [ + "mkdir", + "sftpclient.mkdir" + ], + "title": "SFTPClient.mkdir" + }, + { + "description": "Puts the specified content to the specified path using \"ISO-8859-1\" encoding. If the content of a local file is to be uploaded, please use method putBinary(String,File) instead.", + "id": "script-api:dw/net/SFTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Puts the specified content to the specified path using \"ISO-8859-1\" encoding. If the content of a local file is\nto be uploaded, please use method putBinary(String,File) instead.\n\nNOTE: If the remote file already exists, it is overwritten.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string): boolean", + "source": "script-api", + "tags": [ + "put", + "sftpclient.put" + ], + "title": "SFTPClient.put" + }, + { + "description": "Put the given content to a file on the given path on the SFTP server. The transformation from String into binary data is done via the encoding provided with the method call. If the content of a local file is to be uploaded, please use method putBinary(String,File) instead.", + "id": "script-api:dw/net/SFTPClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Put the given content to a file on the given path on the SFTP server. The transformation from String into binary\ndata is done via the encoding provided with the method call. If the content of a local file is to be uploaded,\nplease use method putBinary(String,File) instead.\n\nNOTE: If the remote file already exists, it is overwritten.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string, encoding: string): boolean", + "source": "script-api", + "tags": [ + "put", + "sftpclient.put" + ], + "title": "SFTPClient.put" + }, + { + "description": "Put the content of the given file into a file on the remote SFTP server with the given absolute path. NOTE: If the remote file already exists, it is overwritten.", + "id": "script-api:dw/net/SFTPClient#putBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.putBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Put the content of the given file into a file on the remote SFTP server with the given absolute path. NOTE: If\nthe remote file already exists, it is overwritten.", + "heading": "Description" + } + ], + "signature": "putBinary(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "putbinary", + "sftpclient.putbinary" + ], + "title": "SFTPClient.putBinary" + }, + { + "description": "Deletes the remote directory on the server identified by the path parameter. In order to delete the directory successfully the directory needs to be empty, otherwise the removeDirectory() method will return false.", + "id": "script-api:dw/net/SFTPClient#removeDirectory", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.removeDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes the remote directory on the server identified by the path parameter. In order to delete the directory\nsuccessfully the directory needs to be empty, otherwise the removeDirectory() method will return false.", + "heading": "Description" + } + ], + "signature": "removeDirectory(path: string): boolean", + "source": "script-api", + "tags": [ + "removedirectory", + "sftpclient.removedirectory" + ], + "title": "SFTPClient.removeDirectory" + }, + { + "description": "Renames an existing file.", + "id": "script-api:dw/net/SFTPClient#rename", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "from", + "type": "string" + }, + { + "name": "to", + "type": "string" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.rename", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Renames an existing file.", + "heading": "Description" + } + ], + "signature": "rename(from: string, to: string): boolean", + "source": "script-api", + "tags": [ + "rename", + "sftpclient.rename" + ], + "title": "SFTPClient.rename" + }, + { + "description": "Sets the identity (private key) to use for the next connection attempt.", + "id": "script-api:dw/net/SFTPClient#setIdentity", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.setIdentity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the identity (private key) to use for the next connection attempt.\n\nThe key is only associated to this instance of the SFTP client.", + "heading": "Description" + } + ], + "signature": "setIdentity(keyRef: KeyRef): void", + "source": "script-api", + "tags": [ + "setidentity", + "sftpclient.setidentity" + ], + "title": "SFTPClient.setIdentity" + }, + { + "description": "Sets the timeout for connections made with the SFTP client to the given number of milliseconds. If the given timeout is less than or equal to zero, the timeout is set to the same value as the script context timeout but will only be set to a maximum of 30 seconds.", + "id": "script-api:dw/net/SFTPClient#setTimeout", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "timeoutMillis", + "type": "number" + } + ], + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.setTimeout", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the timeout for connections made with the SFTP client to the given number of milliseconds. If the given\ntimeout is less than or equal to zero, the timeout is set to the same value as the script context timeout but\nwill only be set to a maximum of 30 seconds.\n\nThe maximum and default timeout depend on the script context timeout. The maximum timeout is set to a maximum of\n2 minutes. The default timeout for a new client is set to a maximum of 30 seconds.\n\nThis method can be called at any time, and will affect the next connection made with this client. It is not\npossible to set the timeout for an open connection.", + "heading": "Description" + } + ], + "signature": "setTimeout(timeoutMillis: number): void", + "source": "script-api", + "tags": [ + "settimeout", + "sftpclient.settimeout" + ], + "title": "SFTPClient.setTimeout" + }, + { + "description": "Returns the timeout for this client, in milliseconds.", + "id": "script-api:dw/net/SFTPClient#timeout", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPClient", + "qualifiedName": "dw.net.SFTPClient.timeout", + "sections": [ + { + "body": "Returns the timeout for this client, in milliseconds.", + "heading": "Description" + } + ], + "signature": "timeout: number", + "source": "script-api", + "tags": [ + "timeout", + "sftpclient.timeout" + ], + "title": "SFTPClient.timeout" + }, + { + "description": "The class is used to store information about a remote file.", + "id": "script-api:dw/net/SFTPFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.SFTPFileInfo", + "sections": [ + { + "body": "The class is used to store information about a remote file.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sftpfileinfo", + "dw.net.sftpfileinfo", + "dw/net" + ], + "title": "SFTPFileInfo" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/SFTPFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.directory", + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "readonly directory: boolean", + "source": "script-api", + "tags": [ + "directory", + "sftpfileinfo.directory" + ], + "title": "SFTPFileInfo.directory" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/SFTPFileInfo#getDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "getDirectory(): boolean", + "source": "script-api", + "tags": [ + "getdirectory", + "sftpfileinfo.getdirectory" + ], + "title": "SFTPFileInfo.getDirectory" + }, + { + "description": "Returns the last modification time of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#getModificationTime", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getModificationTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the last modification time of the file/directory.", + "heading": "Description" + } + ], + "signature": "getModificationTime(): Date", + "source": "script-api", + "tags": [ + "getmodificationtime", + "sftpfileinfo.getmodificationtime" + ], + "title": "SFTPFileInfo.getModificationTime" + }, + { + "description": "Returns the name of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the file/directory.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "sftpfileinfo.getname" + ], + "title": "SFTPFileInfo.getName" + }, + { + "description": "Returns the size of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.getSize", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the file/directory.", + "heading": "Description" + } + ], + "signature": "getSize(): number", + "source": "script-api", + "tags": [ + "getsize", + "sftpfileinfo.getsize" + ], + "title": "SFTPFileInfo.getSize" + }, + { + "description": "Returns the last modification time of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#modificationTime", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.modificationTime", + "sections": [ + { + "body": "Returns the last modification time of the file/directory.", + "heading": "Description" + } + ], + "signature": "readonly modificationTime: Date", + "source": "script-api", + "tags": [ + "modificationtime", + "sftpfileinfo.modificationtime" + ], + "title": "SFTPFileInfo.modificationTime" + }, + { + "description": "Returns the name of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.name", + "sections": [ + { + "body": "Returns the name of the file/directory.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "sftpfileinfo.name" + ], + "title": "SFTPFileInfo.name" + }, + { + "description": "Returns the size of the file/directory.", + "id": "script-api:dw/net/SFTPFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/SFTPFileInfo", + "qualifiedName": "dw.net.SFTPFileInfo.size", + "sections": [ + { + "body": "Returns the size of the file/directory.", + "heading": "Description" + } + ], + "signature": "readonly size: number", + "source": "script-api", + "tags": [ + "size", + "sftpfileinfo.size" + ], + "title": "SFTPFileInfo.size" + }, + { + "description": "The WebDAVClient class supports the WebDAV methods GET, PUT, MKCOL, MOVE, COPY, PROPFIND,OPTIONS and DELETE.", + "examples": [ + "var webdavClient : WebDAVClient = new WebDAVClient(\"http://mywebdav.server.com\",\"myusername\", \"mypassword\");\nvar getString : String = webdavClient.get(\"myData.xml\",\"UTF-8\");\nvar message : String;\n\nif (webdavClient.succeeded())\n{\nmessage = webDavClient.statusText;\n}\nelse\n{\n// error handling\nmessage=\"An error occurred with status code \"+webdavClient.statusCode;\n}\n\nvar data : XML = new XML(getString);" + ], + "id": "script-api:dw/net/WebDAVClient", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.WebDAVClient", + "sections": [ + { + "body": "The WebDAVClient class supports the WebDAV methods GET, PUT, MKCOL, MOVE,\nCOPY, PROPFIND,OPTIONS and DELETE.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.\nThe client can be used as shown in the following example:\n\n\nThe WebDAV client supports the following authentication schemes:\n\n- Basic authentication\n- Digest authentication\n\nThe methods of this class do not generally throw exceptions if the underlying\nWebDAV operation do not succeed.The result of a WebDAV operation can be\nchecked using the methods succeeded(), getStatusCode(), and getStatusText().\n\nImportant note: This WebDAV client cannot be used to access the Commerce Cloud Digital\nserver via WebDAV protocol.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "webdavclient", + "dw.net.webdavclient", + "dw/net" + ], + "title": "WebDAVClient" + }, + { + "description": "The default encoding character set.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_ENCODING", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_ENCODING", + "sections": [ + { + "body": "The default encoding character set.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_ENCODING = \"UTF-8\"", + "source": "script-api", + "tags": [ + "default_encoding", + "webdavclient.default_encoding" + ], + "title": "WebDAVClient.DEFAULT_ENCODING" + }, + { + "description": "The default encoding character set.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_ENCODING", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_ENCODING", + "sections": [ + { + "body": "The default encoding character set.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_ENCODING = \"UTF-8\"", + "source": "script-api", + "tags": [ + "default_encoding", + "webdavclient.default_encoding" + ], + "title": "WebDAVClient.DEFAULT_ENCODING" + }, + { + "description": "The default size for `get()` returning a File is 5MB.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a File is 5MB.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_file_size", + "webdavclient.default_get_file_size" + ], + "title": "WebDAVClient.DEFAULT_GET_FILE_SIZE" + }, + { + "description": "The default size for `get()` returning a File is 5MB.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_FILE_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a File is 5MB.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_file_size", + "webdavclient.default_get_file_size" + ], + "title": "WebDAVClient.DEFAULT_GET_FILE_SIZE" + }, + { + "description": "The default size for `get()` returning a String is 2MB.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_STRING_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a String is 2MB.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_STRING_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_string_size", + "webdavclient.default_get_string_size" + ], + "title": "WebDAVClient.DEFAULT_GET_STRING_SIZE" + }, + { + "description": "The default size for `get()` returning a String is 2MB.", + "id": "script-api:dw/net/WebDAVClient#DEFAULT_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEFAULT_GET_STRING_SIZE", + "sections": [ + { + "body": "The default size for `get()` returning a String is 2MB.", + "heading": "Description" + } + ], + "signature": "static readonly DEFAULT_GET_STRING_SIZE: number", + "source": "script-api", + "tags": [ + "default_get_string_size", + "webdavclient.default_get_string_size" + ], + "title": "WebDAVClient.DEFAULT_GET_STRING_SIZE" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be searched only on the level of the given path and a list of all containing files on that level will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_0", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_0", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be searched only on the level of the given path and a\nlist of all containing files on that level will be returned [is not\nsupported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_0 = 0", + "source": "script-api", + "tags": [ + "depth_0", + "webdavclient.depth_0" + ], + "title": "WebDAVClient.DEPTH_0" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be searched only on the level of the given path and a list of all containing files on that level will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_0", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_0", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be searched only on the level of the given path and a\nlist of all containing files on that level will be returned [is not\nsupported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_0 = 0", + "source": "script-api", + "tags": [ + "depth_0", + "webdavclient.depth_0" + ], + "title": "WebDAVClient.DEPTH_0" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be searched until one level under the given path and a list of all containing files in that two levels [/path and one level underneath] will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_1", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_1", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be searched until one level under the given path and a\nlist of all containing files in that two levels [/path and one level\nunderneath] will be returned [is not supported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_1 = 1", + "source": "script-api", + "tags": [ + "depth_1", + "webdavclient.depth_1" + ], + "title": "WebDAVClient.DEPTH_1" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be searched until one level under the given path and a list of all containing files in that two levels [/path and one level underneath] will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_1", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_1", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be searched until one level under the given path and a\nlist of all containing files in that two levels [/path and one level\nunderneath] will be returned [is not supported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_1 = 1", + "source": "script-api", + "tags": [ + "depth_1", + "webdavclient.depth_1" + ], + "title": "WebDAVClient.DEPTH_1" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be fully searched and a list of all containing files will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_INIFINITY", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_INIFINITY", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be fully searched and a list of all containing files\nwill be returned [is not supported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_INIFINITY = 2147483647", + "source": "script-api", + "tags": [ + "depth_inifinity", + "webdavclient.depth_inifinity" + ], + "title": "WebDAVClient.DEPTH_INIFINITY" + }, + { + "description": "The depth of searching a WebDAV destination using the PROPFIND method - if that depth is given to the PROPFIND method as an input parameter the destination will be fully searched and a list of all containing files will be returned [is not supported by every server].", + "id": "script-api:dw/net/WebDAVClient#DEPTH_INIFINITY", + "kind": "constant", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.DEPTH_INIFINITY", + "sections": [ + { + "body": "The depth of searching a WebDAV destination using the PROPFIND method -\nif that depth is given to the PROPFIND method as an input parameter the\ndestination will be fully searched and a list of all containing files\nwill be returned [is not supported by every server].", + "heading": "Description" + } + ], + "signature": "static readonly DEPTH_INIFINITY = 2147483647", + "source": "script-api", + "tags": [ + "depth_inifinity", + "webdavclient.depth_inifinity" + ], + "title": "WebDAVClient.DEPTH_INIFINITY" + }, + { + "description": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The largest file allowed is 200MB.", + "id": "script-api:dw/net/WebDAVClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a File is forty times\nthe default size for getting a file. The largest file allowed is 200MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_file_size", + "webdavclient.max_get_file_size" + ], + "title": "WebDAVClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for `get()` returning a File is forty times the default size for getting a file. The largest file allowed is 200MB.", + "id": "script-api:dw/net/WebDAVClient#MAX_GET_FILE_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_FILE_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a File is forty times\nthe default size for getting a file. The largest file allowed is 200MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_FILE_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_file_size", + "webdavclient.max_get_file_size" + ], + "title": "WebDAVClient.MAX_GET_FILE_SIZE" + }, + { + "description": "The maximum size for `get()` returning a String is five times the default size for getting a String. The largest String allowed is 10MB.", + "id": "script-api:dw/net/WebDAVClient#MAX_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a String is five\ntimes the default size for getting a String. The largest String allowed\nis 10MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_string_size", + "webdavclient.max_get_string_size" + ], + "title": "WebDAVClient.MAX_GET_STRING_SIZE" + }, + { + "description": "The maximum size for `get()` returning a String is five times the default size for getting a String. The largest String allowed is 10MB.", + "id": "script-api:dw/net/WebDAVClient#MAX_GET_STRING_SIZE", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.MAX_GET_STRING_SIZE", + "sections": [ + { + "body": "The maximum size for `get()` returning a String is five\ntimes the default size for getting a String. The largest String allowed\nis 10MB.", + "heading": "Description" + } + ], + "signature": "static readonly MAX_GET_STRING_SIZE: number", + "source": "script-api", + "tags": [ + "max_get_string_size", + "webdavclient.max_get_string_size" + ], + "title": "WebDAVClient.MAX_GET_STRING_SIZE" + }, + { + "description": "Adds a request header to the next WebDAV call.", + "id": "script-api:dw/net/WebDAVClient#addRequestHeader", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "headerName", + "type": "string" + }, + { + "name": "headerValue", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.addRequestHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a request header to the next WebDAV call.", + "heading": "Description" + } + ], + "signature": "addRequestHeader(headerName: string, headerValue: string): void", + "source": "script-api", + "tags": [ + "addrequestheader", + "webdavclient.addrequestheader" + ], + "title": "WebDAVClient.addRequestHeader" + }, + { + "description": "Returns a dw.util.HashMap of all response headers.", + "id": "script-api:dw/net/WebDAVClient#allResponseHeaders", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.allResponseHeaders", + "sections": [ + { + "body": "Returns a dw.util.HashMap of all response headers.", + "heading": "Description" + } + ], + "signature": "readonly allResponseHeaders: HashMap", + "source": "script-api", + "tags": [ + "allresponseheaders", + "webdavclient.allresponseheaders" + ], + "title": "WebDAVClient.allResponseHeaders" + }, + { + "description": "Closes the current connection to the server.", + "id": "script-api:dw/net/WebDAVClient#close", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.close", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Closes the current connection to the server.", + "heading": "Description" + } + ], + "signature": "close(): void", + "source": "script-api", + "tags": [ + "close", + "webdavclient.close" + ], + "title": "WebDAVClient.close" + }, + { + "description": "Copies a file on the server from one place `rootUrl`/`origin` to the other `rootUrl`/`destination`. If `destination` already exists it gets overwritten. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "origin", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Copies a file on the server from one place `rootUrl`/`origin`\nto the other `rootUrl`/`destination`. If\n`destination` already exists it gets overwritten. Returns\ntrue if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "copy(origin: string, destination: string): boolean", + "source": "script-api", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "description": "Copies a file on the server from one place `rootUrl`/`origin` to the other `rootUrl`/`destination`. If the passed parameter `overwrite` is true and `destination` already exists it gets overwritten. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "origin", + "type": "string" + }, + { + "name": "destination", + "type": "string" + }, + { + "name": "overwrite", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Copies a file on the server from one place `rootUrl`/`origin`\nto the other `rootUrl`/`destination`. If\nthe passed parameter `overwrite` is true and\n`destination` already exists it gets overwritten. Returns\ntrue if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "copy(origin: string, destination: string, overwrite: boolean): boolean", + "source": "script-api", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "description": "Copies a file on the server from one place `rootUrl`/`origin` to the other `rootUrl`/`destination`. If the passed parameter `overwrite` is true and `destination` already exists it gets overwritten. If the passed parameter `shallow` is true a flat copy mechanism is used.", + "id": "script-api:dw/net/WebDAVClient#copy", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "origin", + "type": "string" + }, + { + "name": "destination", + "type": "string" + }, + { + "name": "overwrite", + "type": "boolean" + }, + { + "name": "shallow", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.copy", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Copies a file on the server from one place `rootUrl`/`origin`\nto the other `rootUrl`/`destination`. If\nthe passed parameter `overwrite` is true and\n`destination` already exists it gets overwritten. If the\npassed parameter `shallow` is true a flat copy mechanism is\nused.\n\nReturns true if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "copy(origin: string, destination: string, overwrite: boolean, shallow: boolean): boolean", + "source": "script-api", + "tags": [ + "copy", + "webdavclient.copy" + ], + "title": "WebDAVClient.copy" + }, + { + "description": "Deletes a file or directory from the remote server that can be found under `rootUrl`/`path`. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#del", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.del", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Deletes a file or directory from the remote server that can be found\nunder `rootUrl`/`path`. Returns true if\nsucceeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "del(path: string): boolean", + "source": "script-api", + "tags": [ + "del", + "webdavclient.del" + ], + "title": "WebDAVClient.del" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` and returns a string representation of the data found in the DEFAULT_ENCODING encoding. If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Returns at most DEFAULT_GET_STRING_SIZE bytes.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` and returns a string\nrepresentation of the data found in the DEFAULT_ENCODING encoding. If the\nremote location is a directory the result depends on the server\nconfiguration, some return an HTML formatted directory listing. Returns\nat most DEFAULT_GET_STRING_SIZE bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string): string", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` and returns a string representation of the data found in the given `encoding`. If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Returns at most DEFAULT_GET_STRING_SIZE bytes.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` and returns a string\nrepresentation of the data found in the given `encoding`. If\nthe remote location is a directory the result depends on the server\nconfiguration, some return an HTML formatted directory listing. Returns\nat most DEFAULT_GET_STRING_SIZE bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string): string", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` and returns a string representation of the data found in the given `encoding`. If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Returns at most maxGetSize bytes.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "maxGetSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` and returns a string\nrepresentation of the data found in the given `encoding`. If\nthe remote location is a directory the result depends on the server\nconfiguration, some return an HTML formatted directory listing. Returns\nat most maxGetSize bytes.", + "heading": "Description" + } + ], + "signature": "get(path: string, encoding: string, maxGetSize: number): string", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` in DEFAULT_ENCODING encoding and writes a dw.io.File in the system's standard encoding, which is \"UTF-8\". If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Receives at most DEFAULT_GET_FILE_SIZE bytes which determines the file size of the local file. Returns true if succeeded otherwise false.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` in DEFAULT_ENCODING\nencoding and writes a dw.io.File in the system's standard\nencoding, which is \"UTF-8\". If the remote location is a directory the\nresult depends on the server configuration, some return an HTML formatted\ndirectory listing. Receives at most DEFAULT_GET_FILE_SIZE bytes which\ndetermines the file size of the local file. Returns true if succeeded\notherwise false.", + "heading": "Description" + } + ], + "signature": "get(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` in DEFAULT_ENCODING encoding and writes a dw.io.File in the system's standard encoding, which is \"UTF-8\". If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Receives at most maxFileSize bytes which determines the file size of the local file. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + }, + { + "name": "maxFileSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` in DEFAULT_ENCODING\nencoding and writes a dw.io.File in the system's standard\nencoding, which is \"UTF-8\". If the remote location is a directory the\nresult depends on the server configuration, some return an HTML formatted\ndirectory listing. Receives at most maxFileSize bytes which determines\nthe file size of the local file. Returns true if succeeded, otherwise\nfalse.", + "heading": "Description" + } + ], + "signature": "get(path: string, file: File, maxFileSize: number): boolean", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Reads the content of a remote file or directory that can be found under `rootUrl`/`path` in the passed encoding and writes a dw.io.File in the system standard encoding, which is \"UTF-8\". If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Receives at most maxFileSize bytes which determines the file size of the local file. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#get", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + }, + { + "name": "encoding", + "type": "string" + }, + { + "name": "maxFileSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.get", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote file or directory that can be found under\n`rootUrl`/`path` in the passed encoding and\nwrites a dw.io.File in the system standard encoding, which is\n\"UTF-8\". If the remote location is a directory the result depends on the\nserver configuration, some return an HTML formatted directory listing.\nReceives at most maxFileSize bytes which determines the file size of the\nlocal file. Returns true if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "get(path: string, file: File, encoding: string, maxFileSize: number): boolean", + "source": "script-api", + "tags": [ + "get", + "webdavclient.get" + ], + "title": "WebDAVClient.get" + }, + { + "description": "Returns a dw.util.HashMap of all response headers.", + "id": "script-api:dw/net/WebDAVClient#getAllResponseHeaders", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getAllResponseHeaders", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns a dw.util.HashMap of all response headers.", + "heading": "Description" + } + ], + "signature": "getAllResponseHeaders(): HashMap", + "source": "script-api", + "tags": [ + "getallresponseheaders", + "webdavclient.getallresponseheaders" + ], + "title": "WebDAVClient.getAllResponseHeaders" + }, + { + "description": "Reads the content of a remote binary file that can be found under `rootUrl`/`path` and creates a local copy in dw.io.File. If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Copies at most DEFAULT_GET_FILE_SIZE bytes. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote binary file that can be found under\n`rootUrl`/`path` and creates a local copy\nin dw.io.File. If the remote location is a directory the result\ndepends on the server configuration, some return an HTML formatted\ndirectory listing. Copies at most DEFAULT_GET_FILE_SIZE bytes. Returns\ntrue if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "getBinary(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "getbinary", + "webdavclient.getbinary" + ], + "title": "WebDAVClient.getBinary" + }, + { + "description": "Reads the content of a remote binary file that can be found under `rootUrl`/`path` and creates a local copy in dw.io.File. If the remote location is a directory the result depends on the server configuration, some return an HTML formatted directory listing. Copies at most maxFileSize bytes. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#getBinary", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + }, + { + "name": "maxFileSize", + "type": "number" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getBinary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Reads the content of a remote binary file that can be found under\n`rootUrl`/`path` and creates a local copy\nin dw.io.File. If the remote location is a directory the result\ndepends on the server configuration, some return an HTML formatted\ndirectory listing. Copies at most maxFileSize bytes. Returns true if\nsucceeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "getBinary(path: string, file: File, maxFileSize: number): boolean", + "source": "script-api", + "tags": [ + "getbinary", + "webdavclient.getbinary" + ], + "title": "WebDAVClient.getBinary" + }, + { + "description": "Returns a specified response header - multiple headers are separated by CRLF.", + "id": "script-api:dw/net/WebDAVClient#getResponseHeader", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "header", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getResponseHeader", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a specified response header - multiple headers are separated by\nCRLF.", + "heading": "Description" + } + ], + "signature": "getResponseHeader(header: string): string", + "source": "script-api", + "tags": [ + "getresponseheader", + "webdavclient.getresponseheader" + ], + "title": "WebDAVClient.getResponseHeader" + }, + { + "description": "Returns the status code after the execution of a method.", + "id": "script-api:dw/net/WebDAVClient#getStatusCode", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getStatusCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status code after the execution of a method.", + "heading": "Description" + } + ], + "signature": "getStatusCode(): number", + "source": "script-api", + "tags": [ + "getstatuscode", + "webdavclient.getstatuscode" + ], + "title": "WebDAVClient.getStatusCode" + }, + { + "description": "Returns the status text after the execution of a method.", + "id": "script-api:dw/net/WebDAVClient#getStatusText", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.getStatusText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the status text after the execution of a method.", + "heading": "Description" + } + ], + "signature": "getStatusText(): string", + "source": "script-api", + "tags": [ + "getstatustext", + "webdavclient.getstatustext" + ], + "title": "WebDAVClient.getStatusText" + }, + { + "description": "Creates a directory on the remote server on the location `rootUrl`/`path`.", + "id": "script-api:dw/net/WebDAVClient#mkcol", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.mkcol", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Creates a directory on the remote server on the location\n`rootUrl`/`path`.", + "heading": "Description" + } + ], + "signature": "mkcol(path: string): boolean", + "source": "script-api", + "tags": [ + "mkcol", + "webdavclient.mkcol" + ], + "title": "WebDAVClient.mkcol" + }, + { + "description": "Moves a file on the server from one place `rootUrl` + \"/\" +`origin` to the other `rootUrl`/`destination`. If `destination` already exists it gets overwritten. Can also be used to rename a remote file. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#move", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "origin", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.move", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Moves a file on the server from one place `rootUrl` + \"/\" +`origin`\nto the other `rootUrl`/`destination`. If\n`destination` already exists it gets overwritten. Can also\nbe used to rename a remote file. Returns true if succeeded, otherwise\nfalse.", + "heading": "Description" + } + ], + "signature": "move(origin: string, destination: string): boolean", + "source": "script-api", + "tags": [ + "move", + "webdavclient.move" + ], + "title": "WebDAVClient.move" + }, + { + "description": "Moves a file on the server from one place `rootUrl`/`origin` to the other `rootUrl`/`destination` Can also be used to rename a remote file. If `overwrite` is true and `destination` already exists it gets overwritten. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#move", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "origin", + "type": "string" + }, + { + "name": "destination", + "type": "string" + }, + { + "name": "overwrite", + "type": "boolean" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.move", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Moves a file on the server from one place `rootUrl`/`origin`\nto the other `rootUrl`/`destination` Can\nalso be used to rename a remote file. If `overwrite` is true\nand `destination` already exists it gets overwritten.\nReturns true if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "move(origin: string, destination: string, overwrite: boolean): boolean", + "source": "script-api", + "tags": [ + "move", + "webdavclient.move" + ], + "title": "WebDAVClient.move" + }, + { + "description": "Returns a list of methods which can be executed on the server location `rootUrl`/`path`.", + "id": "script-api:dw/net/WebDAVClient#options", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.options", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Returns a list of methods which can be executed on the server location\n`rootUrl`/`path`.", + "heading": "Description" + } + ], + "signature": "options(path: string): string[]", + "source": "script-api", + "tags": [ + "options", + "webdavclient.options" + ], + "title": "WebDAVClient.options" + }, + { + "description": "Get file listing of a remote location.", + "id": "script-api:dw/net/WebDAVClient#propfind", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.propfind", + "returns": { + "type": "WebDAVFileInfo[]" + }, + "sections": [ + { + "body": "Get file listing of a remote location.\n\nReturns a list of dw.net.WebDAVFileInfo objects which contain\ninformation about the files and directories located on\n`rootUrl`/`path` and DEPTH_1 (1) level\nunderneath.", + "heading": "Description" + } + ], + "signature": "propfind(path: string): WebDAVFileInfo[]", + "source": "script-api", + "tags": [ + "propfind", + "webdavclient.propfind" + ], + "title": "WebDAVClient.propfind" + }, + { + "description": "Get file listing of a remote location.", + "id": "script-api:dw/net/WebDAVClient#propfind", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "depth", + "type": "number" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.propfind", + "returns": { + "type": "WebDAVFileInfo[]" + }, + "sections": [ + { + "body": "Get file listing of a remote location.\n\nReturns a list of dw.net.WebDAVFileInfo objects which contain\ninformation about the files and directories located on\n`rootUrl`/`path` and the passed depth\nunderneath.", + "heading": "Description" + } + ], + "signature": "propfind(path: string, depth: number): WebDAVFileInfo[]", + "source": "script-api", + "tags": [ + "propfind", + "webdavclient.propfind" + ], + "title": "WebDAVClient.propfind" + }, + { + "description": "Puts content encoded with DEFAULT_ENCODING into a remote located file at `rootUrl`/`path`. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Puts content encoded with DEFAULT_ENCODING into a remote located file at\n`rootUrl`/`path`. Returns true if\nsucceeded, otherwise false.\n\nIf the content of a local file is to be uploaded, please use method\nput instead.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string): boolean", + "source": "script-api", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "description": "Puts content encoded with the passed encoding into a remote located file at `rootUrl`/`path`. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "content", + "type": "string" + }, + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Puts content encoded with the passed encoding into a remote located file\nat `rootUrl`/`path`. Returns true if\nsucceeded, otherwise false.\n\nIf the content of a local file is to be uploaded, please use method\nput instead.", + "heading": "Description" + } + ], + "signature": "put(path: string, content: string, encoding: string): boolean", + "source": "script-api", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "description": "Puts content out of a passed local file into a remote located file at `rootUrl`/`path`. This method performs a binary file transfer. Returns true if succeeded, otherwise false.", + "id": "script-api:dw/net/WebDAVClient#put", + "kind": "method", + "packagePath": "dw/net", + "params": [ + { + "name": "path", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.put", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Puts content out of a passed local file into a remote located file\nat `rootUrl`/`path`. This method performs\na binary file transfer. Returns true if succeeded, otherwise false.", + "heading": "Description" + } + ], + "signature": "put(path: string, file: File): boolean", + "source": "script-api", + "tags": [ + "put", + "webdavclient.put" + ], + "title": "WebDAVClient.put" + }, + { + "description": "Returns the status code after the execution of a method.", + "id": "script-api:dw/net/WebDAVClient#statusCode", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.statusCode", + "sections": [ + { + "body": "Returns the status code after the execution of a method.", + "heading": "Description" + } + ], + "signature": "readonly statusCode: number", + "source": "script-api", + "tags": [ + "statuscode", + "webdavclient.statuscode" + ], + "title": "WebDAVClient.statusCode" + }, + { + "description": "Returns the status text after the execution of a method.", + "id": "script-api:dw/net/WebDAVClient#statusText", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.statusText", + "sections": [ + { + "body": "Returns the status text after the execution of a method.", + "heading": "Description" + } + ], + "signature": "readonly statusText: string", + "source": "script-api", + "tags": [ + "statustext", + "webdavclient.statustext" + ], + "title": "WebDAVClient.statusText" + }, + { + "description": "Returns true if the last executed WebDAV method was executed successfully - otherwise false. See the code snippet above for an example how to use the succeed() method.", + "id": "script-api:dw/net/WebDAVClient#succeeded", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVClient", + "qualifiedName": "dw.net.WebDAVClient.succeeded", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the last executed WebDAV method was executed successfully - otherwise false.\nSee the code snippet above for an example how to use the succeed() method.", + "heading": "Description" + } + ], + "signature": "succeeded(): boolean", + "source": "script-api", + "tags": [ + "succeeded", + "webdavclient.succeeded" + ], + "title": "WebDAVClient.succeeded" + }, + { + "description": "Simple class representing a file on a remote WebDAV location. The class possesses only read-only attributes of the file and does not permit any manipulation of the file itself. Instances of this class are returned by dw.net.WebDAVClient.propfind which is used to get a listing of files in a WebDAV directory.", + "id": "script-api:dw/net/WebDAVFileInfo", + "kind": "class", + "packagePath": "dw/net", + "parentId": "script-api:dw/net", + "qualifiedName": "dw.net.WebDAVFileInfo", + "sections": [ + { + "body": "Simple class representing a file on a remote WebDAV location. The class\npossesses only read-only attributes of the file and does not permit any\nmanipulation of the file itself. Instances of this class are returned\nby dw.net.WebDAVClient.propfind which is used to get a\nlisting of files in a WebDAV directory.\n\nNote: when this class is used with sensitive data, be careful in persisting sensitive information to disk.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "webdavfileinfo", + "dw.net.webdavfileinfo", + "dw/net" + ], + "title": "WebDAVFileInfo" + }, + { + "description": "Returns the content type of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#contentType", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.contentType", + "sections": [ + { + "body": "Returns the content type of the file.", + "heading": "Description" + } + ], + "signature": "readonly contentType: string", + "source": "script-api", + "tags": [ + "contenttype", + "webdavfileinfo.contenttype" + ], + "title": "WebDAVFileInfo.contentType" + }, + { + "description": "Returns the creationDate of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#creationDate", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.creationDate", + "sections": [ + { + "body": "Returns the creationDate of the file.", + "heading": "Description" + } + ], + "signature": "readonly creationDate: Date", + "source": "script-api", + "tags": [ + "creationdate", + "webdavfileinfo.creationdate" + ], + "title": "WebDAVFileInfo.creationDate" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/WebDAVFileInfo#directory", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.directory", + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "readonly directory: boolean", + "source": "script-api", + "tags": [ + "directory", + "webdavfileinfo.directory" + ], + "title": "WebDAVFileInfo.directory" + }, + { + "description": "Returns the content type of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#getContentType", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getContentType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the content type of the file.", + "heading": "Description" + } + ], + "signature": "getContentType(): string", + "source": "script-api", + "tags": [ + "getcontenttype", + "webdavfileinfo.getcontenttype" + ], + "title": "WebDAVFileInfo.getContentType" + }, + { + "description": "Returns the creationDate of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#getCreationDate", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getCreationDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the creationDate of the file.", + "heading": "Description" + } + ], + "signature": "getCreationDate(): Date", + "source": "script-api", + "tags": [ + "getcreationdate", + "webdavfileinfo.getcreationdate" + ], + "title": "WebDAVFileInfo.getCreationDate" + }, + { + "description": "Returns the name of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#getName", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the file.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "webdavfileinfo.getname" + ], + "title": "WebDAVFileInfo.getName" + }, + { + "description": "Returns the path of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#getPath", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getPath", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the path of the file.", + "heading": "Description" + } + ], + "signature": "getPath(): string", + "source": "script-api", + "tags": [ + "getpath", + "webdavfileinfo.getpath" + ], + "title": "WebDAVFileInfo.getPath" + }, + { + "description": "Returns the size of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#getSize", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.getSize", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the file.", + "heading": "Description" + } + ], + "signature": "getSize(): number", + "source": "script-api", + "tags": [ + "getsize", + "webdavfileinfo.getsize" + ], + "title": "WebDAVFileInfo.getSize" + }, + { + "description": "Identifies if the file is a directory.", + "id": "script-api:dw/net/WebDAVFileInfo#isDirectory", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.isDirectory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the file is a directory.", + "heading": "Description" + } + ], + "signature": "isDirectory(): boolean", + "source": "script-api", + "tags": [ + "isdirectory", + "webdavfileinfo.isdirectory" + ], + "title": "WebDAVFileInfo.isDirectory" + }, + { + "description": "Returns the lastModified date of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#lastModified", + "kind": "method", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.lastModified", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the lastModified date of the file.", + "heading": "Description" + } + ], + "signature": "lastModified(): Date", + "source": "script-api", + "tags": [ + "lastmodified", + "webdavfileinfo.lastmodified" + ], + "title": "WebDAVFileInfo.lastModified" + }, + { + "description": "Returns the name of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#name", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.name", + "sections": [ + { + "body": "Returns the name of the file.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "webdavfileinfo.name" + ], + "title": "WebDAVFileInfo.name" + }, + { + "description": "Returns the path of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#path", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.path", + "sections": [ + { + "body": "Returns the path of the file.", + "heading": "Description" + } + ], + "signature": "readonly path: string", + "source": "script-api", + "tags": [ + "path", + "webdavfileinfo.path" + ], + "title": "WebDAVFileInfo.path" + }, + { + "description": "Returns the size of the file.", + "id": "script-api:dw/net/WebDAVFileInfo#size", + "kind": "property", + "packagePath": "dw/net", + "parentId": "script-api:dw/net/WebDAVFileInfo", + "qualifiedName": "dw.net.WebDAVFileInfo.size", + "sections": [ + { + "body": "Returns the size of the file.", + "heading": "Description" + } + ], + "signature": "readonly size: number", + "source": "script-api", + "tags": [ + "size", + "webdavfileinfo.size" + ], + "title": "WebDAVFileInfo.size" + }, + { + "description": "14 declarations", + "id": "script-api:dw/object", + "kind": "package", + "packagePath": "dw/object", + "qualifiedName": "dw.object", + "source": "script-api", + "tags": [ + "dw/object", + "dw.object" + ], + "title": "dw.object" + }, + { + "description": "Represents the active data for an object in Commerce Cloud Digital.", + "id": "script-api:dw/object/ActiveData", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ActiveData", + "sections": [ + { + "body": "Represents the active data for an object in Commerce Cloud Digital.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "activedata", + "dw.object.activedata", + "dw/object" + ], + "title": "ActiveData" + }, + { + "description": "Return true if the ActiveData doesn't exist for the object", + "id": "script-api:dw/object/ActiveData#empty", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ActiveData", + "qualifiedName": "dw.object.ActiveData.empty", + "sections": [ + { + "body": "Return true if the ActiveData doesn't exist for the object", + "heading": "Description" + } + ], + "signature": "readonly empty: boolean", + "source": "script-api", + "tags": [ + "empty", + "activedata.empty" + ], + "title": "ActiveData.empty" + }, + { + "description": "Return true if the ActiveData doesn't exist for the object", + "id": "script-api:dw/object/ActiveData#isEmpty", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ActiveData", + "qualifiedName": "dw.object.ActiveData.isEmpty", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Return true if the ActiveData doesn't exist for the object", + "heading": "Description" + } + ], + "signature": "isEmpty(): boolean", + "source": "script-api", + "tags": [ + "isempty", + "activedata.isempty" + ], + "title": "ActiveData.isEmpty" + }, + { + "description": "This class is used together with other classes that contain custom attributes and is used to read and write these attributes. The actual attributes are accessible as ECMA properties. The syntax for setting and retrieving the value of a custom attribute depends upon the type of the attribute. An exception will be thrown, if the wrong syntax is used to set an individual attribute.", + "examples": [ + "// attribute of value type 'Boolean'\neo.custom.bvalue = true;\nvar b : Boolean = eo.custom.bvalue;\n\n// attribute of value type 'Integer'\neo.custom.ivalue = 10;\nvar i : Number = eo.custom.ivalue;\n\n// attribute of value type 'Number'\neo.custom.dvalue = 99.99;\nvar d : Number = eo.custom.dvalue;\n\n// attribute of value type 'String'\neo.custom.svalue = \"String1\";\nvar s : String = eo.custom.svalue;\n\n// attribute of value type 'Email'\neo.custom.emailvalue = \"email@demandware.com\";\nvar e : String = eo.custom.emailvalue;\n\n// attribute of value type 'Text'\neo.custom.tvalue = \"laaaaaaaaaaaarge text\";\nvar t : String = eo.custom.tvalue;\n\n// attribute of value type 'Date'\neo.custom.dtvalue = new Date;\nvar date : Date = eo.custom.dtvalue;", + "var setofstring : Array = eo.custom.setofstringvalue;\nif( Array.isArray( setofstring ) ) // returns false\n{\n// this will never be reached, since setofstring is a Java-backed array and not a native JavaScript array\n}\nif( setofstring instanceof Array ) // returns true\n{\n// this will be reached, since setofstring is a Java-backed array\n}", + "// retrieve a Java-backed array and convert it to a native JavaScript array\nvar setofstring : Array = eo.custom.setofstringvalue;\nvar newValue = Array.from( setofstring );\n\n// add new element\nnewValue.append( \"new element\" );\n\n// reassign the new array to the multi-value attribute to persist the change\neo.custom.setofstringvalue = newValue;", + "// retrieve a Java-backed array\nvar setofstring : Array = eo.custom.setofstringvalue;\n\n// change individual element\nsetofstring[0] = \"updated element\";\n\n// reassign the array to the multi-value attribute to persist the change\neo.custom.setofstringvalue = setofstring;", + "// attribute of value type 'Set of String'\n// set the attribute value only if it hasn't been already set\nif( !('setofstringvalue' in eo.custom) )\n{\neo.custom.setofstringvalue = new Array(\"abc\",\"def\",\"ghi\");\n}\n\n// returns an Array of String instances\nvar setofstring : Array = eo.custom.setofstringvalue;\nvar s1 : String = setofstring[0];\nvar s2 : String = setofstring[1];\nvar s3 : String = setofstring[2];\n\n// attribute of value type 'Enum of Integer' with multi-value handling\neo.custom.enumofintmultivalue = new Array(1, 2, 3);\n\n// returns an Array of EnumValue instances\nvar enumofintmulti : Array = eo.custom.enumofintmultivalue;\nvar value1 : Number = enumofintmulti[0].getValue();\nvar displayvalue1 : String = enumofintmulti[0].getDisplayValue();\nvar value2 : Number = enumofintmulti[1].getValue();\nvar displayvalue2 : String = enumofintmulti[1].getDisplayValue();\nvar value3 : Number = enumofintmulti[2].getValue();\nvar displayvalue3 : String = enumofintmulti[2].getDisplayValue();" + ], + "id": "script-api:dw/object/CustomAttributes", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomAttributes", + "sections": [ + { + "body": "This class is used together with other classes that contain custom attributes and is used to read and write these\nattributes. The actual attributes are accessible as ECMA properties. The syntax for setting and retrieving the value\nof a custom attribute depends upon the type of the attribute. An exception will be thrown, if the wrong syntax is\nused to set an individual attribute.\n\nThe following script examples demonstrate how to work with custom attributes. Suppose we have an ExtensibleObject\nnamed \"eo\" possessing attributes of all the different types supported by the Commerce Cloud Digital metadata system.\nThe following script snippet shows that setting single-valued attributes is simply a matter of using the assignment\noperator and standard ECMA primitives and built-in types:\n\n\nRetrieving multi-value attributes and working with Java-backed arrays\n\nMulti-value attributes return Java-backed arrays, which contain copies of the internal data. In contrast to native\nJavaScript arrays, a Java-backed array behaves differently in the following ways:\n\n- `Array.isArray( javaBackedArray )` will return `false`. If you want to do something based\non the value type, use `javaBackedArray instanceof Array` instead.\n- Adding to or removing elements from a Java-backed array is not supported. You need to create a new native\nJavaScript array based on the Java-backed array, e.g. with `Array.from( javaBackedArray )` and do the\nmodifications there.\n\n\nUpdating multi-value attributes\n\nRetrieved data from a multi-value attribute returns a Java-backed array, which contains a copy of the internal data,\nso changes made to the Java-backed array do not affect the multi-value attribute. To update the multi-value attribute\n(e.g. adding a new element), it needs to be reassigned.\n\n\nIf you only want to change individual elements without appending or removing elements from the Java-backed array, you\nmay even modify it directly.\n\n\nSet-of attributes and enum-of attributes\n\nSet-of attributes and enum-of attributes are handled in a very similar manner. The chief difference is that enum-of\nattributes are limited to a prescribed set of value definitions whereas set-of attributes are open-ended.\nFurthermore, each value in an enum-of attribute has a value and a display name which affects the retrieval logic.\n\n\nFor further details on the Commerce Cloud Digital attribute system, see the core Commerce Cloud Digital\ndocumentation.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customattributes", + "dw.object.customattributes", + "dw/object" + ], + "title": "CustomAttributes" + }, + { + "description": "Represents a custom object and its corresponding attributes.", + "id": "script-api:dw/object/CustomObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomObject", + "sections": [ + { + "body": "Represents a custom object and its corresponding attributes.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customobject", + "dw.object.customobject", + "dw/object" + ], + "title": "CustomObject" + }, + { + "description": "Returns the type of the CustomObject.", + "id": "script-api:dw/object/CustomObject#getType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObject", + "qualifiedName": "dw.object.CustomObject.getType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the CustomObject.", + "heading": "Description" + } + ], + "signature": "getType(): string", + "source": "script-api", + "tags": [ + "gettype", + "customobject.gettype" + ], + "title": "CustomObject.getType" + }, + { + "description": "Returns the type of the CustomObject.", + "id": "script-api:dw/object/CustomObject#type", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/CustomObject", + "qualifiedName": "dw.object.CustomObject.type", + "sections": [ + { + "body": "Returns the type of the CustomObject.", + "heading": "Description" + } + ], + "signature": "readonly type: string", + "source": "script-api", + "tags": [ + "type", + "customobject.type" + ], + "title": "CustomObject.type" + }, + { + "description": "Manager class which provides methods for creating, retrieving, deleting, and searching for custom objects.", + "id": "script-api:dw/object/CustomObjectMgr", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.CustomObjectMgr", + "sections": [ + { + "body": "Manager class which provides methods for creating, retrieving, deleting,\nand searching for custom objects.\n\nTo search for system objects, use dw.object.SystemObjectMgr.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "customobjectmgr", + "dw.object.customobjectmgr", + "dw/object" + ], + "title": "CustomObjectMgr" + }, + { + "description": "Returns a new custom object instance of the specified type, using the given key value. Custom object keys need to be unique for custom object type.", + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Returns a new custom object instance of the specified type, using the\ngiven key value. Custom object keys need to be unique for custom object\ntype.", + "heading": "Description" + } + ], + "signature": "static createCustomObject(type: string, keyValue: string): CustomObject", + "source": "script-api", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "description": "Returns a new custom object instance of the specified type, using the given key value. Custom object keys need to be unique for custom object type.", + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "number" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Returns a new custom object instance of the specified type, using the\ngiven key value. Custom object keys need to be unique for custom object\ntype.", + "heading": "Description" + } + ], + "signature": "static createCustomObject(type: string, keyValue: number): CustomObject", + "source": "script-api", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "description": "Returns a new custom object instance of the specified type, using the given key value. Custom object keys need to be unique for custom object type.", + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Returns a new custom object instance of the specified type, using the\ngiven key value. Custom object keys need to be unique for custom object\ntype.", + "heading": "Description" + } + ], + "signature": "static createCustomObject(type: string, keyValue: string): CustomObject", + "source": "script-api", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "description": "Returns a new custom object instance of the specified type, using the given key value. Custom object keys need to be unique for custom object type.", + "id": "script-api:dw/object/CustomObjectMgr#createCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "number" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.createCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Returns a new custom object instance of the specified type, using the\ngiven key value. Custom object keys need to be unique for custom object\ntype.", + "heading": "Description" + } + ], + "signature": "static createCustomObject(type: string, keyValue: number): CustomObject", + "source": "script-api", + "tags": [ + "createcustomobject", + "customobjectmgr.createcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.createCustomObject" + }, + { + "description": "Returns the meta data for the given type.", + "id": "script-api:dw/object/CustomObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.describe", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for the given type.", + "heading": "Description" + } + ], + "signature": "static describe(type: string): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describe", + "customobjectmgr.describe" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.describe" + }, + { + "description": "Returns the meta data for the given type.", + "id": "script-api:dw/object/CustomObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.describe", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for the given type.", + "heading": "Description" + } + ], + "signature": "static describe(type: string): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describe", + "customobjectmgr.describe" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.describe" + }, + { + "description": "Returns all custom objects of a specific type.", + "id": "script-api:dw/object/CustomObjectMgr#getAllCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getAllCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Returns all custom objects of a specific type.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static getAllCustomObjects(type: string): SeekableIterator", + "source": "script-api", + "tags": [ + "getallcustomobjects", + "customobjectmgr.getallcustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getAllCustomObjects" + }, + { + "description": "Returns all custom objects of a specific type.", + "id": "script-api:dw/object/CustomObjectMgr#getAllCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getAllCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Returns all custom objects of a specific type.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static getAllCustomObjects(type: string): SeekableIterator", + "source": "script-api", + "tags": [ + "getallcustomobjects", + "customobjectmgr.getallcustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getAllCustomObjects" + }, + { + "description": "Returns a custom object based on it's type and unique key.", + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "returns": { + "type": "CustomObject | null" + }, + "sections": [ + { + "body": "Returns a custom object based on it's type and unique key.", + "heading": "Description" + } + ], + "signature": "static getCustomObject(type: string, keyValue: string): CustomObject | null", + "source": "script-api", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "description": "Returns a custom object based on it's type and unique key.", + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "number" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "returns": { + "type": "CustomObject | null" + }, + "sections": [ + { + "body": "Returns a custom object based on it's type and unique key.", + "heading": "Description" + } + ], + "signature": "static getCustomObject(type: string, keyValue: number): CustomObject | null", + "source": "script-api", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "description": "Returns a custom object based on it's type and unique key.", + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "string" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "returns": { + "type": "CustomObject | null" + }, + "sections": [ + { + "body": "Returns a custom object based on it's type and unique key.", + "heading": "Description" + } + ], + "signature": "static getCustomObject(type: string, keyValue: string): CustomObject | null", + "source": "script-api", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "description": "Returns a custom object based on it's type and unique key.", + "id": "script-api:dw/object/CustomObjectMgr#getCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "keyValue", + "type": "number" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.getCustomObject", + "returns": { + "type": "CustomObject | null" + }, + "sections": [ + { + "body": "Returns a custom object based on it's type and unique key.", + "heading": "Description" + } + ], + "signature": "static getCustomObject(type: string, keyValue: number): CustomObject | null", + "source": "script-api", + "tags": [ + "getcustomobject", + "customobjectmgr.getcustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.getCustomObject" + }, + { + "description": "Searches for a single custom object instance.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Searches for a single custom object instance.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Case-independent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set it is recommended to use the following code:\n`queryCustomObjects(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns\nonly the next element and closes the iterator.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObject(type: string, queryString: string, args?: any[]): CustomObject", + "source": "script-api", + "tags": [ + "querycustomobject", + "customobjectmgr.querycustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObject" + }, + { + "description": "Searches for a single custom object instance.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObject", + "returns": { + "type": "CustomObject" + }, + "sections": [ + { + "body": "Searches for a single custom object instance.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Case-independent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set it is recommended to use the following code:\n`queryCustomObjects(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns\nonly the next element and closes the iterator.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObject(type: string, queryString: string, args?: any[]): CustomObject", + "source": "script-api", + "tags": [ + "querycustomobject", + "customobjectmgr.querycustomobject" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObject" + }, + { + "description": "Searches for custom object instances.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for custom object instances.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryCustomObjects(\"sample\", \"\", \"custom.myAttr asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObjects(type: string, queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "description": "Searches for custom object instances.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for custom object instances.\n\nThe search can be configured with a map, which key-value pairs are converted into a query expression. The\nkey-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObjects(type: string, queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "description": "Searches for custom object instances.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for custom object instances.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryCustomObjects(\"sample\", \"\", \"custom.myAttr asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObjects(type: string, queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "description": "Searches for custom object instances.", + "id": "script-api:dw/object/CustomObjectMgr#queryCustomObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.queryCustomObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for custom object instances.\n\nThe search can be configured with a map, which key-value pairs are converted into a query expression. The\nkey-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample:\n\n- Get the custom objects using this method with non-localized attributes query.\n- Access the `obj.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static queryCustomObjects(type: string, queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "querycustomobjects", + "customobjectmgr.querycustomobjects" + ], + "throws": [ + { + "description": "if the given type is invalid", + "type": "IllegalArgumentException" + } + ], + "title": "CustomObjectMgr.queryCustomObjects" + }, + { + "description": "Removes a given custom object.", + "id": "script-api:dw/object/CustomObjectMgr#remove", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "object", + "type": "CustomObject" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.remove", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a given custom object.", + "heading": "Description" + } + ], + "signature": "static remove(object: CustomObject): void", + "source": "script-api", + "tags": [ + "remove", + "customobjectmgr.remove" + ], + "title": "CustomObjectMgr.remove" + }, + { + "description": "Removes a given custom object.", + "id": "script-api:dw/object/CustomObjectMgr#remove", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "object", + "type": "CustomObject" + } + ], + "parentId": "script-api:dw/object/CustomObjectMgr", + "qualifiedName": "dw.object.CustomObjectMgr.remove", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a given custom object.", + "heading": "Description" + } + ], + "signature": "static remove(object: CustomObject): void", + "source": "script-api", + "tags": [ + "remove", + "customobjectmgr.remove" + ], + "title": "CustomObjectMgr.remove" + }, + { + "description": "Base class alternative to ExtensibleObject for objects customizable through the metadata system. Similar to ExtensibleObject: the describe method provides access to the related object-type metadata. The getCustom method is the central point to retrieve and store the objects attribute values themselves.", + "id": "script-api:dw/object/Extensible", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.Extensible", + "sections": [ + { + "body": "Base class alternative to ExtensibleObject for objects customizable through the metadata system.\nSimilar to ExtensibleObject: the describe method provides access to the related object-type metadata.\nThe getCustom method is the central point to retrieve and store the objects attribute\nvalues themselves.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "extensible", + "dw.object.extensible", + "dw/object" + ], + "title": "Extensible" + }, + { + "description": "Returns the custom attributes for this object.", + "id": "script-api:dw/object/Extensible#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.custom", + "sections": [ + { + "body": "Returns the custom attributes for this object.", + "heading": "Description" + } + ], + "signature": "readonly custom: CustomAttributes", + "source": "script-api", + "tags": [ + "custom", + "extensible.custom" + ], + "title": "Extensible.custom" + }, + { + "description": "Returns the meta data of this object. If no meta data is available the method returns null. The returned ObjectTypeDefinition can be used to retrieve the metadata for any of the custom attributes.", + "id": "script-api:dw/object/Extensible#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.describe", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data of this object. If no meta data is available the\nmethod returns null. The returned ObjectTypeDefinition can be used to\nretrieve the metadata for any of the custom attributes.", + "heading": "Description" + } + ], + "signature": "describe(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describe", + "extensible.describe" + ], + "title": "Extensible.describe" + }, + { + "description": "Returns the custom attributes for this object.", + "id": "script-api:dw/object/Extensible#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Extensible", + "qualifiedName": "dw.object.Extensible.getCustom", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns the custom attributes for this object.", + "heading": "Description" + } + ], + "signature": "getCustom(): CustomAttributes", + "source": "script-api", + "tags": [ + "getcustom", + "extensible.getcustom" + ], + "title": "Extensible.getCustom" + }, + { + "description": "Base class for all persistent business objects in Commerce Cloud Digital that are customizable through the metadata system. All objects in Digital that have custom attributes derive from ExtensibleObject including both system-defined and custom objects. The describe() method provides access to the related object-type metadata. The method getCustom() is the central point to retrieve and store the objects attribute values themselves.", + "id": "script-api:dw/object/ExtensibleObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ExtensibleObject", + "sections": [ + { + "body": "Base class for all persistent business objects in Commerce Cloud Digital that\nare customizable through the metadata system. All objects in Digital\nthat have custom attributes derive from ExtensibleObject including\nboth system-defined and custom objects. The describe() method provides access\nto the related object-type metadata. The method getCustom() is the central\npoint to retrieve and store the objects attribute values themselves.", + "heading": "Description" + }, + { + "body": "Extends `PersistentObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "extensibleobject", + "dw.object.extensibleobject", + "dw/object" + ], + "title": "ExtensibleObject" + }, + { + "description": "Returns the custom attributes for this object. The returned object is used for retrieving and storing attribute values. See dw.object.CustomAttributes for a detailed example of the syntax for working with custom attributes.", + "id": "script-api:dw/object/ExtensibleObject#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.custom", + "sections": [ + { + "body": "Returns the custom attributes for this object. The returned object is\nused for retrieving and storing attribute values. See\ndw.object.CustomAttributes for a detailed example of the syntax for\nworking with custom attributes.", + "heading": "Description" + } + ], + "signature": "readonly custom: T", + "source": "script-api", + "tags": [ + "custom", + "extensibleobject.custom" + ], + "title": "ExtensibleObject.custom" + }, + { + "description": "Returns the meta data of this object. If no meta data is available the method returns null. The returned ObjectTypeDefinition can be used to retrieve the metadata for any of the custom attributes.", + "id": "script-api:dw/object/ExtensibleObject#describe", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.describe", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data of this object. If no meta data is available the\nmethod returns null. The returned ObjectTypeDefinition can be used to\nretrieve the metadata for any of the custom attributes.", + "heading": "Description" + } + ], + "signature": "describe(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describe", + "extensibleobject.describe" + ], + "title": "ExtensibleObject.describe" + }, + { + "description": "Returns the custom attributes for this object. The returned object is used for retrieving and storing attribute values. See dw.object.CustomAttributes for a detailed example of the syntax for working with custom attributes.", + "id": "script-api:dw/object/ExtensibleObject#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ExtensibleObject", + "qualifiedName": "dw.object.ExtensibleObject.getCustom", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Returns the custom attributes for this object. The returned object is\nused for retrieving and storing attribute values. See\ndw.object.CustomAttributes for a detailed example of the syntax for\nworking with custom attributes.", + "heading": "Description" + } + ], + "signature": "getCustom(): T", + "source": "script-api", + "tags": [ + "getcustom", + "extensibleobject.getcustom" + ], + "title": "ExtensibleObject.getCustom" + }, + { + "description": "Represents a note that can be attached to any persistent object that supports this feature.", + "id": "script-api:dw/object/Note", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.Note", + "sections": [ + { + "body": "Represents a note that can be attached to any persistent object\nthat supports this feature.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "note", + "dw.object.note", + "dw/object" + ], + "title": "Note" + }, + { + "description": "Return the login ID of user that is stored in the session at the time the note is created.", + "id": "script-api:dw/object/Note#createdBy", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.createdBy", + "sections": [ + { + "body": "Return the login ID of user that is stored in the session at the time\nthe note is created.", + "heading": "Description" + } + ], + "signature": "readonly createdBy: string", + "source": "script-api", + "tags": [ + "createdby", + "note.createdby" + ], + "title": "Note.createdBy" + }, + { + "description": "Return the date and time that the note was created. This is usually set by the system, but may be specified if the note is generated via an import.", + "id": "script-api:dw/object/Note#creationDate", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.creationDate", + "sections": [ + { + "body": "Return the date and time that the note was created. This is usually\nset by the system, but may be specified if the note is generated\nvia an import.", + "heading": "Description" + } + ], + "signature": "readonly creationDate: Date", + "source": "script-api", + "tags": [ + "creationdate", + "note.creationdate" + ], + "title": "Note.creationDate" + }, + { + "description": "Return the login ID of user that is stored in the session at the time the note is created.", + "id": "script-api:dw/object/Note#getCreatedBy", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getCreatedBy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the login ID of user that is stored in the session at the time\nthe note is created.", + "heading": "Description" + } + ], + "signature": "getCreatedBy(): string", + "source": "script-api", + "tags": [ + "getcreatedby", + "note.getcreatedby" + ], + "title": "Note.getCreatedBy" + }, + { + "description": "Return the date and time that the note was created. This is usually set by the system, but may be specified if the note is generated via an import.", + "id": "script-api:dw/object/Note#getCreationDate", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getCreationDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Return the date and time that the note was created. This is usually\nset by the system, but may be specified if the note is generated\nvia an import.", + "heading": "Description" + } + ], + "signature": "getCreationDate(): Date", + "source": "script-api", + "tags": [ + "getcreationdate", + "note.getcreationdate" + ], + "title": "Note.getCreationDate" + }, + { + "description": "Return the subject of the note.", + "id": "script-api:dw/object/Note#getSubject", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getSubject", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the subject of the note.", + "heading": "Description" + } + ], + "signature": "getSubject(): string", + "source": "script-api", + "tags": [ + "getsubject", + "note.getsubject" + ], + "title": "Note.getSubject" + }, + { + "description": "Return the text of the note.", + "id": "script-api:dw/object/Note#getText", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.getText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the text of the note.", + "heading": "Description" + } + ], + "signature": "getText(): string", + "source": "script-api", + "tags": [ + "gettext", + "note.gettext" + ], + "title": "Note.getText" + }, + { + "description": "Return the subject of the note.", + "id": "script-api:dw/object/Note#subject", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.subject", + "sections": [ + { + "body": "Return the subject of the note.", + "heading": "Description" + } + ], + "signature": "readonly subject: string", + "source": "script-api", + "tags": [ + "subject", + "note.subject" + ], + "title": "Note.subject" + }, + { + "description": "Return the text of the note.", + "id": "script-api:dw/object/Note#text", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/Note", + "qualifiedName": "dw.object.Note.text", + "sections": [ + { + "body": "Return the text of the note.", + "heading": "Description" + } + ], + "signature": "readonly text: string", + "source": "script-api", + "tags": [ + "text", + "note.text" + ], + "title": "Note.text" + }, + { + "description": "Represents the definition of an object's attribute.", + "id": "script-api:dw/object/ObjectAttributeDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeDefinition", + "sections": [ + { + "body": "Represents the definition of an object's attribute.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "objectattributedefinition", + "dw.object.objectattributedefinition", + "dw/object" + ], + "title": "ObjectAttributeDefinition" + }, + { + "description": "Returns the ID of the attribute definition.", + "id": "script-api:dw/object/ObjectAttributeDefinition#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.ID", + "sections": [ + { + "body": "Returns the ID of the attribute definition.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "objectattributedefinition.id" + ], + "title": "ObjectAttributeDefinition.ID" + }, + { + "description": "Boolean value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_BOOLEAN", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN", + "sections": [ + { + "body": "Boolean value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_BOOLEAN = 8", + "source": "script-api", + "tags": [ + "value_type_boolean", + "objectattributedefinition.value_type_boolean" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN" + }, + { + "description": "Boolean value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_BOOLEAN", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN", + "sections": [ + { + "body": "Boolean value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_BOOLEAN = 8", + "source": "script-api", + "tags": [ + "value_type_boolean", + "objectattributedefinition.value_type_boolean" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_BOOLEAN" + }, + { + "description": "Date value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATE", + "sections": [ + { + "body": "Date value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_DATE = 6", + "source": "script-api", + "tags": [ + "value_type_date", + "objectattributedefinition.value_type_date" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATE" + }, + { + "description": "Date value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATE", + "sections": [ + { + "body": "Date value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_DATE = 6", + "source": "script-api", + "tags": [ + "value_type_date", + "objectattributedefinition.value_type_date" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATE" + }, + { + "description": "Date and Time value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATETIME", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATETIME", + "sections": [ + { + "body": "Date and Time value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_DATETIME = 11", + "source": "script-api", + "tags": [ + "value_type_datetime", + "objectattributedefinition.value_type_datetime" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATETIME" + }, + { + "description": "Date and Time value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_DATETIME", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_DATETIME", + "sections": [ + { + "body": "Date and Time value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_DATETIME = 11", + "source": "script-api", + "tags": [ + "value_type_datetime", + "objectattributedefinition.value_type_datetime" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_DATETIME" + }, + { + "description": "Email value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_EMAIL", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_EMAIL", + "sections": [ + { + "body": "Email value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_EMAIL = 12", + "source": "script-api", + "tags": [ + "value_type_email", + "objectattributedefinition.value_type_email" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_EMAIL" + }, + { + "description": "Email value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_EMAIL", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_EMAIL", + "sections": [ + { + "body": "Email value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_EMAIL = 12", + "source": "script-api", + "tags": [ + "value_type_email", + "objectattributedefinition.value_type_email" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_EMAIL" + }, + { + "description": "Enum of int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT", + "sections": [ + { + "body": "Enum of int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_ENUM_OF_INT = 31", + "source": "script-api", + "tags": [ + "value_type_enum_of_int", + "objectattributedefinition.value_type_enum_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT" + }, + { + "description": "Enum of int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT", + "sections": [ + { + "body": "Enum of int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_ENUM_OF_INT = 31", + "source": "script-api", + "tags": [ + "value_type_enum_of_int", + "objectattributedefinition.value_type_enum_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_INT" + }, + { + "description": "Enum of String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING", + "sections": [ + { + "body": "Enum of String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_ENUM_OF_STRING = 33", + "source": "script-api", + "tags": [ + "value_type_enum_of_string", + "objectattributedefinition.value_type_enum_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING" + }, + { + "description": "Enum of String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_ENUM_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING", + "sections": [ + { + "body": "Enum of String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_ENUM_OF_STRING = 33", + "source": "script-api", + "tags": [ + "value_type_enum_of_string", + "objectattributedefinition.value_type_enum_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_ENUM_OF_STRING" + }, + { + "description": "HTML value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_HTML", + "sections": [ + { + "body": "HTML value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_HTML = 5", + "source": "script-api", + "tags": [ + "value_type_html", + "objectattributedefinition.value_type_html" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_HTML" + }, + { + "description": "HTML value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_HTML", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_HTML", + "sections": [ + { + "body": "HTML value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_HTML = 5", + "source": "script-api", + "tags": [ + "value_type_html", + "objectattributedefinition.value_type_html" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_HTML" + }, + { + "description": "Image value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_IMAGE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_IMAGE", + "sections": [ + { + "body": "Image value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_IMAGE = 7", + "source": "script-api", + "tags": [ + "value_type_image", + "objectattributedefinition.value_type_image" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_IMAGE" + }, + { + "description": "Image value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_IMAGE", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_IMAGE", + "sections": [ + { + "body": "Image value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_IMAGE = 7", + "source": "script-api", + "tags": [ + "value_type_image", + "objectattributedefinition.value_type_image" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_IMAGE" + }, + { + "description": "int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_INT", + "sections": [ + { + "body": "int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_INT = 1", + "source": "script-api", + "tags": [ + "value_type_int", + "objectattributedefinition.value_type_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_INT" + }, + { + "description": "int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_INT", + "sections": [ + { + "body": "int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_INT = 1", + "source": "script-api", + "tags": [ + "value_type_int", + "objectattributedefinition.value_type_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_INT" + }, + { + "description": "Money value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_MONEY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_MONEY", + "sections": [ + { + "body": "Money value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_MONEY = 9", + "source": "script-api", + "tags": [ + "value_type_money", + "objectattributedefinition.value_type_money" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_MONEY" + }, + { + "description": "Money value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_MONEY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_MONEY", + "sections": [ + { + "body": "Money value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_MONEY = 9", + "source": "script-api", + "tags": [ + "value_type_money", + "objectattributedefinition.value_type_money" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_MONEY" + }, + { + "description": "Number value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_NUMBER", + "sections": [ + { + "body": "Number value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_NUMBER = 2", + "source": "script-api", + "tags": [ + "value_type_number", + "objectattributedefinition.value_type_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_NUMBER" + }, + { + "description": "Number value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_NUMBER", + "sections": [ + { + "body": "Number value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_NUMBER = 2", + "source": "script-api", + "tags": [ + "value_type_number", + "objectattributedefinition.value_type_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_NUMBER" + }, + { + "description": "Password value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_PASSWORD", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_PASSWORD", + "sections": [ + { + "body": "Password value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_PASSWORD = 13", + "source": "script-api", + "tags": [ + "value_type_password", + "objectattributedefinition.value_type_password" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_PASSWORD" + }, + { + "description": "Password value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_PASSWORD", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_PASSWORD", + "sections": [ + { + "body": "Password value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_PASSWORD = 13", + "source": "script-api", + "tags": [ + "value_type_password", + "objectattributedefinition.value_type_password" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_PASSWORD" + }, + { + "description": "Quantity value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_QUANTITY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_QUANTITY", + "sections": [ + { + "body": "Quantity value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_QUANTITY = 10", + "source": "script-api", + "tags": [ + "value_type_quantity", + "objectattributedefinition.value_type_quantity" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_QUANTITY" + }, + { + "description": "Quantity value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_QUANTITY", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_QUANTITY", + "sections": [ + { + "body": "Quantity value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_QUANTITY = 10", + "source": "script-api", + "tags": [ + "value_type_quantity", + "objectattributedefinition.value_type_quantity" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_QUANTITY" + }, + { + "description": "Set of int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT", + "sections": [ + { + "body": "Set of int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_INT = 21", + "source": "script-api", + "tags": [ + "value_type_set_of_int", + "objectattributedefinition.value_type_set_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT" + }, + { + "description": "Set of int value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_INT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT", + "sections": [ + { + "body": "Set of int value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_INT = 21", + "source": "script-api", + "tags": [ + "value_type_set_of_int", + "objectattributedefinition.value_type_set_of_int" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_INT" + }, + { + "description": "Set of Number value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER", + "sections": [ + { + "body": "Set of Number value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_NUMBER = 22", + "source": "script-api", + "tags": [ + "value_type_set_of_number", + "objectattributedefinition.value_type_set_of_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER" + }, + { + "description": "Set of Number value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_NUMBER", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER", + "sections": [ + { + "body": "Set of Number value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_NUMBER = 22", + "source": "script-api", + "tags": [ + "value_type_set_of_number", + "objectattributedefinition.value_type_set_of_number" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_NUMBER" + }, + { + "description": "Set of String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING", + "sections": [ + { + "body": "Set of String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_STRING = 23", + "source": "script-api", + "tags": [ + "value_type_set_of_string", + "objectattributedefinition.value_type_set_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING" + }, + { + "description": "Set of String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_SET_OF_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING", + "sections": [ + { + "body": "Set of String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_SET_OF_STRING = 23", + "source": "script-api", + "tags": [ + "value_type_set_of_string", + "objectattributedefinition.value_type_set_of_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_SET_OF_STRING" + }, + { + "description": "String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_STRING", + "sections": [ + { + "body": "String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_STRING = 3", + "source": "script-api", + "tags": [ + "value_type_string", + "objectattributedefinition.value_type_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_STRING" + }, + { + "description": "String value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_STRING", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_STRING", + "sections": [ + { + "body": "String value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_STRING = 3", + "source": "script-api", + "tags": [ + "value_type_string", + "objectattributedefinition.value_type_string" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_STRING" + }, + { + "description": "Text value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_TEXT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_TEXT", + "sections": [ + { + "body": "Text value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_TEXT = 4", + "source": "script-api", + "tags": [ + "value_type_text", + "objectattributedefinition.value_type_text" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_TEXT" + }, + { + "description": "Text value type.", + "id": "script-api:dw/object/ObjectAttributeDefinition#VALUE_TYPE_TEXT", + "kind": "constant", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.VALUE_TYPE_TEXT", + "sections": [ + { + "body": "Text value type.", + "heading": "Description" + } + ], + "signature": "static readonly VALUE_TYPE_TEXT = 4", + "source": "script-api", + "tags": [ + "value_type_text", + "objectattributedefinition.value_type_text" + ], + "title": "ObjectAttributeDefinition.VALUE_TYPE_TEXT" + }, + { + "description": "Returns all attribute groups the attribute is assigned to.", + "id": "script-api:dw/object/ObjectAttributeDefinition#attributeGroups", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.attributeGroups", + "sections": [ + { + "body": "Returns all attribute groups the attribute is assigned to.", + "heading": "Description" + } + ], + "signature": "readonly attributeGroups: Collection", + "source": "script-api", + "tags": [ + "attributegroups", + "objectattributedefinition.attributegroups" + ], + "title": "ObjectAttributeDefinition.attributeGroups" + }, + { + "description": "Return the default value for the attribute or null if none is defined.", + "id": "script-api:dw/object/ObjectAttributeDefinition#defaultValue", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.defaultValue", + "sections": [ + { + "body": "Return the default value for the attribute or null if none is defined.", + "heading": "Description" + } + ], + "signature": "readonly defaultValue: ObjectAttributeValueDefinition | null", + "source": "script-api", + "tags": [ + "defaultvalue", + "objectattributedefinition.defaultvalue" + ], + "title": "ObjectAttributeDefinition.defaultValue" + }, + { + "description": "Returns the display name for the attribute, which can be used in the user interface.", + "id": "script-api:dw/object/ObjectAttributeDefinition#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.displayName", + "sections": [ + { + "body": "Returns the display name for the attribute, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "objectattributedefinition.displayname" + ], + "title": "ObjectAttributeDefinition.displayName" + }, + { + "description": "Returns all attribute groups the attribute is assigned to.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getAttributeGroups", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getAttributeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all attribute groups the attribute is assigned to.", + "heading": "Description" + } + ], + "signature": "getAttributeGroups(): Collection", + "source": "script-api", + "tags": [ + "getattributegroups", + "objectattributedefinition.getattributegroups" + ], + "title": "ObjectAttributeDefinition.getAttributeGroups" + }, + { + "description": "Return the default value for the attribute or null if none is defined.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getDefaultValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getDefaultValue", + "returns": { + "type": "ObjectAttributeValueDefinition | null" + }, + "sections": [ + { + "body": "Return the default value for the attribute or null if none is defined.", + "heading": "Description" + } + ], + "signature": "getDefaultValue(): ObjectAttributeValueDefinition | null", + "source": "script-api", + "tags": [ + "getdefaultvalue", + "objectattributedefinition.getdefaultvalue" + ], + "title": "ObjectAttributeDefinition.getDefaultValue" + }, + { + "description": "Returns the display name for the attribute, which can be used in the user interface.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name for the attribute, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "objectattributedefinition.getdisplayname" + ], + "title": "ObjectAttributeDefinition.getDisplayName" + }, + { + "description": "Returns the ID of the attribute definition.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the attribute definition.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "objectattributedefinition.getid" + ], + "title": "ObjectAttributeDefinition.getID" + }, + { + "description": "Returns the object type definition in which this attribute is defined.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getObjectTypeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getObjectTypeDefinition", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the object type definition in which this attribute is defined.", + "heading": "Description" + } + ], + "signature": "getObjectTypeDefinition(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "getobjecttypedefinition", + "objectattributedefinition.getobjecttypedefinition" + ], + "title": "ObjectAttributeDefinition.getObjectTypeDefinition" + }, + { + "description": "Returns the attribute's unit representation such as inches for length or pounds for weight. The value returned by this method is based on the attribute itself.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getUnit", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getUnit", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the attribute's unit representation such as\ninches for length or pounds for weight. The value returned by\nthis method is based on the attribute itself.", + "heading": "Description" + } + ], + "signature": "getUnit(): string", + "source": "script-api", + "tags": [ + "getunit", + "objectattributedefinition.getunit" + ], + "title": "ObjectAttributeDefinition.getUnit" + }, + { + "description": "Returns a code for the data type stored in the attribute. See constants defined in this class.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getValueTypeCode", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getValueTypeCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns a code for the data type stored in the attribute. See constants\ndefined in this class.", + "heading": "Description" + } + ], + "signature": "getValueTypeCode(): number", + "source": "script-api", + "tags": [ + "getvaluetypecode", + "objectattributedefinition.getvaluetypecode" + ], + "title": "ObjectAttributeDefinition.getValueTypeCode" + }, + { + "description": "Returns the list of attribute values. In the user interface only the values specified in this list should be offered as valid input values.", + "id": "script-api:dw/object/ObjectAttributeDefinition#getValues", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.getValues", + "returns": { + "type": "Collection | null" + }, + "sections": [ + { + "body": "Returns the list of attribute values. In the user interface only the\nvalues specified in this list should be offered as valid input values.\n\nThe collection contains instances of ObjectAttributeValueDefinition.", + "heading": "Description" + } + ], + "signature": "getValues(): Collection | null", + "source": "script-api", + "tags": [ + "getvalues", + "objectattributedefinition.getvalues" + ], + "title": "ObjectAttributeDefinition.getValues" + }, + { + "description": "Identifies if the attribute represents the primary key of the object.", + "id": "script-api:dw/object/ObjectAttributeDefinition#isKey", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isKey", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the attribute represents the primary key of the object.", + "heading": "Description" + } + ], + "signature": "isKey(): boolean", + "source": "script-api", + "tags": [ + "iskey", + "objectattributedefinition.iskey" + ], + "title": "ObjectAttributeDefinition.isKey" + }, + { + "description": "Checks if this attribute is mandatory.", + "id": "script-api:dw/object/ObjectAttributeDefinition#isMandatory", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isMandatory", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if this attribute is mandatory.", + "heading": "Description" + } + ], + "signature": "isMandatory(): boolean", + "source": "script-api", + "tags": [ + "ismandatory", + "objectattributedefinition.ismandatory" + ], + "title": "ObjectAttributeDefinition.isMandatory" + }, + { + "description": "Returns `true` if the attribute can have multiple values.", + "id": "script-api:dw/object/ObjectAttributeDefinition#isMultiValueType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isMultiValueType", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the attribute can have multiple values.\n\nAttributes of the following types are multi-value capable:\n\n- VALUE_TYPE_SET_OF_INT\n- VALUE_TYPE_SET_OF_NUMBER\n- VALUE_TYPE_SET_OF_STRING\n\nAdditionally, attributes of the following types can be multi-value\nenabled:\n\n- VALUE_TYPE_ENUM_OF_INT\n- VALUE_TYPE_ENUM_OF_STRING", + "heading": "Description" + } + ], + "signature": "isMultiValueType(): boolean", + "source": "script-api", + "tags": [ + "ismultivaluetype", + "objectattributedefinition.ismultivaluetype" + ], + "title": "ObjectAttributeDefinition.isMultiValueType" + }, + { + "deprecated": { + "message": "Use isMultiValueType instead." + }, + "description": "Returns `true` if the attribute is of type 'Set of'.", + "id": "script-api:dw/object/ObjectAttributeDefinition#isSetValueType", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isSetValueType", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the attribute is of type 'Set of'.", + "heading": "Description" + } + ], + "signature": "isSetValueType(): boolean", + "source": "script-api", + "tags": [ + "issetvaluetype", + "objectattributedefinition.issetvaluetype" + ], + "title": "ObjectAttributeDefinition.isSetValueType" + }, + { + "description": "Indicates if the attribute is a pre-defined system attribute or a custom attribute.", + "id": "script-api:dw/object/ObjectAttributeDefinition#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.isSystem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the attribute is a pre-defined system attribute\nor a custom attribute.", + "heading": "Description" + } + ], + "signature": "isSystem(): boolean", + "source": "script-api", + "tags": [ + "issystem", + "objectattributedefinition.issystem" + ], + "title": "ObjectAttributeDefinition.isSystem" + }, + { + "description": "Identifies if the attribute represents the primary key of the object.", + "id": "script-api:dw/object/ObjectAttributeDefinition#key", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.key", + "sections": [ + { + "body": "Identifies if the attribute represents the primary key of the object.", + "heading": "Description" + } + ], + "signature": "readonly key: boolean", + "source": "script-api", + "tags": [ + "key", + "objectattributedefinition.key" + ], + "title": "ObjectAttributeDefinition.key" + }, + { + "description": "Checks if this attribute is mandatory.", + "id": "script-api:dw/object/ObjectAttributeDefinition#mandatory", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.mandatory", + "sections": [ + { + "body": "Checks if this attribute is mandatory.", + "heading": "Description" + } + ], + "signature": "readonly mandatory: boolean", + "source": "script-api", + "tags": [ + "mandatory", + "objectattributedefinition.mandatory" + ], + "title": "ObjectAttributeDefinition.mandatory" + }, + { + "description": "Returns `true` if the attribute can have multiple values.", + "id": "script-api:dw/object/ObjectAttributeDefinition#multiValueType", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.multiValueType", + "sections": [ + { + "body": "Returns `true` if the attribute can have multiple values.\n\nAttributes of the following types are multi-value capable:\n\n- VALUE_TYPE_SET_OF_INT\n- VALUE_TYPE_SET_OF_NUMBER\n- VALUE_TYPE_SET_OF_STRING\n\nAdditionally, attributes of the following types can be multi-value\nenabled:\n\n- VALUE_TYPE_ENUM_OF_INT\n- VALUE_TYPE_ENUM_OF_STRING", + "heading": "Description" + } + ], + "signature": "readonly multiValueType: boolean", + "source": "script-api", + "tags": [ + "multivaluetype", + "objectattributedefinition.multivaluetype" + ], + "title": "ObjectAttributeDefinition.multiValueType" + }, + { + "description": "Returns the object type definition in which this attribute is defined.", + "id": "script-api:dw/object/ObjectAttributeDefinition#objectTypeDefinition", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.objectTypeDefinition", + "sections": [ + { + "body": "Returns the object type definition in which this attribute is defined.", + "heading": "Description" + } + ], + "signature": "readonly objectTypeDefinition: ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "objecttypedefinition", + "objectattributedefinition.objecttypedefinition" + ], + "title": "ObjectAttributeDefinition.objectTypeDefinition" + }, + { + "description": "Returns a boolean flag indicating whether or not values of this attribute definition should be encoded using the encoding=\"off\" flag in ISML templates.", + "id": "script-api:dw/object/ObjectAttributeDefinition#requiresEncoding", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.requiresEncoding", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns a boolean flag indicating whether or not values of this attribute\ndefinition should be encoded using the encoding=\"off\" flag in ISML\ntemplates.", + "heading": "Description" + } + ], + "signature": "requiresEncoding(): boolean", + "source": "script-api", + "tags": [ + "requiresencoding", + "objectattributedefinition.requiresencoding" + ], + "title": "ObjectAttributeDefinition.requiresEncoding" + }, + { + "deprecated": { + "message": "Use isMultiValueType instead." + }, + "description": "Returns `true` if the attribute is of type 'Set of'.", + "id": "script-api:dw/object/ObjectAttributeDefinition#setValueType", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.setValueType", + "sections": [ + { + "body": "Returns `true` if the attribute is of type 'Set of'.", + "heading": "Description" + } + ], + "signature": "readonly setValueType: boolean", + "source": "script-api", + "tags": [ + "setvaluetype", + "objectattributedefinition.setvaluetype" + ], + "title": "ObjectAttributeDefinition.setValueType" + }, + { + "description": "Indicates if the attribute is a pre-defined system attribute or a custom attribute.", + "id": "script-api:dw/object/ObjectAttributeDefinition#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.system", + "sections": [ + { + "body": "Indicates if the attribute is a pre-defined system attribute\nor a custom attribute.", + "heading": "Description" + } + ], + "signature": "readonly system: boolean", + "source": "script-api", + "tags": [ + "system", + "objectattributedefinition.system" + ], + "title": "ObjectAttributeDefinition.system" + }, + { + "description": "Returns the attribute's unit representation such as inches for length or pounds for weight. The value returned by this method is based on the attribute itself.", + "id": "script-api:dw/object/ObjectAttributeDefinition#unit", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.unit", + "sections": [ + { + "body": "Returns the attribute's unit representation such as\ninches for length or pounds for weight. The value returned by\nthis method is based on the attribute itself.", + "heading": "Description" + } + ], + "signature": "readonly unit: string", + "source": "script-api", + "tags": [ + "unit", + "objectattributedefinition.unit" + ], + "title": "ObjectAttributeDefinition.unit" + }, + { + "description": "Returns a code for the data type stored in the attribute. See constants defined in this class.", + "id": "script-api:dw/object/ObjectAttributeDefinition#valueTypeCode", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.valueTypeCode", + "sections": [ + { + "body": "Returns a code for the data type stored in the attribute. See constants\ndefined in this class.", + "heading": "Description" + } + ], + "signature": "readonly valueTypeCode: number", + "source": "script-api", + "tags": [ + "valuetypecode", + "objectattributedefinition.valuetypecode" + ], + "title": "ObjectAttributeDefinition.valueTypeCode" + }, + { + "description": "Returns the list of attribute values. In the user interface only the values specified in this list should be offered as valid input values.", + "id": "script-api:dw/object/ObjectAttributeDefinition#values", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeDefinition", + "qualifiedName": "dw.object.ObjectAttributeDefinition.values", + "sections": [ + { + "body": "Returns the list of attribute values. In the user interface only the\nvalues specified in this list should be offered as valid input values.\n\nThe collection contains instances of ObjectAttributeValueDefinition.", + "heading": "Description" + } + ], + "signature": "readonly values: Collection | null", + "source": "script-api", + "tags": [ + "values", + "objectattributedefinition.values" + ], + "title": "ObjectAttributeDefinition.values" + }, + { + "description": "Represents a group of object attributes.", + "id": "script-api:dw/object/ObjectAttributeGroup", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeGroup", + "sections": [ + { + "body": "Represents a group of object attributes.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "objectattributegroup", + "dw.object.objectattributegroup", + "dw/object" + ], + "title": "ObjectAttributeGroup" + }, + { + "description": "Returns the ID of this group.", + "id": "script-api:dw/object/ObjectAttributeGroup#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.ID", + "sections": [ + { + "body": "Returns the ID of this group.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "objectattributegroup.id" + ], + "title": "ObjectAttributeGroup.ID" + }, + { + "description": "Returns all attribute definitions for this group. The collection may contain both system attribute definition as well as custom attribute definitions.", + "id": "script-api:dw/object/ObjectAttributeGroup#attributeDefinitions", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.attributeDefinitions", + "sections": [ + { + "body": "Returns all attribute definitions for this group. The collection\nmay contain both system attribute definition as well as custom\nattribute definitions.", + "heading": "Description" + } + ], + "signature": "readonly attributeDefinitions: Collection", + "source": "script-api", + "tags": [ + "attributedefinitions", + "objectattributegroup.attributedefinitions" + ], + "title": "ObjectAttributeGroup.attributeDefinitions" + }, + { + "description": "Returns the description of this group in the current locale.", + "id": "script-api:dw/object/ObjectAttributeGroup#description", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.description", + "sections": [ + { + "body": "Returns the description of this group in the current locale.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "objectattributegroup.description" + ], + "title": "ObjectAttributeGroup.description" + }, + { + "description": "Returns the display name of this group.", + "id": "script-api:dw/object/ObjectAttributeGroup#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.displayName", + "sections": [ + { + "body": "Returns the display name of this group.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "objectattributegroup.displayname" + ], + "title": "ObjectAttributeGroup.displayName" + }, + { + "description": "Returns all attribute definitions for this group. The collection may contain both system attribute definition as well as custom attribute definitions.", + "id": "script-api:dw/object/ObjectAttributeGroup#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all attribute definitions for this group. The collection\nmay contain both system attribute definition as well as custom\nattribute definitions.", + "heading": "Description" + } + ], + "signature": "getAttributeDefinitions(): Collection", + "source": "script-api", + "tags": [ + "getattributedefinitions", + "objectattributegroup.getattributedefinitions" + ], + "title": "ObjectAttributeGroup.getAttributeDefinitions" + }, + { + "description": "Returns the description of this group in the current locale.", + "id": "script-api:dw/object/ObjectAttributeGroup#getDescription", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description of this group in the current locale.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "objectattributegroup.getdescription" + ], + "title": "ObjectAttributeGroup.getDescription" + }, + { + "description": "Returns the display name of this group.", + "id": "script-api:dw/object/ObjectAttributeGroup#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of this group.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "objectattributegroup.getdisplayname" + ], + "title": "ObjectAttributeGroup.getDisplayName" + }, + { + "description": "Returns the ID of this group.", + "id": "script-api:dw/object/ObjectAttributeGroup#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this group.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "objectattributegroup.getid" + ], + "title": "ObjectAttributeGroup.getID" + }, + { + "description": "Returns the object type definition to which this attribute group belongs.", + "id": "script-api:dw/object/ObjectAttributeGroup#getObjectTypeDefinition", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.getObjectTypeDefinition", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the object type definition to which this attribute group\nbelongs.", + "heading": "Description" + } + ], + "signature": "getObjectTypeDefinition(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "getobjecttypedefinition", + "objectattributegroup.getobjecttypedefinition" + ], + "title": "ObjectAttributeGroup.getObjectTypeDefinition" + }, + { + "description": "Identifies if this is an sytem or a custom attribute group. A system attribute group is pre-defined and can not be deleted.", + "id": "script-api:dw/object/ObjectAttributeGroup#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.isSystem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this is an sytem or a custom attribute group. A system\nattribute group is pre-defined and can not be deleted.", + "heading": "Description" + } + ], + "signature": "isSystem(): boolean", + "source": "script-api", + "tags": [ + "issystem", + "objectattributegroup.issystem" + ], + "title": "ObjectAttributeGroup.isSystem" + }, + { + "description": "Returns the object type definition to which this attribute group belongs.", + "id": "script-api:dw/object/ObjectAttributeGroup#objectTypeDefinition", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.objectTypeDefinition", + "sections": [ + { + "body": "Returns the object type definition to which this attribute group\nbelongs.", + "heading": "Description" + } + ], + "signature": "readonly objectTypeDefinition: ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "objecttypedefinition", + "objectattributegroup.objecttypedefinition" + ], + "title": "ObjectAttributeGroup.objectTypeDefinition" + }, + { + "description": "Identifies if this is an sytem or a custom attribute group. A system attribute group is pre-defined and can not be deleted.", + "id": "script-api:dw/object/ObjectAttributeGroup#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeGroup", + "qualifiedName": "dw.object.ObjectAttributeGroup.system", + "sections": [ + { + "body": "Identifies if this is an sytem or a custom attribute group. A system\nattribute group is pre-defined and can not be deleted.", + "heading": "Description" + } + ], + "signature": "readonly system: boolean", + "source": "script-api", + "tags": [ + "system", + "objectattributegroup.system" + ], + "title": "ObjectAttributeGroup.system" + }, + { + "description": "Represents the value definition associated with an object attribute.", + "id": "script-api:dw/object/ObjectAttributeValueDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition", + "sections": [ + { + "body": "Represents the value definition associated with an\nobject attribute.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "objectattributevaluedefinition", + "dw.object.objectattributevaluedefinition", + "dw/object" + ], + "title": "ObjectAttributeValueDefinition" + }, + { + "description": "Returns a display name that can be used to present this value in the user interface. For example, the value might be '1' but the display name might be 'Order Exported'.", + "id": "script-api:dw/object/ObjectAttributeValueDefinition#displayValue", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.displayValue", + "sections": [ + { + "body": "Returns a display name that can be used to present this value in\nthe user interface. For example, the value might be '1' but the display\nname might be 'Order Exported'.", + "heading": "Description" + } + ], + "signature": "readonly displayValue: string", + "source": "script-api", + "tags": [ + "displayvalue", + "objectattributevaluedefinition.displayvalue" + ], + "title": "ObjectAttributeValueDefinition.displayValue" + }, + { + "description": "Returns a display name that can be used to present this value in the user interface. For example, the value might be '1' but the display name might be 'Order Exported'.", + "id": "script-api:dw/object/ObjectAttributeValueDefinition#getDisplayValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.getDisplayValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a display name that can be used to present this value in\nthe user interface. For example, the value might be '1' but the display\nname might be 'Order Exported'.", + "heading": "Description" + } + ], + "signature": "getDisplayValue(): string", + "source": "script-api", + "tags": [ + "getdisplayvalue", + "objectattributevaluedefinition.getdisplayvalue" + ], + "title": "ObjectAttributeValueDefinition.getDisplayValue" + }, + { + "description": "Returns the actual value for the attribute.", + "id": "script-api:dw/object/ObjectAttributeValueDefinition#getValue", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.getValue", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the actual value for the attribute.", + "heading": "Description" + } + ], + "signature": "getValue(): any", + "source": "script-api", + "tags": [ + "getvalue", + "objectattributevaluedefinition.getvalue" + ], + "title": "ObjectAttributeValueDefinition.getValue" + }, + { + "description": "Returns the actual value for the attribute.", + "id": "script-api:dw/object/ObjectAttributeValueDefinition#value", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectAttributeValueDefinition", + "qualifiedName": "dw.object.ObjectAttributeValueDefinition.value", + "sections": [ + { + "body": "Returns the actual value for the attribute.", + "heading": "Description" + } + ], + "signature": "readonly value: any", + "source": "script-api", + "tags": [ + "value", + "objectattributevaluedefinition.value" + ], + "title": "ObjectAttributeValueDefinition.value" + }, + { + "description": "The class provides access to the meta data of a system object or custom object. A short example should suffice to demonstrate how this metadata can be used in a script:", + "id": "script-api:dw/object/ObjectTypeDefinition", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.ObjectTypeDefinition", + "sections": [ + { + "body": "The class provides access to the meta data of a system object or custom\nobject. A short example should suffice to demonstrate how this metadata can\nbe used in a script:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "objecttypedefinition", + "dw.object.objecttypedefinition", + "dw/object" + ], + "title": "ObjectTypeDefinition" + }, + { + "description": "Returns the type id of the business objects.", + "id": "script-api:dw/object/ObjectTypeDefinition#ID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.ID", + "sections": [ + { + "body": "Returns the type id of the business objects.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "objecttypedefinition.id" + ], + "title": "ObjectTypeDefinition.ID" + }, + { + "description": "Returns a collection of all declared attributes for the object. The collection contains both system and custom attributes. There might be system and custom attribute with identical names. So the name of the attribute is not a uniqueness criteria. Additional the isCustom() flag must be checked.", + "id": "script-api:dw/object/ObjectTypeDefinition#attributeDefinitions", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.attributeDefinitions", + "sections": [ + { + "body": "Returns a collection of all declared attributes for the object.\nThe collection contains both system and custom attributes. There might\nbe system and custom attribute with identical names. So the name of the\nattribute is not a uniqueness criteria. Additional the isCustom() flag\nmust be checked.", + "heading": "Description" + } + ], + "signature": "readonly attributeDefinitions: Collection", + "source": "script-api", + "tags": [ + "attributedefinitions", + "objecttypedefinition.attributedefinitions" + ], + "title": "ObjectTypeDefinition.attributeDefinitions" + }, + { + "description": "Returns a collection of all declared attribute groups. A attribute group is a collection of attribute, which are typically displayed together as a visual group.", + "id": "script-api:dw/object/ObjectTypeDefinition#attributeGroups", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.attributeGroups", + "sections": [ + { + "body": "Returns a collection of all declared attribute groups. A attribute group\nis a collection of attribute, which are typically displayed together as\na visual group.", + "heading": "Description" + } + ], + "signature": "readonly attributeGroups: Collection", + "source": "script-api", + "tags": [ + "attributegroups", + "objecttypedefinition.attributegroups" + ], + "title": "ObjectTypeDefinition.attributeGroups" + }, + { + "description": "Returns the display name of the definition, which can be used in the user interface.", + "id": "script-api:dw/object/ObjectTypeDefinition#displayName", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.displayName", + "sections": [ + { + "body": "Returns the display name of the definition, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "objecttypedefinition.displayname" + ], + "title": "ObjectTypeDefinition.displayName" + }, + { + "description": "Returns a collection of all declared attributes for the object. The collection contains both system and custom attributes. There might be system and custom attribute with identical names. So the name of the attribute is not a uniqueness criteria. Additional the isCustom() flag must be checked.", + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeDefinitions", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeDefinitions", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all declared attributes for the object.\nThe collection contains both system and custom attributes. There might\nbe system and custom attribute with identical names. So the name of the\nattribute is not a uniqueness criteria. Additional the isCustom() flag\nmust be checked.", + "heading": "Description" + } + ], + "signature": "getAttributeDefinitions(): Collection", + "source": "script-api", + "tags": [ + "getattributedefinitions", + "objecttypedefinition.getattributedefinitions" + ], + "title": "ObjectTypeDefinition.getAttributeDefinitions" + }, + { + "description": "Returns the attribute group with the given name within this object type definition.", + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeGroup", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeGroup", + "returns": { + "type": "ObjectAttributeGroup | null" + }, + "sections": [ + { + "body": "Returns the attribute group with the given name within this object\ntype definition.", + "heading": "Description" + } + ], + "signature": "getAttributeGroup(name: string): ObjectAttributeGroup | null", + "source": "script-api", + "tags": [ + "getattributegroup", + "objecttypedefinition.getattributegroup" + ], + "title": "ObjectTypeDefinition.getAttributeGroup" + }, + { + "description": "Returns a collection of all declared attribute groups. A attribute group is a collection of attribute, which are typically displayed together as a visual group.", + "id": "script-api:dw/object/ObjectTypeDefinition#getAttributeGroups", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getAttributeGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all declared attribute groups. A attribute group\nis a collection of attribute, which are typically displayed together as\na visual group.", + "heading": "Description" + } + ], + "signature": "getAttributeGroups(): Collection", + "source": "script-api", + "tags": [ + "getattributegroups", + "objecttypedefinition.getattributegroups" + ], + "title": "ObjectTypeDefinition.getAttributeGroups" + }, + { + "description": "Returns the custom attribute definition with the given name. The method returns null if no custom attribute is defined with that name.", + "id": "script-api:dw/object/ObjectTypeDefinition#getCustomAttributeDefinition", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getCustomAttributeDefinition", + "returns": { + "type": "ObjectAttributeDefinition | null" + }, + "sections": [ + { + "body": "Returns the custom attribute definition with the given name. The method\nreturns null if no custom attribute is defined with that name.", + "heading": "Description" + } + ], + "signature": "getCustomAttributeDefinition(name: string): ObjectAttributeDefinition | null", + "source": "script-api", + "tags": [ + "getcustomattributedefinition", + "objecttypedefinition.getcustomattributedefinition" + ], + "title": "ObjectTypeDefinition.getCustomAttributeDefinition" + }, + { + "description": "Returns the display name of the definition, which can be used in the user interface.", + "id": "script-api:dw/object/ObjectTypeDefinition#getDisplayName", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of the definition, which can be used in the\nuser interface.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "objecttypedefinition.getdisplayname" + ], + "title": "ObjectTypeDefinition.getDisplayName" + }, + { + "description": "Returns the type id of the business objects.", + "id": "script-api:dw/object/ObjectTypeDefinition#getID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type id of the business objects.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "objecttypedefinition.getid" + ], + "title": "ObjectTypeDefinition.getID" + }, + { + "description": "Returns the system attribute definition with the given name. The method returns null if no system attribute is defined with that name. Only system objects have system attributes. A CustomObject has no system attributes and so the method will always return null for a CustomObject.", + "id": "script-api:dw/object/ObjectTypeDefinition#getSystemAttributeDefinition", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.getSystemAttributeDefinition", + "returns": { + "type": "ObjectAttributeDefinition | null" + }, + "sections": [ + { + "body": "Returns the system attribute definition with the given name. The method\nreturns null if no system attribute is defined with that name. Only\nsystem objects have system attributes. A CustomObject has no system attributes\nand so the method will always return null for a CustomObject.", + "heading": "Description" + } + ], + "signature": "getSystemAttributeDefinition(name: string): ObjectAttributeDefinition | null", + "source": "script-api", + "tags": [ + "getsystemattributedefinition", + "objecttypedefinition.getsystemattributedefinition" + ], + "title": "ObjectTypeDefinition.getSystemAttributeDefinition" + }, + { + "description": "Identifies if this object definition is for a system type or a custom type.", + "id": "script-api:dw/object/ObjectTypeDefinition#isSystem", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.isSystem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this object definition is for a system type or a custom\ntype.", + "heading": "Description" + } + ], + "signature": "isSystem(): boolean", + "source": "script-api", + "tags": [ + "issystem", + "objecttypedefinition.issystem" + ], + "title": "ObjectTypeDefinition.isSystem" + }, + { + "description": "Identifies if this object definition is for a system type or a custom type.", + "id": "script-api:dw/object/ObjectTypeDefinition#system", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/ObjectTypeDefinition", + "qualifiedName": "dw.object.ObjectTypeDefinition.system", + "sections": [ + { + "body": "Identifies if this object definition is for a system type or a custom\ntype.", + "heading": "Description" + } + ], + "signature": "readonly system: boolean", + "source": "script-api", + "tags": [ + "system", + "objecttypedefinition.system" + ], + "title": "ObjectTypeDefinition.system" + }, + { + "description": "Common base class for all objects in Commerce Cloud Digital that have an identity and can be stored and retrieved. Each entity is identified by a unique universal identifier (a UUID).", + "id": "script-api:dw/object/PersistentObject", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.PersistentObject", + "sections": [ + { + "body": "Common base class for all objects in Commerce Cloud Digital that have an\nidentity and can be stored and retrieved. Each entity is identified by\na unique universal identifier (a UUID).", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "persistentobject", + "dw.object.persistentobject", + "dw/object" + ], + "title": "PersistentObject" + }, + { + "description": "Returns the unique universal identifier for this object.", + "id": "script-api:dw/object/PersistentObject#UUID", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.UUID", + "sections": [ + { + "body": "Returns the unique universal identifier for this object.", + "heading": "Description" + } + ], + "signature": "readonly UUID: string", + "source": "script-api", + "tags": [ + "uuid", + "persistentobject.uuid" + ], + "title": "PersistentObject.UUID" + }, + { + "description": "Returns the date that this object was created.", + "id": "script-api:dw/object/PersistentObject#creationDate", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.creationDate", + "sections": [ + { + "body": "Returns the date that this object was created.", + "heading": "Description" + } + ], + "signature": "readonly creationDate: Date", + "source": "script-api", + "tags": [ + "creationdate", + "persistentobject.creationdate" + ], + "title": "PersistentObject.creationDate" + }, + { + "description": "Returns the date that this object was created.", + "id": "script-api:dw/object/PersistentObject#getCreationDate", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getCreationDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date that this object was created.", + "heading": "Description" + } + ], + "signature": "getCreationDate(): Date", + "source": "script-api", + "tags": [ + "getcreationdate", + "persistentobject.getcreationdate" + ], + "title": "PersistentObject.getCreationDate" + }, + { + "description": "Returns the date that this object was last modified.", + "id": "script-api:dw/object/PersistentObject#getLastModified", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getLastModified", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the date that this object was last modified.", + "heading": "Description" + } + ], + "signature": "getLastModified(): Date", + "source": "script-api", + "tags": [ + "getlastmodified", + "persistentobject.getlastmodified" + ], + "title": "PersistentObject.getLastModified" + }, + { + "description": "Returns the unique universal identifier for this object.", + "id": "script-api:dw/object/PersistentObject#getUUID", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.getUUID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique universal identifier for this object.", + "heading": "Description" + } + ], + "signature": "getUUID(): string", + "source": "script-api", + "tags": [ + "getuuid", + "persistentobject.getuuid" + ], + "title": "PersistentObject.getUUID" + }, + { + "description": "Returns the date that this object was last modified.", + "id": "script-api:dw/object/PersistentObject#lastModified", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/PersistentObject", + "qualifiedName": "dw.object.PersistentObject.lastModified", + "sections": [ + { + "body": "Returns the date that this object was last modified.", + "heading": "Description" + } + ], + "signature": "readonly lastModified: Date", + "source": "script-api", + "tags": [ + "lastmodified", + "persistentobject.lastmodified" + ], + "title": "PersistentObject.lastModified" + }, + { + "description": "Base class alternative to ExtensibleObject for customizable objects which do not rely on the metadata system. Unlike Extensible any custom attributes can be set on the fly and are not checked against an available list. Similar to Extensible method getCustom is the central point to retrieve and store the objects attribute values.", + "id": "script-api:dw/object/SimpleExtensible", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.SimpleExtensible", + "sections": [ + { + "body": "Base class alternative to ExtensibleObject for customizable objects which do not rely on the metadata system.\nUnlike Extensible any custom attributes can be set on the fly and are not checked against an available list.\nSimilar to Extensible method getCustom is the central point to retrieve and store the objects attribute\nvalues.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "simpleextensible", + "dw.object.simpleextensible", + "dw/object" + ], + "title": "SimpleExtensible" + }, + { + "description": "Returns the custom attributes for this object.", + "id": "script-api:dw/object/SimpleExtensible#custom", + "kind": "property", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SimpleExtensible", + "qualifiedName": "dw.object.SimpleExtensible.custom", + "sections": [ + { + "body": "Returns the custom attributes for this object.", + "heading": "Description" + } + ], + "signature": "readonly custom: CustomAttributes", + "source": "script-api", + "tags": [ + "custom", + "simpleextensible.custom" + ], + "title": "SimpleExtensible.custom" + }, + { + "description": "Returns the custom attributes for this object.", + "id": "script-api:dw/object/SimpleExtensible#getCustom", + "kind": "method", + "packagePath": "dw/object", + "parentId": "script-api:dw/object/SimpleExtensible", + "qualifiedName": "dw.object.SimpleExtensible.getCustom", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns the custom attributes for this object.", + "heading": "Description" + } + ], + "signature": "getCustom(): CustomAttributes", + "source": "script-api", + "tags": [ + "getcustom", + "simpleextensible.getcustom" + ], + "title": "SimpleExtensible.getCustom" + }, + { + "description": "Manager class which provides methods for querying of system objects with meta data using the Commerce Cloud Digital query language. See individual API methods for details on the query language.", + "id": "script-api:dw/object/SystemObjectMgr", + "kind": "class", + "packagePath": "dw/object", + "parentId": "script-api:dw/object", + "qualifiedName": "dw.object.SystemObjectMgr", + "sections": [ + { + "body": "Manager class which provides methods for querying of system objects with\nmeta data using the Commerce Cloud Digital query language. See individual API methods for\ndetails on the query language.\n\nNote: Other manager classes such as dw.customer.CustomerMgr,\ndw.catalog.ProductMgr, etc provide more specific and fine-grained\nquerying methods that can not be achieved using the general query language.\n\nThe following system object types are supported:\n\n- GiftCertificate\n- SourceCodeGroup\n- Store\n- ProductList\n\nSupport for the following system object types is deprecated:\n\n- Order\n- Profile\n\nUse the search methods from dw.customer.CustomerMgr and dw.order.OrderMgr,\nrespectively for querying these types.\n\nTo search for custom objects, use dw.object.CustomObjectMgr.\nNote: this class allows access to sensitive information through\noperations that retrieve the Profile and Order objects.\nPay attention to appropriate legal and regulatory requirements related to this data.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "systemobjectmgr", + "dw.object.systemobjectmgr", + "dw/object" + ], + "title": "SystemObjectMgr" + }, + { + "description": "Returns the object type definition for the given system object type.", + "id": "script-api:dw/object/SystemObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.describe", + "returns": { + "type": "ObjectTypeDefinition | null" + }, + "sections": [ + { + "body": "Returns the object type definition for the given system object type.\n\nThis method can be used for all system object types that are derived from ExtensibleObject.", + "heading": "Description" + } + ], + "signature": "static describe(type: string): ObjectTypeDefinition | null", + "source": "script-api", + "tags": [ + "describe", + "systemobjectmgr.describe" + ], + "title": "SystemObjectMgr.describe" + }, + { + "description": "Returns the object type definition for the given system object type.", + "id": "script-api:dw/object/SystemObjectMgr#describe", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.describe", + "returns": { + "type": "ObjectTypeDefinition | null" + }, + "sections": [ + { + "body": "Returns the object type definition for the given system object type.\n\nThis method can be used for all system object types that are derived from ExtensibleObject.", + "heading": "Description" + } + ], + "signature": "static describe(type: string): ObjectTypeDefinition | null", + "source": "script-api", + "tags": [ + "describe", + "systemobjectmgr.describe" + ], + "title": "SystemObjectMgr.describe" + }, + { + "description": "Returns all system objects of a specific type. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#getAllSystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.getAllSystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Returns all system objects of a specific type.\nThe following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static getAllSystemObjects(type: string): SeekableIterator", + "source": "script-api", + "tags": [ + "getallsystemobjects", + "systemobjectmgr.getallsystemobjects" + ], + "title": "SystemObjectMgr.getAllSystemObjects" + }, + { + "description": "Returns all system objects of a specific type. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#getAllSystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.getAllSystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Returns all system objects of a specific type.\nThe following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator\nif not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.", + "heading": "Description" + } + ], + "signature": "static getAllSystemObjects(type: string): SeekableIterator", + "source": "script-api", + "tags": [ + "getallsystemobjects", + "systemobjectmgr.getallsystemobjects" + ], + "title": "SystemObjectMgr.getAllSystemObjects" + }, + { + "description": "Searches for a single system object instance. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObject", + "returns": { + "type": "PersistentObject" + }, + "sections": [ + { + "body": "Searches for a single system object instance. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set it is recommended to use the following code:\n`querySystemObjects(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns\nonly the next element and closes the iterator.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being processed. This will enable the cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObject(type: string, queryString: string, args?: any[]): PersistentObject", + "source": "script-api", + "tags": [ + "querysystemobject", + "systemobjectmgr.querysystemobject" + ], + "title": "SystemObjectMgr.querySystemObject" + }, + { + "description": "Searches for a single system object instance. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObject", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObject", + "returns": { + "type": "PersistentObject" + }, + "sections": [ + { + "body": "Searches for a single system object instance. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set it is recommended to use the following code:\n`querySystemObjects(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns\nonly the next element and closes the iterator.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being processed. This will enable the cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObject(type: string, queryString: string, args?: any[]): PersistentObject", + "source": "script-api", + "tags": [ + "querysystemobject", + "systemobjectmgr.querysystemobject" + ], + "title": "SystemObjectMgr.querySystemObject" + }, + { + "description": "Searches for system object instances. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for system object instances. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the system object and the 'sortString' in combination with an empty\n'queryString', e.g. `querySystemObjects(\"sample\", \"\", \"ID asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObjects(type: string, queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "description": "Searches for system object instances. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for system object instances. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured with a map, which key-value pairs are converted into a query expression. The\nkey-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObjects(type: string, queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "description": "Searches for system object instances. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for system object instances. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number and Date types only\n- `>` Greater than - Integer, Number and Date types only\n- `<=` Less or equals than - Integer, Number and Date types only\n- `>=` Greater or equals than - Integer, Number and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search(`custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query\n(`custom.country ILIKE 'usa'`), does also support wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1' and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the system object and the 'sortString' in combination with an empty\n'queryString', e.g. `querySystemObjects(\"sample\", \"\", \"ID asc\")`\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObjects(type: string, queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "description": "Searches for system object instances. The following system object types are supported:", + "id": "script-api:dw/object/SystemObjectMgr#querySystemObjects", + "kind": "method", + "packagePath": "dw/object", + "params": [ + { + "name": "type", + "type": "string" + }, + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/object/SystemObjectMgr", + "qualifiedName": "dw.object.SystemObjectMgr.querySystemObjects", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for system object instances. The following system object types are supported:\n\n- GiftCertificate\n- Order\n- Profile\n- SourceCodeGroup\n- Store\n- ProductList\n\nThe method throws an exception in case of another system type.\n\nThe search can be configured with a map, which key-value pairs are converted into a query expression. The\nkey-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote, that some system attributes are not queryable by default regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default\nsorting directions is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `close()` on the returned SeekableIterator if not all of its\nelements are being retrieved. This will ensure the proper cleanup of system resources.\n\nThis method does not consider locale specific attributes. It returns all objects by checking the default\nnon-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom\ncode.\n\nExample: For store objects, such a locale specific filtering can be:\n\n- Get the store objects using this method with non-localized attributes query.\n- Access the `store.getCustom(\"myattr\")`. It returns the localized value of the attribute.", + "heading": "Description" + } + ], + "signature": "static querySystemObjects(type: string, queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "querysystemobjects", + "systemobjectmgr.querysystemobjects" + ], + "title": "SystemObjectMgr.querySystemObjects" + }, + { + "description": "60 declarations", + "id": "script-api:dw/order", + "kind": "package", + "packagePath": "dw/order", + "qualifiedName": "dw.order", + "source": "script-api", + "tags": [ + "dw/order", + "dw.order" + ], + "title": "dw.order" + }, + { + "description": "An item which references, or in other words is based upon, an dw.order.OrderItem. Provides methods to access the OrderItem, the order dw.order.LineItem which has been extended, and the dw.order.Order. In addition it defines methods to access item level prices and the item id. Supports custom-properties.", + "id": "script-api:dw/order/AbstractItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AbstractItem", + "sections": [ + { + "body": "An item which references, or in other words is based upon, an dw.order.OrderItem. Provides methods to access the\nOrderItem, the order dw.order.LineItem which has been extended, and the dw.order.Order. In addition it defines\nmethods to access item level prices and the item id. Supports custom-properties.", + "heading": "Description" + }, + { + "body": "Extends `Extensible`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "abstractitem", + "dw.order.abstractitem", + "dw/order" + ], + "title": "AbstractItem" + }, + { + "description": "Gross price of item.", + "id": "script-api:dw/order/AbstractItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Gross price of item.", + "heading": "Description" + } + ], + "signature": "getGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getgrossprice", + "abstractitem.getgrossprice" + ], + "title": "AbstractItem.getGrossPrice" + }, + { + "description": "The item-id used for referencing between items", + "id": "script-api:dw/order/AbstractItem#getItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getItemID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The item-id used for referencing between items", + "heading": "Description" + } + ], + "signature": "getItemID(): string", + "source": "script-api", + "tags": [ + "getitemid", + "abstractitem.getitemid" + ], + "title": "AbstractItem.getItemID" + }, + { + "description": "Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.", + "id": "script-api:dw/order/AbstractItem#getLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getLineItem", + "returns": { + "type": "LineItem" + }, + "sections": [ + { + "body": "Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "getLineItem(): LineItem", + "source": "script-api", + "tags": [ + "getlineitem", + "abstractitem.getlineitem" + ], + "title": "AbstractItem.getLineItem" + }, + { + "description": "Net price of item.", + "id": "script-api:dw/order/AbstractItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Net price of item.", + "heading": "Description" + } + ], + "signature": "getNetPrice(): Money", + "source": "script-api", + "tags": [ + "getnetprice", + "abstractitem.getnetprice" + ], + "title": "AbstractItem.getNetPrice" + }, + { + "description": "Returns the order item extensions related to this item. Should never return null.", + "id": "script-api:dw/order/AbstractItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getOrderItem", + "returns": { + "type": "OrderItem" + }, + "sections": [ + { + "body": "Returns the order item extensions related to this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "getOrderItem(): OrderItem", + "source": "script-api", + "tags": [ + "getorderitem", + "abstractitem.getorderitem" + ], + "title": "AbstractItem.getOrderItem" + }, + { + "description": "The order-item-id used for referencing the dw.order.OrderItem", + "id": "script-api:dw/order/AbstractItem#getOrderItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getOrderItemID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The order-item-id used for referencing the dw.order.OrderItem", + "heading": "Description" + } + ], + "signature": "getOrderItemID(): string", + "source": "script-api", + "tags": [ + "getorderitemid", + "abstractitem.getorderitemid" + ], + "title": "AbstractItem.getOrderItemID" + }, + { + "description": "Total tax for item.", + "id": "script-api:dw/order/AbstractItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Total tax for item.", + "heading": "Description" + } + ], + "signature": "getTax(): Money", + "source": "script-api", + "tags": [ + "gettax", + "abstractitem.gettax" + ], + "title": "AbstractItem.getTax" + }, + { + "description": "Price of entire item on which tax calculation is based. Same as getNetPrice or getGrossPrice depending on whether the order is based on net or gross prices.", + "id": "script-api:dw/order/AbstractItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTaxBasis", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of entire item on which tax calculation is based. Same as getNetPrice\nor getGrossPrice depending on whether the order is based on net or gross prices.", + "heading": "Description" + } + ], + "signature": "getTaxBasis(): Money", + "source": "script-api", + "tags": [ + "gettaxbasis", + "abstractitem.gettaxbasis" + ], + "title": "AbstractItem.getTaxBasis" + }, + { + "description": "Tax items representing a tax breakdown", + "id": "script-api:dw/order/AbstractItem#getTaxItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.getTaxItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Tax items representing a tax breakdown", + "heading": "Description" + } + ], + "signature": "getTaxItems(): Collection", + "source": "script-api", + "tags": [ + "gettaxitems", + "abstractitem.gettaxitems" + ], + "title": "AbstractItem.getTaxItems" + }, + { + "description": "Gross price of item.", + "id": "script-api:dw/order/AbstractItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.grossPrice", + "sections": [ + { + "body": "Gross price of item.", + "heading": "Description" + } + ], + "signature": "readonly grossPrice: Money", + "source": "script-api", + "tags": [ + "grossprice", + "abstractitem.grossprice" + ], + "title": "AbstractItem.grossPrice" + }, + { + "description": "The item-id used for referencing between items", + "id": "script-api:dw/order/AbstractItem#itemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.itemID", + "sections": [ + { + "body": "The item-id used for referencing between items", + "heading": "Description" + } + ], + "signature": "readonly itemID: string", + "source": "script-api", + "tags": [ + "itemid", + "abstractitem.itemid" + ], + "title": "AbstractItem.itemID" + }, + { + "description": "Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.", + "id": "script-api:dw/order/AbstractItem#lineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.lineItem", + "sections": [ + { + "body": "Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "readonly lineItem: LineItem", + "source": "script-api", + "tags": [ + "lineitem", + "abstractitem.lineitem" + ], + "title": "AbstractItem.lineItem" + }, + { + "description": "Net price of item.", + "id": "script-api:dw/order/AbstractItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.netPrice", + "sections": [ + { + "body": "Net price of item.", + "heading": "Description" + } + ], + "signature": "readonly netPrice: Money", + "source": "script-api", + "tags": [ + "netprice", + "abstractitem.netprice" + ], + "title": "AbstractItem.netPrice" + }, + { + "description": "Returns the order item extensions related to this item. Should never return null.", + "id": "script-api:dw/order/AbstractItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.orderItem", + "sections": [ + { + "body": "Returns the order item extensions related to this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "readonly orderItem: OrderItem", + "source": "script-api", + "tags": [ + "orderitem", + "abstractitem.orderitem" + ], + "title": "AbstractItem.orderItem" + }, + { + "description": "The order-item-id used for referencing the dw.order.OrderItem", + "id": "script-api:dw/order/AbstractItem#orderItemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.orderItemID", + "sections": [ + { + "body": "The order-item-id used for referencing the dw.order.OrderItem", + "heading": "Description" + } + ], + "signature": "readonly orderItemID: string", + "source": "script-api", + "tags": [ + "orderitemid", + "abstractitem.orderitemid" + ], + "title": "AbstractItem.orderItemID" + }, + { + "description": "Total tax for item.", + "id": "script-api:dw/order/AbstractItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.tax", + "sections": [ + { + "body": "Total tax for item.", + "heading": "Description" + } + ], + "signature": "readonly tax: Money", + "source": "script-api", + "tags": [ + "tax", + "abstractitem.tax" + ], + "title": "AbstractItem.tax" + }, + { + "description": "Price of entire item on which tax calculation is based. Same as getNetPrice or getGrossPrice depending on whether the order is based on net or gross prices.", + "id": "script-api:dw/order/AbstractItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.taxBasis", + "sections": [ + { + "body": "Price of entire item on which tax calculation is based. Same as getNetPrice\nor getGrossPrice depending on whether the order is based on net or gross prices.", + "heading": "Description" + } + ], + "signature": "readonly taxBasis: Money", + "source": "script-api", + "tags": [ + "taxbasis", + "abstractitem.taxbasis" + ], + "title": "AbstractItem.taxBasis" + }, + { + "description": "Tax items representing a tax breakdown", + "id": "script-api:dw/order/AbstractItem#taxItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItem", + "qualifiedName": "dw.order.AbstractItem.taxItems", + "sections": [ + { + "body": "Tax items representing a tax breakdown", + "heading": "Description" + } + ], + "signature": "readonly taxItems: Collection", + "source": "script-api", + "tags": [ + "taxitems", + "abstractitem.taxitems" + ], + "title": "AbstractItem.taxItems" + }, + { + "description": "Basis for item-based objects stemming from a single dw.order.Order, with these common properties (Invoice is used as an example):", + "id": "script-api:dw/order/AbstractItemCtnr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AbstractItemCtnr", + "sections": [ + { + "body": "Basis for item-based objects stemming from a single dw.order.Order, with these common\nproperties (Invoice is used as an example):\n\n-\nThe object has been created from an Order accessible using getOrder\n- Contains a collection of getItems, each item related to exactly one dw.order.OrderItem which in turn represents\nan extension to one of the order dw.order.ProductLineItem or one dw.order.ShippingLineItem.\nExample: an dw.order.Invoice has dw.order.InvoiceItems\n-\nThe items hold various prices which are summed, resulting in a\ngetProductSubtotal, a\ngetServiceSubtotal and a getGrandTotal,\neach represented by a dw.order.SumItem.\n- The object is customizable using custom properties", + "heading": "Description" + }, + { + "body": "Extends `Extensible`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "abstractitemctnr", + "dw.order.abstractitemctnr", + "dw/order" + ], + "title": "AbstractItemCtnr" + }, + { + "description": "Created by this user.", + "id": "script-api:dw/order/AbstractItemCtnr#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.createdBy", + "sections": [ + { + "body": "Created by this user.", + "heading": "Description" + } + ], + "signature": "readonly createdBy: string", + "source": "script-api", + "tags": [ + "createdby", + "abstractitemctnr.createdby" + ], + "title": "AbstractItemCtnr.createdBy" + }, + { + "description": "The time of creation.", + "id": "script-api:dw/order/AbstractItemCtnr#creationDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.creationDate", + "sections": [ + { + "body": "The time of creation.", + "heading": "Description" + } + ], + "signature": "readonly creationDate: Date", + "source": "script-api", + "tags": [ + "creationdate", + "abstractitemctnr.creationdate" + ], + "title": "AbstractItemCtnr.creationDate" + }, + { + "description": "Created by this user.", + "id": "script-api:dw/order/AbstractItemCtnr#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getCreatedBy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Created by this user.", + "heading": "Description" + } + ], + "signature": "getCreatedBy(): string", + "source": "script-api", + "tags": [ + "getcreatedby", + "abstractitemctnr.getcreatedby" + ], + "title": "AbstractItemCtnr.getCreatedBy" + }, + { + "description": "The time of creation.", + "id": "script-api:dw/order/AbstractItemCtnr#getCreationDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getCreationDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "The time of creation.", + "heading": "Description" + } + ], + "signature": "getCreationDate(): Date", + "source": "script-api", + "tags": [ + "getcreationdate", + "abstractitemctnr.getcreationdate" + ], + "title": "AbstractItemCtnr.getCreationDate" + }, + { + "description": "Returns the sum-item representing the grandtotal for all items.", + "id": "script-api:dw/order/AbstractItemCtnr#getGrandTotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getGrandTotal", + "returns": { + "type": "SumItem" + }, + "sections": [ + { + "body": "Returns the sum-item representing the grandtotal for all items.", + "heading": "Description" + } + ], + "signature": "getGrandTotal(): SumItem", + "source": "script-api", + "tags": [ + "getgrandtotal", + "abstractitemctnr.getgrandtotal" + ], + "title": "AbstractItemCtnr.getGrandTotal" + }, + { + "description": "Returns the unsorted collection of items", + "id": "script-api:dw/order/AbstractItemCtnr#getItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the unsorted collection of items", + "heading": "Description" + } + ], + "signature": "getItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getitems", + "abstractitemctnr.getitems" + ], + "title": "AbstractItemCtnr.getItems" + }, + { + "description": "The last modification time.", + "id": "script-api:dw/order/AbstractItemCtnr#getLastModified", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getLastModified", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "The last modification time.", + "heading": "Description" + } + ], + "signature": "getLastModified(): Date", + "source": "script-api", + "tags": [ + "getlastmodified", + "abstractitemctnr.getlastmodified" + ], + "title": "AbstractItemCtnr.getLastModified" + }, + { + "description": "Last modified by this user.", + "id": "script-api:dw/order/AbstractItemCtnr#getModifiedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getModifiedBy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Last modified by this user.", + "heading": "Description" + } + ], + "signature": "getModifiedBy(): string", + "source": "script-api", + "tags": [ + "getmodifiedby", + "abstractitemctnr.getmodifiedby" + ], + "title": "AbstractItemCtnr.getModifiedBy" + }, + { + "description": "Returns the dw.order.Order this object was created for.", + "id": "script-api:dw/order/AbstractItemCtnr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the dw.order.Order this object was created for.", + "heading": "Description" + } + ], + "signature": "getOrder(): Order", + "source": "script-api", + "tags": [ + "getorder", + "abstractitemctnr.getorder" + ], + "title": "AbstractItemCtnr.getOrder" + }, + { + "description": "Returns the sum-item representing the subtotal for product items.", + "id": "script-api:dw/order/AbstractItemCtnr#getProductSubtotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getProductSubtotal", + "returns": { + "type": "SumItem" + }, + "sections": [ + { + "body": "Returns the sum-item representing the subtotal for product items.", + "heading": "Description" + } + ], + "signature": "getProductSubtotal(): SumItem", + "source": "script-api", + "tags": [ + "getproductsubtotal", + "abstractitemctnr.getproductsubtotal" + ], + "title": "AbstractItemCtnr.getProductSubtotal" + }, + { + "description": "Returns the sum-item representing the subtotal for service items such as shipping.", + "id": "script-api:dw/order/AbstractItemCtnr#getServiceSubtotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.getServiceSubtotal", + "returns": { + "type": "SumItem" + }, + "sections": [ + { + "body": "Returns the sum-item representing the subtotal for service items such as\nshipping.", + "heading": "Description" + } + ], + "signature": "getServiceSubtotal(): SumItem", + "source": "script-api", + "tags": [ + "getservicesubtotal", + "abstractitemctnr.getservicesubtotal" + ], + "title": "AbstractItemCtnr.getServiceSubtotal" + }, + { + "description": "Returns the sum-item representing the grandtotal for all items.", + "id": "script-api:dw/order/AbstractItemCtnr#grandTotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.grandTotal", + "sections": [ + { + "body": "Returns the sum-item representing the grandtotal for all items.", + "heading": "Description" + } + ], + "signature": "readonly grandTotal: SumItem", + "source": "script-api", + "tags": [ + "grandtotal", + "abstractitemctnr.grandtotal" + ], + "title": "AbstractItemCtnr.grandTotal" + }, + { + "description": "Returns the unsorted collection of items", + "id": "script-api:dw/order/AbstractItemCtnr#items", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.items", + "sections": [ + { + "body": "Returns the unsorted collection of items", + "heading": "Description" + } + ], + "signature": "readonly items: FilteringCollection", + "source": "script-api", + "tags": [ + "items", + "abstractitemctnr.items" + ], + "title": "AbstractItemCtnr.items" + }, + { + "description": "The last modification time.", + "id": "script-api:dw/order/AbstractItemCtnr#lastModified", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.lastModified", + "sections": [ + { + "body": "The last modification time.", + "heading": "Description" + } + ], + "signature": "readonly lastModified: Date", + "source": "script-api", + "tags": [ + "lastmodified", + "abstractitemctnr.lastmodified" + ], + "title": "AbstractItemCtnr.lastModified" + }, + { + "description": "Last modified by this user.", + "id": "script-api:dw/order/AbstractItemCtnr#modifiedBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.modifiedBy", + "sections": [ + { + "body": "Last modified by this user.", + "heading": "Description" + } + ], + "signature": "readonly modifiedBy: string", + "source": "script-api", + "tags": [ + "modifiedby", + "abstractitemctnr.modifiedby" + ], + "title": "AbstractItemCtnr.modifiedBy" + }, + { + "description": "Returns the dw.order.Order this object was created for.", + "id": "script-api:dw/order/AbstractItemCtnr#order", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.order", + "sections": [ + { + "body": "Returns the dw.order.Order this object was created for.", + "heading": "Description" + } + ], + "signature": "readonly order: Order", + "source": "script-api", + "tags": [ + "order", + "abstractitemctnr.order" + ], + "title": "AbstractItemCtnr.order" + }, + { + "description": "Returns the sum-item representing the subtotal for product items.", + "id": "script-api:dw/order/AbstractItemCtnr#productSubtotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.productSubtotal", + "sections": [ + { + "body": "Returns the sum-item representing the subtotal for product items.", + "heading": "Description" + } + ], + "signature": "readonly productSubtotal: SumItem", + "source": "script-api", + "tags": [ + "productsubtotal", + "abstractitemctnr.productsubtotal" + ], + "title": "AbstractItemCtnr.productSubtotal" + }, + { + "description": "Returns the sum-item representing the subtotal for service items such as shipping.", + "id": "script-api:dw/order/AbstractItemCtnr#serviceSubtotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AbstractItemCtnr", + "qualifiedName": "dw.order.AbstractItemCtnr.serviceSubtotal", + "sections": [ + { + "body": "Returns the sum-item representing the subtotal for service items such as\nshipping.", + "heading": "Description" + } + ], + "signature": "readonly serviceSubtotal: SumItem", + "source": "script-api", + "tags": [ + "servicesubtotal", + "abstractitemctnr.servicesubtotal" + ], + "title": "AbstractItemCtnr.serviceSubtotal" + }, + { + "description": "The Appeasement represents a shopper request for an order credit.", + "id": "script-api:dw/order/Appeasement", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Appeasement", + "sections": [ + { + "body": "The Appeasement represents a shopper request for an order credit.\n\nExample: The buyer finds any problem with the products but he agrees to preserve them, if he would be compensated,\nrather than return them.\n\nThe Appeasement contains 1..n appeasement items.\nEach appeasement item is associated with one dw.order.OrderItem usually representing an dw.order.Order\ndw.order.ProductLineItem.\n\nAn Appeasement can have one of these status values:\n\n- OPEN - the appeasement is open and appeasement items could be added to it\n- COMPLETED - the appeasement is complete and it is not allowed to add new items to it, this is a precondition\nfor refunding the customer for an appeasement.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "appeasement", + "dw.order.appeasement", + "dw/order" + ], + "title": "Appeasement" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "appeasement.orderby_itemid" + ], + "title": "Appeasement.ORDERBY_ITEMID" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "appeasement.orderby_itemid" + ], + "title": "Appeasement.ORDERBY_ITEMID" + }, + { + "description": "Sorting by the position of the related order item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related order item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "appeasement.orderby_itemposition" + ], + "title": "Appeasement.ORDERBY_ITEMPOSITION" + }, + { + "description": "Sorting by the position of the related order item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related order item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "appeasement.orderby_itemposition" + ], + "title": "Appeasement.ORDERBY_ITEMPOSITION" + }, + { + "description": "Unsorted, as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted, as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "appeasement.orderby_unsorted" + ], + "title": "Appeasement.ORDERBY_UNSORTED" + }, + { + "description": "Unsorted, as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Appeasement#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted, as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "appeasement.orderby_unsorted" + ], + "title": "Appeasement.ORDERBY_UNSORTED" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Appeasement#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "appeasement.qualifier_productitems" + ], + "title": "Appeasement.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Appeasement#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "appeasement.qualifier_productitems" + ], + "title": "Appeasement.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Appeasement#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "appeasement.qualifier_serviceitems" + ], + "title": "Appeasement.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Selects the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Appeasement#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "appeasement.qualifier_serviceitems" + ], + "title": "Appeasement.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Constant for Appeasement Status COMPLETED", + "id": "script-api:dw/order/Appeasement#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_COMPLETED", + "sections": [ + { + "body": "Constant for Appeasement Status COMPLETED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_COMPLETED: string", + "source": "script-api", + "tags": [ + "status_completed", + "appeasement.status_completed" + ], + "title": "Appeasement.STATUS_COMPLETED" + }, + { + "description": "Constant for Appeasement Status COMPLETED", + "id": "script-api:dw/order/Appeasement#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_COMPLETED", + "sections": [ + { + "body": "Constant for Appeasement Status COMPLETED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_COMPLETED: string", + "source": "script-api", + "tags": [ + "status_completed", + "appeasement.status_completed" + ], + "title": "Appeasement.STATUS_COMPLETED" + }, + { + "description": "Constant for Appeasement Status OPEN", + "id": "script-api:dw/order/Appeasement#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_OPEN", + "sections": [ + { + "body": "Constant for Appeasement Status OPEN", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_OPEN: string", + "source": "script-api", + "tags": [ + "status_open", + "appeasement.status_open" + ], + "title": "Appeasement.STATUS_OPEN" + }, + { + "description": "Constant for Appeasement Status OPEN", + "id": "script-api:dw/order/Appeasement#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.STATUS_OPEN", + "sections": [ + { + "body": "Constant for Appeasement Status OPEN", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_OPEN: string", + "source": "script-api", + "tags": [ + "status_open", + "appeasement.status_open" + ], + "title": "Appeasement.STATUS_OPEN" + }, + { + "description": "Creates appeasement items corresponding to certain order items and adds them to the appeasement.", + "id": "script-api:dw/order/Appeasement#addItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "totalAmount", + "type": "Money" + }, + { + "name": "orderItems", + "type": "List" + } + ], + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.addItems", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates appeasement items corresponding to certain order items and adds them to the appeasement.", + "heading": "Description" + } + ], + "signature": "addItems(totalAmount: Money, orderItems: List): void", + "source": "script-api", + "tags": [ + "additems", + "appeasement.additems" + ], + "title": "Appeasement.addItems" + }, + { + "description": "Returns the appeasement number.", + "id": "script-api:dw/order/Appeasement#appeasementNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.appeasementNumber", + "sections": [ + { + "body": "Returns the appeasement number.", + "heading": "Description" + } + ], + "signature": "readonly appeasementNumber: string", + "source": "script-api", + "tags": [ + "appeasementnumber", + "appeasement.appeasementnumber" + ], + "title": "Appeasement.appeasementNumber" + }, + { + "description": "Creates a new dw.order.Invoice based on this Appeasement. The appeasement-number will be used as the invoice-number.", + "id": "script-api:dw/order/Appeasement#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this Appeasement. The appeasement-number\nwill be used as the invoice-number.\n\nThe method must not be called more than once for an Appeasement,\nnor may 2 invoices exist with the same invoice-number.\n\nThe new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and\nshould be passed to the refund payment-hook in a separate database transaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "appeasement.createinvoice" + ], + "title": "Appeasement.createInvoice" + }, + { + "description": "Creates a new dw.order.Invoice based on this Appeasement. The invoice-number must be specified as an argument.", + "id": "script-api:dw/order/Appeasement#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this Appeasement. The\ninvoice-number must be specified as an argument.\n\nThe method must not be called more than once for an Appeasement,\nnor may 2 invoices exist with the same invoice-number.\n\nThe new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and\nshould be passed to the refund payment-hook in a separate database transaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(invoiceNumber: string): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "appeasement.createinvoice" + ], + "title": "Appeasement.createInvoice" + }, + { + "description": "Returns the appeasement number.", + "id": "script-api:dw/order/Appeasement#getAppeasementNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getAppeasementNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the appeasement number.", + "heading": "Description" + } + ], + "signature": "getAppeasementNumber(): string", + "source": "script-api", + "tags": [ + "getappeasementnumber", + "appeasement.getappeasementnumber" + ], + "title": "Appeasement.getAppeasementNumber" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/Appeasement#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getInvoice", + "returns": { + "type": "Invoice | null" + }, + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "getInvoice(): Invoice | null", + "source": "script-api", + "tags": [ + "getinvoice", + "appeasement.getinvoice" + ], + "title": "Appeasement.getInvoice" + }, + { + "description": "Returns `null` or the invoice-number.", + "id": "script-api:dw/order/Appeasement#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getInvoiceNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns `null` or the invoice-number.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string | null", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "appeasement.getinvoicenumber" + ], + "title": "Appeasement.getInvoiceNumber" + }, + { + "description": "Returns the reason code for the appeasement. The list of reason codes can be updated by updating meta-data for Appeasement.", + "id": "script-api:dw/order/Appeasement#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getReasonCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the reason code for the appeasement. The list of reason codes can be updated\nby updating meta-data for Appeasement.", + "heading": "Description" + } + ], + "signature": "getReasonCode(): EnumValue", + "source": "script-api", + "tags": [ + "getreasoncode", + "appeasement.getreasoncode" + ], + "title": "Appeasement.getReasonCode" + }, + { + "description": "Returns the reason note for the appeasement.", + "id": "script-api:dw/order/Appeasement#getReasonNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getReasonNote", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the reason note for the appeasement.", + "heading": "Description" + } + ], + "signature": "getReasonNote(): string | null", + "source": "script-api", + "tags": [ + "getreasonnote", + "appeasement.getreasonnote" + ], + "title": "Appeasement.getReasonNote" + }, + { + "description": "Gets the status of this appeasement.", + "id": "script-api:dw/order/Appeasement#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the status of this appeasement.\n\nThe possible values are STATUS_OPEN, STATUS_COMPLETED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "appeasement.getstatus" + ], + "title": "Appeasement.getStatus" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/Appeasement#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.invoice", + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "readonly invoice: Invoice | null", + "source": "script-api", + "tags": [ + "invoice", + "appeasement.invoice" + ], + "title": "Appeasement.invoice" + }, + { + "description": "Returns `null` or the invoice-number.", + "id": "script-api:dw/order/Appeasement#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.invoiceNumber", + "sections": [ + { + "body": "Returns `null` or the invoice-number.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string | null", + "source": "script-api", + "tags": [ + "invoicenumber", + "appeasement.invoicenumber" + ], + "title": "Appeasement.invoiceNumber" + }, + { + "description": "Returns the reason code for the appeasement. The list of reason codes can be updated by updating meta-data for Appeasement.", + "id": "script-api:dw/order/Appeasement#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.reasonCode", + "sections": [ + { + "body": "Returns the reason code for the appeasement. The list of reason codes can be updated\nby updating meta-data for Appeasement.", + "heading": "Description" + } + ], + "signature": "reasonCode: EnumValue", + "source": "script-api", + "tags": [ + "reasoncode", + "appeasement.reasoncode" + ], + "title": "Appeasement.reasonCode" + }, + { + "description": "Returns the reason note for the appeasement.", + "id": "script-api:dw/order/Appeasement#reasonNote", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.reasonNote", + "sections": [ + { + "body": "Returns the reason note for the appeasement.", + "heading": "Description" + } + ], + "signature": "reasonNote: string | null", + "source": "script-api", + "tags": [ + "reasonnote", + "appeasement.reasonnote" + ], + "title": "Appeasement.reasonNote" + }, + { + "description": "Set the reason code for the appeasement. The list of reason codes can be updated by updating meta-data for Appeasement.", + "id": "script-api:dw/order/Appeasement#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reasonCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setReasonCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the reason code for the appeasement. The list of reason codes can be updated\nby updating meta-data for Appeasement.", + "heading": "Description" + } + ], + "signature": "setReasonCode(reasonCode: string): void", + "source": "script-api", + "tags": [ + "setreasoncode", + "appeasement.setreasoncode" + ], + "title": "Appeasement.setReasonCode" + }, + { + "description": "Sets the reason note for the appeasement.", + "id": "script-api:dw/order/Appeasement#setReasonNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reasonNote", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setReasonNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the reason note for the appeasement.", + "heading": "Description" + } + ], + "signature": "setReasonNote(reasonNote: string): void", + "source": "script-api", + "tags": [ + "setreasonnote", + "appeasement.setreasonnote" + ], + "title": "Appeasement.setReasonNote" + }, + { + "description": "Sets the appeasement status.", + "id": "script-api:dw/order/Appeasement#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "appeasementStatus", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the appeasement status.\n\nThe possible values are STATUS_OPEN, STATUS_COMPLETED.\n\nWhen set to status COMPLETED, only the the custom attributes of its appeasement items can be changed.", + "heading": "Description" + } + ], + "signature": "setStatus(appeasementStatus: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "appeasement.setstatus" + ], + "title": "Appeasement.setStatus" + }, + { + "description": "Gets the status of this appeasement.", + "id": "script-api:dw/order/Appeasement#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Appeasement", + "qualifiedName": "dw.order.Appeasement.status", + "sections": [ + { + "body": "Gets the status of this appeasement.\n\nThe possible values are STATUS_OPEN, STATUS_COMPLETED.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "appeasement.status" + ], + "title": "Appeasement.status" + }, + { + "description": "Represents an item of an dw.order.Appeasement which is associated with one dw.order.OrderItem usually representing an dw.order.Order dw.order.ProductLineItem. Items are created using method dw.order.Appeasement.addItems", + "id": "script-api:dw/order/AppeasementItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.AppeasementItem", + "sections": [ + { + "body": "Represents an item of an dw.order.Appeasement which is associated with one dw.order.OrderItem usually representing an dw.order.Order\ndw.order.ProductLineItem. Items are created using method dw.order.Appeasement.addItems\n\nWhen the related Appeasement were set to status COMPLETED, only the the custom attributes of the appeasement item can be changed.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "appeasementitem", + "dw.order.appeasementitem", + "dw/order" + ], + "title": "AppeasementItem" + }, + { + "description": "Returns the number of the dw.order.Appeasement to which this item belongs.", + "id": "script-api:dw/order/AppeasementItem#appeasementNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.appeasementNumber", + "sections": [ + { + "body": "Returns the number of the dw.order.Appeasement to which this item belongs.", + "heading": "Description" + } + ], + "signature": "readonly appeasementNumber: string", + "source": "script-api", + "tags": [ + "appeasementnumber", + "appeasementitem.appeasementnumber" + ], + "title": "AppeasementItem.appeasementNumber" + }, + { + "description": "Returns the number of the dw.order.Appeasement to which this item belongs.", + "id": "script-api:dw/order/AppeasementItem#getAppeasementNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.getAppeasementNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the number of the dw.order.Appeasement to which this item belongs.", + "heading": "Description" + } + ], + "signature": "getAppeasementNumber(): string", + "source": "script-api", + "tags": [ + "getappeasementnumber", + "appeasementitem.getappeasementnumber" + ], + "title": "AppeasementItem.getAppeasementNumber" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/AppeasementItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.getParentItem", + "returns": { + "type": "AppeasementItem | null" + }, + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "getParentItem(): AppeasementItem | null", + "source": "script-api", + "tags": [ + "getparentitem", + "appeasementitem.getparentitem" + ], + "title": "AppeasementItem.getParentItem" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/AppeasementItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.parentItem", + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "parentItem: AppeasementItem | null", + "source": "script-api", + "tags": [ + "parentitem", + "appeasementitem.parentitem" + ], + "title": "AppeasementItem.parentItem" + }, + { + "description": "Set a parent item. The parent item must belong to the same dw.order.Appeasement. An infinite parent-child loop is disallowed as is a parent-child depth greater than 10. Setting a parent item indicates a dependency of the child item on the parent item, and can be used to form a parallel structure to that accessed using dw.order.ProductLineItem.getParent.", + "id": "script-api:dw/order/AppeasementItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "parentItem", + "type": "AppeasementItem" + } + ], + "parentId": "script-api:dw/order/AppeasementItem", + "qualifiedName": "dw.order.AppeasementItem.setParentItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a parent item. The parent item must belong to the same\ndw.order.Appeasement. An infinite parent-child loop is disallowed\nas is a parent-child depth greater than 10. Setting a parent item\nindicates a dependency of the child item on the parent item, and can be\nused to form a parallel structure to that accessed using\ndw.order.ProductLineItem.getParent.", + "heading": "Description" + } + ], + "signature": "setParentItem(parentItem: AppeasementItem): void", + "source": "script-api", + "tags": [ + "setparentitem", + "appeasementitem.setparentitem" + ], + "title": "AppeasementItem.setParentItem" + }, + { + "description": "The Basket class represents a shopping cart.", + "id": "script-api:dw/order/Basket", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Basket", + "sections": [ + { + "body": "The Basket class represents a shopping cart.", + "heading": "Description" + }, + { + "body": "Extends `LineItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "basket", + "dw.order.basket", + "dw/order" + ], + "title": "Basket" + }, + { + "description": "Returns if the basket was created by an agent.", + "id": "script-api:dw/order/Basket#agentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.agentBasket", + "sections": [ + { + "body": "Returns if the basket was created by an agent.\n\nAn agent basket is created by an agent on behalf of the customer in comparison to a storefront basket which is\ncreated by the customer e.g. in the storefront. An agent basket can be created with\nBasketMgr.createAgentBasket.", + "heading": "Description" + } + ], + "signature": "readonly agentBasket: boolean", + "source": "script-api", + "tags": [ + "agentbasket", + "basket.agentbasket" + ], + "title": "Basket.agentBasket" + }, + { + "description": "Returns the timestamp when the inventory for this basket expires.", + "id": "script-api:dw/order/Basket#getInventoryReservationExpiry", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getInventoryReservationExpiry", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Returns the timestamp when the inventory for this basket expires.\n\nIt will return `null` for the following reasons:\n\n- No reservation for the basket was done\n- Reservation is outdated meaning the timestamp is in the past\n\nPlease note that the expiry timestamp will not always be valid for the whole basket. It will not be valid for\nnew items added or items whose quantity has changed after the reservation was done.", + "heading": "Description" + } + ], + "signature": "getInventoryReservationExpiry(): Date | null", + "source": "script-api", + "tags": [ + "getinventoryreservationexpiry", + "basket.getinventoryreservationexpiry" + ], + "title": "Basket.getInventoryReservationExpiry" + }, + { + "description": "Returns the order that this basket represents if the basket is being used to edit an order, otherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference to the order that was used to create this basket (please check limitations around basket accessibility in dw.order.BasketMgr.createBasketFromOrder).", + "id": "script-api:dw/order/Basket#getOrderBeingEdited", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getOrderBeingEdited", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the order that this basket represents if the basket is being used to edit an order, otherwise this method\nreturns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference\nto the order that was used to create this basket (please check limitations around basket accessibility in\ndw.order.BasketMgr.createBasketFromOrder).", + "heading": "Description" + } + ], + "signature": "getOrderBeingEdited(): Order", + "source": "script-api", + "tags": [ + "getorderbeingedited", + "basket.getorderbeingedited" + ], + "title": "Basket.getOrderBeingEdited" + }, + { + "description": "Returns the number of the order that this basket represents if the basket is being used to edit an order, otherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference to the order that was used to create this basket (please check limitations around basket accessibility in dw.order.BasketMgr.createBasketFromOrder).", + "id": "script-api:dw/order/Basket#getOrderNoBeingEdited", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.getOrderNoBeingEdited", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the number of the order that this basket represents if the basket is being used to edit an order,\notherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder\nwill create a reference to the order that was used to create this basket (please check limitations around basket\naccessibility in dw.order.BasketMgr.createBasketFromOrder).", + "heading": "Description" + } + ], + "signature": "getOrderNoBeingEdited(): string", + "source": "script-api", + "tags": [ + "getordernobeingedited", + "basket.getordernobeingedited" + ], + "title": "Basket.getOrderNoBeingEdited" + }, + { + "description": "Returns the timestamp when the inventory for this basket expires.", + "id": "script-api:dw/order/Basket#inventoryReservationExpiry", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.inventoryReservationExpiry", + "sections": [ + { + "body": "Returns the timestamp when the inventory for this basket expires.\n\nIt will return `null` for the following reasons:\n\n- No reservation for the basket was done\n- Reservation is outdated meaning the timestamp is in the past\n\nPlease note that the expiry timestamp will not always be valid for the whole basket. It will not be valid for\nnew items added or items whose quantity has changed after the reservation was done.", + "heading": "Description" + } + ], + "signature": "readonly inventoryReservationExpiry: Date | null", + "source": "script-api", + "tags": [ + "inventoryreservationexpiry", + "basket.inventoryreservationexpiry" + ], + "title": "Basket.inventoryReservationExpiry" + }, + { + "description": "Returns if the basket was created by an agent.", + "id": "script-api:dw/order/Basket#isAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isAgentBasket", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns if the basket was created by an agent.\n\nAn agent basket is created by an agent on behalf of the customer in comparison to a storefront basket which is\ncreated by the customer e.g. in the storefront. An agent basket can be created with\nBasketMgr.createAgentBasket.", + "heading": "Description" + } + ], + "signature": "isAgentBasket(): boolean", + "source": "script-api", + "tags": [ + "isagentbasket", + "basket.isagentbasket" + ], + "title": "Basket.isAgentBasket" + }, + { + "description": "Use this method to check if the Basket was calculated with grouped taxation calculation.", + "id": "script-api:dw/order/Basket#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isTaxRoundedAtGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Use this method to check if the Basket was calculated with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "isTaxRoundedAtGroup(): boolean", + "source": "script-api", + "tags": [ + "istaxroundedatgroup", + "basket.istaxroundedatgroup" + ], + "title": "Basket.isTaxRoundedAtGroup" + }, + { + "description": "Returns if the basket is temporary.", + "id": "script-api:dw/order/Basket#isTemporary", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.isTemporary", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns if the basket is temporary.\n\nTemporary baskets are separate from shopper storefront and agent baskets, and are intended for use to perform\ncalculations or create an order without disturbing a shopper's open storefront basket. A temporary basket can be\ncreated with BasketMgr.createTemporaryBasket.", + "heading": "Description" + } + ], + "signature": "isTemporary(): boolean", + "source": "script-api", + "tags": [ + "istemporary", + "basket.istemporary" + ], + "title": "Basket.isTemporary" + }, + { + "description": "Returns the order that this basket represents if the basket is being used to edit an order, otherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference to the order that was used to create this basket (please check limitations around basket accessibility in dw.order.BasketMgr.createBasketFromOrder).", + "id": "script-api:dw/order/Basket#orderBeingEdited", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.orderBeingEdited", + "sections": [ + { + "body": "Returns the order that this basket represents if the basket is being used to edit an order, otherwise this method\nreturns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference\nto the order that was used to create this basket (please check limitations around basket accessibility in\ndw.order.BasketMgr.createBasketFromOrder).", + "heading": "Description" + } + ], + "signature": "readonly orderBeingEdited: Order", + "source": "script-api", + "tags": [ + "orderbeingedited", + "basket.orderbeingedited" + ], + "title": "Basket.orderBeingEdited" + }, + { + "description": "Returns the number of the order that this basket represents if the basket is being used to edit an order, otherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder will create a reference to the order that was used to create this basket (please check limitations around basket accessibility in dw.order.BasketMgr.createBasketFromOrder).", + "id": "script-api:dw/order/Basket#orderNoBeingEdited", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.orderNoBeingEdited", + "sections": [ + { + "body": "Returns the number of the order that this basket represents if the basket is being used to edit an order,\notherwise this method returns null. Baskets created via dw.order.BasketMgr.createBasketFromOrder\nwill create a reference to the order that was used to create this basket (please check limitations around basket\naccessibility in dw.order.BasketMgr.createBasketFromOrder).", + "heading": "Description" + } + ], + "signature": "readonly orderNoBeingEdited: string", + "source": "script-api", + "tags": [ + "ordernobeingedited", + "basket.ordernobeingedited" + ], + "title": "Basket.orderNoBeingEdited" + }, + { + "description": "Release all inventory previously reserved for this basket. This is not needed for a normal workflow. You can call `dw.order.Basket.reserveInventory()` one time after every basket change. For performance and scaling reasons, avoid calling `dw.order.Basket.releaseInventory()` before `dw.order.Basket.reserveInventory()`. The `reserveInventory` function works in an optimized way to release inventory reservations that are no longer relevant.", + "id": "script-api:dw/order/Basket#releaseInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.releaseInventory", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Release all inventory previously reserved for this basket. This is not needed for a normal workflow.\nYou can call `dw.order.Basket.reserveInventory()` one time after every basket change.\nFor performance and scaling reasons, avoid calling `dw.order.Basket.releaseInventory()`\nbefore `dw.order.Basket.reserveInventory()`. The `reserveInventory` function works in\nan optimized way to release inventory reservations that are no longer relevant.\n\nThe method implements its own transaction handling. Calling the method from inside a transaction is disallowed\nand results in an exception being thrown. This behavior differs when calling the method from an OCAPI\nhook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction\nhandling, but to ensure the shortest possible locking of the inventory this method should only be called as\nthe last step in the OCAPI hook.", + "heading": "Description" + } + ], + "signature": "releaseInventory(): Status", + "source": "script-api", + "tags": [ + "releaseinventory", + "basket.releaseinventory" + ], + "title": "Basket.releaseInventory" + }, + { + "description": "Reserves inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced.", + "examples": [ + "transaction.begin()\nbasket.createProductLineItem(\"sku1\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2} is complete.", + "transaction.begin()\nbasket.createProductLineItem(\"sku2\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten.", + "transaction.begin()\nbasket.removeProductLineItem(item1)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku2:2} is complete. The previous reservation was\n// overwritten and a quantity of 2 is released for sku1." + ], + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Reserves inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of\nthis method are replaced.\n\nSample workflow for subsequent basket reservations:\n\n1. Request: Add item to basket and reserve the basket.\n\n\n2. Request: Add item to basket.\n\n\n3. Request: Remove item from basket.\n\n\nThe method can be used to reserve basket items before checkout to ensure that inventory is still available at the\ntime an order is created from the basket using dw.order.OrderMgr.createOrder. If all or some\nbasket items are not reserved before creating an order, dw.order.OrderMgr.createOrder will\nvalidate item availability and will fail if any item is unavailable. Calling this method in the same request as\ndw.order.OrderMgr.createOrder is unnecessary and discouraged for performance reasons.\n\nThe maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See\ndw.catalog.ProductInventoryRecord.getATS.)\n\nWhen using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the\nbasket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5\nand no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only\nreserve a quantity of 2.\n\nWhen using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to\nan order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other\nbaskets would see an ATS of 2.\n\nReservations can only be made for products with an inventory record. The reservation of product bundles is\ncontrolled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to\nbe reserved for just the bundle or for the bundle and its bundled products.\n\nThe following conditions must be met for the method to succeed:\n\n- an inventory list must be assigned to the current site\n- all products in the basket must exist, and must not be of type Master or ProductSet\n- each product line item must have a valid quantity\n- each product must have an inventory record, or the inventory list must define that products without inventory\nrecord are available by default\n- the reservation must succeed for each item as described above.\n\nThe method implements its own transaction handling. Calling the method from inside a transaction is disallowed\nand results in an exception being thrown. This behavior differs when calling the method from an OCAPI\nhook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction\nhandling, but to ensure the shortest possible locking of the inventory this method should only be called as\nthe last step in the OCAPI hook.\n\nIf the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged\nbut no new reservations will be made. This might lead to a partially reserved basket.\n\nBehaves same as `reserveInventory( null, false );`.\n\nThis method must not be used with\n\n- the CreateOrder2 pipelet, or\n- dw.order.OrderMgr.createOrder, or\n- dw.order.OrderMgr.createOrder\n\nin the same request.", + "heading": "Description" + } + ], + "signature": "reserveInventory(): Status", + "source": "script-api", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "description": "Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced.", + "examples": [ + "transaction.begin()\nbasket.createProductLineItem(\"sku1\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2} is complete.", + "transaction.begin()\nbasket.createProductLineItem(\"sku2\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten.", + "transaction.begin()\nbasket.removeProductLineItem(item1)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku2:2} is complete. The previous reservation was\n// overwritten and a quantity of 2 is released for sku1." + ], + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reservationDurationInMinutes", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of\nthis method are replaced.\n\nSample workflow for subsequent basket reservations:\n\n1. Request: Add item to basket and reserve the basket.\n\n\n2. Request: Add item to basket.\n\n\n3. Request: Remove item from basket.\n\n\nThe method can be used to reserve basket items before checkout to ensure that inventory is still available at the\ntime an order is created from the basket using dw.order.OrderMgr.createOrder. If all or some\nbasket items are not reserved before creating an order, dw.order.OrderMgr.createOrder will\nvalidate item availability and will fail if any item is unavailable. Calling this method in the same request as\ndw.order.OrderMgr.createOrder is unnecessary and discouraged for performance reasons.\n\nThe maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See\ndw.catalog.ProductInventoryRecord.getATS.)\n\nWhen using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the\nbasket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5\nand no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only\nreserve a quantity of 2.\n\nWhen using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to\nan order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other\nbaskets would see an ATS of 2.\n\nReservations can only be made for products with an inventory record. The reservation of product bundles is\ncontrolled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to\nbe reserved for just the bundle or for the bundle and its bundled products.\n\nThe following conditions must be met for the method to succeed:\n\n- an inventory list must be assigned to the current site\n- all products in the basket must exist, and must not be of type Master or ProductSet\n- each product line item must have a valid quantity\n- each product must have an inventory record, or the inventory list must define that products without inventory\nrecord are available by default\n- the reservation must succeed for each item as described above.\n\nThe method implements its own transaction handling. Calling the method from inside a transaction is disallowed\nand results in an exception being thrown. This behavior differs when calling the method from an OCAPI\nhook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction\nhandling, but to ensure the shortest possible locking of the inventory this method should only be called as\nthe last step in the OCAPI hook.\n\ngetInventoryReservationExpiry can be used to determine when the expiration will expire.\n\nIf the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged\nbut no new reservations will be made. This might lead to a partially reserved basket.\n\nBehaves same as `reserveInventory( reservationDurationInMinutes, false );`.\n\nThis method must not be used with\n\n- the CreateOrder2 pipelet, or\n- dw.order.OrderMgr.createOrder, or\n- dw.order.OrderMgr.createOrder\n\nin the same request.", + "heading": "Description" + } + ], + "signature": "reserveInventory(reservationDurationInMinutes: number): Status", + "source": "script-api", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "description": "Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced.", + "examples": [ + "transaction.begin()\nbasket.createProductLineItem(\"sku1\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2} is complete", + "transaction.begin()\nbasket.createProductLineItem(\"sku2\",2,basket.defaultShipment)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten.", + "transaction.begin()\nbasket.removeProductLineItem(item1)\nbasket.commit()\nbasket.reserveInventory()\n// The reservation {sku2:2} is complete. The previous reservation was\n// overwritten and a quantity of 2 is released for sku1." + ], + "id": "script-api:dw/order/Basket#reserveInventory", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reservationDurationInMinutes", + "type": "number" + }, + { + "name": "removeIfNotAvailable", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.reserveInventory", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of\nthis method are replaced.\n\nSample workflow for subsequent basket reservations:\n\n1. Request: Add item to basket and reserve the basket.\n\n\n2. Request: Add item to basket.\n\n\n3. Request: Remove item from basket.\n\n\nThe method can be used to reserve basket items before checkout to ensure that inventory is still available at the\ntime an order is created from the basket using dw.order.OrderMgr.createOrder. If all or some\nbasket items are not reserved before creating an order, dw.order.OrderMgr.createOrder will\nvalidate item availability and will fail if any item is unavailable. Calling this method in the same request as\ndw.order.OrderMgr.createOrder is unnecessary and discouraged for performance reasons.\n\nThe maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See\ndw.catalog.ProductInventoryRecord.getATS.)\n\nWhen using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the\nbasket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5\nand no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only\nreserve a quantity of 2.\n\nWhen using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to\nan order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other\nbaskets would see an ATS of 2.\n\nReservations can only be made for products with an inventory record. The reservation of product bundles is\ncontrolled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to\nbe reserved for just the bundle or for the bundle and its bundled products.\n\nThe following conditions must be met for the method to succeed:\n\n- an inventory list must be assigned to the current site\n- all products in the basket must exist, and must not be of type Master or ProductSet\n- each product line item must have a valid quantity\n- each product must have an inventory record, or the inventory list must define that products without inventory\nrecord are available by default\n- the reservation must succeed for each item as described above or `removeIfNotAvailable` is set to\n`true`\n\nThe method implements its own transaction handling. Calling the method from inside a transaction is disallowed\nand results in an exception being thrown. This behavior differs when calling the method from an OCAPI\nhook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction\nhandling, but to ensure the shortest possible locking of the inventory this method should only be called as\nthe last step in the OCAPI hook.\n\ngetInventoryReservationExpiry can be used to determine when the expiration will expire.\n\nIf the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged\nbut no new reservations will be made. This might lead to a partially reserved basket.\n\nIf the reservation succeeds with an OK status and `removeIfNotAvailable` is `true`, basket\nline items quantities might have been changed or line items might have been removed. The returned\ndw.system.Status object will contain information about the changes. Possible values for\ndw.system.StatusItem.getCode are:\n\n- BUNDLE_REMOVED - a bundle item was removed completely\n- ITEM_REMOVED - a product line item was removed completely\n- ITEM_QUANTITY_REDUCED - the quantity of a line item was reduced\n\ndw.system.StatusItem.getDetails will contain for each item the sku and uuid of the item\nwhich was changed/removed.\n\nThis method must not be used with\n\n- the CreateOrder2 pipelet, or\n- dw.order.OrderMgr.createOrder, or\n- dw.order.OrderMgr.createOrder\n\nin the same request.", + "heading": "Description" + } + ], + "signature": "reserveInventory(reservationDurationInMinutes: number, removeIfNotAvailable: boolean): Status", + "source": "script-api", + "tags": [ + "reserveinventory", + "basket.reserveinventory" + ], + "title": "Basket.reserveInventory" + }, + { + "description": "Set the type of the business this order has been placed in.", + "id": "script-api:dw/order/Basket#setBusinessType", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aType", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setBusinessType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the type of the business this order has been placed in.\n\nPossible values are dw.order.LineItemCtnr.BUSINESS_TYPE_B2C or dw.order.LineItemCtnr.BUSINESS_TYPE_B2B.", + "heading": "Description" + } + ], + "signature": "setBusinessType(aType: number): void", + "source": "script-api", + "tags": [ + "setbusinesstype", + "basket.setbusinesstype" + ], + "title": "Basket.setBusinessType" + }, + { + "description": "Set the channel type in which sales channel this order has been created. This can be used to distinguish order placed through e.g. Storefront, Call Center or Marketplace.", + "id": "script-api:dw/order/Basket#setChannelType", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aType", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setChannelType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the channel type in which sales channel this order has been created. This can be used to distinguish order\nplaced through e.g. Storefront, Call Center or Marketplace.\n\nPossible values are dw.order.LineItemCtnr.CHANNEL_TYPE_STOREFRONT,\ndw.order.LineItemCtnr.CHANNEL_TYPE_CALLCENTER, dw.order.LineItemCtnr.CHANNEL_TYPE_MARKETPLACE,\ndw.order.LineItemCtnr.CHANNEL_TYPE_DSS, dw.order.LineItemCtnr.CHANNEL_TYPE_STORE,\ndw.order.LineItemCtnr.CHANNEL_TYPE_PINTEREST, dw.order.LineItemCtnr.CHANNEL_TYPE_TWITTER,\ndw.order.LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS, dw.order.LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS,\ndw.order.LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION,\ndw.order.LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE, dw.order.LineItemCtnr.CHANNEL_TYPE_GOOGLE,\ndw.order.LineItemCtnr.CHANNEL_TYPE_YOUTUBE, dw.order.LineItemCtnr.CHANNEL_TYPE_TIKTOK,\ndw.order.LineItemCtnr.CHANNEL_TYPE_SNAPCHAT, dw.order.LineItemCtnr.CHANNEL_TYPE_WHATSAPP The\nvalue for dw.order.LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER and\ndw.order.LineItemCtnr.CHANNEL_TYPE_CHATGPT and dw.order.LineItemCtnr.CHANNEL_TYPE_GEMINI are also\navailable, but it can not be set by the scripting API, it is set only internally.", + "heading": "Description" + } + ], + "signature": "setChannelType(aType: number): void", + "source": "script-api", + "tags": [ + "setchanneltype", + "basket.setchanneltype" + ], + "title": "Basket.setChannelType" + }, + { + "deprecated": { + "message": "The method has been deprecated. Please use dw.order.Order.setCustomer\ninstead for registered customer. For guest customer the customerNo is usually generated during order\ncreation and the attribute is set at order level." + }, + "description": "Sets the customer number of the customer associated with this container.", + "id": "script-api:dw/order/Basket#setCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customerNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.setCustomerNo", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer number of the customer associated with this container.\n\nNote this method has little effect as it only sets the customer number and it does not re-link the basket with\na customer profile object, nor is the number copied into the dw.order.Order should one be created from\nthe basket. Use dw.order.Order.setCustomer instead for a registered customer. For a\nguest customer the customerNo is usually generated during order creation and the attribute is set at order level.", + "heading": "Description" + } + ], + "signature": "setCustomerNo(customerNo: string): void", + "source": "script-api", + "tags": [ + "setcustomerno", + "basket.setcustomerno" + ], + "title": "Basket.setCustomerNo" + }, + { + "description": "Register a \"start checkout\" event for the current basket. This event is tracked for AB test statistics but otherwise has no effect on the basket. The system will register at most one checkout per basket per session.", + "id": "script-api:dw/order/Basket#startCheckout", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.startCheckout", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Register a \"start checkout\" event for the current basket. This event is tracked for AB test statistics\nbut otherwise has no effect on the basket. The system will register at most one checkout per basket per session.", + "heading": "Description" + } + ], + "signature": "startCheckout(): void", + "source": "script-api", + "tags": [ + "startcheckout", + "basket.startcheckout" + ], + "title": "Basket.startCheckout" + }, + { + "description": "Use this method to check if the Basket was calculated with grouped taxation calculation.", + "id": "script-api:dw/order/Basket#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.taxRoundedAtGroup", + "sections": [ + { + "body": "Use this method to check if the Basket was calculated with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "readonly taxRoundedAtGroup: boolean", + "source": "script-api", + "tags": [ + "taxroundedatgroup", + "basket.taxroundedatgroup" + ], + "title": "Basket.taxRoundedAtGroup" + }, + { + "description": "Returns if the basket is temporary.", + "id": "script-api:dw/order/Basket#temporary", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.temporary", + "sections": [ + { + "body": "Returns if the basket is temporary.\n\nTemporary baskets are separate from shopper storefront and agent baskets, and are intended for use to perform\ncalculations or create an order without disturbing a shopper's open storefront basket. A temporary basket can be\ncreated with BasketMgr.createTemporaryBasket.", + "heading": "Description" + } + ], + "signature": "readonly temporary: boolean", + "source": "script-api", + "tags": [ + "temporary", + "basket.temporary" + ], + "title": "Basket.temporary" + }, + { + "description": "Updates the basket currency if different to session currency, otherwise does nothing.", + "id": "script-api:dw/order/Basket#updateCurrency", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Basket", + "qualifiedName": "dw.order.Basket.updateCurrency", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the basket currency if different to session currency, otherwise does nothing.\n\nUse dw.system.Session.setCurrency to set the currency for the session. To reflect the session\ncurrency change to the basket you need to update the basket with this method. This ensures that any upcoming\nbasket recalculation, which is based on the session currency, matches the basket currency.", + "heading": "Description" + } + ], + "signature": "updateCurrency(): void", + "source": "script-api", + "tags": [ + "updatecurrency", + "basket.updatecurrency" + ], + "title": "Basket.updateCurrency" + }, + { + "description": "Provides static helper methods for managing baskets.", + "id": "script-api:dw/order/BasketMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.BasketMgr", + "sections": [ + { + "body": "Provides static helper methods for managing baskets.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "basketmgr", + "dw.order.basketmgr", + "dw/order" + ], + "title": "BasketMgr" + }, + { + "description": "Retrieve all open baskets for the logged in customer including the temporary baskets.", + "id": "script-api:dw/order/BasketMgr#baskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.baskets", + "sections": [ + { + "body": "Retrieve all open baskets for the logged in customer including the temporary baskets.\n\nRestricted to agent scenario use cases: The returned list contains all agent baskets created with\ncreateAgentBasket and the current storefront basket which can also be retrieved with\ngetCurrentBasket. This method will result in an exception if called by a user without permission\nCreate_Order_On_Behalf_Of or if no customer is logged in the session.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static readonly baskets: List", + "source": "script-api", + "tags": [ + "baskets", + "basketmgr.baskets" + ], + "title": "BasketMgr.baskets" + }, + { + "description": "Retrieve all open baskets for the logged in customer including the temporary baskets.", + "id": "script-api:dw/order/BasketMgr#baskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.baskets", + "sections": [ + { + "body": "Retrieve all open baskets for the logged in customer including the temporary baskets.\n\nRestricted to agent scenario use cases: The returned list contains all agent baskets created with\ncreateAgentBasket and the current storefront basket which can also be retrieved with\ngetCurrentBasket. This method will result in an exception if called by a user without permission\nCreate_Order_On_Behalf_Of or if no customer is logged in the session.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static readonly baskets: List", + "source": "script-api", + "tags": [ + "baskets", + "basketmgr.baskets" + ], + "title": "BasketMgr.baskets" + }, + { + "description": "Creates a new agent basket for the current session customer.", + "id": "script-api:dw/order/BasketMgr#createAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createAgentBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a new agent basket for the current session customer.\n\nBy default only 4 open agent baskets are allowed per customer. If this is exceeded a\nCreateAgentBasketLimitExceededException will be thrown.\n\nThis method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no\ncustomer is logged in the session.", + "heading": "Description" + } + ], + "signature": "static createAgentBasket(): Basket", + "source": "script-api", + "tags": [ + "createagentbasket", + "basketmgr.createagentbasket" + ], + "throws": [ + { + "description": "indicates that no agent basket could be created because the agent basket limit is already exceeded", + "type": "CreateAgentBasketLimitExceededException" + } + ], + "title": "BasketMgr.createAgentBasket" + }, + { + "description": "Creates a new agent basket for the current session customer.", + "id": "script-api:dw/order/BasketMgr#createAgentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createAgentBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a new agent basket for the current session customer.\n\nBy default only 4 open agent baskets are allowed per customer. If this is exceeded a\nCreateAgentBasketLimitExceededException will be thrown.\n\nThis method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no\ncustomer is logged in the session.", + "heading": "Description" + } + ], + "signature": "static createAgentBasket(): Basket", + "source": "script-api", + "tags": [ + "createagentbasket", + "basketmgr.createagentbasket" + ], + "throws": [ + { + "description": "indicates that no agent basket could be created because the agent basket limit is already exceeded", + "type": "CreateAgentBasketLimitExceededException" + } + ], + "title": "BasketMgr.createAgentBasket" + }, + { + "description": "Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created from the Basket, the original Order is changed to status dw.order.Order.ORDER_STATUS_REPLACED. Restricted to agent scenario use cases.", + "id": "script-api:dw/order/BasketMgr#createBasketFromOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createBasketFromOrder", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created\nfrom the Basket, the original Order is changed to status dw.order.Order.ORDER_STATUS_REPLACED. Restricted\nto agent scenario use cases.\n\nIn case a storefront customer is using it the created storefront basket cannot be retrieved via\n\n- getCurrentBasket (ScriptAPI),\n- GET /baskets/ (REST APIs) or\n- DELETE /baskets/ (REST APIs) or\n- GetBasket (Pipelet) or\n- Basket-related CSC Operations from BM (these also use OCAPI REST API).\n\nBaskets containing an \"orderNumberBeingEdited\" are explicitly excluded from the list of baskets that can be\nretrieved. Responsible for this behavior (this kind of basket cannot be used as general purpose shopping baskets)\n- see dw.order.Basket.getOrderNoBeingEdited / dw.order.Basket.getOrderBeingEdited.\n\nIn case a Business Manager user is logged in into the session the basket will be marked as an agent basket. See\ndw.order.Basket.isAgentBasket.\n\nAny inventory reservation associated with the order will be canceled either early when\ndw.order.Basket.reserveInventory is called for the new basket or (later) when a new replacement order\nis created from the basket. Consider reserving the basket following its creation.\n\nThe method only succeeds for an Order\n\n- without gift certificates,\n- status is not cancelled,\n- was not previously replaced and\n- was not previously exported.\n\nFailures are indicated by throwing an APIException of type CreateBasketFromOrderException which provides one of\nthese errorCodes:\n\n- Code dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC - the Order contains a gift certificate and\ncannot be replaced.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED - the Order was already replaced.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED - the Order was cancelled.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED - the Order has already been\nexported.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createBasketFromOrder(order: Order): Basket", + "source": "script-api", + "tags": [ + "createbasketfromorder", + "basketmgr.createbasketfromorder" + ], + "throws": [ + { + "description": "indicates the Order is in an invalid state.", + "type": "dw.order.CreateBasketFromOrderException" + } + ], + "title": "BasketMgr.createBasketFromOrder" + }, + { + "description": "Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created from the Basket, the original Order is changed to status dw.order.Order.ORDER_STATUS_REPLACED. Restricted to agent scenario use cases.", + "id": "script-api:dw/order/BasketMgr#createBasketFromOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createBasketFromOrder", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created\nfrom the Basket, the original Order is changed to status dw.order.Order.ORDER_STATUS_REPLACED. Restricted\nto agent scenario use cases.\n\nIn case a storefront customer is using it the created storefront basket cannot be retrieved via\n\n- getCurrentBasket (ScriptAPI),\n- GET /baskets/ (REST APIs) or\n- DELETE /baskets/ (REST APIs) or\n- GetBasket (Pipelet) or\n- Basket-related CSC Operations from BM (these also use OCAPI REST API).\n\nBaskets containing an \"orderNumberBeingEdited\" are explicitly excluded from the list of baskets that can be\nretrieved. Responsible for this behavior (this kind of basket cannot be used as general purpose shopping baskets)\n- see dw.order.Basket.getOrderNoBeingEdited / dw.order.Basket.getOrderBeingEdited.\n\nIn case a Business Manager user is logged in into the session the basket will be marked as an agent basket. See\ndw.order.Basket.isAgentBasket.\n\nAny inventory reservation associated with the order will be canceled either early when\ndw.order.Basket.reserveInventory is called for the new basket or (later) when a new replacement order\nis created from the basket. Consider reserving the basket following its creation.\n\nThe method only succeeds for an Order\n\n- without gift certificates,\n- status is not cancelled,\n- was not previously replaced and\n- was not previously exported.\n\nFailures are indicated by throwing an APIException of type CreateBasketFromOrderException which provides one of\nthese errorCodes:\n\n- Code dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC - the Order contains a gift certificate and\ncannot be replaced.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED - the Order was already replaced.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED - the Order was cancelled.\n- Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED - the Order has already been\nexported.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createBasketFromOrder(order: Order): Basket", + "source": "script-api", + "tags": [ + "createbasketfromorder", + "basketmgr.createbasketfromorder" + ], + "throws": [ + { + "description": "indicates the Order is in an invalid state.", + "type": "dw.order.CreateBasketFromOrderException" + } + ], + "title": "BasketMgr.createBasketFromOrder" + }, + { + "description": "Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper storefront and agent baskets, and are intended for use to perform calculations or create an order without disturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration of 15 minutes.", + "id": "script-api:dw/order/BasketMgr#createTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createTemporaryBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper\nstorefront and agent baskets, and are intended for use to perform calculations or create an order without\ndisturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration\nof 15 minutes.\n\nBy default only 4 open temporary baskets are allowed per customer. If this is exceeded a\nCreateTemporaryBasketLimitExceededException will be thrown.", + "heading": "Description" + } + ], + "signature": "static createTemporaryBasket(): Basket", + "source": "script-api", + "tags": [ + "createtemporarybasket", + "basketmgr.createtemporarybasket" + ], + "title": "BasketMgr.createTemporaryBasket" + }, + { + "description": "Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper storefront and agent baskets, and are intended for use to perform calculations or create an order without disturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration of 15 minutes.", + "id": "script-api:dw/order/BasketMgr#createTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.createTemporaryBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper\nstorefront and agent baskets, and are intended for use to perform calculations or create an order without\ndisturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration\nof 15 minutes.\n\nBy default only 4 open temporary baskets are allowed per customer. If this is exceeded a\nCreateTemporaryBasketLimitExceededException will be thrown.", + "heading": "Description" + } + ], + "signature": "static createTemporaryBasket(): Basket", + "source": "script-api", + "tags": [ + "createtemporarybasket", + "basketmgr.createtemporarybasket" + ], + "title": "BasketMgr.createTemporaryBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or `null` if no current valid basket exists.", + "examples": [ + "var basket : Basket = BasketMgr.getCurrentBasket();\nif (basket) {\n// do something with basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#currentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentBasket", + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or `null` if no current valid\nbasket exists.\n\nThe methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket\npersistence, which can be configured in the Business Manager site preferences / baskets section. A basket is\nvalid for the configured basket lifetime.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or\n`GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation\nin any scenario.\n\nThe current basket, if one exists, is usually updated by the method. In particular the last-modified date is\nupdated. No update is done when method getCurrentBasket is used within a read-only hook\nimplementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended\nin 2 ways:\n\n- The basket is modified in some way, e.g. a product is added resulting in the basket total being newly\ncalculated. This results in the basket lifetime being reset.\n- The basket has not been modified for 60 minutes, then using this method to access the basket will also reset\nthe basket lifetime.\n\nWhat happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and\npayment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs\nto a different customer this data is removed. This happens when a guest customer that has a basket logs in and\nhence identifies as a registered customer. In this case the basket which was previously created by the guest\ncustomer gets transferred to the (now logged in) registered customer. Should the registered customer already have\na basket, this basket is effectively invalidated, but made available using getStoredBasket allowing\nthe script to merge content from it if desired.\n\nWhat happens when a customer logs out or when the customer session times out? After the customer logs out, a\nbasket belonging to the registered customer (now logged out) is stored (where applicable) and this method\nreturns `null`. Personal data is also cleared when the session times out for a guest customer.\n\nThe following personal data is cleared:\n\n- product line items that were added from a wish list\n- shipping method\n- coupon line items\n- gift certificate line items\n- billing and shipping addresses\n- payment instruments\n- buyer email\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.\n\nTypical usage:\n\n\nConstraints:\n\n- The method only accesses the basket for the session customer, an exception is thrown when the session\ncustomer is `null`.\n- Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns\n`null`.", + "heading": "Description" + } + ], + "signature": "static readonly currentBasket: Basket | null", + "source": "script-api", + "tags": [ + "currentbasket", + "basketmgr.currentbasket" + ], + "title": "BasketMgr.currentBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or `null` if no current valid basket exists.", + "examples": [ + "var basket : Basket = BasketMgr.getCurrentBasket();\nif (basket) {\n// do something with basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#currentBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentBasket", + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or `null` if no current valid\nbasket exists.\n\nThe methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket\npersistence, which can be configured in the Business Manager site preferences / baskets section. A basket is\nvalid for the configured basket lifetime.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or\n`GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation\nin any scenario.\n\nThe current basket, if one exists, is usually updated by the method. In particular the last-modified date is\nupdated. No update is done when method getCurrentBasket is used within a read-only hook\nimplementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended\nin 2 ways:\n\n- The basket is modified in some way, e.g. a product is added resulting in the basket total being newly\ncalculated. This results in the basket lifetime being reset.\n- The basket has not been modified for 60 minutes, then using this method to access the basket will also reset\nthe basket lifetime.\n\nWhat happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and\npayment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs\nto a different customer this data is removed. This happens when a guest customer that has a basket logs in and\nhence identifies as a registered customer. In this case the basket which was previously created by the guest\ncustomer gets transferred to the (now logged in) registered customer. Should the registered customer already have\na basket, this basket is effectively invalidated, but made available using getStoredBasket allowing\nthe script to merge content from it if desired.\n\nWhat happens when a customer logs out or when the customer session times out? After the customer logs out, a\nbasket belonging to the registered customer (now logged out) is stored (where applicable) and this method\nreturns `null`. Personal data is also cleared when the session times out for a guest customer.\n\nThe following personal data is cleared:\n\n- product line items that were added from a wish list\n- shipping method\n- coupon line items\n- gift certificate line items\n- billing and shipping addresses\n- payment instruments\n- buyer email\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.\n\nTypical usage:\n\n\nConstraints:\n\n- The method only accesses the basket for the session customer, an exception is thrown when the session\ncustomer is `null`.\n- Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns\n`null`.", + "heading": "Description" + } + ], + "signature": "static readonly currentBasket: Basket | null", + "source": "script-api", + "tags": [ + "currentbasket", + "basketmgr.currentbasket" + ], + "title": "BasketMgr.currentBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or creates a new one if no current valid basket exists. See getCurrentBasket for more details.", + "id": "script-api:dw/order/BasketMgr#currentOrNewBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentOrNewBasket", + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or creates a new one if no current valid\nbasket exists. See getCurrentBasket for more details.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. For these scenarios, create baskets via `POST baskets` REST calls.", + "heading": "Description" + } + ], + "signature": "static readonly currentOrNewBasket: Basket", + "source": "script-api", + "tags": [ + "currentornewbasket", + "basketmgr.currentornewbasket" + ], + "title": "BasketMgr.currentOrNewBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or creates a new one if no current valid basket exists. See getCurrentBasket for more details.", + "id": "script-api:dw/order/BasketMgr#currentOrNewBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.currentOrNewBasket", + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or creates a new one if no current valid\nbasket exists. See getCurrentBasket for more details.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. For these scenarios, create baskets via `POST baskets` REST calls.", + "heading": "Description" + } + ], + "signature": "static readonly currentOrNewBasket: Basket", + "source": "script-api", + "tags": [ + "currentornewbasket", + "basketmgr.currentornewbasket" + ], + "title": "BasketMgr.currentOrNewBasket" + }, + { + "description": "Remove a customer basket including a temporary basket.", + "id": "script-api:dw/order/BasketMgr#deleteBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteBasket", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove a customer basket including a temporary basket.\n\nThis method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no\ncustomer is logged in the session.", + "heading": "Description" + } + ], + "signature": "static deleteBasket(basket: Basket): void", + "source": "script-api", + "tags": [ + "deletebasket", + "basketmgr.deletebasket" + ], + "title": "BasketMgr.deleteBasket" + }, + { + "description": "Remove a customer basket including a temporary basket.", + "id": "script-api:dw/order/BasketMgr#deleteBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteBasket", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove a customer basket including a temporary basket.\n\nThis method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no\ncustomer is logged in the session.", + "heading": "Description" + } + ], + "signature": "static deleteBasket(basket: Basket): void", + "source": "script-api", + "tags": [ + "deletebasket", + "basketmgr.deletebasket" + ], + "title": "BasketMgr.deleteBasket" + }, + { + "description": "Remove a customer temporary basket.", + "id": "script-api:dw/order/BasketMgr#deleteTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteTemporaryBasket", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove a customer temporary basket.", + "heading": "Description" + } + ], + "signature": "static deleteTemporaryBasket(basket: Basket): void", + "source": "script-api", + "tags": [ + "deletetemporarybasket", + "basketmgr.deletetemporarybasket" + ], + "title": "BasketMgr.deleteTemporaryBasket" + }, + { + "description": "Remove a customer temporary basket.", + "id": "script-api:dw/order/BasketMgr#deleteTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.deleteTemporaryBasket", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove a customer temporary basket.", + "heading": "Description" + } + ], + "signature": "static deleteTemporaryBasket(basket: Basket): void", + "source": "script-api", + "tags": [ + "deletetemporarybasket", + "basketmgr.deletetemporarybasket" + ], + "title": "BasketMgr.deleteTemporaryBasket" + }, + { + "description": "This method returns a valid basket of the session customer or `null` if none is found. This method can also be used to get a temporary basket for the session customer.", + "id": "script-api:dw/order/BasketMgr#getBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "uuid", + "type": "string" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns a valid basket of the session customer or `null` if none is found. This method can\nalso be used to get a temporary basket for the session customer.\n\nIf the basket does not belong to the session customer, the method returns `null`.\n\nIf the registered customer is not logged in, the method returns `null`.\n\nRestricted to agent scenario use cases: This method will result in an exception if called by a user without\npermission Create_Order_On_Behalf_Of or if no customer is logged in the session.\n\nThe basket, if accessible, is usually updated in the same way as getCurrentBasket.\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.", + "heading": "Description" + } + ], + "signature": "static getBasket(uuid: string): Basket | null", + "source": "script-api", + "tags": [ + "getbasket", + "basketmgr.getbasket" + ], + "title": "BasketMgr.getBasket" + }, + { + "description": "This method returns a valid basket of the session customer or `null` if none is found. This method can also be used to get a temporary basket for the session customer.", + "id": "script-api:dw/order/BasketMgr#getBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "uuid", + "type": "string" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns a valid basket of the session customer or `null` if none is found. This method can\nalso be used to get a temporary basket for the session customer.\n\nIf the basket does not belong to the session customer, the method returns `null`.\n\nIf the registered customer is not logged in, the method returns `null`.\n\nRestricted to agent scenario use cases: This method will result in an exception if called by a user without\npermission Create_Order_On_Behalf_Of or if no customer is logged in the session.\n\nThe basket, if accessible, is usually updated in the same way as getCurrentBasket.\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.", + "heading": "Description" + } + ], + "signature": "static getBasket(uuid: string): Basket | null", + "source": "script-api", + "tags": [ + "getbasket", + "basketmgr.getbasket" + ], + "title": "BasketMgr.getBasket" + }, + { + "description": "Retrieve all open baskets for the logged in customer including the temporary baskets.", + "id": "script-api:dw/order/BasketMgr#getBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBaskets", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieve all open baskets for the logged in customer including the temporary baskets.\n\nRestricted to agent scenario use cases: The returned list contains all agent baskets created with\ncreateAgentBasket and the current storefront basket which can also be retrieved with\ngetCurrentBasket. This method will result in an exception if called by a user without permission\nCreate_Order_On_Behalf_Of or if no customer is logged in the session.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static getBaskets(): List", + "source": "script-api", + "tags": [ + "getbaskets", + "basketmgr.getbaskets" + ], + "title": "BasketMgr.getBaskets" + }, + { + "description": "Retrieve all open baskets for the logged in customer including the temporary baskets.", + "id": "script-api:dw/order/BasketMgr#getBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getBaskets", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieve all open baskets for the logged in customer including the temporary baskets.\n\nRestricted to agent scenario use cases: The returned list contains all agent baskets created with\ncreateAgentBasket and the current storefront basket which can also be retrieved with\ngetCurrentBasket. This method will result in an exception if called by a user without permission\nCreate_Order_On_Behalf_Of or if no customer is logged in the session.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static getBaskets(): List", + "source": "script-api", + "tags": [ + "getbaskets", + "basketmgr.getbaskets" + ], + "title": "BasketMgr.getBaskets" + }, + { + "description": "This method returns the current valid basket of the session customer or `null` if no current valid basket exists.", + "examples": [ + "var basket : Basket = BasketMgr.getCurrentBasket();\nif (basket) {\n// do something with basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#getCurrentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or `null` if no current valid\nbasket exists.\n\nThe methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket\npersistence, which can be configured in the Business Manager site preferences / baskets section. A basket is\nvalid for the configured basket lifetime.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or\n`GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation\nin any scenario.\n\nThe current basket, if one exists, is usually updated by the method. In particular the last-modified date is\nupdated. No update is done when method getCurrentBasket is used within a read-only hook\nimplementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended\nin 2 ways:\n\n- The basket is modified in some way, e.g. a product is added resulting in the basket total being newly\ncalculated. This results in the basket lifetime being reset.\n- The basket has not been modified for 60 minutes, then using this method to access the basket will also reset\nthe basket lifetime.\n\nWhat happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and\npayment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs\nto a different customer this data is removed. This happens when a guest customer that has a basket logs in and\nhence identifies as a registered customer. In this case the basket which was previously created by the guest\ncustomer gets transferred to the (now logged in) registered customer. Should the registered customer already have\na basket, this basket is effectively invalidated, but made available using getStoredBasket allowing\nthe script to merge content from it if desired.\n\nWhat happens when a customer logs out or when the customer session times out? After the customer logs out, a\nbasket belonging to the registered customer (now logged out) is stored (where applicable) and this method\nreturns `null`. Personal data is also cleared when the session times out for a guest customer.\n\nThe following personal data is cleared:\n\n- product line items that were added from a wish list\n- shipping method\n- coupon line items\n- gift certificate line items\n- billing and shipping addresses\n- payment instruments\n- buyer email\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.\n\nTypical usage:\n\n\nConstraints:\n\n- The method only accesses the basket for the session customer, an exception is thrown when the session\ncustomer is `null`.\n- Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns\n`null`.", + "heading": "Description" + } + ], + "signature": "static getCurrentBasket(): Basket | null", + "source": "script-api", + "tags": [ + "getcurrentbasket", + "basketmgr.getcurrentbasket" + ], + "title": "BasketMgr.getCurrentBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or `null` if no current valid basket exists.", + "examples": [ + "var basket : Basket = BasketMgr.getCurrentBasket();\nif (basket) {\n// do something with basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#getCurrentBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or `null` if no current valid\nbasket exists.\n\nThe methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket\npersistence, which can be configured in the Business Manager site preferences / baskets section. A basket is\nvalid for the configured basket lifetime.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or\n`GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation\nin any scenario.\n\nThe current basket, if one exists, is usually updated by the method. In particular the last-modified date is\nupdated. No update is done when method getCurrentBasket is used within a read-only hook\nimplementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended\nin 2 ways:\n\n- The basket is modified in some way, e.g. a product is added resulting in the basket total being newly\ncalculated. This results in the basket lifetime being reset.\n- The basket has not been modified for 60 minutes, then using this method to access the basket will also reset\nthe basket lifetime.\n\nWhat happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and\npayment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs\nto a different customer this data is removed. This happens when a guest customer that has a basket logs in and\nhence identifies as a registered customer. In this case the basket which was previously created by the guest\ncustomer gets transferred to the (now logged in) registered customer. Should the registered customer already have\na basket, this basket is effectively invalidated, but made available using getStoredBasket allowing\nthe script to merge content from it if desired.\n\nWhat happens when a customer logs out or when the customer session times out? After the customer logs out, a\nbasket belonging to the registered customer (now logged out) is stored (where applicable) and this method\nreturns `null`. Personal data is also cleared when the session times out for a guest customer.\n\nThe following personal data is cleared:\n\n- product line items that were added from a wish list\n- shipping method\n- coupon line items\n- gift certificate line items\n- billing and shipping addresses\n- payment instruments\n- buyer email\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.\n\nTypical usage:\n\n\nConstraints:\n\n- The method only accesses the basket for the session customer, an exception is thrown when the session\ncustomer is `null`.\n- Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns\n`null`.", + "heading": "Description" + } + ], + "signature": "static getCurrentBasket(): Basket | null", + "source": "script-api", + "tags": [ + "getcurrentbasket", + "basketmgr.getcurrentbasket" + ], + "title": "BasketMgr.getCurrentBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or creates a new one if no current valid basket exists. See getCurrentBasket for more details.", + "id": "script-api:dw/order/BasketMgr#getCurrentOrNewBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentOrNewBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or creates a new one if no current valid\nbasket exists. See getCurrentBasket for more details.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. For these scenarios, create baskets via `POST baskets` REST calls.", + "heading": "Description" + } + ], + "signature": "static getCurrentOrNewBasket(): Basket", + "source": "script-api", + "tags": [ + "getcurrentornewbasket", + "basketmgr.getcurrentornewbasket" + ], + "title": "BasketMgr.getCurrentOrNewBasket" + }, + { + "description": "This method returns the current valid basket of the session customer or creates a new one if no current valid basket exists. See getCurrentBasket for more details.", + "id": "script-api:dw/order/BasketMgr#getCurrentOrNewBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getCurrentOrNewBasket", + "returns": { + "type": "Basket" + }, + "sections": [ + { + "body": "This method returns the current valid basket of the session customer or creates a new one if no current valid\nbasket exists. See getCurrentBasket for more details.\n\nIn hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also\nutilizing PWA Kit or other custom headless solution for another part of the same site), this method must\nNOT be used. For these scenarios, create baskets via `POST baskets` REST calls.", + "heading": "Description" + } + ], + "signature": "static getCurrentOrNewBasket(): Basket", + "source": "script-api", + "tags": [ + "getcurrentornewbasket", + "basketmgr.getcurrentornewbasket" + ], + "title": "BasketMgr.getCurrentOrNewBasket" + }, + { + "description": "This method returns the stored basket of the session customer or `null` if none is found. A stored basket is returned in the following situation:", + "examples": [ + "var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();\nvar storedBasket : Basket = BasketMgr.getStoredBasket();\nif (storedBasket) {\n// transfer all the data needed from the stored to the active basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#getStoredBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getStoredBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns the stored basket of the session customer or `null` if none is found. A stored\nbasket is returned in the following situation:\n\n- During one visit, a customer-Q logs in and creates a basket-A by adding products to it.\n- During a subsequent visit, a second basket-B is created for a guest customer who then logs in as\ncustomer-Q.\n\nIn this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this\nmethod. It is now possible to merge the information from the stored basket (basket-A) to the active basket\n(basket-B). If this method returns `null` in the previous scenario, verify that:\n\n- The session handling between the two visits is correct - the first visit and second visit must be in\ndifferent sessions. Furthermore, the second session must contain both basket creations: as guest and the customer\nlogin.\n- The stored basket is not expired.\n- Basket persistence settings are configured correctly in the Business Manager.\n\nA stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets\nsection. A basket is valid for the configured basket lifetime.\n\nTypical usage:\n\n\nA exhaustive example on how to use this method in the context of the Merge Basket functionality can be found\nhere: Merge Basket utility\nfunctions using Script API", + "heading": "Description" + } + ], + "signature": "static getStoredBasket(): Basket | null", + "source": "script-api", + "tags": [ + "getstoredbasket", + "basketmgr.getstoredbasket" + ], + "title": "BasketMgr.getStoredBasket" + }, + { + "description": "This method returns the stored basket of the session customer or `null` if none is found. A stored basket is returned in the following situation:", + "examples": [ + "var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();\nvar storedBasket : Basket = BasketMgr.getStoredBasket();\nif (storedBasket) {\n// transfer all the data needed from the stored to the active basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#getStoredBasket", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getStoredBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns the stored basket of the session customer or `null` if none is found. A stored\nbasket is returned in the following situation:\n\n- During one visit, a customer-Q logs in and creates a basket-A by adding products to it.\n- During a subsequent visit, a second basket-B is created for a guest customer who then logs in as\ncustomer-Q.\n\nIn this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this\nmethod. It is now possible to merge the information from the stored basket (basket-A) to the active basket\n(basket-B). If this method returns `null` in the previous scenario, verify that:\n\n- The session handling between the two visits is correct - the first visit and second visit must be in\ndifferent sessions. Furthermore, the second session must contain both basket creations: as guest and the customer\nlogin.\n- The stored basket is not expired.\n- Basket persistence settings are configured correctly in the Business Manager.\n\nA stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets\nsection. A basket is valid for the configured basket lifetime.\n\nTypical usage:\n\n\nA exhaustive example on how to use this method in the context of the Merge Basket functionality can be found\nhere: Merge Basket utility\nfunctions using Script API", + "heading": "Description" + } + ], + "signature": "static getStoredBasket(): Basket | null", + "source": "script-api", + "tags": [ + "getstoredbasket", + "basketmgr.getstoredbasket" + ], + "title": "BasketMgr.getStoredBasket" + }, + { + "description": "This method returns a valid temporary basket of the session customer or `null` if none is found.", + "id": "script-api:dw/order/BasketMgr#getTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "uuid", + "type": "string" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns a valid temporary basket of the session customer or `null` if none is found.\n\nIf the basket does not belong to the session customer, the method returns `null`.\n\nIf the basket is not a temporary basket, the method returns `null`.\n\nThe basket, if accessible, is usually updated in the same way as getCurrentBasket.\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.", + "heading": "Description" + } + ], + "signature": "static getTemporaryBasket(uuid: string): Basket | null", + "source": "script-api", + "tags": [ + "gettemporarybasket", + "basketmgr.gettemporarybasket" + ], + "title": "BasketMgr.getTemporaryBasket" + }, + { + "description": "This method returns a valid temporary basket of the session customer or `null` if none is found.", + "id": "script-api:dw/order/BasketMgr#getTemporaryBasket", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "uuid", + "type": "string" + } + ], + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBasket", + "returns": { + "type": "Basket | null" + }, + "sections": [ + { + "body": "This method returns a valid temporary basket of the session customer or `null` if none is found.\n\nIf the basket does not belong to the session customer, the method returns `null`.\n\nIf the basket is not a temporary basket, the method returns `null`.\n\nThe basket, if accessible, is usually updated in the same way as getCurrentBasket.\n\nIf the session currency no longer matches the basket currency, the basket currency should be updated with\ndw.order.Basket.updateCurrency.", + "heading": "Description" + } + ], + "signature": "static getTemporaryBasket(uuid: string): Basket | null", + "source": "script-api", + "tags": [ + "gettemporarybasket", + "basketmgr.gettemporarybasket" + ], + "title": "BasketMgr.getTemporaryBasket" + }, + { + "description": "Retrieve all open temporary baskets for the logged in customer.", + "id": "script-api:dw/order/BasketMgr#getTemporaryBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBaskets", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieve all open temporary baskets for the logged in customer.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static getTemporaryBaskets(): List", + "source": "script-api", + "tags": [ + "gettemporarybaskets", + "basketmgr.gettemporarybaskets" + ], + "title": "BasketMgr.getTemporaryBaskets" + }, + { + "description": "Retrieve all open temporary baskets for the logged in customer.", + "id": "script-api:dw/order/BasketMgr#getTemporaryBaskets", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.getTemporaryBaskets", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Retrieve all open temporary baskets for the logged in customer.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static getTemporaryBaskets(): List", + "source": "script-api", + "tags": [ + "gettemporarybaskets", + "basketmgr.gettemporarybaskets" + ], + "title": "BasketMgr.getTemporaryBaskets" + }, + { + "description": "This method returns the stored basket of the session customer or `null` if none is found. A stored basket is returned in the following situation:", + "examples": [ + "var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();\nvar storedBasket : Basket = BasketMgr.getStoredBasket();\nif (storedBasket) {\n// transfer all the data needed from the stored to the active basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#storedBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.storedBasket", + "sections": [ + { + "body": "This method returns the stored basket of the session customer or `null` if none is found. A stored\nbasket is returned in the following situation:\n\n- During one visit, a customer-Q logs in and creates a basket-A by adding products to it.\n- During a subsequent visit, a second basket-B is created for a guest customer who then logs in as\ncustomer-Q.\n\nIn this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this\nmethod. It is now possible to merge the information from the stored basket (basket-A) to the active basket\n(basket-B). If this method returns `null` in the previous scenario, verify that:\n\n- The session handling between the two visits is correct - the first visit and second visit must be in\ndifferent sessions. Furthermore, the second session must contain both basket creations: as guest and the customer\nlogin.\n- The stored basket is not expired.\n- Basket persistence settings are configured correctly in the Business Manager.\n\nA stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets\nsection. A basket is valid for the configured basket lifetime.\n\nTypical usage:\n\n\nA exhaustive example on how to use this method in the context of the Merge Basket functionality can be found\nhere: Merge Basket utility\nfunctions using Script API", + "heading": "Description" + } + ], + "signature": "static readonly storedBasket: Basket | null", + "source": "script-api", + "tags": [ + "storedbasket", + "basketmgr.storedbasket" + ], + "title": "BasketMgr.storedBasket" + }, + { + "description": "This method returns the stored basket of the session customer or `null` if none is found. A stored basket is returned in the following situation:", + "examples": [ + "var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();\nvar storedBasket : Basket = BasketMgr.getStoredBasket();\nif (storedBasket) {\n// transfer all the data needed from the stored to the active basket\n}" + ], + "id": "script-api:dw/order/BasketMgr#storedBasket", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.storedBasket", + "sections": [ + { + "body": "This method returns the stored basket of the session customer or `null` if none is found. A stored\nbasket is returned in the following situation:\n\n- During one visit, a customer-Q logs in and creates a basket-A by adding products to it.\n- During a subsequent visit, a second basket-B is created for a guest customer who then logs in as\ncustomer-Q.\n\nIn this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this\nmethod. It is now possible to merge the information from the stored basket (basket-A) to the active basket\n(basket-B). If this method returns `null` in the previous scenario, verify that:\n\n- The session handling between the two visits is correct - the first visit and second visit must be in\ndifferent sessions. Furthermore, the second session must contain both basket creations: as guest and the customer\nlogin.\n- The stored basket is not expired.\n- Basket persistence settings are configured correctly in the Business Manager.\n\nA stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets\nsection. A basket is valid for the configured basket lifetime.\n\nTypical usage:\n\n\nA exhaustive example on how to use this method in the context of the Merge Basket functionality can be found\nhere: Merge Basket utility\nfunctions using Script API", + "heading": "Description" + } + ], + "signature": "static readonly storedBasket: Basket | null", + "source": "script-api", + "tags": [ + "storedbasket", + "basketmgr.storedbasket" + ], + "title": "BasketMgr.storedBasket" + }, + { + "description": "Retrieve all open temporary baskets for the logged in customer.", + "id": "script-api:dw/order/BasketMgr#temporaryBaskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.temporaryBaskets", + "sections": [ + { + "body": "Retrieve all open temporary baskets for the logged in customer.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static readonly temporaryBaskets: List", + "source": "script-api", + "tags": [ + "temporarybaskets", + "basketmgr.temporarybaskets" + ], + "title": "BasketMgr.temporaryBaskets" + }, + { + "description": "Retrieve all open temporary baskets for the logged in customer.", + "id": "script-api:dw/order/BasketMgr#temporaryBaskets", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BasketMgr", + "qualifiedName": "dw.order.BasketMgr.temporaryBaskets", + "sections": [ + { + "body": "Retrieve all open temporary baskets for the logged in customer.\n\nPlease notice that baskets are invalidated after a certain amount of time and may not be returned anymore.", + "heading": "Description" + } + ], + "signature": "static readonly temporaryBaskets: List", + "source": "script-api", + "tags": [ + "temporarybaskets", + "basketmgr.temporarybaskets" + ], + "title": "BasketMgr.temporaryBaskets" + }, + { + "description": "Line item representing an applied dw.campaign.BonusChoiceDiscount in a LineItemCtnr. This type of line item can only be created by the B2C Commerce promotions engine when applying a BonusChoiceDiscount. A BonusDiscountLineItem is basically a placeholder in the cart which entitles a customer to add one or more bonus products to his basket from a configured list of products. Merchants typically display this type of line item in the cart by showing the corresponding promotion callout message. They typically provide links to the bonus products that the customer can choose from. This line item can be removed from the cart but will be re-added each time the promotions engine re-applies discounts. Merchants may however add custom logic to show/hide this line item since it just a placeholder and not an actual product line item.", + "id": "script-api:dw/order/BonusDiscountLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.BonusDiscountLineItem", + "sections": [ + { + "body": "Line item representing an applied dw.campaign.BonusChoiceDiscount in a LineItemCtnr. This type of line item\ncan only be created by the B2C Commerce promotions engine when applying a BonusChoiceDiscount.\nA BonusDiscountLineItem is basically a placeholder in the cart which entitles a customer to add one or more bonus\nproducts to his basket from a configured list of products. Merchants typically display this type of line item in the\ncart by showing the corresponding promotion callout message. They typically provide links to the bonus products that\nthe customer can choose from. This line item can be removed from the cart but will be re-added each time the\npromotions engine re-applies discounts. Merchants may however add custom logic to show/hide this line item since it\njust a placeholder and not an actual product line item.\n\nThe number of products that a customer is allowed to choose from is determined by getMaxBonusItems. The\ncollection of products the customer can choose from is determined by getBonusProducts. When a customer\nchooses a bonus product in the storefront, it is necessary to use the `AddBonusProductToBasket` pipelet\ninstead of the usual `AddProductToBasket` pipelet, in order to associate this BonusDiscountLineItem with\nthe newly created bonus ProductLineItem. Alternatively, the API method\ndw.order.LineItemCtnr.createBonusProductLineItem\ncan be used instead. The system does proper validations in order to prevent incorrect or too many bonus products from\nbeing associated with this BonusDiscountLineItem. Once a customer has selected bonus products, the product line items\nrepresenting the chosen bonus products can be retrieved with getBonusProductLineItems.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "bonusdiscountlineitem", + "dw.order.bonusdiscountlineitem", + "dw/order" + ], + "title": "BonusDiscountLineItem" + }, + { + "description": "Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of bonus products.", + "id": "script-api:dw/order/BonusDiscountLineItem#bonusChoiceRuleBased", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusChoiceRuleBased", + "sections": [ + { + "body": "Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of\nbonus products.\n\nIf the promotion is rule based, then a ProductSearchModel should be used to return the bonus products the\ncustomer may choose from, as the methods that return lists will return nothing. See getBonusProducts", + "heading": "Description" + } + ], + "signature": "readonly bonusChoiceRuleBased: boolean", + "source": "script-api", + "tags": [ + "bonuschoicerulebased", + "bonusdiscountlineitem.bonuschoicerulebased" + ], + "title": "BonusDiscountLineItem.bonusChoiceRuleBased" + }, + { + "description": "Get the product line items in the current LineItemCtnr representing the bonus products that the customer has selected for this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#bonusProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusProductLineItems", + "sections": [ + { + "body": "Get the product line items in the current LineItemCtnr representing the\nbonus products that the customer has selected for this discount.", + "heading": "Description" + } + ], + "signature": "readonly bonusProductLineItems: List", + "source": "script-api", + "tags": [ + "bonusproductlineitems", + "bonusdiscountlineitem.bonusproductlineitems" + ], + "title": "BonusDiscountLineItem.bonusProductLineItems" + }, + { + "description": "Get the list of bonus products which the customer is allowed to choose from for this discount. This list is configured by a merchant entering a list of SKUs for the discount. Products which do not exist in the system, or are offline, or are not assigned to a category in the site catalog are filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered out. This allows merchants to display out-of-stock bonus products with appropriate messaging.", + "id": "script-api:dw/order/BonusDiscountLineItem#bonusProducts", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.bonusProducts", + "sections": [ + { + "body": "Get the list of bonus products which the customer is allowed to choose\nfrom for this discount. This list is configured by a merchant entering a\nlist of SKUs for the discount. Products which do not exist in the system,\nor are offline, or are not assigned to a category in the site catalog are\nfiltered out. Unavailable (i.e. out-of-stock) products are NOT filtered\nout. This allows merchants to display out-of-stock bonus products with\nappropriate messaging.\n\nIf the promotion which triggered this discount does not exist, or this\npromotion is rule based, then this method returns an empty list.\n\nIf the promotion is rule based, then this method will return an empty list.\nA ProductSearchModel should be used to return the bonus products the\ncustomer may choose from instead. See\ndw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and\ndw.catalog.ProductSearchModel.setPromotionID\n\nIf a returned product is a master product, the customer is entitled to\nchoose from any variant. If the product is an option product, the\ncustomer is entitled to choose any value for each option. Since the\npromotions engine does not touch the value of the product option line\nitems, it is the responsibility of custom code to set option prices.", + "heading": "Description" + } + ], + "signature": "readonly bonusProducts: List>", + "source": "script-api", + "tags": [ + "bonusproducts", + "bonusdiscountlineitem.bonusproducts" + ], + "title": "BonusDiscountLineItem.bonusProducts" + }, + { + "description": "Get the coupon line item associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#couponLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.couponLineItem", + "sections": [ + { + "body": "Get the coupon line item associated with this discount.", + "heading": "Description" + } + ], + "signature": "readonly couponLineItem: CouponLineItem | null", + "source": "script-api", + "tags": [ + "couponlineitem", + "bonusdiscountlineitem.couponlineitem" + ], + "title": "BonusDiscountLineItem.couponLineItem" + }, + { + "description": "Get the product line items in the current LineItemCtnr representing the bonus products that the customer has selected for this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProductLineItems", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Get the product line items in the current LineItemCtnr representing the\nbonus products that the customer has selected for this discount.", + "heading": "Description" + } + ], + "signature": "getBonusProductLineItems(): List", + "source": "script-api", + "tags": [ + "getbonusproductlineitems", + "bonusdiscountlineitem.getbonusproductlineitems" + ], + "title": "BonusDiscountLineItem.getBonusProductLineItems" + }, + { + "description": "Get the effective price for the passed bonus product. This is expected to be one of the products returned by getBonusProducts with one exception: If a master product is configured as a bonus product, this implies that a customer may choose from any of its variants. In this case, it is allowed to pass in a variant to this method and a price will be returned. If the passed product is not a valid bonus product, this method throws an exception.", + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProductPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProductPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Get the effective price for the passed bonus product. This is expected to\nbe one of the products returned by getBonusProducts with one\nexception: If a master product is configured as a bonus product, this\nimplies that a customer may choose from any of its variants. In this\ncase, it is allowed to pass in a variant to this method and a price will\nbe returned. If the passed product is not a valid bonus product, this\nmethod throws an exception.", + "heading": "Description" + } + ], + "signature": "getBonusProductPrice(product: Product): Money", + "source": "script-api", + "tags": [ + "getbonusproductprice", + "bonusdiscountlineitem.getbonusproductprice" + ], + "title": "BonusDiscountLineItem.getBonusProductPrice" + }, + { + "description": "Get the list of bonus products which the customer is allowed to choose from for this discount. This list is configured by a merchant entering a list of SKUs for the discount. Products which do not exist in the system, or are offline, or are not assigned to a category in the site catalog are filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered out. This allows merchants to display out-of-stock bonus products with appropriate messaging.", + "id": "script-api:dw/order/BonusDiscountLineItem#getBonusProducts", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getBonusProducts", + "returns": { + "type": "List>" + }, + "sections": [ + { + "body": "Get the list of bonus products which the customer is allowed to choose\nfrom for this discount. This list is configured by a merchant entering a\nlist of SKUs for the discount. Products which do not exist in the system,\nor are offline, or are not assigned to a category in the site catalog are\nfiltered out. Unavailable (i.e. out-of-stock) products are NOT filtered\nout. This allows merchants to display out-of-stock bonus products with\nappropriate messaging.\n\nIf the promotion which triggered this discount does not exist, or this\npromotion is rule based, then this method returns an empty list.\n\nIf the promotion is rule based, then this method will return an empty list.\nA ProductSearchModel should be used to return the bonus products the\ncustomer may choose from instead. See\ndw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and\ndw.catalog.ProductSearchModel.setPromotionID\n\nIf a returned product is a master product, the customer is entitled to\nchoose from any variant. If the product is an option product, the\ncustomer is entitled to choose any value for each option. Since the\npromotions engine does not touch the value of the product option line\nitems, it is the responsibility of custom code to set option prices.", + "heading": "Description" + } + ], + "signature": "getBonusProducts(): List>", + "source": "script-api", + "tags": [ + "getbonusproducts", + "bonusdiscountlineitem.getbonusproducts" + ], + "title": "BonusDiscountLineItem.getBonusProducts" + }, + { + "description": "Get the coupon line item associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getCouponLineItem", + "returns": { + "type": "CouponLineItem | null" + }, + "sections": [ + { + "body": "Get the coupon line item associated with this discount.", + "heading": "Description" + } + ], + "signature": "getCouponLineItem(): CouponLineItem | null", + "source": "script-api", + "tags": [ + "getcouponlineitem", + "bonusdiscountlineitem.getcouponlineitem" + ], + "title": "BonusDiscountLineItem.getCouponLineItem" + }, + { + "description": "Get the maximum number of bonus items that the customer is permitted to select for this bonus discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#getMaxBonusItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getMaxBonusItems", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Get the maximum number of bonus items that the customer is permitted to\nselect for this bonus discount.\n\nIf the promotion which triggered this discount does not exist, then this\nmethod returns 0.", + "heading": "Description" + } + ], + "signature": "getMaxBonusItems(): number", + "source": "script-api", + "tags": [ + "getmaxbonusitems", + "bonusdiscountlineitem.getmaxbonusitems" + ], + "title": "BonusDiscountLineItem.getMaxBonusItems" + }, + { + "description": "Get the promotion associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Get the promotion associated with this discount.", + "heading": "Description" + } + ], + "signature": "getPromotion(): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "bonusdiscountlineitem.getpromotion" + ], + "title": "BonusDiscountLineItem.getPromotion" + }, + { + "description": "Get the promotion ID associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.getPromotionID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the promotion ID associated with this discount.", + "heading": "Description" + } + ], + "signature": "getPromotionID(): string", + "source": "script-api", + "tags": [ + "getpromotionid", + "bonusdiscountlineitem.getpromotionid" + ], + "title": "BonusDiscountLineItem.getPromotionID" + }, + { + "description": "Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of bonus products.", + "id": "script-api:dw/order/BonusDiscountLineItem#isBonusChoiceRuleBased", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.isBonusChoiceRuleBased", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of\nbonus products.\n\nIf the promotion is rule based, then a ProductSearchModel should be used to return the bonus products the\ncustomer may choose from, as the methods that return lists will return nothing. See getBonusProducts", + "heading": "Description" + } + ], + "signature": "isBonusChoiceRuleBased(): boolean", + "source": "script-api", + "tags": [ + "isbonuschoicerulebased", + "bonusdiscountlineitem.isbonuschoicerulebased" + ], + "title": "BonusDiscountLineItem.isBonusChoiceRuleBased" + }, + { + "description": "Get the maximum number of bonus items that the customer is permitted to select for this bonus discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#maxBonusItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.maxBonusItems", + "sections": [ + { + "body": "Get the maximum number of bonus items that the customer is permitted to\nselect for this bonus discount.\n\nIf the promotion which triggered this discount does not exist, then this\nmethod returns 0.", + "heading": "Description" + } + ], + "signature": "readonly maxBonusItems: number", + "source": "script-api", + "tags": [ + "maxbonusitems", + "bonusdiscountlineitem.maxbonusitems" + ], + "title": "BonusDiscountLineItem.maxBonusItems" + }, + { + "description": "Get the promotion associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.promotion", + "sections": [ + { + "body": "Get the promotion associated with this discount.", + "heading": "Description" + } + ], + "signature": "readonly promotion: Promotion | null", + "source": "script-api", + "tags": [ + "promotion", + "bonusdiscountlineitem.promotion" + ], + "title": "BonusDiscountLineItem.promotion" + }, + { + "description": "Get the promotion ID associated with this discount.", + "id": "script-api:dw/order/BonusDiscountLineItem#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/BonusDiscountLineItem", + "qualifiedName": "dw.order.BonusDiscountLineItem.promotionID", + "sections": [ + { + "body": "Get the promotion ID associated with this discount.", + "heading": "Description" + } + ], + "signature": "readonly promotionID: string", + "source": "script-api", + "tags": [ + "promotionid", + "bonusdiscountlineitem.promotionid" + ], + "title": "BonusDiscountLineItem.promotionID" + }, + { + "description": "The CouponLineItem class is used to store redeemed coupons in the Basket.", + "id": "script-api:dw/order/CouponLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CouponLineItem", + "sections": [ + { + "body": "The CouponLineItem class is used to store redeemed coupons in the Basket.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "couponlineitem", + "dw.order.couponlineitem", + "dw/order" + ], + "title": "CouponLineItem" + }, + { + "description": "Identifies if the coupon is currently applied in the basket. A coupon line is applied if there exists at least one price adjustment related to the coupon line item.", + "id": "script-api:dw/order/CouponLineItem#applied", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.applied", + "sections": [ + { + "body": "Identifies if the coupon is currently applied in the basket. A coupon\nline is applied if there exists at least one price adjustment related\nto the coupon line item.", + "heading": "Description" + } + ], + "signature": "readonly applied: boolean", + "source": "script-api", + "tags": [ + "applied", + "couponlineitem.applied" + ], + "title": "CouponLineItem.applied" + }, + { + "description": "Associates the specified price adjustment with the coupon line item. This method is only applicable if used for price adjustments and coupon line items NOT based on B2C Commerce campaigns.", + "id": "script-api:dw/order/CouponLineItem#associatePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustment", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.associatePriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Associates the specified price adjustment with the coupon line item. This method is only applicable if used for\nprice adjustments and coupon line items NOT based on B2C Commerce campaigns.", + "heading": "Description" + } + ], + "signature": "associatePriceAdjustment(priceAdjustment: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "associatepriceadjustment", + "couponlineitem.associatepriceadjustment" + ], + "title": "CouponLineItem.associatePriceAdjustment" + }, + { + "description": "Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom coupon code, the method returns false.", + "id": "script-api:dw/order/CouponLineItem#basedOnCampaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.basedOnCampaign", + "sections": [ + { + "body": "Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom\ncoupon code, the method returns false.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCampaign: boolean", + "source": "script-api", + "tags": [ + "basedoncampaign", + "couponlineitem.basedoncampaign" + ], + "title": "CouponLineItem.basedOnCampaign" + }, + { + "description": "Returns the bonus discount line items of the line item container triggered by this coupon.", + "id": "script-api:dw/order/CouponLineItem#bonusDiscountLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.bonusDiscountLineItems", + "sections": [ + { + "body": "Returns the bonus discount line items of the line item container triggered\nby this coupon.", + "heading": "Description" + } + ], + "signature": "readonly bonusDiscountLineItems: Collection", + "source": "script-api", + "tags": [ + "bonusdiscountlineitems", + "couponlineitem.bonusdiscountlineitems" + ], + "title": "CouponLineItem.bonusDiscountLineItems" + }, + { + "description": "Returns the coupon code.", + "id": "script-api:dw/order/CouponLineItem#couponCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.couponCode", + "sections": [ + { + "body": "Returns the coupon code.", + "heading": "Description" + } + ], + "signature": "readonly couponCode: string", + "source": "script-api", + "tags": [ + "couponcode", + "couponlineitem.couponcode" + ], + "title": "CouponLineItem.couponCode" + }, + { + "description": "Returns the bonus discount line items of the line item container triggered by this coupon.", + "id": "script-api:dw/order/CouponLineItem#getBonusDiscountLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getBonusDiscountLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the bonus discount line items of the line item container triggered\nby this coupon.", + "heading": "Description" + } + ], + "signature": "getBonusDiscountLineItems(): Collection", + "source": "script-api", + "tags": [ + "getbonusdiscountlineitems", + "couponlineitem.getbonusdiscountlineitems" + ], + "title": "CouponLineItem.getBonusDiscountLineItems" + }, + { + "description": "Returns the coupon code.", + "id": "script-api:dw/order/CouponLineItem#getCouponCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getCouponCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the coupon code.", + "heading": "Description" + } + ], + "signature": "getCouponCode(): string", + "source": "script-api", + "tags": [ + "getcouponcode", + "couponlineitem.getcouponcode" + ], + "title": "CouponLineItem.getCouponCode" + }, + { + "description": "Returns the price adjustments of the line item container triggered by this coupon.", + "id": "script-api:dw/order/CouponLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the price adjustments of the line item container triggered\nby this coupon.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getpriceadjustments", + "couponlineitem.getpriceadjustments" + ], + "title": "CouponLineItem.getPriceAdjustments" + }, + { + "deprecated": { + "message": "A coupon code and its coupon can be associated with\nmultiple promotions. Therefore, this method is not\nappropriate anymore. For backward-compatibility, the method\nreturns one of the promotions associated with the coupon\ncode." + }, + "description": "Returns the promotion related to the coupon line item.", + "id": "script-api:dw/order/CouponLineItem#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPromotion", + "returns": { + "type": "Promotion" + }, + "sections": [ + { + "body": "Returns the promotion related to the coupon line item.", + "heading": "Description" + } + ], + "signature": "getPromotion(): Promotion", + "source": "script-api", + "tags": [ + "getpromotion", + "couponlineitem.getpromotion" + ], + "title": "CouponLineItem.getPromotion" + }, + { + "deprecated": { + "message": "A coupon code and it's coupon can be associated with\nmultiple promotions. Therefore, this method is not\nappropriate anymore. For backward-compatibility, the method\nreturns the ID of one of the promotions associated with\nthe coupon code." + }, + "description": "Returns the id of the related promotion.", + "id": "script-api:dw/order/CouponLineItem#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getPromotionID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the id of the related promotion.", + "heading": "Description" + } + ], + "signature": "getPromotionID(): string", + "source": "script-api", + "tags": [ + "getpromotionid", + "couponlineitem.getpromotionid" + ], + "title": "CouponLineItem.getPromotionID" + }, + { + "description": "This method provides a detailed error status in case the coupon code of this coupon line item instance became invalid.", + "id": "script-api:dw/order/CouponLineItem#getStatusCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.getStatusCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "This method provides a detailed error status in case the coupon code of\nthis coupon line item instance became invalid.", + "heading": "Description" + } + ], + "signature": "getStatusCode(): string", + "source": "script-api", + "tags": [ + "getstatuscode", + "couponlineitem.getstatuscode" + ], + "title": "CouponLineItem.getStatusCode" + }, + { + "description": "Identifies if the coupon is currently applied in the basket. A coupon line is applied if there exists at least one price adjustment related to the coupon line item.", + "id": "script-api:dw/order/CouponLineItem#isApplied", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isApplied", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the coupon is currently applied in the basket. A coupon\nline is applied if there exists at least one price adjustment related\nto the coupon line item.", + "heading": "Description" + } + ], + "signature": "isApplied(): boolean", + "source": "script-api", + "tags": [ + "isapplied", + "couponlineitem.isapplied" + ], + "title": "CouponLineItem.isApplied" + }, + { + "description": "Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom coupon code, the method returns false.", + "id": "script-api:dw/order/CouponLineItem#isBasedOnCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isBasedOnCampaign", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom\ncoupon code, the method returns false.", + "heading": "Description" + } + ], + "signature": "isBasedOnCampaign(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncampaign", + "couponlineitem.isbasedoncampaign" + ], + "title": "CouponLineItem.isBasedOnCampaign" + }, + { + "description": "Allows to check whether the coupon code of this coupon line item instance is valid. Coupon line item is valid, if status code is one of the following:", + "id": "script-api:dw/order/CouponLineItem#isValid", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.isValid", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Allows to check whether the coupon code of this coupon line item instance\nis valid. Coupon line item is valid, if status code is one of the following:\n\n- dw.campaign.CouponStatusCodes.APPLIED\n- dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "heading": "Description" + } + ], + "signature": "isValid(): boolean", + "source": "script-api", + "tags": [ + "isvalid", + "couponlineitem.isvalid" + ], + "title": "CouponLineItem.isValid" + }, + { + "description": "Returns the price adjustments of the line item container triggered by this coupon.", + "id": "script-api:dw/order/CouponLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.priceAdjustments", + "sections": [ + { + "body": "Returns the price adjustments of the line item container triggered\nby this coupon.", + "heading": "Description" + } + ], + "signature": "readonly priceAdjustments: Collection", + "source": "script-api", + "tags": [ + "priceadjustments", + "couponlineitem.priceadjustments" + ], + "title": "CouponLineItem.priceAdjustments" + }, + { + "deprecated": { + "message": "A coupon code and its coupon can be associated with\nmultiple promotions. Therefore, this method is not\nappropriate anymore. For backward-compatibility, the method\nreturns one of the promotions associated with the coupon\ncode." + }, + "description": "Returns the promotion related to the coupon line item.", + "id": "script-api:dw/order/CouponLineItem#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.promotion", + "sections": [ + { + "body": "Returns the promotion related to the coupon line item.", + "heading": "Description" + } + ], + "signature": "readonly promotion: Promotion", + "source": "script-api", + "tags": [ + "promotion", + "couponlineitem.promotion" + ], + "title": "CouponLineItem.promotion" + }, + { + "deprecated": { + "message": "A coupon code and it's coupon can be associated with\nmultiple promotions. Therefore, this method is not\nappropriate anymore. For backward-compatibility, the method\nreturns the ID of one of the promotions associated with\nthe coupon code." + }, + "description": "Returns the id of the related promotion.", + "id": "script-api:dw/order/CouponLineItem#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.promotionID", + "sections": [ + { + "body": "Returns the id of the related promotion.", + "heading": "Description" + } + ], + "signature": "readonly promotionID: string", + "source": "script-api", + "tags": [ + "promotionid", + "couponlineitem.promotionid" + ], + "title": "CouponLineItem.promotionID" + }, + { + "description": "This method provides a detailed error status in case the coupon code of this coupon line item instance became invalid.", + "id": "script-api:dw/order/CouponLineItem#statusCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.statusCode", + "sections": [ + { + "body": "This method provides a detailed error status in case the coupon code of\nthis coupon line item instance became invalid.", + "heading": "Description" + } + ], + "signature": "readonly statusCode: string", + "source": "script-api", + "tags": [ + "statuscode", + "couponlineitem.statuscode" + ], + "title": "CouponLineItem.statusCode" + }, + { + "description": "Allows to check whether the coupon code of this coupon line item instance is valid. Coupon line item is valid, if status code is one of the following:", + "id": "script-api:dw/order/CouponLineItem#valid", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CouponLineItem", + "qualifiedName": "dw.order.CouponLineItem.valid", + "sections": [ + { + "body": "Allows to check whether the coupon code of this coupon line item instance\nis valid. Coupon line item is valid, if status code is one of the following:\n\n- dw.campaign.CouponStatusCodes.APPLIED\n- dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION", + "heading": "Description" + } + ], + "signature": "readonly valid: boolean", + "source": "script-api", + "tags": [ + "valid", + "couponlineitem.valid" + ], + "title": "CouponLineItem.valid" + }, + { + "description": "This exception is thrown by BasketMgr.createAgentBasket to indicate that the open agent basket limit for the current session customer is already reached, and therefore no new agent basket could be created.", + "id": "script-api:dw/order/CreateAgentBasketLimitExceededException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateAgentBasketLimitExceededException", + "sections": [ + { + "body": "This exception is thrown by BasketMgr.createAgentBasket to indicate that the open agent basket limit for\nthe current session customer is already reached, and therefore no new agent basket could be created.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "createagentbasketlimitexceededexception", + "dw.order.createagentbasketlimitexceededexception", + "dw/order" + ], + "title": "CreateAgentBasketLimitExceededException" + }, + { + "description": "This APIException is thrown by method dw.order.BasketMgr.createBasketFromOrder to indicate no Basket could be created from the Order.", + "id": "script-api:dw/order/CreateBasketFromOrderException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateBasketFromOrderException", + "sections": [ + { + "body": "This APIException is thrown by method dw.order.BasketMgr.createBasketFromOrder\nto indicate no Basket could be created from the Order.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "createbasketfromorderexception", + "dw.order.createbasketfromorderexception", + "dw/order" + ], + "title": "CreateBasketFromOrderException" + }, + { + "description": "Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.", + "id": "script-api:dw/order/CreateBasketFromOrderException#errorCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateBasketFromOrderException", + "qualifiedName": "dw.order.CreateBasketFromOrderException.errorCode", + "sections": [ + { + "body": "Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.", + "heading": "Description" + } + ], + "signature": "readonly errorCode: string", + "source": "script-api", + "tags": [ + "errorcode", + "createbasketfromorderexception.errorcode" + ], + "title": "CreateBasketFromOrderException.errorCode" + }, + { + "description": "Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.", + "id": "script-api:dw/order/CreateBasketFromOrderException#getErrorCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateBasketFromOrderException", + "qualifiedName": "dw.order.CreateBasketFromOrderException.getErrorCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.", + "heading": "Description" + } + ], + "signature": "getErrorCode(): string", + "source": "script-api", + "tags": [ + "geterrorcode", + "createbasketfromorderexception.geterrorcode" + ], + "title": "CreateBasketFromOrderException.getErrorCode" + }, + { + "description": "This exception could be thrown by LineItemCtnr.createCouponLineItem when the provided coupon code is invalid.", + "id": "script-api:dw/order/CreateCouponLineItemException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateCouponLineItemException", + "sections": [ + { + "body": "This exception could be thrown by LineItemCtnr.createCouponLineItem\nwhen the provided coupon code is invalid.\n\n'errorCode' property is set to one of the following values:\n\n- dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET = Indicates that coupon code has already been added to basket.\n- dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET = Indicates that another code of the same MultiCode/System coupon has already been added to basket.\n- dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED = Indicates that code of MultiCode/System coupon has already been redeemed.\n- dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN = Indicates that coupon not found for given coupon code or that the code itself was not found.\n- dw.campaign.CouponStatusCodes.COUPON_DISABLED = Indicates that coupon is not enabled.\n- dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code exceeded.\n- dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code and customer exceeded.\n- dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code, customer and time exceeded.\n- dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION = Indicates that coupon is not assigned to an active promotion.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "createcouponlineitemexception", + "dw.order.createcouponlineitemexception", + "dw/order" + ], + "title": "CreateCouponLineItemException" + }, + { + "description": "Returns one of the error codes listed in the class doc.", + "id": "script-api:dw/order/CreateCouponLineItemException#errorCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateCouponLineItemException", + "qualifiedName": "dw.order.CreateCouponLineItemException.errorCode", + "sections": [ + { + "body": "Returns one of the error codes listed in the class doc.", + "heading": "Description" + } + ], + "signature": "readonly errorCode: string", + "source": "script-api", + "tags": [ + "errorcode", + "createcouponlineitemexception.errorcode" + ], + "title": "CreateCouponLineItemException.errorCode" + }, + { + "description": "Returns one of the error codes listed in the class doc.", + "id": "script-api:dw/order/CreateCouponLineItemException#getErrorCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/CreateCouponLineItemException", + "qualifiedName": "dw.order.CreateCouponLineItemException.getErrorCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns one of the error codes listed in the class doc.", + "heading": "Description" + } + ], + "signature": "getErrorCode(): string", + "source": "script-api", + "tags": [ + "geterrorcode", + "createcouponlineitemexception.geterrorcode" + ], + "title": "CreateCouponLineItemException.getErrorCode" + }, + { + "description": "This APIException is thrown by method dw.order.OrderMgr.createOrder to indicate no Order could be created from the Basket.", + "id": "script-api:dw/order/CreateOrderException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateOrderException", + "sections": [ + { + "body": "This APIException is thrown by method dw.order.OrderMgr.createOrder\nto indicate no Order could be created from the Basket.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "createorderexception", + "dw.order.createorderexception", + "dw/order" + ], + "title": "CreateOrderException" + }, + { + "description": "This exception is thrown by BasketMgr.createTemporaryBasket to indicate that the open temporary basket limit for the current session customer is already reached, and therefore no new temporary basket could be created.", + "id": "script-api:dw/order/CreateTemporaryBasketLimitExceededException", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.CreateTemporaryBasketLimitExceededException", + "sections": [ + { + "body": "This exception is thrown by BasketMgr.createTemporaryBasket to indicate that the open temporary basket\nlimit for the current session customer is already reached, and therefore no new temporary basket could be created.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "createtemporarybasketlimitexceededexception", + "dw.order.createtemporarybasketlimitexceededexception", + "dw/order" + ], + "title": "CreateTemporaryBasketLimitExceededException" + }, + { + "description": "Represents a Gift Certificate that can be used to purchase products.", + "id": "script-api:dw/order/GiftCertificate", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificate", + "sections": [ + { + "body": "Represents a Gift Certificate that can be used to purchase\nproducts.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "giftcertificate", + "dw.order.giftcertificate", + "dw/order" + ], + "title": "GiftCertificate" + }, + { + "deprecated": { + "message": "Use getGiftCertificateCode" + }, + "description": "Returns the code of the gift certificate. This redemption code is send to gift certificate recipient.", + "id": "script-api:dw/order/GiftCertificate#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.ID", + "sections": [ + { + "body": "Returns the code of the gift certificate. This redemption code is send to\ngift certificate recipient.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "giftcertificate.id" + ], + "title": "GiftCertificate.ID" + }, + { + "description": "Represents a status of 'issued', which indicates that the Gift Certificate has been created and that it can be used to purchase products.", + "id": "script-api:dw/order/GiftCertificate#STATUS_ISSUED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_ISSUED", + "sections": [ + { + "body": "Represents a status of 'issued', which indicates that the Gift Certificate\nhas been created and that it can be used to purchase products.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_ISSUED = 1", + "source": "script-api", + "tags": [ + "status_issued", + "giftcertificate.status_issued" + ], + "title": "GiftCertificate.STATUS_ISSUED" + }, + { + "description": "Represents a status of 'issued', which indicates that the Gift Certificate has been created and that it can be used to purchase products.", + "id": "script-api:dw/order/GiftCertificate#STATUS_ISSUED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_ISSUED", + "sections": [ + { + "body": "Represents a status of 'issued', which indicates that the Gift Certificate\nhas been created and that it can be used to purchase products.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_ISSUED = 1", + "source": "script-api", + "tags": [ + "status_issued", + "giftcertificate.status_issued" + ], + "title": "GiftCertificate.STATUS_ISSUED" + }, + { + "description": "Represents a status of 'partially redeemed', which indicates that the Gift Certificate has been used to purchase products, but that there is still a balance on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#STATUS_PARTIALLY_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PARTIALLY_REDEEMED", + "sections": [ + { + "body": "Represents a status of 'partially redeemed', which indicates that the Gift Certificate\nhas been used to purchase products, but that there is still a balance on\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIALLY_REDEEMED = 2", + "source": "script-api", + "tags": [ + "status_partially_redeemed", + "giftcertificate.status_partially_redeemed" + ], + "title": "GiftCertificate.STATUS_PARTIALLY_REDEEMED" + }, + { + "description": "Represents a status of 'partially redeemed', which indicates that the Gift Certificate has been used to purchase products, but that there is still a balance on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#STATUS_PARTIALLY_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PARTIALLY_REDEEMED", + "sections": [ + { + "body": "Represents a status of 'partially redeemed', which indicates that the Gift Certificate\nhas been used to purchase products, but that there is still a balance on\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIALLY_REDEEMED = 2", + "source": "script-api", + "tags": [ + "status_partially_redeemed", + "giftcertificate.status_partially_redeemed" + ], + "title": "GiftCertificate.STATUS_PARTIALLY_REDEEMED" + }, + { + "description": "Represents a status of 'pending', which indicates that the Gift Certificate has been created but that it cannot be used yet.", + "id": "script-api:dw/order/GiftCertificate#STATUS_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PENDING", + "sections": [ + { + "body": "Represents a status of 'pending', which indicates that the Gift Certificate\nhas been created but that it cannot be used yet.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PENDING = 0", + "source": "script-api", + "tags": [ + "status_pending", + "giftcertificate.status_pending" + ], + "title": "GiftCertificate.STATUS_PENDING" + }, + { + "description": "Represents a status of 'pending', which indicates that the Gift Certificate has been created but that it cannot be used yet.", + "id": "script-api:dw/order/GiftCertificate#STATUS_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_PENDING", + "sections": [ + { + "body": "Represents a status of 'pending', which indicates that the Gift Certificate\nhas been created but that it cannot be used yet.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PENDING = 0", + "source": "script-api", + "tags": [ + "status_pending", + "giftcertificate.status_pending" + ], + "title": "GiftCertificate.STATUS_PENDING" + }, + { + "description": "Represents a status of 'redeemed', which indicates that the Gift Certificate has been used and no longer contains a balance.", + "id": "script-api:dw/order/GiftCertificate#STATUS_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_REDEEMED", + "sections": [ + { + "body": "Represents a status of 'redeemed', which indicates that the Gift Certificate\nhas been used and no longer contains a balance.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_REDEEMED = 3", + "source": "script-api", + "tags": [ + "status_redeemed", + "giftcertificate.status_redeemed" + ], + "title": "GiftCertificate.STATUS_REDEEMED" + }, + { + "description": "Represents a status of 'redeemed', which indicates that the Gift Certificate has been used and no longer contains a balance.", + "id": "script-api:dw/order/GiftCertificate#STATUS_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.STATUS_REDEEMED", + "sections": [ + { + "body": "Represents a status of 'redeemed', which indicates that the Gift Certificate\nhas been used and no longer contains a balance.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_REDEEMED = 3", + "source": "script-api", + "tags": [ + "status_redeemed", + "giftcertificate.status_redeemed" + ], + "title": "GiftCertificate.STATUS_REDEEMED" + }, + { + "description": "Returns the original amount on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.amount", + "sections": [ + { + "body": "Returns the original amount on the gift certificate.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "giftcertificate.amount" + ], + "title": "GiftCertificate.amount" + }, + { + "description": "Returns the balance on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#balance", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.balance", + "sections": [ + { + "body": "Returns the balance on the gift certificate.", + "heading": "Description" + } + ], + "signature": "readonly balance: Money", + "source": "script-api", + "tags": [ + "balance", + "giftcertificate.balance" + ], + "title": "GiftCertificate.balance" + }, + { + "description": "Returns the description string.", + "id": "script-api:dw/order/GiftCertificate#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.description", + "sections": [ + { + "body": "Returns the description string.", + "heading": "Description" + } + ], + "signature": "description: string", + "source": "script-api", + "tags": [ + "description", + "giftcertificate.description" + ], + "title": "GiftCertificate.description" + }, + { + "description": "Returns true if the Gift Certificate is enabled, false otherwise.", + "id": "script-api:dw/order/GiftCertificate#enabled", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.enabled", + "sections": [ + { + "body": "Returns true if the Gift Certificate is enabled, false otherwise.", + "heading": "Description" + } + ], + "signature": "enabled: boolean", + "source": "script-api", + "tags": [ + "enabled", + "giftcertificate.enabled" + ], + "title": "GiftCertificate.enabled" + }, + { + "description": "Returns the original amount on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the original amount on the gift certificate.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "giftcertificate.getamount" + ], + "title": "GiftCertificate.getAmount" + }, + { + "description": "Returns the balance on the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getBalance", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getBalance", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the balance on the gift certificate.", + "heading": "Description" + } + ], + "signature": "getBalance(): Money", + "source": "script-api", + "tags": [ + "getbalance", + "giftcertificate.getbalance" + ], + "title": "GiftCertificate.getBalance" + }, + { + "description": "Returns the description string.", + "id": "script-api:dw/order/GiftCertificate#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the description string.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "giftcertificate.getdescription" + ], + "title": "GiftCertificate.getDescription" + }, + { + "description": "Returns the code of the gift certificate. This redemption code is send to gift certificate recipient.", + "id": "script-api:dw/order/GiftCertificate#getGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getGiftCertificateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the code of the gift certificate. This redemption code is send to\ngift certificate recipient.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateCode(): string", + "source": "script-api", + "tags": [ + "getgiftcertificatecode", + "giftcertificate.getgiftcertificatecode" + ], + "title": "GiftCertificate.getGiftCertificateCode" + }, + { + "deprecated": { + "message": "Use getGiftCertificateCode" + }, + "description": "Returns the code of the gift certificate. This redemption code is send to gift certificate recipient.", + "id": "script-api:dw/order/GiftCertificate#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the code of the gift certificate. This redemption code is send to\ngift certificate recipient.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "giftcertificate.getid" + ], + "title": "GiftCertificate.getID" + }, + { + "description": "Returns the masked gift certificate code with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/GiftCertificate#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMaskedGiftCertificateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the last 4 characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "getMaskedGiftCertificateCode(): string", + "source": "script-api", + "tags": [ + "getmaskedgiftcertificatecode", + "giftcertificate.getmaskedgiftcertificatecode" + ], + "title": "GiftCertificate.getMaskedGiftCertificateCode" + }, + { + "description": "Returns the masked gift certificate code with all but the specified number of characters replaced with a '*' character.", + "id": "script-api:dw/order/GiftCertificate#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ignore", + "type": "number" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMaskedGiftCertificateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the specified number of characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "getMaskedGiftCertificateCode(ignore: number): string", + "source": "script-api", + "tags": [ + "getmaskedgiftcertificatecode", + "giftcertificate.getmaskedgiftcertificatecode" + ], + "throws": [ + { + "description": "if ignore is negative.", + "type": "IllegalArgumentException" + } + ], + "title": "GiftCertificate.getMaskedGiftCertificateCode" + }, + { + "description": "Returns the merchant ID of the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getMerchantID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMerchantID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the merchant ID of the gift certificate.", + "heading": "Description" + } + ], + "signature": "getMerchantID(): string", + "source": "script-api", + "tags": [ + "getmerchantid", + "giftcertificate.getmerchantid" + ], + "title": "GiftCertificate.getMerchantID" + }, + { + "description": "Returns the message to include in the email of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the message to include in the email of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "getMessage(): string", + "source": "script-api", + "tags": [ + "getmessage", + "giftcertificate.getmessage" + ], + "title": "GiftCertificate.getMessage" + }, + { + "description": "Returns the order number", + "id": "script-api:dw/order/GiftCertificate#getOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order number", + "heading": "Description" + } + ], + "signature": "getOrderNo(): string", + "source": "script-api", + "tags": [ + "getorderno", + "giftcertificate.getorderno" + ], + "title": "GiftCertificate.getOrderNo" + }, + { + "description": "Returns the email address of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getRecipientEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the email address of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "getRecipientEmail(): string", + "source": "script-api", + "tags": [ + "getrecipientemail", + "giftcertificate.getrecipientemail" + ], + "title": "GiftCertificate.getRecipientEmail" + }, + { + "description": "Returns the name of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#getRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getRecipientName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "getRecipientName(): string", + "source": "script-api", + "tags": [ + "getrecipientname", + "giftcertificate.getrecipientname" + ], + "title": "GiftCertificate.getRecipientName" + }, + { + "description": "Returns the name of the person or organization that sent the gift certificate or null if undefined.", + "id": "script-api:dw/order/GiftCertificate#getSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getSenderName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the name of the person or organization that\nsent the gift certificate or null if undefined.", + "heading": "Description" + } + ], + "signature": "getSenderName(): string | null", + "source": "script-api", + "tags": [ + "getsendername", + "giftcertificate.getsendername" + ], + "title": "GiftCertificate.getSenderName" + }, + { + "description": "Returns the status where the possible values are STATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED or STATUS_REDEEMED.", + "id": "script-api:dw/order/GiftCertificate#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.getStatus", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status where the possible values are\nSTATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED\nor STATUS_REDEEMED.", + "heading": "Description" + } + ], + "signature": "getStatus(): number", + "source": "script-api", + "tags": [ + "getstatus", + "giftcertificate.getstatus" + ], + "title": "GiftCertificate.getStatus" + }, + { + "description": "Returns the code of the gift certificate. This redemption code is send to gift certificate recipient.", + "id": "script-api:dw/order/GiftCertificate#giftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.giftCertificateCode", + "sections": [ + { + "body": "Returns the code of the gift certificate. This redemption code is send to\ngift certificate recipient.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateCode: string", + "source": "script-api", + "tags": [ + "giftcertificatecode", + "giftcertificate.giftcertificatecode" + ], + "title": "GiftCertificate.giftCertificateCode" + }, + { + "description": "Returns true if the Gift Certificate is enabled, false otherwise.", + "id": "script-api:dw/order/GiftCertificate#isEnabled", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.isEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the Gift Certificate is enabled, false otherwise.", + "heading": "Description" + } + ], + "signature": "isEnabled(): boolean", + "source": "script-api", + "tags": [ + "isenabled", + "giftcertificate.isenabled" + ], + "title": "GiftCertificate.isEnabled" + }, + { + "description": "Returns the masked gift certificate code with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/GiftCertificate#maskedGiftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.maskedGiftCertificateCode", + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the last 4 characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "readonly maskedGiftCertificateCode: string", + "source": "script-api", + "tags": [ + "maskedgiftcertificatecode", + "giftcertificate.maskedgiftcertificatecode" + ], + "title": "GiftCertificate.maskedGiftCertificateCode" + }, + { + "description": "Returns the merchant ID of the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#merchantID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.merchantID", + "sections": [ + { + "body": "Returns the merchant ID of the gift certificate.", + "heading": "Description" + } + ], + "signature": "readonly merchantID: string", + "source": "script-api", + "tags": [ + "merchantid", + "giftcertificate.merchantid" + ], + "title": "GiftCertificate.merchantID" + }, + { + "description": "Returns the message to include in the email of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#message", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.message", + "sections": [ + { + "body": "Returns the message to include in the email of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "message: string", + "source": "script-api", + "tags": [ + "message", + "giftcertificate.message" + ], + "title": "GiftCertificate.message" + }, + { + "description": "Returns the order number", + "id": "script-api:dw/order/GiftCertificate#orderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.orderNo", + "sections": [ + { + "body": "Returns the order number", + "heading": "Description" + } + ], + "signature": "orderNo: string", + "source": "script-api", + "tags": [ + "orderno", + "giftcertificate.orderno" + ], + "title": "GiftCertificate.orderNo" + }, + { + "description": "Returns the email address of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#recipientEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.recipientEmail", + "sections": [ + { + "body": "Returns the email address of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "recipientEmail: string", + "source": "script-api", + "tags": [ + "recipientemail", + "giftcertificate.recipientemail" + ], + "title": "GiftCertificate.recipientEmail" + }, + { + "description": "Returns the name of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#recipientName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.recipientName", + "sections": [ + { + "body": "Returns the name of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "recipientName: string", + "source": "script-api", + "tags": [ + "recipientname", + "giftcertificate.recipientname" + ], + "title": "GiftCertificate.recipientName" + }, + { + "description": "Returns the name of the person or organization that sent the gift certificate or null if undefined.", + "id": "script-api:dw/order/GiftCertificate#senderName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.senderName", + "sections": [ + { + "body": "Returns the name of the person or organization that\nsent the gift certificate or null if undefined.", + "heading": "Description" + } + ], + "signature": "senderName: string | null", + "source": "script-api", + "tags": [ + "sendername", + "giftcertificate.sendername" + ], + "title": "GiftCertificate.senderName" + }, + { + "description": "An optional description that you can use to categorize the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setDescription", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "description", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "An optional description that you can use to categorize the\ngift certificate.", + "heading": "Description" + } + ], + "signature": "setDescription(description: string): void", + "source": "script-api", + "tags": [ + "setdescription", + "giftcertificate.setdescription" + ], + "title": "GiftCertificate.setDescription" + }, + { + "description": "Controls if the Gift Certificate is enabled.", + "id": "script-api:dw/order/GiftCertificate#setEnabled", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "enabled", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setEnabled", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Controls if the Gift Certificate is enabled.", + "heading": "Description" + } + ], + "signature": "setEnabled(enabled: boolean): void", + "source": "script-api", + "tags": [ + "setenabled", + "giftcertificate.setenabled" + ], + "title": "GiftCertificate.setEnabled" + }, + { + "description": "Sets the message to include in the email of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setMessage", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the message to include in the email of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "setMessage(message: string): void", + "source": "script-api", + "tags": [ + "setmessage", + "giftcertificate.setmessage" + ], + "title": "GiftCertificate.setMessage" + }, + { + "description": "Sets the order number", + "id": "script-api:dw/order/GiftCertificate#setOrderNo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setOrderNo", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the order number", + "heading": "Description" + } + ], + "signature": "setOrderNo(orderNo: string): void", + "source": "script-api", + "tags": [ + "setorderno", + "giftcertificate.setorderno" + ], + "title": "GiftCertificate.setOrderNo" + }, + { + "description": "Sets the email address of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "recipientEmail", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setRecipientEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the email address of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "setRecipientEmail(recipientEmail: string): void", + "source": "script-api", + "tags": [ + "setrecipientemail", + "giftcertificate.setrecipientemail" + ], + "title": "GiftCertificate.setRecipientEmail" + }, + { + "description": "Sets the name of the person receiving the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setRecipientName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "recipient", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setRecipientName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the person receiving\nthe gift certificate.", + "heading": "Description" + } + ], + "signature": "setRecipientName(recipient: string): void", + "source": "script-api", + "tags": [ + "setrecipientname", + "giftcertificate.setrecipientname" + ], + "title": "GiftCertificate.setRecipientName" + }, + { + "description": "Sets the name of the person or organization that sent the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setSenderName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "sender", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setSenderName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the person or organization that\nsent the gift certificate.", + "heading": "Description" + } + ], + "signature": "setSenderName(sender: string): void", + "source": "script-api", + "tags": [ + "setsendername", + "giftcertificate.setsendername" + ], + "title": "GiftCertificate.setSenderName" + }, + { + "description": "Sets the status of the gift certificate.", + "id": "script-api:dw/order/GiftCertificate#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status of the gift certificate.\n\nPossible values are: STATUS_ISSUED,\nSTATUS_PENDING, STATUS_PARTIALLY_REDEEMED\nand STATUS_REDEEMED.", + "heading": "Description" + } + ], + "signature": "setStatus(status: number): void", + "source": "script-api", + "tags": [ + "setstatus", + "giftcertificate.setstatus" + ], + "title": "GiftCertificate.setStatus" + }, + { + "description": "Returns the status where the possible values are STATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED or STATUS_REDEEMED.", + "id": "script-api:dw/order/GiftCertificate#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificate", + "qualifiedName": "dw.order.GiftCertificate.status", + "sections": [ + { + "body": "Returns the status where the possible values are\nSTATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED\nor STATUS_REDEEMED.", + "heading": "Description" + } + ], + "signature": "status: number", + "source": "script-api", + "tags": [ + "status", + "giftcertificate.status" + ], + "title": "GiftCertificate.status" + }, + { + "description": "Represents a Gift Certificate line item in the cart. When an order is processed, a Gift Certificate is created based on the information in the Gift Certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateLineItem", + "sections": [ + { + "body": "Represents a Gift Certificate line item in the cart. When an order is\nprocessed, a Gift Certificate is created based on the information in\nthe Gift Certificate line item.", + "heading": "Description" + }, + { + "body": "Extends `LineItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "giftcertificatelineitem", + "dw.order.giftcertificatelineitem", + "dw/order" + ], + "title": "GiftCertificateLineItem" + }, + { + "description": "Returns the ID of the gift certificate that this line item was used to create. If this line item has not been used to create a Gift Certificate, this method returns null.", + "id": "script-api:dw/order/GiftCertificateLineItem#getGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getGiftCertificateID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the gift certificate that this line item\nwas used to create. If this line item has not been used to create\na Gift Certificate, this method returns null.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateID(): string | null", + "source": "script-api", + "tags": [ + "getgiftcertificateid", + "giftcertificatelineitem.getgiftcertificateid" + ], + "title": "GiftCertificateLineItem.getGiftCertificateID" + }, + { + "description": "Returns the message to include in the email of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#getMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the message to include in the email of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "getMessage(): string", + "source": "script-api", + "tags": [ + "getmessage", + "giftcertificatelineitem.getmessage" + ], + "title": "GiftCertificateLineItem.getMessage" + }, + { + "description": "Returns the associated ProductListItem.", + "id": "script-api:dw/order/GiftCertificateLineItem#getProductListItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getProductListItem", + "returns": { + "type": "ProductListItem | null" + }, + "sections": [ + { + "body": "Returns the associated ProductListItem.", + "heading": "Description" + } + ], + "signature": "getProductListItem(): ProductListItem | null", + "source": "script-api", + "tags": [ + "getproductlistitem", + "giftcertificatelineitem.getproductlistitem" + ], + "title": "GiftCertificateLineItem.getProductListItem" + }, + { + "description": "Returns the email address of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#getRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getRecipientEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the email address of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "getRecipientEmail(): string", + "source": "script-api", + "tags": [ + "getrecipientemail", + "giftcertificatelineitem.getrecipientemail" + ], + "title": "GiftCertificateLineItem.getRecipientEmail" + }, + { + "description": "Returns the name of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#getRecipientName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getRecipientName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the person receiving the gift certificate line item.", + "heading": "Description" + } + ], + "signature": "getRecipientName(): string", + "source": "script-api", + "tags": [ + "getrecipientname", + "giftcertificatelineitem.getrecipientname" + ], + "title": "GiftCertificateLineItem.getRecipientName" + }, + { + "description": "Returns the name of the person or organization that sent the gift certificate line item or null if undefined.", + "id": "script-api:dw/order/GiftCertificateLineItem#getSenderName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getSenderName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the name of the person or organization that\nsent the gift certificate line item or null if undefined.", + "heading": "Description" + } + ], + "signature": "getSenderName(): string | null", + "source": "script-api", + "tags": [ + "getsendername", + "giftcertificatelineitem.getsendername" + ], + "title": "GiftCertificateLineItem.getSenderName" + }, + { + "description": "Returns the associated Shipment.", + "id": "script-api:dw/order/GiftCertificateLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.getShipment", + "returns": { + "type": "Shipment" + }, + "sections": [ + { + "body": "Returns the associated Shipment.", + "heading": "Description" + } + ], + "signature": "getShipment(): Shipment", + "source": "script-api", + "tags": [ + "getshipment", + "giftcertificatelineitem.getshipment" + ], + "title": "GiftCertificateLineItem.getShipment" + }, + { + "description": "Returns the ID of the gift certificate that this line item was used to create. If this line item has not been used to create a Gift Certificate, this method returns null.", + "id": "script-api:dw/order/GiftCertificateLineItem#giftCertificateID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.giftCertificateID", + "sections": [ + { + "body": "Returns the ID of the gift certificate that this line item\nwas used to create. If this line item has not been used to create\na Gift Certificate, this method returns null.", + "heading": "Description" + } + ], + "signature": "giftCertificateID: string | null", + "source": "script-api", + "tags": [ + "giftcertificateid", + "giftcertificatelineitem.giftcertificateid" + ], + "title": "GiftCertificateLineItem.giftCertificateID" + }, + { + "description": "Returns the message to include in the email of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#message", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.message", + "sections": [ + { + "body": "Returns the message to include in the email of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "message: string", + "source": "script-api", + "tags": [ + "message", + "giftcertificatelineitem.message" + ], + "title": "GiftCertificateLineItem.message" + }, + { + "description": "Returns the associated ProductListItem.", + "id": "script-api:dw/order/GiftCertificateLineItem#productListItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.productListItem", + "sections": [ + { + "body": "Returns the associated ProductListItem.", + "heading": "Description" + } + ], + "signature": "productListItem: ProductListItem | null", + "source": "script-api", + "tags": [ + "productlistitem", + "giftcertificatelineitem.productlistitem" + ], + "title": "GiftCertificateLineItem.productListItem" + }, + { + "description": "Returns the email address of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#recipientEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.recipientEmail", + "sections": [ + { + "body": "Returns the email address of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "recipientEmail: string", + "source": "script-api", + "tags": [ + "recipientemail", + "giftcertificatelineitem.recipientemail" + ], + "title": "GiftCertificateLineItem.recipientEmail" + }, + { + "description": "Returns the name of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#recipientName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.recipientName", + "sections": [ + { + "body": "Returns the name of the person receiving the gift certificate line item.", + "heading": "Description" + } + ], + "signature": "recipientName: string", + "source": "script-api", + "tags": [ + "recipientname", + "giftcertificatelineitem.recipientname" + ], + "title": "GiftCertificateLineItem.recipientName" + }, + { + "description": "Returns the name of the person or organization that sent the gift certificate line item or null if undefined.", + "id": "script-api:dw/order/GiftCertificateLineItem#senderName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.senderName", + "sections": [ + { + "body": "Returns the name of the person or organization that\nsent the gift certificate line item or null if undefined.", + "heading": "Description" + } + ], + "signature": "senderName: string | null", + "source": "script-api", + "tags": [ + "sendername", + "giftcertificatelineitem.sendername" + ], + "title": "GiftCertificateLineItem.senderName" + }, + { + "description": "Sets the ID of the gift certificate associated with this line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#setGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setGiftCertificateID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the ID of the gift certificate associated with this line item.", + "heading": "Description" + } + ], + "signature": "setGiftCertificateID(id: string): void", + "source": "script-api", + "tags": [ + "setgiftcertificateid", + "giftcertificatelineitem.setgiftcertificateid" + ], + "title": "GiftCertificateLineItem.setGiftCertificateID" + }, + { + "description": "Sets the message to include in the email of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#setMessage", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the message to include in the email of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "setMessage(message: string): void", + "source": "script-api", + "tags": [ + "setmessage", + "giftcertificatelineitem.setmessage" + ], + "title": "GiftCertificateLineItem.setMessage" + }, + { + "description": "Sets the associated ProductListItem.", + "id": "script-api:dw/order/GiftCertificateLineItem#setProductListItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productListItem", + "type": "ProductListItem" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setProductListItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the associated ProductListItem.\n\nThe product list item to be set must be of type gift certificate otherwise an exception is thrown.", + "heading": "Description" + } + ], + "signature": "setProductListItem(productListItem: ProductListItem): void", + "source": "script-api", + "tags": [ + "setproductlistitem", + "giftcertificatelineitem.setproductlistitem" + ], + "title": "GiftCertificateLineItem.setProductListItem" + }, + { + "description": "Sets the email address of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#setRecipientEmail", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "recipientEmail", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setRecipientEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the email address of the person receiving\nthe gift certificate line item.", + "heading": "Description" + } + ], + "signature": "setRecipientEmail(recipientEmail: string): void", + "source": "script-api", + "tags": [ + "setrecipientemail", + "giftcertificatelineitem.setrecipientemail" + ], + "title": "GiftCertificateLineItem.setRecipientEmail" + }, + { + "description": "Sets the name of the person receiving the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#setRecipientName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "recipient", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setRecipientName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the person receiving the gift certificate line item.", + "heading": "Description" + } + ], + "signature": "setRecipientName(recipient: string): void", + "source": "script-api", + "tags": [ + "setrecipientname", + "giftcertificatelineitem.setrecipientname" + ], + "title": "GiftCertificateLineItem.setRecipientName" + }, + { + "description": "Sets the name of the person or organization that sent the gift certificate line item.", + "id": "script-api:dw/order/GiftCertificateLineItem#setSenderName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "sender", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setSenderName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the person or organization that\nsent the gift certificate line item.", + "heading": "Description" + } + ], + "signature": "setSenderName(sender: string): void", + "source": "script-api", + "tags": [ + "setsendername", + "giftcertificatelineitem.setsendername" + ], + "title": "GiftCertificateLineItem.setSenderName" + }, + { + "description": "Associates the gift certificate line item with the specified shipment.", + "id": "script-api:dw/order/GiftCertificateLineItem#setShipment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.setShipment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Associates the gift certificate line item with the specified shipment.\n\nGift certificate line item and shipment must belong to the same line item ctnr.", + "heading": "Description" + } + ], + "signature": "setShipment(shipment: Shipment): void", + "source": "script-api", + "tags": [ + "setshipment", + "giftcertificatelineitem.setshipment" + ], + "title": "GiftCertificateLineItem.setShipment" + }, + { + "description": "Returns the associated Shipment.", + "id": "script-api:dw/order/GiftCertificateLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateLineItem", + "qualifiedName": "dw.order.GiftCertificateLineItem.shipment", + "sections": [ + { + "body": "Returns the associated Shipment.", + "heading": "Description" + } + ], + "signature": "shipment: Shipment", + "source": "script-api", + "tags": [ + "shipment", + "giftcertificatelineitem.shipment" + ], + "title": "GiftCertificateLineItem.shipment" + }, + { + "description": "The GiftCertificateMgr class contains a set of static methods for interacting with GiftCertificates.", + "id": "script-api:dw/order/GiftCertificateMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateMgr", + "sections": [ + { + "body": "The GiftCertificateMgr class contains a set of static methods for\ninteracting with GiftCertificates.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "giftcertificatemgr", + "dw.order.giftcertificatemgr", + "dw/order" + ], + "title": "GiftCertificateMgr" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate is currently disabled.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_DISABLED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis currently disabled.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_DISABLED = \"GIFTCERTIFICATE-100\"", + "source": "script-api", + "tags": [ + "gc_error_disabled", + "giftcertificatemgr.gc_error_disabled" + ], + "title": "GiftCertificateMgr.GC_ERROR_DISABLED" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate is currently disabled.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_DISABLED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis currently disabled.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_DISABLED = \"GIFTCERTIFICATE-100\"", + "source": "script-api", + "tags": [ + "gc_error_disabled", + "giftcertificatemgr.gc_error_disabled" + ], + "title": "GiftCertificateMgr.GC_ERROR_DISABLED" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\ndoes not have a sufficient balance to perform the requested\noperation.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INSUFFICIENT_BALANCE = \"GIFTCERTIFICATE-110\"", + "source": "script-api", + "tags": [ + "gc_error_insufficient_balance", + "giftcertificatemgr.gc_error_insufficient_balance" + ], + "title": "GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\ndoes not have a sufficient balance to perform the requested\noperation.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INSUFFICIENT_BALANCE = \"GIFTCERTIFICATE-110\"", + "source": "script-api", + "tags": [ + "gc_error_insufficient_balance", + "giftcertificatemgr.gc_error_insufficient_balance" + ], + "title": "GiftCertificateMgr.GC_ERROR_INSUFFICIENT_BALANCE" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate Amount was not valid.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_AMOUNT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nAmount was not valid.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INVALID_AMOUNT = \"GIFTCERTIFICATE-140\"", + "source": "script-api", + "tags": [ + "gc_error_invalid_amount", + "giftcertificatemgr.gc_error_invalid_amount" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate Amount was not valid.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_AMOUNT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nAmount was not valid.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INVALID_AMOUNT = \"GIFTCERTIFICATE-140\"", + "source": "script-api", + "tags": [ + "gc_error_invalid_amount", + "giftcertificatemgr.gc_error_invalid_amount" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_AMOUNT" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate ID was not valid.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_CODE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nID was not valid.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INVALID_CODE = \"GIFTCERTIFICATE-150\"", + "source": "script-api", + "tags": [ + "gc_error_invalid_code", + "giftcertificatemgr.gc_error_invalid_code" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_CODE" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate ID was not valid.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_INVALID_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_INVALID_CODE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nID was not valid.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_INVALID_CODE = \"GIFTCERTIFICATE-150\"", + "source": "script-api", + "tags": [ + "gc_error_invalid_code", + "giftcertificatemgr.gc_error_invalid_code" + ], + "title": "GiftCertificateMgr.GC_ERROR_INVALID_CODE" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_PENDING", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_PENDING = \"GIFTCERTIFICATE-130\"", + "source": "script-api", + "tags": [ + "gc_error_pending", + "giftcertificatemgr.gc_error_pending" + ], + "title": "GiftCertificateMgr.GC_ERROR_PENDING" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_PENDING", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_PENDING = \"GIFTCERTIFICATE-130\"", + "source": "script-api", + "tags": [ + "gc_error_pending", + "giftcertificatemgr.gc_error_pending" + ], + "title": "GiftCertificateMgr.GC_ERROR_PENDING" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_REDEEMED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_REDEEMED = \"GIFTCERTIFICATE-120\"", + "source": "script-api", + "tags": [ + "gc_error_redeemed", + "giftcertificatemgr.gc_error_redeemed" + ], + "title": "GiftCertificateMgr.GC_ERROR_REDEEMED" + }, + { + "deprecated": { + "message": "Use dw.order.GiftCertificateStatusCodes instead." + }, + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateMgr#GC_ERROR_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.GC_ERROR_REDEEMED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GC_ERROR_REDEEMED = \"GIFTCERTIFICATE-120\"", + "source": "script-api", + "tags": [ + "gc_error_redeemed", + "giftcertificatemgr.gc_error_redeemed" + ], + "title": "GiftCertificateMgr.GC_ERROR_REDEEMED" + }, + { + "description": "Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create the Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift Certificate will not be created.", + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "number" + }, + { + "name": "code", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "returns": { + "type": "GiftCertificate" + }, + "sections": [ + { + "body": "Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create\nthe Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift\nCertificate will not be created.", + "heading": "Description" + } + ], + "signature": "static createGiftCertificate(amount: number, code: string | null): GiftCertificate", + "source": "script-api", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "description": "Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.", + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "returns": { + "type": "GiftCertificate" + }, + "sections": [ + { + "body": "Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.", + "heading": "Description" + } + ], + "signature": "static createGiftCertificate(amount: number): GiftCertificate", + "source": "script-api", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "description": "Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create the Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift Certificate will not be created.", + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "number" + }, + { + "name": "code", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "returns": { + "type": "GiftCertificate" + }, + "sections": [ + { + "body": "Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create\nthe Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift\nCertificate will not be created.", + "heading": "Description" + } + ], + "signature": "static createGiftCertificate(amount: number, code: string | null): GiftCertificate", + "source": "script-api", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "description": "Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.", + "id": "script-api:dw/order/GiftCertificateMgr#createGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.createGiftCertificate", + "returns": { + "type": "GiftCertificate" + }, + "sections": [ + { + "body": "Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.", + "heading": "Description" + } + ], + "signature": "static createGiftCertificate(amount: number): GiftCertificate", + "source": "script-api", + "tags": [ + "creategiftcertificate", + "giftcertificatemgr.creategiftcertificate" + ], + "title": "GiftCertificateMgr.createGiftCertificate" + }, + { + "deprecated": { + "message": "Use getGiftCertificateByCode" + }, + "description": "Returns the Gift Certificate identified by the specified gift certificate code.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificate", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified\ngift certificate code.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificate(giftCertificateCode: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificate", + "giftcertificatemgr.getgiftcertificate" + ], + "title": "GiftCertificateMgr.getGiftCertificate" + }, + { + "deprecated": { + "message": "Use getGiftCertificateByCode" + }, + "description": "Returns the Gift Certificate identified by the specified gift certificate code.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificate", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified\ngift certificate code.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificate(giftCertificateCode: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificate", + "giftcertificatemgr.getgiftcertificate" + ], + "title": "GiftCertificateMgr.getGiftCertificate" + }, + { + "description": "Returns the Gift Certificate identified by the specified gift certificate code.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByCode", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified\ngift certificate code.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificateByCode(giftCertificateCode: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificatebycode", + "giftcertificatemgr.getgiftcertificatebycode" + ], + "title": "GiftCertificateMgr.getGiftCertificateByCode" + }, + { + "description": "Returns the Gift Certificate identified by the specified gift certificate code.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByCode", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified\ngift certificate code.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificateByCode(giftCertificateCode: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificatebycode", + "giftcertificatemgr.getgiftcertificatebycode" + ], + "title": "GiftCertificateMgr.getGiftCertificateByCode" + }, + { + "description": "Returns the Gift Certificate identified by the specified merchant ID.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByMerchantID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "merchantID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByMerchantID", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified merchant ID.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificateByMerchantID(merchantID: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificatebymerchantid", + "giftcertificatemgr.getgiftcertificatebymerchantid" + ], + "title": "GiftCertificateMgr.getGiftCertificateByMerchantID" + }, + { + "description": "Returns the Gift Certificate identified by the specified merchant ID.", + "id": "script-api:dw/order/GiftCertificateMgr#getGiftCertificateByMerchantID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "merchantID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.getGiftCertificateByMerchantID", + "returns": { + "type": "GiftCertificate | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate identified by the specified merchant ID.", + "heading": "Description" + } + ], + "signature": "static getGiftCertificateByMerchantID(merchantID: string): GiftCertificate | null", + "source": "script-api", + "tags": [ + "getgiftcertificatebymerchantid", + "giftcertificatemgr.getgiftcertificatebymerchantid" + ], + "title": "GiftCertificateMgr.getGiftCertificateByMerchantID" + }, + { + "description": "Redeems an amount from a Gift Certificate. The Gift Certificate ID is specified in the OrderPaymentInstrument and the amount specified in the PaymentTransaction associated with the OrderPaymentInstrument. If the PaymentTransaction.getTransactionID() is not null, the value returned by this method is used as the 'Order Number' for the redemption transaction. The 'Order Number' is visible via the Business Manager.", + "id": "script-api:dw/order/GiftCertificateMgr#redeemGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.redeemGiftCertificate", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Redeems an amount from a Gift Certificate. The Gift Certificate ID\nis specified in the OrderPaymentInstrument and the amount\nspecified in the PaymentTransaction associated with the\nOrderPaymentInstrument. If the PaymentTransaction.getTransactionID()\nis not null, the value returned by this method is used as the\n'Order Number' for the redemption transaction. The 'Order Number' is\nvisible via the Business Manager.", + "heading": "Description" + } + ], + "signature": "static redeemGiftCertificate(paymentInstrument: OrderPaymentInstrument): Status", + "source": "script-api", + "tags": [ + "redeemgiftcertificate", + "giftcertificatemgr.redeemgiftcertificate" + ], + "title": "GiftCertificateMgr.redeemGiftCertificate" + }, + { + "description": "Redeems an amount from a Gift Certificate. The Gift Certificate ID is specified in the OrderPaymentInstrument and the amount specified in the PaymentTransaction associated with the OrderPaymentInstrument. If the PaymentTransaction.getTransactionID() is not null, the value returned by this method is used as the 'Order Number' for the redemption transaction. The 'Order Number' is visible via the Business Manager.", + "id": "script-api:dw/order/GiftCertificateMgr#redeemGiftCertificate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "paymentInstrument", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/order/GiftCertificateMgr", + "qualifiedName": "dw.order.GiftCertificateMgr.redeemGiftCertificate", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Redeems an amount from a Gift Certificate. The Gift Certificate ID\nis specified in the OrderPaymentInstrument and the amount\nspecified in the PaymentTransaction associated with the\nOrderPaymentInstrument. If the PaymentTransaction.getTransactionID()\nis not null, the value returned by this method is used as the\n'Order Number' for the redemption transaction. The 'Order Number' is\nvisible via the Business Manager.", + "heading": "Description" + } + ], + "signature": "static redeemGiftCertificate(paymentInstrument: OrderPaymentInstrument): Status", + "source": "script-api", + "tags": [ + "redeemgiftcertificate", + "giftcertificatemgr.redeemgiftcertificate" + ], + "title": "GiftCertificateMgr.redeemGiftCertificate" + }, + { + "description": "Helper class containing status codes for the various errors that can occur when redeeming a gift certificate. One of these codes is returned as part of a Status object when a unsuccessful call to the `RedeemGiftCertificate` pipelet is made.", + "id": "script-api:dw/order/GiftCertificateStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.GiftCertificateStatusCodes", + "sections": [ + { + "body": "Helper class containing status codes for the various errors that can occur\nwhen redeeming a gift certificate. One of these codes is returned as part of\na Status object when a unsuccessful call to the\n`RedeemGiftCertificate` pipelet is made.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "giftcertificatestatuscodes", + "dw.order.giftcertificatestatuscodes", + "dw/order" + ], + "title": "GiftCertificateStatusCodes" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate was in a different currency than the Basket.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_CURRENCY_MISMATCH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nwas in a different currency than the Basket.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_CURRENCY_MISMATCH = \"GIFTCERTIFICATE_CURRENCY_MISMATCH\"", + "source": "script-api", + "tags": [ + "giftcertificate_currency_mismatch", + "giftcertificatestatuscodes.giftcertificate_currency_mismatch" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate was in a different currency than the Basket.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_CURRENCY_MISMATCH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nwas in a different currency than the Basket.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_CURRENCY_MISMATCH = \"GIFTCERTIFICATE_CURRENCY_MISMATCH\"", + "source": "script-api", + "tags": [ + "giftcertificate_currency_mismatch", + "giftcertificatestatuscodes.giftcertificate_currency_mismatch" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_CURRENCY_MISMATCH" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate is currently disabled.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis currently disabled.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_DISABLED = \"GIFTCERTIFICATE_DISABLED\"", + "source": "script-api", + "tags": [ + "giftcertificate_disabled", + "giftcertificatestatuscodes.giftcertificate_disabled" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate is currently disabled.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_DISABLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis currently disabled.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_DISABLED = \"GIFTCERTIFICATE_DISABLED\"", + "source": "script-api", + "tags": [ + "giftcertificate_disabled", + "giftcertificatestatuscodes.giftcertificate_disabled" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_DISABLED" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\ndoes not have a sufficient balance to perform the requested\noperation.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_INSUFFICIENT_BALANCE = \"GIFTCERTIFICATE_INSUFFICIENT_BALANCE\"", + "source": "script-api", + "tags": [ + "giftcertificate_insufficient_balance", + "giftcertificatestatuscodes.giftcertificate_insufficient_balance" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\ndoes not have a sufficient balance to perform the requested\noperation.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_INSUFFICIENT_BALANCE = \"GIFTCERTIFICATE_INSUFFICIENT_BALANCE\"", + "source": "script-api", + "tags": [ + "giftcertificate_insufficient_balance", + "giftcertificatestatuscodes.giftcertificate_insufficient_balance" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_INSUFFICIENT_BALANCE" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate was not found.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nwas not found.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_NOT_FOUND = \"GIFTCERTIFICATE_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "giftcertificate_not_found", + "giftcertificatestatuscodes.giftcertificate_not_found" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate was not found.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_NOT_FOUND", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nwas not found.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_NOT_FOUND = \"GIFTCERTIFICATE_NOT_FOUND\"", + "source": "script-api", + "tags": [ + "giftcertificate_not_found", + "giftcertificatestatuscodes.giftcertificate_not_found" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_NOT_FOUND" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate is pending and is not available for use.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis pending and is not available for use.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_PENDING = \"GIFTCERTIFICATE_PENDING\"", + "source": "script-api", + "tags": [ + "giftcertificate_pending", + "giftcertificatestatuscodes.giftcertificate_pending" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate is pending and is not available for use.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_PENDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nis pending and is not available for use.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_PENDING = \"GIFTCERTIFICATE_PENDING\"", + "source": "script-api", + "tags": [ + "giftcertificate_pending", + "giftcertificatestatuscodes.giftcertificate_pending" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_PENDING" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_REDEEMED = \"GIFTCERTIFICATE_REDEEMED\"", + "source": "script-api", + "tags": [ + "giftcertificate_redeemed", + "giftcertificatestatuscodes.giftcertificate_redeemed" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED" + }, + { + "description": "Indicates that an error occurred because the Gift Certificate has been fully redeemed.", + "id": "script-api:dw/order/GiftCertificateStatusCodes#GIFTCERTIFICATE_REDEEMED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/GiftCertificateStatusCodes", + "qualifiedName": "dw.order.GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED", + "sections": [ + { + "body": "Indicates that an error occurred because the Gift Certificate\nhas been fully redeemed.", + "heading": "Description" + } + ], + "signature": "static readonly GIFTCERTIFICATE_REDEEMED = \"GIFTCERTIFICATE_REDEEMED\"", + "source": "script-api", + "tags": [ + "giftcertificate_redeemed", + "giftcertificatestatuscodes.giftcertificate_redeemed" + ], + "title": "GiftCertificateStatusCodes.GIFTCERTIFICATE_REDEEMED" + }, + { + "description": "The Invoice can be a debit or credit invoice, and is created from custom scripts using one of the methods dw.order.ShippingOrder.createInvoice, dw.order.Appeasement.createInvoice, dw.order.ReturnCase.createInvoice or dw.order.Return.createInvoice.", + "id": "script-api:dw/order/Invoice", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Invoice", + "sections": [ + { + "body": "The Invoice can be a debit or credit invoice, and is created\nfrom custom scripts using one of the methods\ndw.order.ShippingOrder.createInvoice,\ndw.order.Appeasement.createInvoice,\ndw.order.ReturnCase.createInvoice or\ndw.order.Return.createInvoice.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "invoice", + "dw.order.invoice", + "dw/order" + ], + "title": "Invoice" + }, + { + "description": "Sorting by creation date. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_CREATION_DATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_CREATION_DATE", + "sections": [ + { + "body": "Sorting by creation date. Use with method getPaymentTransactions as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_CREATION_DATE: any", + "source": "script-api", + "tags": [ + "orderby_creation_date", + "invoice.orderby_creation_date" + ], + "title": "Invoice.ORDERBY_CREATION_DATE" + }, + { + "description": "Sorting by creation date. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_CREATION_DATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_CREATION_DATE", + "sections": [ + { + "body": "Sorting by creation date. Use with method getPaymentTransactions as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_CREATION_DATE: any", + "source": "script-api", + "tags": [ + "orderby_creation_date", + "invoice.orderby_creation_date" + ], + "title": "Invoice.ORDERBY_CREATION_DATE" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "invoice.orderby_itemid" + ], + "title": "Invoice.ORDERBY_ITEMID" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "invoice.orderby_itemid" + ], + "title": "Invoice.ORDERBY_ITEMID" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method\ngetItems as an argument to method\ndw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "invoice.orderby_itemposition" + ], + "title": "Invoice.ORDERBY_ITEMPOSITION" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method\ngetItems as an argument to method\ndw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "invoice.orderby_itemposition" + ], + "title": "Invoice.ORDERBY_ITEMPOSITION" + }, + { + "description": "Reverse orders. Use as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_REVERSE", + "sections": [ + { + "body": "Reverse orders. Use as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_REVERSE: any", + "source": "script-api", + "tags": [ + "orderby_reverse", + "invoice.orderby_reverse" + ], + "title": "Invoice.ORDERBY_REVERSE" + }, + { + "description": "Reverse orders. Use as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_REVERSE", + "sections": [ + { + "body": "Reverse orders. Use as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_REVERSE: any", + "source": "script-api", + "tags": [ + "orderby_reverse", + "invoice.orderby_reverse" + ], + "title": "Invoice.ORDERBY_REVERSE" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "invoice.orderby_unsorted" + ], + "title": "Invoice.ORDERBY_UNSORTED" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Invoice#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "invoice.orderby_unsorted" + ], + "title": "Invoice.ORDERBY_UNSORTED" + }, + { + "description": "Selects the capture transactions. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_CAPTURE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_CAPTURE", + "sections": [ + { + "body": "Selects the capture transactions. Use with method getPaymentTransactions as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_CAPTURE: any", + "source": "script-api", + "tags": [ + "qualifier_capture", + "invoice.qualifier_capture" + ], + "title": "Invoice.QUALIFIER_CAPTURE" + }, + { + "description": "Selects the capture transactions. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_CAPTURE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_CAPTURE", + "sections": [ + { + "body": "Selects the capture transactions. Use with method getPaymentTransactions as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_CAPTURE: any", + "source": "script-api", + "tags": [ + "qualifier_capture", + "invoice.qualifier_capture" + ], + "title": "Invoice.QUALIFIER_CAPTURE" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "invoice.qualifier_productitems" + ], + "title": "Invoice.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "invoice.qualifier_productitems" + ], + "title": "Invoice.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the refund transactions. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_REFUND", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_REFUND", + "sections": [ + { + "body": "Selects the refund transactions. Use with method getPaymentTransactions as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_REFUND: any", + "source": "script-api", + "tags": [ + "qualifier_refund", + "invoice.qualifier_refund" + ], + "title": "Invoice.QUALIFIER_REFUND" + }, + { + "description": "Selects the refund transactions. Use with method getPaymentTransactions as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_REFUND", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_REFUND", + "sections": [ + { + "body": "Selects the refund transactions. Use with method getPaymentTransactions as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_REFUND: any", + "source": "script-api", + "tags": [ + "qualifier_refund", + "invoice.qualifier_refund" + ], + "title": "Invoice.QUALIFIER_REFUND" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "invoice.qualifier_serviceitems" + ], + "title": "Invoice.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Invoice#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "invoice.qualifier_serviceitems" + ], + "title": "Invoice.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Constant for Invoice Status Failed.", + "id": "script-api:dw/order/Invoice#STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_FAILED", + "sections": [ + { + "body": "Constant for Invoice Status Failed.\n\nThe invoice handling failed.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_FAILED: string", + "source": "script-api", + "tags": [ + "status_failed", + "invoice.status_failed" + ], + "title": "Invoice.STATUS_FAILED" + }, + { + "description": "Constant for Invoice Status Failed.", + "id": "script-api:dw/order/Invoice#STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_FAILED", + "sections": [ + { + "body": "Constant for Invoice Status Failed.\n\nThe invoice handling failed.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_FAILED: string", + "source": "script-api", + "tags": [ + "status_failed", + "invoice.status_failed" + ], + "title": "Invoice.STATUS_FAILED" + }, + { + "description": "Constant for Invoice Status Manual.", + "id": "script-api:dw/order/Invoice#STATUS_MANUAL", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_MANUAL", + "sections": [ + { + "body": "Constant for Invoice Status Manual.\n\nThe invoice is not paid but will not be handled automatically.\n\nA manual invoice handling (capture or refund) is necessary.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_MANUAL: string", + "source": "script-api", + "tags": [ + "status_manual", + "invoice.status_manual" + ], + "title": "Invoice.STATUS_MANUAL" + }, + { + "description": "Constant for Invoice Status Manual.", + "id": "script-api:dw/order/Invoice#STATUS_MANUAL", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_MANUAL", + "sections": [ + { + "body": "Constant for Invoice Status Manual.\n\nThe invoice is not paid but will not be handled automatically.\n\nA manual invoice handling (capture or refund) is necessary.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_MANUAL: string", + "source": "script-api", + "tags": [ + "status_manual", + "invoice.status_manual" + ], + "title": "Invoice.STATUS_MANUAL" + }, + { + "description": "Constant for Invoice Status Not Paid.", + "id": "script-api:dw/order/Invoice#STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_NOT_PAID", + "sections": [ + { + "body": "Constant for Invoice Status Not Paid.\n\nThe invoice is not paid and will be handled automatically.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NOT_PAID: string", + "source": "script-api", + "tags": [ + "status_not_paid", + "invoice.status_not_paid" + ], + "title": "Invoice.STATUS_NOT_PAID" + }, + { + "description": "Constant for Invoice Status Not Paid.", + "id": "script-api:dw/order/Invoice#STATUS_NOT_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_NOT_PAID", + "sections": [ + { + "body": "Constant for Invoice Status Not Paid.\n\nThe invoice is not paid and will be handled automatically.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NOT_PAID: string", + "source": "script-api", + "tags": [ + "status_not_paid", + "invoice.status_not_paid" + ], + "title": "Invoice.STATUS_NOT_PAID" + }, + { + "description": "Constant for Invoice Status Paid.", + "id": "script-api:dw/order/Invoice#STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_PAID", + "sections": [ + { + "body": "Constant for Invoice Status Paid.\n\nThe invoice was successfully paid.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PAID: string", + "source": "script-api", + "tags": [ + "status_paid", + "invoice.status_paid" + ], + "title": "Invoice.STATUS_PAID" + }, + { + "description": "Constant for Invoice Status Paid.", + "id": "script-api:dw/order/Invoice#STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.STATUS_PAID", + "sections": [ + { + "body": "Constant for Invoice Status Paid.\n\nThe invoice was successfully paid.", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PAID: string", + "source": "script-api", + "tags": [ + "status_paid", + "invoice.status_paid" + ], + "title": "Invoice.STATUS_PAID" + }, + { + "description": "Constant for Invoice Type Appeasement.", + "id": "script-api:dw/order/Invoice#TYPE_APPEASEMENT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_APPEASEMENT", + "sections": [ + { + "body": "Constant for Invoice Type Appeasement.\n\nThe invoice was created for an appeasement.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_APPEASEMENT: string", + "source": "script-api", + "tags": [ + "type_appeasement", + "invoice.type_appeasement" + ], + "title": "Invoice.TYPE_APPEASEMENT" + }, + { + "description": "Constant for Invoice Type Appeasement.", + "id": "script-api:dw/order/Invoice#TYPE_APPEASEMENT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_APPEASEMENT", + "sections": [ + { + "body": "Constant for Invoice Type Appeasement.\n\nThe invoice was created for an appeasement.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_APPEASEMENT: string", + "source": "script-api", + "tags": [ + "type_appeasement", + "invoice.type_appeasement" + ], + "title": "Invoice.TYPE_APPEASEMENT" + }, + { + "description": "Constant for Invoice Type Return.", + "id": "script-api:dw/order/Invoice#TYPE_RETURN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN", + "sections": [ + { + "body": "Constant for Invoice Type Return.\n\nThe invoice was created for a return.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_RETURN: string", + "source": "script-api", + "tags": [ + "type_return", + "invoice.type_return" + ], + "title": "Invoice.TYPE_RETURN" + }, + { + "description": "Constant for Invoice Type Return.", + "id": "script-api:dw/order/Invoice#TYPE_RETURN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN", + "sections": [ + { + "body": "Constant for Invoice Type Return.\n\nThe invoice was created for a return.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_RETURN: string", + "source": "script-api", + "tags": [ + "type_return", + "invoice.type_return" + ], + "title": "Invoice.TYPE_RETURN" + }, + { + "description": "Constant for Invoice Type Return Case.", + "id": "script-api:dw/order/Invoice#TYPE_RETURN_CASE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN_CASE", + "sections": [ + { + "body": "Constant for Invoice Type Return Case.\n\nThe invoice was created for a return case.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_RETURN_CASE: string", + "source": "script-api", + "tags": [ + "type_return_case", + "invoice.type_return_case" + ], + "title": "Invoice.TYPE_RETURN_CASE" + }, + { + "description": "Constant for Invoice Type Return Case.", + "id": "script-api:dw/order/Invoice#TYPE_RETURN_CASE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_RETURN_CASE", + "sections": [ + { + "body": "Constant for Invoice Type Return Case.\n\nThe invoice was created for a return case.\n\nThe invoice amount needs to be refunded.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_RETURN_CASE: string", + "source": "script-api", + "tags": [ + "type_return_case", + "invoice.type_return_case" + ], + "title": "Invoice.TYPE_RETURN_CASE" + }, + { + "description": "Constant for Invoice Type Shipping.", + "id": "script-api:dw/order/Invoice#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_SHIPPING", + "sections": [ + { + "body": "Constant for Invoice Type Shipping.\n\nThe invoice was created for a shipping order.\n\nThe invoice amount needs to be captured.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_shipping", + "invoice.type_shipping" + ], + "title": "Invoice.TYPE_SHIPPING" + }, + { + "description": "Constant for Invoice Type Shipping.", + "id": "script-api:dw/order/Invoice#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.TYPE_SHIPPING", + "sections": [ + { + "body": "Constant for Invoice Type Shipping.\n\nThe invoice was created for a shipping order.\n\nThe invoice amount needs to be captured.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_shipping", + "invoice.type_shipping" + ], + "title": "Invoice.TYPE_SHIPPING" + }, + { + "description": "The invoice will be accounted.", + "id": "script-api:dw/order/Invoice#account", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.account", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The invoice will be accounted.\n\nIt will be captured in case of a shipping invoice and it will be refunded in\ncase of an appeasement, return case or return invoice.\n\nThe accounting will be handled in the payment hooks\ndw.order.hooks.PaymentHooks.capture or\ndw.order.hooks.PaymentHooks.refund. The implementing script could add\npayment transactions to the invoice. The accompanying business logic will\nset the status to `PAID` or `FAILED`.\n\nThe accounting will fail when the invoice state is different to\nSTATUS_NOT_PAID or STATUS_FAILED.\n\nThe method implements its own transaction handling. The method must not\nbe called inside a transaction.", + "heading": "Description" + } + ], + "signature": "account(): boolean", + "source": "script-api", + "tags": [ + "account", + "invoice.account" + ], + "title": "Invoice.account" + }, + { + "description": "Calling this method registers an amount captured for a given order payment instrument. The authorization for the capture is associated with the payment transaction belonging to the instrument. Calling this method allows the Invoice, the dw.order.OrderPaymentInstrument and the dw.order.Order to return their captured amount as a sum calculated on the fly. The method may be called multiple times for the same instrument (multiple capture for one authorization) or for different instruments (invoice settlement using multiple payments).", + "id": "script-api:dw/order/Invoice#addCaptureTransaction", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "instrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "capturedAmount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.addCaptureTransaction", + "returns": { + "type": "PaymentTransaction" + }, + "sections": [ + { + "body": "Calling this method registers an amount captured for a given\norder payment instrument. The authorization for the\ncapture is associated with the payment transaction belonging to the\ninstrument. Calling this method allows the Invoice, the\ndw.order.OrderPaymentInstrument and the dw.order.Order to\nreturn their captured amount as a sum calculated on the fly. The method\nmay be called multiple times for the same instrument (multiple capture\nfor one authorization) or for different instruments (invoice settlement\nusing multiple payments).", + "heading": "Description" + } + ], + "signature": "addCaptureTransaction(instrument: OrderPaymentInstrument, capturedAmount: Money): PaymentTransaction", + "source": "script-api", + "tags": [ + "addcapturetransaction", + "invoice.addcapturetransaction" + ], + "title": "Invoice.addCaptureTransaction" + }, + { + "description": "Calling this method registers an amount refunded for a given order payment instrument. Calling this method allows the Invoice, the dw.order.OrderPaymentInstrument and the dw.order.Order to return their refunded amount as a sum calculated on the fly. The method may be called multiple times for the same instrument (multiple refunds of one payment) or for different instruments (invoice settlement using multiple payments).", + "id": "script-api:dw/order/Invoice#addRefundTransaction", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "instrument", + "type": "OrderPaymentInstrument" + }, + { + "name": "refundedAmount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.addRefundTransaction", + "returns": { + "type": "PaymentTransaction" + }, + "sections": [ + { + "body": "Calling this method registers an amount refunded for a given\norder payment instrument. Calling this method allows the\nInvoice, the dw.order.OrderPaymentInstrument and\nthe dw.order.Order to return their refunded amount as a sum\ncalculated on the fly. The method may be called multiple times for the\nsame instrument (multiple refunds of one payment) or for different\ninstruments (invoice settlement using multiple payments).", + "heading": "Description" + } + ], + "signature": "addRefundTransaction(instrument: OrderPaymentInstrument, refundedAmount: Money): PaymentTransaction", + "source": "script-api", + "tags": [ + "addrefundtransaction", + "invoice.addrefundtransaction" + ], + "title": "Invoice.addRefundTransaction" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly.", + "id": "script-api:dw/order/Invoice#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.capturedAmount", + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts are\ncalculated on the fly.\n\nAssociate a payment capture for a dw.order.OrderPaymentInstrument\nwith an Invoice using\naddCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "readonly capturedAmount: Money", + "source": "script-api", + "tags": [ + "capturedamount", + "invoice.capturedamount" + ], + "title": "Invoice.capturedAmount" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly.", + "id": "script-api:dw/order/Invoice#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getCapturedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts are\ncalculated on the fly.\n\nAssociate a payment capture for a dw.order.OrderPaymentInstrument\nwith an Invoice using\naddCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "getCapturedAmount(): Money", + "source": "script-api", + "tags": [ + "getcapturedamount", + "invoice.getcapturedamount" + ], + "title": "Invoice.getCapturedAmount" + }, + { + "description": "Returns the invoice number.", + "id": "script-api:dw/order/Invoice#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getInvoiceNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the invoice number.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "invoice.getinvoicenumber" + ], + "title": "Invoice.getInvoiceNumber" + }, + { + "description": "Returns the payment transactions belonging to this Invoice.", + "id": "script-api:dw/order/Invoice#getPaymentTransactions", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getPaymentTransactions", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the payment transactions belonging to this Invoice.\n\nThis dw.util.FilteringCollection can be sorted / filtered using:\n\n- dw.util.FilteringCollection.sort with\nORDERBY_CREATION_DATE\n- dw.util.FilteringCollection.sort with\nORDERBY_UNSORTED\n- dw.util.FilteringCollection.select with\nQUALIFIER_CAPTURE\n- dw.util.FilteringCollection.select with\nQUALIFIER_REFUND", + "heading": "Description" + } + ], + "signature": "getPaymentTransactions(): FilteringCollection", + "source": "script-api", + "tags": [ + "getpaymenttransactions", + "invoice.getpaymenttransactions" + ], + "title": "Invoice.getPaymentTransactions" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly.", + "id": "script-api:dw/order/Invoice#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getRefundedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts are\ncalculated on the fly.\n\nAssociate a payment capture for a dw.order.OrderPaymentInstrument\nwith an Invoice using\naddRefundTransaction.", + "heading": "Description" + } + ], + "signature": "getRefundedAmount(): Money", + "source": "script-api", + "tags": [ + "getrefundedamount", + "invoice.getrefundedamount" + ], + "title": "Invoice.getRefundedAmount" + }, + { + "description": "Returns the invoice status.", + "id": "script-api:dw/order/Invoice#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the invoice status.\n\nThe possible values are STATUS_NOT_PAID, STATUS_MANUAL,\nSTATUS_PAID, STATUS_FAILED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "invoice.getstatus" + ], + "title": "Invoice.getStatus" + }, + { + "description": "Returns the invoice type.", + "id": "script-api:dw/order/Invoice#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.getType", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the invoice type.\n\nThe possible values are TYPE_SHIPPING, TYPE_RETURN,\nTYPE_RETURN_CASE, TYPE_APPEASEMENT.", + "heading": "Description" + } + ], + "signature": "getType(): EnumValue", + "source": "script-api", + "tags": [ + "gettype", + "invoice.gettype" + ], + "title": "Invoice.getType" + }, + { + "description": "Returns the invoice number.", + "id": "script-api:dw/order/Invoice#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.invoiceNumber", + "sections": [ + { + "body": "Returns the invoice number.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string", + "source": "script-api", + "tags": [ + "invoicenumber", + "invoice.invoicenumber" + ], + "title": "Invoice.invoiceNumber" + }, + { + "description": "Returns the payment transactions belonging to this Invoice.", + "id": "script-api:dw/order/Invoice#paymentTransactions", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.paymentTransactions", + "sections": [ + { + "body": "Returns the payment transactions belonging to this Invoice.\n\nThis dw.util.FilteringCollection can be sorted / filtered using:\n\n- dw.util.FilteringCollection.sort with\nORDERBY_CREATION_DATE\n- dw.util.FilteringCollection.sort with\nORDERBY_UNSORTED\n- dw.util.FilteringCollection.select with\nQUALIFIER_CAPTURE\n- dw.util.FilteringCollection.select with\nQUALIFIER_REFUND", + "heading": "Description" + } + ], + "signature": "readonly paymentTransactions: FilteringCollection", + "source": "script-api", + "tags": [ + "paymenttransactions", + "invoice.paymenttransactions" + ], + "title": "Invoice.paymentTransactions" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly.", + "id": "script-api:dw/order/Invoice#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.refundedAmount", + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts are\ncalculated on the fly.\n\nAssociate a payment capture for a dw.order.OrderPaymentInstrument\nwith an Invoice using\naddRefundTransaction.", + "heading": "Description" + } + ], + "signature": "readonly refundedAmount: Money", + "source": "script-api", + "tags": [ + "refundedamount", + "invoice.refundedamount" + ], + "title": "Invoice.refundedAmount" + }, + { + "description": "Sets the invoice status.", + "id": "script-api:dw/order/Invoice#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the invoice status.\n\nThe possible values are STATUS_NOT_PAID, STATUS_MANUAL,\nSTATUS_PAID, STATUS_FAILED.", + "heading": "Description" + } + ], + "signature": "setStatus(status: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "invoice.setstatus" + ], + "title": "Invoice.setStatus" + }, + { + "description": "Returns the invoice status.", + "id": "script-api:dw/order/Invoice#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.status", + "sections": [ + { + "body": "Returns the invoice status.\n\nThe possible values are STATUS_NOT_PAID, STATUS_MANUAL,\nSTATUS_PAID, STATUS_FAILED.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "invoice.status" + ], + "title": "Invoice.status" + }, + { + "description": "Returns the invoice type.", + "id": "script-api:dw/order/Invoice#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Invoice", + "qualifiedName": "dw.order.Invoice.type", + "sections": [ + { + "body": "Returns the invoice type.\n\nThe possible values are TYPE_SHIPPING, TYPE_RETURN,\nTYPE_RETURN_CASE, TYPE_APPEASEMENT.", + "heading": "Description" + } + ], + "signature": "readonly type: EnumValue", + "source": "script-api", + "tags": [ + "type", + "invoice.type" + ], + "title": "Invoice.type" + }, + { + "description": "Represents a specific item in an dw.order.Invoice. Invoice items are added to the invoice on its creation, each item references exactly one order-item.", + "id": "script-api:dw/order/InvoiceItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.InvoiceItem", + "sections": [ + { + "body": "Represents a specific item in an dw.order.Invoice. Invoice items are added to the invoice\non its creation, each item references exactly one order-item.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "invoiceitem", + "dw.order.invoiceitem", + "dw/order" + ], + "title": "InvoiceItem" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/InvoiceItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.basePrice", + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "readonly basePrice: Money", + "source": "script-api", + "tags": [ + "baseprice", + "invoiceitem.baseprice" + ], + "title": "InvoiceItem.basePrice" + }, + { + "description": "Returns the captured amount for this item.", + "id": "script-api:dw/order/InvoiceItem#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.capturedAmount", + "sections": [ + { + "body": "Returns the captured amount for this item.", + "heading": "Description" + } + ], + "signature": "capturedAmount: Money", + "source": "script-api", + "tags": [ + "capturedamount", + "invoiceitem.capturedamount" + ], + "title": "InvoiceItem.capturedAmount" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/InvoiceItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getBasePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "getBasePrice(): Money", + "source": "script-api", + "tags": [ + "getbaseprice", + "invoiceitem.getbaseprice" + ], + "title": "InvoiceItem.getBasePrice" + }, + { + "description": "Returns the captured amount for this item.", + "id": "script-api:dw/order/InvoiceItem#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getCapturedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the captured amount for this item.", + "heading": "Description" + } + ], + "signature": "getCapturedAmount(): Money", + "source": "script-api", + "tags": [ + "getcapturedamount", + "invoiceitem.getcapturedamount" + ], + "title": "InvoiceItem.getCapturedAmount" + }, + { + "description": "Returns the number of the invoice to which this item belongs.", + "id": "script-api:dw/order/InvoiceItem#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getInvoiceNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the number of the invoice to which this item belongs.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "invoiceitem.getinvoicenumber" + ], + "title": "InvoiceItem.getInvoiceNumber" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/InvoiceItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getParentItem", + "returns": { + "type": "InvoiceItem | null" + }, + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "getParentItem(): InvoiceItem | null", + "source": "script-api", + "tags": [ + "getparentitem", + "invoiceitem.getparentitem" + ], + "title": "InvoiceItem.getParentItem" + }, + { + "description": "Returns the quantity of this item.", + "id": "script-api:dw/order/InvoiceItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of this item.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "invoiceitem.getquantity" + ], + "title": "InvoiceItem.getQuantity" + }, + { + "description": "Returns the refunded amount for this item.", + "id": "script-api:dw/order/InvoiceItem#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.getRefundedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the refunded amount for this item.", + "heading": "Description" + } + ], + "signature": "getRefundedAmount(): Money", + "source": "script-api", + "tags": [ + "getrefundedamount", + "invoiceitem.getrefundedamount" + ], + "title": "InvoiceItem.getRefundedAmount" + }, + { + "description": "Returns the number of the invoice to which this item belongs.", + "id": "script-api:dw/order/InvoiceItem#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.invoiceNumber", + "sections": [ + { + "body": "Returns the number of the invoice to which this item belongs.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string", + "source": "script-api", + "tags": [ + "invoicenumber", + "invoiceitem.invoicenumber" + ], + "title": "InvoiceItem.invoiceNumber" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/InvoiceItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.parentItem", + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "parentItem: InvoiceItem | null", + "source": "script-api", + "tags": [ + "parentitem", + "invoiceitem.parentitem" + ], + "title": "InvoiceItem.parentItem" + }, + { + "description": "Returns the quantity of this item.", + "id": "script-api:dw/order/InvoiceItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.quantity", + "sections": [ + { + "body": "Returns the quantity of this item.", + "heading": "Description" + } + ], + "signature": "readonly quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "invoiceitem.quantity" + ], + "title": "InvoiceItem.quantity" + }, + { + "description": "Returns the refunded amount for this item.", + "id": "script-api:dw/order/InvoiceItem#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.refundedAmount", + "sections": [ + { + "body": "Returns the refunded amount for this item.", + "heading": "Description" + } + ], + "signature": "refundedAmount: Money", + "source": "script-api", + "tags": [ + "refundedamount", + "invoiceitem.refundedamount" + ], + "title": "InvoiceItem.refundedAmount" + }, + { + "description": "Updates the captured amount for this item.", + "id": "script-api:dw/order/InvoiceItem#setCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "capturedAmount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setCapturedAmount", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the captured amount for this item.", + "heading": "Description" + } + ], + "signature": "setCapturedAmount(capturedAmount: Money): void", + "source": "script-api", + "tags": [ + "setcapturedamount", + "invoiceitem.setcapturedamount" + ], + "title": "InvoiceItem.setCapturedAmount" + }, + { + "description": "Set a parent item. The parent item must belong to the same dw.order.Invoice. An infinite parent-child loop is disallowed as is a parent-child depth greater than 10. Setting a parent item indicates a dependency of the child item on the parent item, and can be used to form a parallel structure to that accessed using dw.order.ProductLineItem.getParent.", + "id": "script-api:dw/order/InvoiceItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "parentItem", + "type": "InvoiceItem" + } + ], + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setParentItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a parent item. The parent item must belong to the same\ndw.order.Invoice. An infinite parent-child loop is disallowed\nas is a parent-child depth greater than 10. Setting a parent item\nindicates a dependency of the child item on the parent item, and can be\nused to form a parallel structure to that accessed using\ndw.order.ProductLineItem.getParent.", + "heading": "Description" + } + ], + "signature": "setParentItem(parentItem: InvoiceItem): void", + "source": "script-api", + "tags": [ + "setparentitem", + "invoiceitem.setparentitem" + ], + "title": "InvoiceItem.setParentItem" + }, + { + "description": "Updates the refunded amount for this item.", + "id": "script-api:dw/order/InvoiceItem#setRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "refundedAmount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/InvoiceItem", + "qualifiedName": "dw.order.InvoiceItem.setRefundedAmount", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the refunded amount for this item.", + "heading": "Description" + } + ], + "signature": "setRefundedAmount(refundedAmount: Money): void", + "source": "script-api", + "tags": [ + "setrefundedamount", + "invoiceitem.setrefundedamount" + ], + "title": "InvoiceItem.setRefundedAmount" + }, + { + "description": "Common line item base class.", + "id": "script-api:dw/order/LineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItem", + "sections": [ + { + "body": "Common line item base class.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "lineitem", + "dw.order.lineitem", + "dw/order" + ], + "title": "LineItem" + }, + { + "description": "Returns the base price for the line item, which is the price of the unit before applying adjustments, in the purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "id": "script-api:dw/order/LineItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.basePrice", + "sections": [ + { + "body": "Returns the base price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "heading": "Description" + } + ], + "signature": "basePrice: Money", + "source": "script-api", + "tags": [ + "baseprice", + "lineitem.baseprice" + ], + "title": "LineItem.basePrice" + }, + { + "description": "Returns the base price for the line item, which is the price of the unit before applying adjustments, in the purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "id": "script-api:dw/order/LineItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getBasePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the base price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "heading": "Description" + } + ], + "signature": "getBasePrice(): Money", + "source": "script-api", + "tags": [ + "getbaseprice", + "lineitem.getbaseprice" + ], + "title": "LineItem.getBasePrice" + }, + { + "description": "Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the purchase currency, including tax.", + "id": "script-api:dw/order/LineItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency, including tax.", + "heading": "Description" + } + ], + "signature": "getGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getgrossprice", + "lineitem.getgrossprice" + ], + "title": "LineItem.getGrossPrice" + }, + { + "description": "Returns the line item ctnr of the line item.", + "id": "script-api:dw/order/LineItem#getLineItemCtnr", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getLineItemCtnr", + "returns": { + "type": "LineItemCtnr" + }, + "sections": [ + { + "body": "Returns the line item ctnr of the line item.", + "heading": "Description" + } + ], + "signature": "getLineItemCtnr(): LineItemCtnr", + "source": "script-api", + "tags": [ + "getlineitemctnr", + "lineitem.getlineitemctnr" + ], + "title": "LineItem.getLineItemCtnr" + }, + { + "description": "Returns the display text for the line item.", + "id": "script-api:dw/order/LineItem#getLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getLineItemText", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display text for the line item.", + "heading": "Description" + } + ], + "signature": "getLineItemText(): string", + "source": "script-api", + "tags": [ + "getlineitemtext", + "lineitem.getlineitemtext" + ], + "title": "LineItem.getLineItemText" + }, + { + "description": "Returns the net price for the line item, which is the price of the unit before applying adjustments, in the purchase currency, excluding tax.", + "id": "script-api:dw/order/LineItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the net price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency, excluding tax.", + "heading": "Description" + } + ], + "signature": "getNetPrice(): Money", + "source": "script-api", + "tags": [ + "getnetprice", + "lineitem.getnetprice" + ], + "title": "LineItem.getNetPrice" + }, + { + "description": "Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the line item is based on gross pricing then the gross price is returned.", + "id": "script-api:dw/order/LineItem#getPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the\nline item is based on gross pricing then the gross price is returned.", + "heading": "Description" + } + ], + "signature": "getPrice(): Money", + "source": "script-api", + "tags": [ + "getprice", + "lineitem.getprice" + ], + "title": "LineItem.getPrice" + }, + { + "description": "Return the price amount for the line item. Same as getPrice().getValue().", + "id": "script-api:dw/order/LineItem#getPriceValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getPriceValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Return the price amount for the line item. Same as getPrice().getValue().", + "heading": "Description" + } + ], + "signature": "getPriceValue(): number", + "source": "script-api", + "tags": [ + "getpricevalue", + "lineitem.getpricevalue" + ], + "title": "LineItem.getPriceValue" + }, + { + "description": "Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/LineItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase\ncurrency.", + "heading": "Description" + } + ], + "signature": "getTax(): Money", + "source": "script-api", + "tags": [ + "gettax", + "lineitem.gettax" + ], + "title": "LineItem.getTax" + }, + { + "description": "Get the price used to calculate the tax for this line item.", + "id": "script-api:dw/order/LineItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxBasis", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Get the price used to calculate the tax for this line item.", + "heading": "Description" + } + ], + "signature": "getTaxBasis(): Money", + "source": "script-api", + "tags": [ + "gettaxbasis", + "lineitem.gettaxbasis" + ], + "title": "LineItem.getTaxBasis" + }, + { + "description": "Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the case where the tax class ID is null, you should use the default tax class ID.", + "id": "script-api:dw/order/LineItem#getTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxClassID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the\ncase where the tax class ID is null, you should use the default tax class ID.", + "heading": "Description" + } + ], + "signature": "getTaxClassID(): string | null", + "source": "script-api", + "tags": [ + "gettaxclassid", + "lineitem.gettaxclassid" + ], + "title": "LineItem.getTaxClassID" + }, + { + "description": "Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A value of 0.175 represents a percentage of 17.5%.", + "id": "script-api:dw/order/LineItem#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A\nvalue of 0.175 represents a percentage of 17.5%.", + "heading": "Description" + } + ], + "signature": "getTaxRate(): number", + "source": "script-api", + "tags": [ + "gettaxrate", + "lineitem.gettaxrate" + ], + "title": "LineItem.getTaxRate" + }, + { + "description": "Returns the tax items for this line item. When taxes are set via setTaxes, the line item's tax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved after order creation and can be retrieved on both baskets and orders.", + "id": "script-api:dw/order/LineItem#getTaxes", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.getTaxes", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the tax items for this line item. When taxes are set via setTaxes, the line item's\ntax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved\nafter order creation and can be retrieved on both baskets and orders.\n\nAccess is currently restricted to select pilot customers and controlled via feature toggle.", + "heading": "Description" + } + ], + "signature": "getTaxes(): Collection", + "source": "script-api", + "tags": [ + "gettaxes", + "lineitem.gettaxes" + ], + "title": "LineItem.getTaxes" + }, + { + "description": "Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the purchase currency, including tax.", + "id": "script-api:dw/order/LineItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.grossPrice", + "sections": [ + { + "body": "Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency, including tax.", + "heading": "Description" + } + ], + "signature": "grossPrice: Money", + "source": "script-api", + "tags": [ + "grossprice", + "lineitem.grossprice" + ], + "title": "LineItem.grossPrice" + }, + { + "description": "Returns the line item ctnr of the line item.", + "id": "script-api:dw/order/LineItem#lineItemCtnr", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.lineItemCtnr", + "sections": [ + { + "body": "Returns the line item ctnr of the line item.", + "heading": "Description" + } + ], + "signature": "readonly lineItemCtnr: LineItemCtnr", + "source": "script-api", + "tags": [ + "lineitemctnr", + "lineitem.lineitemctnr" + ], + "title": "LineItem.lineItemCtnr" + }, + { + "description": "Returns the display text for the line item.", + "id": "script-api:dw/order/LineItem#lineItemText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.lineItemText", + "sections": [ + { + "body": "Returns the display text for the line item.", + "heading": "Description" + } + ], + "signature": "lineItemText: string", + "source": "script-api", + "tags": [ + "lineitemtext", + "lineitem.lineitemtext" + ], + "title": "LineItem.lineItemText" + }, + { + "description": "Returns the net price for the line item, which is the price of the unit before applying adjustments, in the purchase currency, excluding tax.", + "id": "script-api:dw/order/LineItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.netPrice", + "sections": [ + { + "body": "Returns the net price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency, excluding tax.", + "heading": "Description" + } + ], + "signature": "netPrice: Money", + "source": "script-api", + "tags": [ + "netprice", + "lineitem.netprice" + ], + "title": "LineItem.netPrice" + }, + { + "description": "Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the line item is based on gross pricing then the gross price is returned.", + "id": "script-api:dw/order/LineItem#price", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.price", + "sections": [ + { + "body": "Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the\nline item is based on gross pricing then the gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly price: Money", + "source": "script-api", + "tags": [ + "price", + "lineitem.price" + ], + "title": "LineItem.price" + }, + { + "description": "Return the price amount for the line item. Same as getPrice().getValue().", + "id": "script-api:dw/order/LineItem#priceValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.priceValue", + "sections": [ + { + "body": "Return the price amount for the line item. Same as getPrice().getValue().", + "heading": "Description" + } + ], + "signature": "priceValue: number", + "source": "script-api", + "tags": [ + "pricevalue", + "lineitem.pricevalue" + ], + "title": "LineItem.priceValue" + }, + { + "deprecated": { + "message": "Use updatePrice instead." + }, + "description": "Sets the base price for the line item, which is the price of the unit before applying adjustments, in the purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "id": "script-api:dw/order/LineItem#setBasePrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setBasePrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the base price for the line item, which is the price of the unit before applying adjustments, in the\npurchase currency. The base price may be net or gross of tax depending on the configured taxation policy.", + "heading": "Description" + } + ], + "signature": "setBasePrice(aValue: Money): void", + "source": "script-api", + "tags": [ + "setbaseprice", + "lineitem.setbaseprice" + ], + "title": "LineItem.setBasePrice" + }, + { + "deprecated": { + "message": "Use updatePrice which sets the base price and also the gross price if the line item\nis based on gross pricing." + }, + "description": "Sets the gross price for the line item, which is the Price of the unit before applying adjustments, in the purchase currency, including tax.", + "id": "script-api:dw/order/LineItem#setGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setGrossPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the gross price for the line item, which is the Price of the unit before applying adjustments, in the\npurchase currency, including tax.", + "heading": "Description" + } + ], + "signature": "setGrossPrice(aValue: Money): void", + "source": "script-api", + "tags": [ + "setgrossprice", + "lineitem.setgrossprice" + ], + "title": "LineItem.setGrossPrice" + }, + { + "description": "Sets the display text for the line item.", + "id": "script-api:dw/order/LineItem#setLineItemText", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aText", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setLineItemText", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the display text for the line item.", + "heading": "Description" + } + ], + "signature": "setLineItemText(aText: string): void", + "source": "script-api", + "tags": [ + "setlineitemtext", + "lineitem.setlineitemtext" + ], + "title": "LineItem.setLineItemText" + }, + { + "deprecated": { + "message": "Use updatePrice which sets the base price and also the net price if the line item is\nbased on net pricing." + }, + "description": "Sets the value for the net price, which is the price of the unit before applying adjustments, in the purchase currency, excluding tax.", + "id": "script-api:dw/order/LineItem#setNetPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setNetPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value for the net price, which is the price of the unit before applying adjustments, in the purchase\ncurrency, excluding tax.", + "heading": "Description" + } + ], + "signature": "setNetPrice(aValue: Money): void", + "source": "script-api", + "tags": [ + "setnetprice", + "lineitem.setnetprice" + ], + "title": "LineItem.setNetPrice" + }, + { + "description": "Sets price attributes of the line item based on the current purchase currency and taxation policy.", + "id": "script-api:dw/order/LineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setPriceValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets price attributes of the line item based on the current purchase currency and taxation policy.\n\nThe methods sets the 'basePrice' attribute of the line item. Additionally, it sets the 'netPrice' attribute of\nthe line item if the current taxation policy is 'net', and the 'grossPrice' attribute, if the current taxation\npolicy is 'gross'.\n\nIf null is specified as value, the price attributes are reset to Money.NOT_AVAILABLE.", + "heading": "Description" + } + ], + "signature": "setPriceValue(value: number): void", + "source": "script-api", + "tags": [ + "setpricevalue", + "lineitem.setpricevalue" + ], + "title": "LineItem.setPriceValue" + }, + { + "description": "Sets the value for the tax of the line item, which is the the tax of the unit before applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/LineItem#setTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value for the tax of the line item, which is the the tax of the unit before applying adjustments, in the\npurchase currency.\n\nIf tax items are already set (e.g. via setTaxes), calling this will clear them.", + "heading": "Description" + } + ], + "signature": "setTax(aValue: Money): void", + "source": "script-api", + "tags": [ + "settax", + "lineitem.settax" + ], + "title": "LineItem.setTax" + }, + { + "description": "Sets the tax class ID for the line item.", + "id": "script-api:dw/order/LineItem#setTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxClassID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tax class ID for the line item.", + "heading": "Description" + } + ], + "signature": "setTaxClassID(aValue: string): void", + "source": "script-api", + "tags": [ + "settaxclassid", + "lineitem.settaxclassid" + ], + "title": "LineItem.setTaxClassID" + }, + { + "description": "Sets the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A value of 0.175 represents a percentage of 17.5%.", + "id": "script-api:dw/order/LineItem#setTaxRate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxRate", + "type": "number" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxRate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A\nvalue of 0.175 represents a percentage of 17.5%.\n\nIf tax items are already set (e.g. via setTaxes), calling this will clear them.", + "heading": "Description" + } + ], + "signature": "setTaxRate(taxRate: number): void", + "source": "script-api", + "tags": [ + "settaxrate", + "lineitem.settaxrate" + ], + "title": "LineItem.setTaxRate" + }, + { + "description": "Sets the tax items for this line item. The container must be a basket. Persists the given items, then aggregates them (sum of tax values, combined tax rate) and updates this line item's tax amount and tax rate accordingly.", + "id": "script-api:dw/order/LineItem#setTaxes", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxItems", + "type": "Collection" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.setTaxes", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tax items for this line item. The container must be a basket. Persists the given items, then aggregates\nthem (sum of tax values, combined tax rate) and updates this line item's tax amount and tax rate accordingly.\n\nEach element in the collection must be a LineItemTax, for example created via\nLineItemTax.LineItemTax.\n\nUse either multilevel tax items via setTaxes or\nsetTax/setTaxRate/updateTax/updateTaxAmount,\nnot both.\n\nAccess is currently restricted to select pilot customers and controlled via feature toggle.\n\nThe maximum number of tax items allowed per line item is 10.", + "heading": "Description" + } + ], + "signature": "setTaxes(taxItems: Collection): void", + "source": "script-api", + "tags": [ + "settaxes", + "lineitem.settaxes" + ], + "throws": [ + { + "description": "if the container is not a basket, or if more than 10 tax items are provided", + "type": "IllegalArgumentException" + } + ], + "title": "LineItem.setTaxes" + }, + { + "description": "Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/LineItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.tax", + "sections": [ + { + "body": "Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase\ncurrency.", + "heading": "Description" + } + ], + "signature": "tax: Money", + "source": "script-api", + "tags": [ + "tax", + "lineitem.tax" + ], + "title": "LineItem.tax" + }, + { + "description": "Get the price used to calculate the tax for this line item.", + "id": "script-api:dw/order/LineItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxBasis", + "sections": [ + { + "body": "Get the price used to calculate the tax for this line item.", + "heading": "Description" + } + ], + "signature": "readonly taxBasis: Money", + "source": "script-api", + "tags": [ + "taxbasis", + "lineitem.taxbasis" + ], + "title": "LineItem.taxBasis" + }, + { + "description": "Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the case where the tax class ID is null, you should use the default tax class ID.", + "id": "script-api:dw/order/LineItem#taxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxClassID", + "sections": [ + { + "body": "Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the\ncase where the tax class ID is null, you should use the default tax class ID.", + "heading": "Description" + } + ], + "signature": "taxClassID: string | null", + "source": "script-api", + "tags": [ + "taxclassid", + "lineitem.taxclassid" + ], + "title": "LineItem.taxClassID" + }, + { + "description": "Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A value of 0.175 represents a percentage of 17.5%.", + "id": "script-api:dw/order/LineItem#taxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxRate", + "sections": [ + { + "body": "Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A\nvalue of 0.175 represents a percentage of 17.5%.", + "heading": "Description" + } + ], + "signature": "taxRate: number", + "source": "script-api", + "tags": [ + "taxrate", + "lineitem.taxrate" + ], + "title": "LineItem.taxRate" + }, + { + "description": "Returns the tax items for this line item. When taxes are set via setTaxes, the line item's tax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved after order creation and can be retrieved on both baskets and orders.", + "id": "script-api:dw/order/LineItem#taxes", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.taxes", + "sections": [ + { + "body": "Returns the tax items for this line item. When taxes are set via setTaxes, the line item's\ntax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved\nafter order creation and can be retrieved on both baskets and orders.\n\nAccess is currently restricted to select pilot customers and controlled via feature toggle.", + "heading": "Description" + } + ], + "signature": "taxes: Collection", + "source": "script-api", + "tags": [ + "taxes", + "lineitem.taxes" + ], + "title": "LineItem.taxes" + }, + { + "deprecated": { + "message": "Use setPriceValue instead." + }, + "description": "Updates the price attributes of the line item based on the specified price. The base price is set to the specified value. If the line item is based on net pricing then the net price attribute is set. If the line item is based on gross pricing then the gross price attribute is set. Whether or not a line item is based on net or gross pricing is a site-wide configuration parameter.", + "id": "script-api:dw/order/LineItem#updatePrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "price", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updatePrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the price attributes of the line item based on the specified price. The base price is set to the\nspecified value. If the line item is based on net pricing then the net price attribute is set. If the line item\nis based on gross pricing then the gross price attribute is set. Whether or not a line item is based on net or\ngross pricing is a site-wide configuration parameter.", + "heading": "Description" + } + ], + "signature": "updatePrice(price: Money): void", + "source": "script-api", + "tags": [ + "updateprice", + "lineitem.updateprice" + ], + "title": "LineItem.updatePrice" + }, + { + "description": "Updates the tax-related attributes of the line item based on the specified tax rate, a tax basis determined by the system and the \"Tax Rounding Mode\" order preference. This method sets the tax basis as an attribute, and is not affected by the previous value of this attribute.", + "id": "script-api:dw/order/LineItem#updateTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxRate", + "type": "number" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the tax-related attributes of the line item based on the specified tax rate, a tax basis determined by\nthe system and the \"Tax Rounding Mode\" order preference. This method sets the tax basis as an attribute, and is\nnot affected by the previous value of this attribute.\n\nThe value used as a basis depends on the type of line item this is and on the promotion preferences for the\ncurrent site. If you tax products, shipping, and discounts based on price (default), then the tax basis will\nsimply be equal to getPrice. If you tax products and shipping only based on adjusted price, then the\ntax basis depends upon line item type as follows:\n\n- ProductLineItem: basis equals dw.order.ProductLineItem.getProratedPrice.\n- ShippingLineItem: basis equals dw.order.ShippingLineItem.getAdjustedPrice.\n- ProductShippingLineItem: basis equals\ndw.order.ProductShippingLineItem.getAdjustedPrice.\n- PriceAdjustment: basis equals 0.00.\n- All other line item types: basis equals getPrice.\n\nIf null is passed as tax rate, tax-related attribute fields are set to N/A.", + "heading": "Description" + } + ], + "signature": "updateTax(taxRate: number): void", + "source": "script-api", + "tags": [ + "updatetax", + "lineitem.updatetax" + ], + "title": "LineItem.updateTax" + }, + { + "description": "Updates the tax-related attributes of the line item based on the specified tax rate, the passed tax basis and the \"Tax Rounding Mode\" order preference. If null is passed as tax rate or tax basis, tax-related attribute fields are set to N/A.", + "id": "script-api:dw/order/LineItem#updateTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxRate", + "type": "number" + }, + { + "name": "taxBasis", + "type": "Money | null" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the tax-related attributes of the line item based on the specified tax rate, the passed tax basis and the\n\"Tax Rounding Mode\" order preference. If null is passed as tax rate or tax basis, tax-related attribute fields\nare set to N/A.\n\nIf tax items are already set (e.g. via setTaxes), calling this will clear them.", + "heading": "Description" + } + ], + "signature": "updateTax(taxRate: number, taxBasis: Money | null): void", + "source": "script-api", + "tags": [ + "updatetax", + "lineitem.updatetax" + ], + "title": "LineItem.updateTax" + }, + { + "description": "Updates tax amount of the line item setting the provided value. Depending on the way how the tax is calculated (based on net or gross price), the corresponding gross or net price is updated accordingly. For tax calculation based on net price, the gross price is calculated by adding the tax to the net price. For tax calculation based on gross price, the net price is calculated by subtracting the tax from the gross price.", + "id": "script-api:dw/order/LineItem#updateTaxAmount", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "tax", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItem", + "qualifiedName": "dw.order.LineItem.updateTaxAmount", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates tax amount of the line item setting the provided value. Depending on the way how the tax is calculated\n(based on net or gross price), the corresponding gross or net price is updated accordingly. For tax calculation\nbased on net price, the gross price is calculated by adding the tax to the net price. For tax calculation based\non gross price, the net price is calculated by subtracting the tax from the gross price.\n\nIf null is passed as tax amount, the item tax and resulting net or gross price are set to N/A.\n\nNote that tax rate is not calculated and it is not updated.\n\nIf tax items are already set (e.g. via setTaxes), calling this will clear them.", + "heading": "Description" + } + ], + "signature": "updateTaxAmount(tax: Money): void", + "source": "script-api", + "tags": [ + "updatetaxamount", + "lineitem.updatetaxamount" + ], + "title": "LineItem.updateTaxAmount" + }, + { + "description": "A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. This container also provides access to shipments, shipping adjustments (promotions), and payment instruments (credit cards).", + "id": "script-api:dw/order/LineItemCtnr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItemCtnr", + "sections": [ + { + "body": "A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. This container also\nprovides access to shipments, shipping adjustments (promotions), and payment instruments (credit cards).\n\nLineItemCtnr also contains a set of methods for creating line items and adjustments, and for accessing various price\nvalues. There are three types of price-related methods:\n\n- Net-based methods represent the amount of a category before tax has been calculated. For example,\nthe getMerchandizeTotalNetPrice() returns the price of all merchandise in the container whereas\ngetShippingTotalNetPrice() returns the price of all shipments in the container.\n- Tax-based methods return the amount of tax on a category. For example, the getMerchandizeTotalTax()\nreturns the total tax for all merchandise and the getShippingTotalTax() returns the tax applied to all\nshipments.\n- Gross-based methods represent the amount of a category after tax has been calculated. For example,\nthe getMerchandizeTotalGrossPrice() returns the price of all merchandise in the container, including tax on the\nmerchandise, whereas getShippingTotalGrossPrice() returns the price of all shipments in the container, including tax\non the shipments in the container.\n\nThere are also a set of methods that provide access to 'adjusted' values. The adjusted-based methods return values\nwhere promotions have been applied. For example, the getAdjustedMerchandizeTotalNetPrice() method returns the net\nprice of all merchandise after product-level and order-level promotions have been applied. Whereas the\ngetAdjustedMerchandizeTotalGrossPrice() method returns the price of all merchandise after product-level and\norder-level promotions have been applied and includes the amount of merchandise-related tax.\n\nFinally, there are a set of methods that return the aggregate values representing the line items in the container.\nThese are the total-based methods getTotalNetPrice(), getTotalTax() and getTotalGrossPrice(). These methods return\nthe totals of all items in the container and include any order-level promotions.\n\nNote that all merchandise-related methods do not include 'gift certificates' values in the values they return. Gift\ncertificates are not considered merchandise as they do not represent a product.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "lineitemctnr", + "dw.order.lineitemctnr", + "dw/order" + ], + "title": "LineItemCtnr" + }, + { + "description": "constant for Business Type B2B", + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2B", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2B", + "sections": [ + { + "body": "constant for Business Type B2B", + "heading": "Description" + } + ], + "signature": "static readonly BUSINESS_TYPE_B2B: number", + "source": "script-api", + "tags": [ + "business_type_b2b", + "lineitemctnr.business_type_b2b" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2B" + }, + { + "description": "constant for Business Type B2B", + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2B", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2B", + "sections": [ + { + "body": "constant for Business Type B2B", + "heading": "Description" + } + ], + "signature": "static readonly BUSINESS_TYPE_B2B: number", + "source": "script-api", + "tags": [ + "business_type_b2b", + "lineitemctnr.business_type_b2b" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2B" + }, + { + "description": "constant for Business Type B2C", + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2C", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2C", + "sections": [ + { + "body": "constant for Business Type B2C", + "heading": "Description" + } + ], + "signature": "static readonly BUSINESS_TYPE_B2C: number", + "source": "script-api", + "tags": [ + "business_type_b2c", + "lineitemctnr.business_type_b2c" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2C" + }, + { + "description": "constant for Business Type B2C", + "id": "script-api:dw/order/LineItemCtnr#BUSINESS_TYPE_B2C", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.BUSINESS_TYPE_B2C", + "sections": [ + { + "body": "constant for Business Type B2C", + "heading": "Description" + } + ], + "signature": "static readonly BUSINESS_TYPE_B2C: number", + "source": "script-api", + "tags": [ + "business_type_b2c", + "lineitemctnr.business_type_b2c" + ], + "title": "LineItemCtnr.BUSINESS_TYPE_B2C" + }, + { + "description": "constant for Channel Type CallCenter", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CALLCENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CALLCENTER", + "sections": [ + { + "body": "constant for Channel Type CallCenter", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CALLCENTER: number", + "source": "script-api", + "tags": [ + "channel_type_callcenter", + "lineitemctnr.channel_type_callcenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CALLCENTER" + }, + { + "description": "constant for Channel Type CallCenter", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CALLCENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CALLCENTER", + "sections": [ + { + "body": "constant for Channel Type CallCenter", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CALLCENTER: number", + "source": "script-api", + "tags": [ + "channel_type_callcenter", + "lineitemctnr.channel_type_callcenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CALLCENTER" + }, + { + "description": "constant for Channel Type ChatGPT", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CHATGPT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CHATGPT", + "sections": [ + { + "body": "constant for Channel Type ChatGPT", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CHATGPT: number", + "source": "script-api", + "tags": [ + "channel_type_chatgpt", + "lineitemctnr.channel_type_chatgpt" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CHATGPT" + }, + { + "description": "constant for Channel Type ChatGPT", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CHATGPT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CHATGPT", + "sections": [ + { + "body": "constant for Channel Type ChatGPT", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CHATGPT: number", + "source": "script-api", + "tags": [ + "channel_type_chatgpt", + "lineitemctnr.channel_type_chatgpt" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CHATGPT" + }, + { + "description": "constant for Channel Type Customer Service Center", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "sections": [ + { + "body": "constant for Channel Type Customer Service Center", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CUSTOMERSERVICECENTER: number", + "source": "script-api", + "tags": [ + "channel_type_customerservicecenter", + "lineitemctnr.channel_type_customerservicecenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER" + }, + { + "description": "constant for Channel Type Customer Service Center", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER", + "sections": [ + { + "body": "constant for Channel Type Customer Service Center", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_CUSTOMERSERVICECENTER: number", + "source": "script-api", + "tags": [ + "channel_type_customerservicecenter", + "lineitemctnr.channel_type_customerservicecenter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_CUSTOMERSERVICECENTER" + }, + { + "description": "constant for Channel Type DSS", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_DSS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_DSS", + "sections": [ + { + "body": "constant for Channel Type DSS", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_DSS: number", + "source": "script-api", + "tags": [ + "channel_type_dss", + "lineitemctnr.channel_type_dss" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_DSS" + }, + { + "description": "constant for Channel Type DSS", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_DSS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_DSS", + "sections": [ + { + "body": "constant for Channel Type DSS", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_DSS: number", + "source": "script-api", + "tags": [ + "channel_type_dss", + "lineitemctnr.channel_type_dss" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_DSS" + }, + { + "description": "constant for Channel Type Facebook Ads", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_FACEBOOKADS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS", + "sections": [ + { + "body": "constant for Channel Type Facebook Ads", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_FACEBOOKADS: number", + "source": "script-api", + "tags": [ + "channel_type_facebookads", + "lineitemctnr.channel_type_facebookads" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS" + }, + { + "description": "constant for Channel Type Facebook Ads", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_FACEBOOKADS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS", + "sections": [ + { + "body": "constant for Channel Type Facebook Ads", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_FACEBOOKADS: number", + "source": "script-api", + "tags": [ + "channel_type_facebookads", + "lineitemctnr.channel_type_facebookads" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_FACEBOOKADS" + }, + { + "description": "constant for Channel Type Gemini", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GEMINI", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GEMINI", + "sections": [ + { + "body": "constant for Channel Type Gemini", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_GEMINI: number", + "source": "script-api", + "tags": [ + "channel_type_gemini", + "lineitemctnr.channel_type_gemini" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GEMINI" + }, + { + "description": "constant for Channel Type Gemini", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GEMINI", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GEMINI", + "sections": [ + { + "body": "constant for Channel Type Gemini", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_GEMINI: number", + "source": "script-api", + "tags": [ + "channel_type_gemini", + "lineitemctnr.channel_type_gemini" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GEMINI" + }, + { + "description": "constant for Channel Type Google", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GOOGLE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GOOGLE", + "sections": [ + { + "body": "constant for Channel Type Google", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_GOOGLE: number", + "source": "script-api", + "tags": [ + "channel_type_google", + "lineitemctnr.channel_type_google" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GOOGLE" + }, + { + "description": "constant for Channel Type Google", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_GOOGLE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_GOOGLE", + "sections": [ + { + "body": "constant for Channel Type Google", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_GOOGLE: number", + "source": "script-api", + "tags": [ + "channel_type_google", + "lineitemctnr.channel_type_google" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_GOOGLE" + }, + { + "description": "constant for Channel Type Instagram Commerce", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "sections": [ + { + "body": "constant for Channel Type Instagram Commerce", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_INSTAGRAMCOMMERCE: number", + "source": "script-api", + "tags": [ + "channel_type_instagramcommerce", + "lineitemctnr.channel_type_instagramcommerce" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE" + }, + { + "description": "constant for Channel Type Instagram Commerce", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE", + "sections": [ + { + "body": "constant for Channel Type Instagram Commerce", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_INSTAGRAMCOMMERCE: number", + "source": "script-api", + "tags": [ + "channel_type_instagramcommerce", + "lineitemctnr.channel_type_instagramcommerce" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_INSTAGRAMCOMMERCE" + }, + { + "description": "constant for Channel Type Marketplace", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_MARKETPLACE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_MARKETPLACE", + "sections": [ + { + "body": "constant for Channel Type Marketplace", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_MARKETPLACE: number", + "source": "script-api", + "tags": [ + "channel_type_marketplace", + "lineitemctnr.channel_type_marketplace" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_MARKETPLACE" + }, + { + "description": "constant for Channel Type Marketplace", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_MARKETPLACE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_MARKETPLACE", + "sections": [ + { + "body": "constant for Channel Type Marketplace", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_MARKETPLACE: number", + "source": "script-api", + "tags": [ + "channel_type_marketplace", + "lineitemctnr.channel_type_marketplace" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_MARKETPLACE" + }, + { + "description": "constant for Channel Type Online Reservation", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_ONLINERESERVATION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION", + "sections": [ + { + "body": "constant for Channel Type Online Reservation", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_ONLINERESERVATION: number", + "source": "script-api", + "tags": [ + "channel_type_onlinereservation", + "lineitemctnr.channel_type_onlinereservation" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION" + }, + { + "description": "constant for Channel Type Online Reservation", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_ONLINERESERVATION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION", + "sections": [ + { + "body": "constant for Channel Type Online Reservation", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_ONLINERESERVATION: number", + "source": "script-api", + "tags": [ + "channel_type_onlinereservation", + "lineitemctnr.channel_type_onlinereservation" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_ONLINERESERVATION" + }, + { + "description": "constant for Channel Type Pinterest", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_PINTEREST", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_PINTEREST", + "sections": [ + { + "body": "constant for Channel Type Pinterest", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_PINTEREST: number", + "source": "script-api", + "tags": [ + "channel_type_pinterest", + "lineitemctnr.channel_type_pinterest" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_PINTEREST" + }, + { + "description": "constant for Channel Type Pinterest", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_PINTEREST", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_PINTEREST", + "sections": [ + { + "body": "constant for Channel Type Pinterest", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_PINTEREST: number", + "source": "script-api", + "tags": [ + "channel_type_pinterest", + "lineitemctnr.channel_type_pinterest" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_PINTEREST" + }, + { + "description": "constant for Channel Type Snapchat", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SNAPCHAT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SNAPCHAT", + "sections": [ + { + "body": "constant for Channel Type Snapchat", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_SNAPCHAT: number", + "source": "script-api", + "tags": [ + "channel_type_snapchat", + "lineitemctnr.channel_type_snapchat" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SNAPCHAT" + }, + { + "description": "constant for Channel Type Snapchat", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SNAPCHAT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SNAPCHAT", + "sections": [ + { + "body": "constant for Channel Type Snapchat", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_SNAPCHAT: number", + "source": "script-api", + "tags": [ + "channel_type_snapchat", + "lineitemctnr.channel_type_snapchat" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SNAPCHAT" + }, + { + "description": "constant for Channel Type Store", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STORE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STORE", + "sections": [ + { + "body": "constant for Channel Type Store", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_STORE: number", + "source": "script-api", + "tags": [ + "channel_type_store", + "lineitemctnr.channel_type_store" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STORE" + }, + { + "description": "constant for Channel Type Store", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STORE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STORE", + "sections": [ + { + "body": "constant for Channel Type Store", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_STORE: number", + "source": "script-api", + "tags": [ + "channel_type_store", + "lineitemctnr.channel_type_store" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STORE" + }, + { + "description": "constant for Channel Type Storefront", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STOREFRONT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STOREFRONT", + "sections": [ + { + "body": "constant for Channel Type Storefront", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_STOREFRONT: number", + "source": "script-api", + "tags": [ + "channel_type_storefront", + "lineitemctnr.channel_type_storefront" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STOREFRONT" + }, + { + "description": "constant for Channel Type Storefront", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_STOREFRONT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_STOREFRONT", + "sections": [ + { + "body": "constant for Channel Type Storefront", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_STOREFRONT: number", + "source": "script-api", + "tags": [ + "channel_type_storefront", + "lineitemctnr.channel_type_storefront" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_STOREFRONT" + }, + { + "description": "constant for Channel Type Subscriptions", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SUBSCRIPTIONS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS", + "sections": [ + { + "body": "constant for Channel Type Subscriptions", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_SUBSCRIPTIONS: number", + "source": "script-api", + "tags": [ + "channel_type_subscriptions", + "lineitemctnr.channel_type_subscriptions" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS" + }, + { + "description": "constant for Channel Type Subscriptions", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_SUBSCRIPTIONS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS", + "sections": [ + { + "body": "constant for Channel Type Subscriptions", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_SUBSCRIPTIONS: number", + "source": "script-api", + "tags": [ + "channel_type_subscriptions", + "lineitemctnr.channel_type_subscriptions" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_SUBSCRIPTIONS" + }, + { + "description": "constant for Channel Type TikTok", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TIKTOK", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TIKTOK", + "sections": [ + { + "body": "constant for Channel Type TikTok", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_TIKTOK: number", + "source": "script-api", + "tags": [ + "channel_type_tiktok", + "lineitemctnr.channel_type_tiktok" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TIKTOK" + }, + { + "description": "constant for Channel Type TikTok", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TIKTOK", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TIKTOK", + "sections": [ + { + "body": "constant for Channel Type TikTok", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_TIKTOK: number", + "source": "script-api", + "tags": [ + "channel_type_tiktok", + "lineitemctnr.channel_type_tiktok" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TIKTOK" + }, + { + "description": "constant for Channel Type Twitter", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TWITTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TWITTER", + "sections": [ + { + "body": "constant for Channel Type Twitter", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_TWITTER: number", + "source": "script-api", + "tags": [ + "channel_type_twitter", + "lineitemctnr.channel_type_twitter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TWITTER" + }, + { + "description": "constant for Channel Type Twitter", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_TWITTER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_TWITTER", + "sections": [ + { + "body": "constant for Channel Type Twitter", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_TWITTER: number", + "source": "script-api", + "tags": [ + "channel_type_twitter", + "lineitemctnr.channel_type_twitter" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_TWITTER" + }, + { + "description": "constant for Channel Type WhatsApp", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_WHATSAPP", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_WHATSAPP", + "sections": [ + { + "body": "constant for Channel Type WhatsApp", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_WHATSAPP: number", + "source": "script-api", + "tags": [ + "channel_type_whatsapp", + "lineitemctnr.channel_type_whatsapp" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_WHATSAPP" + }, + { + "description": "constant for Channel Type WhatsApp", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_WHATSAPP", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_WHATSAPP", + "sections": [ + { + "body": "constant for Channel Type WhatsApp", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_WHATSAPP: number", + "source": "script-api", + "tags": [ + "channel_type_whatsapp", + "lineitemctnr.channel_type_whatsapp" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_WHATSAPP" + }, + { + "description": "constant for Channel Type YouTube", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_YOUTUBE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_YOUTUBE", + "sections": [ + { + "body": "constant for Channel Type YouTube", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_YOUTUBE: number", + "source": "script-api", + "tags": [ + "channel_type_youtube", + "lineitemctnr.channel_type_youtube" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_YOUTUBE" + }, + { + "description": "constant for Channel Type YouTube", + "id": "script-api:dw/order/LineItemCtnr#CHANNEL_TYPE_YOUTUBE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.CHANNEL_TYPE_YOUTUBE", + "sections": [ + { + "body": "constant for Channel Type YouTube", + "heading": "Description" + } + ], + "signature": "static readonly CHANNEL_TYPE_YOUTUBE: number", + "source": "script-api", + "tags": [ + "channel_type_youtube", + "lineitemctnr.channel_type_youtube" + ], + "title": "LineItemCtnr.CHANNEL_TYPE_YOUTUBE" + }, + { + "description": "Adds a note to the object.", + "id": "script-api:dw/order/LineItemCtnr#addNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "subject", + "type": "string" + }, + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.addNote", + "returns": { + "type": "Note" + }, + "sections": [ + { + "body": "Adds a note to the object.", + "heading": "Description" + } + ], + "signature": "addNote(subject: string, text: string): Note", + "source": "script-api", + "tags": [ + "addnote", + "lineitemctnr.addnote" + ], + "title": "LineItemCtnr.addNote" + }, + { + "description": "Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.", + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalGrossPrice", + "sections": [ + { + "body": "Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices\nrepresent the sum of product prices before services such as shipping, but after product-level and order-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalgrossprice", + "lineitemctnr.adjustedmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.", + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalNetPrice", + "sections": [ + { + "body": "Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum\nof product prices before services such as shipping, but after product-level and order-level adjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalnetprice", + "lineitemctnr.adjustedmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalNetPrice" + }, + { + "description": "Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line item container is based on net pricing the adjusted merchandize total net price is returned. If the line item container is based on gross pricing the adjusted merchandize total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalPrice", + "sections": [ + { + "body": "Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line\nitem container is based on net pricing the adjusted merchandize total net price is returned. If the line item\ncontainer is based on gross pricing the adjusted merchandize total gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalprice", + "lineitemctnr.adjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#adjustedMerchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedMerchandizeTotalTax", + "sections": [ + { + "body": "Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices\nbefore services such as shipping have been added, but after adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalTax: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotaltax", + "lineitemctnr.adjustedmerchandizetotaltax" + ], + "title": "LineItemCtnr.adjustedMerchandizeTotalTax" + }, + { + "description": "Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalGrossPrice", + "sections": [ + { + "body": "Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping\nadjustments have been applied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalgrossprice", + "lineitemctnr.adjustedshippingtotalgrossprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalNetPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalnetprice", + "lineitemctnr.adjustedshippingtotalnetprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalNetPrice" + }, + { + "description": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalPrice", + "sections": [ + { + "body": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted\nshipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping\ntotal gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalprice", + "lineitemctnr.adjustedshippingtotalprice" + ], + "title": "LineItemCtnr.adjustedShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#adjustedShippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.adjustedShippingTotalTax", + "sections": [ + { + "body": "Returns the tax of all shipping line items of the line item container after shipping adjustments have been\napplied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalTax: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotaltax", + "lineitemctnr.adjustedshippingtotaltax" + ], + "title": "LineItemCtnr.adjustedShippingTotalTax" + }, + { + "deprecated": { + "message": "Use getGiftCertificateLineItems to get the collection instead." + }, + "description": "Returns all gift certificate line items of the container.", + "id": "script-api:dw/order/LineItemCtnr#allGiftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allGiftCertificateLineItems", + "sections": [ + { + "body": "Returns all gift certificate line items of the container.", + "heading": "Description" + } + ], + "signature": "readonly allGiftCertificateLineItems: Collection", + "source": "script-api", + "tags": [ + "allgiftcertificatelineitems", + "lineitemctnr.allgiftcertificatelineitems" + ], + "title": "LineItemCtnr.allGiftCertificateLineItems" + }, + { + "description": "Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.", + "id": "script-api:dw/order/LineItemCtnr#allLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allLineItems", + "sections": [ + { + "body": "Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.", + "heading": "Description" + } + ], + "signature": "readonly allLineItems: Collection>", + "source": "script-api", + "tags": [ + "alllineitems", + "lineitemctnr.alllineitems" + ], + "title": "LineItemCtnr.allLineItems" + }, + { + "description": "Returns all product line items of the container, no matter if they are dependent or independent. This includes option, bundled and bonus line items.", + "id": "script-api:dw/order/LineItemCtnr#allProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allProductLineItems", + "sections": [ + { + "body": "Returns all product line items of the container, no matter if they are dependent or independent. This includes\noption, bundled and bonus line items.", + "heading": "Description" + } + ], + "signature": "readonly allProductLineItems: Collection", + "source": "script-api", + "tags": [ + "allproductlineitems", + "lineitemctnr.allproductlineitems" + ], + "title": "LineItemCtnr.allProductLineItems" + }, + { + "description": "Returns a hash mapping all products in the line item container to their total quantities. The total product quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to look up prices because it returns products such as bundled line items which are included in the price of their parent and therefore have no corresponding price.", + "id": "script-api:dw/order/LineItemCtnr#allProductQuantities", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allProductQuantities", + "sections": [ + { + "body": "Returns a hash mapping all products in the line item container to their total quantities. The total product\nquantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to\nlook up prices because it returns products such as bundled line items which are included in the price of their\nparent and therefore have no corresponding price.\n\nThe method counts all direct product line items, plus dependent product line items that are not option line\nitems. It also excludes product line items that are not associated to any catalog product.", + "heading": "Description" + } + ], + "signature": "readonly allProductQuantities: HashMap", + "source": "script-api", + "tags": [ + "allproductquantities", + "lineitemctnr.allproductquantities" + ], + "title": "LineItemCtnr.allProductQuantities" + }, + { + "description": "Returns the collection of all shipping price adjustments applied somewhere in the container. This can be adjustments applied to individual shipments or to the container itself. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.", + "id": "script-api:dw/order/LineItemCtnr#allShippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.allShippingPriceAdjustments", + "sections": [ + { + "body": "Returns the collection of all shipping price adjustments applied somewhere in the container. This can be\nadjustments applied to individual shipments or to the container itself. Note that the promotions engine only\napplies shipping price adjustments to the the default shipping line item of shipments, and never to the\ncontainer.", + "heading": "Description" + } + ], + "signature": "readonly allShippingPriceAdjustments: Collection", + "source": "script-api", + "tags": [ + "allshippingpriceadjustments", + "lineitemctnr.allshippingpriceadjustments" + ], + "title": "LineItemCtnr.allShippingPriceAdjustments" + }, + { + "description": "Returns the billing address defined for the container. Returns null if no billing address has been created yet.", + "id": "script-api:dw/order/LineItemCtnr#billingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.billingAddress", + "sections": [ + { + "body": "Returns the billing address defined for the container. Returns null if no billing address has been created yet.", + "heading": "Description" + } + ], + "signature": "readonly billingAddress: OrderAddress | null", + "source": "script-api", + "tags": [ + "billingaddress", + "lineitemctnr.billingaddress" + ], + "title": "LineItemCtnr.billingAddress" + }, + { + "description": "Returns an unsorted collection of the the bonus discount line items associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#bonusDiscountLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.bonusDiscountLineItems", + "sections": [ + { + "body": "Returns an unsorted collection of the the bonus discount line items associated with this container.", + "heading": "Description" + } + ], + "signature": "readonly bonusDiscountLineItems: Collection", + "source": "script-api", + "tags": [ + "bonusdiscountlineitems", + "lineitemctnr.bonusdiscountlineitems" + ], + "title": "LineItemCtnr.bonusDiscountLineItems" + }, + { + "description": "Returns the collection of product line items that are bonus items (where dw.order.ProductLineItem.isBonusProductLineItem is true).", + "id": "script-api:dw/order/LineItemCtnr#bonusLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.bonusLineItems", + "sections": [ + { + "body": "Returns the collection of product line items that are bonus items (where\ndw.order.ProductLineItem.isBonusProductLineItem is true).", + "heading": "Description" + } + ], + "signature": "readonly bonusLineItems: Collection>", + "source": "script-api", + "tags": [ + "bonuslineitems", + "lineitemctnr.bonuslineitems" + ], + "title": "LineItemCtnr.bonusLineItems" + }, + { + "description": "Returns the type of the business this order has been placed in.", + "id": "script-api:dw/order/LineItemCtnr#businessType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.businessType", + "sections": [ + { + "body": "Returns the type of the business this order has been placed in.\n\nPossible values are BUSINESS_TYPE_B2C or BUSINESS_TYPE_B2B.", + "heading": "Description" + } + ], + "signature": "readonly businessType: EnumValue | null", + "source": "script-api", + "tags": [ + "businesstype", + "lineitemctnr.businesstype" + ], + "title": "LineItemCtnr.businessType" + }, + { + "description": "The channel type defines in which sales channel this order has been created. This can be used to distinguish order placed through Storefront, Call Center or Marketplace.", + "id": "script-api:dw/order/LineItemCtnr#channelType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.channelType", + "sections": [ + { + "body": "The channel type defines in which sales channel this order has been created. This can be used to distinguish\norder placed through Storefront, Call Center or Marketplace.\n\nPossible values are CHANNEL_TYPE_STOREFRONT, CHANNEL_TYPE_CALLCENTER,\nCHANNEL_TYPE_MARKETPLACE, CHANNEL_TYPE_DSS, CHANNEL_TYPE_STORE,\nCHANNEL_TYPE_PINTEREST, CHANNEL_TYPE_TWITTER, CHANNEL_TYPE_FACEBOOKADS,\nCHANNEL_TYPE_SUBSCRIPTIONS, CHANNEL_TYPE_ONLINERESERVATION,\nCHANNEL_TYPE_CUSTOMERSERVICECENTER, CHANNEL_TYPE_INSTAGRAMCOMMERCE,\nCHANNEL_TYPE_GOOGLE, CHANNEL_TYPE_YOUTUBE, CHANNEL_TYPE_TIKTOK,\nCHANNEL_TYPE_SNAPCHAT, CHANNEL_TYPE_WHATSAPP, CHANNEL_TYPE_CHATGPT,\nCHANNEL_TYPE_GEMINI", + "heading": "Description" + } + ], + "signature": "readonly channelType: EnumValue | null", + "source": "script-api", + "tags": [ + "channeltype", + "lineitemctnr.channeltype" + ], + "title": "LineItemCtnr.channelType" + }, + { + "description": "Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the order they were added to container.", + "id": "script-api:dw/order/LineItemCtnr#couponLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.couponLineItems", + "sections": [ + { + "body": "Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the\norder they were added to container.", + "heading": "Description" + } + ], + "signature": "readonly couponLineItems: Collection", + "source": "script-api", + "tags": [ + "couponlineitems", + "lineitemctnr.couponlineitems" + ], + "title": "LineItemCtnr.couponLineItems" + }, + { + "description": "Create a billing address for the LineItemCtnr. A LineItemCtnr (e.g. basket) initially has no billing address. This method creates a billing address for the LineItemCtnr and replaces an existing billing address.", + "id": "script-api:dw/order/LineItemCtnr#createBillingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createBillingAddress", + "returns": { + "type": "OrderAddress" + }, + "sections": [ + { + "body": "Create a billing address for the LineItemCtnr. A LineItemCtnr (e.g. basket) initially has no billing address.\nThis method creates a billing address for the LineItemCtnr and replaces an existing billing address.", + "heading": "Description" + } + ], + "signature": "createBillingAddress(): OrderAddress", + "source": "script-api", + "tags": [ + "createbillingaddress", + "lineitemctnr.createbillingaddress" + ], + "title": "LineItemCtnr.createBillingAddress" + }, + { + "description": "Creates a product line item in the container based on the passed Product and BonusDiscountLineItem. The product must be assigned to the current site catalog and must also be a bonus product of the specified BonusDiscountLineItem or an exception is thrown. The line item is always created in the default shipment. If successful, the operation always creates a new ProductLineItem and never simply increments the quantity of an existing ProductLineItem. An option model can optionally be specified.", + "id": "script-api:dw/order/LineItemCtnr#createBonusProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "bonusDiscountLineItem", + "type": "BonusDiscountLineItem" + }, + { + "name": "product", + "type": "Product" + }, + { + "name": "optionModel", + "type": "ProductOptionModel | null" + }, + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createBonusProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Creates a product line item in the container based on the passed Product and BonusDiscountLineItem. The product\nmust be assigned to the current site catalog and must also be a bonus product of the specified\nBonusDiscountLineItem or an exception is thrown. The line item is always created in the default shipment. If\nsuccessful, the operation always creates a new ProductLineItem and never simply increments the quantity of an\nexisting ProductLineItem. An option model can optionally be specified.", + "heading": "Description" + } + ], + "signature": "createBonusProductLineItem(bonusDiscountLineItem: BonusDiscountLineItem, product: Product, optionModel: ProductOptionModel | null, shipment: Shipment): ProductLineItem", + "source": "script-api", + "tags": [ + "createbonusproductlineitem", + "lineitemctnr.createbonusproductlineitem" + ], + "title": "LineItemCtnr.createBonusProductLineItem" + }, + { + "description": "Creates a new CouponLineItem for this container based on the supplied coupon code.", + "examples": [ + "try {\nvar cli : CouponLineItem = basket.createCouponLineItem(couponCode, true);\n} catch (e if e instanceof APIException && e.type === 'CreateCouponLineItemException')\nif (e.errorCode == CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET) {\n...\n}\n}" + ], + "id": "script-api:dw/order/LineItemCtnr#createCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "couponCode", + "type": "string" + }, + { + "name": "campaignBased", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createCouponLineItem", + "returns": { + "type": "CouponLineItem" + }, + "sections": [ + { + "body": "Creates a new CouponLineItem for this container based on the supplied coupon code.\n\nThe created coupon line item is based on the B2C Commerce campaign system if campaignBased parameter is true. In\nthat case, if the supplied coupon code is not valid, APIException with type 'CreateCouponLineItemException' is\nthrown.\n\nIf you want to create a custom coupon line item, you must call this method with campaignBased = false or to use\ncreateCouponLineItem.\n\nExample:\n\n\nAn dw.order.CreateCouponLineItemException is thrown in case of campaignBased = true only. Indicates that the\nprovided coupon code is not a valid coupon code to create a coupon line item based on the B2C Commerce campaign\nsystem. The error code property (CreateCouponLineItemException.errorCode) will be set to one of the following\nvalues:\n\n- dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET = Indicates that coupon code has already\nbeen added to basket.\n- dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET = Indicates that another code of the same\nMultiCode/System coupon has already been added to basket.\n- dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED = Indicates that code of MultiCode/System\ncoupon has already been redeemed.\n- dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN = Indicates that coupon not found for given coupon\ncode or that the code itself was not found.\n- dw.campaign.CouponStatusCodes.COUPON_DISABLED = Indicates that coupon is not enabled.\n- dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per\ncode exceeded.\n- dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of\nredemptions per code and customer exceeded.\n- dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of\nredemptions per code, customer and time exceeded.\n- dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION = Indicates that coupon is not assigned to an\nactive promotion.", + "heading": "Description" + } + ], + "signature": "createCouponLineItem(couponCode: string, campaignBased: boolean): CouponLineItem", + "source": "script-api", + "tags": [ + "createcouponlineitem", + "lineitemctnr.createcouponlineitem" + ], + "title": "LineItemCtnr.createCouponLineItem" + }, + { + "description": "Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the specified coupon code.", + "id": "script-api:dw/order/LineItemCtnr#createCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createCouponLineItem", + "returns": { + "type": "CouponLineItem" + }, + "sections": [ + { + "body": "Creates a coupon line item that is not based on the B2C Commerce campaign system and associates it with the\nspecified coupon code.\n\nThere may not be any other coupon line item in the container with the specific coupon code, otherwise an\nexception is thrown.\n\nIf you want to create a coupon line item based on the B2C Commerce campaign system, you must use\ncreateCouponLineItem with campaignBased = true.", + "heading": "Description" + } + ], + "signature": "createCouponLineItem(couponCode: string): CouponLineItem", + "source": "script-api", + "tags": [ + "createcouponlineitem", + "lineitemctnr.createcouponlineitem" + ], + "title": "LineItemCtnr.createCouponLineItem" + }, + { + "description": "Creates a gift certificate line item.", + "id": "script-api:dw/order/LineItemCtnr#createGiftCertificateLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "number" + }, + { + "name": "recipientEmail", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createGiftCertificateLineItem", + "returns": { + "type": "GiftCertificateLineItem" + }, + "sections": [ + { + "body": "Creates a gift certificate line item.", + "heading": "Description" + } + ], + "signature": "createGiftCertificateLineItem(amount: number, recipientEmail: string): GiftCertificateLineItem", + "source": "script-api", + "tags": [ + "creategiftcertificatelineitem", + "lineitemctnr.creategiftcertificatelineitem" + ], + "title": "LineItemCtnr.createGiftCertificateLineItem" + }, + { + "description": "Creates an OrderPaymentInstrument representing a Gift Certificate. The amount is set on a PaymentTransaction that is accessible via the OrderPaymentInstrument. By default, the status of the PaymentTransaction is set to CREATE. The PaymentTransaction must be processed at a later time.", + "id": "script-api:dw/order/LineItemCtnr#createGiftCertificatePaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + }, + { + "name": "amount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createGiftCertificatePaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument" + }, + "sections": [ + { + "body": "Creates an OrderPaymentInstrument representing a Gift Certificate. The amount is set on a PaymentTransaction that\nis accessible via the OrderPaymentInstrument. By default, the status of the PaymentTransaction is set to CREATE.\nThe PaymentTransaction must be processed at a later time.", + "heading": "Description" + } + ], + "signature": "createGiftCertificatePaymentInstrument(giftCertificateCode: string, amount: Money): OrderPaymentInstrument", + "source": "script-api", + "tags": [ + "creategiftcertificatepaymentinstrument", + "lineitemctnr.creategiftcertificatepaymentinstrument" + ], + "title": "LineItemCtnr.createGiftCertificatePaymentInstrument" + }, + { + "description": "Creates a payment instrument using the specified payment method id and amount. The amount is set on the PaymentTransaction that is attached to the payment instrument.", + "id": "script-api:dw/order/LineItemCtnr#createPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "paymentMethodId", + "type": "string" + }, + { + "name": "amount", + "type": "Money | null" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument" + }, + "sections": [ + { + "body": "Creates a payment instrument using the specified payment method id and amount. The amount is set on the\nPaymentTransaction that is attached to the payment instrument.", + "heading": "Description" + } + ], + "signature": "createPaymentInstrument(paymentMethodId: string, amount: Money | null): OrderPaymentInstrument", + "source": "script-api", + "tags": [ + "createpaymentinstrument", + "lineitemctnr.createpaymentinstrument" + ], + "title": "LineItemCtnr.createPaymentInstrument" + }, + { + "description": "Creates a payment instrument using the specified wallet payment instrument and amount. The amount is set on the PaymentTransaction that is attached to the payment instrument. All data from the wallet payment instrument will be copied over to the created payment instrument.", + "id": "script-api:dw/order/LineItemCtnr#createPaymentInstrumentFromWallet", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "walletPaymentInstrument", + "type": "CustomerPaymentInstrument" + }, + { + "name": "amount", + "type": "Money | null" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPaymentInstrumentFromWallet", + "returns": { + "type": "OrderPaymentInstrument" + }, + "sections": [ + { + "body": "Creates a payment instrument using the specified wallet payment instrument and amount. The amount is set on the\nPaymentTransaction that is attached to the payment instrument. All data from the wallet payment\ninstrument will be copied over to the created payment instrument.", + "heading": "Description" + } + ], + "signature": "createPaymentInstrumentFromWallet(walletPaymentInstrument: CustomerPaymentInstrument, amount: Money | null): OrderPaymentInstrument", + "source": "script-api", + "tags": [ + "createpaymentinstrumentfromwallet", + "lineitemctnr.createpaymentinstrumentfromwallet" + ], + "title": "LineItemCtnr.createPaymentInstrumentFromWallet" + }, + { + "description": "Creates an order price adjustment.", + "id": "script-api:dw/order/LineItemCtnr#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates an order price adjustment.\n\nThe promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise\nan exception is thrown.", + "heading": "Description" + } + ], + "signature": "createPriceAdjustment(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "createpriceadjustment", + "lineitemctnr.createpriceadjustment" + ], + "title": "LineItemCtnr.createPriceAdjustment" + }, + { + "description": "Creates an order level price adjustment for a specific discount.", + "id": "script-api:dw/order/LineItemCtnr#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + }, + { + "name": "discount", + "type": "Discount" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates an order level price adjustment for a specific discount.\n\nThe promotion id is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise\nan exception is thrown.\n\nThe possible discount types are supported: dw.campaign.PercentageDiscount and\ndw.campaign.AmountDiscount.\n\nExamples:\n\n`\nvar myOrder : dw.order.Order; // assume known\n\nvar paTenPercent : dw.order.PriceAdjustment = myOrder.createPriceAdjustment(\"myPromotionID1\", new dw.campaign.PercentageDiscount(10));\n\nvar paReduceBy20 : dw.order.PriceAdjustment = myOrder.createPriceAdjustment(\"myPromotionID2\", new dw.campaign.AmountDiscount(20);\n\n`", + "heading": "Description" + } + ], + "signature": "createPriceAdjustment(promotionID: string, discount: Discount): PriceAdjustment", + "source": "script-api", + "tags": [ + "createpriceadjustment", + "lineitemctnr.createpriceadjustment" + ], + "title": "LineItemCtnr.createPriceAdjustment" + }, + { + "deprecated": { + "message": "Use createProductLineItem or\ndw.order.ProductLineItem.updateQuantity instead." + }, + "description": "Creates a new product line item in the container and assigns it to the specified shipment.", + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productID", + "type": "string" + }, + { + "name": "quantity", + "type": "Quantity" + }, + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Creates a new product line item in the container and assigns it to the specified shipment.\n\nIf the specified productID represents a product in the site catalog, the method will associate the product line\nitem with that catalog product and will copy all order-relevant information, like the quantity unit, from the\ncatalog product.\n\nIf the specified productID does not represent a product of the site catalog, the method creates a new product\nline item and initializes it with the specified product ID and quantity. If the passed in quantity value is not a\npositive integer, it will be rounded to the nearest positive integer. The minimum order quantity and step\nquantity will be set to 1.0.\n\nFor catalog products, the method follows the configured 'Add2Basket' strategy to either increment the quantity of\nan existing product line item or create a new product line item for the same product. For non-catalog products,\nthe method creates a new product line item no matter if the same product is already in the line item container.\nIf a negative quantity is specified, it is automatically changed to 1.0.", + "heading": "Description" + } + ], + "signature": "createProductLineItem(productID: string, quantity: Quantity, shipment: Shipment): ProductLineItem", + "source": "script-api", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "description": "Creates a new product line item in the container and assigns it to the specified shipment.", + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productID", + "type": "string" + }, + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Creates a new product line item in the container and assigns it to the specified shipment.\n\nIf the specified productID represents a product in the site catalog, the method will associate the product line\nitem with that catalog product and will copy all order-relevant information, like the quantity unit, from the\ncatalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum\norder quantity of the product.\n\nIf the product represents a product in the site catalog and is an option product, the product is added with it's\ndefault option values.\n\nIf the specified productID does not represent a product of the site catalog, the method creates a new product\nline item and initializes it with the specified product ID and with a quantity, minimum order quantity, and step\nquantity value of 1.0.\n\nIf the provided SKU references a product that is not available as described in method dw.order.ProductLineItem.isCatalogProduct, the new product line item is considered a non-catalog product line item without a connection to a product. Such product line items are not included in reservation requests in either OCI-based inventory or eCom-based inventory when calling dw.order.Basket.reserveInventory or dw.order.OrderMgr.createOrder.", + "heading": "Description" + } + ], + "signature": "createProductLineItem(productID: string, shipment: Shipment): ProductLineItem", + "source": "script-api", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "description": "Creates a new product line item in the basket and assigns it to the specified shipment.", + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productListItem", + "type": "ProductListItem" + }, + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Creates a new product line item in the basket and assigns it to the specified shipment.\n\nIf the product list item references a product in the site catalog, the method will associate the product line\nitem with that catalog product and will copy all order-relevant information, like the quantity unit, from the\ncatalog product. The quantity of the product line item is initialized with 1.0 or - if defined - the minimum\norder quantity of the product.\n\nIf the product list item references an option product, the option values are copied from the product list item.\n\nIf the product list item is associated with an existing product line item, and the BasketAddProductBehaviour\nsetting is MergeQuantities, then the product line item quantity is increased by 1.0 or, if defined, the minimum\norder quantity of the product.\n\nAn exception is thrown if\n\n- the line item container is no basket.\n- the type of the product list item is not PRODUCT.\n- the product list item references a product which is not assigned to the site catalog.", + "heading": "Description" + } + ], + "signature": "createProductLineItem(productListItem: ProductListItem, shipment: Shipment): ProductLineItem", + "source": "script-api", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "description": "Creates a new product line item in the container and assigns it to the specified shipment. An option model can be specified.", + "id": "script-api:dw/order/LineItemCtnr#createProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "product", + "type": "Product" + }, + { + "name": "optionModel", + "type": "ProductOptionModel | null" + }, + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Creates a new product line item in the container and assigns it to the specified shipment. An option model can be\nspecified.\n\nPlease note that the product must be assigned to the current site catalog.", + "heading": "Description" + } + ], + "signature": "createProductLineItem(product: Product, optionModel: ProductOptionModel | null, shipment: Shipment): ProductLineItem", + "source": "script-api", + "tags": [ + "createproductlineitem", + "lineitemctnr.createproductlineitem" + ], + "title": "LineItemCtnr.createProductLineItem" + }, + { + "description": "Creates a standard shipment for the line item container. The specified ID must not yet be in use for another shipment of this line item container.", + "id": "script-api:dw/order/LineItemCtnr#createShipment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createShipment", + "returns": { + "type": "Shipment" + }, + "sections": [ + { + "body": "Creates a standard shipment for the line item container. The specified ID must not yet be in use for another\nshipment of this line item container.", + "heading": "Description" + } + ], + "signature": "createShipment(id: string): Shipment", + "source": "script-api", + "tags": [ + "createshipment", + "lineitemctnr.createshipment" + ], + "title": "LineItemCtnr.createShipment" + }, + { + "description": "Creates a shipping price adjustment to be applied to the container.", + "id": "script-api:dw/order/LineItemCtnr#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.createShippingPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a shipping price adjustment to be applied to the container.\n\nThe promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce; otherwise\nthe method will throw an exception.\n\nIf there already exists a shipping price adjustment referring to the specified promotion ID, an exception is\nthrown.", + "heading": "Description" + } + ], + "signature": "createShippingPriceAdjustment(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "createshippingpriceadjustment", + "lineitemctnr.createshippingpriceadjustment" + ], + "title": "LineItemCtnr.createShippingPriceAdjustment" + }, + { + "description": "Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the buyer sees all prices in the store front.", + "id": "script-api:dw/order/LineItemCtnr#currencyCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.currencyCode", + "sections": [ + { + "body": "Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such\nas 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the\nbuyer sees all prices in the store front.", + "heading": "Description" + } + ], + "signature": "readonly currencyCode: string", + "source": "script-api", + "tags": [ + "currencycode", + "lineitemctnr.currencycode" + ], + "title": "LineItemCtnr.currencyCode" + }, + { + "description": "Returns the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#customer", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customer", + "sections": [ + { + "body": "Returns the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "readonly customer: Customer", + "source": "script-api", + "tags": [ + "customer", + "lineitemctnr.customer" + ], + "title": "LineItemCtnr.customer" + }, + { + "description": "Returns the email of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#customerEmail", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerEmail", + "sections": [ + { + "body": "Returns the email of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "customerEmail: string", + "source": "script-api", + "tags": [ + "customeremail", + "lineitemctnr.customeremail" + ], + "title": "LineItemCtnr.customerEmail" + }, + { + "description": "Returns the name of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#customerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerName", + "sections": [ + { + "body": "Returns the name of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "customerName: string", + "source": "script-api", + "tags": [ + "customername", + "lineitemctnr.customername" + ], + "title": "LineItemCtnr.customerName" + }, + { + "description": "Returns the customer number of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#customerNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.customerNo", + "sections": [ + { + "body": "Returns the customer number of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "readonly customerNo: string", + "source": "script-api", + "tags": [ + "customerno", + "lineitemctnr.customerno" + ], + "title": "LineItemCtnr.customerNo" + }, + { + "description": "Returns the default shipment of the line item container. Baskets always have a default shipment with ID \"me\". For orders, this can differ, for example: dw.order.OrderMgr.createOrder removes empty shipments, so if the basket's \"me\" shipment was empty at order creation, the order has no \"me\" shipment. In that case, the shipment with the lowest ID is returned as the fallback, or `null` if the order has no shipments. See dw.order.Shipment.isDefault for the matching logic.", + "id": "script-api:dw/order/LineItemCtnr#defaultShipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.defaultShipment", + "sections": [ + { + "body": "Returns the default shipment of the line item container. Baskets always have a default shipment with ID \"me\".\nFor orders, this can differ, for example: dw.order.OrderMgr.createOrder removes empty\nshipments, so if the basket's \"me\" shipment was empty at order creation, the order has no \"me\" shipment. In\nthat case, the shipment with the lowest ID is returned as the fallback, or `null` if the order has\nno shipments. See dw.order.Shipment.isDefault for the matching logic.\n\nProcesses that access a shipment use the default shipment when none is specified. The default shipment can't be\nremoved. Calling removeShipment on it throws an exception.", + "heading": "Description" + } + ], + "signature": "readonly defaultShipment: Shipment | null", + "source": "script-api", + "tags": [ + "defaultshipment", + "lineitemctnr.defaultshipment" + ], + "title": "LineItemCtnr.defaultShipment" + }, + { + "description": "Returns the Etag of the line item container. The Etag is a hash that represents the overall container state including any associated objects like line items.", + "id": "script-api:dw/order/LineItemCtnr#etag", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.etag", + "sections": [ + { + "body": "Returns the Etag of the line item container. The Etag is a hash that represents the overall container state\nincluding any associated objects like line items.", + "heading": "Description" + } + ], + "signature": "readonly etag: string", + "source": "script-api", + "tags": [ + "etag", + "lineitemctnr.etag" + ], + "title": "LineItemCtnr.etag" + }, + { + "description": "Use this method to check whether the LineItemCtnr is calculated based on external tax tables.", + "id": "script-api:dw/order/LineItemCtnr#externallyTaxed", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.externallyTaxed", + "sections": [ + { + "body": "Use this method to check whether the LineItemCtnr is calculated based on external tax tables.\n\nNote: a basket can only be created in EXTERNAL tax mode using SCAPI.", + "heading": "Description" + } + ], + "signature": "readonly externallyTaxed: boolean", + "source": "script-api", + "tags": [ + "externallytaxed", + "lineitemctnr.externallytaxed" + ], + "title": "LineItemCtnr.externallyTaxed" + }, + { + "description": "Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted total gross price (including tax) in purchase currency. Adjusted merchandize prices\nrepresent the sum of product prices before services such as shipping, but after product-level and order-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalgrossprice", + "lineitemctnr.getadjustedmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping, but after product-level and order-level adjustments.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total net price (excluding tax) in purchase currency. Adjusted merchandize prices represent the sum\nof product prices before services such as shipping, but after product-level and order-level adjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalnetprice", + "lineitemctnr.getadjustedmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalNetPrice" + }, + { + "description": "Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line item container is based on net pricing the adjusted merchandize total net price is returned. If the line item container is based on gross pricing the adjusted merchandize total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted merchandize total price including product-level and order-level adjustments. If the line\nitem container is based on net pricing the adjusted merchandize total net price is returned. If the line item\ncontainer is based on gross pricing the adjusted merchandize total gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalprice", + "lineitemctnr.getadjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the adjusted merchandize total price including order-level adjustments if requested. If the line item container is based on net pricing the adjusted merchandize total net price is returned. If the line item container is based on gross pricing the adjusted merchandize total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "applyOrderLevelAdjustments", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted merchandize total price including order-level adjustments if requested. If the line item\ncontainer is based on net pricing the adjusted merchandize total net price is returned. If the line item\ncontainer is based on gross pricing the adjusted merchandize total gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments: boolean): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalprice", + "lineitemctnr.getadjustedmerchandizetotalprice" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedMerchandizeTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the subtotal tax in purchase currency. Adjusted merchandize prices represent the sum of product prices\nbefore services such as shipping have been added, but after adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotaltax", + "lineitemctnr.getadjustedmerchandizetotaltax" + ], + "title": "LineItemCtnr.getAdjustedMerchandizeTotalTax" + }, + { + "description": "Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted sum of all shipping line items of the line item container, including tax after shipping\nadjustments have been applied.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalgrossprice", + "lineitemctnr.getadjustedshippingtotalgrossprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, excluding tax after shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalnetprice", + "lineitemctnr.getadjustedshippingtotalnetprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalNetPrice" + }, + { + "description": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted\nshipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping\ntotal gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalprice", + "lineitemctnr.getadjustedshippingtotalprice" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the line item container after shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getAdjustedShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAdjustedShippingTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of all shipping line items of the line item container after shipping adjustments have been\napplied.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotaltax", + "lineitemctnr.getadjustedshippingtotaltax" + ], + "title": "LineItemCtnr.getAdjustedShippingTotalTax" + }, + { + "deprecated": { + "message": "Use getGiftCertificateLineItems to get the collection instead." + }, + "description": "Returns all gift certificate line items of the container.", + "id": "script-api:dw/order/LineItemCtnr#getAllGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllGiftCertificateLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all gift certificate line items of the container.", + "heading": "Description" + } + ], + "signature": "getAllGiftCertificateLineItems(): Collection", + "source": "script-api", + "tags": [ + "getallgiftcertificatelineitems", + "lineitemctnr.getallgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getAllGiftCertificateLineItems" + }, + { + "description": "Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.", + "id": "script-api:dw/order/LineItemCtnr#getAllLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllLineItems", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns all product, shipping, price adjustment, and gift certificate line items of the line item container.", + "heading": "Description" + } + ], + "signature": "getAllLineItems(): Collection>", + "source": "script-api", + "tags": [ + "getalllineitems", + "lineitemctnr.getalllineitems" + ], + "title": "LineItemCtnr.getAllLineItems" + }, + { + "description": "Returns all product line items of the container, no matter if they are dependent or independent. This includes option, bundled and bonus line items.", + "id": "script-api:dw/order/LineItemCtnr#getAllProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product line items of the container, no matter if they are dependent or independent. This includes\noption, bundled and bonus line items.", + "heading": "Description" + } + ], + "signature": "getAllProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getallproductlineitems", + "lineitemctnr.getallproductlineitems" + ], + "title": "LineItemCtnr.getAllProductLineItems" + }, + { + "description": "Returns all product line items of the container that have a product ID equal to the specified product ID, no matter if they are dependent or independent. This includes option, bundled and bonus line items.", + "id": "script-api:dw/order/LineItemCtnr#getAllProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all product line items of the container that have a product ID equal to the specified product ID, no\nmatter if they are dependent or independent. This includes option, bundled and bonus line items.", + "heading": "Description" + } + ], + "signature": "getAllProductLineItems(productID: string): Collection", + "source": "script-api", + "tags": [ + "getallproductlineitems", + "lineitemctnr.getallproductlineitems" + ], + "title": "LineItemCtnr.getAllProductLineItems" + }, + { + "description": "Returns a hash mapping all products in the line item container to their total quantities. The total product quantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to look up prices because it returns products such as bundled line items which are included in the price of their parent and therefore have no corresponding price.", + "id": "script-api:dw/order/LineItemCtnr#getAllProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllProductQuantities", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns a hash mapping all products in the line item container to their total quantities. The total product\nquantity is used chiefly to validate the availability of the items in the cart. This method is not appropriate to\nlook up prices because it returns products such as bundled line items which are included in the price of their\nparent and therefore have no corresponding price.\n\nThe method counts all direct product line items, plus dependent product line items that are not option line\nitems. It also excludes product line items that are not associated to any catalog product.", + "heading": "Description" + } + ], + "signature": "getAllProductQuantities(): HashMap", + "source": "script-api", + "tags": [ + "getallproductquantities", + "lineitemctnr.getallproductquantities" + ], + "title": "LineItemCtnr.getAllProductQuantities" + }, + { + "description": "Returns the collection of all shipping price adjustments applied somewhere in the container. This can be adjustments applied to individual shipments or to the container itself. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.", + "id": "script-api:dw/order/LineItemCtnr#getAllShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getAllShippingPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of all shipping price adjustments applied somewhere in the container. This can be\nadjustments applied to individual shipments or to the container itself. Note that the promotions engine only\napplies shipping price adjustments to the the default shipping line item of shipments, and never to the\ncontainer.", + "heading": "Description" + } + ], + "signature": "getAllShippingPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getallshippingpriceadjustments", + "lineitemctnr.getallshippingpriceadjustments" + ], + "title": "LineItemCtnr.getAllShippingPriceAdjustments" + }, + { + "description": "Returns the billing address defined for the container. Returns null if no billing address has been created yet.", + "id": "script-api:dw/order/LineItemCtnr#getBillingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBillingAddress", + "returns": { + "type": "OrderAddress | null" + }, + "sections": [ + { + "body": "Returns the billing address defined for the container. Returns null if no billing address has been created yet.", + "heading": "Description" + } + ], + "signature": "getBillingAddress(): OrderAddress | null", + "source": "script-api", + "tags": [ + "getbillingaddress", + "lineitemctnr.getbillingaddress" + ], + "title": "LineItemCtnr.getBillingAddress" + }, + { + "description": "Returns an unsorted collection of the the bonus discount line items associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#getBonusDiscountLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBonusDiscountLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an unsorted collection of the the bonus discount line items associated with this container.", + "heading": "Description" + } + ], + "signature": "getBonusDiscountLineItems(): Collection", + "source": "script-api", + "tags": [ + "getbonusdiscountlineitems", + "lineitemctnr.getbonusdiscountlineitems" + ], + "title": "LineItemCtnr.getBonusDiscountLineItems" + }, + { + "description": "Returns the collection of product line items that are bonus items (where dw.order.ProductLineItem.isBonusProductLineItem is true).", + "id": "script-api:dw/order/LineItemCtnr#getBonusLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBonusLineItems", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns the collection of product line items that are bonus items (where\ndw.order.ProductLineItem.isBonusProductLineItem is true).", + "heading": "Description" + } + ], + "signature": "getBonusLineItems(): Collection>", + "source": "script-api", + "tags": [ + "getbonuslineitems", + "lineitemctnr.getbonuslineitems" + ], + "title": "LineItemCtnr.getBonusLineItems" + }, + { + "description": "Returns the type of the business this order has been placed in.", + "id": "script-api:dw/order/LineItemCtnr#getBusinessType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getBusinessType", + "returns": { + "type": "EnumValue | null" + }, + "sections": [ + { + "body": "Returns the type of the business this order has been placed in.\n\nPossible values are BUSINESS_TYPE_B2C or BUSINESS_TYPE_B2B.", + "heading": "Description" + } + ], + "signature": "getBusinessType(): EnumValue | null", + "source": "script-api", + "tags": [ + "getbusinesstype", + "lineitemctnr.getbusinesstype" + ], + "title": "LineItemCtnr.getBusinessType" + }, + { + "description": "The channel type defines in which sales channel this order has been created. This can be used to distinguish order placed through Storefront, Call Center or Marketplace.", + "id": "script-api:dw/order/LineItemCtnr#getChannelType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getChannelType", + "returns": { + "type": "EnumValue | null" + }, + "sections": [ + { + "body": "The channel type defines in which sales channel this order has been created. This can be used to distinguish\norder placed through Storefront, Call Center or Marketplace.\n\nPossible values are CHANNEL_TYPE_STOREFRONT, CHANNEL_TYPE_CALLCENTER,\nCHANNEL_TYPE_MARKETPLACE, CHANNEL_TYPE_DSS, CHANNEL_TYPE_STORE,\nCHANNEL_TYPE_PINTEREST, CHANNEL_TYPE_TWITTER, CHANNEL_TYPE_FACEBOOKADS,\nCHANNEL_TYPE_SUBSCRIPTIONS, CHANNEL_TYPE_ONLINERESERVATION,\nCHANNEL_TYPE_CUSTOMERSERVICECENTER, CHANNEL_TYPE_INSTAGRAMCOMMERCE,\nCHANNEL_TYPE_GOOGLE, CHANNEL_TYPE_YOUTUBE, CHANNEL_TYPE_TIKTOK,\nCHANNEL_TYPE_SNAPCHAT, CHANNEL_TYPE_WHATSAPP, CHANNEL_TYPE_CHATGPT,\nCHANNEL_TYPE_GEMINI", + "heading": "Description" + } + ], + "signature": "getChannelType(): EnumValue | null", + "source": "script-api", + "tags": [ + "getchanneltype", + "lineitemctnr.getchanneltype" + ], + "title": "LineItemCtnr.getChannelType" + }, + { + "description": "Returns the coupon line item representing the specified coupon code.", + "id": "script-api:dw/order/LineItemCtnr#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "couponCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCouponLineItem", + "returns": { + "type": "CouponLineItem | null" + }, + "sections": [ + { + "body": "Returns the coupon line item representing the specified coupon code.", + "heading": "Description" + } + ], + "signature": "getCouponLineItem(couponCode: string): CouponLineItem | null", + "source": "script-api", + "tags": [ + "getcouponlineitem", + "lineitemctnr.getcouponlineitem" + ], + "title": "LineItemCtnr.getCouponLineItem" + }, + { + "description": "Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the order they were added to container.", + "id": "script-api:dw/order/LineItemCtnr#getCouponLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCouponLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a sorted collection of the coupon line items in the container. The coupon line items are returned in the\norder they were added to container.", + "heading": "Description" + } + ], + "signature": "getCouponLineItems(): Collection", + "source": "script-api", + "tags": [ + "getcouponlineitems", + "lineitemctnr.getcouponlineitems" + ], + "title": "LineItemCtnr.getCouponLineItems" + }, + { + "description": "Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such as 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the buyer sees all prices in the store front.", + "id": "script-api:dw/order/LineItemCtnr#getCurrencyCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCurrencyCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the currency code for this line item container. The currency code is a 3-character currency mnemonic such\nas 'USD' or 'EUR'. The currency code represents the currency in which the calculation is made, and in which the\nbuyer sees all prices in the store front.", + "heading": "Description" + } + ], + "signature": "getCurrencyCode(): string", + "source": "script-api", + "tags": [ + "getcurrencycode", + "lineitemctnr.getcurrencycode" + ], + "title": "LineItemCtnr.getCurrencyCode" + }, + { + "description": "Returns the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#getCustomer", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomer", + "returns": { + "type": "Customer" + }, + "sections": [ + { + "body": "Returns the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "getCustomer(): Customer", + "source": "script-api", + "tags": [ + "getcustomer", + "lineitemctnr.getcustomer" + ], + "title": "LineItemCtnr.getCustomer" + }, + { + "description": "Returns the email of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#getCustomerEmail", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerEmail", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the email of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "getCustomerEmail(): string", + "source": "script-api", + "tags": [ + "getcustomeremail", + "lineitemctnr.getcustomeremail" + ], + "title": "LineItemCtnr.getCustomerEmail" + }, + { + "description": "Returns the name of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#getCustomerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "getCustomerName(): string", + "source": "script-api", + "tags": [ + "getcustomername", + "lineitemctnr.getcustomername" + ], + "title": "LineItemCtnr.getCustomerName" + }, + { + "description": "Returns the customer number of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#getCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getCustomerNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer number of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "getCustomerNo(): string", + "source": "script-api", + "tags": [ + "getcustomerno", + "lineitemctnr.getcustomerno" + ], + "title": "LineItemCtnr.getCustomerNo" + }, + { + "description": "Returns the default shipment of the line item container. Baskets always have a default shipment with ID \"me\". For orders, this can differ, for example: dw.order.OrderMgr.createOrder removes empty shipments, so if the basket's \"me\" shipment was empty at order creation, the order has no \"me\" shipment. In that case, the shipment with the lowest ID is returned as the fallback, or `null` if the order has no shipments. See dw.order.Shipment.isDefault for the matching logic.", + "id": "script-api:dw/order/LineItemCtnr#getDefaultShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getDefaultShipment", + "returns": { + "type": "Shipment | null" + }, + "sections": [ + { + "body": "Returns the default shipment of the line item container. Baskets always have a default shipment with ID \"me\".\nFor orders, this can differ, for example: dw.order.OrderMgr.createOrder removes empty\nshipments, so if the basket's \"me\" shipment was empty at order creation, the order has no \"me\" shipment. In\nthat case, the shipment with the lowest ID is returned as the fallback, or `null` if the order has\nno shipments. See dw.order.Shipment.isDefault for the matching logic.\n\nProcesses that access a shipment use the default shipment when none is specified. The default shipment can't be\nremoved. Calling removeShipment on it throws an exception.", + "heading": "Description" + } + ], + "signature": "getDefaultShipment(): Shipment | null", + "source": "script-api", + "tags": [ + "getdefaultshipment", + "lineitemctnr.getdefaultshipment" + ], + "title": "LineItemCtnr.getDefaultShipment" + }, + { + "description": "Returns the Etag of the line item container. The Etag is a hash that represents the overall container state including any associated objects like line items.", + "id": "script-api:dw/order/LineItemCtnr#getEtag", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getEtag", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Etag of the line item container. The Etag is a hash that represents the overall container state\nincluding any associated objects like line items.", + "heading": "Description" + } + ], + "signature": "getEtag(): string", + "source": "script-api", + "tags": [ + "getetag", + "lineitemctnr.getetag" + ], + "title": "LineItemCtnr.getEtag" + }, + { + "description": "Returns all gift certificate line items of the container.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all gift certificate line items of the container.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateLineItems(): Collection", + "source": "script-api", + "tags": [ + "getgiftcertificatelineitems", + "lineitemctnr.getgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getGiftCertificateLineItems" + }, + { + "description": "Returns all gift certificate line items of the container, no matter if they are dependent or independent.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateId", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all gift certificate line items of the container, no matter if they are dependent or independent.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateLineItems(giftCertificateId: string): Collection", + "source": "script-api", + "tags": [ + "getgiftcertificatelineitems", + "lineitemctnr.getgiftcertificatelineitems" + ], + "title": "LineItemCtnr.getGiftCertificateLineItems" + }, + { + "description": "Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificatePaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificatePaymentInstruments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this\ncontainer.", + "heading": "Description" + } + ], + "signature": "getGiftCertificatePaymentInstruments(): Collection", + "source": "script-api", + "tags": [ + "getgiftcertificatepaymentinstruments", + "lineitemctnr.getgiftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.getGiftCertificatePaymentInstruments" + }, + { + "description": "Returns an unsorted collection containing all PaymentInstruments of type PaymentInstrument.METHOD_GIFT_CERTIFICATE where the specified code is the same code on the payment instrument.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificatePaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificatePaymentInstruments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an unsorted collection containing all PaymentInstruments of type\nPaymentInstrument.METHOD_GIFT_CERTIFICATE where the specified code is the same code on the payment instrument.", + "heading": "Description" + } + ], + "signature": "getGiftCertificatePaymentInstruments(giftCertificateCode: string): Collection", + "source": "script-api", + "tags": [ + "getgiftcertificatepaymentinstruments", + "lineitemctnr.getgiftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.getGiftCertificatePaymentInstruments" + }, + { + "description": "Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getgiftcertificatetotalgrossprice", + "lineitemctnr.getgiftcertificatetotalgrossprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to total gross price.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to\ntotal gross price.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getgiftcertificatetotalnetprice", + "lineitemctnr.getgiftcertificatetotalnetprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalNetPrice" + }, + { + "description": "Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate total net price is returned. If the line item container is based on gross pricing the gift certificate total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate\ntotal net price is returned. If the line item container is based on gross pricing the gift certificate total\ngross price is returned.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getgiftcertificatetotalprice", + "lineitemctnr.getgiftcertificatetotalprice" + ], + "title": "LineItemCtnr.getGiftCertificateTotalPrice" + }, + { + "description": "Returns the total tax of all gift certificates in the cart. Should usually be 0.0.", + "id": "script-api:dw/order/LineItemCtnr#getGiftCertificateTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getGiftCertificateTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total tax of all gift certificates in the cart. Should usually be 0.0.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateTotalTax(): Money", + "source": "script-api", + "tags": [ + "getgiftcertificatetotaltax", + "lineitemctnr.getgiftcertificatetotaltax" + ], + "title": "LineItemCtnr.getGiftCertificateTotalTax" + }, + { + "description": "Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of\nproduct prices before services such as shipping or adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalgrossprice", + "lineitemctnr.getmerchandizetotalgrossprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotion have been added.", + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of\nproduct prices before services such as shipping or adjustment from promotion have been added.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalnetprice", + "lineitemctnr.getmerchandizetotalnetprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalNetPrice" + }, + { + "description": "Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net price is returned. If the line item container is based on gross pricing the merchandize total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net\nprice is returned. If the line item container is based on gross pricing the merchandize total gross price is\nreturned.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalprice", + "lineitemctnr.getmerchandizetotalprice" + ], + "title": "LineItemCtnr.getMerchandizeTotalPrice" + }, + { + "description": "Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#getMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getMerchandizeTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before\nservices such as shipping or adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalTax(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotaltax", + "lineitemctnr.getmerchandizetotaltax" + ], + "title": "LineItemCtnr.getMerchandizeTotalTax" + }, + { + "description": "Returns the list of notes for this object, ordered by creation time from oldest to newest.", + "id": "script-api:dw/order/LineItemCtnr#getNotes", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getNotes", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the list of notes for this object, ordered by creation time from oldest to newest.", + "heading": "Description" + } + ], + "signature": "getNotes(): List", + "source": "script-api", + "tags": [ + "getnotes", + "lineitemctnr.getnotes" + ], + "title": "LineItemCtnr.getNotes" + }, + { + "deprecated": { + "message": "Use getPaymentInstruments or getGiftCertificatePaymentInstruments to get the\nset of payment instruments." + }, + "description": "Returns the payment instrument of the line item container or null. This method is deprecated. You should use getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.", + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument | null" + }, + "sections": [ + { + "body": "Returns the payment instrument of the line item container or null. This method is deprecated. You should use\ngetPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(): OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "lineitemctnr.getpaymentinstrument" + ], + "title": "LineItemCtnr.getPaymentInstrument" + }, + { + "description": "Returns an unsorted collection of the payment instruments in this container.", + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstruments", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns an unsorted collection of the payment instruments in this container.", + "heading": "Description" + } + ], + "signature": "getPaymentInstruments(): Collection>", + "source": "script-api", + "tags": [ + "getpaymentinstruments", + "lineitemctnr.getpaymentinstruments" + ], + "title": "LineItemCtnr.getPaymentInstruments" + }, + { + "description": "Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID.", + "id": "script-api:dw/order/LineItemCtnr#getPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "paymentMethodID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPaymentInstruments", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns an unsorted collection of PaymentInstrument instances based on the specified payment method ID.", + "heading": "Description" + } + ], + "signature": "getPaymentInstruments(paymentMethodID: string): Collection>", + "source": "script-api", + "tags": [ + "getpaymentinstruments", + "lineitemctnr.getpaymentinstruments" + ], + "title": "LineItemCtnr.getPaymentInstruments" + }, + { + "description": "Returns the price adjustment associated to the specified promotion ID.", + "id": "script-api:dw/order/LineItemCtnr#getPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPriceAdjustmentByPromotionID", + "returns": { + "type": "PriceAdjustment | null" + }, + "sections": [ + { + "body": "Returns the price adjustment associated to the specified promotion ID.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustmentByPromotionID(promotionID: string): PriceAdjustment | null", + "source": "script-api", + "tags": [ + "getpriceadjustmentbypromotionid", + "lineitemctnr.getpriceadjustmentbypromotionid" + ], + "title": "LineItemCtnr.getPriceAdjustmentByPromotionID" + }, + { + "description": "Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were applied to the order by the promotions engine.", + "id": "script-api:dw/order/LineItemCtnr#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of price adjustments that have been applied to the totals such as promotion on the\npurchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were\napplied to the order by the promotions engine.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getpriceadjustments", + "lineitemctnr.getpriceadjustments" + ], + "title": "LineItemCtnr.getPriceAdjustments" + }, + { + "description": "Returns the product line items of the container that are not dependent on other product line items. This includes line items representing bonus products in the container but excludes option, bundled, and bonus line items. The returned collection is sorted by the position attribute of the product line items.", + "id": "script-api:dw/order/LineItemCtnr#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product line items of the container that are not dependent on other product line items. This includes\nline items representing bonus products in the container but excludes option, bundled, and bonus line items. The\nreturned collection is sorted by the position attribute of the product line items.", + "heading": "Description" + } + ], + "signature": "getProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getproductlineitems", + "lineitemctnr.getproductlineitems" + ], + "title": "LineItemCtnr.getProductLineItems" + }, + { + "description": "Returns the product line items of the container that have a product ID equal to the specified product ID and that are not dependent on other product line items. This includes line items representing bonus products in the container, but excludes option, bundled and bonus line items. The returned collection is sorted by the position attribute of the product line items.", + "id": "script-api:dw/order/LineItemCtnr#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the product line items of the container that have a product ID equal to the specified product ID and that\nare not dependent on other product line items. This includes line items representing bonus products in the\ncontainer, but excludes option, bundled and bonus line items. The returned collection is sorted by the position\nattribute of the product line items.", + "heading": "Description" + } + ], + "signature": "getProductLineItems(productID: string): Collection", + "source": "script-api", + "tags": [ + "getproductlineitems", + "lineitemctnr.getproductlineitems" + ], + "title": "LineItemCtnr.getProductLineItems" + }, + { + "description": "Returns a hash map of all products in the line item container and their total quantities. The total product quantity is for example used to lookup the product price.", + "id": "script-api:dw/order/LineItemCtnr#getProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantities", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns a hash map of all products in the line item container and their total quantities. The total product\nquantity is for example used to lookup the product price.\n\nThe method counts all direct product line items, plus dependent product line items that are not bundled line\nitems and no option line items. It also excludes product line items that are not associated to any catalog\nproduct, and bonus product line items.", + "heading": "Description" + } + ], + "signature": "getProductQuantities(): HashMap", + "source": "script-api", + "tags": [ + "getproductquantities", + "lineitemctnr.getproductquantities" + ], + "title": "LineItemCtnr.getProductQuantities" + }, + { + "description": "Returns a hash map of all products in the line item container and their total quantities. The total product quantity is for example used to lookup the product price in the cart.", + "id": "script-api:dw/order/LineItemCtnr#getProductQuantities", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "includeBonusProducts", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantities", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns a hash map of all products in the line item container and their total quantities. The total product\nquantity is for example used to lookup the product price in the cart.\n\nThe method counts all direct product line items, plus dependent product line items that are not bundled line\nitems and no option line items. It also excludes product line items that are not associated to any catalog\nproduct.\n\nIf the parameter 'includeBonusProducts' is set to true, the method also counts bonus product line items.", + "heading": "Description" + } + ], + "signature": "getProductQuantities(includeBonusProducts: boolean): HashMap", + "source": "script-api", + "tags": [ + "getproductquantities", + "lineitemctnr.getproductquantities" + ], + "title": "LineItemCtnr.getProductQuantities" + }, + { + "description": "Returns the total quantity of all product line items. Not included are bundled line items and option line items.", + "id": "script-api:dw/order/LineItemCtnr#getProductQuantityTotal", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getProductQuantityTotal", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the total quantity of all product line items. Not included are bundled line items and option line items.", + "heading": "Description" + } + ], + "signature": "getProductQuantityTotal(): number", + "source": "script-api", + "tags": [ + "getproductquantitytotal", + "lineitemctnr.getproductquantitytotal" + ], + "title": "LineItemCtnr.getProductQuantityTotal" + }, + { + "description": "Returns the shipment for the specified ID or `null` if no shipment with this ID exists in the line item container. Using \"me\" always returns the default shipment.", + "id": "script-api:dw/order/LineItemCtnr#getShipment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShipment", + "returns": { + "type": "Shipment | null" + }, + "sections": [ + { + "body": "Returns the shipment for the specified ID or `null` if no shipment with this ID exists in the line\nitem container. Using \"me\" always returns the default shipment.", + "heading": "Description" + } + ], + "signature": "getShipment(id: string): Shipment | null", + "source": "script-api", + "tags": [ + "getshipment", + "lineitemctnr.getshipment" + ], + "title": "LineItemCtnr.getShipment" + }, + { + "description": "Returns all shipments of the line item container.", + "id": "script-api:dw/order/LineItemCtnr#getShipments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShipments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all shipments of the line item container.\n\nThe first shipment in the returned collection is the default shipment (shipment ID always set to \"me\"). All other\nshipments are sorted ascending by shipment ID.", + "heading": "Description" + } + ], + "signature": "getShipments(): Collection", + "source": "script-api", + "tags": [ + "getshipments", + "lineitemctnr.getshipments" + ], + "title": "LineItemCtnr.getShipments" + }, + { + "description": "Returns the shipping price adjustment associated with the specified promotion ID.", + "id": "script-api:dw/order/LineItemCtnr#getShippingPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingPriceAdjustmentByPromotionID", + "returns": { + "type": "PriceAdjustment | null" + }, + "sections": [ + { + "body": "Returns the shipping price adjustment associated with the specified promotion ID.", + "heading": "Description" + } + ], + "signature": "getShippingPriceAdjustmentByPromotionID(promotionID: string): PriceAdjustment | null", + "source": "script-api", + "tags": [ + "getshippingpriceadjustmentbypromotionid", + "lineitemctnr.getshippingpriceadjustmentbypromotionid" + ], + "title": "LineItemCtnr.getShippingPriceAdjustmentByPromotionID" + }, + { + "description": "Returns the of shipping price adjustments applied to the shipping total of the container. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.", + "id": "script-api:dw/order/LineItemCtnr#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the of shipping price adjustments applied to the shipping total of the container. Note that the\npromotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and\nnever to the container.", + "heading": "Description" + } + ], + "signature": "getShippingPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getshippingpriceadjustments", + "lineitemctnr.getshippingpriceadjustments" + ], + "title": "LineItemCtnr.getShippingPriceAdjustments" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "getShippingTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalgrossprice", + "lineitemctnr.getshippingtotalgrossprice" + ], + "title": "LineItemCtnr.getShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "getShippingTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalnetprice", + "lineitemctnr.getshippingtotalnetprice" + ], + "title": "LineItemCtnr.getShippingTotalNetPrice" + }, + { + "description": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price\nis returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "heading": "Description" + } + ], + "signature": "getShippingTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalprice", + "lineitemctnr.getshippingtotalprice" + ], + "title": "LineItemCtnr.getShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#getShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getShippingTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of all shipping line items of the line item container before shipping adjustments have been\napplied.", + "heading": "Description" + } + ], + "signature": "getShippingTotalTax(): Money", + "source": "script-api", + "tags": [ + "getshippingtotaltax", + "lineitemctnr.getshippingtotaltax" + ], + "title": "LineItemCtnr.getShippingTotalTax" + }, + { + "description": "This method returns a dw.util.SortedMap in which the keys are dw.util.Decimal tax rates and the values are dw.value.Money total tax for the tax rate. The map is unmodifiable.", + "id": "script-api:dw/order/LineItemCtnr#getTaxTotalsPerTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTaxTotalsPerTaxRate", + "returns": { + "type": "SortedMap" + }, + "sections": [ + { + "body": "This method returns a dw.util.SortedMap in which the keys are dw.util.Decimal tax rates and the values\nare dw.value.Money total tax for the tax rate. The map is unmodifiable.", + "heading": "Description" + } + ], + "signature": "getTaxTotalsPerTaxRate(): SortedMap", + "source": "script-api", + "tags": [ + "gettaxtotalspertaxrate", + "lineitemctnr.gettaxtotalspertaxrate" + ], + "title": "LineItemCtnr.getTaxTotalsPerTaxRate" + }, + { + "description": "Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#getTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum\nof product prices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "getTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "gettotalgrossprice", + "lineitemctnr.gettotalgrossprice" + ], + "title": "LineItemCtnr.getTotalGrossPrice" + }, + { + "description": "Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#getTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum\nof product prices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "getTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "gettotalnetprice", + "lineitemctnr.gettotalnetprice" + ], + "title": "LineItemCtnr.getTotalNetPrice" + }, + { + "description": "Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#getTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.getTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product\nprices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "getTotalTax(): Money", + "source": "script-api", + "tags": [ + "gettotaltax", + "lineitemctnr.gettotaltax" + ], + "title": "LineItemCtnr.getTotalTax" + }, + { + "description": "Returns all gift certificate line items of the container.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateLineItems", + "sections": [ + { + "body": "Returns all gift certificate line items of the container.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateLineItems: Collection", + "source": "script-api", + "tags": [ + "giftcertificatelineitems", + "lineitemctnr.giftcertificatelineitems" + ], + "title": "LineItemCtnr.giftCertificateLineItems" + }, + { + "description": "Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this container.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificatePaymentInstruments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificatePaymentInstruments", + "sections": [ + { + "body": "Returns an unsorted collection of the PaymentInstrument instances that represent GiftCertificates in this\ncontainer.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificatePaymentInstruments: Collection", + "source": "script-api", + "tags": [ + "giftcertificatepaymentinstruments", + "lineitemctnr.giftcertificatepaymentinstruments" + ], + "title": "LineItemCtnr.giftCertificatePaymentInstruments" + }, + { + "description": "Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalGrossPrice", + "sections": [ + { + "body": "Returns the total gross price of all gift certificates in the cart. Should usually be equal to total net price.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "giftcertificatetotalgrossprice", + "lineitemctnr.giftcertificatetotalgrossprice" + ], + "title": "LineItemCtnr.giftCertificateTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to total gross price.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalNetPrice", + "sections": [ + { + "body": "Returns the total net price (excluding tax) of all gift certificates in the cart. Should usually be equal to\ntotal gross price.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "giftcertificatetotalnetprice", + "lineitemctnr.giftcertificatetotalnetprice" + ], + "title": "LineItemCtnr.giftCertificateTotalNetPrice" + }, + { + "description": "Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate total net price is returned. If the line item container is based on gross pricing the gift certificate total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalPrice", + "sections": [ + { + "body": "Returns the gift certificate total price. If the line item container is based on net pricing the gift certificate\ntotal net price is returned. If the line item container is based on gross pricing the gift certificate total\ngross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateTotalPrice: Money", + "source": "script-api", + "tags": [ + "giftcertificatetotalprice", + "lineitemctnr.giftcertificatetotalprice" + ], + "title": "LineItemCtnr.giftCertificateTotalPrice" + }, + { + "description": "Returns the total tax of all gift certificates in the cart. Should usually be 0.0.", + "id": "script-api:dw/order/LineItemCtnr#giftCertificateTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.giftCertificateTotalTax", + "sections": [ + { + "body": "Returns the total tax of all gift certificates in the cart. Should usually be 0.0.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateTotalTax: Money", + "source": "script-api", + "tags": [ + "giftcertificatetotaltax", + "lineitemctnr.giftcertificatetotaltax" + ], + "title": "LineItemCtnr.giftCertificateTotalTax" + }, + { + "description": "Use this method to check whether the LineItemCtnr is calculated based on external tax tables.", + "id": "script-api:dw/order/LineItemCtnr#isExternallyTaxed", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.isExternallyTaxed", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Use this method to check whether the LineItemCtnr is calculated based on external tax tables.\n\nNote: a basket can only be created in EXTERNAL tax mode using SCAPI.", + "heading": "Description" + } + ], + "signature": "isExternallyTaxed(): boolean", + "source": "script-api", + "tags": [ + "isexternallytaxed", + "lineitemctnr.isexternallytaxed" + ], + "title": "LineItemCtnr.isExternallyTaxed" + }, + { + "description": "Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.", + "id": "script-api:dw/order/LineItemCtnr#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.isTaxRoundedAtGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "isTaxRoundedAtGroup(): boolean", + "source": "script-api", + "tags": [ + "istaxroundedatgroup", + "lineitemctnr.istaxroundedatgroup" + ], + "title": "LineItemCtnr.isTaxRoundedAtGroup" + }, + { + "description": "Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalGrossPrice", + "sections": [ + { + "body": "Returns the total gross price (including tax) in purchase currency. Merchandize total prices represent the sum of\nproduct prices before services such as shipping or adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalgrossprice", + "lineitemctnr.merchandizetotalgrossprice" + ], + "title": "LineItemCtnr.merchandizeTotalGrossPrice" + }, + { + "description": "Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotion have been added.", + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalNetPrice", + "sections": [ + { + "body": "Returns the total net price (excluding tax) in purchase currency. Merchandize total prices represent the sum of\nproduct prices before services such as shipping or adjustment from promotion have been added.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalnetprice", + "lineitemctnr.merchandizetotalnetprice" + ], + "title": "LineItemCtnr.merchandizeTotalNetPrice" + }, + { + "description": "Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net price is returned. If the line item container is based on gross pricing the merchandize total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalPrice", + "sections": [ + { + "body": "Returns the merchandize total price. If the line item container is based on net pricing the merchandize total net\nprice is returned. If the line item container is based on gross pricing the merchandize total gross price is\nreturned.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalprice", + "lineitemctnr.merchandizetotalprice" + ], + "title": "LineItemCtnr.merchandizeTotalPrice" + }, + { + "description": "Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added.", + "id": "script-api:dw/order/LineItemCtnr#merchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.merchandizeTotalTax", + "sections": [ + { + "body": "Returns the total tax in purchase currency. Merchandize total prices represent the sum of product prices before\nservices such as shipping or adjustment from promotions have been added.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalTax: Money", + "source": "script-api", + "tags": [ + "merchandizetotaltax", + "lineitemctnr.merchandizetotaltax" + ], + "title": "LineItemCtnr.merchandizeTotalTax" + }, + { + "description": "Returns the list of notes for this object, ordered by creation time from oldest to newest.", + "id": "script-api:dw/order/LineItemCtnr#notes", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.notes", + "sections": [ + { + "body": "Returns the list of notes for this object, ordered by creation time from oldest to newest.", + "heading": "Description" + } + ], + "signature": "readonly notes: List", + "source": "script-api", + "tags": [ + "notes", + "lineitemctnr.notes" + ], + "title": "LineItemCtnr.notes" + }, + { + "deprecated": { + "message": "Use getPaymentInstruments or getGiftCertificatePaymentInstruments to get the\nset of payment instruments." + }, + "description": "Returns the payment instrument of the line item container or null. This method is deprecated. You should use getPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.", + "id": "script-api:dw/order/LineItemCtnr#paymentInstrument", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.paymentInstrument", + "sections": [ + { + "body": "Returns the payment instrument of the line item container or null. This method is deprecated. You should use\ngetPaymentInstruments() or getGiftCertificatePaymentInstruments() instead.", + "heading": "Description" + } + ], + "signature": "readonly paymentInstrument: OrderPaymentInstrument | null", + "source": "script-api", + "tags": [ + "paymentinstrument", + "lineitemctnr.paymentinstrument" + ], + "title": "LineItemCtnr.paymentInstrument" + }, + { + "description": "Returns an unsorted collection of the payment instruments in this container.", + "id": "script-api:dw/order/LineItemCtnr#paymentInstruments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.paymentInstruments", + "sections": [ + { + "body": "Returns an unsorted collection of the payment instruments in this container.", + "heading": "Description" + } + ], + "signature": "readonly paymentInstruments: Collection>", + "source": "script-api", + "tags": [ + "paymentinstruments", + "lineitemctnr.paymentinstruments" + ], + "title": "LineItemCtnr.paymentInstruments" + }, + { + "description": "Returns the collection of price adjustments that have been applied to the totals such as promotion on the purchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were applied to the order by the promotions engine.", + "id": "script-api:dw/order/LineItemCtnr#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.priceAdjustments", + "sections": [ + { + "body": "Returns the collection of price adjustments that have been applied to the totals such as promotion on the\npurchase value (i.e. $10 Off or 10% Off). The price adjustments are sorted by the order in which they were\napplied to the order by the promotions engine.", + "heading": "Description" + } + ], + "signature": "readonly priceAdjustments: Collection", + "source": "script-api", + "tags": [ + "priceadjustments", + "lineitemctnr.priceadjustments" + ], + "title": "LineItemCtnr.priceAdjustments" + }, + { + "description": "Returns the product line items of the container that are not dependent on other product line items. This includes line items representing bonus products in the container but excludes option, bundled, and bonus line items. The returned collection is sorted by the position attribute of the product line items.", + "id": "script-api:dw/order/LineItemCtnr#productLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productLineItems", + "sections": [ + { + "body": "Returns the product line items of the container that are not dependent on other product line items. This includes\nline items representing bonus products in the container but excludes option, bundled, and bonus line items. The\nreturned collection is sorted by the position attribute of the product line items.", + "heading": "Description" + } + ], + "signature": "readonly productLineItems: Collection", + "source": "script-api", + "tags": [ + "productlineitems", + "lineitemctnr.productlineitems" + ], + "title": "LineItemCtnr.productLineItems" + }, + { + "description": "Returns a hash map of all products in the line item container and their total quantities. The total product quantity is for example used to lookup the product price.", + "id": "script-api:dw/order/LineItemCtnr#productQuantities", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productQuantities", + "sections": [ + { + "body": "Returns a hash map of all products in the line item container and their total quantities. The total product\nquantity is for example used to lookup the product price.\n\nThe method counts all direct product line items, plus dependent product line items that are not bundled line\nitems and no option line items. It also excludes product line items that are not associated to any catalog\nproduct, and bonus product line items.", + "heading": "Description" + } + ], + "signature": "readonly productQuantities: HashMap", + "source": "script-api", + "tags": [ + "productquantities", + "lineitemctnr.productquantities" + ], + "title": "LineItemCtnr.productQuantities" + }, + { + "description": "Returns the total quantity of all product line items. Not included are bundled line items and option line items.", + "id": "script-api:dw/order/LineItemCtnr#productQuantityTotal", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.productQuantityTotal", + "sections": [ + { + "body": "Returns the total quantity of all product line items. Not included are bundled line items and option line items.", + "heading": "Description" + } + ], + "signature": "readonly productQuantityTotal: number", + "source": "script-api", + "tags": [ + "productquantitytotal", + "lineitemctnr.productquantitytotal" + ], + "title": "LineItemCtnr.productQuantityTotal" + }, + { + "description": "Removes the all Payment Instruments from this container and deletes the Payment Instruments.", + "id": "script-api:dw/order/LineItemCtnr#removeAllPaymentInstruments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeAllPaymentInstruments", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the all Payment Instruments from this container and deletes the Payment Instruments.", + "heading": "Description" + } + ], + "signature": "removeAllPaymentInstruments(): void", + "source": "script-api", + "tags": [ + "removeallpaymentinstruments", + "lineitemctnr.removeallpaymentinstruments" + ], + "title": "LineItemCtnr.removeAllPaymentInstruments" + }, + { + "description": "Removes the specified bonus discount line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removeBonusDiscountLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "bonusDiscountLineItem", + "type": "BonusDiscountLineItem" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeBonusDiscountLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified bonus discount line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removeBonusDiscountLineItem(bonusDiscountLineItem: BonusDiscountLineItem): void", + "source": "script-api", + "tags": [ + "removebonusdiscountlineitem", + "lineitemctnr.removebonusdiscountlineitem" + ], + "title": "LineItemCtnr.removeBonusDiscountLineItem" + }, + { + "description": "Removes the specified coupon line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removeCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "couponLineItem", + "type": "CouponLineItem" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeCouponLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified coupon line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removeCouponLineItem(couponLineItem: CouponLineItem): void", + "source": "script-api", + "tags": [ + "removecouponlineitem", + "lineitemctnr.removecouponlineitem" + ], + "title": "LineItemCtnr.removeCouponLineItem" + }, + { + "description": "Removes the specified gift certificate line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removeGiftCertificateLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateLineItem", + "type": "GiftCertificateLineItem" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeGiftCertificateLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified gift certificate line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removeGiftCertificateLineItem(giftCertificateLineItem: GiftCertificateLineItem): void", + "source": "script-api", + "tags": [ + "removegiftcertificatelineitem", + "lineitemctnr.removegiftcertificatelineitem" + ], + "title": "LineItemCtnr.removeGiftCertificateLineItem" + }, + { + "description": "Removes a note from this line item container and deletes it.", + "id": "script-api:dw/order/LineItemCtnr#removeNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "note", + "type": "Note" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a note from this line item container and deletes it.", + "heading": "Description" + } + ], + "signature": "removeNote(note: Note): void", + "source": "script-api", + "tags": [ + "removenote", + "lineitemctnr.removenote" + ], + "title": "LineItemCtnr.removeNote" + }, + { + "description": "Removes the specified Payment Instrument from this container and deletes the Payment Instrument.", + "id": "script-api:dw/order/LineItemCtnr#removePaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "pi", + "type": "PaymentInstrument" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removePaymentInstrument", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified Payment Instrument from this container and deletes the Payment Instrument.", + "heading": "Description" + } + ], + "signature": "removePaymentInstrument(pi: PaymentInstrument): void", + "source": "script-api", + "tags": [ + "removepaymentinstrument", + "lineitemctnr.removepaymentinstrument" + ], + "title": "LineItemCtnr.removePaymentInstrument" + }, + { + "description": "Removes the specified price adjustment line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustment", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removePriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified price adjustment line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removePriceAdjustment(priceAdjustment: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "removepriceadjustment", + "lineitemctnr.removepriceadjustment" + ], + "title": "LineItemCtnr.removePriceAdjustment" + }, + { + "description": "Removes the specified product line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removeProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productLineItem", + "type": "ProductLineItem" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeProductLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified product line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removeProductLineItem(productLineItem: ProductLineItem): void", + "source": "script-api", + "tags": [ + "removeproductlineitem", + "lineitemctnr.removeproductlineitem" + ], + "title": "LineItemCtnr.removeProductLineItem" + }, + { + "description": "Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line items from the line item container. It is not permissible to remove the default shipment.", + "id": "script-api:dw/order/LineItemCtnr#removeShipment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeShipment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified shipment and all associated product, gift certificate, shipping and price adjustment line\nitems from the line item container. It is not permissible to remove the default shipment.", + "heading": "Description" + } + ], + "signature": "removeShipment(shipment: Shipment): void", + "source": "script-api", + "tags": [ + "removeshipment", + "lineitemctnr.removeshipment" + ], + "title": "LineItemCtnr.removeShipment" + }, + { + "description": "Removes the specified shipping price adjustment line item from the line item container.", + "id": "script-api:dw/order/LineItemCtnr#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustment", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.removeShippingPriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified shipping price adjustment line item from the line item container.", + "heading": "Description" + } + ], + "signature": "removeShippingPriceAdjustment(priceAdjustment: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "removeshippingpriceadjustment", + "lineitemctnr.removeshippingpriceadjustment" + ], + "title": "LineItemCtnr.removeShippingPriceAdjustment" + }, + { + "description": "Sets the email address of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#setCustomerEmail", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.setCustomerEmail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the email address of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "setCustomerEmail(aValue: string): void", + "source": "script-api", + "tags": [ + "setcustomeremail", + "lineitemctnr.setcustomeremail" + ], + "title": "LineItemCtnr.setCustomerEmail" + }, + { + "description": "Sets the name of the customer associated with this container.", + "id": "script-api:dw/order/LineItemCtnr#setCustomerName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.setCustomerName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the customer associated with this container.", + "heading": "Description" + } + ], + "signature": "setCustomerName(aValue: string): void", + "source": "script-api", + "tags": [ + "setcustomername", + "lineitemctnr.setcustomername" + ], + "title": "LineItemCtnr.setCustomerName" + }, + { + "description": "Returns all shipments of the line item container.", + "id": "script-api:dw/order/LineItemCtnr#shipments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shipments", + "sections": [ + { + "body": "Returns all shipments of the line item container.\n\nThe first shipment in the returned collection is the default shipment (shipment ID always set to \"me\"). All other\nshipments are sorted ascending by shipment ID.", + "heading": "Description" + } + ], + "signature": "readonly shipments: Collection", + "source": "script-api", + "tags": [ + "shipments", + "lineitemctnr.shipments" + ], + "title": "LineItemCtnr.shipments" + }, + { + "description": "Returns the of shipping price adjustments applied to the shipping total of the container. Note that the promotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and never to the container.", + "id": "script-api:dw/order/LineItemCtnr#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingPriceAdjustments", + "sections": [ + { + "body": "Returns the of shipping price adjustments applied to the shipping total of the container. Note that the\npromotions engine only applies shipping price adjustments to the the default shipping line item of shipments, and\nnever to the container.", + "heading": "Description" + } + ], + "signature": "readonly shippingPriceAdjustments: Collection", + "source": "script-api", + "tags": [ + "shippingpriceadjustments", + "lineitemctnr.shippingpriceadjustments" + ], + "title": "LineItemCtnr.shippingPriceAdjustments" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#shippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalGrossPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, including tax before shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalgrossprice", + "lineitemctnr.shippingtotalgrossprice" + ], + "title": "LineItemCtnr.shippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#shippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalNetPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the line item container, excluding tax before shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalnetprice", + "lineitemctnr.shippingtotalnetprice" + ], + "title": "LineItemCtnr.shippingTotalNetPrice" + }, + { + "description": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "id": "script-api:dw/order/LineItemCtnr#shippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalPrice", + "sections": [ + { + "body": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price\nis returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalprice", + "lineitemctnr.shippingtotalprice" + ], + "title": "LineItemCtnr.shippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the line item container before shipping adjustments have been applied.", + "id": "script-api:dw/order/LineItemCtnr#shippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.shippingTotalTax", + "sections": [ + { + "body": "Returns the tax of all shipping line items of the line item container before shipping adjustments have been\napplied.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalTax: Money", + "source": "script-api", + "tags": [ + "shippingtotaltax", + "lineitemctnr.shippingtotaltax" + ], + "title": "LineItemCtnr.shippingTotalTax" + }, + { + "description": "Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.", + "id": "script-api:dw/order/LineItemCtnr#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.taxRoundedAtGroup", + "sections": [ + { + "body": "Use this method to check if the LineItemCtnr was calculated with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "readonly taxRoundedAtGroup: boolean", + "source": "script-api", + "tags": [ + "taxroundedatgroup", + "lineitemctnr.taxroundedatgroup" + ], + "title": "LineItemCtnr.taxRoundedAtGroup" + }, + { + "description": "This method returns a dw.util.SortedMap in which the keys are dw.util.Decimal tax rates and the values are dw.value.Money total tax for the tax rate. The map is unmodifiable.", + "id": "script-api:dw/order/LineItemCtnr#taxTotalsPerTaxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.taxTotalsPerTaxRate", + "sections": [ + { + "body": "This method returns a dw.util.SortedMap in which the keys are dw.util.Decimal tax rates and the values\nare dw.value.Money total tax for the tax rate. The map is unmodifiable.", + "heading": "Description" + } + ], + "signature": "readonly taxTotalsPerTaxRate: SortedMap", + "source": "script-api", + "tags": [ + "taxtotalspertaxrate", + "lineitemctnr.taxtotalspertaxrate" + ], + "title": "LineItemCtnr.taxTotalsPerTaxRate" + }, + { + "description": "Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#totalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalGrossPrice", + "sections": [ + { + "body": "Returns the grand total price gross of tax for LineItemCtnr, in purchase currency. Total prices represent the sum\nof product prices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly totalGrossPrice: Money", + "source": "script-api", + "tags": [ + "totalgrossprice", + "lineitemctnr.totalgrossprice" + ], + "title": "LineItemCtnr.totalGrossPrice" + }, + { + "description": "Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#totalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalNetPrice", + "sections": [ + { + "body": "Returns the grand total price for LineItemCtnr net of tax, in purchase currency. Total prices represent the sum\nof product prices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly totalNetPrice: Money", + "source": "script-api", + "tags": [ + "totalnetprice", + "lineitemctnr.totalnetprice" + ], + "title": "LineItemCtnr.totalNetPrice" + }, + { + "description": "Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product prices, services prices and adjustments.", + "id": "script-api:dw/order/LineItemCtnr#totalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.totalTax", + "sections": [ + { + "body": "Returns the grand total tax for LineItemCtnr, in purchase currency. Total prices represent the sum of product\nprices, services prices and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly totalTax: Money", + "source": "script-api", + "tags": [ + "totaltax", + "lineitemctnr.totaltax" + ], + "title": "LineItemCtnr.totalTax" + }, + { + "description": "Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr.", + "id": "script-api:dw/order/LineItemCtnr#updateOrderLevelPriceAdjustmentTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.updateOrderLevelPriceAdjustmentTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Calculates the tax for all shipping and order-level merchandise price adjustments in this LineItemCtnr.\n\nThe tax on each adjustment is calculated from the taxes of the line items the adjustment applies across.\n\nThis method must be invoked at the end of tax calculation of a basket or an order.", + "heading": "Description" + } + ], + "signature": "updateOrderLevelPriceAdjustmentTax(): void", + "source": "script-api", + "tags": [ + "updateorderlevelpriceadjustmenttax", + "lineitemctnr.updateorderlevelpriceadjustmenttax" + ], + "title": "LineItemCtnr.updateOrderLevelPriceAdjustmentTax" + }, + { + "description": "Recalculates the totals of the line item container. It is necessary to call this method after any type of modification to the basket.", + "id": "script-api:dw/order/LineItemCtnr#updateTotals", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.updateTotals", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Recalculates the totals of the line item container. It is necessary to call this method after any type of\nmodification to the basket.", + "heading": "Description" + } + ], + "signature": "updateTotals(): void", + "source": "script-api", + "tags": [ + "updatetotals", + "lineitemctnr.updatetotals" + ], + "title": "LineItemCtnr.updateTotals" + }, + { + "description": "Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits for the current user and the current site.", + "id": "script-api:dw/order/LineItemCtnr#verifyPriceAdjustmentLimits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemCtnr", + "qualifiedName": "dw.order.LineItemCtnr.verifyPriceAdjustmentLimits", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Verifies whether the manual price adjustments made for the line item container exceed the corresponding limits\nfor the current user and the current site.\n\nThe results of this method are based on the current values held in the dw.order.LineItemCtnr, such as the\nbase price of manual price adjustments. It is important the method is only called after the calculation process\nhas completed.\n\nStatus.OK is returned if NONE of the manual price adjustments exceed the correspondent limits.\n\nStatus.ERROR is returned if ANY of the manual price adjustments exceed the correspondent limits. If this case\ndw.system.Status.getItems returns all price adjustment limit violations. The code of each\ndw.system.StatusItem represents the violated price adjustment type (see\ndw.order.PriceAdjustmentLimitTypes). dw.system.StatusItem.getDetails returns a\ndw.util.Map with the max amount and (where relevant) the item to which the violation applies.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "verifyPriceAdjustmentLimits(): Status", + "source": "script-api", + "tags": [ + "verifypriceadjustmentlimits", + "lineitemctnr.verifypriceadjustmentlimits" + ], + "title": "LineItemCtnr.verifyPriceAdjustmentLimits" + }, + { + "description": "A tax on a line item: tax identifier, rate, and optional amount. Use with LineItem.setTaxes and LineItem.getTaxes.", + "id": "script-api:dw/order/LineItemTax", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.LineItemTax", + "sections": [ + { + "body": "A tax on a line item: tax identifier, rate, and optional amount. Use with LineItem.setTaxes\nand LineItem.getTaxes.\n\nCreate instances via LineItemTax.LineItemTax to have the\nserver compute the tax value, or via\nLineItemTax.LineItemTax to provide a\npre-computed tax value.\n\nAccess is currently restricted to select pilot customers and controlled via feature toggle.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "lineitemtax", + "dw.order.lineitemtax", + "dw/order" + ], + "title": "LineItemTax" + }, + { + "description": "Gets the tax identifier (e.g. \"DE_7\").", + "id": "script-api:dw/order/LineItemTax#getTaxId", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxId", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the tax identifier (e.g. \"DE_7\").", + "heading": "Description" + } + ], + "signature": "getTaxId(): string", + "source": "script-api", + "tags": [ + "gettaxid", + "lineitemtax.gettaxid" + ], + "title": "LineItemTax.getTaxId" + }, + { + "description": "Gets the tax rate as a decimal (e.g. 0.07 for 7%).", + "id": "script-api:dw/order/LineItemTax#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Gets the tax rate as a decimal (e.g. 0.07 for 7%).", + "heading": "Description" + } + ], + "signature": "getTaxRate(): number", + "source": "script-api", + "tags": [ + "gettaxrate", + "lineitemtax.gettaxrate" + ], + "title": "LineItemTax.getTaxRate" + }, + { + "description": "Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.", + "id": "script-api:dw/order/LineItemTax#getTaxValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.getTaxValue", + "returns": { + "type": "Money | null" + }, + "sections": [ + { + "body": "Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.", + "heading": "Description" + } + ], + "signature": "getTaxValue(): Money | null", + "source": "script-api", + "tags": [ + "gettaxvalue", + "lineitemtax.gettaxvalue" + ], + "title": "LineItemTax.getTaxValue" + }, + { + "description": "Gets the tax identifier (e.g. \"DE_7\").", + "id": "script-api:dw/order/LineItemTax#taxId", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxId", + "sections": [ + { + "body": "Gets the tax identifier (e.g. \"DE_7\").", + "heading": "Description" + } + ], + "signature": "readonly taxId: string", + "source": "script-api", + "tags": [ + "taxid", + "lineitemtax.taxid" + ], + "title": "LineItemTax.taxId" + }, + { + "description": "Gets the tax rate as a decimal (e.g. 0.07 for 7%).", + "id": "script-api:dw/order/LineItemTax#taxRate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxRate", + "sections": [ + { + "body": "Gets the tax rate as a decimal (e.g. 0.07 for 7%).", + "heading": "Description" + } + ], + "signature": "readonly taxRate: number", + "source": "script-api", + "tags": [ + "taxrate", + "lineitemtax.taxrate" + ], + "title": "LineItemTax.taxRate" + }, + { + "description": "Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.", + "id": "script-api:dw/order/LineItemTax#taxValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/LineItemTax", + "qualifiedName": "dw.order.LineItemTax.taxValue", + "sections": [ + { + "body": "Gets the tax value (amount) in purchase currency, or null if computed from rate and tax basis.", + "heading": "Description" + } + ], + "signature": "readonly taxValue: Money | null", + "source": "script-api", + "tags": [ + "taxvalue", + "lineitemtax.taxvalue" + ], + "title": "LineItemTax.taxValue" + }, + { + "description": "The Order class represents an order. The correct way to retrieve an order is described in dw.order.OrderMgr.", + "id": "script-api:dw/order/Order", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Order", + "sections": [ + { + "body": "The Order class represents an order. The correct way to retrieve an order is described in dw.order.OrderMgr.", + "heading": "Description" + }, + { + "body": "Extends `LineItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "order", + "dw.order.order", + "dw/order" + ], + "title": "Order" + }, + { + "description": "constant for when Confirmation Status is Confirmed", + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for when Confirmation Status is Confirmed", + "heading": "Description" + } + ], + "signature": "static readonly CONFIRMATION_STATUS_CONFIRMED: number", + "source": "script-api", + "tags": [ + "confirmation_status_confirmed", + "order.confirmation_status_confirmed" + ], + "title": "Order.CONFIRMATION_STATUS_CONFIRMED" + }, + { + "description": "constant for when Confirmation Status is Confirmed", + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for when Confirmation Status is Confirmed", + "heading": "Description" + } + ], + "signature": "static readonly CONFIRMATION_STATUS_CONFIRMED: number", + "source": "script-api", + "tags": [ + "confirmation_status_confirmed", + "order.confirmation_status_confirmed" + ], + "title": "Order.CONFIRMATION_STATUS_CONFIRMED" + }, + { + "description": "constant for when Confirmation Status is Not Confirmed", + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_NOTCONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_NOTCONFIRMED", + "sections": [ + { + "body": "constant for when Confirmation Status is Not Confirmed", + "heading": "Description" + } + ], + "signature": "static readonly CONFIRMATION_STATUS_NOTCONFIRMED: number", + "source": "script-api", + "tags": [ + "confirmation_status_notconfirmed", + "order.confirmation_status_notconfirmed" + ], + "title": "Order.CONFIRMATION_STATUS_NOTCONFIRMED" + }, + { + "description": "constant for when Confirmation Status is Not Confirmed", + "id": "script-api:dw/order/Order#CONFIRMATION_STATUS_NOTCONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.CONFIRMATION_STATUS_NOTCONFIRMED", + "sections": [ + { + "body": "constant for when Confirmation Status is Not Confirmed", + "heading": "Description" + } + ], + "signature": "static readonly CONFIRMATION_STATUS_NOTCONFIRMED: number", + "source": "script-api", + "tags": [ + "confirmation_status_notconfirmed", + "order.confirmation_status_notconfirmed" + ], + "title": "Order.CONFIRMATION_STATUS_NOTCONFIRMED" + }, + { + "description": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "sections": [ + { + "body": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING = \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "order.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "description": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "sections": [ + { + "body": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING = \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "order.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "deprecated": { + "message": "Support for this algorithm will be removed in a future release. Please use\nENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING instead." + }, + "description": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "sections": [ + { + "body": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING = \"RSA/ECB/PKCS1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_pkcs1padding", + "order.encryption_algorithm_rsa_ecb_pkcs1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING" + }, + { + "deprecated": { + "message": "Support for this algorithm will be removed in a future release. Please use\nENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING instead." + }, + "description": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "id": "script-api:dw/order/Order#ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING", + "sections": [ + { + "body": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING = \"RSA/ECB/PKCS1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_pkcs1padding", + "order.encryption_algorithm_rsa_ecb_pkcs1padding" + ], + "title": "Order.ENCRYPTION_ALGORITHM_RSA_ECB_PKCS1PADDING" + }, + { + "description": "constant for when Export Status is Exported", + "id": "script-api:dw/order/Order#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_EXPORTED", + "sections": [ + { + "body": "constant for when Export Status is Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_EXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_exported", + "order.export_status_exported" + ], + "title": "Order.EXPORT_STATUS_EXPORTED" + }, + { + "description": "constant for when Export Status is Exported", + "id": "script-api:dw/order/Order#EXPORT_STATUS_EXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_EXPORTED", + "sections": [ + { + "body": "constant for when Export Status is Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_EXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_exported", + "order.export_status_exported" + ], + "title": "Order.EXPORT_STATUS_EXPORTED" + }, + { + "description": "constant for when Export Status is Failed", + "id": "script-api:dw/order/Order#EXPORT_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_FAILED", + "sections": [ + { + "body": "constant for when Export Status is Failed", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_FAILED: number", + "source": "script-api", + "tags": [ + "export_status_failed", + "order.export_status_failed" + ], + "title": "Order.EXPORT_STATUS_FAILED" + }, + { + "description": "constant for when Export Status is Failed", + "id": "script-api:dw/order/Order#EXPORT_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_FAILED", + "sections": [ + { + "body": "constant for when Export Status is Failed", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_FAILED: number", + "source": "script-api", + "tags": [ + "export_status_failed", + "order.export_status_failed" + ], + "title": "Order.EXPORT_STATUS_FAILED" + }, + { + "description": "constant for when Export Status is Not Exported", + "id": "script-api:dw/order/Order#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_NOTEXPORTED", + "sections": [ + { + "body": "constant for when Export Status is Not Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_NOTEXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_notexported", + "order.export_status_notexported" + ], + "title": "Order.EXPORT_STATUS_NOTEXPORTED" + }, + { + "description": "constant for when Export Status is Not Exported", + "id": "script-api:dw/order/Order#EXPORT_STATUS_NOTEXPORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_NOTEXPORTED", + "sections": [ + { + "body": "constant for when Export Status is Not Exported", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_NOTEXPORTED: number", + "source": "script-api", + "tags": [ + "export_status_notexported", + "order.export_status_notexported" + ], + "title": "Order.EXPORT_STATUS_NOTEXPORTED" + }, + { + "description": "constant for when Export Status is ready to be exported.", + "id": "script-api:dw/order/Order#EXPORT_STATUS_READY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_READY", + "sections": [ + { + "body": "constant for when Export Status is ready to be exported.", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_READY: number", + "source": "script-api", + "tags": [ + "export_status_ready", + "order.export_status_ready" + ], + "title": "Order.EXPORT_STATUS_READY" + }, + { + "description": "constant for when Export Status is ready to be exported.", + "id": "script-api:dw/order/Order#EXPORT_STATUS_READY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.EXPORT_STATUS_READY", + "sections": [ + { + "body": "constant for when Export Status is ready to be exported.", + "heading": "Description" + } + ], + "signature": "static readonly EXPORT_STATUS_READY: number", + "source": "script-api", + "tags": [ + "export_status_ready", + "order.export_status_ready" + ], + "title": "Order.EXPORT_STATUS_READY" + }, + { + "description": "constant for when Order Status is Cancelled", + "id": "script-api:dw/order/Order#ORDER_STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CANCELLED", + "sections": [ + { + "body": "constant for when Order Status is Cancelled", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_CANCELLED: number", + "source": "script-api", + "tags": [ + "order_status_cancelled", + "order.order_status_cancelled" + ], + "title": "Order.ORDER_STATUS_CANCELLED" + }, + { + "description": "constant for when Order Status is Cancelled", + "id": "script-api:dw/order/Order#ORDER_STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CANCELLED", + "sections": [ + { + "body": "constant for when Order Status is Cancelled", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_CANCELLED: number", + "source": "script-api", + "tags": [ + "order_status_cancelled", + "order.order_status_cancelled" + ], + "title": "Order.ORDER_STATUS_CANCELLED" + }, + { + "description": "constant for when Order Status is Completed", + "id": "script-api:dw/order/Order#ORDER_STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_COMPLETED", + "sections": [ + { + "body": "constant for when Order Status is Completed", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_COMPLETED: number", + "source": "script-api", + "tags": [ + "order_status_completed", + "order.order_status_completed" + ], + "title": "Order.ORDER_STATUS_COMPLETED" + }, + { + "description": "constant for when Order Status is Completed", + "id": "script-api:dw/order/Order#ORDER_STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_COMPLETED", + "sections": [ + { + "body": "constant for when Order Status is Completed", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_COMPLETED: number", + "source": "script-api", + "tags": [ + "order_status_completed", + "order.order_status_completed" + ], + "title": "Order.ORDER_STATUS_COMPLETED" + }, + { + "description": "constant for when Order Status is Created", + "id": "script-api:dw/order/Order#ORDER_STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CREATED", + "sections": [ + { + "body": "constant for when Order Status is Created", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_CREATED: number", + "source": "script-api", + "tags": [ + "order_status_created", + "order.order_status_created" + ], + "title": "Order.ORDER_STATUS_CREATED" + }, + { + "description": "constant for when Order Status is Created", + "id": "script-api:dw/order/Order#ORDER_STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_CREATED", + "sections": [ + { + "body": "constant for when Order Status is Created", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_CREATED: number", + "source": "script-api", + "tags": [ + "order_status_created", + "order.order_status_created" + ], + "title": "Order.ORDER_STATUS_CREATED" + }, + { + "description": "constant for when Order Status is Failed", + "id": "script-api:dw/order/Order#ORDER_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_FAILED", + "sections": [ + { + "body": "constant for when Order Status is Failed", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_FAILED: number", + "source": "script-api", + "tags": [ + "order_status_failed", + "order.order_status_failed" + ], + "title": "Order.ORDER_STATUS_FAILED" + }, + { + "description": "constant for when Order Status is Failed", + "id": "script-api:dw/order/Order#ORDER_STATUS_FAILED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_FAILED", + "sections": [ + { + "body": "constant for when Order Status is Failed", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_FAILED: number", + "source": "script-api", + "tags": [ + "order_status_failed", + "order.order_status_failed" + ], + "title": "Order.ORDER_STATUS_FAILED" + }, + { + "description": "constant for when Order Status is New", + "id": "script-api:dw/order/Order#ORDER_STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_NEW", + "sections": [ + { + "body": "constant for when Order Status is New", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_NEW: number", + "source": "script-api", + "tags": [ + "order_status_new", + "order.order_status_new" + ], + "title": "Order.ORDER_STATUS_NEW" + }, + { + "description": "constant for when Order Status is New", + "id": "script-api:dw/order/Order#ORDER_STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_NEW", + "sections": [ + { + "body": "constant for when Order Status is New", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_NEW: number", + "source": "script-api", + "tags": [ + "order_status_new", + "order.order_status_new" + ], + "title": "Order.ORDER_STATUS_NEW" + }, + { + "description": "constant for when Order Status is Open", + "id": "script-api:dw/order/Order#ORDER_STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_OPEN", + "sections": [ + { + "body": "constant for when Order Status is Open", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_OPEN: number", + "source": "script-api", + "tags": [ + "order_status_open", + "order.order_status_open" + ], + "title": "Order.ORDER_STATUS_OPEN" + }, + { + "description": "constant for when Order Status is Open", + "id": "script-api:dw/order/Order#ORDER_STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_OPEN", + "sections": [ + { + "body": "constant for when Order Status is Open", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_OPEN: number", + "source": "script-api", + "tags": [ + "order_status_open", + "order.order_status_open" + ], + "title": "Order.ORDER_STATUS_OPEN" + }, + { + "description": "constant for when Order Status is Replaced", + "id": "script-api:dw/order/Order#ORDER_STATUS_REPLACED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_REPLACED", + "sections": [ + { + "body": "constant for when Order Status is Replaced", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_REPLACED: number", + "source": "script-api", + "tags": [ + "order_status_replaced", + "order.order_status_replaced" + ], + "title": "Order.ORDER_STATUS_REPLACED" + }, + { + "description": "constant for when Order Status is Replaced", + "id": "script-api:dw/order/Order#ORDER_STATUS_REPLACED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.ORDER_STATUS_REPLACED", + "sections": [ + { + "body": "constant for when Order Status is Replaced", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_STATUS_REPLACED: number", + "source": "script-api", + "tags": [ + "order_status_replaced", + "order.order_status_replaced" + ], + "title": "Order.ORDER_STATUS_REPLACED" + }, + { + "description": "constant for when Payment Status is Not Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_NOTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_NOTPAID", + "sections": [ + { + "body": "constant for when Payment Status is Not Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_NOTPAID: number", + "source": "script-api", + "tags": [ + "payment_status_notpaid", + "order.payment_status_notpaid" + ], + "title": "Order.PAYMENT_STATUS_NOTPAID" + }, + { + "description": "constant for when Payment Status is Not Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_NOTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_NOTPAID", + "sections": [ + { + "body": "constant for when Payment Status is Not Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_NOTPAID: number", + "source": "script-api", + "tags": [ + "payment_status_notpaid", + "order.payment_status_notpaid" + ], + "title": "Order.PAYMENT_STATUS_NOTPAID" + }, + { + "description": "constant for when Payment Status is Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PAID", + "sections": [ + { + "body": "constant for when Payment Status is Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PAID: number", + "source": "script-api", + "tags": [ + "payment_status_paid", + "order.payment_status_paid" + ], + "title": "Order.PAYMENT_STATUS_PAID" + }, + { + "description": "constant for when Payment Status is Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PAID", + "sections": [ + { + "body": "constant for when Payment Status is Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PAID: number", + "source": "script-api", + "tags": [ + "payment_status_paid", + "order.payment_status_paid" + ], + "title": "Order.PAYMENT_STATUS_PAID" + }, + { + "description": "constant for when Payment Status is Part Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PARTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PARTPAID", + "sections": [ + { + "body": "constant for when Payment Status is Part Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PARTPAID: number", + "source": "script-api", + "tags": [ + "payment_status_partpaid", + "order.payment_status_partpaid" + ], + "title": "Order.PAYMENT_STATUS_PARTPAID" + }, + { + "description": "constant for when Payment Status is Part Paid", + "id": "script-api:dw/order/Order#PAYMENT_STATUS_PARTPAID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.PAYMENT_STATUS_PARTPAID", + "sections": [ + { + "body": "constant for when Payment Status is Part Paid", + "heading": "Description" + } + ], + "signature": "static readonly PAYMENT_STATUS_PARTPAID: number", + "source": "script-api", + "tags": [ + "payment_status_partpaid", + "order.payment_status_partpaid" + ], + "title": "Order.PAYMENT_STATUS_PARTPAID" + }, + { + "description": "constant for when Shipping Status is Not shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_NOTSHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Not shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_notshipped", + "order.shipping_status_notshipped" + ], + "title": "Order.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "description": "constant for when Shipping Status is Not shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_NOTSHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Not shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_notshipped", + "order.shipping_status_notshipped" + ], + "title": "Order.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "description": "constant for when Shipping Status is Part Shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_PARTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_PARTSHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Part Shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_PARTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_partshipped", + "order.shipping_status_partshipped" + ], + "title": "Order.SHIPPING_STATUS_PARTSHIPPED" + }, + { + "description": "constant for when Shipping Status is Part Shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_PARTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_PARTSHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Part Shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_PARTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_partshipped", + "order.shipping_status_partshipped" + ], + "title": "Order.SHIPPING_STATUS_PARTSHIPPED" + }, + { + "description": "constant for when Shipping Status is Shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_SHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_shipped", + "order.shipping_status_shipped" + ], + "title": "Order.SHIPPING_STATUS_SHIPPED" + }, + { + "description": "constant for when Shipping Status is Shipped", + "id": "script-api:dw/order/Order#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.SHIPPING_STATUS_SHIPPED", + "sections": [ + { + "body": "constant for when Shipping Status is Shipped", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_shipped", + "order.shipping_status_shipped" + ], + "title": "Order.SHIPPING_STATUS_SHIPPED" + }, + { + "description": "Returns the affiliate partner ID value, or null.", + "id": "script-api:dw/order/Order#affiliatePartnerID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.affiliatePartnerID", + "sections": [ + { + "body": "Returns the affiliate partner ID value, or null.", + "heading": "Description" + } + ], + "signature": "affiliatePartnerID: string | null", + "source": "script-api", + "tags": [ + "affiliatepartnerid", + "order.affiliatepartnerid" + ], + "title": "Order.affiliatePartnerID" + }, + { + "description": "Returns the affiliate partner name value, or null.", + "id": "script-api:dw/order/Order#affiliatePartnerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.affiliatePartnerName", + "sections": [ + { + "body": "Returns the affiliate partner name value, or null.", + "heading": "Description" + } + ], + "signature": "affiliatePartnerName: string | null", + "source": "script-api", + "tags": [ + "affiliatepartnername", + "order.affiliatepartnername" + ], + "title": "Order.affiliatePartnerName" + }, + { + "description": "Returns the collection of dw.order.AppeasementItems associated with this order.", + "id": "script-api:dw/order/Order#appeasementItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.appeasementItems", + "sections": [ + { + "body": "Returns the collection of dw.order.AppeasementItems associated with this order.", + "heading": "Description" + } + ], + "signature": "readonly appeasementItems: FilteringCollection", + "source": "script-api", + "tags": [ + "appeasementitems", + "order.appeasementitems" + ], + "title": "Order.appeasementItems" + }, + { + "description": "Returns the collection of dw.order.Appeasements associated with this order.", + "id": "script-api:dw/order/Order#appeasements", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.appeasements", + "sections": [ + { + "body": "Returns the collection of dw.order.Appeasements associated with this order.", + "heading": "Description" + } + ], + "signature": "readonly appeasements: FilteringCollection", + "source": "script-api", + "tags": [ + "appeasements", + "order.appeasements" + ], + "title": "Order.appeasements" + }, + { + "description": "If this order was cancelled, returns the value of the cancel code or null.", + "id": "script-api:dw/order/Order#cancelCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.cancelCode", + "sections": [ + { + "body": "If this order was cancelled, returns the value of the\ncancel code or null.", + "heading": "Description" + } + ], + "signature": "cancelCode: EnumValue | null", + "source": "script-api", + "tags": [ + "cancelcode", + "order.cancelcode" + ], + "title": "Order.cancelCode" + }, + { + "description": "If this order was cancelled, returns the text describing why the order was cancelled or null.", + "id": "script-api:dw/order/Order#cancelDescription", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.cancelDescription", + "sections": [ + { + "body": "If this order was cancelled, returns the text describing why\nthe order was cancelled or null.", + "heading": "Description" + } + ], + "signature": "cancelDescription: string | null", + "source": "script-api", + "tags": [ + "canceldescription", + "order.canceldescription" + ], + "title": "Order.cancelDescription" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly. Associate a payment capture for an dw.order.PaymentInstrument with an dw.order.Invoice using Invoice.addCaptureTransaction.", + "id": "script-api:dw/order/Order#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.capturedAmount", + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts\nare calculated on the fly. Associate a payment capture for an dw.order.PaymentInstrument with an dw.order.Invoice\nusing Invoice.addCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "readonly capturedAmount: Money", + "source": "script-api", + "tags": [ + "capturedamount", + "order.capturedamount" + ], + "title": "Order.capturedAmount" + }, + { + "description": "Returns the confirmation status of the order.", + "id": "script-api:dw/order/Order#confirmationStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.confirmationStatus", + "sections": [ + { + "body": "Returns the confirmation status of the order.\n\nPossible values are CONFIRMATION_STATUS_NOTCONFIRMED and\nCONFIRMATION_STATUS_CONFIRMED.", + "heading": "Description" + } + ], + "signature": "confirmationStatus: EnumValue", + "source": "script-api", + "tags": [ + "confirmationstatus", + "order.confirmationstatus" + ], + "title": "Order.confirmationStatus" + }, + { + "description": "Creates a new dw.order.Appeasement associated with this order.", + "id": "script-api:dw/order/Order#createAppeasement", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "appeasementNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createAppeasement", + "returns": { + "type": "Appeasement" + }, + "sections": [ + { + "body": "Creates a new dw.order.Appeasement associated with this order.\n\nAn appeasementNumber must be specified.\n\nIf an Appeasement already exists for the appeasementNumber, the method fails with an\nexception.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createAppeasement(appeasementNumber: string): Appeasement", + "source": "script-api", + "tags": [ + "createappeasement", + "order.createappeasement" + ], + "throws": [ + { + "description": "if an Appeasement already exists with the number.", + "type": "IllegalArgumentException" + } + ], + "title": "Order.createAppeasement" + }, + { + "description": "Creates a new dw.order.Appeasement associated with this order.", + "id": "script-api:dw/order/Order#createAppeasement", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createAppeasement", + "returns": { + "type": "Appeasement" + }, + "sections": [ + { + "body": "Creates a new dw.order.Appeasement associated with this order.\n\nThe new Appeasement\nwill have an appeasementNumber based on the getOrderNo.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createAppeasement(): Appeasement", + "source": "script-api", + "tags": [ + "createappeasement", + "order.createappeasement" + ], + "title": "Order.createAppeasement" + }, + { + "description": "Creates a new dw.order.ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization).", + "id": "script-api:dw/order/Order#createReturnCase", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnCaseNumber", + "type": "string" + }, + { + "name": "isRMA", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createReturnCase", + "returns": { + "type": "ReturnCase | null" + }, + "sections": [ + { + "body": "Creates a new dw.order.ReturnCase associated with this order\nspecifying whether the ReturnCase is an RMA (return merchandise authorization).\n\nA returnCaseNumber must be specified.\n\nIf a ReturnCase already exists for the returnCaseNumber, the method fails with an\nexception.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createReturnCase(returnCaseNumber: string, isRMA: boolean): ReturnCase | null", + "source": "script-api", + "tags": [ + "createreturncase", + "order.createreturncase" + ], + "throws": [ + { + "description": "if a ReturnCase already exists with the number.", + "type": "IllegalArgumentException" + } + ], + "title": "Order.createReturnCase" + }, + { + "description": "Creates a new dw.order.ReturnCase associated with this order specifying whether the ReturnCase is an RMA (return merchandise authorization).", + "id": "script-api:dw/order/Order#createReturnCase", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "isRMA", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createReturnCase", + "returns": { + "type": "ReturnCase" + }, + "sections": [ + { + "body": "Creates a new dw.order.ReturnCase associated with this order\nspecifying whether the ReturnCase is an RMA (return merchandise authorization).\n\nThe new ReturnCase\nwill have a returnCaseNumber based on the getOrderNo, e.g. for an order-no 1234 the\nreturn cases will have the numbers 1234#RC1, 1234#RC2, 1234#RC3...\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createReturnCase(isRMA: boolean): ReturnCase", + "source": "script-api", + "tags": [ + "createreturncase", + "order.createreturncase" + ], + "title": "Order.createReturnCase" + }, + { + "description": "Returns the dw.order.OrderItem order item with the given status which wraps a new dw.order.ShippingLineItem service item which is created and added to the order.", + "id": "script-api:dw/order/Order#createServiceItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ID", + "type": "string" + }, + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createServiceItem", + "returns": { + "type": "OrderItem" + }, + "sections": [ + { + "body": "Returns the dw.order.OrderItem order item with the given status which wraps a new\ndw.order.ShippingLineItem service item which is created and added to the order.", + "heading": "Description" + } + ], + "signature": "createServiceItem(ID: string, status: string): OrderItem", + "source": "script-api", + "tags": [ + "createserviceitem", + "order.createserviceitem" + ], + "title": "Order.createServiceItem" + }, + { + "description": "Creates a new dw.order.ShippingOrder for this order.", + "id": "script-api:dw/order/Order#createShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createShippingOrder", + "returns": { + "type": "ShippingOrder" + }, + "sections": [ + { + "body": "Creates a new dw.order.ShippingOrder for this order.\n\nGenerates a default shipping order number. Use\ncreateShippingOrder for a defined shipping order number.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createShippingOrder(): ShippingOrder", + "source": "script-api", + "tags": [ + "createshippingorder", + "order.createshippingorder" + ], + "title": "Order.createShippingOrder" + }, + { + "description": "Creates a new dw.order.ShippingOrder for this order.", + "id": "script-api:dw/order/Order#createShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingOrderNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createShippingOrder", + "returns": { + "type": "ShippingOrder" + }, + "sections": [ + { + "body": "Creates a new dw.order.ShippingOrder for this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "createShippingOrder(shippingOrderNumber: string): ShippingOrder", + "source": "script-api", + "tags": [ + "createshippingorder", + "order.createshippingorder" + ], + "title": "Order.createShippingOrder" + }, + { + "description": "Returns the name of the user who has created the order. If an agent user has created the order, the agent user's name is returned. Otherwise \"Customer\" is returned.", + "id": "script-api:dw/order/Order#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.createdBy", + "sections": [ + { + "body": "Returns the name of the user who has created the order.\nIf an agent user has created the order, the agent user's name\nis returned. Otherwise \"Customer\" is returned.", + "heading": "Description" + } + ], + "signature": "readonly createdBy: string", + "source": "script-api", + "tags": [ + "createdby", + "order.createdby" + ], + "title": "Order.createdBy" + }, + { + "description": "Returns the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, this method returns this order because this order is the current order.", + "id": "script-api:dw/order/Order#currentOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.currentOrder", + "sections": [ + { + "body": "Returns the current order. The current order\nrepresents the most recent order in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order 3 is now the\ncurrent order and Order1 is still the original representation of the\norder. If this order has not been replaced, this method returns this\norder because this order is the current order.", + "heading": "Description" + } + ], + "signature": "readonly currentOrder: Order", + "source": "script-api", + "tags": [ + "currentorder", + "order.currentorder" + ], + "title": "Order.currentOrder" + }, + { + "description": "Returns the order number of the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, calling this method returns the same value as the getOrderNo method because this order is the current order.", + "id": "script-api:dw/order/Order#currentOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.currentOrderNo", + "sections": [ + { + "body": "Returns the order number of the current order. The current order\nrepresents the most recent order in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order 3 is now the\ncurrent order and Order1 is still the original representation of the\norder. If this order has not been replaced, calling this method returns the\nsame value as the getOrderNo method because this order is the\ncurrent order.", + "heading": "Description" + } + ], + "signature": "readonly currentOrderNo: string", + "source": "script-api", + "tags": [ + "currentorderno", + "order.currentorderno" + ], + "title": "Order.currentOrderNo" + }, + { + "description": "Returns the ID of the locale that was in effect when the order was placed. This is the customer's locale.", + "id": "script-api:dw/order/Order#customerLocaleID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.customerLocaleID", + "sections": [ + { + "body": "Returns the ID of the locale that was in effect when the order\nwas placed. This is the customer's locale.", + "heading": "Description" + } + ], + "signature": "readonly customerLocaleID: string | null", + "source": "script-api", + "tags": [ + "customerlocaleid", + "order.customerlocaleid" + ], + "title": "Order.customerLocaleID" + }, + { + "description": "Returns the customer-specific reference information for the order, or null.", + "id": "script-api:dw/order/Order#customerOrderReference", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.customerOrderReference", + "sections": [ + { + "body": "Returns the customer-specific reference information for the order, or null.", + "heading": "Description" + } + ], + "signature": "customerOrderReference: string | null", + "source": "script-api", + "tags": [ + "customerorderreference", + "order.customerorderreference" + ], + "title": "Order.customerOrderReference" + }, + { + "description": "Returns a date after which an order can be exported.", + "id": "script-api:dw/order/Order#exportAfter", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.exportAfter", + "sections": [ + { + "body": "Returns a date after which an order can be exported.", + "heading": "Description" + } + ], + "signature": "exportAfter: Date", + "source": "script-api", + "tags": [ + "exportafter", + "order.exportafter" + ], + "title": "Order.exportAfter" + }, + { + "description": "Returns the export status of the order.", + "id": "script-api:dw/order/Order#exportStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.exportStatus", + "sections": [ + { + "body": "Returns the export status of the order.\n\nPossible values are: EXPORT_STATUS_NOTEXPORTED,\nEXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY,\nand EXPORT_STATUS_FAILED.", + "heading": "Description" + } + ], + "signature": "exportStatus: EnumValue", + "source": "script-api", + "tags": [ + "exportstatus", + "order.exportstatus" + ], + "title": "Order.exportStatus" + }, + { + "description": "Returns the value of an external order number associated with this order, or null.", + "id": "script-api:dw/order/Order#externalOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderNo", + "sections": [ + { + "body": "Returns the value of an external order number associated\nwith this order, or null.", + "heading": "Description" + } + ], + "signature": "externalOrderNo: string | null", + "source": "script-api", + "tags": [ + "externalorderno", + "order.externalorderno" + ], + "title": "Order.externalOrderNo" + }, + { + "description": "Returns the status of an external order associated with this order, or null.", + "id": "script-api:dw/order/Order#externalOrderStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderStatus", + "sections": [ + { + "body": "Returns the status of an external order associated\nwith this order, or null.", + "heading": "Description" + } + ], + "signature": "externalOrderStatus: string | null", + "source": "script-api", + "tags": [ + "externalorderstatus", + "order.externalorderstatus" + ], + "title": "Order.externalOrderStatus" + }, + { + "description": "Returns the text describing the external order, or null.", + "id": "script-api:dw/order/Order#externalOrderText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.externalOrderText", + "sections": [ + { + "body": "Returns the text describing the external order, or null.", + "heading": "Description" + } + ], + "signature": "externalOrderText: string | null", + "source": "script-api", + "tags": [ + "externalordertext", + "order.externalordertext" + ], + "title": "Order.externalOrderText" + }, + { + "description": "Returns the affiliate partner ID value, or null.", + "id": "script-api:dw/order/Order#getAffiliatePartnerID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAffiliatePartnerID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the affiliate partner ID value, or null.", + "heading": "Description" + } + ], + "signature": "getAffiliatePartnerID(): string | null", + "source": "script-api", + "tags": [ + "getaffiliatepartnerid", + "order.getaffiliatepartnerid" + ], + "title": "Order.getAffiliatePartnerID" + }, + { + "description": "Returns the affiliate partner name value, or null.", + "id": "script-api:dw/order/Order#getAffiliatePartnerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAffiliatePartnerName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the affiliate partner name value, or null.", + "heading": "Description" + } + ], + "signature": "getAffiliatePartnerName(): string | null", + "source": "script-api", + "tags": [ + "getaffiliatepartnername", + "order.getaffiliatepartnername" + ], + "title": "Order.getAffiliatePartnerName" + }, + { + "description": "Returns the dw.order.Appeasement associated with this order with the given appeasementNumber. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getAppeasement", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "appeasementNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasement", + "returns": { + "type": "Appeasement | null" + }, + "sections": [ + { + "body": "Returns the dw.order.Appeasement associated with this order with the given appeasementNumber.\nThe method returns `null` if no instance can be found.", + "heading": "Description" + } + ], + "signature": "getAppeasement(appeasementNumber: string): Appeasement | null", + "source": "script-api", + "tags": [ + "getappeasement", + "order.getappeasement" + ], + "title": "Order.getAppeasement" + }, + { + "description": "Returns the dw.order.AppeasementItem associated with this Order with the given appeasementItemID. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getAppeasementItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "appeasementItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasementItem", + "returns": { + "type": "AppeasementItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.AppeasementItem associated with this Order with the given appeasementItemID.\nThe method returns `null` if no instance can be found.", + "heading": "Description" + } + ], + "signature": "getAppeasementItem(appeasementItemID: string): AppeasementItem | null", + "source": "script-api", + "tags": [ + "getappeasementitem", + "order.getappeasementitem" + ], + "title": "Order.getAppeasementItem" + }, + { + "description": "Returns the collection of dw.order.AppeasementItems associated with this order.", + "id": "script-api:dw/order/Order#getAppeasementItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasementItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.AppeasementItems associated with this order.", + "heading": "Description" + } + ], + "signature": "getAppeasementItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getappeasementitems", + "order.getappeasementitems" + ], + "title": "Order.getAppeasementItems" + }, + { + "description": "Returns the collection of dw.order.Appeasements associated with this order.", + "id": "script-api:dw/order/Order#getAppeasements", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getAppeasements", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.Appeasements associated with this order.", + "heading": "Description" + } + ], + "signature": "getAppeasements(): FilteringCollection", + "source": "script-api", + "tags": [ + "getappeasements", + "order.getappeasements" + ], + "title": "Order.getAppeasements" + }, + { + "description": "If this order was cancelled, returns the value of the cancel code or null.", + "id": "script-api:dw/order/Order#getCancelCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCancelCode", + "returns": { + "type": "EnumValue | null" + }, + "sections": [ + { + "body": "If this order was cancelled, returns the value of the\ncancel code or null.", + "heading": "Description" + } + ], + "signature": "getCancelCode(): EnumValue | null", + "source": "script-api", + "tags": [ + "getcancelcode", + "order.getcancelcode" + ], + "title": "Order.getCancelCode" + }, + { + "description": "If this order was cancelled, returns the text describing why the order was cancelled or null.", + "id": "script-api:dw/order/Order#getCancelDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCancelDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "If this order was cancelled, returns the text describing why\nthe order was cancelled or null.", + "heading": "Description" + } + ], + "signature": "getCancelDescription(): string | null", + "source": "script-api", + "tags": [ + "getcanceldescription", + "order.getcanceldescription" + ], + "title": "Order.getCancelDescription" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly. Associate a payment capture for an dw.order.PaymentInstrument with an dw.order.Invoice using Invoice.addCaptureTransaction.", + "id": "script-api:dw/order/Order#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCapturedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts\nare calculated on the fly. Associate a payment capture for an dw.order.PaymentInstrument with an dw.order.Invoice\nusing Invoice.addCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "getCapturedAmount(): Money", + "source": "script-api", + "tags": [ + "getcapturedamount", + "order.getcapturedamount" + ], + "title": "Order.getCapturedAmount" + }, + { + "description": "Returns the confirmation status of the order.", + "id": "script-api:dw/order/Order#getConfirmationStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getConfirmationStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the confirmation status of the order.\n\nPossible values are CONFIRMATION_STATUS_NOTCONFIRMED and\nCONFIRMATION_STATUS_CONFIRMED.", + "heading": "Description" + } + ], + "signature": "getConfirmationStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getconfirmationstatus", + "order.getconfirmationstatus" + ], + "title": "Order.getConfirmationStatus" + }, + { + "description": "Returns the name of the user who has created the order. If an agent user has created the order, the agent user's name is returned. Otherwise \"Customer\" is returned.", + "id": "script-api:dw/order/Order#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCreatedBy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the user who has created the order.\nIf an agent user has created the order, the agent user's name\nis returned. Otherwise \"Customer\" is returned.", + "heading": "Description" + } + ], + "signature": "getCreatedBy(): string", + "source": "script-api", + "tags": [ + "getcreatedby", + "order.getcreatedby" + ], + "title": "Order.getCreatedBy" + }, + { + "description": "Returns the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, this method returns this order because this order is the current order.", + "id": "script-api:dw/order/Order#getCurrentOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCurrentOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the current order. The current order\nrepresents the most recent order in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order 3 is now the\ncurrent order and Order1 is still the original representation of the\norder. If this order has not been replaced, this method returns this\norder because this order is the current order.", + "heading": "Description" + } + ], + "signature": "getCurrentOrder(): Order", + "source": "script-api", + "tags": [ + "getcurrentorder", + "order.getcurrentorder" + ], + "title": "Order.getCurrentOrder" + }, + { + "description": "Returns the order number of the current order. The current order represents the most recent order in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order 3 is now the current order and Order1 is still the original representation of the order. If this order has not been replaced, calling this method returns the same value as the getOrderNo method because this order is the current order.", + "id": "script-api:dw/order/Order#getCurrentOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCurrentOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order number of the current order. The current order\nrepresents the most recent order in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order 3 is now the\ncurrent order and Order1 is still the original representation of the\norder. If this order has not been replaced, calling this method returns the\nsame value as the getOrderNo method because this order is the\ncurrent order.", + "heading": "Description" + } + ], + "signature": "getCurrentOrderNo(): string", + "source": "script-api", + "tags": [ + "getcurrentorderno", + "order.getcurrentorderno" + ], + "title": "Order.getCurrentOrderNo" + }, + { + "description": "Returns the ID of the locale that was in effect when the order was placed. This is the customer's locale.", + "id": "script-api:dw/order/Order#getCustomerLocaleID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCustomerLocaleID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the locale that was in effect when the order\nwas placed. This is the customer's locale.", + "heading": "Description" + } + ], + "signature": "getCustomerLocaleID(): string | null", + "source": "script-api", + "tags": [ + "getcustomerlocaleid", + "order.getcustomerlocaleid" + ], + "title": "Order.getCustomerLocaleID" + }, + { + "description": "Returns the customer-specific reference information for the order, or null.", + "id": "script-api:dw/order/Order#getCustomerOrderReference", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getCustomerOrderReference", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the customer-specific reference information for the order, or null.", + "heading": "Description" + } + ], + "signature": "getCustomerOrderReference(): string | null", + "source": "script-api", + "tags": [ + "getcustomerorderreference", + "order.getcustomerorderreference" + ], + "title": "Order.getCustomerOrderReference" + }, + { + "description": "Returns a date after which an order can be exported.", + "id": "script-api:dw/order/Order#getExportAfter", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExportAfter", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns a date after which an order can be exported.", + "heading": "Description" + } + ], + "signature": "getExportAfter(): Date", + "source": "script-api", + "tags": [ + "getexportafter", + "order.getexportafter" + ], + "title": "Order.getExportAfter" + }, + { + "description": "Returns the export status of the order.", + "id": "script-api:dw/order/Order#getExportStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExportStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the export status of the order.\n\nPossible values are: EXPORT_STATUS_NOTEXPORTED,\nEXPORT_STATUS_EXPORTED, EXPORT_STATUS_READY,\nand EXPORT_STATUS_FAILED.", + "heading": "Description" + } + ], + "signature": "getExportStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getexportstatus", + "order.getexportstatus" + ], + "title": "Order.getExportStatus" + }, + { + "description": "Returns the value of an external order number associated with this order, or null.", + "id": "script-api:dw/order/Order#getExternalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value of an external order number associated\nwith this order, or null.", + "heading": "Description" + } + ], + "signature": "getExternalOrderNo(): string | null", + "source": "script-api", + "tags": [ + "getexternalorderno", + "order.getexternalorderno" + ], + "title": "Order.getExternalOrderNo" + }, + { + "description": "Returns the status of an external order associated with this order, or null.", + "id": "script-api:dw/order/Order#getExternalOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderStatus", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the status of an external order associated\nwith this order, or null.", + "heading": "Description" + } + ], + "signature": "getExternalOrderStatus(): string | null", + "source": "script-api", + "tags": [ + "getexternalorderstatus", + "order.getexternalorderstatus" + ], + "title": "Order.getExternalOrderStatus" + }, + { + "description": "Returns the text describing the external order, or null.", + "id": "script-api:dw/order/Order#getExternalOrderText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getExternalOrderText", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the text describing the external order, or null.", + "heading": "Description" + } + ], + "signature": "getExternalOrderText(): string | null", + "source": "script-api", + "tags": [ + "getexternalordertext", + "order.getexternalordertext" + ], + "title": "Order.getExternalOrderText" + }, + { + "description": "The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for Commerce experience, service agents can find information for customers who have never called into the call center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to determine all the records associated with a specific customer.", + "id": "script-api:dw/order/Order#getGlobalPartyID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getGlobalPartyID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for\nCommerce experience, service agents can find information for customers who have never called into the call\ncenter, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and\neasily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to\ndetermine all the records associated with a specific customer.", + "heading": "Description" + } + ], + "signature": "getGlobalPartyID(): string | null", + "source": "script-api", + "tags": [ + "getglobalpartyid", + "order.getglobalpartyid" + ], + "title": "Order.getGlobalPartyID" + }, + { + "description": "Returns the dw.order.Invoice associated with this order with the given invoiceNumber. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoice", + "returns": { + "type": "Invoice | null" + }, + "sections": [ + { + "body": "Returns the dw.order.Invoice associated with this order with the given invoiceNumber.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getInvoice(invoiceNumber: string): Invoice | null", + "source": "script-api", + "tags": [ + "getinvoice", + "order.getinvoice" + ], + "title": "Order.getInvoice" + }, + { + "description": "Returns the dw.order.InvoiceItem associated with this order with the given ID. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getInvoiceItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceItem", + "returns": { + "type": "InvoiceItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.InvoiceItem associated with this order with the given ID.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getInvoiceItem(invoiceItemID: string): InvoiceItem | null", + "source": "script-api", + "tags": [ + "getinvoiceitem", + "order.getinvoiceitem" + ], + "title": "Order.getInvoiceItem" + }, + { + "description": "Returns the collection of dw.order.InvoiceItems associated with this order.", + "id": "script-api:dw/order/Order#getInvoiceItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.InvoiceItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getInvoiceItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getinvoiceitems", + "order.getinvoiceitems" + ], + "title": "Order.getInvoiceItems" + }, + { + "description": "Returns the invoice number for this Order.", + "id": "script-api:dw/order/Order#getInvoiceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoiceNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the invoice number for this Order.\n\nWhen an order is placed (e.g. with dw.order.OrderMgr.placeOrder) invoice number will be filled\nusing a sequence. Before order was placed `null` will be returned unless it was set with\nsetInvoiceNo.", + "heading": "Description" + } + ], + "signature": "getInvoiceNo(): string | null", + "source": "script-api", + "tags": [ + "getinvoiceno", + "order.getinvoiceno" + ], + "title": "Order.getInvoiceNo" + }, + { + "description": "Returns the collection of dw.order.Invoices associated with this order.", + "id": "script-api:dw/order/Order#getInvoices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getInvoices", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.Invoices associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getInvoices(): FilteringCollection", + "source": "script-api", + "tags": [ + "getinvoices", + "order.getinvoices" + ], + "title": "Order.getInvoices" + }, + { + "deprecated": { + "message": "This method will be removed soon. Please use the following methods instead:\n\n- getOrderExportXML \\u2013 if payment instrument data should be masked\n- getOrderExportXML_1 \\u2013 if payment instrument data should be re-encrypted" + }, + "description": "Returns the order export XML as String object, with payment instrument data re-encrypted using the given encryption algorithm and key.", + "id": "script-api:dw/order/Order#getOrderExportXML", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "encryptionAlgorithm", + "type": "string" + }, + { + "name": "encryptionKey", + "type": "string" + }, + { + "name": "encryptUsingEKID", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderExportXML", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order export XML as String object, with payment instrument data re-encrypted using the given\nencryption algorithm and key.\n\nNOTE: If no encryption is needed or desired please always use getOrderExportXML instead, which returns\nthe payment instrument data masked. Do not pass in any null arguments!\n\nExample:", + "heading": "Description" + } + ], + "signature": "getOrderExportXML(encryptionAlgorithm: string, encryptionKey: string, encryptUsingEKID: boolean): string", + "source": "script-api", + "tags": [ + "getorderexportxml", + "order.getorderexportxml" + ], + "throws": [ + { + "description": "If the method is called in a transaction with changes.", + "type": "IllegalStateException" + }, + { + "description": "If the order is not placed. This method can be called for placed orders only.", + "type": "IllegalStateException" + }, + { + "description": "If the order export XML could not be generated.", + "type": "IllegalStateException" + } + ], + "title": "Order.getOrderExportXML" + }, + { + "description": "Returns the dw.order.OrderItem for the itemID. An OrderItem will only exist for dw.order.ProductLineItems or dw.order.ShippingLineItems which belong to the order. The method fails with an exception if no instance can be found.", + "id": "script-api:dw/order/Order#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "itemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderItem", + "returns": { + "type": "OrderItem" + }, + "sections": [ + { + "body": "Returns the dw.order.OrderItem for the itemID.\nAn OrderItem will only exist for dw.order.ProductLineItems or\ndw.order.ShippingLineItems which belong to the order.\nThe method fails with an exception if no instance can be found.", + "heading": "Description" + } + ], + "signature": "getOrderItem(itemID: string): OrderItem", + "source": "script-api", + "tags": [ + "getorderitem", + "order.getorderitem" + ], + "throws": [ + { + "description": "if no instance is found", + "type": "IllegalArgumentException" + } + ], + "title": "Order.getOrderItem" + }, + { + "description": "Returns the order number for this order.", + "id": "script-api:dw/order/Order#getOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order number for this order.", + "heading": "Description" + } + ], + "signature": "getOrderNo(): string", + "source": "script-api", + "tags": [ + "getorderno", + "order.getorderno" + ], + "title": "Order.getOrderNo" + }, + { + "description": "Returns the token for this order. The order token is a string (length 32 bytes) associated with this one order. The order token is random. It reduces the capability of malicious users to access an order through guessing. Order token can be used to further validate order ownership, but should never be used to solely validate ownership. In addition, the storefront should ensure authentication and authorization. See the Security Best Practices for Developers for details.", + "id": "script-api:dw/order/Order#getOrderToken", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOrderToken", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the token for this order. The order token is a string (length 32 bytes) associated\nwith this one order. The order token is random. It reduces the capability of malicious\nusers to access an order through guessing. Order token can be used to further validate order\nownership, but should never be used to solely validate ownership. In addition, the storefront\nshould ensure authentication and authorization. See the Security Best Practices for Developers for details.", + "heading": "Description" + } + ], + "signature": "getOrderToken(): string", + "source": "script-api", + "tags": [ + "getordertoken", + "order.getordertoken" + ], + "title": "Order.getOrderToken" + }, + { + "description": "Returns the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns this order.", + "id": "script-api:dw/order/Order#getOriginalOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOriginalOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the original order associated with\nthis order. The original order represents an order that was the\nfirst ancestor in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order1 is still the\noriginal representation of the order. If this order is the first\nancestor, this method returns this order.", + "heading": "Description" + } + ], + "signature": "getOriginalOrder(): Order", + "source": "script-api", + "tags": [ + "getoriginalorder", + "order.getoriginalorder" + ], + "title": "Order.getOriginalOrder" + }, + { + "description": "Returns the order number of the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns the value of getOrderNo().", + "id": "script-api:dw/order/Order#getOriginalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getOriginalOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the order number of the original order associated with\nthis order. The original order represents an order that was the\nfirst ancestor in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order1 is still the\noriginal representation of the order. If this order is the first\nancestor, this method returns the value of getOrderNo().", + "heading": "Description" + } + ], + "signature": "getOriginalOrderNo(): string", + "source": "script-api", + "tags": [ + "getoriginalorderno", + "order.getoriginalorderno" + ], + "title": "Order.getOriginalOrderNo" + }, + { + "description": "Returns the order payment status value.", + "id": "script-api:dw/order/Order#getPaymentStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getPaymentStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the order payment status value.\n\nPossible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID\nor PAYMENT_STATUS_PAID.", + "heading": "Description" + } + ], + "signature": "getPaymentStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getpaymentstatus", + "order.getpaymentstatus" + ], + "title": "Order.getPaymentStatus" + }, + { + "deprecated": { + "message": "Use dw.order.LineItemCtnr.getPaymentInstruments\nto get the list of PaymentInstrument instances and then use\ngetPaymentTransaction() method on each PaymentInstrument to access\nthe individual transactions." + }, + "description": "Returns the payment transaction associated with this order. It is possible that there are multiple payment transactions associated with the order. In this case, this method returns the transaction associated with the first PaymentInstrument returned by `getPaymentInstruments()`.", + "id": "script-api:dw/order/Order#getPaymentTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getPaymentTransaction", + "returns": { + "type": "PaymentTransaction | null" + }, + "sections": [ + { + "body": "Returns the payment transaction associated with this order.\nIt is possible that there are multiple payment transactions\nassociated with the order. In this case, this method returns\nthe transaction associated with the first PaymentInstrument\nreturned by `getPaymentInstruments()`.", + "heading": "Description" + } + ], + "signature": "getPaymentTransaction(): PaymentTransaction | null", + "source": "script-api", + "tags": [ + "getpaymenttransaction", + "order.getpaymenttransaction" + ], + "title": "Order.getPaymentTransaction" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly. Associate a payment refund for an dw.order.PaymentInstrument with an dw.order.Invoice using Invoice.addRefundTransaction.", + "id": "script-api:dw/order/Order#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getRefundedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts are\ncalculated on the fly. Associate a payment refund for an dw.order.PaymentInstrument with an dw.order.Invoice\nusing Invoice.addRefundTransaction.", + "heading": "Description" + } + ], + "signature": "getRefundedAmount(): Money", + "source": "script-api", + "tags": [ + "getrefundedamount", + "order.getrefundedamount" + ], + "title": "Order.getRefundedAmount" + }, + { + "description": "Returns the IP address of the remote host from which the order was created.", + "id": "script-api:dw/order/Order#getRemoteHost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getRemoteHost", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the IP address of the remote host from which the order was created.\n\nIf the IP address was not captured for the order because order IP logging\nwas disabled at the time the order was created, null will be returned.", + "heading": "Description" + } + ], + "signature": "getRemoteHost(): string | null", + "source": "script-api", + "tags": [ + "getremotehost", + "order.getremotehost" + ], + "title": "Order.getRemoteHost" + }, + { + "description": "If this order was replaced by another order, returns the value of the replace code. Otherwise. returns null.", + "id": "script-api:dw/order/Order#getReplaceCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplaceCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the value of the replace code. Otherwise.\nreturns null.", + "heading": "Description" + } + ], + "signature": "getReplaceCode(): EnumValue", + "source": "script-api", + "tags": [ + "getreplacecode", + "order.getreplacecode" + ], + "title": "Order.getReplaceCode" + }, + { + "description": "If this order was replaced by another order, returns the value of the replace description. Otherwise returns null.", + "id": "script-api:dw/order/Order#getReplaceDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplaceDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the value of the replace description. Otherwise\nreturns null.", + "heading": "Description" + } + ], + "signature": "getReplaceDescription(): string | null", + "source": "script-api", + "tags": [ + "getreplacedescription", + "order.getreplacedescription" + ], + "title": "Order.getReplaceDescription" + }, + { + "description": "Returns the order that this order replaced or null. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.", + "id": "script-api:dw/order/Order#getReplacedOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacedOrder", + "returns": { + "type": "Order | null" + }, + "sections": [ + { + "body": "Returns the order that this order replaced or null. For example, if you\nhave three orders where Order1 was replaced by Order2 and Order2 was\nreplaced by Order3, calling this method on Order3 will return Order2.\nSimilarly, calling this method on Order1 will return null as Order1 was\nthe original order.", + "heading": "Description" + } + ], + "signature": "getReplacedOrder(): Order | null", + "source": "script-api", + "tags": [ + "getreplacedorder", + "order.getreplacedorder" + ], + "title": "Order.getReplacedOrder" + }, + { + "description": "Returns the order number that this order replaced or null if this order did not replace an order. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return the order number for Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.", + "id": "script-api:dw/order/Order#getReplacedOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacedOrderNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the order number that this order replaced or null if this order\ndid not replace an order. For example, if you have three orders\nwhere Order1 was replaced by Order2 and Order2 was replaced by Order3,\ncalling this method on Order3 will return the order number for\nOrder2. Similarly, calling this method on Order1 will return null as\nOrder1 was the original order.", + "heading": "Description" + } + ], + "signature": "getReplacedOrderNo(): string | null", + "source": "script-api", + "tags": [ + "getreplacedorderno", + "order.getreplacedorderno" + ], + "title": "Order.getReplacedOrderNo" + }, + { + "description": "Returns the order that replaced this order, or null.", + "id": "script-api:dw/order/Order#getReplacementOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacementOrder", + "returns": { + "type": "Order | null" + }, + "sections": [ + { + "body": "Returns the order that replaced this order, or null.", + "heading": "Description" + } + ], + "signature": "getReplacementOrder(): Order | null", + "source": "script-api", + "tags": [ + "getreplacementorder", + "order.getreplacementorder" + ], + "title": "Order.getReplacementOrder" + }, + { + "description": "If this order was replaced by another order, returns the order number that replaced this order. Otherwise returns null.", + "id": "script-api:dw/order/Order#getReplacementOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReplacementOrderNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the order number that replaced this order. Otherwise\nreturns null.", + "heading": "Description" + } + ], + "signature": "getReplacementOrderNo(): string | null", + "source": "script-api", + "tags": [ + "getreplacementorderno", + "order.getreplacementorderno" + ], + "title": "Order.getReplacementOrderNo" + }, + { + "description": "Returns the dw.order.Return associated with this order with the given returnNumber. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getReturn", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturn", + "returns": { + "type": "Return | null" + }, + "sections": [ + { + "body": "Returns the dw.order.Return associated with this order with the given returnNumber.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturn(returnNumber: string): Return | null", + "source": "script-api", + "tags": [ + "getreturn", + "order.getreturn" + ], + "title": "Order.getReturn" + }, + { + "description": "Returns the dw.order.ReturnCase associated with this order with the given returnCaseNumber. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getReturnCase", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnCaseNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCase", + "returns": { + "type": "ReturnCase | null" + }, + "sections": [ + { + "body": "Returns the dw.order.ReturnCase associated with this order with the given returnCaseNumber.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnCase(returnCaseNumber: string): ReturnCase | null", + "source": "script-api", + "tags": [ + "getreturncase", + "order.getreturncase" + ], + "title": "Order.getReturnCase" + }, + { + "description": "Returns the dw.order.ReturnCaseItem associated with this order with the given returnCaseItemID. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getReturnCaseItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnCaseItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCaseItem", + "returns": { + "type": "ReturnCaseItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.ReturnCaseItem associated with this order with the given returnCaseItemID.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnCaseItem(returnCaseItemID: string): ReturnCaseItem | null", + "source": "script-api", + "tags": [ + "getreturncaseitem", + "order.getreturncaseitem" + ], + "title": "Order.getReturnCaseItem" + }, + { + "description": "Returns the collection of dw.order.ReturnCaseItems associated with this order.", + "id": "script-api:dw/order/Order#getReturnCaseItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCaseItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnCaseItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnCaseItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getreturncaseitems", + "order.getreturncaseitems" + ], + "title": "Order.getReturnCaseItems" + }, + { + "description": "Returns the collection of dw.order.ReturnCases associated with this order.", + "id": "script-api:dw/order/Order#getReturnCases", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnCases", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnCases associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnCases(): FilteringCollection", + "source": "script-api", + "tags": [ + "getreturncases", + "order.getreturncases" + ], + "title": "Order.getReturnCases" + }, + { + "description": "Returns the dw.order.ReturnItem associated with this order with the given ID. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getReturnItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnItem", + "returns": { + "type": "ReturnItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.ReturnItem associated with this order with the given ID.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnItem(returnItemID: string): ReturnItem | null", + "source": "script-api", + "tags": [ + "getreturnitem", + "order.getreturnitem" + ], + "title": "Order.getReturnItem" + }, + { + "description": "Returns the collection of dw.order.ReturnItems associated with this order.", + "id": "script-api:dw/order/Order#getReturnItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturnItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturnItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getreturnitems", + "order.getreturnitems" + ], + "title": "Order.getReturnItems" + }, + { + "description": "Returns the collection of dw.order.Returns associated with this order.", + "id": "script-api:dw/order/Order#getReturns", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getReturns", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.Returns associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getReturns(): FilteringCollection", + "source": "script-api", + "tags": [ + "getreturns", + "order.getreturns" + ], + "title": "Order.getReturns" + }, + { + "description": "Returns the dw.order.ShippingOrder associated with this order with the given shippingOrderNumber. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingOrderNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrder", + "returns": { + "type": "ShippingOrder | null" + }, + "sections": [ + { + "body": "Returns the dw.order.ShippingOrder associated with this order with the given shippingOrderNumber.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getShippingOrder(shippingOrderNumber: string): ShippingOrder | null", + "source": "script-api", + "tags": [ + "getshippingorder", + "order.getshippingorder" + ], + "title": "Order.getShippingOrder" + }, + { + "description": "Returns the dw.order.ShippingOrderItem associated with this order with the given shippingOrderItemID. The method returns `null` if no instance can be found.", + "id": "script-api:dw/order/Order#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingOrderItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrderItem", + "returns": { + "type": "ShippingOrderItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.ShippingOrderItem associated with this order with the given shippingOrderItemID.\nThe method returns `null` if no instance can be found.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItem(shippingOrderItemID: string): ShippingOrderItem | null", + "source": "script-api", + "tags": [ + "getshippingorderitem", + "order.getshippingorderitem" + ], + "title": "Order.getShippingOrderItem" + }, + { + "description": "Returns the collection of dw.order.ShippingOrderItems associated with this order.", + "id": "script-api:dw/order/Order#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrderItems", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.ShippingOrderItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItems(): FilteringCollection", + "source": "script-api", + "tags": [ + "getshippingorderitems", + "order.getshippingorderitems" + ], + "title": "Order.getShippingOrderItems" + }, + { + "description": "Returns the collection of dw.order.ShippingOrders associated with this order.", + "id": "script-api:dw/order/Order#getShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingOrders", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Returns the collection of dw.order.ShippingOrders associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getShippingOrders(): FilteringCollection", + "source": "script-api", + "tags": [ + "getshippingorders", + "order.getshippingorders" + ], + "title": "Order.getShippingOrders" + }, + { + "description": "Returns the order shipping status.", + "id": "script-api:dw/order/Order#getShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getShippingStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the order shipping status.\n\nPossible values are SHIPPING_STATUS_NOTSHIPPED,\nSHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.", + "heading": "Description" + } + ], + "signature": "getShippingStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getshippingstatus", + "order.getshippingstatus" + ], + "title": "Order.getShippingStatus" + }, + { + "description": "Returns the source code stored with the order or `null` if no source code is attached to the order.", + "id": "script-api:dw/order/Order#getSourceCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCode", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the source code stored with the order or `null` if no source code is attached to the order.", + "heading": "Description" + } + ], + "signature": "getSourceCode(): string | null", + "source": "script-api", + "tags": [ + "getsourcecode", + "order.getsourcecode" + ], + "title": "Order.getSourceCode" + }, + { + "description": "Returns the source code group attached to the order or `null` if no source code group is attached to the order.", + "id": "script-api:dw/order/Order#getSourceCodeGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCodeGroup", + "returns": { + "type": "SourceCodeGroup | null" + }, + "sections": [ + { + "body": "Returns the source code group attached to the order or `null` if no source code group is attached to\nthe order.", + "heading": "Description" + } + ], + "signature": "getSourceCodeGroup(): SourceCodeGroup | null", + "source": "script-api", + "tags": [ + "getsourcecodegroup", + "order.getsourcecodegroup" + ], + "title": "Order.getSourceCodeGroup" + }, + { + "description": "Returns the source code group id stored with the order or `null` if no source code group is attached to the order.", + "id": "script-api:dw/order/Order#getSourceCodeGroupID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getSourceCodeGroupID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the source code group id stored with the order or `null` if no source code group is attached\nto the order.", + "heading": "Description" + } + ], + "signature": "getSourceCodeGroupID(): string | null", + "source": "script-api", + "tags": [ + "getsourcecodegroupid", + "order.getsourcecodegroupid" + ], + "title": "Order.getSourceCodeGroupID" + }, + { + "description": "Returns the status of the order.", + "id": "script-api:dw/order/Order#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the status of the order.\n\nPossible values are:\n\n- ORDER_STATUS_CREATED\n- ORDER_STATUS_NEW\n- ORDER_STATUS_OPEN\n- ORDER_STATUS_COMPLETED\n- ORDER_STATUS_CANCELLED\n- ORDER_STATUS_FAILED\n- ORDER_STATUS_REPLACED\n\nThe order status usually changes when a process action is initiated. Most status changes have an action which\nneeds to executed in order to end having the order in a specific order status. When an order is created with e.g.\ndw.order.OrderMgr.createOrder the order status will be ORDER_STATUS_CREATED. The usual\nflow is that payment authorization will be added to the order. Once the order is considered as valid (payed,\nfraud checked, ...) the order gets placed. This can be done by calling\ndw.order.OrderMgr.placeOrder. The result of placing an order will be status\nORDER_STATUS_OPEN (from a process standpoint ORDER_STATUS_NEW which has the same meaning).\nStatus ORDER_STATUS_REPLACED is related to functionality\ndw.order.BasketMgr.createBasketFromOrder. ORDER_STATUS_COMPLETED has no meaning by\ndefault but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes:\n\nStatus before Action Status after Business meaning\n- dw.order.OrderMgr.createOrder CREATED Order was created from a basket.\nCREATED dw.order.OrderMgr.placeOrder OPEN/NEW Order was considered as valid. Order can now be exported to 3rd party systems.\nCREATED dw.order.OrderMgr.failOrder FAILED Order was considered not valid. E.g. payment authorization was wrong or fraud check was not successful.\nOPEN/NEW dw.order.OrderMgr.cancelOrder CANCELLED Order was cancelled.\nCANCELLED dw.order.OrderMgr.undoCancelOrder OPEN/NEW Order was cancelled by mistake and this needs to be undone.\nFAILED dw.order.OrderMgr.undoFailOrder CREATED Order was failed by mistake and this needs to be undone.\n\nEvery status change will trigger a change in the order journal which is the base for GMV calculations.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "order.getstatus" + ], + "title": "Order.getStatus" + }, + { + "description": "The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for Commerce experience, service agents can find information for customers who have never called into the call center, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and easily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to determine all the records associated with a specific customer.", + "id": "script-api:dw/order/Order#globalPartyID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.globalPartyID", + "sections": [ + { + "body": "The Global Party ID reconciles customer identity across multiple systems. For example, as part of the Service for\nCommerce experience, service agents can find information for customers who have never called into the call\ncenter, but have created a profile on the website. Service agents can find guest order data from B2C Commerce and\neasily create accounts for customers. Customer 360 Data Manager matches records from multiple data sources to\ndetermine all the records associated with a specific customer.", + "heading": "Description" + } + ], + "signature": "readonly globalPartyID: string | null", + "source": "script-api", + "tags": [ + "globalpartyid", + "order.globalpartyid" + ], + "title": "Order.globalPartyID" + }, + { + "description": "Returns true, if the order is imported and false otherwise.", + "id": "script-api:dw/order/Order#imported", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.imported", + "sections": [ + { + "body": "Returns true, if the order is imported and false\notherwise.", + "heading": "Description" + } + ], + "signature": "readonly imported: boolean", + "source": "script-api", + "tags": [ + "imported", + "order.imported" + ], + "title": "Order.imported" + }, + { + "description": "Returns the collection of dw.order.InvoiceItems associated with this order.", + "id": "script-api:dw/order/Order#invoiceItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoiceItems", + "sections": [ + { + "body": "Returns the collection of dw.order.InvoiceItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly invoiceItems: FilteringCollection", + "source": "script-api", + "tags": [ + "invoiceitems", + "order.invoiceitems" + ], + "title": "Order.invoiceItems" + }, + { + "description": "Returns the invoice number for this Order.", + "id": "script-api:dw/order/Order#invoiceNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoiceNo", + "sections": [ + { + "body": "Returns the invoice number for this Order.\n\nWhen an order is placed (e.g. with dw.order.OrderMgr.placeOrder) invoice number will be filled\nusing a sequence. Before order was placed `null` will be returned unless it was set with\nsetInvoiceNo.", + "heading": "Description" + } + ], + "signature": "invoiceNo: string | null", + "source": "script-api", + "tags": [ + "invoiceno", + "order.invoiceno" + ], + "title": "Order.invoiceNo" + }, + { + "description": "Returns the collection of dw.order.Invoices associated with this order.", + "id": "script-api:dw/order/Order#invoices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.invoices", + "sections": [ + { + "body": "Returns the collection of dw.order.Invoices associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly invoices: FilteringCollection", + "source": "script-api", + "tags": [ + "invoices", + "order.invoices" + ], + "title": "Order.invoices" + }, + { + "description": "Returns true, if the order is imported and false otherwise.", + "id": "script-api:dw/order/Order#isImported", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.isImported", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true, if the order is imported and false\notherwise.", + "heading": "Description" + } + ], + "signature": "isImported(): boolean", + "source": "script-api", + "tags": [ + "isimported", + "order.isimported" + ], + "title": "Order.isImported" + }, + { + "description": "Use this method to check if the Order was created with grouped taxation calculation.", + "id": "script-api:dw/order/Order#isTaxRoundedAtGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.isTaxRoundedAtGroup", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Use this method to check if the Order was created with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "isTaxRoundedAtGroup(): boolean", + "source": "script-api", + "tags": [ + "istaxroundedatgroup", + "order.istaxroundedatgroup" + ], + "title": "Order.isTaxRoundedAtGroup" + }, + { + "description": "Returns the order export XML as String object.", + "id": "script-api:dw/order/Order#orderExportXML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderExportXML", + "sections": [ + { + "body": "Returns the order export XML as String object.\n\nNOTE: This method will return payment instrument data masked. If payment instrument re-encryption is needed\nplease use getOrderExportXML_2 instead.\n\nExample:", + "heading": "Description" + } + ], + "signature": "readonly orderExportXML: string", + "source": "script-api", + "tags": [ + "orderexportxml", + "order.orderexportxml" + ], + "throws": [ + { + "description": "If the method is called in a transaction with changes.", + "type": "IllegalStateException" + }, + { + "description": "If the order is not placed. This method can be called for placed orders only.", + "type": "IllegalStateException" + }, + { + "description": "If the order export XML could not be generated.", + "type": "IllegalStateException" + } + ], + "title": "Order.orderExportXML" + }, + { + "description": "Returns the order number for this order.", + "id": "script-api:dw/order/Order#orderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderNo", + "sections": [ + { + "body": "Returns the order number for this order.", + "heading": "Description" + } + ], + "signature": "readonly orderNo: string", + "source": "script-api", + "tags": [ + "orderno", + "order.orderno" + ], + "title": "Order.orderNo" + }, + { + "description": "Returns the token for this order. The order token is a string (length 32 bytes) associated with this one order. The order token is random. It reduces the capability of malicious users to access an order through guessing. Order token can be used to further validate order ownership, but should never be used to solely validate ownership. In addition, the storefront should ensure authentication and authorization. See the Security Best Practices for Developers for details.", + "id": "script-api:dw/order/Order#orderToken", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.orderToken", + "sections": [ + { + "body": "Returns the token for this order. The order token is a string (length 32 bytes) associated\nwith this one order. The order token is random. It reduces the capability of malicious\nusers to access an order through guessing. Order token can be used to further validate order\nownership, but should never be used to solely validate ownership. In addition, the storefront\nshould ensure authentication and authorization. See the Security Best Practices for Developers for details.", + "heading": "Description" + } + ], + "signature": "readonly orderToken: string", + "source": "script-api", + "tags": [ + "ordertoken", + "order.ordertoken" + ], + "title": "Order.orderToken" + }, + { + "description": "Returns the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns this order.", + "id": "script-api:dw/order/Order#originalOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.originalOrder", + "sections": [ + { + "body": "Returns the original order associated with\nthis order. The original order represents an order that was the\nfirst ancestor in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order1 is still the\noriginal representation of the order. If this order is the first\nancestor, this method returns this order.", + "heading": "Description" + } + ], + "signature": "readonly originalOrder: Order", + "source": "script-api", + "tags": [ + "originalorder", + "order.originalorder" + ], + "title": "Order.originalOrder" + }, + { + "description": "Returns the order number of the original order associated with this order. The original order represents an order that was the first ancestor in a chain of orders. For example, if Order1 was replaced by Order2, Order2 is the current representation of the order and Order1 is the original representation of the order. If you replace Order2 with Order3, Order1 is still the original representation of the order. If this order is the first ancestor, this method returns the value of getOrderNo().", + "id": "script-api:dw/order/Order#originalOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.originalOrderNo", + "sections": [ + { + "body": "Returns the order number of the original order associated with\nthis order. The original order represents an order that was the\nfirst ancestor in a chain of orders.\nFor example, if Order1 was replaced by Order2, Order2 is the current\nrepresentation of the order and Order1 is the original representation\nof the order. If you replace Order2 with Order3, Order1 is still the\noriginal representation of the order. If this order is the first\nancestor, this method returns the value of getOrderNo().", + "heading": "Description" + } + ], + "signature": "readonly originalOrderNo: string", + "source": "script-api", + "tags": [ + "originalorderno", + "order.originalorderno" + ], + "title": "Order.originalOrderNo" + }, + { + "description": "Returns the order payment status value.", + "id": "script-api:dw/order/Order#paymentStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.paymentStatus", + "sections": [ + { + "body": "Returns the order payment status value.\n\nPossible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID\nor PAYMENT_STATUS_PAID.", + "heading": "Description" + } + ], + "signature": "paymentStatus: EnumValue", + "source": "script-api", + "tags": [ + "paymentstatus", + "order.paymentstatus" + ], + "title": "Order.paymentStatus" + }, + { + "deprecated": { + "message": "Use dw.order.LineItemCtnr.getPaymentInstruments\nto get the list of PaymentInstrument instances and then use\ngetPaymentTransaction() method on each PaymentInstrument to access\nthe individual transactions." + }, + "description": "Returns the payment transaction associated with this order. It is possible that there are multiple payment transactions associated with the order. In this case, this method returns the transaction associated with the first PaymentInstrument returned by `getPaymentInstruments()`.", + "id": "script-api:dw/order/Order#paymentTransaction", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.paymentTransaction", + "sections": [ + { + "body": "Returns the payment transaction associated with this order.\nIt is possible that there are multiple payment transactions\nassociated with the order. In this case, this method returns\nthe transaction associated with the first PaymentInstrument\nreturned by `getPaymentInstruments()`.", + "heading": "Description" + } + ], + "signature": "readonly paymentTransaction: PaymentTransaction | null", + "source": "script-api", + "tags": [ + "paymenttransaction", + "order.paymenttransaction" + ], + "title": "Order.paymentTransaction" + }, + { + "description": "Ensures that the order is authorized.", + "id": "script-api:dw/order/Order#reauthorize", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.reauthorize", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Ensures that the order is authorized.\n\nChecks if the order is authorized by calling the hook\ndw.order.hooks.PaymentHooks.validateAuthorization. If the authorization\nis not valid it reauthorizes the order by calling the\ndw.order.hooks.PaymentHooks.reauthorize.", + "heading": "Description" + } + ], + "signature": "reauthorize(): Status", + "source": "script-api", + "tags": [ + "reauthorize", + "order.reauthorize" + ], + "title": "Order.reauthorize" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly. Associate a payment refund for an dw.order.PaymentInstrument with an dw.order.Invoice using Invoice.addRefundTransaction.", + "id": "script-api:dw/order/Order#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.refundedAmount", + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts are\ncalculated on the fly. Associate a payment refund for an dw.order.PaymentInstrument with an dw.order.Invoice\nusing Invoice.addRefundTransaction.", + "heading": "Description" + } + ], + "signature": "readonly refundedAmount: Money", + "source": "script-api", + "tags": [ + "refundedamount", + "order.refundedamount" + ], + "title": "Order.refundedAmount" + }, + { + "description": "Returns the IP address of the remote host from which the order was created.", + "id": "script-api:dw/order/Order#remoteHost", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.remoteHost", + "sections": [ + { + "body": "Returns the IP address of the remote host from which the order was created.\n\nIf the IP address was not captured for the order because order IP logging\nwas disabled at the time the order was created, null will be returned.", + "heading": "Description" + } + ], + "signature": "readonly remoteHost: string | null", + "source": "script-api", + "tags": [ + "remotehost", + "order.remotehost" + ], + "title": "Order.remoteHost" + }, + { + "description": "Removes the IP address of the remote host if stored.", + "id": "script-api:dw/order/Order#removeRemoteHost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.removeRemoteHost", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the IP address of the remote host if stored.\n\nIf IP logging was enabled during order creation the IP address of the customer will be stored and can be\nretrieved using getRemoteHost.", + "heading": "Description" + } + ], + "signature": "removeRemoteHost(): void", + "source": "script-api", + "tags": [ + "removeremotehost", + "order.removeremotehost" + ], + "title": "Order.removeRemoteHost" + }, + { + "description": "If this order was replaced by another order, returns the value of the replace code. Otherwise. returns null.", + "id": "script-api:dw/order/Order#replaceCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replaceCode", + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the value of the replace code. Otherwise.\nreturns null.", + "heading": "Description" + } + ], + "signature": "replaceCode: EnumValue", + "source": "script-api", + "tags": [ + "replacecode", + "order.replacecode" + ], + "title": "Order.replaceCode" + }, + { + "description": "If this order was replaced by another order, returns the value of the replace description. Otherwise returns null.", + "id": "script-api:dw/order/Order#replaceDescription", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replaceDescription", + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the value of the replace description. Otherwise\nreturns null.", + "heading": "Description" + } + ], + "signature": "replaceDescription: string | null", + "source": "script-api", + "tags": [ + "replacedescription", + "order.replacedescription" + ], + "title": "Order.replaceDescription" + }, + { + "description": "Returns the order that this order replaced or null. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.", + "id": "script-api:dw/order/Order#replacedOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacedOrder", + "sections": [ + { + "body": "Returns the order that this order replaced or null. For example, if you\nhave three orders where Order1 was replaced by Order2 and Order2 was\nreplaced by Order3, calling this method on Order3 will return Order2.\nSimilarly, calling this method on Order1 will return null as Order1 was\nthe original order.", + "heading": "Description" + } + ], + "signature": "readonly replacedOrder: Order | null", + "source": "script-api", + "tags": [ + "replacedorder", + "order.replacedorder" + ], + "title": "Order.replacedOrder" + }, + { + "description": "Returns the order number that this order replaced or null if this order did not replace an order. For example, if you have three orders where Order1 was replaced by Order2 and Order2 was replaced by Order3, calling this method on Order3 will return the order number for Order2. Similarly, calling this method on Order1 will return null as Order1 was the original order.", + "id": "script-api:dw/order/Order#replacedOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacedOrderNo", + "sections": [ + { + "body": "Returns the order number that this order replaced or null if this order\ndid not replace an order. For example, if you have three orders\nwhere Order1 was replaced by Order2 and Order2 was replaced by Order3,\ncalling this method on Order3 will return the order number for\nOrder2. Similarly, calling this method on Order1 will return null as\nOrder1 was the original order.", + "heading": "Description" + } + ], + "signature": "readonly replacedOrderNo: string | null", + "source": "script-api", + "tags": [ + "replacedorderno", + "order.replacedorderno" + ], + "title": "Order.replacedOrderNo" + }, + { + "description": "Returns the order that replaced this order, or null.", + "id": "script-api:dw/order/Order#replacementOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacementOrder", + "sections": [ + { + "body": "Returns the order that replaced this order, or null.", + "heading": "Description" + } + ], + "signature": "readonly replacementOrder: Order | null", + "source": "script-api", + "tags": [ + "replacementorder", + "order.replacementorder" + ], + "title": "Order.replacementOrder" + }, + { + "description": "If this order was replaced by another order, returns the order number that replaced this order. Otherwise returns null.", + "id": "script-api:dw/order/Order#replacementOrderNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.replacementOrderNo", + "sections": [ + { + "body": "If this order was replaced by another order,\nreturns the order number that replaced this order. Otherwise\nreturns null.", + "heading": "Description" + } + ], + "signature": "readonly replacementOrderNo: string | null", + "source": "script-api", + "tags": [ + "replacementorderno", + "order.replacementorderno" + ], + "title": "Order.replacementOrderNo" + }, + { + "description": "Returns the collection of dw.order.ReturnCaseItems associated with this order.", + "id": "script-api:dw/order/Order#returnCaseItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnCaseItems", + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnCaseItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly returnCaseItems: FilteringCollection", + "source": "script-api", + "tags": [ + "returncaseitems", + "order.returncaseitems" + ], + "title": "Order.returnCaseItems" + }, + { + "description": "Returns the collection of dw.order.ReturnCases associated with this order.", + "id": "script-api:dw/order/Order#returnCases", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnCases", + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnCases associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly returnCases: FilteringCollection", + "source": "script-api", + "tags": [ + "returncases", + "order.returncases" + ], + "title": "Order.returnCases" + }, + { + "description": "Returns the collection of dw.order.ReturnItems associated with this order.", + "id": "script-api:dw/order/Order#returnItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returnItems", + "sections": [ + { + "body": "Returns the collection of dw.order.ReturnItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly returnItems: FilteringCollection", + "source": "script-api", + "tags": [ + "returnitems", + "order.returnitems" + ], + "title": "Order.returnItems" + }, + { + "description": "Returns the collection of dw.order.Returns associated with this order.", + "id": "script-api:dw/order/Order#returns", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.returns", + "sections": [ + { + "body": "Returns the collection of dw.order.Returns associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly returns: FilteringCollection", + "source": "script-api", + "tags": [ + "returns", + "order.returns" + ], + "title": "Order.returns" + }, + { + "description": "Sets the affiliate partner ID value.", + "id": "script-api:dw/order/Order#setAffiliatePartnerID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "affiliatePartnerID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setAffiliatePartnerID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the affiliate partner ID value.", + "heading": "Description" + } + ], + "signature": "setAffiliatePartnerID(affiliatePartnerID: string): void", + "source": "script-api", + "tags": [ + "setaffiliatepartnerid", + "order.setaffiliatepartnerid" + ], + "title": "Order.setAffiliatePartnerID" + }, + { + "description": "Sets the affiliate partner name value.", + "id": "script-api:dw/order/Order#setAffiliatePartnerName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "affiliatePartnerName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setAffiliatePartnerName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the affiliate partner name value.", + "heading": "Description" + } + ], + "signature": "setAffiliatePartnerName(affiliatePartnerName: string): void", + "source": "script-api", + "tags": [ + "setaffiliatepartnername", + "order.setaffiliatepartnername" + ], + "title": "Order.setAffiliatePartnerName" + }, + { + "description": "Sets the cancel code value.", + "id": "script-api:dw/order/Order#setCancelCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "cancelCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCancelCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the cancel code value.", + "heading": "Description" + } + ], + "signature": "setCancelCode(cancelCode: string): void", + "source": "script-api", + "tags": [ + "setcancelcode", + "order.setcancelcode" + ], + "title": "Order.setCancelCode" + }, + { + "description": "Sets the description as to why the order was cancelled.", + "id": "script-api:dw/order/Order#setCancelDescription", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "cancelDescription", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCancelDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the description as to why the order was cancelled.", + "heading": "Description" + } + ], + "signature": "setCancelDescription(cancelDescription: string): void", + "source": "script-api", + "tags": [ + "setcanceldescription", + "order.setcanceldescription" + ], + "title": "Order.setCancelDescription" + }, + { + "description": "Sets the confirmation status value.", + "id": "script-api:dw/order/Order#setConfirmationStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setConfirmationStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the confirmation status value.\n\nPossible values are CONFIRMATION_STATUS_NOTCONFIRMED or\nCONFIRMATION_STATUS_CONFIRMED.", + "heading": "Description" + } + ], + "signature": "setConfirmationStatus(status: number): void", + "source": "script-api", + "tags": [ + "setconfirmationstatus", + "order.setconfirmationstatus" + ], + "title": "Order.setConfirmationStatus" + }, + { + "description": "This method is used to associate the order object with the specified customer object.", + "id": "script-api:dw/order/Order#setCustomer", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomer", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "This method is used to associate the order object with the specified customer object.\n\nIf the customer object represents a registered customer, the order will be assigned\nto this registered customer and the order's customer number\n(dw.order.LineItemCtnr.getCustomerNo) will be updated.\n\nIf the customer object represents an unregistered (anonymous) customer, the\norder will become an anonymous order and the order's customer number\nwill be set to null.", + "heading": "Description" + } + ], + "signature": "setCustomer(customer: Customer): void", + "source": "script-api", + "tags": [ + "setcustomer", + "order.setcustomer" + ], + "throws": [ + { + "description": "If specified customer is null.", + "type": "NullArgumentException" + } + ], + "title": "Order.setCustomer" + }, + { + "description": "Sets the customer number associated with this order.", + "id": "script-api:dw/order/Order#setCustomerNo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customerNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomerNo", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer number associated with this order.\n\nNote it is recommended to use (dw.order.Order.setCustomer) instead of this method. This method\nonly sets the customer number and should be used with care as it does not re-link the order with a customer\nprofile object which can lead to an inconsistency! Ensure that the customer number used is not already taken\nby a different customer profile.", + "heading": "Description" + } + ], + "signature": "setCustomerNo(customerNo: string): void", + "source": "script-api", + "tags": [ + "setcustomerno", + "order.setcustomerno" + ], + "title": "Order.setCustomerNo" + }, + { + "description": "Sets the customer-specific reference information for the order.", + "id": "script-api:dw/order/Order#setCustomerOrderReference", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reference", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setCustomerOrderReference", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer-specific reference information for the order.", + "heading": "Description" + } + ], + "signature": "setCustomerOrderReference(reference: string): void", + "source": "script-api", + "tags": [ + "setcustomerorderreference", + "order.setcustomerorderreference" + ], + "title": "Order.setCustomerOrderReference" + }, + { + "description": "Sets the date after which an order can be exported.", + "id": "script-api:dw/order/Order#setExportAfter", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "date", + "type": "Date" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExportAfter", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the date after which an order can be exported.", + "heading": "Description" + } + ], + "signature": "setExportAfter(date: Date): void", + "source": "script-api", + "tags": [ + "setexportafter", + "order.setexportafter" + ], + "title": "Order.setExportAfter" + }, + { + "description": "Sets the export status of the order.", + "id": "script-api:dw/order/Order#setExportStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExportStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the export status of the order.\n\nPossible values are: EXPORT_STATUS_NOTEXPORTED, EXPORT_STATUS_EXPORTED,\nEXPORT_STATUS_READY, and EXPORT_STATUS_FAILED.\n\nSetting the status to EXPORT_STATUS_EXPORTED will also trigger the finalization of on order inventory\ntransactions for this order meaning that all inventory transactions with type on order will be moved into final\ninventory transactions. This is only relevant when On Order Inventory is turned on for the inventory list ordered\nproducts are in.\n\nIn case of an exception the current transaction is marked as rollback only.", + "heading": "Description" + } + ], + "signature": "setExportStatus(status: number): void", + "source": "script-api", + "tags": [ + "setexportstatus", + "order.setexportstatus" + ], + "title": "Order.setExportStatus" + }, + { + "description": "Sets the value of an external order number associated with this order", + "id": "script-api:dw/order/Order#setExternalOrderNo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "externalOrderNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderNo", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value of an external order number associated\nwith this order", + "heading": "Description" + } + ], + "signature": "setExternalOrderNo(externalOrderNo: string): void", + "source": "script-api", + "tags": [ + "setexternalorderno", + "order.setexternalorderno" + ], + "title": "Order.setExternalOrderNo" + }, + { + "description": "Sets the status of an external order associated with this order", + "id": "script-api:dw/order/Order#setExternalOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status of an external order associated\nwith this order", + "heading": "Description" + } + ], + "signature": "setExternalOrderStatus(status: string): void", + "source": "script-api", + "tags": [ + "setexternalorderstatus", + "order.setexternalorderstatus" + ], + "title": "Order.setExternalOrderStatus" + }, + { + "description": "Sets the text describing the external order.", + "id": "script-api:dw/order/Order#setExternalOrderText", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setExternalOrderText", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the text describing the external order.", + "heading": "Description" + } + ], + "signature": "setExternalOrderText(text: string): void", + "source": "script-api", + "tags": [ + "setexternalordertext", + "order.setexternalordertext" + ], + "title": "Order.setExternalOrderText" + }, + { + "description": "Sets the invoice number for this Order.", + "id": "script-api:dw/order/Order#setInvoiceNo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setInvoiceNo", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the invoice number for this Order.\n\nNotice that this value might be overwritten during order placement (e.g. with dw.order.OrderMgr.placeOrder).", + "heading": "Description" + } + ], + "signature": "setInvoiceNo(invoiceNumber: string): void", + "source": "script-api", + "tags": [ + "setinvoiceno", + "order.setinvoiceno" + ], + "title": "Order.setInvoiceNo" + }, + { + "deprecated": { + "message": "use setStatus instead" + }, + "description": "Sets the order status.", + "id": "script-api:dw/order/Order#setOrderStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setOrderStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the order status.\n\nUse this method when using Order Post Processing such as the creation of dw.order.ShippingOrder shipping\norders. The only supported values are ORDER_STATUS_OPEN, ORDER_STATUS_CANCELLED. Setting the\nstatus will adjust the order item status when applicable (item status not SHIPPED or CANCELLED). Note that the\norder status and the status of the items are directly related and dependent on one another.\n\nSee dw.order.OrderItem.setStatus for more information about possible status transitions.\n\nWarning: This method will not undo coupon redemptions upon cancellation of an order. Re-opening such an\norder later with dw.order.OrderMgr.undoCancelOrder or dw.order.OrderItem.setStatus\nwith ORDER_STATUS_OPEN will result in an additional application of the same coupon code which in turn\nmight fail.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "setOrderStatus(status: number): void", + "source": "script-api", + "tags": [ + "setorderstatus", + "order.setorderstatus" + ], + "throws": [ + { + "description": "on attempt to set an unsupported status value", + "type": "IllegalArgumentException" + } + ], + "title": "Order.setOrderStatus" + }, + { + "description": "Sets the order payment status.", + "id": "script-api:dw/order/Order#setPaymentStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setPaymentStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the order payment status.\n\nPossible values are PAYMENT_STATUS_NOTPAID, PAYMENT_STATUS_PARTPAID\nor PAYMENT_STATUS_PAID.", + "heading": "Description" + } + ], + "signature": "setPaymentStatus(status: number): void", + "source": "script-api", + "tags": [ + "setpaymentstatus", + "order.setpaymentstatus" + ], + "title": "Order.setPaymentStatus" + }, + { + "description": "Sets the value of the replace code.", + "id": "script-api:dw/order/Order#setReplaceCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "replaceCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setReplaceCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value of the replace code.", + "heading": "Description" + } + ], + "signature": "setReplaceCode(replaceCode: string): void", + "source": "script-api", + "tags": [ + "setreplacecode", + "order.setreplacecode" + ], + "title": "Order.setReplaceCode" + }, + { + "description": "Sets the value of the replace description.", + "id": "script-api:dw/order/Order#setReplaceDescription", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "replaceDescription", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setReplaceDescription", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value of the replace description.", + "heading": "Description" + } + ], + "signature": "setReplaceDescription(replaceDescription: string): void", + "source": "script-api", + "tags": [ + "setreplacedescription", + "order.setreplacedescription" + ], + "title": "Order.setReplaceDescription" + }, + { + "description": "Sets the order shipping status value.", + "id": "script-api:dw/order/Order#setShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setShippingStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the order shipping status value.\n\nPossible values are SHIPPING_STATUS_NOTSHIPPED,\nSHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.", + "heading": "Description" + } + ], + "signature": "setShippingStatus(status: number): void", + "source": "script-api", + "tags": [ + "setshippingstatus", + "order.setshippingstatus" + ], + "title": "Order.setShippingStatus" + }, + { + "description": "Sets the status of the order.", + "id": "script-api:dw/order/Order#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status of the order.\n\nPossible values are:\n\n- ORDER_STATUS_NEW\n- ORDER_STATUS_OPEN\n- ORDER_STATUS_COMPLETED\n- ORDER_STATUS_CANCELLED\n- ORDER_STATUS_REPLACED\n\nThis method does not support order statuses ORDER_STATUS_CREATED or ORDER_STATUS_FAILED. Please\nuse dw.order.OrderMgr.placeOrder or dw.order.OrderMgr.failOrder.\n\nSetting the order status to ORDER_STATUS_CANCELLED will have the same effect as calling\ndw.order.OrderMgr.cancelOrder. Setting a canceled order to ORDER_STATUS_NEW,\nORDER_STATUS_OPEN or ORDER_STATUS_COMPLETED will have the same effect as calling\ndw.order.OrderMgr.undoCancelOrder. It is recommended to use the methods in\ndw.order.OrderMgr directly to be able to do error processing with the return code.", + "heading": "Description" + } + ], + "signature": "setStatus(status: number): void", + "source": "script-api", + "tags": [ + "setstatus", + "order.setstatus" + ], + "throws": [ + { + "description": "on attempt to set status CREATED or FAILED, or status transition while cancel order or undo cancel order returns with an error code.", + "type": "IllegalArgumentException" + } + ], + "title": "Order.setStatus" + }, + { + "description": "Returns the collection of dw.order.ShippingOrderItems associated with this order.", + "id": "script-api:dw/order/Order#shippingOrderItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingOrderItems", + "sections": [ + { + "body": "Returns the collection of dw.order.ShippingOrderItems associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderItems: FilteringCollection", + "source": "script-api", + "tags": [ + "shippingorderitems", + "order.shippingorderitems" + ], + "title": "Order.shippingOrderItems" + }, + { + "description": "Returns the collection of dw.order.ShippingOrders associated with this order.", + "id": "script-api:dw/order/Order#shippingOrders", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingOrders", + "sections": [ + { + "body": "Returns the collection of dw.order.ShippingOrders associated with this order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrders: FilteringCollection", + "source": "script-api", + "tags": [ + "shippingorders", + "order.shippingorders" + ], + "title": "Order.shippingOrders" + }, + { + "description": "Returns the order shipping status.", + "id": "script-api:dw/order/Order#shippingStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.shippingStatus", + "sections": [ + { + "body": "Returns the order shipping status.\n\nPossible values are SHIPPING_STATUS_NOTSHIPPED,\nSHIPPING_STATUS_PARTSHIPPED or SHIPPING_STATUS_SHIPPED.", + "heading": "Description" + } + ], + "signature": "shippingStatus: EnumValue", + "source": "script-api", + "tags": [ + "shippingstatus", + "order.shippingstatus" + ], + "title": "Order.shippingStatus" + }, + { + "description": "Returns the source code stored with the order or `null` if no source code is attached to the order.", + "id": "script-api:dw/order/Order#sourceCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCode", + "sections": [ + { + "body": "Returns the source code stored with the order or `null` if no source code is attached to the order.", + "heading": "Description" + } + ], + "signature": "readonly sourceCode: string | null", + "source": "script-api", + "tags": [ + "sourcecode", + "order.sourcecode" + ], + "title": "Order.sourceCode" + }, + { + "description": "Returns the source code group attached to the order or `null` if no source code group is attached to the order.", + "id": "script-api:dw/order/Order#sourceCodeGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCodeGroup", + "sections": [ + { + "body": "Returns the source code group attached to the order or `null` if no source code group is attached to\nthe order.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeGroup: SourceCodeGroup | null", + "source": "script-api", + "tags": [ + "sourcecodegroup", + "order.sourcecodegroup" + ], + "title": "Order.sourceCodeGroup" + }, + { + "description": "Returns the source code group id stored with the order or `null` if no source code group is attached to the order.", + "id": "script-api:dw/order/Order#sourceCodeGroupID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.sourceCodeGroupID", + "sections": [ + { + "body": "Returns the source code group id stored with the order or `null` if no source code group is attached\nto the order.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeGroupID: string | null", + "source": "script-api", + "tags": [ + "sourcecodegroupid", + "order.sourcecodegroupid" + ], + "title": "Order.sourceCodeGroupID" + }, + { + "description": "Returns the status of the order.", + "id": "script-api:dw/order/Order#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.status", + "sections": [ + { + "body": "Returns the status of the order.\n\nPossible values are:\n\n- ORDER_STATUS_CREATED\n- ORDER_STATUS_NEW\n- ORDER_STATUS_OPEN\n- ORDER_STATUS_COMPLETED\n- ORDER_STATUS_CANCELLED\n- ORDER_STATUS_FAILED\n- ORDER_STATUS_REPLACED\n\nThe order status usually changes when a process action is initiated. Most status changes have an action which\nneeds to executed in order to end having the order in a specific order status. When an order is created with e.g.\ndw.order.OrderMgr.createOrder the order status will be ORDER_STATUS_CREATED. The usual\nflow is that payment authorization will be added to the order. Once the order is considered as valid (payed,\nfraud checked, ...) the order gets placed. This can be done by calling\ndw.order.OrderMgr.placeOrder. The result of placing an order will be status\nORDER_STATUS_OPEN (from a process standpoint ORDER_STATUS_NEW which has the same meaning).\nStatus ORDER_STATUS_REPLACED is related to functionality\ndw.order.BasketMgr.createBasketFromOrder. ORDER_STATUS_COMPLETED has no meaning by\ndefault but can be used by custom implementations but is a synonym for NEW/OPEN. Below you will find the most important status changes:\n\nStatus before Action Status after Business meaning\n- dw.order.OrderMgr.createOrder CREATED Order was created from a basket.\nCREATED dw.order.OrderMgr.placeOrder OPEN/NEW Order was considered as valid. Order can now be exported to 3rd party systems.\nCREATED dw.order.OrderMgr.failOrder FAILED Order was considered not valid. E.g. payment authorization was wrong or fraud check was not successful.\nOPEN/NEW dw.order.OrderMgr.cancelOrder CANCELLED Order was cancelled.\nCANCELLED dw.order.OrderMgr.undoCancelOrder OPEN/NEW Order was cancelled by mistake and this needs to be undone.\nFAILED dw.order.OrderMgr.undoFailOrder CREATED Order was failed by mistake and this needs to be undone.\n\nEvery status change will trigger a change in the order journal which is the base for GMV calculations.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "order.status" + ], + "title": "Order.status" + }, + { + "description": "Use this method to check if the Order was created with grouped taxation calculation.", + "id": "script-api:dw/order/Order#taxRoundedAtGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.taxRoundedAtGroup", + "sections": [ + { + "body": "Use this method to check if the Order was created with grouped taxation calculation.\n\nIf the tax is rounded on group level, the tax is applied to the summed-up tax basis for each tax rate.", + "heading": "Description" + } + ], + "signature": "readonly taxRoundedAtGroup: boolean", + "source": "script-api", + "tags": [ + "taxroundedatgroup", + "order.taxroundedatgroup" + ], + "title": "Order.taxRoundedAtGroup" + }, + { + "description": "Tracks an order change.", + "id": "script-api:dw/order/Order#trackOrderChange", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Order", + "qualifiedName": "dw.order.Order.trackOrderChange", + "returns": { + "type": "Note" + }, + "sections": [ + { + "body": "Tracks an order change.\n\nThis adds a history entry to the order. Focus of history entries are changes through business logic, both custom\nand internal logic. Tracked order changes are read-only and can be accessed in the Business Manager order\nhistory. The following attributes of the created dw.object.Note history entry are initialized:\n\n- dw.object.Note.getCreatedBy gets the current user assigned\n- dw.object.Note.getCreationDate gets the current date assigned\n\nThis feature is intended to track important changes in custom order flow which should become visible in Business\nManager's history tab. It is NOT intended as auditing feature for every change to an order. A warning will be\nproduced after 600 notes are added to an order. The warning can be reviewed in Business Manager's Quota Status\nscreen. Attempting to add a note to an order which already has 1000 notes results in an exception. Please bear in\nmind that internal changes, such as order status changes, also track changes. Avoid using this feature in\nrecurring jobs which may re-process orders multiple times as the limit needs to be considered each time a change\nis tracked. The same limit on the number of notes added also applies when using method\ndw.order.LineItemCtnr.addNote to add notes.", + "heading": "Description" + } + ], + "signature": "trackOrderChange(text: string): Note", + "source": "script-api", + "tags": [ + "trackorderchange", + "order.trackorderchange" + ], + "title": "Order.trackOrderChange" + }, + { + "description": "The Address class represents a customer's address.", + "id": "script-api:dw/order/OrderAddress", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderAddress", + "sections": [ + { + "body": "The Address class represents a customer's address.\n\nNote: this class allows access to sensitive personal and private information.\nPay attention to appropriate legal and regulatory requirements.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "orderaddress", + "dw.order.orderaddress", + "dw/order" + ], + "title": "OrderAddress" + }, + { + "description": "Returns the customer's first address.", + "id": "script-api:dw/order/OrderAddress#address1", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.address1", + "sections": [ + { + "body": "Returns the customer's first address.", + "heading": "Description" + } + ], + "signature": "address1: string", + "source": "script-api", + "tags": [ + "address1", + "orderaddress.address1" + ], + "title": "OrderAddress.address1" + }, + { + "description": "Returns the customer's second address.", + "id": "script-api:dw/order/OrderAddress#address2", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.address2", + "sections": [ + { + "body": "Returns the customer's second address.", + "heading": "Description" + } + ], + "signature": "address2: string", + "source": "script-api", + "tags": [ + "address2", + "orderaddress.address2" + ], + "title": "OrderAddress.address2" + }, + { + "description": "Returns the Customer's City.", + "id": "script-api:dw/order/OrderAddress#city", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.city", + "sections": [ + { + "body": "Returns the Customer's City.", + "heading": "Description" + } + ], + "signature": "city: string", + "source": "script-api", + "tags": [ + "city", + "orderaddress.city" + ], + "title": "OrderAddress.city" + }, + { + "description": "Returns the Customer's company name.", + "id": "script-api:dw/order/OrderAddress#companyName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.companyName", + "sections": [ + { + "body": "Returns the Customer's company name.", + "heading": "Description" + } + ], + "signature": "companyName: string", + "source": "script-api", + "tags": [ + "companyname", + "orderaddress.companyname" + ], + "title": "OrderAddress.companyName" + }, + { + "description": "Returns the customer's country code.", + "id": "script-api:dw/order/OrderAddress#countryCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.countryCode", + "sections": [ + { + "body": "Returns the customer's country code.", + "heading": "Description" + } + ], + "signature": "countryCode: EnumValue", + "source": "script-api", + "tags": [ + "countrycode", + "orderaddress.countrycode" + ], + "title": "OrderAddress.countryCode" + }, + { + "description": "Returns the Customer's first name.", + "id": "script-api:dw/order/OrderAddress#firstName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.firstName", + "sections": [ + { + "body": "Returns the Customer's first name.", + "heading": "Description" + } + ], + "signature": "firstName: string", + "source": "script-api", + "tags": [ + "firstname", + "orderaddress.firstname" + ], + "title": "OrderAddress.firstName" + }, + { + "description": "Returns a concatenation of the Customer's first, middle, and last names and it' suffix.", + "id": "script-api:dw/order/OrderAddress#fullName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.fullName", + "sections": [ + { + "body": "Returns a concatenation of the Customer's first, middle,\nand last names and it' suffix.", + "heading": "Description" + } + ], + "signature": "readonly fullName: string", + "source": "script-api", + "tags": [ + "fullname", + "orderaddress.fullname" + ], + "title": "OrderAddress.fullName" + }, + { + "description": "Returns the customer's first address.", + "id": "script-api:dw/order/OrderAddress#getAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getAddress1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's first address.", + "heading": "Description" + } + ], + "signature": "getAddress1(): string", + "source": "script-api", + "tags": [ + "getaddress1", + "orderaddress.getaddress1" + ], + "title": "OrderAddress.getAddress1" + }, + { + "description": "Returns the customer's second address.", + "id": "script-api:dw/order/OrderAddress#getAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getAddress2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's second address.", + "heading": "Description" + } + ], + "signature": "getAddress2(): string", + "source": "script-api", + "tags": [ + "getaddress2", + "orderaddress.getaddress2" + ], + "title": "OrderAddress.getAddress2" + }, + { + "description": "Returns the Customer's City.", + "id": "script-api:dw/order/OrderAddress#getCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Customer's City.", + "heading": "Description" + } + ], + "signature": "getCity(): string", + "source": "script-api", + "tags": [ + "getcity", + "orderaddress.getcity" + ], + "title": "OrderAddress.getCity" + }, + { + "description": "Returns the Customer's company name.", + "id": "script-api:dw/order/OrderAddress#getCompanyName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCompanyName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Customer's company name.", + "heading": "Description" + } + ], + "signature": "getCompanyName(): string", + "source": "script-api", + "tags": [ + "getcompanyname", + "orderaddress.getcompanyname" + ], + "title": "OrderAddress.getCompanyName" + }, + { + "description": "Returns the customer's country code.", + "id": "script-api:dw/order/OrderAddress#getCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getCountryCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the customer's country code.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): EnumValue", + "source": "script-api", + "tags": [ + "getcountrycode", + "orderaddress.getcountrycode" + ], + "title": "OrderAddress.getCountryCode" + }, + { + "description": "Returns the Customer's first name.", + "id": "script-api:dw/order/OrderAddress#getFirstName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getFirstName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Customer's first name.", + "heading": "Description" + } + ], + "signature": "getFirstName(): string", + "source": "script-api", + "tags": [ + "getfirstname", + "orderaddress.getfirstname" + ], + "title": "OrderAddress.getFirstName" + }, + { + "description": "Returns a concatenation of the Customer's first, middle, and last names and it' suffix.", + "id": "script-api:dw/order/OrderAddress#getFullName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getFullName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a concatenation of the Customer's first, middle,\nand last names and it' suffix.", + "heading": "Description" + } + ], + "signature": "getFullName(): string", + "source": "script-api", + "tags": [ + "getfullname", + "orderaddress.getfullname" + ], + "title": "OrderAddress.getFullName" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/order/OrderAddress#getJobTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getJobTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "getJobTitle(): string", + "source": "script-api", + "tags": [ + "getjobtitle", + "orderaddress.getjobtitle" + ], + "title": "OrderAddress.getJobTitle" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/order/OrderAddress#getLastName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getLastName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "getLastName(): string", + "source": "script-api", + "tags": [ + "getlastname", + "orderaddress.getlastname" + ], + "title": "OrderAddress.getLastName" + }, + { + "description": "Returns the customer's phone number.", + "id": "script-api:dw/order/OrderAddress#getPhone", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPhone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's phone number.", + "heading": "Description" + } + ], + "signature": "getPhone(): string", + "source": "script-api", + "tags": [ + "getphone", + "orderaddress.getphone" + ], + "title": "OrderAddress.getPhone" + }, + { + "description": "Returns the customer's post box.", + "id": "script-api:dw/order/OrderAddress#getPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPostBox", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's post box.", + "heading": "Description" + } + ], + "signature": "getPostBox(): string", + "source": "script-api", + "tags": [ + "getpostbox", + "orderaddress.getpostbox" + ], + "title": "OrderAddress.getPostBox" + }, + { + "description": "Returns the customer's postal code.", + "id": "script-api:dw/order/OrderAddress#getPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's postal code.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "orderaddress.getpostalcode" + ], + "title": "OrderAddress.getPostalCode" + }, + { + "description": "Returns the customer's salutation.", + "id": "script-api:dw/order/OrderAddress#getSalutation", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSalutation", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's salutation.", + "heading": "Description" + } + ], + "signature": "getSalutation(): string", + "source": "script-api", + "tags": [ + "getsalutation", + "orderaddress.getsalutation" + ], + "title": "OrderAddress.getSalutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/order/OrderAddress#getSecondName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSecondName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "getSecondName(): string", + "source": "script-api", + "tags": [ + "getsecondname", + "orderaddress.getsecondname" + ], + "title": "OrderAddress.getSecondName" + }, + { + "description": "Returns the customer's state.", + "id": "script-api:dw/order/OrderAddress#getStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getStateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's state.", + "heading": "Description" + } + ], + "signature": "getStateCode(): string", + "source": "script-api", + "tags": [ + "getstatecode", + "orderaddress.getstatecode" + ], + "title": "OrderAddress.getStateCode" + }, + { + "description": "Returns the customer's suffix.", + "id": "script-api:dw/order/OrderAddress#getSuffix", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSuffix", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's suffix.", + "heading": "Description" + } + ], + "signature": "getSuffix(): string", + "source": "script-api", + "tags": [ + "getsuffix", + "orderaddress.getsuffix" + ], + "title": "OrderAddress.getSuffix" + }, + { + "description": "Returns the customer's suite.", + "id": "script-api:dw/order/OrderAddress#getSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getSuite", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's suite.", + "heading": "Description" + } + ], + "signature": "getSuite(): string", + "source": "script-api", + "tags": [ + "getsuite", + "orderaddress.getsuite" + ], + "title": "OrderAddress.getSuite" + }, + { + "description": "Returns the customer's title.", + "id": "script-api:dw/order/OrderAddress#getTitle", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.getTitle", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the customer's title.", + "heading": "Description" + } + ], + "signature": "getTitle(): string", + "source": "script-api", + "tags": [ + "gettitle", + "orderaddress.gettitle" + ], + "title": "OrderAddress.getTitle" + }, + { + "description": "Returns true if the specified address is equivalent to this address. An equivalent address is an address whose core attributes contain the same values. The core attributes are:", + "id": "script-api:dw/order/OrderAddress#isEquivalentAddress", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "address", + "type": "any" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.isEquivalentAddress", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the specified address is equivalent to\nthis address. An equivalent address is an address whose\ncore attributes contain the same values. The core attributes\nare:\n\n- address1\n- address2\n- city\n- companyName\n- countryCode\n- firstName\n- lastName\n- postalCode\n- postBox\n- stateCode", + "heading": "Description" + } + ], + "signature": "isEquivalentAddress(address: any): boolean", + "source": "script-api", + "tags": [ + "isequivalentaddress", + "orderaddress.isequivalentaddress" + ], + "title": "OrderAddress.isEquivalentAddress" + }, + { + "description": "Returns the customer's job title.", + "id": "script-api:dw/order/OrderAddress#jobTitle", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.jobTitle", + "sections": [ + { + "body": "Returns the customer's job title.", + "heading": "Description" + } + ], + "signature": "jobTitle: string", + "source": "script-api", + "tags": [ + "jobtitle", + "orderaddress.jobtitle" + ], + "title": "OrderAddress.jobTitle" + }, + { + "description": "Returns the customer's last name.", + "id": "script-api:dw/order/OrderAddress#lastName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.lastName", + "sections": [ + { + "body": "Returns the customer's last name.", + "heading": "Description" + } + ], + "signature": "lastName: string", + "source": "script-api", + "tags": [ + "lastname", + "orderaddress.lastname" + ], + "title": "OrderAddress.lastName" + }, + { + "description": "Returns the customer's phone number.", + "id": "script-api:dw/order/OrderAddress#phone", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.phone", + "sections": [ + { + "body": "Returns the customer's phone number.", + "heading": "Description" + } + ], + "signature": "phone: string", + "source": "script-api", + "tags": [ + "phone", + "orderaddress.phone" + ], + "title": "OrderAddress.phone" + }, + { + "description": "Returns the customer's post box.", + "id": "script-api:dw/order/OrderAddress#postBox", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.postBox", + "sections": [ + { + "body": "Returns the customer's post box.", + "heading": "Description" + } + ], + "signature": "postBox: string", + "source": "script-api", + "tags": [ + "postbox", + "orderaddress.postbox" + ], + "title": "OrderAddress.postBox" + }, + { + "description": "Returns the customer's postal code.", + "id": "script-api:dw/order/OrderAddress#postalCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.postalCode", + "sections": [ + { + "body": "Returns the customer's postal code.", + "heading": "Description" + } + ], + "signature": "postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "orderaddress.postalcode" + ], + "title": "OrderAddress.postalCode" + }, + { + "description": "Returns the customer's salutation.", + "id": "script-api:dw/order/OrderAddress#salutation", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.salutation", + "sections": [ + { + "body": "Returns the customer's salutation.", + "heading": "Description" + } + ], + "signature": "salutation: string", + "source": "script-api", + "tags": [ + "salutation", + "orderaddress.salutation" + ], + "title": "OrderAddress.salutation" + }, + { + "description": "Returns the customer's second name.", + "id": "script-api:dw/order/OrderAddress#secondName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.secondName", + "sections": [ + { + "body": "Returns the customer's second name.", + "heading": "Description" + } + ], + "signature": "secondName: string", + "source": "script-api", + "tags": [ + "secondname", + "orderaddress.secondname" + ], + "title": "OrderAddress.secondName" + }, + { + "description": "Sets the customer's first address.", + "id": "script-api:dw/order/OrderAddress#setAddress1", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setAddress1", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's first address.", + "heading": "Description" + } + ], + "signature": "setAddress1(value: string): void", + "source": "script-api", + "tags": [ + "setaddress1", + "orderaddress.setaddress1" + ], + "title": "OrderAddress.setAddress1" + }, + { + "description": "Sets the customer's second address.", + "id": "script-api:dw/order/OrderAddress#setAddress2", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setAddress2", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's second address.", + "heading": "Description" + } + ], + "signature": "setAddress2(value: string): void", + "source": "script-api", + "tags": [ + "setaddress2", + "orderaddress.setaddress2" + ], + "title": "OrderAddress.setAddress2" + }, + { + "description": "Sets the Customer's City.", + "id": "script-api:dw/order/OrderAddress#setCity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "city", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Customer's City.", + "heading": "Description" + } + ], + "signature": "setCity(city: string): void", + "source": "script-api", + "tags": [ + "setcity", + "orderaddress.setcity" + ], + "title": "OrderAddress.setCity" + }, + { + "description": "Sets the Customer's company name.", + "id": "script-api:dw/order/OrderAddress#setCompanyName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "companyName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCompanyName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Customer's company name.", + "heading": "Description" + } + ], + "signature": "setCompanyName(companyName: string): void", + "source": "script-api", + "tags": [ + "setcompanyname", + "orderaddress.setcompanyname" + ], + "title": "OrderAddress.setCompanyName" + }, + { + "description": "Sets the Customer's country code.", + "id": "script-api:dw/order/OrderAddress#setCountryCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "countryCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setCountryCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Customer's country code.", + "heading": "Description" + } + ], + "signature": "setCountryCode(countryCode: string): void", + "source": "script-api", + "tags": [ + "setcountrycode", + "orderaddress.setcountrycode" + ], + "title": "OrderAddress.setCountryCode" + }, + { + "description": "Sets the Customer's first name.", + "id": "script-api:dw/order/OrderAddress#setFirstName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "firstName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setFirstName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Customer's first name.", + "heading": "Description" + } + ], + "signature": "setFirstName(firstName: string): void", + "source": "script-api", + "tags": [ + "setfirstname", + "orderaddress.setfirstname" + ], + "title": "OrderAddress.setFirstName" + }, + { + "description": "Sets the customer's job title.", + "id": "script-api:dw/order/OrderAddress#setJobTitle", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "jobTitle", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setJobTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's job title.", + "heading": "Description" + } + ], + "signature": "setJobTitle(jobTitle: string): void", + "source": "script-api", + "tags": [ + "setjobtitle", + "orderaddress.setjobtitle" + ], + "title": "OrderAddress.setJobTitle" + }, + { + "description": "Sets the customer's last name.", + "id": "script-api:dw/order/OrderAddress#setLastName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "lastName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setLastName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's last name.", + "heading": "Description" + } + ], + "signature": "setLastName(lastName: string): void", + "source": "script-api", + "tags": [ + "setlastname", + "orderaddress.setlastname" + ], + "title": "OrderAddress.setLastName" + }, + { + "description": "Sets the customer's phone number. The length is restricted to 256 characters.", + "id": "script-api:dw/order/OrderAddress#setPhone", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "phoneNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPhone", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's phone number. The length is restricted to 256 characters.", + "heading": "Description" + } + ], + "signature": "setPhone(phoneNumber: string): void", + "source": "script-api", + "tags": [ + "setphone", + "orderaddress.setphone" + ], + "title": "OrderAddress.setPhone" + }, + { + "description": "Sets the customer's post box.", + "id": "script-api:dw/order/OrderAddress#setPostBox", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "postBox", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPostBox", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's post box.", + "heading": "Description" + } + ], + "signature": "setPostBox(postBox: string): void", + "source": "script-api", + "tags": [ + "setpostbox", + "orderaddress.setpostbox" + ], + "title": "OrderAddress.setPostBox" + }, + { + "description": "Sets the customer's postal code.", + "id": "script-api:dw/order/OrderAddress#setPostalCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "postalCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setPostalCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's postal code.", + "heading": "Description" + } + ], + "signature": "setPostalCode(postalCode: string): void", + "source": "script-api", + "tags": [ + "setpostalcode", + "orderaddress.setpostalcode" + ], + "title": "OrderAddress.setPostalCode" + }, + { + "deprecated": { + "message": "Use setSalutation" + }, + "description": "Sets the customer's salutation.", + "id": "script-api:dw/order/OrderAddress#setSaluation", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSaluation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's salutation.", + "heading": "Description" + } + ], + "signature": "setSaluation(value: string): void", + "source": "script-api", + "tags": [ + "setsaluation", + "orderaddress.setsaluation" + ], + "title": "OrderAddress.setSaluation" + }, + { + "description": "Sets the customer's salutation.", + "id": "script-api:dw/order/OrderAddress#setSalutation", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSalutation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's salutation.", + "heading": "Description" + } + ], + "signature": "setSalutation(value: string): void", + "source": "script-api", + "tags": [ + "setsalutation", + "orderaddress.setsalutation" + ], + "title": "OrderAddress.setSalutation" + }, + { + "description": "Sets the customer's second name.", + "id": "script-api:dw/order/OrderAddress#setSecondName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "secondName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSecondName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's second name.", + "heading": "Description" + } + ], + "signature": "setSecondName(secondName: string): void", + "source": "script-api", + "tags": [ + "setsecondname", + "orderaddress.setsecondname" + ], + "title": "OrderAddress.setSecondName" + }, + { + "description": "Sets the customer's state.", + "id": "script-api:dw/order/OrderAddress#setStateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "state", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setStateCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's state.", + "heading": "Description" + } + ], + "signature": "setStateCode(state: string): void", + "source": "script-api", + "tags": [ + "setstatecode", + "orderaddress.setstatecode" + ], + "title": "OrderAddress.setStateCode" + }, + { + "description": "Sets the customer's suffix.", + "id": "script-api:dw/order/OrderAddress#setSuffix", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "suffix", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSuffix", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's suffix.", + "heading": "Description" + } + ], + "signature": "setSuffix(suffix: string): void", + "source": "script-api", + "tags": [ + "setsuffix", + "orderaddress.setsuffix" + ], + "title": "OrderAddress.setSuffix" + }, + { + "description": "Sets the customer's suite. The length is restricted to 256 characters.", + "id": "script-api:dw/order/OrderAddress#setSuite", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setSuite", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's suite. The length is restricted to 256 characters.", + "heading": "Description" + } + ], + "signature": "setSuite(value: string): void", + "source": "script-api", + "tags": [ + "setsuite", + "orderaddress.setsuite" + ], + "title": "OrderAddress.setSuite" + }, + { + "description": "Sets the customer's title.", + "id": "script-api:dw/order/OrderAddress#setTitle", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.setTitle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the customer's title.", + "heading": "Description" + } + ], + "signature": "setTitle(title: string): void", + "source": "script-api", + "tags": [ + "settitle", + "orderaddress.settitle" + ], + "title": "OrderAddress.setTitle" + }, + { + "description": "Returns the customer's state.", + "id": "script-api:dw/order/OrderAddress#stateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.stateCode", + "sections": [ + { + "body": "Returns the customer's state.", + "heading": "Description" + } + ], + "signature": "stateCode: string", + "source": "script-api", + "tags": [ + "statecode", + "orderaddress.statecode" + ], + "title": "OrderAddress.stateCode" + }, + { + "description": "Returns the customer's suffix.", + "id": "script-api:dw/order/OrderAddress#suffix", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.suffix", + "sections": [ + { + "body": "Returns the customer's suffix.", + "heading": "Description" + } + ], + "signature": "suffix: string", + "source": "script-api", + "tags": [ + "suffix", + "orderaddress.suffix" + ], + "title": "OrderAddress.suffix" + }, + { + "description": "Returns the customer's suite.", + "id": "script-api:dw/order/OrderAddress#suite", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.suite", + "sections": [ + { + "body": "Returns the customer's suite.", + "heading": "Description" + } + ], + "signature": "suite: string", + "source": "script-api", + "tags": [ + "suite", + "orderaddress.suite" + ], + "title": "OrderAddress.suite" + }, + { + "description": "Returns the customer's title.", + "id": "script-api:dw/order/OrderAddress#title", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderAddress", + "qualifiedName": "dw.order.OrderAddress.title", + "sections": [ + { + "body": "Returns the customer's title.", + "heading": "Description" + } + ], + "signature": "title: string", + "source": "script-api", + "tags": [ + "title", + "orderaddress.title" + ], + "title": "OrderAddress.title" + }, + { + "description": "Defines extensions to dw.order.ProductLineItems and dw.order.ShippingLineItems belonging to an dw.order.Order order.", + "id": "script-api:dw/order/OrderItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderItem", + "sections": [ + { + "body": "Defines extensions to dw.order.ProductLineItems and\ndw.order.ShippingLineItems belonging to an dw.order.Order order.\n\nThe order-item can be accessed using\ndw.order.ProductLineItem.getOrderItem or\ndw.order.ShippingLineItem.getOrderItem - these methods return null\nif the item is associated with a dw.order.Basket basket rather than\nan dw.order.Order order. Alternative access is available using\ndw.order.Order.getOrderItem by passing the\ndw.order.OrderItem.getItemID used to identify the\norder-item in for example export files. The\nassociated order-item can also be accessed from\ndw.order.InvoiceItem invoice-items,\ndw.order.ShippingOrderItem shipping-order-items,\ndw.order.ReturnItem return-items and dw.order.ReturnCaseItem return-case-items\nusing dw.order.AbstractItem.getOrderItem.\n\nThe order-item provides an item-level getStatus and\ngetType, methods for accessing and creating associated items,\nand methods used to allocateInventory for dw.order.ShippingOrder shipping-order creation.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "orderitem", + "dw.order.orderitem", + "dw/order" + ], + "title": "OrderItem" + }, + { + "description": "Constant for Order Item Status BACKORDER", + "id": "script-api:dw/order/OrderItem#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_BACKORDER", + "sections": [ + { + "body": "Constant for Order Item Status BACKORDER", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "status_backorder", + "orderitem.status_backorder" + ], + "title": "OrderItem.STATUS_BACKORDER" + }, + { + "description": "Constant for Order Item Status BACKORDER", + "id": "script-api:dw/order/OrderItem#STATUS_BACKORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_BACKORDER", + "sections": [ + { + "body": "Constant for Order Item Status BACKORDER", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_BACKORDER: string", + "source": "script-api", + "tags": [ + "status_backorder", + "orderitem.status_backorder" + ], + "title": "OrderItem.STATUS_BACKORDER" + }, + { + "description": "Constant for Order Item Status CANCELLED", + "id": "script-api:dw/order/OrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Order Item Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "orderitem.status_cancelled" + ], + "title": "OrderItem.STATUS_CANCELLED" + }, + { + "description": "Constant for Order Item Status CANCELLED", + "id": "script-api:dw/order/OrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Order Item Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "orderitem.status_cancelled" + ], + "title": "OrderItem.STATUS_CANCELLED" + }, + { + "description": "Constant for Order Item Status CONFIRMED", + "id": "script-api:dw/order/OrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Order Item Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "orderitem.status_confirmed" + ], + "title": "OrderItem.STATUS_CONFIRMED" + }, + { + "description": "Constant for Order Item Status CONFIRMED", + "id": "script-api:dw/order/OrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Order Item Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "orderitem.status_confirmed" + ], + "title": "OrderItem.STATUS_CONFIRMED" + }, + { + "description": "Constant for Order Item Status CREATED", + "id": "script-api:dw/order/OrderItem#STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CREATED", + "sections": [ + { + "body": "Constant for Order Item Status CREATED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CREATED: string", + "source": "script-api", + "tags": [ + "status_created", + "orderitem.status_created" + ], + "title": "OrderItem.STATUS_CREATED" + }, + { + "description": "Constant for Order Item Status CREATED", + "id": "script-api:dw/order/OrderItem#STATUS_CREATED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_CREATED", + "sections": [ + { + "body": "Constant for Order Item Status CREATED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CREATED: string", + "source": "script-api", + "tags": [ + "status_created", + "orderitem.status_created" + ], + "title": "OrderItem.STATUS_CREATED" + }, + { + "description": "Constant for Order Item Status NEW", + "id": "script-api:dw/order/OrderItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_NEW", + "sections": [ + { + "body": "Constant for Order Item Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "orderitem.status_new" + ], + "title": "OrderItem.STATUS_NEW" + }, + { + "description": "Constant for Order Item Status NEW", + "id": "script-api:dw/order/OrderItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_NEW", + "sections": [ + { + "body": "Constant for Order Item Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "orderitem.status_new" + ], + "title": "OrderItem.STATUS_NEW" + }, + { + "description": "Constant for Order Item Status OPEN", + "id": "script-api:dw/order/OrderItem#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_OPEN", + "sections": [ + { + "body": "Constant for Order Item Status OPEN", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_OPEN: string", + "source": "script-api", + "tags": [ + "status_open", + "orderitem.status_open" + ], + "title": "OrderItem.STATUS_OPEN" + }, + { + "description": "Constant for Order Item Status OPEN", + "id": "script-api:dw/order/OrderItem#STATUS_OPEN", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_OPEN", + "sections": [ + { + "body": "Constant for Order Item Status OPEN", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_OPEN: string", + "source": "script-api", + "tags": [ + "status_open", + "orderitem.status_open" + ], + "title": "OrderItem.STATUS_OPEN" + }, + { + "description": "Constant for Order Item Status SHIPPED", + "id": "script-api:dw/order/OrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Order Item Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "orderitem.status_shipped" + ], + "title": "OrderItem.STATUS_SHIPPED" + }, + { + "description": "Constant for Order Item Status SHIPPED", + "id": "script-api:dw/order/OrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Order Item Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "orderitem.status_shipped" + ], + "title": "OrderItem.STATUS_SHIPPED" + }, + { + "description": "Constant for Order Item Status WAREHOUSE", + "id": "script-api:dw/order/OrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Order Item Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "orderitem.status_warehouse" + ], + "title": "OrderItem.STATUS_WAREHOUSE" + }, + { + "description": "Constant for Order Item Status WAREHOUSE", + "id": "script-api:dw/order/OrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Order Item Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "orderitem.status_warehouse" + ], + "title": "OrderItem.STATUS_WAREHOUSE" + }, + { + "description": "Constant for Order Item Type PRODUCT", + "id": "script-api:dw/order/OrderItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_PRODUCT", + "sections": [ + { + "body": "Constant for Order Item Type PRODUCT", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRODUCT: string", + "source": "script-api", + "tags": [ + "type_product", + "orderitem.type_product" + ], + "title": "OrderItem.TYPE_PRODUCT" + }, + { + "description": "Constant for Order Item Type PRODUCT", + "id": "script-api:dw/order/OrderItem#TYPE_PRODUCT", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_PRODUCT", + "sections": [ + { + "body": "Constant for Order Item Type PRODUCT", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_PRODUCT: string", + "source": "script-api", + "tags": [ + "type_product", + "orderitem.type_product" + ], + "title": "OrderItem.TYPE_PRODUCT" + }, + { + "description": "Constant for Order Item Type SERVICE", + "id": "script-api:dw/order/OrderItem#TYPE_SERVICE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_SERVICE", + "sections": [ + { + "body": "Constant for Order Item Type SERVICE", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SERVICE: string", + "source": "script-api", + "tags": [ + "type_service", + "orderitem.type_service" + ], + "title": "OrderItem.TYPE_SERVICE" + }, + { + "description": "Constant for Order Item Type SERVICE", + "id": "script-api:dw/order/OrderItem#TYPE_SERVICE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.TYPE_SERVICE", + "sections": [ + { + "body": "Constant for Order Item Type SERVICE", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SERVICE: string", + "source": "script-api", + "tags": [ + "type_service", + "orderitem.type_service" + ], + "title": "OrderItem.TYPE_SERVICE" + }, + { + "description": "Please note that this method is disabled by default. Please contact support for enabling it.", + "id": "script-api:dw/order/OrderItem#allocateInventory", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "partialAllocation", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.allocateInventory", + "returns": { + "type": "Quantity | null" + }, + "sections": [ + { + "body": "Please note that this method is disabled by default. Please contact support for enabling it.\n\nAttempts to allocate inventory for the item and returns the quantity that could be allocated or `null`\nif no allocation was possible.\n\nAll dw.order.ProductLineItem.getOptionProductLineItems are allocated with\ntheir parent. Note that for items with option product line items no partial allocation is possible. That means\nthe partialAllocation parameter will in this case always be considered as `false`", + "heading": "Description" + } + ], + "signature": "allocateInventory(partialAllocation: boolean): Quantity | null", + "source": "script-api", + "tags": [ + "allocateinventory", + "orderitem.allocateinventory" + ], + "title": "OrderItem.allocateInventory" + }, + { + "description": "Sum of amounts appeased for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#appeasedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.appeasedAmount", + "sections": [ + { + "body": "Sum of amounts appeased for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "readonly appeasedAmount: Money", + "source": "script-api", + "tags": [ + "appeasedamount", + "orderitem.appeasedamount" + ], + "title": "OrderItem.appeasedAmount" + }, + { + "description": "Sum of amounts captured for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.capturedAmount", + "sections": [ + { + "body": "Sum of amounts captured for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "readonly capturedAmount: Money", + "source": "script-api", + "tags": [ + "capturedamount", + "orderitem.capturedamount" + ], + "title": "OrderItem.capturedAmount" + }, + { + "description": "Sum of amounts appeased for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#getAppeasedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getAppeasedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Sum of amounts appeased for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "getAppeasedAmount(): Money", + "source": "script-api", + "tags": [ + "getappeasedamount", + "orderitem.getappeasedamount" + ], + "title": "OrderItem.getAppeasedAmount" + }, + { + "description": "Sum of amounts captured for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getCapturedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Sum of amounts captured for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "getCapturedAmount(): Money", + "source": "script-api", + "tags": [ + "getcapturedamount", + "orderitem.getcapturedamount" + ], + "title": "OrderItem.getCapturedAmount" + }, + { + "description": "Returns all invoice items associated with this item, each dw.order.InvoiceItem will belong to a different dw.order.Invoice, which can also be accessed using Order.getInvoices or Order.getInvoice.", + "id": "script-api:dw/order/OrderItem#getInvoiceItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getInvoiceItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all invoice items associated with this item, each\ndw.order.InvoiceItem will belong to a different\ndw.order.Invoice, which can also be accessed using\nOrder.getInvoices or Order.getInvoice.", + "heading": "Description" + } + ], + "signature": "getInvoiceItems(): Collection", + "source": "script-api", + "tags": [ + "getinvoiceitems", + "orderitem.getinvoiceitems" + ], + "title": "OrderItem.getInvoiceItems" + }, + { + "description": "The itemID used to identify the OrderItem. Note this is not a UUID, it is created internally when the OrderItem instance is created, and is typically used within export files to identify the item.", + "id": "script-api:dw/order/OrderItem#getItemID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getItemID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The itemID used to identify the OrderItem. Note this is\nnot a UUID, it is created internally when the OrderItem\ninstance is created, and is typically used within export files to\nidentify the item.", + "heading": "Description" + } + ], + "signature": "getItemID(): string", + "source": "script-api", + "tags": [ + "getitemid", + "orderitem.getitemid" + ], + "title": "OrderItem.getItemID" + }, + { + "description": "Returns the line item which is being extended by this instance.", + "id": "script-api:dw/order/OrderItem#getLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getLineItem", + "returns": { + "type": "LineItem" + }, + "sections": [ + { + "body": "Returns the line item which is being extended by this instance.", + "heading": "Description" + } + ], + "signature": "getLineItem(): LineItem", + "source": "script-api", + "tags": [ + "getlineitem", + "orderitem.getlineitem" + ], + "title": "OrderItem.getLineItem" + }, + { + "description": "Sum of amounts refunded for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getRefundedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Sum of amounts refunded for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "getRefundedAmount(): Money", + "source": "script-api", + "tags": [ + "getrefundedamount", + "orderitem.getrefundedamount" + ], + "title": "OrderItem.getRefundedAmount" + }, + { + "description": "Returns all return case items associated with this item, each dw.order.ReturnCaseItem will belong to a different dw.order.ReturnCase, which can also be accessed using Order.getReturnCases or Order.getReturnCase.", + "id": "script-api:dw/order/OrderItem#getReturnCaseItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getReturnCaseItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all return case items associated with this item,\neach dw.order.ReturnCaseItem will belong to a different\ndw.order.ReturnCase, which can also be accessed using\nOrder.getReturnCases or Order.getReturnCase.", + "heading": "Description" + } + ], + "signature": "getReturnCaseItems(): Collection", + "source": "script-api", + "tags": [ + "getreturncaseitems", + "orderitem.getreturncaseitems" + ], + "title": "OrderItem.getReturnCaseItems" + }, + { + "description": "The quantity returned, dynamically sum of quantities held by associated ReturnItems.", + "id": "script-api:dw/order/OrderItem#getReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getReturnedQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "The quantity returned, dynamically sum of quantities held by associated\nReturnItems.", + "heading": "Description" + } + ], + "signature": "getReturnedQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getreturnedquantity", + "orderitem.getreturnedquantity" + ], + "title": "OrderItem.getReturnedQuantity" + }, + { + "deprecated": {}, + "description": "The last added non-cancelled shipping order item if one exists, otherwise `null`.", + "id": "script-api:dw/order/OrderItem#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItem", + "returns": { + "type": "ShippingOrderItem | null" + }, + "sections": [ + { + "body": "The last added non-cancelled shipping order item if one exists, otherwise `null`.\n\nMultiple shipping order items that are not in status ShippingOrderItem.STATUS_CANCELLED\ncan exist for one OrderItem, for example if the OrderItem has been split for shipping purposes.\nThe method returns `null` if no non-cancelled shipping order item exists.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItem(): ShippingOrderItem | null", + "source": "script-api", + "tags": [ + "getshippingorderitem", + "orderitem.getshippingorderitem" + ], + "title": "OrderItem.getShippingOrderItem" + }, + { + "description": "Returns a collection of the ShippingOrderItems created for this item. ShippingOrder items represents the whole or part of this item which could be delivered, and belong to a shipping order. Note that the cancelled shipping order items are returned too. This method is equivalent to getShippingOrderItems called with parameter `true`.", + "id": "script-api:dw/order/OrderItem#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of the ShippingOrderItems created for this item.\nShippingOrder items represents the whole or part of this item which could\nbe delivered, and belong to a shipping order.\nNote that the cancelled shipping order items are returned too.\nThis method is equivalent to getShippingOrderItems\ncalled with parameter `true`.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItems(): Collection", + "source": "script-api", + "tags": [ + "getshippingorderitems", + "orderitem.getshippingorderitems" + ], + "title": "OrderItem.getShippingOrderItems" + }, + { + "description": "Returns a collection of the ShippingOrderItems created for this item. ShippingOrder items represent the whole or part of this item which could be delivered, and belong to a shipping order. Depending on the `includeCancelled` parameter the cancelled shipping order items will be returned or not.", + "id": "script-api:dw/order/OrderItem#getShippingOrderItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "includeCancelled", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getShippingOrderItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of the ShippingOrderItems created for this item.\nShippingOrder items represent the whole or part of this item which could\nbe delivered, and belong to a shipping order.\nDepending on the `includeCancelled` parameter the cancelled shipping order\nitems will be returned or not.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItems(includeCancelled: boolean): Collection", + "source": "script-api", + "tags": [ + "getshippingorderitems", + "orderitem.getshippingorderitems" + ], + "title": "OrderItem.getShippingOrderItems" + }, + { + "description": "Returns a collection of all split OrderItems associated with this item. Inverse relation to getSplitSourceItem.", + "id": "script-api:dw/order/OrderItem#getSplitItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getSplitItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all split OrderItems associated with this item. Inverse relation to getSplitSourceItem.\n\nSplit order items are created when\n\n- creating a ShippingOrderItem for a ShippingOrder, see ShippingOrder.createShippingOrderItem\n- splitting an existing ShippingOrderItem, see ShippingOrderItem.split\n\nwith a specified quantity less than the existing quantity of the associated ProductLineItem. In this case the associated ProductLineItem\nis split by creating a new ProductLineItem and associating a new ShippingOrderItem with this item. The new ShippingOrderItem\nreceives the specified quantity and the quantity of the item is set to the remaining quantity. All split items are associated to their originating item via\nthe \"split source item\" association.", + "heading": "Description" + } + ], + "signature": "getSplitItems(): Collection", + "source": "script-api", + "tags": [ + "getsplititems", + "orderitem.getsplititems" + ], + "title": "OrderItem.getSplitItems" + }, + { + "description": "Returns the split source item associated with this item, if existing. Inverse relation to getSplitItems.", + "id": "script-api:dw/order/OrderItem#getSplitSourceItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getSplitSourceItem", + "returns": { + "type": "OrderItem | null" + }, + "sections": [ + { + "body": "Returns the split source item associated with this item, if existing. Inverse relation to getSplitItems.\n\nA split source item is associated after the successful creation of a split item with a quantity less than the existing quantity of the item to split.\nFor details see getSplitItems.", + "heading": "Description" + } + ], + "signature": "getSplitSourceItem(): OrderItem | null", + "source": "script-api", + "tags": [ + "getsplitsourceitem", + "orderitem.getsplitsourceitem" + ], + "title": "OrderItem.getSplitSourceItem" + }, + { + "description": "Gets the order item status.", + "id": "script-api:dw/order/OrderItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the order item status.\n\nThe possible values are:\n\n- STATUS_NEW\n- STATUS_OPEN\n- STATUS_BACKORDER\n- STATUS_CONFIRMED\n- STATUS_WAREHOUSE\n- STATUS_SHIPPED\n- STATUS_CANCELLED", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "orderitem.getstatus" + ], + "title": "OrderItem.getStatus" + }, + { + "description": "Returns the type of line item with which this instance is associated, one of", + "id": "script-api:dw/order/OrderItem#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.getType", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the type of line item with which this instance is associated, one\nof\n\n- SERVICE (method dw.order.OrderItem.getLineItem returns a\ndw.order.ShippingLineItem\n- PRODUCT (method dw.order.OrderItem.getLineItem returns a\ndw.order.ProductLineItem", + "heading": "Description" + } + ], + "signature": "getType(): EnumValue", + "source": "script-api", + "tags": [ + "gettype", + "orderitem.gettype" + ], + "title": "OrderItem.getType" + }, + { + "description": "Returns all invoice items associated with this item, each dw.order.InvoiceItem will belong to a different dw.order.Invoice, which can also be accessed using Order.getInvoices or Order.getInvoice.", + "id": "script-api:dw/order/OrderItem#invoiceItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.invoiceItems", + "sections": [ + { + "body": "Returns all invoice items associated with this item, each\ndw.order.InvoiceItem will belong to a different\ndw.order.Invoice, which can also be accessed using\nOrder.getInvoices or Order.getInvoice.", + "heading": "Description" + } + ], + "signature": "readonly invoiceItems: Collection", + "source": "script-api", + "tags": [ + "invoiceitems", + "orderitem.invoiceitems" + ], + "title": "OrderItem.invoiceItems" + }, + { + "description": "The itemID used to identify the OrderItem. Note this is not a UUID, it is created internally when the OrderItem instance is created, and is typically used within export files to identify the item.", + "id": "script-api:dw/order/OrderItem#itemID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.itemID", + "sections": [ + { + "body": "The itemID used to identify the OrderItem. Note this is\nnot a UUID, it is created internally when the OrderItem\ninstance is created, and is typically used within export files to\nidentify the item.", + "heading": "Description" + } + ], + "signature": "readonly itemID: string", + "source": "script-api", + "tags": [ + "itemid", + "orderitem.itemid" + ], + "title": "OrderItem.itemID" + }, + { + "description": "Returns the line item which is being extended by this instance.", + "id": "script-api:dw/order/OrderItem#lineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.lineItem", + "sections": [ + { + "body": "Returns the line item which is being extended by this instance.", + "heading": "Description" + } + ], + "signature": "readonly lineItem: LineItem", + "source": "script-api", + "tags": [ + "lineitem", + "orderitem.lineitem" + ], + "title": "OrderItem.lineItem" + }, + { + "description": "Sum of amounts refunded for this item, calculated by iterating over invoice items associated with the item.", + "id": "script-api:dw/order/OrderItem#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.refundedAmount", + "sections": [ + { + "body": "Sum of amounts refunded for this item, calculated by iterating over\ninvoice items associated with the item.", + "heading": "Description" + } + ], + "signature": "readonly refundedAmount: Money", + "source": "script-api", + "tags": [ + "refundedamount", + "orderitem.refundedamount" + ], + "title": "OrderItem.refundedAmount" + }, + { + "description": "Returns all return case items associated with this item, each dw.order.ReturnCaseItem will belong to a different dw.order.ReturnCase, which can also be accessed using Order.getReturnCases or Order.getReturnCase.", + "id": "script-api:dw/order/OrderItem#returnCaseItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.returnCaseItems", + "sections": [ + { + "body": "Returns all return case items associated with this item,\neach dw.order.ReturnCaseItem will belong to a different\ndw.order.ReturnCase, which can also be accessed using\nOrder.getReturnCases or Order.getReturnCase.", + "heading": "Description" + } + ], + "signature": "readonly returnCaseItems: Collection", + "source": "script-api", + "tags": [ + "returncaseitems", + "orderitem.returncaseitems" + ], + "title": "OrderItem.returnCaseItems" + }, + { + "description": "The quantity returned, dynamically sum of quantities held by associated ReturnItems.", + "id": "script-api:dw/order/OrderItem#returnedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.returnedQuantity", + "sections": [ + { + "body": "The quantity returned, dynamically sum of quantities held by associated\nReturnItems.", + "heading": "Description" + } + ], + "signature": "readonly returnedQuantity: Quantity", + "source": "script-api", + "tags": [ + "returnedquantity", + "orderitem.returnedquantity" + ], + "title": "OrderItem.returnedQuantity" + }, + { + "description": "Set the status of the order item, use one of the values documented in dw.order.OrderItem.getStatus.", + "id": "script-api:dw/order/OrderItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the status of the order item, use one of the values documented in dw.order.OrderItem.getStatus.\n\nIf the order item has a related shipping order item (see getShippingOrderItem) the status of the\nshipping order item will be adjusted to the same status. Setting the status of an order item might also change\nthe status of the related order. The following rules apply in top-down order:\n\n- all items STATUS_CANCELLED - order status is dw.order.Order.ORDER_STATUS_CANCELLED\n- at least one item in status STATUS_SHIPPED and all other items are STATUS_CANCELLED order\nstatus is dw.order.Order.ORDER_STATUS_COMPLETED\n- at least one item in status STATUS_CREATED, STATUS_OPEN, STATUS_NEW\n, STATUS_BACKORDER - order status is dw.order.Order.ORDER_STATUS_OPEN, order confirmation status\nis dw.order.Order.CONFIRMATION_STATUS_NOTCONFIRMED\n- other combinations will have only items in STATUS_CONFIRMED, STATUS_CANCELLED and\nSTATUS_SHIPPED - order status is dw.order.Order.ORDER_STATUS_OPEN, order confirmation status is\ndw.order.Order.CONFIRMATION_STATUS_CONFIRMED", + "heading": "Description" + } + ], + "signature": "setStatus(status: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "orderitem.setstatus" + ], + "title": "OrderItem.setStatus" + }, + { + "deprecated": {}, + "description": "The last added non-cancelled shipping order item if one exists, otherwise `null`.", + "id": "script-api:dw/order/OrderItem#shippingOrderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.shippingOrderItem", + "sections": [ + { + "body": "The last added non-cancelled shipping order item if one exists, otherwise `null`.\n\nMultiple shipping order items that are not in status ShippingOrderItem.STATUS_CANCELLED\ncan exist for one OrderItem, for example if the OrderItem has been split for shipping purposes.\nThe method returns `null` if no non-cancelled shipping order item exists.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderItem: ShippingOrderItem | null", + "source": "script-api", + "tags": [ + "shippingorderitem", + "orderitem.shippingorderitem" + ], + "title": "OrderItem.shippingOrderItem" + }, + { + "description": "Returns a collection of the ShippingOrderItems created for this item. ShippingOrder items represents the whole or part of this item which could be delivered, and belong to a shipping order. Note that the cancelled shipping order items are returned too. This method is equivalent to getShippingOrderItems called with parameter `true`.", + "id": "script-api:dw/order/OrderItem#shippingOrderItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.shippingOrderItems", + "sections": [ + { + "body": "Returns a collection of the ShippingOrderItems created for this item.\nShippingOrder items represents the whole or part of this item which could\nbe delivered, and belong to a shipping order.\nNote that the cancelled shipping order items are returned too.\nThis method is equivalent to getShippingOrderItems\ncalled with parameter `true`.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderItems: Collection", + "source": "script-api", + "tags": [ + "shippingorderitems", + "orderitem.shippingorderitems" + ], + "title": "OrderItem.shippingOrderItems" + }, + { + "description": "Returns a collection of all split OrderItems associated with this item. Inverse relation to getSplitSourceItem.", + "id": "script-api:dw/order/OrderItem#splitItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.splitItems", + "sections": [ + { + "body": "Returns a collection of all split OrderItems associated with this item. Inverse relation to getSplitSourceItem.\n\nSplit order items are created when\n\n- creating a ShippingOrderItem for a ShippingOrder, see ShippingOrder.createShippingOrderItem\n- splitting an existing ShippingOrderItem, see ShippingOrderItem.split\n\nwith a specified quantity less than the existing quantity of the associated ProductLineItem. In this case the associated ProductLineItem\nis split by creating a new ProductLineItem and associating a new ShippingOrderItem with this item. The new ShippingOrderItem\nreceives the specified quantity and the quantity of the item is set to the remaining quantity. All split items are associated to their originating item via\nthe \"split source item\" association.", + "heading": "Description" + } + ], + "signature": "readonly splitItems: Collection", + "source": "script-api", + "tags": [ + "splititems", + "orderitem.splititems" + ], + "title": "OrderItem.splitItems" + }, + { + "description": "Returns the split source item associated with this item, if existing. Inverse relation to getSplitItems.", + "id": "script-api:dw/order/OrderItem#splitSourceItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.splitSourceItem", + "sections": [ + { + "body": "Returns the split source item associated with this item, if existing. Inverse relation to getSplitItems.\n\nA split source item is associated after the successful creation of a split item with a quantity less than the existing quantity of the item to split.\nFor details see getSplitItems.", + "heading": "Description" + } + ], + "signature": "readonly splitSourceItem: OrderItem | null", + "source": "script-api", + "tags": [ + "splitsourceitem", + "orderitem.splitsourceitem" + ], + "title": "OrderItem.splitSourceItem" + }, + { + "description": "Gets the order item status.", + "id": "script-api:dw/order/OrderItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.status", + "sections": [ + { + "body": "Gets the order item status.\n\nThe possible values are:\n\n- STATUS_NEW\n- STATUS_OPEN\n- STATUS_BACKORDER\n- STATUS_CONFIRMED\n- STATUS_WAREHOUSE\n- STATUS_SHIPPED\n- STATUS_CANCELLED", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "orderitem.status" + ], + "title": "OrderItem.status" + }, + { + "description": "Returns the type of line item with which this instance is associated, one of", + "id": "script-api:dw/order/OrderItem#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderItem", + "qualifiedName": "dw.order.OrderItem.type", + "sections": [ + { + "body": "Returns the type of line item with which this instance is associated, one\nof\n\n- SERVICE (method dw.order.OrderItem.getLineItem returns a\ndw.order.ShippingLineItem\n- PRODUCT (method dw.order.OrderItem.getLineItem returns a\ndw.order.ProductLineItem", + "heading": "Description" + } + ], + "signature": "readonly type: EnumValue", + "source": "script-api", + "tags": [ + "type", + "orderitem.type" + ], + "title": "OrderItem.type" + }, + { + "description": "Provides static helper methods for managing orders.", + "id": "script-api:dw/order/OrderMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderMgr", + "sections": [ + { + "body": "Provides static helper methods for managing orders.\n\nPipelet GetOrder and methods provided to access orders such as getOrder and\nsearchOrders can be limited by the site preference 'Limit Storefront Order\nAccess'. An insecure order access occurs in a storefront session when all of the following are true:\n\n- The current storefront session isn’t the session in which the order was created.\n- The session customer doesn’t match the order customer.\n- The order status isn’t CREATED.\n\nWhen an order is accessed in an insecure manner:\n\n- If the preference is ACTIVE, the action is disallowed and a SecurityException with a message\nbeginning 'Unauthorized access to order' is thrown.\n- If the preference is NOT ACTIVE, a SecurityException with a message beginning 'Unauthorized\naccess to order' is logged as an error.\n\nIn addition, the storefront should ensure the shopper is properly authenticated and authorized to read\nor modify the content of an order object. For more information, see Access Control.\n\nDon’t use dw.order.OrderMgr.searchOrder methods or processOrders\nimmediately after creating or updating an order. The order search index updates asynchronously, typically within seconds but occasionally longer depending on search service load, so it\nmight not include very recent changes. Instead, do one of the following:\n\n- In the same request, pass the dw.order.Order object reference to the followup logic.\n- For storefront use cases, especially when passing the order reference to a third party, use the\norder token for security by using getOrder.\n\nWhen implementing order history functionality, don't use the search or query methods in this class. Instead, use\ndw.customer.OrderHistory.getOrders.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "ordermgr", + "dw.order.ordermgr", + "dw/order" + ], + "title": "OrderMgr" + }, + { + "description": "This method cancels an order. Only orders in status OPEN, NEW, or COMPLETED can be cancelled.", + "id": "script-api:dw/order/OrderMgr#cancelOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.cancelOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method cancels an order. Only orders in status OPEN, NEW, or COMPLETED can be cancelled.\n\nSetting of cancel code and cancel description can be done by calling\n`Order.setCancelCode` and `Order.setCancelDescription`. *\nIf the order contains product or gift certificate line items associated with product list items, records of the\npurchase of the product list items will be removed.\n\nInventory transactions and coupon redemptions associated with the order will be rolled back.\n\nIt is important to consider that this method will cancel orders with gift certificate line items.\n\nIf an order has any active post-processing objects (e.g. shipping orders, returns, appeasements), then it cannot\nbe cancelled directly. Its status is set automatically, based on the statuses of its post-processing objects. To\ncancel such an order, you must cancel all related post-processing objects.\n\nIf your B2C Commerce instance is integrated with Order Management, then you manage order statuses in Order\nManagement. Use Order Management API endpoints.", + "heading": "Description" + } + ], + "signature": "static cancelOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "cancelorder", + "ordermgr.cancelorder" + ], + "title": "OrderMgr.cancelOrder" + }, + { + "description": "This method cancels an order. Only orders in status OPEN, NEW, or COMPLETED can be cancelled.", + "id": "script-api:dw/order/OrderMgr#cancelOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.cancelOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method cancels an order. Only orders in status OPEN, NEW, or COMPLETED can be cancelled.\n\nSetting of cancel code and cancel description can be done by calling\n`Order.setCancelCode` and `Order.setCancelDescription`. *\nIf the order contains product or gift certificate line items associated with product list items, records of the\npurchase of the product list items will be removed.\n\nInventory transactions and coupon redemptions associated with the order will be rolled back.\n\nIt is important to consider that this method will cancel orders with gift certificate line items.\n\nIf an order has any active post-processing objects (e.g. shipping orders, returns, appeasements), then it cannot\nbe cancelled directly. Its status is set automatically, based on the statuses of its post-processing objects. To\ncancel such an order, you must cancel all related post-processing objects.\n\nIf your B2C Commerce instance is integrated with Order Management, then you manage order statuses in Order\nManagement. Use Order Management API endpoints.", + "heading": "Description" + } + ], + "signature": "static cancelOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "cancelorder", + "ordermgr.cancelorder" + ], + "title": "OrderMgr.cancelOrder" + }, + { + "description": "This method creates an order based on a basket. If successful, the new order will be in status dw.order.Order.ORDER_STATUS_CREATED. The basket will be removed from the session and marked for removal.", + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "This method creates an order based on a basket. If successful, the new order will be in status\ndw.order.Order.ORDER_STATUS_CREATED. The basket will be removed from the session and marked for removal.\n\nThis method throws an APIException with type 'CreateOrderException' if any of the following conditions are\nencountered:\n\n- any of the totals (net, gross, tax) of the basket is N/A\n- any of the product items is not available (this takes previously reserved items into account)\n- any campaign-based coupon in the basket is invalid (see dw.order.CouponLineItem.isValid\n- the basket represents an order being edited, but the order has already been replaced by another order\n- the basket represents an order being edited, but the customer associated with the original order is not the\nsame as the current customer\n\nThe method removes all empty shipments from the basket before creating the order. A shipment is said to be empty\nif all of the following are true:\n\n- it contains no product or gift certificate line items\n- all total prices (net, gross, tax) are 0.0\n\nThis method decrements inventory for all products contained in the order. A previous call to\ndw.order.Basket.reserveInventory is unnecessary and discouraged within the same request. The method\ntakes any items with reserved inventory into account, allowing an early reservation of items, e.g. at the\nbeginning of the checkout process. As described above, an APIException is thrown if any item is not available.\n\nIf the basket contains product or gift certificate line items associated with product list items, the method\nupdates the purchased quantity of the product list items; see\ndw.customer.ProductListItem.getPurchasedQuantity.\n\nThe system generates an order number via hook dw.order.hooks.OrderHooks.createOrderNo. If no hook is\nregistered for the endpoint, the number is generated by calling createOrderSequenceNo. The format of\nthe number is based on the Order Number scheme defined in the Sequence Numbers preference configured for the site\nor organization. The number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher\nor lower than a previously created number. As a result, sorting orders by order number is not guaranteed to sort\nthem in their order of creation.\n\nThis method must not be used with the ReserveInventoryForOrder pipelet or\ndw.order.Basket.reserveInventory in the same request.\n\nWhen an order is created, search results don't include it until the next asynchronous update of the order search\nindex. See dw.order.OrderMgr.\n\nPlease note that this method might result in an order with a different customer ID than the originating\nregistered customer attached to the session. This happens if a registered customer logs in with the \"RememberMe\"\nflag set to `true`, but is later logged out (either explicitly, or automatically via session\nexpiration) before calling this method. This is due to the internal order creation logic, which creates a new\nguest customer and attaches it to the order in such cases. To avoid this situation, have your custom code verify\nthat the customer is authenticated before it calls this method.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createOrder(basket: Basket): Order", + "source": "script-api", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "throws": [ + { + "description": "indicates the order could not be created", + "type": "dw.order.CreateOrderException" + } + ], + "title": "OrderMgr.createOrder" + }, + { + "description": "This method functions the same as createOrder, but allows the optional specification of an `orderNo`. The `orderNo` must be unique within the context of a site.", + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "orderNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "This method functions the same as createOrder, but allows the optional specification of\nan `orderNo`. The `orderNo` must be unique within the context of a site.\n\nIf the `orderNo` is not specified, the behavior is the same as that of\ncreateOrder. In that case, the system generates an order number via hook\ndw.order.hooks.OrderHooks.createOrderNo. If no hook is registered for the endpoint, the number is\ngenerated by calling createOrderSequenceNo. The format of the number is based on the Order Number\nscheme defined in the Sequence Numbers preference configured for the site or organization. The number is\nguaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously\ncreated number. As a result, sorting orders by order number is not guaranteed to sort them in their order of\ncreation.\n\nThis method must not be used with the ReserveInventoryForOrder pipelet or\ndw.order.Basket.reserveInventory in the same request.\n\nWhen an order is created, search results don't include it until the next asynchronous update of the order search\nindex. See dw.order.OrderMgr.\n\nPlease note that this method might result in an order with a different customer ID than the originating\nregistered customer attached to the session. This happens if a registered customer logs in with the \"RememberMe\"\nflag set to `true`, but is later logged out (either explicitly, or automatically via session\nexpiration) before calling this method. This is due to the internal order creation logic, which creates a new\nguest customer and attaches it to the order in such cases. To avoid this situation, have your custom code verify\nthat the customer is authenticated before it calls this method.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createOrder(basket: Basket, orderNo: string): Order", + "source": "script-api", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "throws": [ + { + "description": "indicates the order could not be created", + "type": "dw.order.CreateOrderException" + } + ], + "title": "OrderMgr.createOrder" + }, + { + "description": "This method creates an order based on a basket. If successful, the new order will be in status dw.order.Order.ORDER_STATUS_CREATED. The basket will be removed from the session and marked for removal.", + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "This method creates an order based on a basket. If successful, the new order will be in status\ndw.order.Order.ORDER_STATUS_CREATED. The basket will be removed from the session and marked for removal.\n\nThis method throws an APIException with type 'CreateOrderException' if any of the following conditions are\nencountered:\n\n- any of the totals (net, gross, tax) of the basket is N/A\n- any of the product items is not available (this takes previously reserved items into account)\n- any campaign-based coupon in the basket is invalid (see dw.order.CouponLineItem.isValid\n- the basket represents an order being edited, but the order has already been replaced by another order\n- the basket represents an order being edited, but the customer associated with the original order is not the\nsame as the current customer\n\nThe method removes all empty shipments from the basket before creating the order. A shipment is said to be empty\nif all of the following are true:\n\n- it contains no product or gift certificate line items\n- all total prices (net, gross, tax) are 0.0\n\nThis method decrements inventory for all products contained in the order. A previous call to\ndw.order.Basket.reserveInventory is unnecessary and discouraged within the same request. The method\ntakes any items with reserved inventory into account, allowing an early reservation of items, e.g. at the\nbeginning of the checkout process. As described above, an APIException is thrown if any item is not available.\n\nIf the basket contains product or gift certificate line items associated with product list items, the method\nupdates the purchased quantity of the product list items; see\ndw.customer.ProductListItem.getPurchasedQuantity.\n\nThe system generates an order number via hook dw.order.hooks.OrderHooks.createOrderNo. If no hook is\nregistered for the endpoint, the number is generated by calling createOrderSequenceNo. The format of\nthe number is based on the Order Number scheme defined in the Sequence Numbers preference configured for the site\nor organization. The number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher\nor lower than a previously created number. As a result, sorting orders by order number is not guaranteed to sort\nthem in their order of creation.\n\nThis method must not be used with the ReserveInventoryForOrder pipelet or\ndw.order.Basket.reserveInventory in the same request.\n\nWhen an order is created, search results don't include it until the next asynchronous update of the order search\nindex. See dw.order.OrderMgr.\n\nPlease note that this method might result in an order with a different customer ID than the originating\nregistered customer attached to the session. This happens if a registered customer logs in with the \"RememberMe\"\nflag set to `true`, but is later logged out (either explicitly, or automatically via session\nexpiration) before calling this method. This is due to the internal order creation logic, which creates a new\nguest customer and attaches it to the order in such cases. To avoid this situation, have your custom code verify\nthat the customer is authenticated before it calls this method.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createOrder(basket: Basket): Order", + "source": "script-api", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "throws": [ + { + "description": "indicates the order could not be created", + "type": "dw.order.CreateOrderException" + } + ], + "title": "OrderMgr.createOrder" + }, + { + "description": "This method functions the same as createOrder, but allows the optional specification of an `orderNo`. The `orderNo` must be unique within the context of a site.", + "id": "script-api:dw/order/OrderMgr#createOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "orderNo", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "This method functions the same as createOrder, but allows the optional specification of\nan `orderNo`. The `orderNo` must be unique within the context of a site.\n\nIf the `orderNo` is not specified, the behavior is the same as that of\ncreateOrder. In that case, the system generates an order number via hook\ndw.order.hooks.OrderHooks.createOrderNo. If no hook is registered for the endpoint, the number is\ngenerated by calling createOrderSequenceNo. The format of the number is based on the Order Number\nscheme defined in the Sequence Numbers preference configured for the site or organization. The number is\nguaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a previously\ncreated number. As a result, sorting orders by order number is not guaranteed to sort them in their order of\ncreation.\n\nThis method must not be used with the ReserveInventoryForOrder pipelet or\ndw.order.Basket.reserveInventory in the same request.\n\nWhen an order is created, search results don't include it until the next asynchronous update of the order search\nindex. See dw.order.OrderMgr.\n\nPlease note that this method might result in an order with a different customer ID than the originating\nregistered customer attached to the session. This happens if a registered customer logs in with the \"RememberMe\"\nflag set to `true`, but is later logged out (either explicitly, or automatically via session\nexpiration) before calling this method. This is due to the internal order creation logic, which creates a new\nguest customer and attaches it to the order in such cases. To avoid this situation, have your custom code verify\nthat the customer is authenticated before it calls this method.\n\nUsage:", + "heading": "Description" + } + ], + "signature": "static createOrder(basket: Basket, orderNo: string): Order", + "source": "script-api", + "tags": [ + "createorder", + "ordermgr.createorder" + ], + "throws": [ + { + "description": "indicates the order could not be created", + "type": "dw.order.CreateOrderException" + } + ], + "title": "OrderMgr.createOrder" + }, + { + "description": "Creates an order number.", + "id": "script-api:dw/order/OrderMgr#createOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Creates an order number.\n\nThe order number is created via hook dw.order.hooks.OrderHooks.createOrderNo. If no hook is registered\nfor the endpoint, the number is generated by calling createOrderSequenceNo. The format of the number\nis based on the Order Number scheme defined in the Sequence Numbers preference configured for the site or\norganization.\n\nThe number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a\npreviously created number. As a result, sorting orders by order number is not guaranteed to sort them in their\norder of creation.", + "heading": "Description" + } + ], + "signature": "static createOrderNo(): string", + "source": "script-api", + "tags": [ + "createorderno", + "ordermgr.createorderno" + ], + "throws": [ + { + "description": "if order number creation failed", + "type": "CreateException" + } + ], + "title": "OrderMgr.createOrderNo" + }, + { + "description": "Creates an order number.", + "id": "script-api:dw/order/OrderMgr#createOrderNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Creates an order number.\n\nThe order number is created via hook dw.order.hooks.OrderHooks.createOrderNo. If no hook is registered\nfor the endpoint, the number is generated by calling createOrderSequenceNo. The format of the number\nis based on the Order Number scheme defined in the Sequence Numbers preference configured for the site or\norganization.\n\nThe number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a\npreviously created number. As a result, sorting orders by order number is not guaranteed to sort them in their\norder of creation.", + "heading": "Description" + } + ], + "signature": "static createOrderNo(): string", + "source": "script-api", + "tags": [ + "createorderno", + "ordermgr.createorderno" + ], + "throws": [ + { + "description": "if order number creation failed", + "type": "CreateException" + } + ], + "title": "OrderMgr.createOrderNo" + }, + { + "description": "Creates an order number.", + "id": "script-api:dw/order/OrderMgr#createOrderSequenceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderSequenceNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Creates an order number.\n\nThe format of the number is based on the Order Number scheme defined in the Sequence Numbers preference\nconfigured for the site or organization.\n\nThe number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a\npreviously created number. As a result, sorting orders by order number is not guaranteed to sort them in their\norder of creation.", + "heading": "Description" + } + ], + "signature": "static createOrderSequenceNo(): string", + "source": "script-api", + "tags": [ + "createordersequenceno", + "ordermgr.createordersequenceno" + ], + "throws": [ + { + "description": "if order number creation failed", + "type": "CreateException" + } + ], + "title": "OrderMgr.createOrderSequenceNo" + }, + { + "description": "Creates an order number.", + "id": "script-api:dw/order/OrderMgr#createOrderSequenceNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createOrderSequenceNo", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Creates an order number.\n\nThe format of the number is based on the Order Number scheme defined in the Sequence Numbers preference\nconfigured for the site or organization.\n\nThe number is guaranteed to be unique, but is not guaranteed to be sequential. It can be higher or lower than a\npreviously created number. As a result, sorting orders by order number is not guaranteed to sort them in their\norder of creation.", + "heading": "Description" + } + ], + "signature": "static createOrderSequenceNo(): string", + "source": "script-api", + "tags": [ + "createordersequenceno", + "ordermgr.createordersequenceno" + ], + "throws": [ + { + "description": "if order number creation failed", + "type": "CreateException" + } + ], + "title": "OrderMgr.createOrderSequenceNo" + }, + { + "description": "Triggers the shipping order creation for an order.", + "id": "script-api:dw/order/OrderMgr#createShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createShippingOrders", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Triggers the shipping order creation for an order.\n\nMust be run outside of a transaction. Will call hooks of the shipping order creation process, which are:\n\n- dw.order.hooks.ShippingOrderHooks.extensionPointPrepareCreateShippingOrders\n- dw.order.hooks.ShippingOrderHooks.extensionPointCreateShippingOrders\n- dw.order.hooks.ShippingOrderHooks.extensionPointAfterStatusChange\n- dw.order.hooks.ShippingOrderHooks.extensionPointNotifyStatusChange\n\nAs a result, zero, one, or multiple dw.order.ShippingOrders are created.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw an exception if accessed.\nActivation needs preliminary approval by Product Management. Please contact support in this case. Existing\ncustomers using these APIs are not affected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "static createShippingOrders(order: Order): Status", + "source": "script-api", + "tags": [ + "createshippingorders", + "ordermgr.createshippingorders" + ], + "title": "OrderMgr.createShippingOrders" + }, + { + "description": "Triggers the shipping order creation for an order.", + "id": "script-api:dw/order/OrderMgr#createShippingOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.createShippingOrders", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Triggers the shipping order creation for an order.\n\nMust be run outside of a transaction. Will call hooks of the shipping order creation process, which are:\n\n- dw.order.hooks.ShippingOrderHooks.extensionPointPrepareCreateShippingOrders\n- dw.order.hooks.ShippingOrderHooks.extensionPointCreateShippingOrders\n- dw.order.hooks.ShippingOrderHooks.extensionPointAfterStatusChange\n- dw.order.hooks.ShippingOrderHooks.extensionPointNotifyStatusChange\n\nAs a result, zero, one, or multiple dw.order.ShippingOrders are created.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw an exception if accessed.\nActivation needs preliminary approval by Product Management. Please contact support in this case. Existing\ncustomers using these APIs are not affected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "static createShippingOrders(order: Order): Status", + "source": "script-api", + "tags": [ + "createshippingorders", + "ordermgr.createshippingorders" + ], + "title": "OrderMgr.createShippingOrders" + }, + { + "description": "Returns the meta data for Orders.", + "id": "script-api:dw/order/OrderMgr#describeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.describeOrder", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for Orders.", + "heading": "Description" + } + ], + "signature": "static describeOrder(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describeorder", + "ordermgr.describeorder" + ], + "title": "OrderMgr.describeOrder" + }, + { + "description": "Returns the meta data for Orders.", + "id": "script-api:dw/order/OrderMgr#describeOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.describeOrder", + "returns": { + "type": "ObjectTypeDefinition" + }, + "sections": [ + { + "body": "Returns the meta data for Orders.", + "heading": "Description" + } + ], + "signature": "static describeOrder(): ObjectTypeDefinition", + "source": "script-api", + "tags": [ + "describeorder", + "ordermgr.describeorder" + ], + "title": "OrderMgr.describeOrder" + }, + { + "deprecated": { + "message": "Please use failOrder instead." + }, + "description": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order must be in status CREATED, and will be set to status FAILED.", + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order\nmust be in status CREATED, and will be set to status FAILED.\n\nInventory transactions and coupon redemptions associated with the Order will be rolled back.\n\nIf the order is failed in the same session in which it was created, the basket will be reopened such that it can\nbe used for a subsequent order.", + "heading": "Description" + } + ], + "signature": "static failOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "description": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order must be in status CREATED, and will be set to status FAILED.", + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "reopenBasketIfPossible", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order\nmust be in status CREATED, and will be set to status FAILED.\n\nInventory transactions and coupon redemptions associated with the Order will be rolled back.\n\nThis method does not alter shipments. Note that createOrder removes empty shipments\nbefore creating the order, so a reopened basket might be missing shipments that existed before. If the removed\nshipment was the default (\"me\"), the fallback default is the shipment with the lowest ID. See\ndw.order.LineItemCtnr.getDefaultShipment and dw.order.Shipment.isDefault.\n\nA basket can only be reopened if no other basket for the customer exists at the moment of the call to\n`failOrder`, since a customer is limited to 1 storefront basket at a time. If, after order creation, a\ncall was made to BasketMgr.getCurrentOrNewBasket or pipelet GetBasket with parameter Create=true, then\na new basket has been created, and `failOrder` cannot reopen the basket the order was created with. If\na basket is reopened, it always masks sensitive information (e.g., credit card number), because during order\ncreation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "static failOrder(order: Order, reopenBasketIfPossible: boolean): Status", + "source": "script-api", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "deprecated": { + "message": "Please use failOrder instead." + }, + "description": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order must be in status CREATED, and will be set to status FAILED.", + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order\nmust be in status CREATED, and will be set to status FAILED.\n\nInventory transactions and coupon redemptions associated with the Order will be rolled back.\n\nIf the order is failed in the same session in which it was created, the basket will be reopened such that it can\nbe used for a subsequent order.", + "heading": "Description" + } + ], + "signature": "static failOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "description": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order must be in status CREATED, and will be set to status FAILED.", + "id": "script-api:dw/order/OrderMgr#failOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "reopenBasketIfPossible", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.failOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method fails an unplaced order and is usually called if payment could not be authorized. The specified Order\nmust be in status CREATED, and will be set to status FAILED.\n\nInventory transactions and coupon redemptions associated with the Order will be rolled back.\n\nThis method does not alter shipments. Note that createOrder removes empty shipments\nbefore creating the order, so a reopened basket might be missing shipments that existed before. If the removed\nshipment was the default (\"me\"), the fallback default is the shipment with the lowest ID. See\ndw.order.LineItemCtnr.getDefaultShipment and dw.order.Shipment.isDefault.\n\nA basket can only be reopened if no other basket for the customer exists at the moment of the call to\n`failOrder`, since a customer is limited to 1 storefront basket at a time. If, after order creation, a\ncall was made to BasketMgr.getCurrentOrNewBasket or pipelet GetBasket with parameter Create=true, then\na new basket has been created, and `failOrder` cannot reopen the basket the order was created with. If\na basket is reopened, it always masks sensitive information (e.g., credit card number), because during order\ncreation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "static failOrder(order: Order, reopenBasketIfPossible: boolean): Status", + "source": "script-api", + "tags": [ + "failorder", + "ordermgr.failorder" + ], + "title": "OrderMgr.failOrder" + }, + { + "description": "Returns the order with the specified order number. Order access in the storefront can be limited; see the class description. Use getOrder instead for secure access in a storefront session.", + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the order with the specified order number. Order access in the storefront can be limited; see\nthe class description. Use getOrder instead for secure access in a storefront session.\n\nIf Limit Storefront Order Access site preference is enabled, this method throws an exception when an\ninsecure access is attempted (refer to the conditions of insecure access in the description of OrderMgr\nclass). Use getOrder instead.", + "heading": "Description" + } + ], + "signature": "static getOrder(orderNumber: string): Order", + "source": "script-api", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "throws": [ + { + "description": "thrown when the Limit Storefront Order Access preference is enabled and the order is insecurely accessed", + "type": "SecurityException" + } + ], + "title": "OrderMgr.getOrder" + }, + { + "description": "Resolves an order using the orderNumber and orderToken.", + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderNumber", + "type": "string" + }, + { + "name": "orderToken", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "returns": { + "type": "Order | null" + }, + "sections": [ + { + "body": "Resolves an order using the orderNumber and orderToken.\n\nThe order token is generated during order creation in a secure way that is designed to reduce the\npossibility of unauthorized access. You can retrieve the token via (dw.order.Order.getOrderToken.\n\nThis version of the getOrder method doesn’t return an exception when the Limit Storefront Order\nAccess site preference is enabled. Best security practice is to always enable this preference, and to use\nthis method when appropriate.\n\nYou should always use this method in the following cases.\n\n- Integration use cases (such as asynchronous payment processing)\n- When resolving orders from links (for example, order confirmation)\n- Storefront use cases", + "heading": "Description" + } + ], + "signature": "static getOrder(orderNumber: string, orderToken: string): Order | null", + "source": "script-api", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "description": "Returns the order with the specified order number. Order access in the storefront can be limited; see the class description. Use getOrder instead for secure access in a storefront session.", + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Returns the order with the specified order number. Order access in the storefront can be limited; see\nthe class description. Use getOrder instead for secure access in a storefront session.\n\nIf Limit Storefront Order Access site preference is enabled, this method throws an exception when an\ninsecure access is attempted (refer to the conditions of insecure access in the description of OrderMgr\nclass). Use getOrder instead.", + "heading": "Description" + } + ], + "signature": "static getOrder(orderNumber: string): Order", + "source": "script-api", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "throws": [ + { + "description": "thrown when the Limit Storefront Order Access preference is enabled and the order is insecurely accessed", + "type": "SecurityException" + } + ], + "title": "OrderMgr.getOrder" + }, + { + "description": "Resolves an order using the orderNumber and orderToken.", + "id": "script-api:dw/order/OrderMgr#getOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderNumber", + "type": "string" + }, + { + "name": "orderToken", + "type": "string" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.getOrder", + "returns": { + "type": "Order | null" + }, + "sections": [ + { + "body": "Resolves an order using the orderNumber and orderToken.\n\nThe order token is generated during order creation in a secure way that is designed to reduce the\npossibility of unauthorized access. You can retrieve the token via (dw.order.Order.getOrderToken.\n\nThis version of the getOrder method doesn’t return an exception when the Limit Storefront Order\nAccess site preference is enabled. Best security practice is to always enable this preference, and to use\nthis method when appropriate.\n\nYou should always use this method in the following cases.\n\n- Integration use cases (such as asynchronous payment processing)\n- When resolving orders from links (for example, order confirmation)\n- Storefront use cases", + "heading": "Description" + } + ], + "signature": "static getOrder(orderNumber: string, orderToken: string): Order | null", + "source": "script-api", + "tags": [ + "getorder", + "ordermgr.getorder" + ], + "title": "OrderMgr.getOrder" + }, + { + "description": "This method places an order and is usually called after payment has been authorized. The specified order must be in status CREATED, and will be set to status NEW.", + "id": "script-api:dw/order/OrderMgr#placeOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.placeOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method places an order and is usually called after payment has been authorized. The specified order must be\nin status CREATED, and will be set to status NEW.\n\nIf the order contains product or gift certificate line items associated with product list items, records of the\npurchase of the product list items will be made. For example, if the basket contains an item added from a gift\nregistry, the purchase history of the respective gift registry item is updated.\n\nThe order will count toward product and customer active data.\n\nPlacing an order leads to the generation of shipment numbers for all shipments and the invoice number of the\norder. See dw.order.Shipment.getShipmentNo and dw.order.Order.getInvoiceNo. This is done\nusing sequences.", + "heading": "Description" + } + ], + "signature": "static placeOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "placeorder", + "ordermgr.placeorder" + ], + "title": "OrderMgr.placeOrder" + }, + { + "description": "This method places an order and is usually called after payment has been authorized. The specified order must be in status CREATED, and will be set to status NEW.", + "id": "script-api:dw/order/OrderMgr#placeOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.placeOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method places an order and is usually called after payment has been authorized. The specified order must be\nin status CREATED, and will be set to status NEW.\n\nIf the order contains product or gift certificate line items associated with product list items, records of the\npurchase of the product list items will be made. For example, if the basket contains an item added from a gift\nregistry, the purchase history of the respective gift registry item is updated.\n\nThe order will count toward product and customer active data.\n\nPlacing an order leads to the generation of shipment numbers for all shipments and the invoice number of the\norder. See dw.order.Shipment.getShipmentNo and dw.order.Order.getInvoiceNo. This is done\nusing sequences.", + "heading": "Description" + } + ], + "signature": "static placeOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "placeorder", + "ordermgr.placeorder" + ], + "title": "OrderMgr.placeOrder" + }, + { + "description": "Executes a user-definable function on a set of orders. This method is intended to be used in batch processes and jobs, since it allows efficient processing of large result sets (which might take a while to process). First, a search with the given parameters is executed. Then the given function is executed once for each order of the search result. The order is handed over as the only parameter to this function.", + "id": "script-api:dw/order/OrderMgr#processOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.processOrders", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Executes a user-definable function on a set of orders. This method is intended to be used in batch processes and\njobs, since it allows efficient processing of large result sets (which might take a while to process). First, a\nsearch with the given parameters is executed. Then the given function is executed once for each order of the\nsearch result. The order is handed over as the only parameter to this function.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. The callback function will be supplied with a single argument of type 'Order'. When the function\ndefines additional arguments, they will be undefined when called. When the method doesn't define any argument, it\nwill be called anyway. Error during execution of the callback will be logged, and execution will continue with\nthe next element from the result set. This method can be used as in this example (which counts the number of\norders):", + "heading": "Description" + } + ], + "signature": "static processOrders(processFunction: Function, queryString: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "processorders", + "ordermgr.processorders" + ], + "title": "OrderMgr.processOrders" + }, + { + "description": "Executes a user-definable function on a set of orders. This method is intended to be used in batch processes and jobs, since it allows efficient processing of large result sets (which might take a while to process). First, a search with the given parameters is executed. Then the given function is executed once for each order of the search result. The order is handed over as the only parameter to this function.", + "id": "script-api:dw/order/OrderMgr#processOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "processFunction", + "type": "Function" + }, + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.processOrders", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Executes a user-definable function on a set of orders. This method is intended to be used in batch processes and\njobs, since it allows efficient processing of large result sets (which might take a while to process). First, a\nsearch with the given parameters is executed. Then the given function is executed once for each order of the\nsearch result. The order is handed over as the only parameter to this function.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. The callback function will be supplied with a single argument of type 'Order'. When the function\ndefines additional arguments, they will be undefined when called. When the method doesn't define any argument, it\nwill be called anyway. Error during execution of the callback will be logged, and execution will continue with\nthe next element from the result set. This method can be used as in this example (which counts the number of\norders):", + "heading": "Description" + } + ], + "signature": "static processOrders(processFunction: Function, queryString: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "processorders", + "ordermgr.processorders" + ], + "title": "OrderMgr.processOrders" + }, + { + "deprecated": { + "message": "Please use searchOrder instead." + }, + "description": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set, it is recommended to use the following code:\n`queryOrders(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns only the\nnext element and closes the iterator.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrder(queryString: string, args?: any[]): Order", + "source": "script-api", + "tags": [ + "queryorder", + "ordermgr.queryorder" + ], + "title": "OrderMgr.queryOrder" + }, + { + "deprecated": { + "message": "Please use searchOrder instead." + }, + "description": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set, it is recommended to use the following code:\n`queryOrders(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns only the\nnext element and closes the iterator.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrder(queryString: string, args?: any[]): Order", + "source": "script-api", + "tags": [ + "queryorder", + "ordermgr.queryorder" + ], + "title": "OrderMgr.queryOrder" + }, + { + "deprecated": { + "message": "Please use searchOrders instead." + }, + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. When implementing order history functionality, don't use the search or query methods in this\nclass. Instead, use dw.customer.OrderHistory.getOrders.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of a specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryOrders(\"sample\", \"\", \"custom.myAttr asc\")`.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders, and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrders(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "deprecated": { + "message": "Please use searchOrders instead." + }, + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured with a map, which converts key-value pairs into a query expression. The key-value\npairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements. When\nimplementing order history functionality, don't use the search or query methods in this class. Instead, use\ndw.customer.OrderHistory.getOrders.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call the `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrders(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "deprecated": { + "message": "Please use searchOrders instead." + }, + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. When implementing order history functionality, don't use the search or query methods in this\nclass. Instead, use dw.customer.OrderHistory.getOrders.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of a specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryOrders(\"sample\", \"\", \"custom.myAttr asc\")`.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders, and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrders(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "deprecated": { + "message": "Please use searchOrders instead." + }, + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#queryOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.queryOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured with a map, which converts key-value pairs into a query expression. The key-value\npairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements. When\nimplementing order history functionality, don't use the search or query methods in this class. Instead, use\ndw.customer.OrderHistory.getOrders.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"`\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call the `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nThis method is deprecated and will be removed in a future release.\nOne of the following methods should be used instead:\nsearchOrder, searchOrders, and\nsearchOrders to search for orders and\nprocessOrders to search for and process orders in jobs.", + "heading": "Description" + } + ], + "signature": "static queryOrders(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "queryorders", + "ordermgr.queryorders" + ], + "title": "OrderMgr.queryOrders" + }, + { + "description": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`), also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`.\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set, it is recommended to use the following code:\n`queryOrders(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns only the\nnext element and closes the iterator.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrder(queryString: string, args?: any[]): Order", + "source": "script-api", + "tags": [ + "searchorder", + "ordermgr.searchorder" + ], + "title": "OrderMgr.searchOrder" + }, + { + "description": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrder", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Searches for a single order instance. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`), also supports wildcards for substring matching\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`.\n\nIf there is more than one object matching the specified query criteria, the result is not deterministic. In order\nto retrieve a single object from a sorted result set, it is recommended to use the following code:\n`queryOrders(\"\", \"custom.myAttr asc\", null).first()`. The method `first()` returns only the\nnext element and closes the iterator.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrder(queryString: string, args?: any[]): Order", + "source": "script-api", + "tags": [ + "searchorder", + "ordermgr.searchorder" + ], + "title": "OrderMgr.searchOrder" + }, + { + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. When implementing order history functionality, don't use the search or query methods in this\nclass. Instead, use dw.customer.OrderHistory.getOrders.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nNote that wildcards are not supported by Search Service.\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of a specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryOrders(\"sample\", \"\", \"custom.myAttr asc\")`.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The result is limited to a maximum of 1000 orders\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrders(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured with a map, which converts key-value pairs into a query expression. The key-value\npairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"` Note that wildcards are not supported by Search Service.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The result is limited to a maximum of 1000 orders\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrders(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryString", + "type": "string" + }, + { + "name": "sortString", + "type": "string | null" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured using a simple query language, which provides most common filter and operator\nfunctionality. When implementing order history functionality, don't use the search or query methods in this\nclass. Instead, use dw.customer.OrderHistory.getOrders.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe following operators are supported in a condition:\n\n- `=` Equals - All types; supports NULL value (`thumbnail = NULL`)\n- `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)\n- `<` Less than - Integer, Number, and Date types only\n- `>` Greater than - Integer, Number, and Date types only\n- `<=` Less or equals than - Integer, Number, and Date types only\n- `>=` Greater or equals than - Integer, Number, and Date types only\n- `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to\nsupport substring search (e.g. `custom.country LIKE 'US*'`)\n- `ILIKE` Caseindependent Like - String types and Email only; use to support case-insensitive\nqueries (e.g. `custom.country ILIKE 'usa'`); also supports wildcards for substring matching\n\nNote that wildcards are not supported by Search Service.\n\nConditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g.\n`gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.\n\nThe query language provides a placeholder syntax to pass objects as additional search parameters. Each passed\nobject is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by\nbraces. The first Integer value must be '0', the second '1', and so on, e.g.\n`querySystemObjects(\"sample\", \"age = {0} or creationDate >= {1}\", 18, date)`.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nSometimes it is desired to get all instances of a specified type with a special sorting condition. This can be\neasily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty\n'queryString', e.g. `queryOrders(\"sample\", \"\", \"custom.myAttr asc\")`.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The result is limited to a maximum of 1000 orders\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrders(queryString: string, sortString: string | null, args?: any[]): SeekableIterator", + "source": "script-api", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "description": "Searches for order instances. Order access in the storefront can be limited; see the class description.", + "id": "script-api:dw/order/OrderMgr#searchOrders", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "queryAttributes", + "type": "utilMap" + }, + { + "name": "sortString", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.searchOrders", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Searches for order instances. Order access in the storefront can be limited; see the class description.\n\nThe search can be configured with a map, which converts key-value pairs into a query expression. The key-value\npairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.\n\nExample:\n\nA map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:\n`\"name like 'tom*' and age = 66\"` Note that wildcards are not supported by Search Service.\n\nThe identifier for an attribute to use in a query condition is always the ID of the attribute as defined\nin the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g.\n`custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).\n\nSupported attribute value types with sample expression values:\n\n- String `'String', 'Str*', 'Strin?'`\n- Integer `1, 3E4`\n- Number `1.0, 3.99E5`\n- Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`\n- DateTime\n`yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`\n- Boolean `true, false`\n- Email `'search@demandware.com', '*@demandware.com'`\n- Set of String `'String', 'Str*', 'Strin?'`\n- Set of Integer `1, 3E4`\n- Set of Number `1.0, 3.99E5`\n- Enum of String `'String', 'Str*', 'Strin?'`\n- Enum of Integer `1, 3E4`\n\nThe following types of attributes are not queryable:\n\n- Image\n- HTML\n- Text\n- Quantity\n- Password\n\nNote that some system attributes are not queryable by default, regardless of the actual value type code.\n\nThe sorting parameter is optional and may contain a comma-separated list of attribute names to sort by.\nEach sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default\nsorting direction is ascending, if no direction was specified.\n\nExample: `age desc, name`\n\nPlease note that specifying a localized custom attribute as the sorting attribute is currently not supported.\n\nIt is strongly recommended to call `dw.util.SeekableIterator.close` on the returned\nSeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system\nresources.\n\nIf the order search API is configured to use the new Search Service, these differences apply:\n\n- Search may match and return documents with missing (NULL) values in search fields, depending on\nhow the query is structured, potentially leading to broader result sets. For example, a query like\n`custom.searchField != \"some value\"` also returns documents where `custom.searchField`\nis NULL — whereas in relational databases, such documents are excluded.\n- Wildcards are filtered from the query (*, %, +) and replaced by spaces\n- LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring\nsearches\n- LIKE queries are always case-insensitive\n- Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending\non how they are combined\n- Using logical operators may result in degraded performance, depending on how they are combined\n- The result is limited to a maximum of 1000 orders\n\nOrder search index updates are asynchronous, triggered only by committing changes to the underlying system.", + "heading": "Description" + } + ], + "signature": "static searchOrders(queryAttributes: utilMap, sortString: string | null): SeekableIterator", + "source": "script-api", + "tags": [ + "searchorders", + "ordermgr.searchorders" + ], + "title": "OrderMgr.searchOrders" + }, + { + "description": "This method is used to turn a CANCELLED order into an OPEN order.", + "id": "script-api:dw/order/OrderMgr#undoCancelOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoCancelOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method is used to turn a CANCELLED order into an OPEN order.\n\nThe specified order must be a cancelled order (dw.order.Order.ORDER_STATUS_CANCELLED). The method will\nreserve inventory for all product line items, and create redemptions for all coupons. If successful, the status\nof the order will be changed to dw.order.Order.ORDER_STATUS_OPEN. If the order contains product or gift\ncertificate line items associated with product list items, records of the purchase of the product list items will\nbe recreated.\n\nIf the undoCancelOrder call fails, the transaction is marked as ‘rollback only’ – all changes in the associated\ntransaction will no longer be committed.\n\nPossible error status codes are:\n\n- OrderProcessStatusCodes.COUPON_INVALID - coupon is not active anymore or maximum amount of\nredemptions is reached\n- OrderProcessStatusCodes.ORDER_NOT_CANCELLED - order is not in status\ndw.order.Order.ORDER_STATUS_CANCELLED\n- OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED - Inventory reservation for the order failed. In\ncases when availability is too low then undoCancel or undoFail results in a reservation failure. This can be\navoided using the order site preferences to specifically allow overselling. See order site preferences under\n\"Constraints for Undoing Failed/Cancelled Orders\".", + "heading": "Description" + } + ], + "signature": "static undoCancelOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "undocancelorder", + "ordermgr.undocancelorder" + ], + "title": "OrderMgr.undoCancelOrder" + }, + { + "description": "This method is used to turn a CANCELLED order into an OPEN order.", + "id": "script-api:dw/order/OrderMgr#undoCancelOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoCancelOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method is used to turn a CANCELLED order into an OPEN order.\n\nThe specified order must be a cancelled order (dw.order.Order.ORDER_STATUS_CANCELLED). The method will\nreserve inventory for all product line items, and create redemptions for all coupons. If successful, the status\nof the order will be changed to dw.order.Order.ORDER_STATUS_OPEN. If the order contains product or gift\ncertificate line items associated with product list items, records of the purchase of the product list items will\nbe recreated.\n\nIf the undoCancelOrder call fails, the transaction is marked as ‘rollback only’ – all changes in the associated\ntransaction will no longer be committed.\n\nPossible error status codes are:\n\n- OrderProcessStatusCodes.COUPON_INVALID - coupon is not active anymore or maximum amount of\nredemptions is reached\n- OrderProcessStatusCodes.ORDER_NOT_CANCELLED - order is not in status\ndw.order.Order.ORDER_STATUS_CANCELLED\n- OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED - Inventory reservation for the order failed. In\ncases when availability is too low then undoCancel or undoFail results in a reservation failure. This can be\navoided using the order site preferences to specifically allow overselling. See order site preferences under\n\"Constraints for Undoing Failed/Cancelled Orders\".", + "heading": "Description" + } + ], + "signature": "static undoCancelOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "undocancelorder", + "ordermgr.undocancelorder" + ], + "title": "OrderMgr.undoCancelOrder" + }, + { + "description": "This method is used to turn a FAILED order into a CREATED order.", + "id": "script-api:dw/order/OrderMgr#undoFailOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoFailOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method is used to turn a FAILED order into a CREATED order.\n\nThe specified order must be a failed order (dw.order.Order.ORDER_STATUS_FAILED). The method will reserve\ninventory for all product line items, and create redemptions for all coupons. If successful, the status of the\norder will be changed to dw.order.Order.ORDER_STATUS_CREATED.\n\nIf the undoFailOrder call fails, the transaction is marked as ‘rollback only’ – all changes in the associated\ntransaction will no longer be committed.\n\nPossible error status codes are:\n\n- OrderProcessStatusCodes.COUPON_INVALID - coupon is not active anymore or maximum amount of\nredemptions is reached\n- OrderProcessStatusCodes.ORDER_NOT_FAILED - order is not in status\ndw.order.Order.ORDER_STATUS_FAILED\n- OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED - Inventory reservation for the order failed. In\ncases when availability is too low then undoCancel or undoFail results in a reservation failure. This can be\navoided using the order site preferences to specifically allow overselling. See order site preferences under\n\"Constraints for Undoing Failed/Cancelled Orders\".", + "heading": "Description" + } + ], + "signature": "static undoFailOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "undofailorder", + "ordermgr.undofailorder" + ], + "title": "OrderMgr.undoFailOrder" + }, + { + "description": "This method is used to turn a FAILED order into a CREATED order.", + "id": "script-api:dw/order/OrderMgr#undoFailOrder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/OrderMgr", + "qualifiedName": "dw.order.OrderMgr.undoFailOrder", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "This method is used to turn a FAILED order into a CREATED order.\n\nThe specified order must be a failed order (dw.order.Order.ORDER_STATUS_FAILED). The method will reserve\ninventory for all product line items, and create redemptions for all coupons. If successful, the status of the\norder will be changed to dw.order.Order.ORDER_STATUS_CREATED.\n\nIf the undoFailOrder call fails, the transaction is marked as ‘rollback only’ – all changes in the associated\ntransaction will no longer be committed.\n\nPossible error status codes are:\n\n- OrderProcessStatusCodes.COUPON_INVALID - coupon is not active anymore or maximum amount of\nredemptions is reached\n- OrderProcessStatusCodes.ORDER_NOT_FAILED - order is not in status\ndw.order.Order.ORDER_STATUS_FAILED\n- OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED - Inventory reservation for the order failed. In\ncases when availability is too low then undoCancel or undoFail results in a reservation failure. This can be\navoided using the order site preferences to specifically allow overselling. See order site preferences under\n\"Constraints for Undoing Failed/Cancelled Orders\".", + "heading": "Description" + } + ], + "signature": "static undoFailOrder(order: Order): Status", + "source": "script-api", + "tags": [ + "undofailorder", + "ordermgr.undofailorder" + ], + "title": "OrderMgr.undoFailOrder" + }, + { + "description": "Represents any payment instrument used to pay orders, such as credit card or bank transfer. The object defines standard methods for credit card payment, and can be extended by attributes appropriate for other payment methods.", + "id": "script-api:dw/order/OrderPaymentInstrument", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderPaymentInstrument", + "sections": [ + { + "body": "Represents any payment instrument used to pay orders, such as credit card\nor bank transfer. The object defines standard methods for credit card\npayment, and can be extended by attributes appropriate for other\npayment methods.", + "heading": "Description" + }, + { + "body": "Extends `PaymentInstrument`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "orderpaymentinstrument", + "dw.order.orderpaymentinstrument", + "dw/order" + ], + "title": "OrderPaymentInstrument" + }, + { + "description": "Returns the driver's license associated with a bank account if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.bankAccountDriversLicense", + "sections": [ + { + "body": "Returns the driver's license associated with a bank account if the calling\ncontext meets the following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is identical to the customer related to the basket\nor order, and the current protocol is HTTPS.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has permission to the Orders module.\n\nOtherwise, the method throws an exception.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountDriversLicense: string", + "source": "script-api", + "tags": [ + "bankaccountdriverslicense", + "orderpaymentinstrument.bankaccountdriverslicense" + ], + "title": "OrderPaymentInstrument.bankAccountDriversLicense" + }, + { + "description": "Returns the account number if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.bankAccountNumber", + "sections": [ + { + "body": "Returns the account number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is identical to the customer related to the basket\nor order, and the current protocol is HTTPS.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has permissions to the Orders module.\n\nOtherwise, the method throws an exception.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountNumber: string", + "source": "script-api", + "tags": [ + "bankaccountnumber", + "orderpaymentinstrument.bankaccountnumber" + ], + "title": "OrderPaymentInstrument.bankAccountNumber" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice using Invoice method addCaptureTransaction.", + "id": "script-api:dw/order/OrderPaymentInstrument#capturedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.capturedAmount", + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts\nare calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice\nusing Invoice method addCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "readonly capturedAmount: Money", + "source": "script-api", + "tags": [ + "capturedamount", + "orderpaymentinstrument.capturedamount" + ], + "title": "OrderPaymentInstrument.capturedAmount" + }, + { + "description": "Returns the de-crypted creditcard number if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.creditCardNumber", + "sections": [ + { + "body": "Returns the de-crypted creditcard number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.\n\n-\nIf the customer is anonymous, and the order references this customer, and the protocol is secure and\nthe order status is CREATED.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has the permission to manage orders.\n\n-\nIf the payment information has not been masked as a result of the data retention security policy\nfor the site.\n\nOtherwise, the method returns the masked credit card number.", + "heading": "Description" + } + ], + "signature": "readonly creditCardNumber: string", + "source": "script-api", + "tags": [ + "creditcardnumber", + "orderpaymentinstrument.creditcardnumber" + ], + "title": "OrderPaymentInstrument.creditCardNumber" + }, + { + "description": "Returns the driver's license associated with a bank account if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getBankAccountDriversLicense", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the driver's license associated with a bank account if the calling\ncontext meets the following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is identical to the customer related to the basket\nor order, and the current protocol is HTTPS.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has permission to the Orders module.\n\nOtherwise, the method throws an exception.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicense(): string", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicense", + "orderpaymentinstrument.getbankaccountdriverslicense" + ], + "title": "OrderPaymentInstrument.getBankAccountDriversLicense" + }, + { + "description": "Returns the account number if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getBankAccountNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the account number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current customer is identical to the customer related to the basket\nor order, and the current protocol is HTTPS.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has permissions to the Orders module.\n\nOtherwise, the method throws an exception.", + "heading": "Description" + } + ], + "signature": "getBankAccountNumber(): string", + "source": "script-api", + "tags": [ + "getbankaccountnumber", + "orderpaymentinstrument.getbankaccountnumber" + ], + "title": "OrderPaymentInstrument.getBankAccountNumber" + }, + { + "description": "Returns the sum of the captured amounts. The captured amounts are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice using Invoice method addCaptureTransaction.", + "id": "script-api:dw/order/OrderPaymentInstrument#getCapturedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getCapturedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the captured amounts. The captured amounts\nare calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice\nusing Invoice method addCaptureTransaction.", + "heading": "Description" + } + ], + "signature": "getCapturedAmount(): Money", + "source": "script-api", + "tags": [ + "getcapturedamount", + "orderpaymentinstrument.getcapturedamount" + ], + "title": "OrderPaymentInstrument.getCapturedAmount" + }, + { + "description": "Returns the de-crypted creditcard number if the calling context meets the following criteria:", + "id": "script-api:dw/order/OrderPaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the de-crypted creditcard number if the calling context meets\nthe following criteria:\n\n-\nIf the method call happens in the context of a storefront request and\nthe current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.\n\n-\nIf the customer is anonymous, and the order references this customer, and the protocol is secure and\nthe order status is CREATED.\n\n-\nIf the method call happens in the context of the business manager and the\ncurrent user has the permission to manage orders.\n\n-\nIf the payment information has not been masked as a result of the data retention security policy\nfor the site.\n\nOtherwise, the method returns the masked credit card number.", + "heading": "Description" + } + ], + "signature": "getCreditCardNumber(): string", + "source": "script-api", + "tags": [ + "getcreditcardnumber", + "orderpaymentinstrument.getcreditcardnumber" + ], + "title": "OrderPaymentInstrument.getCreditCardNumber" + }, + { + "description": "Returns the Payment Transaction for this Payment Instrument or null.", + "id": "script-api:dw/order/OrderPaymentInstrument#getPaymentTransaction", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getPaymentTransaction", + "returns": { + "type": "PaymentTransaction | null" + }, + "sections": [ + { + "body": "Returns the Payment Transaction for this Payment Instrument or null.", + "heading": "Description" + } + ], + "signature": "getPaymentTransaction(): PaymentTransaction | null", + "source": "script-api", + "tags": [ + "getpaymenttransaction", + "orderpaymentinstrument.getpaymenttransaction" + ], + "title": "OrderPaymentInstrument.getPaymentTransaction" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice using Invoice method addRefundTransaction.", + "id": "script-api:dw/order/OrderPaymentInstrument#getRefundedAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.getRefundedAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts\nare calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice\nusing Invoice method addRefundTransaction.", + "heading": "Description" + } + ], + "signature": "getRefundedAmount(): Money", + "source": "script-api", + "tags": [ + "getrefundedamount", + "orderpaymentinstrument.getrefundedamount" + ], + "title": "OrderPaymentInstrument.getRefundedAmount" + }, + { + "description": "Returns the Payment Transaction for this Payment Instrument or null.", + "id": "script-api:dw/order/OrderPaymentInstrument#paymentTransaction", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.paymentTransaction", + "sections": [ + { + "body": "Returns the Payment Transaction for this Payment Instrument or null.", + "heading": "Description" + } + ], + "signature": "readonly paymentTransaction: PaymentTransaction | null", + "source": "script-api", + "tags": [ + "paymenttransaction", + "orderpaymentinstrument.paymenttransaction" + ], + "title": "OrderPaymentInstrument.paymentTransaction" + }, + { + "description": "Returns the sum of the refunded amounts. The refunded amounts are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice using Invoice method addRefundTransaction.", + "id": "script-api:dw/order/OrderPaymentInstrument#refundedAmount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderPaymentInstrument", + "qualifiedName": "dw.order.OrderPaymentInstrument.refundedAmount", + "sections": [ + { + "body": "Returns the sum of the refunded amounts. The refunded amounts\nare calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice\nusing Invoice method addRefundTransaction.", + "heading": "Description" + } + ], + "signature": "readonly refundedAmount: Money", + "source": "script-api", + "tags": [ + "refundedamount", + "orderpaymentinstrument.refundedamount" + ], + "title": "OrderPaymentInstrument.refundedAmount" + }, + { + "description": "Contains constants representing different status codes for interacting with an order, such as cancelling or editing an order.", + "id": "script-api:dw/order/OrderProcessStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.OrderProcessStatusCodes", + "sections": [ + { + "body": "Contains constants representing different status codes\nfor interacting with an order, such as cancelling\nor editing an order.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "orderprocessstatuscodes", + "dw.order.orderprocessstatuscodes", + "dw/order" + ], + "title": "OrderProcessStatusCodes" + }, + { + "description": "Indicates that a coupon in the order is not valid.", + "id": "script-api:dw/order/OrderProcessStatusCodes#COUPON_INVALID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.COUPON_INVALID", + "sections": [ + { + "body": "Indicates that a coupon in the order is not valid.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_INVALID = \"COUPON_INVALID\"", + "source": "script-api", + "tags": [ + "coupon_invalid", + "orderprocessstatuscodes.coupon_invalid" + ], + "title": "OrderProcessStatusCodes.COUPON_INVALID" + }, + { + "description": "Indicates that a coupon in the order is not valid.", + "id": "script-api:dw/order/OrderProcessStatusCodes#COUPON_INVALID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.COUPON_INVALID", + "sections": [ + { + "body": "Indicates that a coupon in the order is not valid.", + "heading": "Description" + } + ], + "signature": "static readonly COUPON_INVALID = \"COUPON_INVALID\"", + "source": "script-api", + "tags": [ + "coupon_invalid", + "orderprocessstatuscodes.coupon_invalid" + ], + "title": "OrderProcessStatusCodes.COUPON_INVALID" + }, + { + "description": "Indicates that no inventory could be reserved for the order.", + "id": "script-api:dw/order/OrderProcessStatusCodes#INVENTORY_RESERVATION_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED", + "sections": [ + { + "body": "Indicates that no inventory could be reserved for the order.", + "heading": "Description" + } + ], + "signature": "static readonly INVENTORY_RESERVATION_FAILED = \"INVENTORY_RESERVATION_FAILED\"", + "source": "script-api", + "tags": [ + "inventory_reservation_failed", + "orderprocessstatuscodes.inventory_reservation_failed" + ], + "title": "OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED" + }, + { + "description": "Indicates that no inventory could be reserved for the order.", + "id": "script-api:dw/order/OrderProcessStatusCodes#INVENTORY_RESERVATION_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED", + "sections": [ + { + "body": "Indicates that no inventory could be reserved for the order.", + "heading": "Description" + } + ], + "signature": "static readonly INVENTORY_RESERVATION_FAILED = \"INVENTORY_RESERVATION_FAILED\"", + "source": "script-api", + "tags": [ + "inventory_reservation_failed", + "orderprocessstatuscodes.inventory_reservation_failed" + ], + "title": "OrderProcessStatusCodes.INVENTORY_RESERVATION_FAILED" + }, + { + "description": "Indicates that the order could not be used because it has already been cancelled.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been cancelled.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_CANCELLED = \"ORDER_CANCELLED\"", + "source": "script-api", + "tags": [ + "order_already_cancelled", + "orderprocessstatuscodes.order_already_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED" + }, + { + "description": "Indicates that the order could not be used because it has already been cancelled.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been cancelled.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_CANCELLED = \"ORDER_CANCELLED\"", + "source": "script-api", + "tags": [ + "order_already_cancelled", + "orderprocessstatuscodes.order_already_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED" + }, + { + "description": "Indicates that the order could not be used because it has already been exported.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_EXPORTED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED", + "sections": [ + { + "body": "Indicates that the order could not be used because it\nhas already been exported.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_EXPORTED = \"ORDER_EXPORTED\"", + "source": "script-api", + "tags": [ + "order_already_exported", + "orderprocessstatuscodes.order_already_exported" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED" + }, + { + "description": "Indicates that the order could not be used because it has already been exported.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_EXPORTED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED", + "sections": [ + { + "body": "Indicates that the order could not be used because it\nhas already been exported.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_EXPORTED = \"ORDER_EXPORTED\"", + "source": "script-api", + "tags": [ + "order_already_exported", + "orderprocessstatuscodes.order_already_exported" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED" + }, + { + "description": "Indicates that the order could not be used because it has already been failed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_FAILED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been failed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_FAILED = \"ORDER_FAILED\"", + "source": "script-api", + "tags": [ + "order_already_failed", + "orderprocessstatuscodes.order_already_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_FAILED" + }, + { + "description": "Indicates that the order could not be used because it has already been failed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_FAILED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been failed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_FAILED = \"ORDER_FAILED\"", + "source": "script-api", + "tags": [ + "order_already_failed", + "orderprocessstatuscodes.order_already_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_FAILED" + }, + { + "description": "Indicates that the order could not be used because it has already been replaced.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_REPLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been replaced.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_REPLACED = \"ORDER_REPLACED\"", + "source": "script-api", + "tags": [ + "order_already_replaced", + "orderprocessstatuscodes.order_already_replaced" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_REPLACED" + }, + { + "description": "Indicates that the order could not be used because it has already been replaced.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_ALREADY_REPLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has already been replaced.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_ALREADY_REPLACED = \"ORDER_REPLACED\"", + "source": "script-api", + "tags": [ + "order_already_replaced", + "orderprocessstatuscodes.order_already_replaced" + ], + "title": "OrderProcessStatusCodes.ORDER_ALREADY_REPLACED" + }, + { + "description": "Indicates that the order could not be used because it contains gift certificates.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_CONTAINS_GC", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC", + "sections": [ + { + "body": "Indicates that the order could not be used because it\ncontains gift certificates.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_CONTAINS_GC = \"CANCEL_ORDER_GC\"", + "source": "script-api", + "tags": [ + "order_contains_gc", + "orderprocessstatuscodes.order_contains_gc" + ], + "title": "OrderProcessStatusCodes.ORDER_CONTAINS_GC" + }, + { + "description": "Indicates that the order could not be used because it contains gift certificates.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_CONTAINS_GC", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC", + "sections": [ + { + "body": "Indicates that the order could not be used because it\ncontains gift certificates.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_CONTAINS_GC = \"CANCEL_ORDER_GC\"", + "source": "script-api", + "tags": [ + "order_contains_gc", + "orderprocessstatuscodes.order_contains_gc" + ], + "title": "OrderProcessStatusCodes.ORDER_CONTAINS_GC" + }, + { + "description": "Indicates that the order could not be used because it is not cancelled.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_CANCELLED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit is not cancelled.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_CANCELLED = \"ORDER_NOT_CANCELLED\"", + "source": "script-api", + "tags": [ + "order_not_cancelled", + "orderprocessstatuscodes.order_not_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_CANCELLED" + }, + { + "description": "Indicates that the order could not be used because it is not cancelled.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_CANCELLED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_CANCELLED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit is not cancelled.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_CANCELLED = \"ORDER_NOT_CANCELLED\"", + "source": "script-api", + "tags": [ + "order_not_cancelled", + "orderprocessstatuscodes.order_not_cancelled" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_CANCELLED" + }, + { + "description": "Indicates that the order could not be used because it has not been failed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_FAILED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has not been failed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_FAILED = \"ORDER_NOT_FAILED\"", + "source": "script-api", + "tags": [ + "order_not_failed", + "orderprocessstatuscodes.order_not_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_FAILED" + }, + { + "description": "Indicates that the order could not be used because it has not been failed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_FAILED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_FAILED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has not been failed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_FAILED = \"ORDER_NOT_FAILED\"", + "source": "script-api", + "tags": [ + "order_not_failed", + "orderprocessstatuscodes.order_not_failed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_FAILED" + }, + { + "description": "Indicates that the order could not be used because it has not been placed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_PLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_PLACED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has not been placed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_PLACED = \"ORDER_NOT_PLACED\"", + "source": "script-api", + "tags": [ + "order_not_placed", + "orderprocessstatuscodes.order_not_placed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_PLACED" + }, + { + "description": "Indicates that the order could not be used because it has not been placed.", + "id": "script-api:dw/order/OrderProcessStatusCodes#ORDER_NOT_PLACED", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/OrderProcessStatusCodes", + "qualifiedName": "dw.order.OrderProcessStatusCodes.ORDER_NOT_PLACED", + "sections": [ + { + "body": "Indicates that the order could not be used because\nit has not been placed.", + "heading": "Description" + } + ], + "signature": "static readonly ORDER_NOT_PLACED = \"ORDER_NOT_PLACED\"", + "source": "script-api", + "tags": [ + "order_not_placed", + "orderprocessstatuscodes.order_not_placed" + ], + "title": "OrderProcessStatusCodes.ORDER_NOT_PLACED" + }, + { + "description": "Represents payment cards and provides methods to access the payment card attributes and status.", + "id": "script-api:dw/order/PaymentCard", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentCard", + "sections": [ + { + "body": "Represents payment cards and provides methods to access the payment card\nattributes and status.\n\nNote: this class handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "paymentcard", + "dw.order.paymentcard", + "dw/order" + ], + "title": "PaymentCard" + }, + { + "description": "Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.", + "id": "script-api:dw/order/PaymentCard#active", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.active", + "sections": [ + { + "body": "Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "readonly active: boolean", + "source": "script-api", + "tags": [ + "active", + "paymentcard.active" + ], + "title": "PaymentCard.active" + }, + { + "description": "Returns the unique card type of the payment card.", + "id": "script-api:dw/order/PaymentCard#cardType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.cardType", + "sections": [ + { + "body": "Returns the unique card type of the payment card.", + "heading": "Description" + } + ], + "signature": "readonly cardType: string", + "source": "script-api", + "tags": [ + "cardtype", + "paymentcard.cardtype" + ], + "title": "PaymentCard.cardType" + }, + { + "description": "Returns the description of the payment card.", + "id": "script-api:dw/order/PaymentCard#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.description", + "sections": [ + { + "body": "Returns the description of the payment card.", + "heading": "Description" + } + ], + "signature": "readonly description: MarkupText", + "source": "script-api", + "tags": [ + "description", + "paymentcard.description" + ], + "title": "PaymentCard.description" + }, + { + "description": "Returns the unique card type of the payment card.", + "id": "script-api:dw/order/PaymentCard#getCardType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getCardType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique card type of the payment card.", + "heading": "Description" + } + ], + "signature": "getCardType(): string", + "source": "script-api", + "tags": [ + "getcardtype", + "paymentcard.getcardtype" + ], + "title": "PaymentCard.getCardType" + }, + { + "description": "Returns the description of the payment card.", + "id": "script-api:dw/order/PaymentCard#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the description of the payment card.", + "heading": "Description" + } + ], + "signature": "getDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getdescription", + "paymentcard.getdescription" + ], + "title": "PaymentCard.getDescription" + }, + { + "description": "Returns the reference to the payment card image.", + "id": "script-api:dw/order/PaymentCard#getImage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the reference to the payment card image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "paymentcard.getimage" + ], + "title": "PaymentCard.getImage" + }, + { + "description": "Returns the name of the payment card.", + "id": "script-api:dw/order/PaymentCard#getName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the payment card.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "paymentcard.getname" + ], + "title": "PaymentCard.getName" + }, + { + "description": "Returns the reference to the payment card image.", + "id": "script-api:dw/order/PaymentCard#image", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.image", + "sections": [ + { + "body": "Returns the reference to the payment card image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "paymentcard.image" + ], + "title": "PaymentCard.image" + }, + { + "description": "Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.", + "id": "script-api:dw/order/PaymentCard#isActive", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.isActive", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "isActive(): boolean", + "source": "script-api", + "tags": [ + "isactive", + "paymentcard.isactive" + ], + "title": "PaymentCard.isActive" + }, + { + "description": "Returns 'true' if this payment card is applicable for the specified customer, country and payment amount and the session currency.", + "id": "script-api:dw/order/PaymentCard#isApplicable", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer | null" + }, + { + "name": "countryCode", + "type": "string | null" + }, + { + "name": "paymentAmount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.isApplicable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if this payment card is applicable for the specified\ncustomer, country and payment amount and the session currency.\n\nThe payment card is applicable if\n\n- the card is restricted by customer group, and at least one of the\ngroups of the specified customer is assigned to the card\n- the card is restricted by billing country, and the specified country\ncode is assigned to the card\n- the method is restricted by payment amount for the session currency,\nand the specified payment amount is within the limits of the min/max\npayment amount defined for the method and the session currency\n- the method is restricted by session currency, and the session\ncurrency code is assigned to the method\n\nAll parameters are optional, and if not specified, the respective\nrestriction won't be validated. For example, if a card is restricted by\nbilling country, but no country code is specified, this card will be\nreturned, unless it is filtered out by customer group or payment amount.", + "heading": "Description" + } + ], + "signature": "isApplicable(customer: Customer | null, countryCode: string | null, paymentAmount: number): boolean", + "source": "script-api", + "tags": [ + "isapplicable", + "paymentcard.isapplicable" + ], + "title": "PaymentCard.isApplicable" + }, + { + "description": "Returns the name of the payment card.", + "id": "script-api:dw/order/PaymentCard#name", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.name", + "sections": [ + { + "body": "Returns the name of the payment card.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "paymentcard.name" + ], + "title": "PaymentCard.name" + }, + { + "description": "Verify the card against the provided values. This method is equivalent to verify but omits verification of the card security code. If the verification fails the resulting dw.system.Status will hold up to 2 error items each with a code:", + "id": "script-api:dw/order/PaymentCard#verify", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "expiresMonth", + "type": "number" + }, + { + "name": "expiresYear", + "type": "number" + }, + { + "name": "cardNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.verify", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Verify the card against the provided values. This method is equivalent to\nverify but omits verification of the\ncard security code. If the verification fails the resulting\ndw.system.Status will hold up to 2 error items each with a code:\n\n- dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE - the expiresMonth and expiresYear do not describe a\nmonth in the future, or describe an invalid month outside the range 1-12.\n- dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER - the cardNumber does not verify against one or more configured\nchecks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.", + "heading": "Description" + } + ], + "signature": "verify(expiresMonth: number, expiresYear: number, cardNumber: string): Status", + "source": "script-api", + "tags": [ + "verify", + "paymentcard.verify" + ], + "title": "PaymentCard.verify" + }, + { + "description": "Verify the card against the provided values. If the verification fails the resulting dw.system.Status will hold up to 3 error items with these codes:", + "id": "script-api:dw/order/PaymentCard#verify", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "expiresMonth", + "type": "number" + }, + { + "name": "expiresYear", + "type": "number" + }, + { + "name": "cardNumber", + "type": "string" + }, + { + "name": "csc", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentCard", + "qualifiedName": "dw.order.PaymentCard.verify", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Verify the card against the provided values. If the verification fails the resulting\ndw.system.Status will hold up to 3 error items with these codes:\n\n- dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE - the expiresMonth and expiresYear do not describe a\nmonth in the future, or describe an invalid month outside the range 1-12.\n- dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER - the cardNumber does not verify against one or more configured\nchecks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.\n- dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE - the card security code does not verify against the configured\naccepted length.", + "heading": "Description" + } + ], + "signature": "verify(expiresMonth: number, expiresYear: number, cardNumber: string, csc: string): Status", + "source": "script-api", + "tags": [ + "verify", + "paymentcard.verify" + ], + "title": "PaymentCard.verify" + }, + { + "description": "Base class for payment instrument either stored in the customers profile or related to an order. A payment instrument can be credit card or bank transfer. The object defines standard methods for credit card payment, and can be extended by attributes appropriate for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentInstrument", + "sections": [ + { + "body": "Base class for payment instrument either stored in the customers profile\nor related to an order. A payment instrument can be credit card\nor bank transfer. The object defines standard methods for credit card\npayment, and can be extended by attributes appropriate for other\npayment methods.\n\nNote: this class handles sensitive financial and card holder data.\nPay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.", + "heading": "Description" + }, + { + "body": "Extends `EncryptedObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "paymentinstrument", + "dw.order.paymentinstrument", + "dw/order" + ], + "title": "PaymentInstrument" + }, + { + "deprecated": { + "message": "Support for this algorithm will be removed in a future release. Please use\nENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING instead." + }, + "description": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA", + "sections": [ + { + "body": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA: string", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa", + "paymentinstrument.encryption_algorithm_rsa" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA" + }, + { + "deprecated": { + "message": "Support for this algorithm will be removed in a future release. Please use\nENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING instead." + }, + "description": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA", + "sections": [ + { + "body": "The outdated encryption algorithm \"RSA/ECB/PKCS1Padding\". Please do not use anymore!", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA: string", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa", + "paymentinstrument.encryption_algorithm_rsa" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA" + }, + { + "description": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "sections": [ + { + "body": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING = \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "paymentinstrument.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "description": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "id": "script-api:dw/order/PaymentInstrument#ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING", + "sections": [ + { + "body": "The encryption algorithm \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\".", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING = \"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding", + "paymentinstrument.encryption_algorithm_rsa_ecb_oaepwithsha_256andmgf1padding" + ], + "title": "PaymentInstrument.ENCRYPTION_ALGORITHM_RSA_ECB_OAEPWITHSHA_256ANDMGF1PADDING" + }, + { + "description": "Represents a bank transfer type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_BANK_TRANSFER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BANK_TRANSFER", + "sections": [ + { + "body": "Represents a bank transfer type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_BANK_TRANSFER: string", + "source": "script-api", + "tags": [ + "method_bank_transfer", + "paymentinstrument.method_bank_transfer" + ], + "title": "PaymentInstrument.METHOD_BANK_TRANSFER" + }, + { + "description": "Represents a bank transfer type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_BANK_TRANSFER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BANK_TRANSFER", + "sections": [ + { + "body": "Represents a bank transfer type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_BANK_TRANSFER: string", + "source": "script-api", + "tags": [ + "method_bank_transfer", + "paymentinstrument.method_bank_transfer" + ], + "title": "PaymentInstrument.METHOD_BANK_TRANSFER" + }, + { + "description": "Represents a 'bill me later' type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_BML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BML", + "sections": [ + { + "body": "Represents a 'bill me later' type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_BML: string", + "source": "script-api", + "tags": [ + "method_bml", + "paymentinstrument.method_bml" + ], + "title": "PaymentInstrument.METHOD_BML" + }, + { + "description": "Represents a 'bill me later' type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_BML", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_BML", + "sections": [ + { + "body": "Represents a 'bill me later' type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_BML: string", + "source": "script-api", + "tags": [ + "method_bml", + "paymentinstrument.method_bml" + ], + "title": "PaymentInstrument.METHOD_BML" + }, + { + "description": "Represents a credit card type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_CREDIT_CARD", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_CREDIT_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_CREDIT_CARD: string", + "source": "script-api", + "tags": [ + "method_credit_card", + "paymentinstrument.method_credit_card" + ], + "title": "PaymentInstrument.METHOD_CREDIT_CARD" + }, + { + "description": "Represents a credit card type of payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_CREDIT_CARD", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_CREDIT_CARD", + "sections": [ + { + "body": "Represents a credit card type of payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_CREDIT_CARD: string", + "source": "script-api", + "tags": [ + "method_credit_card", + "paymentinstrument.method_credit_card" + ], + "title": "PaymentInstrument.METHOD_CREDIT_CARD" + }, + { + "description": "Represents an Android Pay payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_ANDROID_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_ANDROID_PAY", + "sections": [ + { + "body": "Represents an Android Pay payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_DW_ANDROID_PAY: string", + "source": "script-api", + "tags": [ + "method_dw_android_pay", + "paymentinstrument.method_dw_android_pay" + ], + "title": "PaymentInstrument.METHOD_DW_ANDROID_PAY" + }, + { + "description": "Represents an Android Pay payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_ANDROID_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_ANDROID_PAY", + "sections": [ + { + "body": "Represents an Android Pay payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_DW_ANDROID_PAY: string", + "source": "script-api", + "tags": [ + "method_dw_android_pay", + "paymentinstrument.method_dw_android_pay" + ], + "title": "PaymentInstrument.METHOD_DW_ANDROID_PAY" + }, + { + "description": "Represents an Apple Pay payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_APPLE_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_APPLE_PAY", + "sections": [ + { + "body": "Represents an Apple Pay payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_DW_APPLE_PAY: string", + "source": "script-api", + "tags": [ + "method_dw_apple_pay", + "paymentinstrument.method_dw_apple_pay" + ], + "title": "PaymentInstrument.METHOD_DW_APPLE_PAY" + }, + { + "description": "Represents an Apple Pay payment.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_DW_APPLE_PAY", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_DW_APPLE_PAY", + "sections": [ + { + "body": "Represents an Apple Pay payment.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_DW_APPLE_PAY: string", + "source": "script-api", + "tags": [ + "method_dw_apple_pay", + "paymentinstrument.method_dw_apple_pay" + ], + "title": "PaymentInstrument.METHOD_DW_APPLE_PAY" + }, + { + "description": "Represents a gift certificate.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_GIFT_CERTIFICATE", + "sections": [ + { + "body": "Represents a gift certificate.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_GIFT_CERTIFICATE: string", + "source": "script-api", + "tags": [ + "method_gift_certificate", + "paymentinstrument.method_gift_certificate" + ], + "title": "PaymentInstrument.METHOD_GIFT_CERTIFICATE" + }, + { + "description": "Represents a gift certificate.", + "id": "script-api:dw/order/PaymentInstrument#METHOD_GIFT_CERTIFICATE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.METHOD_GIFT_CERTIFICATE", + "sections": [ + { + "body": "Represents a gift certificate.", + "heading": "Description" + } + ], + "signature": "static readonly METHOD_GIFT_CERTIFICATE: string", + "source": "script-api", + "tags": [ + "method_gift_certificate", + "paymentinstrument.method_gift_certificate" + ], + "title": "PaymentInstrument.METHOD_GIFT_CERTIFICATE" + }, + { + "description": "Returns the driver's license number associated with the bank account if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicense", + "sections": [ + { + "body": "Returns the driver's license number associated with the bank account if the\ncalling context meets the following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a storefront request, and the current customer is identical\nto the customer related to the basket, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked driver's license number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "bankAccountDriversLicense: string", + "source": "script-api", + "tags": [ + "bankaccountdriverslicense", + "paymentinstrument.bankaccountdriverslicense" + ], + "title": "PaymentInstrument.bankAccountDriversLicense" + }, + { + "description": "Returns the last 4 characters of the decrypted driver's license number of the bank account associated with this PaymentInstrument.", + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicenseLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicenseLastDigits", + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted driver's license number of\nthe bank account associated with this PaymentInstrument.\n\nIf the number is empty or null\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountDriversLicenseLastDigits: string | null", + "source": "script-api", + "tags": [ + "bankaccountdriverslicenselastdigits", + "paymentinstrument.bankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.bankAccountDriversLicenseLastDigits" + }, + { + "description": "Returns the driver's license state code associated with a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#bankAccountDriversLicenseStateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountDriversLicenseStateCode", + "sections": [ + { + "body": "Returns the driver's license state code associated with a bank account payment instrument.\nReturns null for other payment methods.", + "heading": "Description" + } + ], + "signature": "bankAccountDriversLicenseStateCode: string", + "source": "script-api", + "tags": [ + "bankaccountdriverslicensestatecode", + "paymentinstrument.bankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.bankAccountDriversLicenseStateCode" + }, + { + "description": "Returns the full name of the holder of a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#bankAccountHolder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountHolder", + "sections": [ + { + "body": "Returns the full name of the holder of a bank account payment instrument.\nReturns null for other payment methods.", + "heading": "Description" + } + ], + "signature": "bankAccountHolder: string", + "source": "script-api", + "tags": [ + "bankaccountholder", + "paymentinstrument.bankaccountholder" + ], + "title": "PaymentInstrument.bankAccountHolder" + }, + { + "description": "Returns the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#bankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountNumber", + "sections": [ + { + "body": "Returns the bank account number if the calling context meets\nthe following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a storefront request, and the current customer is identical\nto the customer related to the basket, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked bank account number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "bankAccountNumber: string", + "source": "script-api", + "tags": [ + "bankaccountnumber", + "paymentinstrument.bankaccountnumber" + ], + "title": "PaymentInstrument.bankAccountNumber" + }, + { + "description": "Returns the last 4 characters of the decrypted bank account number.", + "id": "script-api:dw/order/PaymentInstrument#bankAccountNumberLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankAccountNumberLastDigits", + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted bank account number.\n\nIf the number is empty or null,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly bankAccountNumberLastDigits: string | null", + "source": "script-api", + "tags": [ + "bankaccountnumberlastdigits", + "paymentinstrument.bankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.bankAccountNumberLastDigits" + }, + { + "description": "Returns the bank routing number of a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#bankRoutingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.bankRoutingNumber", + "sections": [ + { + "body": "Returns the bank routing number of a bank account payment instrument.\nReturns null for other payment methods.\n\nIf account information has been masked due to the data retention security\npolicy for the site, the return value is fully masked.", + "heading": "Description" + } + ], + "signature": "bankRoutingNumber: string", + "source": "script-api", + "tags": [ + "bankroutingnumber", + "paymentinstrument.bankroutingnumber" + ], + "title": "PaymentInstrument.bankRoutingNumber" + }, + { + "description": "Returns the month of the year in which the credit card expires (1-12).", + "id": "script-api:dw/order/PaymentInstrument#creditCardExpirationMonth", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpirationMonth", + "sections": [ + { + "body": "Returns the month of the year in which the credit card\nexpires (1-12).", + "heading": "Description" + } + ], + "signature": "creditCardExpirationMonth: number", + "source": "script-api", + "tags": [ + "creditcardexpirationmonth", + "paymentinstrument.creditcardexpirationmonth" + ], + "title": "PaymentInstrument.creditCardExpirationMonth" + }, + { + "description": "Returns the year in which the credit card expires, such as '2004'.", + "id": "script-api:dw/order/PaymentInstrument#creditCardExpirationYear", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpirationYear", + "sections": [ + { + "body": "Returns the year in which the credit card\nexpires, such as '2004'.", + "heading": "Description" + } + ], + "signature": "creditCardExpirationYear: number", + "source": "script-api", + "tags": [ + "creditcardexpirationyear", + "paymentinstrument.creditcardexpirationyear" + ], + "title": "PaymentInstrument.creditCardExpirationYear" + }, + { + "description": "Returns true if this payment instrument represents an expired credit card. This check is only logical if the credit card expiration month and year are set. If either of these attributes are not set, then this method always returns false.", + "id": "script-api:dw/order/PaymentInstrument#creditCardExpired", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardExpired", + "sections": [ + { + "body": "Returns true if this payment instrument represents an expired credit\ncard. This check is only logical if the credit card expiration month and\nyear are set. If either of these attributes are not set, then this method\nalways returns false.", + "heading": "Description" + } + ], + "signature": "readonly creditCardExpired: boolean", + "source": "script-api", + "tags": [ + "creditcardexpired", + "paymentinstrument.creditcardexpired" + ], + "title": "PaymentInstrument.creditCardExpired" + }, + { + "description": "Returns the name of the credit card owner.", + "id": "script-api:dw/order/PaymentInstrument#creditCardHolder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardHolder", + "sections": [ + { + "body": "Returns the name of the credit card owner.", + "heading": "Description" + } + ], + "signature": "creditCardHolder: string", + "source": "script-api", + "tags": [ + "creditcardholder", + "paymentinstrument.creditcardholder" + ], + "title": "PaymentInstrument.creditCardHolder" + }, + { + "description": "Returns the credit card issue number. This attribute is only used by specific credit/debit card processors such as Solo and Switch in the UK.", + "id": "script-api:dw/order/PaymentInstrument#creditCardIssueNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardIssueNumber", + "sections": [ + { + "body": "Returns the credit card issue number. This attribute is only used by\nspecific credit/debit card processors such as Solo and Switch in the UK.", + "heading": "Description" + } + ], + "signature": "creditCardIssueNumber: string", + "source": "script-api", + "tags": [ + "creditcardissuenumber", + "paymentinstrument.creditcardissuenumber" + ], + "title": "PaymentInstrument.creditCardIssueNumber" + }, + { + "description": "Returns the decrypted credit card number if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#creditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardNumber", + "sections": [ + { + "body": "Returns the decrypted credit card number if the calling context meets\nthe following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrument in the context of a storefront request, and\nthe current authenticated customer is referenced by the basket or order, and\nthe current protocol is HTTPS.\n\n-\nIf the customer is anonymous, and the customer is referenced by the order, and the protocol is secure and\nthe order status is CREATED.\n\n-\nIf the instance is a OrderPaymentInstrument, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrument, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked credit card number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "creditCardNumber: string", + "source": "script-api", + "tags": [ + "creditcardnumber", + "paymentinstrument.creditcardnumber" + ], + "title": "PaymentInstrument.creditCardNumber" + }, + { + "description": "Returns the last 4 characters of the decrypted credit card number.", + "id": "script-api:dw/order/PaymentInstrument#creditCardNumberLastDigits", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardNumberLastDigits", + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted credit card number.\n\nIf the number is empty or null\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly creditCardNumberLastDigits: string | null", + "source": "script-api", + "tags": [ + "creditcardnumberlastdigits", + "paymentinstrument.creditcardnumberlastdigits" + ], + "title": "PaymentInstrument.creditCardNumberLastDigits" + }, + { + "description": "Secure credit card data can be replaced by a token by utilizing a tokenization provider, which securely stores the credit card data using the token as a key. The stored data can later reused by including the token in a request. In this way credit card processes such as authorization and capture can be implemented without being responsible for persisting the credit card data.", + "id": "script-api:dw/order/PaymentInstrument#creditCardToken", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardToken", + "sections": [ + { + "body": "Secure credit card data can be replaced by a token by utilizing a\ntokenization provider, which securely stores the credit card data using\nthe token as a key. The stored data can later reused by including the\ntoken in a request. In this way credit card processes such as\nauthorization and capture can be implemented without being responsible\nfor persisting the credit card data.", + "heading": "Description" + } + ], + "signature": "creditCardToken: string", + "source": "script-api", + "tags": [ + "creditcardtoken", + "paymentinstrument.creditcardtoken" + ], + "title": "PaymentInstrument.creditCardToken" + }, + { + "description": "Returns the type of the credit card.", + "id": "script-api:dw/order/PaymentInstrument#creditCardType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardType", + "sections": [ + { + "body": "Returns the type of the credit card.", + "heading": "Description" + } + ], + "signature": "creditCardType: string", + "source": "script-api", + "tags": [ + "creditcardtype", + "paymentinstrument.creditcardtype" + ], + "title": "PaymentInstrument.creditCardType" + }, + { + "description": "Returns the month of the year in which the credit card became valid (1-12). This attribute is not used by all credit card types.", + "id": "script-api:dw/order/PaymentInstrument#creditCardValidFromMonth", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardValidFromMonth", + "sections": [ + { + "body": "Returns the month of the year in which the credit card became\nvalid (1-12). This attribute is not used by all credit card types.", + "heading": "Description" + } + ], + "signature": "creditCardValidFromMonth: number", + "source": "script-api", + "tags": [ + "creditcardvalidfrommonth", + "paymentinstrument.creditcardvalidfrommonth" + ], + "title": "PaymentInstrument.creditCardValidFromMonth" + }, + { + "description": "Returns the year in which the credit card became valid, such as '2001'. This attribute is not used by all credit card types.", + "id": "script-api:dw/order/PaymentInstrument#creditCardValidFromYear", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.creditCardValidFromYear", + "sections": [ + { + "body": "Returns the year in which the credit card became valid, such as '2001'.\nThis attribute is not used by all credit card types.", + "heading": "Description" + } + ], + "signature": "creditCardValidFromYear: number", + "source": "script-api", + "tags": [ + "creditcardvalidfromyear", + "paymentinstrument.creditcardvalidfromyear" + ], + "title": "PaymentInstrument.creditCardValidFromYear" + }, + { + "description": "Returns the driver's license number associated with the bank account if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicense", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the driver's license number associated with the bank account if the\ncalling context meets the following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a storefront request, and the current customer is identical\nto the customer related to the basket, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked driver's license number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicense(): string", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicense", + "paymentinstrument.getbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getBankAccountDriversLicense" + }, + { + "description": "Returns the last 4 characters of the decrypted driver's license number of the bank account associated with this PaymentInstrument.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted driver's license number of\nthe bank account associated with this PaymentInstrument.\n\nIf the number is empty or null\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicenseLastDigits(): string | null", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicenselastdigits", + "paymentinstrument.getbankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseLastDigits" + }, + { + "description": "Returns the last specified number of characters of the decrypted driver's license number of the bank account associated with this PaymentInstrument.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseLastDigits", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "count", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last specified number of characters of the decrypted driver's license number of\nthe bank account associated with this PaymentInstrument.\n\nIf the number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `count` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicenseLastDigits(count: number): string | null", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicenselastdigits", + "paymentinstrument.getbankaccountdriverslicenselastdigits" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseLastDigits" + }, + { + "description": "Returns the driver's license state code associated with a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountDriversLicenseStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountDriversLicenseStateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the driver's license state code associated with a bank account payment instrument.\nReturns null for other payment methods.", + "heading": "Description" + } + ], + "signature": "getBankAccountDriversLicenseStateCode(): string", + "source": "script-api", + "tags": [ + "getbankaccountdriverslicensestatecode", + "paymentinstrument.getbankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.getBankAccountDriversLicenseStateCode" + }, + { + "description": "Returns the full name of the holder of a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountHolder", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the full name of the holder of a bank account payment instrument.\nReturns null for other payment methods.", + "heading": "Description" + } + ], + "signature": "getBankAccountHolder(): string", + "source": "script-api", + "tags": [ + "getbankaccountholder", + "paymentinstrument.getbankaccountholder" + ], + "title": "PaymentInstrument.getBankAccountHolder" + }, + { + "description": "Returns the bank account number if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the bank account number if the calling context meets\nthe following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a storefront request, and the current customer is identical\nto the customer related to the basket, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrumentInfo, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked bank account number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "getBankAccountNumber(): string", + "source": "script-api", + "tags": [ + "getbankaccountnumber", + "paymentinstrument.getbankaccountnumber" + ], + "title": "PaymentInstrument.getBankAccountNumber" + }, + { + "description": "Returns the last 4 characters of the decrypted bank account number.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumberLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted bank account number.\n\nIf the number is empty or null,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getBankAccountNumberLastDigits(): string | null", + "source": "script-api", + "tags": [ + "getbankaccountnumberlastdigits", + "paymentinstrument.getbankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.getBankAccountNumberLastDigits" + }, + { + "description": "Returns the last specified number of characters of the decrypted bank account card number.", + "id": "script-api:dw/order/PaymentInstrument#getBankAccountNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "count", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankAccountNumberLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last specified number of characters of the decrypted bank account card number.\n\nIf the number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `count` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getBankAccountNumberLastDigits(count: number): string | null", + "source": "script-api", + "tags": [ + "getbankaccountnumberlastdigits", + "paymentinstrument.getbankaccountnumberlastdigits" + ], + "title": "PaymentInstrument.getBankAccountNumberLastDigits" + }, + { + "description": "Returns the bank routing number of a bank account payment instrument. Returns null for other payment methods.", + "id": "script-api:dw/order/PaymentInstrument#getBankRoutingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getBankRoutingNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the bank routing number of a bank account payment instrument.\nReturns null for other payment methods.\n\nIf account information has been masked due to the data retention security\npolicy for the site, the return value is fully masked.", + "heading": "Description" + } + ], + "signature": "getBankRoutingNumber(): string", + "source": "script-api", + "tags": [ + "getbankroutingnumber", + "paymentinstrument.getbankroutingnumber" + ], + "title": "PaymentInstrument.getBankRoutingNumber" + }, + { + "description": "Returns the month of the year in which the credit card expires (1-12).", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardExpirationMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardExpirationMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the month of the year in which the credit card\nexpires (1-12).", + "heading": "Description" + } + ], + "signature": "getCreditCardExpirationMonth(): number", + "source": "script-api", + "tags": [ + "getcreditcardexpirationmonth", + "paymentinstrument.getcreditcardexpirationmonth" + ], + "title": "PaymentInstrument.getCreditCardExpirationMonth" + }, + { + "description": "Returns the year in which the credit card expires, such as '2004'.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardExpirationYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardExpirationYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the year in which the credit card\nexpires, such as '2004'.", + "heading": "Description" + } + ], + "signature": "getCreditCardExpirationYear(): number", + "source": "script-api", + "tags": [ + "getcreditcardexpirationyear", + "paymentinstrument.getcreditcardexpirationyear" + ], + "title": "PaymentInstrument.getCreditCardExpirationYear" + }, + { + "description": "Returns the name of the credit card owner.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardHolder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardHolder", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the credit card owner.", + "heading": "Description" + } + ], + "signature": "getCreditCardHolder(): string", + "source": "script-api", + "tags": [ + "getcreditcardholder", + "paymentinstrument.getcreditcardholder" + ], + "title": "PaymentInstrument.getCreditCardHolder" + }, + { + "description": "Returns the credit card issue number. This attribute is only used by specific credit/debit card processors such as Solo and Switch in the UK.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardIssueNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardIssueNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the credit card issue number. This attribute is only used by\nspecific credit/debit card processors such as Solo and Switch in the UK.", + "heading": "Description" + } + ], + "signature": "getCreditCardIssueNumber(): string", + "source": "script-api", + "tags": [ + "getcreditcardissuenumber", + "paymentinstrument.getcreditcardissuenumber" + ], + "title": "PaymentInstrument.getCreditCardIssueNumber" + }, + { + "description": "Returns the decrypted credit card number if the calling context meets the following criteria:", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the decrypted credit card number if the calling context meets\nthe following criteria:\n\n-\nIf the instance is a CustomerPaymentInstrument, and\nwe are in the context of a storefront request, and the current customer\nis registered and authenticated, and the payment instrument is associated\nto the profile of the current customer, and the current protocol is HTTPS\n\n-\nIf the instance is a OrderPaymentInstrument in the context of a storefront request, and\nthe current authenticated customer is referenced by the basket or order, and\nthe current protocol is HTTPS.\n\n-\nIf the customer is anonymous, and the customer is referenced by the order, and the protocol is secure and\nthe order status is CREATED.\n\n-\nIf the instance is a OrderPaymentInstrument, and we are in\nthe context of a business manager request, and the current user has the\npermission MANAGE_ORDERS\n\n-\nIf the instance is a OrderPaymentInstrument, and the account information\nhas not been masked as a result of the data retention security policy\nfor the site\n\nOtherwise, the method returns the masked credit card number. If a basket is reopened with\nOrderMgr.failOrder, it always masks sensitive information\nbecause during order creation, basket payment information is permanently masked.", + "heading": "Description" + } + ], + "signature": "getCreditCardNumber(): string", + "source": "script-api", + "tags": [ + "getcreditcardnumber", + "paymentinstrument.getcreditcardnumber" + ], + "title": "PaymentInstrument.getCreditCardNumber" + }, + { + "description": "Returns the last 4 characters of the decrypted credit card number.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumberLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last 4 characters of the decrypted credit card number.\n\nIf the number is empty or null\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getCreditCardNumberLastDigits(): string | null", + "source": "script-api", + "tags": [ + "getcreditcardnumberlastdigits", + "paymentinstrument.getcreditcardnumberlastdigits" + ], + "title": "PaymentInstrument.getCreditCardNumberLastDigits" + }, + { + "description": "Returns the last specified number of characters of the decrypted credit card number.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardNumberLastDigits", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "count", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardNumberLastDigits", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the last specified number of characters of the decrypted credit card number.\n\nIf the number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `count` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getCreditCardNumberLastDigits(count: number): string | null", + "source": "script-api", + "tags": [ + "getcreditcardnumberlastdigits", + "paymentinstrument.getcreditcardnumberlastdigits" + ], + "title": "PaymentInstrument.getCreditCardNumberLastDigits" + }, + { + "description": "Secure credit card data can be replaced by a token by utilizing a tokenization provider, which securely stores the credit card data using the token as a key. The stored data can later reused by including the token in a request. In this way credit card processes such as authorization and capture can be implemented without being responsible for persisting the credit card data.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardToken", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardToken", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Secure credit card data can be replaced by a token by utilizing a\ntokenization provider, which securely stores the credit card data using\nthe token as a key. The stored data can later reused by including the\ntoken in a request. In this way credit card processes such as\nauthorization and capture can be implemented without being responsible\nfor persisting the credit card data.", + "heading": "Description" + } + ], + "signature": "getCreditCardToken(): string", + "source": "script-api", + "tags": [ + "getcreditcardtoken", + "paymentinstrument.getcreditcardtoken" + ], + "title": "PaymentInstrument.getCreditCardToken" + }, + { + "description": "Returns the type of the credit card.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the credit card.", + "heading": "Description" + } + ], + "signature": "getCreditCardType(): string", + "source": "script-api", + "tags": [ + "getcreditcardtype", + "paymentinstrument.getcreditcardtype" + ], + "title": "PaymentInstrument.getCreditCardType" + }, + { + "description": "Returns the month of the year in which the credit card became valid (1-12). This attribute is not used by all credit card types.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardValidFromMonth", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardValidFromMonth", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the month of the year in which the credit card became\nvalid (1-12). This attribute is not used by all credit card types.", + "heading": "Description" + } + ], + "signature": "getCreditCardValidFromMonth(): number", + "source": "script-api", + "tags": [ + "getcreditcardvalidfrommonth", + "paymentinstrument.getcreditcardvalidfrommonth" + ], + "title": "PaymentInstrument.getCreditCardValidFromMonth" + }, + { + "description": "Returns the year in which the credit card became valid, such as '2001'. This attribute is not used by all credit card types.", + "id": "script-api:dw/order/PaymentInstrument#getCreditCardValidFromYear", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getCreditCardValidFromYear", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the year in which the credit card became valid, such as '2001'.\nThis attribute is not used by all credit card types.", + "heading": "Description" + } + ], + "signature": "getCreditCardValidFromYear(): number", + "source": "script-api", + "tags": [ + "getcreditcardvalidfromyear", + "paymentinstrument.getcreditcardvalidfromyear" + ], + "title": "PaymentInstrument.getCreditCardValidFromYear" + }, + { + "description": "Encrypts the driver's license number of the bank account of this object with the given algorithm and the given public key. Returned is the Base64 encoded representation of the result.", + "id": "script-api:dw/order/PaymentInstrument#getEncryptedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "publicKey", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedBankAccountDriversLicense", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypts the driver's license number of the bank account of this object with the given algorithm and the given\npublic key. Returned is the Base64 encoded representation of the result.\n\nSee also dw.crypto.Cipher.encrypt_2 on how to generate RSA key\npairs.\n\nIf account information has been masked due to the data retention security policy for the site, the returned value\nis the Base64 encoded representation of the encrypted form of the masked number.", + "heading": "Description" + } + ], + "signature": "getEncryptedBankAccountDriversLicense(algorithm: string, publicKey: string): string", + "source": "script-api", + "tags": [ + "getencryptedbankaccountdriverslicense", + "paymentinstrument.getencryptedbankaccountdriverslicense" + ], + "throws": [ + { + "description": "If algorithm is not a valid known algorithm.", + "type": "IllegalArgumentException" + }, + { + "description": "If publicKey is a null, empty or blank string.", + "type": "IllegalArgumentException" + } + ], + "title": "PaymentInstrument.getEncryptedBankAccountDriversLicense" + }, + { + "description": "Encrypts the bank account number of this object with the given algorithm and the given public key. Returned is the Base64 encoded representation of the result.", + "id": "script-api:dw/order/PaymentInstrument#getEncryptedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "publicKey", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedBankAccountNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypts the bank account number of this object with the given algorithm and the given public key. Returned is\nthe Base64 encoded representation of the result.\n\nIf account information has been masked due to the data retention security policy for the site, the returned value\nis the Base64 encoded representation of the encrypted form of the masked number.", + "heading": "Description" + } + ], + "signature": "getEncryptedBankAccountNumber(algorithm: string, publicKey: string): string", + "source": "script-api", + "tags": [ + "getencryptedbankaccountnumber", + "paymentinstrument.getencryptedbankaccountnumber" + ], + "throws": [ + { + "description": "If algorithm is not a valid known algorithm.", + "type": "IllegalArgumentException" + }, + { + "description": "If publicKey is a null, empty or blank string.", + "type": "IllegalArgumentException" + } + ], + "title": "PaymentInstrument.getEncryptedBankAccountNumber" + }, + { + "deprecated": { + "message": "Please use getEncryptedCreditCardNumber instead." + }, + "description": "Encrypts the credit card number of this object with the given algorithm and the given public key. Returned is the Base64 encoded representation of the result.", + "id": "script-api:dw/order/PaymentInstrument#getEncryptedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "publicKey", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypts the credit card number of this object with the given algorithm and the given public key. Returned is the\nBase64 encoded representation of the result.\n\nSee also dw.crypto.Cipher.encrypt_2 on how to generate RSA key\npairs.\n\nIf account information has been masked due to the data retention security policy for the site, the returned value\nis the Base64 encoded representation of the encrypted form of the masked number.", + "heading": "Description" + } + ], + "signature": "getEncryptedCreditCardNumber(algorithm: string, publicKey: string): string", + "source": "script-api", + "tags": [ + "getencryptedcreditcardnumber", + "paymentinstrument.getencryptedcreditcardnumber" + ], + "throws": [ + { + "description": "If algorithm is not a valid known algorithm.", + "type": "IllegalArgumentException" + }, + { + "description": "If publicKey is a null, empty or blank string.", + "type": "IllegalArgumentException" + } + ], + "title": "PaymentInstrument.getEncryptedCreditCardNumber" + }, + { + "description": "Encrypts the credit card number of this object with the given algorithm and the public key taken from a certificate in the keystore. Returned is the Base64 encoded representation of the result.", + "id": "script-api:dw/order/PaymentInstrument#getEncryptedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "certificateRef", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getEncryptedCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypts the credit card number of this object with the given algorithm and the public key taken from a\ncertificate in the keystore. Returned is the Base64 encoded representation of the result.\n\nSee also dw.crypto.Cipher.encrypt_2 on how to generate RSA\nkey pairs.\n\nIf account information has been masked due to the data retention security policy for the site, the returned value\nis the Base64 encoded representation of the encrypted form of the masked number.", + "heading": "Description" + } + ], + "signature": "getEncryptedCreditCardNumber(algorithm: string, certificateRef: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencryptedcreditcardnumber", + "paymentinstrument.getencryptedcreditcardnumber" + ], + "throws": [ + { + "description": "If algorithm is not a valid known algorithm.", + "type": "IllegalArgumentException" + }, + { + "description": "If certificateRef is null or could not be found.", + "type": "IllegalArgumentException" + } + ], + "title": "PaymentInstrument.getEncryptedCreditCardNumber" + }, + { + "description": "Returns the Gift Certificate code for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#getGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getGiftCertificateCode", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate code for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateCode(): string | null", + "source": "script-api", + "tags": [ + "getgiftcertificatecode", + "paymentinstrument.getgiftcertificatecode" + ], + "title": "PaymentInstrument.getGiftCertificateCode" + }, + { + "deprecated": { + "message": "Use getGiftCertificateCode" + }, + "description": "Returns the Gift Certificate ID for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#getGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getGiftCertificateID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the Gift Certificate ID for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateID(): string | null", + "source": "script-api", + "tags": [ + "getgiftcertificateid", + "paymentinstrument.getgiftcertificateid" + ], + "title": "PaymentInstrument.getGiftCertificateID" + }, + { + "description": "Returns the decrypted driver's license number of the bank account with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountDriversLicense", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the decrypted driver's license number of the bank account with\nall but the last 4 characters replaced with a '*' character.\n\nIf the driver's license number is empty,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getMaskedBankAccountDriversLicense(): string", + "source": "script-api", + "tags": [ + "getmaskedbankaccountdriverslicense", + "paymentinstrument.getmaskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getMaskedBankAccountDriversLicense" + }, + { + "description": "Returns the decrypted driver's license number of the bank account with all but the specified number characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ignore", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountDriversLicense", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the decrypted driver's license number of the bank account with\nall but the specified number characters replaced with a '*' character.\n\nIf the driver's license number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `ignore` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getMaskedBankAccountDriversLicense(ignore: number): string | null", + "source": "script-api", + "tags": [ + "getmaskedbankaccountdriverslicense", + "paymentinstrument.getmaskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.getMaskedBankAccountDriversLicense" + }, + { + "description": "Returns the decrypted bank account number with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the decrypted bank account number with\nall but the last 4 characters replaced with a '*' character.\n\nIf the number is empty (i.e. \"\" or null),\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getMaskedBankAccountNumber(): string | null", + "source": "script-api", + "tags": [ + "getmaskedbankaccountnumber", + "paymentinstrument.getmaskedbankaccountnumber" + ], + "title": "PaymentInstrument.getMaskedBankAccountNumber" + }, + { + "description": "Returns the decrypted bank account number with all but the specified number characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ignore", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedBankAccountNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the decrypted bank account number with\nall but the specified number characters replaced with a '*' character.\n\nIf the card number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `ignore` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getMaskedBankAccountNumber(ignore: number): string | null", + "source": "script-api", + "tags": [ + "getmaskedbankaccountnumber", + "paymentinstrument.getmaskedbankaccountnumber" + ], + "title": "PaymentInstrument.getMaskedBankAccountNumber" + }, + { + "description": "Returns the decrypted credit card number with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedCreditCardNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the decrypted credit card number with\nall but the last 4 characters replaced with a '*' character.\n\nIf the number is empty,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "getMaskedCreditCardNumber(): string", + "source": "script-api", + "tags": [ + "getmaskedcreditcardnumber", + "paymentinstrument.getmaskedcreditcardnumber" + ], + "title": "PaymentInstrument.getMaskedCreditCardNumber" + }, + { + "description": "Returns the decrypted credit card number with all but the specified number characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ignore", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedCreditCardNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the decrypted credit card number with\nall but the specified number characters replaced with a '*' character.\n\nIf the card number is empty (i.e. \"\" or null),\nit will be returned without an exception.\n\nNote that `ignore` is limited to 4 in an unsecure environment,\nand if account information for this payment instrument has been masked\ndue to the data retention security policy for the site.", + "heading": "Description" + } + ], + "signature": "getMaskedCreditCardNumber(ignore: number): string | null", + "source": "script-api", + "tags": [ + "getmaskedcreditcardnumber", + "paymentinstrument.getmaskedcreditcardnumber" + ], + "title": "PaymentInstrument.getMaskedCreditCardNumber" + }, + { + "description": "Returns the masked gift certificate code with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedGiftCertificateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the last 4 characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "getMaskedGiftCertificateCode(): string", + "source": "script-api", + "tags": [ + "getmaskedgiftcertificatecode", + "paymentinstrument.getmaskedgiftcertificatecode" + ], + "title": "PaymentInstrument.getMaskedGiftCertificateCode" + }, + { + "description": "Returns the masked gift certificate code with all but the specified number of characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#getMaskedGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "ignore", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getMaskedGiftCertificateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the specified number of characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "getMaskedGiftCertificateCode(ignore: number): string", + "source": "script-api", + "tags": [ + "getmaskedgiftcertificatecode", + "paymentinstrument.getmaskedgiftcertificatecode" + ], + "throws": [ + { + "description": "if ignore is negative.", + "type": "IllegalArgumentException" + } + ], + "title": "PaymentInstrument.getMaskedGiftCertificateCode" + }, + { + "description": "Returns the identifier of the payment method represented by this payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.getPaymentMethod", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the identifier of the payment method represented by this\npayment instrument.", + "heading": "Description" + } + ], + "signature": "getPaymentMethod(): string", + "source": "script-api", + "tags": [ + "getpaymentmethod", + "paymentinstrument.getpaymentmethod" + ], + "title": "PaymentInstrument.getPaymentMethod" + }, + { + "description": "Returns the Gift Certificate code for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#giftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.giftCertificateCode", + "sections": [ + { + "body": "Returns the Gift Certificate code for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "giftCertificateCode: string | null", + "source": "script-api", + "tags": [ + "giftcertificatecode", + "paymentinstrument.giftcertificatecode" + ], + "title": "PaymentInstrument.giftCertificateCode" + }, + { + "deprecated": { + "message": "Use getGiftCertificateCode" + }, + "description": "Returns the Gift Certificate ID for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#giftCertificateID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.giftCertificateID", + "sections": [ + { + "body": "Returns the Gift Certificate ID for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "giftCertificateID: string | null", + "source": "script-api", + "tags": [ + "giftcertificateid", + "paymentinstrument.giftcertificateid" + ], + "title": "PaymentInstrument.giftCertificateID" + }, + { + "description": "Returns true if this payment instrument represents an expired credit card. This check is only logical if the credit card expiration month and year are set. If either of these attributes are not set, then this method always returns false.", + "id": "script-api:dw/order/PaymentInstrument#isCreditCardExpired", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.isCreditCardExpired", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this payment instrument represents an expired credit\ncard. This check is only logical if the credit card expiration month and\nyear are set. If either of these attributes are not set, then this method\nalways returns false.", + "heading": "Description" + } + ], + "signature": "isCreditCardExpired(): boolean", + "source": "script-api", + "tags": [ + "iscreditcardexpired", + "paymentinstrument.iscreditcardexpired" + ], + "title": "PaymentInstrument.isCreditCardExpired" + }, + { + "description": "Returns `true` if the account information for this Payment Instrument has been permanently masked as a result of the data retention security policy for the site or a creditcard tokenization, and `false` otherwise.", + "id": "script-api:dw/order/PaymentInstrument#isPermanentlyMasked", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.isPermanentlyMasked", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns `true` if the account information for this Payment Instrument\nhas been permanently masked as a result of the data retention security policy\nfor the site or a creditcard tokenization, and `false` otherwise.\n\nWhen account information is masked only the last 4 digits of the credit card\nor bank account number are recoverable. The bank account driver's license number\nand bank routing number are completely masked.", + "heading": "Description" + } + ], + "signature": "isPermanentlyMasked(): boolean", + "source": "script-api", + "tags": [ + "ispermanentlymasked", + "paymentinstrument.ispermanentlymasked" + ], + "title": "PaymentInstrument.isPermanentlyMasked" + }, + { + "description": "Returns the decrypted driver's license number of the bank account with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#maskedBankAccountDriversLicense", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedBankAccountDriversLicense", + "sections": [ + { + "body": "Returns the decrypted driver's license number of the bank account with\nall but the last 4 characters replaced with a '*' character.\n\nIf the driver's license number is empty,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly maskedBankAccountDriversLicense: string", + "source": "script-api", + "tags": [ + "maskedbankaccountdriverslicense", + "paymentinstrument.maskedbankaccountdriverslicense" + ], + "title": "PaymentInstrument.maskedBankAccountDriversLicense" + }, + { + "description": "Returns the decrypted bank account number with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#maskedBankAccountNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedBankAccountNumber", + "sections": [ + { + "body": "Returns the decrypted bank account number with\nall but the last 4 characters replaced with a '*' character.\n\nIf the number is empty (i.e. \"\" or null),\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly maskedBankAccountNumber: string | null", + "source": "script-api", + "tags": [ + "maskedbankaccountnumber", + "paymentinstrument.maskedbankaccountnumber" + ], + "title": "PaymentInstrument.maskedBankAccountNumber" + }, + { + "description": "Returns the decrypted credit card number with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#maskedCreditCardNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedCreditCardNumber", + "sections": [ + { + "body": "Returns the decrypted credit card number with\nall but the last 4 characters replaced with a '*' character.\n\nIf the number is empty,\nit will be returned without an exception.", + "heading": "Description" + } + ], + "signature": "readonly maskedCreditCardNumber: string", + "source": "script-api", + "tags": [ + "maskedcreditcardnumber", + "paymentinstrument.maskedcreditcardnumber" + ], + "title": "PaymentInstrument.maskedCreditCardNumber" + }, + { + "description": "Returns the masked gift certificate code with all but the last 4 characters replaced with a '*' character.", + "id": "script-api:dw/order/PaymentInstrument#maskedGiftCertificateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.maskedGiftCertificateCode", + "sections": [ + { + "body": "Returns the masked gift certificate code with\nall but the last 4 characters replaced with a '*' character.", + "heading": "Description" + } + ], + "signature": "readonly maskedGiftCertificateCode: string", + "source": "script-api", + "tags": [ + "maskedgiftcertificatecode", + "paymentinstrument.maskedgiftcertificatecode" + ], + "title": "PaymentInstrument.maskedGiftCertificateCode" + }, + { + "description": "Returns the identifier of the payment method represented by this payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#paymentMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.paymentMethod", + "sections": [ + { + "body": "Returns the identifier of the payment method represented by this\npayment instrument.", + "heading": "Description" + } + ], + "signature": "readonly paymentMethod: string", + "source": "script-api", + "tags": [ + "paymentmethod", + "paymentinstrument.paymentmethod" + ], + "title": "PaymentInstrument.paymentMethod" + }, + { + "description": "Returns `true` if the account information for this Payment Instrument has been permanently masked as a result of the data retention security policy for the site or a creditcard tokenization, and `false` otherwise.", + "id": "script-api:dw/order/PaymentInstrument#permanentlyMasked", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.permanentlyMasked", + "sections": [ + { + "body": "Returns `true` if the account information for this Payment Instrument\nhas been permanently masked as a result of the data retention security policy\nfor the site or a creditcard tokenization, and `false` otherwise.\n\nWhen account information is masked only the last 4 digits of the credit card\nor bank account number are recoverable. The bank account driver's license number\nand bank routing number are completely masked.", + "heading": "Description" + } + ], + "signature": "readonly permanentlyMasked: boolean", + "source": "script-api", + "tags": [ + "permanentlymasked", + "paymentinstrument.permanentlymasked" + ], + "title": "PaymentInstrument.permanentlyMasked" + }, + { + "description": "Set the driver's license number associated with a bank account payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#setBankAccountDriversLicense", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "license", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountDriversLicense", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the driver's license number associated with a bank account payment instrument.", + "heading": "Description" + } + ], + "signature": "setBankAccountDriversLicense(license: string): void", + "source": "script-api", + "tags": [ + "setbankaccountdriverslicense", + "paymentinstrument.setbankaccountdriverslicense" + ], + "title": "PaymentInstrument.setBankAccountDriversLicense" + }, + { + "description": "Set the driver's license state code associated with a bank account payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#setBankAccountDriversLicenseStateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "stateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountDriversLicenseStateCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the driver's license state code associated with a bank account payment instrument.", + "heading": "Description" + } + ], + "signature": "setBankAccountDriversLicenseStateCode(stateCode: string): void", + "source": "script-api", + "tags": [ + "setbankaccountdriverslicensestatecode", + "paymentinstrument.setbankaccountdriverslicensestatecode" + ], + "title": "PaymentInstrument.setBankAccountDriversLicenseStateCode" + }, + { + "description": "Set the full name of the holder of a bank account payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#setBankAccountHolder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "holder", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountHolder", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the full name of the holder of a bank account payment instrument.", + "heading": "Description" + } + ], + "signature": "setBankAccountHolder(holder: string): void", + "source": "script-api", + "tags": [ + "setbankaccountholder", + "paymentinstrument.setbankaccountholder" + ], + "title": "PaymentInstrument.setBankAccountHolder" + }, + { + "description": "Set the bank account number of a bank account payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#setBankAccountNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "accountNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankAccountNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the bank account number of a bank account payment instrument.", + "heading": "Description" + } + ], + "signature": "setBankAccountNumber(accountNumber: string): void", + "source": "script-api", + "tags": [ + "setbankaccountnumber", + "paymentinstrument.setbankaccountnumber" + ], + "title": "PaymentInstrument.setBankAccountNumber" + }, + { + "description": "Set the bank routing number of a bank account payment instrument.", + "id": "script-api:dw/order/PaymentInstrument#setBankRoutingNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "routingNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setBankRoutingNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the bank routing number of a bank account payment instrument.", + "heading": "Description" + } + ], + "signature": "setBankRoutingNumber(routingNumber: string): void", + "source": "script-api", + "tags": [ + "setbankroutingnumber", + "paymentinstrument.setbankroutingnumber" + ], + "title": "PaymentInstrument.setBankRoutingNumber" + }, + { + "description": "Sets the month of the year in which the credit card expires. Permissible values are from 1 to 12.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardExpirationMonth", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardExpirationMonth", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the month of the year in which the credit card\nexpires. Permissible values are from 1 to 12.", + "heading": "Description" + } + ], + "signature": "setCreditCardExpirationMonth(aValue: number): void", + "source": "script-api", + "tags": [ + "setcreditcardexpirationmonth", + "paymentinstrument.setcreditcardexpirationmonth" + ], + "title": "PaymentInstrument.setCreditCardExpirationMonth" + }, + { + "description": "Sets the year in which the credit card expires, such as '2004'.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardExpirationYear", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardExpirationYear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the year in which the credit card\nexpires, such as '2004'.", + "heading": "Description" + } + ], + "signature": "setCreditCardExpirationYear(aValue: number): void", + "source": "script-api", + "tags": [ + "setcreditcardexpirationyear", + "paymentinstrument.setcreditcardexpirationyear" + ], + "title": "PaymentInstrument.setCreditCardExpirationYear" + }, + { + "description": "Sets the name of the credit card owner.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardHolder", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardHolder", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the credit card owner.", + "heading": "Description" + } + ], + "signature": "setCreditCardHolder(aValue: string): void", + "source": "script-api", + "tags": [ + "setcreditcardholder", + "paymentinstrument.setcreditcardholder" + ], + "title": "PaymentInstrument.setCreditCardHolder" + }, + { + "description": "Set the credit card issue number. This attribute is only used by specific credit/debit card processors such as Solo and Switch in the UK.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardIssueNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardIssueNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the credit card issue number. This attribute is only used by\nspecific credit/debit card processors such as Solo and Switch in the UK.", + "heading": "Description" + } + ], + "signature": "setCreditCardIssueNumber(aValue: string): void", + "source": "script-api", + "tags": [ + "setcreditcardissuenumber", + "paymentinstrument.setcreditcardissuenumber" + ], + "title": "PaymentInstrument.setCreditCardIssueNumber" + }, + { + "description": "Sets the credit card number for this payment.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the credit card number for this payment.", + "heading": "Description" + } + ], + "signature": "setCreditCardNumber(aValue: string): void", + "source": "script-api", + "tags": [ + "setcreditcardnumber", + "paymentinstrument.setcreditcardnumber" + ], + "title": "PaymentInstrument.setCreditCardNumber" + }, + { + "description": "Secure credit card data can be replaced by a token by utilizing a tokenization provider, which securely stores the credit card data using the token as a key. The stored data can later reused by including the token in a request. In this way credit card processes such as authorization and capture can be implemented without being responsible for persisting the credit card data.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardToken", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "token", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardToken", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Secure credit card data can be replaced by a token by utilizing a\ntokenization provider, which securely stores the credit card data using\nthe token as a key. The stored data can later reused by including the\ntoken in a request. In this way credit card processes such as\nauthorization and capture can be implemented without being responsible\nfor persisting the credit card data.\n\nAn Exception will be thrown when the token is null or blank.\n\nWhen setting a credit card token, the account information (including the\ncreditcard number) is masked and all creditcard attributes are frozen and\nan attempt to change will be result in an exception.", + "heading": "Description" + } + ], + "signature": "setCreditCardToken(token: string): void", + "source": "script-api", + "tags": [ + "setcreditcardtoken", + "paymentinstrument.setcreditcardtoken" + ], + "title": "PaymentInstrument.setCreditCardToken" + }, + { + "description": "Sets the type of the credit card.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardType", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the type of the credit card.", + "heading": "Description" + } + ], + "signature": "setCreditCardType(aValue: string): void", + "source": "script-api", + "tags": [ + "setcreditcardtype", + "paymentinstrument.setcreditcardtype" + ], + "title": "PaymentInstrument.setCreditCardType" + }, + { + "description": "Sets the month of the year in which the credit card became valid (1-12). This attribute is not used by all credit card types", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardValidFromMonth", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardValidFromMonth", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the month of the year in which the credit card became valid (1-12).\nThis attribute is not used by all credit card types", + "heading": "Description" + } + ], + "signature": "setCreditCardValidFromMonth(aValue: number): void", + "source": "script-api", + "tags": [ + "setcreditcardvalidfrommonth", + "paymentinstrument.setcreditcardvalidfrommonth" + ], + "title": "PaymentInstrument.setCreditCardValidFromMonth" + }, + { + "description": "Sets the year in which the credit card became valid, such as '2001'. This attribute is not used by all credit card types.", + "id": "script-api:dw/order/PaymentInstrument#setCreditCardValidFromYear", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setCreditCardValidFromYear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the year in which the credit card became valid, such as '2001'.\nThis attribute is not used by all credit card types.", + "heading": "Description" + } + ], + "signature": "setCreditCardValidFromYear(aValue: number): void", + "source": "script-api", + "tags": [ + "setcreditcardvalidfromyear", + "paymentinstrument.setcreditcardvalidfromyear" + ], + "title": "PaymentInstrument.setCreditCardValidFromYear" + }, + { + "description": "Sets the Gift Certificate code for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#setGiftCertificateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setGiftCertificateCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Gift Certificate code for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "setGiftCertificateCode(giftCertificateCode: string): void", + "source": "script-api", + "tags": [ + "setgiftcertificatecode", + "paymentinstrument.setgiftcertificatecode" + ], + "title": "PaymentInstrument.setGiftCertificateCode" + }, + { + "deprecated": { + "message": "Use setGiftCertificateCode" + }, + "description": "Sets the Gift Certificate ID for this Payment Instrument.", + "id": "script-api:dw/order/PaymentInstrument#setGiftCertificateID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "giftCertificateID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentInstrument", + "qualifiedName": "dw.order.PaymentInstrument.setGiftCertificateID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the Gift Certificate ID for this Payment Instrument.", + "heading": "Description" + } + ], + "signature": "setGiftCertificateID(giftCertificateID: string): void", + "source": "script-api", + "tags": [ + "setgiftcertificateid", + "paymentinstrument.setgiftcertificateid" + ], + "title": "PaymentInstrument.setGiftCertificateID" + }, + { + "description": "The PaymentMethod class represents a logical type of payment a customer can make in the storefront. This class provides methods to access the payment method attributes, status, and (for card-based payment methods) the related payment cards.", + "id": "script-api:dw/order/PaymentMethod", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentMethod", + "sections": [ + { + "body": "The PaymentMethod class represents a logical type of payment a customer can\nmake in the storefront. This class provides methods to access the payment\nmethod attributes, status, and (for card-based payment methods) the related\npayment cards.\n\nA typical storefront presents the customer a list of payment methods that a\ncustomer can choose from after he has entered his billing address during the\ncheckout.\ndw.order.PaymentMgr.getApplicablePaymentMethods\nis used to determine the PaymentMethods that are relevant for the customer\nbased on the amount of his order, his customer groups, and his shipping\naddress.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "paymentmethod", + "dw.order.paymentmethod", + "dw/order" + ], + "title": "PaymentMethod" + }, + { + "description": "Returns the unique ID of the payment method.", + "id": "script-api:dw/order/PaymentMethod#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.ID", + "sections": [ + { + "body": "Returns the unique ID of the payment method.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "paymentmethod.id" + ], + "title": "PaymentMethod.ID" + }, + { + "description": "Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.", + "id": "script-api:dw/order/PaymentMethod#active", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.active", + "sections": [ + { + "body": "Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "readonly active: boolean", + "source": "script-api", + "tags": [ + "active", + "paymentmethod.active" + ], + "title": "PaymentMethod.active" + }, + { + "description": "Returns enabled payment cards that are assigned to this payment method, regardless of current customer, country or payment amount restrictions. The payment cards are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMethod#activePaymentCards", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.activePaymentCards", + "sections": [ + { + "body": "Returns enabled payment cards that are assigned to this payment method, regardless\nof current customer, country or payment amount restrictions.\nThe payment cards are sorted as defined in the Business Manager.", + "heading": "Description" + } + ], + "signature": "readonly activePaymentCards: List", + "source": "script-api", + "tags": [ + "activepaymentcards", + "paymentmethod.activepaymentcards" + ], + "title": "PaymentMethod.activePaymentCards" + }, + { + "description": "Returns the description of the payment method.", + "id": "script-api:dw/order/PaymentMethod#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.description", + "sections": [ + { + "body": "Returns the description of the payment method.", + "heading": "Description" + } + ], + "signature": "readonly description: MarkupText", + "source": "script-api", + "tags": [ + "description", + "paymentmethod.description" + ], + "title": "PaymentMethod.description" + }, + { + "description": "Returns enabled payment cards that are assigned to this payment method, regardless of current customer, country or payment amount restrictions. The payment cards are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMethod#getActivePaymentCards", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getActivePaymentCards", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns enabled payment cards that are assigned to this payment method, regardless\nof current customer, country or payment amount restrictions.\nThe payment cards are sorted as defined in the Business Manager.", + "heading": "Description" + } + ], + "signature": "getActivePaymentCards(): List", + "source": "script-api", + "tags": [ + "getactivepaymentcards", + "paymentmethod.getactivepaymentcards" + ], + "title": "PaymentMethod.getActivePaymentCards" + }, + { + "description": "Returns the sorted list of all enabled payment cards of this payment method applicable for the specified customer, country, payment amount and the session currency The payment cards are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMethod#getApplicablePaymentCards", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer | null" + }, + { + "name": "countryCode", + "type": "string | null" + }, + { + "name": "paymentAmount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getApplicablePaymentCards", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the sorted list of all enabled payment cards of this payment\nmethod applicable for the specified customer, country, payment amount and the session currency\nThe payment cards are sorted as defined in the Business Manager.\n\nA payment card is applicable if\n\n- the card is restricted by customer group, and at least one of\nthe groups of the specified customer is assigned to the card\n- the card is restricted by billing country, and the specified\ncountry code is assigned to the card\n- the card is restricted by payment amount for the session currency,\nand the specified payment amount is within the limits of the min/max\npayment amount defined for the method and the session currency\n- the card is restricted by currency code, and the specified\ncurrency code matches session currency.\n\nAll parameters are optional, and if not specified, the respective\nrestriction won't be validated. For example, if a card is restricted\nby billing country, but no country code is specified, this card will\nbe returned, unless it is filtered out by customer group or payment\namount.", + "heading": "Description" + } + ], + "signature": "getApplicablePaymentCards(customer: Customer | null, countryCode: string | null, paymentAmount: number): List", + "source": "script-api", + "tags": [ + "getapplicablepaymentcards", + "paymentmethod.getapplicablepaymentcards" + ], + "title": "PaymentMethod.getApplicablePaymentCards" + }, + { + "description": "Returns the description of the payment method.", + "id": "script-api:dw/order/PaymentMethod#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getDescription", + "returns": { + "type": "MarkupText" + }, + "sections": [ + { + "body": "Returns the description of the payment method.", + "heading": "Description" + } + ], + "signature": "getDescription(): MarkupText", + "source": "script-api", + "tags": [ + "getdescription", + "paymentmethod.getdescription" + ], + "title": "PaymentMethod.getDescription" + }, + { + "description": "Returns the unique ID of the payment method.", + "id": "script-api:dw/order/PaymentMethod#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique ID of the payment method.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "paymentmethod.getid" + ], + "title": "PaymentMethod.getID" + }, + { + "description": "Returns the reference to the payment method image.", + "id": "script-api:dw/order/PaymentMethod#getImage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getImage", + "returns": { + "type": "MediaFile" + }, + "sections": [ + { + "body": "Returns the reference to the payment method image.", + "heading": "Description" + } + ], + "signature": "getImage(): MediaFile", + "source": "script-api", + "tags": [ + "getimage", + "paymentmethod.getimage" + ], + "title": "PaymentMethod.getImage" + }, + { + "description": "Returns the name of the payment method.", + "id": "script-api:dw/order/PaymentMethod#getName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the payment method.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "paymentmethod.getname" + ], + "title": "PaymentMethod.getName" + }, + { + "description": "Returns the payment processor associated to this payment method.", + "id": "script-api:dw/order/PaymentMethod#getPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.getPaymentProcessor", + "returns": { + "type": "PaymentProcessor" + }, + "sections": [ + { + "body": "Returns the payment processor associated to this payment method.", + "heading": "Description" + } + ], + "signature": "getPaymentProcessor(): PaymentProcessor", + "source": "script-api", + "tags": [ + "getpaymentprocessor", + "paymentmethod.getpaymentprocessor" + ], + "title": "PaymentMethod.getPaymentProcessor" + }, + { + "description": "Returns the reference to the payment method image.", + "id": "script-api:dw/order/PaymentMethod#image", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.image", + "sections": [ + { + "body": "Returns the reference to the payment method image.", + "heading": "Description" + } + ], + "signature": "readonly image: MediaFile", + "source": "script-api", + "tags": [ + "image", + "paymentmethod.image" + ], + "title": "PaymentMethod.image" + }, + { + "description": "Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.", + "id": "script-api:dw/order/PaymentMethod#isActive", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.isActive", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "isActive(): boolean", + "source": "script-api", + "tags": [ + "isactive", + "paymentmethod.isactive" + ], + "title": "PaymentMethod.isActive" + }, + { + "description": "Returns 'true' if this payment method is applicable for the specified customer, country and payment amount and the session currency.", + "id": "script-api:dw/order/PaymentMethod#isApplicable", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer | null" + }, + { + "name": "countryCode", + "type": "string | null" + }, + { + "name": "paymentAmount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.isApplicable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if this payment method is applicable for the specified\ncustomer, country and payment amount and the session currency.\n\nThe payment method is applicable if\n\n- the method is restricted by customer group, and at least one of the\ngroups of the specified customer is assigned to the method\n- the method is restricted by billing country, and the specified\ncountry code is assigned to the method\n- the method is restricted by payment amount for the session currency,\nand the specified payment amount is within the limits of the min/max\npayment amount defined for the method and the session currency\n- the method is restricted by currency code, and the specified\ncurrency code matches session currency.\n\nAll parameters are optional, and if not specified, the respective\nrestriction won't be validated. For example, if a method is restricted by\nbilling country, but no country code is specified, this method will be\nreturned, unless it is filtered out by customer group or payment amount.", + "heading": "Description" + } + ], + "signature": "isApplicable(customer: Customer | null, countryCode: string | null, paymentAmount: number): boolean", + "source": "script-api", + "tags": [ + "isapplicable", + "paymentmethod.isapplicable" + ], + "title": "PaymentMethod.isApplicable" + }, + { + "description": "Returns the name of the payment method.", + "id": "script-api:dw/order/PaymentMethod#name", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.name", + "sections": [ + { + "body": "Returns the name of the payment method.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "paymentmethod.name" + ], + "title": "PaymentMethod.name" + }, + { + "description": "Returns the payment processor associated to this payment method.", + "id": "script-api:dw/order/PaymentMethod#paymentProcessor", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMethod", + "qualifiedName": "dw.order.PaymentMethod.paymentProcessor", + "sections": [ + { + "body": "Returns the payment processor associated to this payment method.", + "heading": "Description" + } + ], + "signature": "readonly paymentProcessor: PaymentProcessor", + "source": "script-api", + "tags": [ + "paymentprocessor", + "paymentmethod.paymentprocessor" + ], + "title": "PaymentMethod.paymentProcessor" + }, + { + "description": "dw.order.PaymentMgr is used to access payment methods and payment cards of the current site.", + "id": "script-api:dw/order/PaymentMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentMgr", + "sections": [ + { + "body": "dw.order.PaymentMgr is used to access payment methods and payment\ncards of the current site.\n\nTo access payment methods and payment cards explicitly, use methods\ngetPaymentMethod and getPaymentCard.\n\nTo access active payment methods use method getActivePaymentMethods.\n\nTo access applicable payment methods for a customer, country and/or payment\namount use method getApplicablePaymentMethods.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymentmgr", + "dw.order.paymentmgr", + "dw/order" + ], + "title": "PaymentMgr" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#activePaymentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.activePaymentMethods", + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite, regardless of any customer group, country, payment amount or currency\nrestrictions. The payment methods are sorted as defined in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static readonly activePaymentMethods: List", + "source": "script-api", + "tags": [ + "activepaymentmethods", + "paymentmgr.activepaymentmethods" + ], + "title": "PaymentMgr.activePaymentMethods" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#activePaymentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.activePaymentMethods", + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite, regardless of any customer group, country, payment amount or currency\nrestrictions. The payment methods are sorted as defined in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static readonly activePaymentMethods: List", + "source": "script-api", + "tags": [ + "activepaymentmethods", + "paymentmgr.activepaymentmethods" + ], + "title": "PaymentMgr.activePaymentMethods" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#getActivePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getActivePaymentMethods", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite, regardless of any customer group, country, payment amount or currency\nrestrictions. The payment methods are sorted as defined in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static getActivePaymentMethods(): List", + "source": "script-api", + "tags": [ + "getactivepaymentmethods", + "paymentmgr.getactivepaymentmethods" + ], + "title": "PaymentMgr.getActivePaymentMethods" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#getActivePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getActivePaymentMethods", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite, regardless of any customer group, country, payment amount or currency\nrestrictions. The payment methods are sorted as defined in the Business\nManager.", + "heading": "Description" + } + ], + "signature": "static getActivePaymentMethods(): List", + "source": "script-api", + "tags": [ + "getactivepaymentmethods", + "paymentmgr.getactivepaymentmethods" + ], + "title": "PaymentMgr.getActivePaymentMethods" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site applicable for the session currency, specified customer, country and payment amount. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#getApplicablePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer | null" + }, + { + "name": "countryCode", + "type": "string | null" + }, + { + "name": "paymentAmount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getApplicablePaymentMethods", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite applicable for the session currency, specified customer, country and payment amount.\nThe payment methods are sorted as defined in the Business Manager.\n\nA payment method is applicable if\n\n- the method is restricted by customer group, and at least one of\nthe groups of the specified customer is assigned to the method\n- the method is restricted by billing country, and the specified\ncountry code is assigned to the method\n- the method is restricted by payment amount for the session currency,\nand the specified payment amount is within the limits of the min/max\npayment amount defined for the method and the session currency\n- the method is restricted by currency code, and the specified\ncurrency code matches session currency.\n\nAll parameters are optional, and if not specified, the respective\nrestriction won't be validated. For example, if a method is restricted\nby billing country, but no country code is specified, this method will\nbe returned, unless it is filtered out by customer group or payment\namount.", + "heading": "Description" + } + ], + "signature": "static getApplicablePaymentMethods(customer: Customer | null, countryCode: string | null, paymentAmount: number): List", + "source": "script-api", + "tags": [ + "getapplicablepaymentmethods", + "paymentmgr.getapplicablepaymentmethods" + ], + "title": "PaymentMgr.getApplicablePaymentMethods" + }, + { + "description": "Returns the sorted list of all enabled payment methods of the current site applicable for the session currency, specified customer, country and payment amount. The payment methods are sorted as defined in the Business Manager.", + "id": "script-api:dw/order/PaymentMgr#getApplicablePaymentMethods", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "customer", + "type": "Customer | null" + }, + { + "name": "countryCode", + "type": "string | null" + }, + { + "name": "paymentAmount", + "type": "number" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getApplicablePaymentMethods", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the sorted list of all enabled payment methods of the current\nsite applicable for the session currency, specified customer, country and payment amount.\nThe payment methods are sorted as defined in the Business Manager.\n\nA payment method is applicable if\n\n- the method is restricted by customer group, and at least one of\nthe groups of the specified customer is assigned to the method\n- the method is restricted by billing country, and the specified\ncountry code is assigned to the method\n- the method is restricted by payment amount for the session currency,\nand the specified payment amount is within the limits of the min/max\npayment amount defined for the method and the session currency\n- the method is restricted by currency code, and the specified\ncurrency code matches session currency.\n\nAll parameters are optional, and if not specified, the respective\nrestriction won't be validated. For example, if a method is restricted\nby billing country, but no country code is specified, this method will\nbe returned, unless it is filtered out by customer group or payment\namount.", + "heading": "Description" + } + ], + "signature": "static getApplicablePaymentMethods(customer: Customer | null, countryCode: string | null, paymentAmount: number): List", + "source": "script-api", + "tags": [ + "getapplicablepaymentmethods", + "paymentmgr.getapplicablepaymentmethods" + ], + "title": "PaymentMgr.getApplicablePaymentMethods" + }, + { + "description": "Returns the payment card for the specified cardType or null if no such card exists in the current site.", + "id": "script-api:dw/order/PaymentMgr#getPaymentCard", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "cardType", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentCard", + "returns": { + "type": "PaymentCard | null" + }, + "sections": [ + { + "body": "Returns the payment card for the specified cardType or null if no such\ncard exists in the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentCard(cardType: string): PaymentCard | null", + "source": "script-api", + "tags": [ + "getpaymentcard", + "paymentmgr.getpaymentcard" + ], + "title": "PaymentMgr.getPaymentCard" + }, + { + "description": "Returns the payment card for the specified cardType or null if no such card exists in the current site.", + "id": "script-api:dw/order/PaymentMgr#getPaymentCard", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "cardType", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentCard", + "returns": { + "type": "PaymentCard | null" + }, + "sections": [ + { + "body": "Returns the payment card for the specified cardType or null if no such\ncard exists in the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentCard(cardType: string): PaymentCard | null", + "source": "script-api", + "tags": [ + "getpaymentcard", + "paymentmgr.getpaymentcard" + ], + "title": "PaymentMgr.getPaymentCard" + }, + { + "description": "Returns the payment method for the specified ID or null if no such method exists in the current site.", + "id": "script-api:dw/order/PaymentMgr#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentMethod", + "returns": { + "type": "PaymentMethod | null" + }, + "sections": [ + { + "body": "Returns the payment method for the specified ID or null if no such method\nexists in the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentMethod(id: string): PaymentMethod | null", + "source": "script-api", + "tags": [ + "getpaymentmethod", + "paymentmgr.getpaymentmethod" + ], + "title": "PaymentMgr.getPaymentMethod" + }, + { + "description": "Returns the payment method for the specified ID or null if no such method exists in the current site.", + "id": "script-api:dw/order/PaymentMgr#getPaymentMethod", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentMgr", + "qualifiedName": "dw.order.PaymentMgr.getPaymentMethod", + "returns": { + "type": "PaymentMethod | null" + }, + "sections": [ + { + "body": "Returns the payment method for the specified ID or null if no such method\nexists in the current site.", + "heading": "Description" + } + ], + "signature": "static getPaymentMethod(id: string): PaymentMethod | null", + "source": "script-api", + "tags": [ + "getpaymentmethod", + "paymentmgr.getpaymentmethod" + ], + "title": "PaymentMgr.getPaymentMethod" + }, + { + "description": "A PaymentProcessor represents an entity that processes payments of one or more types. In the B2C Commerce system, a payment processor is just a container for configuration values, which describe, for example, the parameters (URL, merchant ID, password, etc) required for connecting to a payment gateway.", + "id": "script-api:dw/order/PaymentProcessor", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentProcessor", + "sections": [ + { + "body": "A PaymentProcessor represents an entity that processes payments of one or more types. In the B2C Commerce system, a\npayment processor is just a container for configuration values, which describe, for example, the parameters (URL,\nmerchant ID, password, etc) required for connecting to a payment gateway.\n\nThe system has several built in PaymentProcessors. These are:\n\n- BASIC_CREDIT\n- BASIC_GIFT_CERTIFICATE\n- CYBERSOURCE_CREDIT\n- CYBERSOURCE_BML\n- PAYPAL_CREDIT\n- PAYPAL_EXPRESS\n- VERISIGN_CREDIT\n\nThe first two of these are merely placeholders with no associated preference values. The remaining system payment\nprocessors define preference values which are maintained in the Business Manager and are used in conjunction with\nbuilt-in B2C Commerce payment integrations. Preferences of system PaymentProcessors are not intended to be read\nprogrammatically.\n\nMerchants may also define custom payment processors. This is done by defining a payment processor with an arbitrary\nID in the Business Manager, and then configuring an attribute group with the same ID on the\ndw.system.SitePreferences system object. Attributes added to the group will be considered preferences of the\npayment processor and will be readable through getPreferenceValue. Merchants can design their\ncheckout process to read these preferences at run time for connecting to their payment gateways.\n\nEvery dw.order.PaymentMethod in the system is associated with at most one PaymentProcessor. This basically\nrepresents the physical payment gateway which processes the (logical) payment method. Each payment processor may be\nassociated with an arbitrary number of payment methods. Also, each payment transaction has one PaymentProcessor which\nis set by custom code during the checkout process.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "paymentprocessor", + "dw.order.paymentprocessor", + "dw/order" + ], + "title": "PaymentProcessor" + }, + { + "description": "Returns the 'ID' of this processor.", + "id": "script-api:dw/order/PaymentProcessor#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.ID", + "sections": [ + { + "body": "Returns the 'ID' of this processor.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "paymentprocessor.id" + ], + "title": "PaymentProcessor.ID" + }, + { + "description": "Returns the 'ID' of this processor.", + "id": "script-api:dw/order/PaymentProcessor#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the 'ID' of this processor.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "paymentprocessor.getid" + ], + "title": "PaymentProcessor.getID" + }, + { + "description": "Returns the value of the specified preference for this payment processor. If the preference name is invalid (or null) or no preference value is defined for this payment processor, null is returned.", + "id": "script-api:dw/order/PaymentProcessor#getPreferenceValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentProcessor", + "qualifiedName": "dw.order.PaymentProcessor.getPreferenceValue", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Returns the value of the specified preference for this payment processor.\nIf the preference name is invalid (or null) or no preference value is\ndefined for this payment processor, null is returned.", + "heading": "Description" + } + ], + "signature": "getPreferenceValue(name: string): any | null", + "source": "script-api", + "tags": [ + "getpreferencevalue", + "paymentprocessor.getpreferencevalue" + ], + "title": "PaymentProcessor.getPreferenceValue" + }, + { + "description": "Helper class containing status codes for the various errors that can occur when validating a payment card. One of these codes is returned as part of a Status object when a unsuccessful call to the `VerifyPaymentCard` or `VerifyCreditCard` pipelet is made. The same codes are used when calling dw.order.PaymentCard.verify or dw.order.PaymentCard.verify.", + "id": "script-api:dw/order/PaymentStatusCodes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentStatusCodes", + "sections": [ + { + "body": "Helper class containing status codes for the various errors that can occur\nwhen validating a payment card. One of these codes is returned as part of a\nStatus object when a unsuccessful call to the `VerifyPaymentCard`\nor `VerifyCreditCard` pipelet is made. The same codes are used\nwhen calling dw.order.PaymentCard.verify or\ndw.order.PaymentCard.verify.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymentstatuscodes", + "dw.order.paymentstatuscodes", + "dw/order" + ], + "title": "PaymentStatusCodes" + }, + { + "description": "The code indicates that the credit card number is incorrect.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER", + "sections": [ + { + "body": "The code indicates that the credit card number is incorrect.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_CARD_NUMBER = \"CREDITCARD_INVALID_CARD_NUMBER\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_card_number", + "paymentstatuscodes.creditcard_invalid_card_number" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER" + }, + { + "description": "The code indicates that the credit card number is incorrect.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_CARD_NUMBER", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER", + "sections": [ + { + "body": "The code indicates that the credit card number is incorrect.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_CARD_NUMBER = \"CREDITCARD_INVALID_CARD_NUMBER\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_card_number", + "paymentstatuscodes.creditcard_invalid_card_number" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER" + }, + { + "description": "The code indicates that the credit card is expired.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_EXPIRATION_DATE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE", + "sections": [ + { + "body": "The code indicates that the credit card is expired.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_EXPIRATION_DATE = \"CREDITCARD_INVALID_EXPIRATION_DATE\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_expiration_date", + "paymentstatuscodes.creditcard_invalid_expiration_date" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE" + }, + { + "description": "The code indicates that the credit card is expired.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_EXPIRATION_DATE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE", + "sections": [ + { + "body": "The code indicates that the credit card is expired.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_EXPIRATION_DATE = \"CREDITCARD_INVALID_EXPIRATION_DATE\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_expiration_date", + "paymentstatuscodes.creditcard_invalid_expiration_date" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE" + }, + { + "description": "The code indicates that the credit card security code length is invalid.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_SECURITY_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE", + "sections": [ + { + "body": "The code indicates that the credit card security code length is invalid.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_SECURITY_CODE = \"CREDITCARD_INVALID_SECURITY_CODE\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_security_code", + "paymentstatuscodes.creditcard_invalid_security_code" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE" + }, + { + "description": "The code indicates that the credit card security code length is invalid.", + "id": "script-api:dw/order/PaymentStatusCodes#CREDITCARD_INVALID_SECURITY_CODE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentStatusCodes", + "qualifiedName": "dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE", + "sections": [ + { + "body": "The code indicates that the credit card security code length is invalid.", + "heading": "Description" + } + ], + "signature": "static readonly CREDITCARD_INVALID_SECURITY_CODE = \"CREDITCARD_INVALID_SECURITY_CODE\"", + "source": "script-api", + "tags": [ + "creditcard_invalid_security_code", + "paymentstatuscodes.creditcard_invalid_security_code" + ], + "title": "PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE" + }, + { + "description": "The PaymentTransaction class represents a payment transaction.", + "id": "script-api:dw/order/PaymentTransaction", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PaymentTransaction", + "sections": [ + { + "body": "The PaymentTransaction class represents a payment transaction.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "paymenttransaction", + "dw.order.paymenttransaction", + "dw/order" + ], + "title": "PaymentTransaction" + }, + { + "description": "Constant representing the authorization type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH", + "sections": [ + { + "body": "Constant representing the authorization type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AUTH = \"AUTH\"", + "source": "script-api", + "tags": [ + "type_auth", + "paymenttransaction.type_auth" + ], + "title": "PaymentTransaction.TYPE_AUTH" + }, + { + "description": "Constant representing the authorization type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH", + "sections": [ + { + "body": "Constant representing the authorization type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AUTH = \"AUTH\"", + "source": "script-api", + "tags": [ + "type_auth", + "paymenttransaction.type_auth" + ], + "title": "PaymentTransaction.TYPE_AUTH" + }, + { + "description": "Constant representing the authorization reversal type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH_REVERSAL", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH_REVERSAL", + "sections": [ + { + "body": "Constant representing the authorization reversal type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AUTH_REVERSAL = \"AUTH_REVERSAL\"", + "source": "script-api", + "tags": [ + "type_auth_reversal", + "paymenttransaction.type_auth_reversal" + ], + "title": "PaymentTransaction.TYPE_AUTH_REVERSAL" + }, + { + "description": "Constant representing the authorization reversal type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_AUTH_REVERSAL", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_AUTH_REVERSAL", + "sections": [ + { + "body": "Constant representing the authorization reversal type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_AUTH_REVERSAL = \"AUTH_REVERSAL\"", + "source": "script-api", + "tags": [ + "type_auth_reversal", + "paymenttransaction.type_auth_reversal" + ], + "title": "PaymentTransaction.TYPE_AUTH_REVERSAL" + }, + { + "description": "Constant representing the capture type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_CAPTURE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CAPTURE", + "sections": [ + { + "body": "Constant representing the capture type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CAPTURE = \"CAPTURE\"", + "source": "script-api", + "tags": [ + "type_capture", + "paymenttransaction.type_capture" + ], + "title": "PaymentTransaction.TYPE_CAPTURE" + }, + { + "description": "Constant representing the capture type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_CAPTURE", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CAPTURE", + "sections": [ + { + "body": "Constant representing the capture type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CAPTURE = \"CAPTURE\"", + "source": "script-api", + "tags": [ + "type_capture", + "paymenttransaction.type_capture" + ], + "title": "PaymentTransaction.TYPE_CAPTURE" + }, + { + "description": "Constant representing the credit type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_CREDIT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CREDIT", + "sections": [ + { + "body": "Constant representing the credit type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CREDIT = \"CREDIT\"", + "source": "script-api", + "tags": [ + "type_credit", + "paymenttransaction.type_credit" + ], + "title": "PaymentTransaction.TYPE_CREDIT" + }, + { + "description": "Constant representing the credit type of payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#TYPE_CREDIT", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.TYPE_CREDIT", + "sections": [ + { + "body": "Constant representing the credit type of payment transaction.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_CREDIT = \"CREDIT\"", + "source": "script-api", + "tags": [ + "type_credit", + "paymenttransaction.type_credit" + ], + "title": "PaymentTransaction.TYPE_CREDIT" + }, + { + "description": "Returns the payment service-specific account id.", + "id": "script-api:dw/order/PaymentTransaction#accountID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.accountID", + "sections": [ + { + "body": "Returns the payment service-specific account id.", + "heading": "Description" + } + ], + "signature": "accountID: string", + "source": "script-api", + "tags": [ + "accountid", + "paymenttransaction.accountid" + ], + "title": "PaymentTransaction.accountID" + }, + { + "description": "Returns the payment service-specific account type.", + "id": "script-api:dw/order/PaymentTransaction#accountType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.accountType", + "sections": [ + { + "body": "Returns the payment service-specific account type.", + "heading": "Description" + } + ], + "signature": "accountType: string", + "source": "script-api", + "tags": [ + "accounttype", + "paymenttransaction.accounttype" + ], + "title": "PaymentTransaction.accountType" + }, + { + "description": "Returns the amount of the transaction.", + "id": "script-api:dw/order/PaymentTransaction#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.amount", + "sections": [ + { + "body": "Returns the amount of the transaction.", + "heading": "Description" + } + ], + "signature": "amount: Money", + "source": "script-api", + "tags": [ + "amount", + "paymenttransaction.amount" + ], + "title": "PaymentTransaction.amount" + }, + { + "description": "Returns the payment service-specific account id.", + "id": "script-api:dw/order/PaymentTransaction#getAccountID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAccountID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payment service-specific account id.", + "heading": "Description" + } + ], + "signature": "getAccountID(): string", + "source": "script-api", + "tags": [ + "getaccountid", + "paymenttransaction.getaccountid" + ], + "title": "PaymentTransaction.getAccountID" + }, + { + "description": "Returns the payment service-specific account type.", + "id": "script-api:dw/order/PaymentTransaction#getAccountType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAccountType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payment service-specific account type.", + "heading": "Description" + } + ], + "signature": "getAccountType(): string", + "source": "script-api", + "tags": [ + "getaccounttype", + "paymenttransaction.getaccounttype" + ], + "title": "PaymentTransaction.getAccountType" + }, + { + "description": "Returns the amount of the transaction.", + "id": "script-api:dw/order/PaymentTransaction#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the amount of the transaction.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "paymenttransaction.getamount" + ], + "title": "PaymentTransaction.getAmount" + }, + { + "description": "Returns the payment instrument related to this payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#getPaymentInstrument", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getPaymentInstrument", + "returns": { + "type": "OrderPaymentInstrument" + }, + "sections": [ + { + "body": "Returns the payment instrument related to this payment transaction.", + "heading": "Description" + } + ], + "signature": "getPaymentInstrument(): OrderPaymentInstrument", + "source": "script-api", + "tags": [ + "getpaymentinstrument", + "paymenttransaction.getpaymentinstrument" + ], + "title": "PaymentTransaction.getPaymentInstrument" + }, + { + "description": "Returns the payment processor related to this payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#getPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getPaymentProcessor", + "returns": { + "type": "PaymentProcessor" + }, + "sections": [ + { + "body": "Returns the payment processor related to this payment transaction.", + "heading": "Description" + } + ], + "signature": "getPaymentProcessor(): PaymentProcessor", + "source": "script-api", + "tags": [ + "getpaymentprocessor", + "paymenttransaction.getpaymentprocessor" + ], + "title": "PaymentTransaction.getPaymentProcessor" + }, + { + "description": "Returns the payment service-specific transaction id.", + "id": "script-api:dw/order/PaymentTransaction#getTransactionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getTransactionID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the payment service-specific transaction id.", + "heading": "Description" + } + ], + "signature": "getTransactionID(): string", + "source": "script-api", + "tags": [ + "gettransactionid", + "paymenttransaction.gettransactionid" + ], + "title": "PaymentTransaction.getTransactionID" + }, + { + "description": "Returns the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.", + "id": "script-api:dw/order/PaymentTransaction#getType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.getType", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the value of the transaction type where the\nvalue is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE\nor TYPE_CREDIT.", + "heading": "Description" + } + ], + "signature": "getType(): EnumValue", + "source": "script-api", + "tags": [ + "gettype", + "paymenttransaction.gettype" + ], + "title": "PaymentTransaction.getType" + }, + { + "description": "Returns the payment instrument related to this payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#paymentInstrument", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.paymentInstrument", + "sections": [ + { + "body": "Returns the payment instrument related to this payment transaction.", + "heading": "Description" + } + ], + "signature": "readonly paymentInstrument: OrderPaymentInstrument", + "source": "script-api", + "tags": [ + "paymentinstrument", + "paymenttransaction.paymentinstrument" + ], + "title": "PaymentTransaction.paymentInstrument" + }, + { + "description": "Returns the payment processor related to this payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#paymentProcessor", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.paymentProcessor", + "sections": [ + { + "body": "Returns the payment processor related to this payment transaction.", + "heading": "Description" + } + ], + "signature": "paymentProcessor: PaymentProcessor", + "source": "script-api", + "tags": [ + "paymentprocessor", + "paymenttransaction.paymentprocessor" + ], + "title": "PaymentTransaction.paymentProcessor" + }, + { + "description": "Sets the payment service-specific account id.", + "id": "script-api:dw/order/PaymentTransaction#setAccountID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "accountID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAccountID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the payment service-specific account id.", + "heading": "Description" + } + ], + "signature": "setAccountID(accountID: string): void", + "source": "script-api", + "tags": [ + "setaccountid", + "paymenttransaction.setaccountid" + ], + "title": "PaymentTransaction.setAccountID" + }, + { + "description": "Sets the payment service-specific account type.", + "id": "script-api:dw/order/PaymentTransaction#setAccountType", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "accountType", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAccountType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the payment service-specific account type.", + "heading": "Description" + } + ], + "signature": "setAccountType(accountType: string): void", + "source": "script-api", + "tags": [ + "setaccounttype", + "paymenttransaction.setaccounttype" + ], + "title": "PaymentTransaction.setAccountType" + }, + { + "description": "Sets the amount of the transaction.", + "id": "script-api:dw/order/PaymentTransaction#setAmount", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setAmount", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the amount of the transaction.", + "heading": "Description" + } + ], + "signature": "setAmount(amount: Money): void", + "source": "script-api", + "tags": [ + "setamount", + "paymenttransaction.setamount" + ], + "title": "PaymentTransaction.setAmount" + }, + { + "description": "Sets the payment processor related to this payment transaction.", + "id": "script-api:dw/order/PaymentTransaction#setPaymentProcessor", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "paymentProcessor", + "type": "PaymentProcessor" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setPaymentProcessor", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the payment processor related to this payment transaction.", + "heading": "Description" + } + ], + "signature": "setPaymentProcessor(paymentProcessor: PaymentProcessor): void", + "source": "script-api", + "tags": [ + "setpaymentprocessor", + "paymenttransaction.setpaymentprocessor" + ], + "title": "PaymentTransaction.setPaymentProcessor" + }, + { + "description": "Sets the payment service-specific transaction id.", + "id": "script-api:dw/order/PaymentTransaction#setTransactionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "transactionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setTransactionID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the payment service-specific transaction id.", + "heading": "Description" + } + ], + "signature": "setTransactionID(transactionID: string): void", + "source": "script-api", + "tags": [ + "settransactionid", + "paymenttransaction.settransactionid" + ], + "title": "PaymentTransaction.setTransactionID" + }, + { + "description": "Sets the value of the transaction type where permissible values are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.", + "id": "script-api:dw/order/PaymentTransaction#setType", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.setType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value of the transaction type where permissible\nvalues are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.", + "heading": "Description" + } + ], + "signature": "setType(type: string): void", + "source": "script-api", + "tags": [ + "settype", + "paymenttransaction.settype" + ], + "title": "PaymentTransaction.setType" + }, + { + "description": "Returns the payment service-specific transaction id.", + "id": "script-api:dw/order/PaymentTransaction#transactionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.transactionID", + "sections": [ + { + "body": "Returns the payment service-specific transaction id.", + "heading": "Description" + } + ], + "signature": "transactionID: string", + "source": "script-api", + "tags": [ + "transactionid", + "paymenttransaction.transactionid" + ], + "title": "PaymentTransaction.transactionID" + }, + { + "description": "Returns the value of the transaction type where the value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.", + "id": "script-api:dw/order/PaymentTransaction#type", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PaymentTransaction", + "qualifiedName": "dw.order.PaymentTransaction.type", + "sections": [ + { + "body": "Returns the value of the transaction type where the\nvalue is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE\nor TYPE_CREDIT.", + "heading": "Description" + } + ], + "signature": "type: EnumValue", + "source": "script-api", + "tags": [ + "type", + "paymenttransaction.type" + ], + "title": "PaymentTransaction.type" + }, + { + "description": "The PriceAdjustment class represents an adjustment to the price of an order. A PriceAdjustment can apply to a ProductLineItem, ShippingLineItem, ProductShippingLineItem, or a LineItemCtnr, and are generally categorized as product-level, shipping-level, or order-level. PriceAdjustments are generated by the B2C Commerce promotions engine when applying discounts. See dw.campaign.PromotionMgr.applyDiscounts. They may also be generated by custom code through the API. See for example dw.order.ProductLineItem.createPriceAdjustment. In the latter case, the PriceAdjustment is called \"custom\"; in the former case, it is called \"system\". System price adjustments are associated with the promotion that triggered their creation. If the promotion was coupon-based, then the price adjustment will additionally be associated with a coupon line item in the LineItemCtnr.", + "id": "script-api:dw/order/PriceAdjustment", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PriceAdjustment", + "sections": [ + { + "body": "The PriceAdjustment class represents an adjustment to the price of an order. A PriceAdjustment can apply to a\nProductLineItem, ShippingLineItem, ProductShippingLineItem, or a LineItemCtnr, and are generally categorized as\nproduct-level, shipping-level, or order-level. PriceAdjustments are generated by the B2C Commerce promotions engine\nwhen applying discounts. See dw.campaign.PromotionMgr.applyDiscounts. They may also be\ngenerated by custom code through the API. See for example\ndw.order.ProductLineItem.createPriceAdjustment. In the latter case, the PriceAdjustment is called\n\"custom\"; in the former case, it is called \"system\". System price adjustments are associated with the promotion that\ntriggered their creation. If the promotion was coupon-based, then the price adjustment will additionally be\nassociated with a coupon line item in the LineItemCtnr.", + "heading": "Description" + }, + { + "body": "Extends `LineItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "priceadjustment", + "dw.order.priceadjustment", + "dw/order" + ], + "title": "PriceAdjustment" + }, + { + "description": "Returns the B2C Commerce AB-test this price adjustment is associated with. The associated AB-test is determined from the ABTestID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#ABTest", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTest", + "sections": [ + { + "body": "Returns the B2C Commerce AB-test this price adjustment is associated with. The associated AB-test is determined\nfrom the ABTestID attribute which is set by the promotions engine when applying discounts.\n\nIf the AB-test has been removed from the system since this price adjustment was created, this method returns\nnull. This method always returns null for custom price adjustments.", + "heading": "Description" + } + ], + "signature": "readonly ABTest: ABTest | null", + "source": "script-api", + "tags": [ + "abtest", + "priceadjustment.abtest" + ], + "title": "PriceAdjustment.ABTest" + }, + { + "description": "Returns the ID of the AB-test related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#ABTestID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestID", + "sections": [ + { + "body": "Returns the ID of the AB-test related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "readonly ABTestID: string | null", + "source": "script-api", + "tags": [ + "abtestid", + "priceadjustment.abtestid" + ], + "title": "PriceAdjustment.ABTestID" + }, + { + "description": "Returns the B2C Commerce AB-test segment this price adjustment is associated with. The associated AB-test segment is determined from the ABTestSegmentID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#ABTestSegment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestSegment", + "sections": [ + { + "body": "Returns the B2C Commerce AB-test segment this price adjustment is associated with. The associated AB-test segment\nis determined from the ABTestSegmentID attribute which is set by the promotions engine when applying discounts.\n\nIf the AB-test, or this segment, has been removed from the system since this price adjustment was created, this\nmethod returns null. This method always returns null for custom price adjustments.", + "heading": "Description" + } + ], + "signature": "readonly ABTestSegment: ABTestSegment | null", + "source": "script-api", + "tags": [ + "abtestsegment", + "priceadjustment.abtestsegment" + ], + "title": "PriceAdjustment.ABTestSegment" + }, + { + "description": "Returns the ID of the AB-test segment related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#ABTestSegmentID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.ABTestSegmentID", + "sections": [ + { + "body": "Returns the ID of the AB-test segment related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "readonly ABTestSegmentID: string | null", + "source": "script-api", + "tags": [ + "abtestsegmentid", + "priceadjustment.abtestsegmentid" + ], + "title": "PriceAdjustment.ABTestSegmentID" + }, + { + "description": "A `Discount` instance describing the discount applied to obtain this price-adjustment. This method only returns a non-null value if the price-adjustment was created", + "id": "script-api:dw/order/PriceAdjustment#appliedDiscount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.appliedDiscount", + "sections": [ + { + "body": "A `Discount` instance describing the discount applied to\nobtain this price-adjustment. This method only returns a non-null value\nif the price-adjustment was created\n\n- when a discount-plan was applied to a basket, or\n- as a custom price-adjustment using one of the methods\ndw.order.ProductLineItem.createPriceAdjustment,\ndw.order.ShippingLineItem.createShippingPriceAdjustment\nor dw.order.LineItemCtnr.createPriceAdjustment.\n\nNote an instance of the dw.campaign.Discount subclasses is\nreturned, such as dw.campaign.AmountDiscount or\ndw.campaign.PriceBookPriceDiscount, use\ndw.campaign.Discount.getType and the constants in\ndw.campaign.Discount to distinguish between types. Each subclass\nprovides access to specific properties.", + "heading": "Description" + } + ], + "signature": "readonly appliedDiscount: Discount | null", + "source": "script-api", + "tags": [ + "applieddiscount", + "priceadjustment.applieddiscount" + ], + "title": "PriceAdjustment.appliedDiscount" + }, + { + "description": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a promotion assigned to an AB-test.", + "id": "script-api:dw/order/PriceAdjustment#basedOnABTest", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnABTest", + "sections": [ + { + "body": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a\npromotion assigned to an AB-test.", + "heading": "Description" + } + ], + "signature": "readonly basedOnABTest: boolean", + "source": "script-api", + "tags": [ + "basedonabtest", + "priceadjustment.basedonabtest" + ], + "title": "PriceAdjustment.basedOnABTest" + }, + { + "deprecated": { + "message": "The method has been deprecated since the name implies that there is a related Campaign, which may not\nbe true. Use `!isCustom()` instead." + }, + "description": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a promotion assigned to a Campaign or an AB-test.", + "id": "script-api:dw/order/PriceAdjustment#basedOnCampaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnCampaign", + "sections": [ + { + "body": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a\npromotion assigned to a Campaign or an AB-test.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCampaign: boolean", + "source": "script-api", + "tags": [ + "basedoncampaign", + "priceadjustment.basedoncampaign" + ], + "title": "PriceAdjustment.basedOnCampaign" + }, + { + "description": "Identifies if the promotion line item results from a coupon.", + "id": "script-api:dw/order/PriceAdjustment#basedOnCoupon", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.basedOnCoupon", + "sections": [ + { + "body": "Identifies if the promotion line item results from a coupon.", + "heading": "Description" + } + ], + "signature": "readonly basedOnCoupon: boolean", + "source": "script-api", + "tags": [ + "basedoncoupon", + "priceadjustment.basedoncoupon" + ], + "title": "PriceAdjustment.basedOnCoupon" + }, + { + "description": "Returns the B2C Commerce campaign this price adjustment is associated with. The associated campaign is determined from the campaignID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#campaign", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.campaign", + "sections": [ + { + "body": "Returns the B2C Commerce campaign this price adjustment is associated with. The associated campaign is determined\nfrom the campaignID attribute which is set by the promotions engine when applying discounts.\n\nIf the campaign has been removed from the system since this price adjustment was created, this method returns\nnull. This method always returns null for custom price adjustments.\n\nNote: If the price adjustment was generated by a B2C Commerce promotion as part of an AB-test, then a Campaign\nobject will be returned, but it is a mock implementation, and not a true Campaign. This behavior is required for\nbackwards compatibility and should not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "readonly campaign: Campaign | null", + "source": "script-api", + "tags": [ + "campaign", + "priceadjustment.campaign" + ], + "title": "PriceAdjustment.campaign" + }, + { + "description": "Returns the ID of the campaign the price adjustment was based on.", + "id": "script-api:dw/order/PriceAdjustment#campaignID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.campaignID", + "sections": [ + { + "body": "Returns the ID of the campaign the price adjustment was based on.\n\nNote:If the price adjustment was generated by a B2C Commerce promotion as part of an AB-test, then an ID will be\nreturned but it is not the ID of a true campaign. This behavior is required for backwards compatibility and\nshould not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "readonly campaignID: string | null", + "source": "script-api", + "tags": [ + "campaignid", + "priceadjustment.campaignid" + ], + "title": "PriceAdjustment.campaignID" + }, + { + "description": "Returns the coupon line item related to this price adjustment. If the price adjustment is not based on a coupon, null is returned.", + "id": "script-api:dw/order/PriceAdjustment#couponLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.couponLineItem", + "sections": [ + { + "body": "Returns the coupon line item related to this price adjustment.\nIf the price adjustment is not based on a coupon, null is returned.", + "heading": "Description" + } + ], + "signature": "readonly couponLineItem: CouponLineItem | null", + "source": "script-api", + "tags": [ + "couponlineitem", + "priceadjustment.couponlineitem" + ], + "title": "PriceAdjustment.couponLineItem" + }, + { + "description": "Returns the name of the user who created the price adjustment. This method returns a value if the price-adjustment was created as a custom price-adjustment using one of the methods dw.order.ProductLineItem.createPriceAdjustment, dw.order.ShippingLineItem.createShippingPriceAdjustment or dw.order.LineItemCtnr.createPriceAdjustment.", + "id": "script-api:dw/order/PriceAdjustment#createdBy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.createdBy", + "sections": [ + { + "body": "Returns the name of the user who created the price adjustment.\nThis method returns a value if the price-adjustment was\ncreated as a custom price-adjustment using one of the methods\ndw.order.ProductLineItem.createPriceAdjustment,\ndw.order.ShippingLineItem.createShippingPriceAdjustment\nor dw.order.LineItemCtnr.createPriceAdjustment.\n\nIf an agent user has created the price adjustment, the agent user's name\nis returned. Otherwise \"Customer\" is returned.", + "heading": "Description" + } + ], + "signature": "readonly createdBy: string", + "source": "script-api", + "tags": [ + "createdby", + "priceadjustment.createdby" + ], + "title": "PriceAdjustment.createdBy" + }, + { + "description": "Returns the B2C Commerce AB-test this price adjustment is associated with. The associated AB-test is determined from the ABTestID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#getABTest", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTest", + "returns": { + "type": "ABTest | null" + }, + "sections": [ + { + "body": "Returns the B2C Commerce AB-test this price adjustment is associated with. The associated AB-test is determined\nfrom the ABTestID attribute which is set by the promotions engine when applying discounts.\n\nIf the AB-test has been removed from the system since this price adjustment was created, this method returns\nnull. This method always returns null for custom price adjustments.", + "heading": "Description" + } + ], + "signature": "getABTest(): ABTest | null", + "source": "script-api", + "tags": [ + "getabtest", + "priceadjustment.getabtest" + ], + "title": "PriceAdjustment.getABTest" + }, + { + "description": "Returns the ID of the AB-test related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#getABTestID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the AB-test related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "getABTestID(): string | null", + "source": "script-api", + "tags": [ + "getabtestid", + "priceadjustment.getabtestid" + ], + "title": "PriceAdjustment.getABTestID" + }, + { + "description": "Returns the B2C Commerce AB-test segment this price adjustment is associated with. The associated AB-test segment is determined from the ABTestSegmentID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#getABTestSegment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestSegment", + "returns": { + "type": "ABTestSegment | null" + }, + "sections": [ + { + "body": "Returns the B2C Commerce AB-test segment this price adjustment is associated with. The associated AB-test segment\nis determined from the ABTestSegmentID attribute which is set by the promotions engine when applying discounts.\n\nIf the AB-test, or this segment, has been removed from the system since this price adjustment was created, this\nmethod returns null. This method always returns null for custom price adjustments.", + "heading": "Description" + } + ], + "signature": "getABTestSegment(): ABTestSegment | null", + "source": "script-api", + "tags": [ + "getabtestsegment", + "priceadjustment.getabtestsegment" + ], + "title": "PriceAdjustment.getABTestSegment" + }, + { + "description": "Returns the ID of the AB-test segment related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#getABTestSegmentID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getABTestSegmentID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the AB-test segment related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "getABTestSegmentID(): string | null", + "source": "script-api", + "tags": [ + "getabtestsegmentid", + "priceadjustment.getabtestsegmentid" + ], + "title": "PriceAdjustment.getABTestSegmentID" + }, + { + "description": "A `Discount` instance describing the discount applied to obtain this price-adjustment. This method only returns a non-null value if the price-adjustment was created", + "id": "script-api:dw/order/PriceAdjustment#getAppliedDiscount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getAppliedDiscount", + "returns": { + "type": "Discount | null" + }, + "sections": [ + { + "body": "A `Discount` instance describing the discount applied to\nobtain this price-adjustment. This method only returns a non-null value\nif the price-adjustment was created\n\n- when a discount-plan was applied to a basket, or\n- as a custom price-adjustment using one of the methods\ndw.order.ProductLineItem.createPriceAdjustment,\ndw.order.ShippingLineItem.createShippingPriceAdjustment\nor dw.order.LineItemCtnr.createPriceAdjustment.\n\nNote an instance of the dw.campaign.Discount subclasses is\nreturned, such as dw.campaign.AmountDiscount or\ndw.campaign.PriceBookPriceDiscount, use\ndw.campaign.Discount.getType and the constants in\ndw.campaign.Discount to distinguish between types. Each subclass\nprovides access to specific properties.", + "heading": "Description" + } + ], + "signature": "getAppliedDiscount(): Discount | null", + "source": "script-api", + "tags": [ + "getapplieddiscount", + "priceadjustment.getapplieddiscount" + ], + "title": "PriceAdjustment.getAppliedDiscount" + }, + { + "description": "Returns the B2C Commerce campaign this price adjustment is associated with. The associated campaign is determined from the campaignID attribute which is set by the promotions engine when applying discounts.", + "id": "script-api:dw/order/PriceAdjustment#getCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCampaign", + "returns": { + "type": "Campaign | null" + }, + "sections": [ + { + "body": "Returns the B2C Commerce campaign this price adjustment is associated with. The associated campaign is determined\nfrom the campaignID attribute which is set by the promotions engine when applying discounts.\n\nIf the campaign has been removed from the system since this price adjustment was created, this method returns\nnull. This method always returns null for custom price adjustments.\n\nNote: If the price adjustment was generated by a B2C Commerce promotion as part of an AB-test, then a Campaign\nobject will be returned, but it is a mock implementation, and not a true Campaign. This behavior is required for\nbackwards compatibility and should not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "getCampaign(): Campaign | null", + "source": "script-api", + "tags": [ + "getcampaign", + "priceadjustment.getcampaign" + ], + "title": "PriceAdjustment.getCampaign" + }, + { + "description": "Returns the ID of the campaign the price adjustment was based on.", + "id": "script-api:dw/order/PriceAdjustment#getCampaignID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCampaignID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the campaign the price adjustment was based on.\n\nNote:If the price adjustment was generated by a B2C Commerce promotion as part of an AB-test, then an ID will be\nreturned but it is not the ID of a true campaign. This behavior is required for backwards compatibility and\nshould not be relied upon as it may change in future releases.", + "heading": "Description" + } + ], + "signature": "getCampaignID(): string | null", + "source": "script-api", + "tags": [ + "getcampaignid", + "priceadjustment.getcampaignid" + ], + "title": "PriceAdjustment.getCampaignID" + }, + { + "description": "Returns the coupon line item related to this price adjustment. If the price adjustment is not based on a coupon, null is returned.", + "id": "script-api:dw/order/PriceAdjustment#getCouponLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCouponLineItem", + "returns": { + "type": "CouponLineItem | null" + }, + "sections": [ + { + "body": "Returns the coupon line item related to this price adjustment.\nIf the price adjustment is not based on a coupon, null is returned.", + "heading": "Description" + } + ], + "signature": "getCouponLineItem(): CouponLineItem | null", + "source": "script-api", + "tags": [ + "getcouponlineitem", + "priceadjustment.getcouponlineitem" + ], + "title": "PriceAdjustment.getCouponLineItem" + }, + { + "description": "Returns the name of the user who created the price adjustment. This method returns a value if the price-adjustment was created as a custom price-adjustment using one of the methods dw.order.ProductLineItem.createPriceAdjustment, dw.order.ShippingLineItem.createShippingPriceAdjustment or dw.order.LineItemCtnr.createPriceAdjustment.", + "id": "script-api:dw/order/PriceAdjustment#getCreatedBy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getCreatedBy", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the user who created the price adjustment.\nThis method returns a value if the price-adjustment was\ncreated as a custom price-adjustment using one of the methods\ndw.order.ProductLineItem.createPriceAdjustment,\ndw.order.ShippingLineItem.createShippingPriceAdjustment\nor dw.order.LineItemCtnr.createPriceAdjustment.\n\nIf an agent user has created the price adjustment, the agent user's name\nis returned. Otherwise \"Customer\" is returned.", + "heading": "Description" + } + ], + "signature": "getCreatedBy(): string", + "source": "script-api", + "tags": [ + "getcreatedby", + "priceadjustment.getcreatedby" + ], + "title": "PriceAdjustment.getCreatedBy" + }, + { + "description": "Returns the promotion associated with this price adjustment. The associated promotion is determined from the promotionID and campaignID attributes which are set by the promotions engine when applying discounts. Alternatively if the promotion applied as part of an AB-test, then the associated promotion is determined from the promotionID attribute and the hidden attributes, abTestID and abTestGroupID.", + "id": "script-api:dw/order/PriceAdjustment#getPromotion", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getPromotion", + "returns": { + "type": "Promotion | null" + }, + "sections": [ + { + "body": "Returns the promotion associated with this price adjustment. The\nassociated promotion is determined from the promotionID and campaignID\nattributes which are set by the promotions engine when applying\ndiscounts. Alternatively if the promotion applied as part of an AB-test,\nthen the associated promotion is determined from the promotionID\nattribute and the hidden attributes, abTestID and abTestGroupID.\n\nIf the promotion has been removed from the system since this price\nadjustment was created, or if the promotion still exists but is not\nassigned to any campaign or AB-test, this method returns null. If the\npromotion has been reassigned to a different campaign or AB-test since\nthis price adjustment was created, then the system will return an\nappropriate Promotion instance. This method always returns null for\ncustom price adjustments.", + "heading": "Description" + } + ], + "signature": "getPromotion(): Promotion | null", + "source": "script-api", + "tags": [ + "getpromotion", + "priceadjustment.getpromotion" + ], + "title": "PriceAdjustment.getPromotion" + }, + { + "description": "Returns the ID of the promotion related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#getPromotionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getPromotionID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the promotion related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "getPromotionID(): string", + "source": "script-api", + "tags": [ + "getpromotionid", + "priceadjustment.getpromotionid" + ], + "title": "PriceAdjustment.getPromotionID" + }, + { + "description": "Returns a map representing the product line items to which this price adjustment is \"related\" (in the sense defined below) and the portion of this adjustment's price which applies to each after discount prorating is performed. This information is sometimes useful to display in the storefront but is more often useful for integrating with backend order-management and accounting systems which require all discounts to be itemized.", + "id": "script-api:dw/order/PriceAdjustment#getProratedPrices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getProratedPrices", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a map representing the product line items to which this price\nadjustment is \"related\" (in the sense defined below) and the portion of\nthis adjustment's price which applies to each after discount prorating is\nperformed. This information is sometimes useful to display in the\nstorefront but is more often useful for integrating with backend\norder-management and accounting systems which require all discounts to be\nitemized.\n\nThe definition of \"related\" product line items depends on the type of\npromotion which generated this price adjustment:\n\n- For order promotions, price adjustments are prorated across all\nproduct line items which are not explicitly excluded by the promotion.\nCustom order price adjustments apply to all items in the LineItemCtnr.\n- For Buy-X-Get-Y product promotions, price adjustments are prorated\nacross all items all product line items that are involved in the\npromotion, meaning that the PLI has one or more items contributing to the\nqualifying product count (i.e. the item is one of the X) or receiving the\ndiscount (i.e. the item is one of the Y).\n- Other product promotions are not prorated and simply adjust the\nparent product line item, and so the returned map is of size 1.\n- For shipping promotions, this method returns an empty map.\n\nBuy-X-Get-Y product promotions are prorated as follows: Each price\nadjustment generated by the promotion is sequentially prorated upon the\nrelated items according to the items' adjusted prices after all non-BOGO\nproduct promotions are considered, but before order promotions are\nconsidered.\n\nOrder promotions are prorated sequentially upon non-excluded items\naccording to the order in which they applied during promotion processing.\n\nThe values in the map are inclusive of tax if this price adjustment is\nbased on gross pricing, and exclusive of tax otherwise. The sum of the\nprorated prices always equals the price of this price adjustment.", + "heading": "Description" + } + ], + "signature": "getProratedPrices(): utilMap", + "source": "script-api", + "tags": [ + "getproratedprices", + "priceadjustment.getproratedprices" + ], + "title": "PriceAdjustment.getProratedPrices" + }, + { + "description": "Returns the number of items this price adjustment applies to. This value is always equal to 1 for price adjustments generated by order or shipping promotions. For price adjustments generated by product promotions, this value represents the number of units of the parent product line item to which the adjustment applies. Because promotions may have a maximum number of applications this value may be less than the product line item quantity.", + "id": "script-api:dw/order/PriceAdjustment#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getQuantity", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of items this price adjustment applies to. This value\nis always equal to 1 for price adjustments generated by order or shipping\npromotions. For price adjustments generated by product promotions, this\nvalue represents the number of units of the parent product line item to\nwhich the adjustment applies. Because promotions may have a maximum\nnumber of applications this value may be less than the product line item\nquantity.\n\nFor custom price adjustments, not generated by the promotions engine,\nthis method always returns 0.", + "heading": "Description" + } + ], + "signature": "getQuantity(): number", + "source": "script-api", + "tags": [ + "getquantity", + "priceadjustment.getquantity" + ], + "title": "PriceAdjustment.getQuantity" + }, + { + "description": "Returns the reason code of the price adjustment. The list of available reason codes is editable system meta-data. An example for using the reason code is that in a call center application the CSR will explain why he gave a discount to the customer.", + "id": "script-api:dw/order/PriceAdjustment#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.getReasonCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the reason code of the price adjustment. The list of available\nreason codes is editable system meta-data. An example for using the\nreason code is that in a call center application the CSR will explain\nwhy he gave a discount to the customer.", + "heading": "Description" + } + ], + "signature": "getReasonCode(): EnumValue", + "source": "script-api", + "tags": [ + "getreasoncode", + "priceadjustment.getreasoncode" + ], + "title": "PriceAdjustment.getReasonCode" + }, + { + "description": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a promotion assigned to an AB-test.", + "id": "script-api:dw/order/PriceAdjustment#isBasedOnABTest", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnABTest", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a\npromotion assigned to an AB-test.", + "heading": "Description" + } + ], + "signature": "isBasedOnABTest(): boolean", + "source": "script-api", + "tags": [ + "isbasedonabtest", + "priceadjustment.isbasedonabtest" + ], + "title": "PriceAdjustment.isBasedOnABTest" + }, + { + "deprecated": { + "message": "The method has been deprecated since the name implies that there is a related Campaign, which may not\nbe true. Use `!isCustom()` instead." + }, + "description": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a promotion assigned to a Campaign or an AB-test.", + "id": "script-api:dw/order/PriceAdjustment#isBasedOnCampaign", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnCampaign", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the price adjustment was generated by the B2C Commerce promotions engine when applying a\npromotion assigned to a Campaign or an AB-test.", + "heading": "Description" + } + ], + "signature": "isBasedOnCampaign(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncampaign", + "priceadjustment.isbasedoncampaign" + ], + "title": "PriceAdjustment.isBasedOnCampaign" + }, + { + "description": "Identifies if the promotion line item results from a coupon.", + "id": "script-api:dw/order/PriceAdjustment#isBasedOnCoupon", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isBasedOnCoupon", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the promotion line item results from a coupon.", + "heading": "Description" + } + ], + "signature": "isBasedOnCoupon(): boolean", + "source": "script-api", + "tags": [ + "isbasedoncoupon", + "priceadjustment.isbasedoncoupon" + ], + "title": "PriceAdjustment.isBasedOnCoupon" + }, + { + "description": "Returns true if this PriceAdjustment was created by custom script code.", + "id": "script-api:dw/order/PriceAdjustment#isCustom", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isCustom", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this PriceAdjustment was created by custom script code.", + "heading": "Description" + } + ], + "signature": "isCustom(): boolean", + "source": "script-api", + "tags": [ + "iscustom", + "priceadjustment.iscustom" + ], + "title": "PriceAdjustment.isCustom" + }, + { + "description": "Returns true if this PriceAdjustment was added manually by a user.", + "id": "script-api:dw/order/PriceAdjustment#isManual", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.isManual", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this PriceAdjustment was added manually by a user.\n\nA manual PriceAdjustment is one which has been added as a result of\na user interaction e.g. by a user editing an order.\n\nA non-manual PriceAdjustment is one which has been added for a different\nreason, e.g. by custom logic which automatically adjusts the price of\nparticular products when certain conditions are met.", + "heading": "Description" + } + ], + "signature": "isManual(): boolean", + "source": "script-api", + "tags": [ + "ismanual", + "priceadjustment.ismanual" + ], + "title": "PriceAdjustment.isManual" + }, + { + "description": "Returns true if this PriceAdjustment was added manually by a user.", + "id": "script-api:dw/order/PriceAdjustment#manual", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.manual", + "sections": [ + { + "body": "Returns true if this PriceAdjustment was added manually by a user.\n\nA manual PriceAdjustment is one which has been added as a result of\na user interaction e.g. by a user editing an order.\n\nA non-manual PriceAdjustment is one which has been added for a different\nreason, e.g. by custom logic which automatically adjusts the price of\nparticular products when certain conditions are met.", + "heading": "Description" + } + ], + "signature": "manual: boolean", + "source": "script-api", + "tags": [ + "manual", + "priceadjustment.manual" + ], + "title": "PriceAdjustment.manual" + }, + { + "description": "Returns the promotion associated with this price adjustment. The associated promotion is determined from the promotionID and campaignID attributes which are set by the promotions engine when applying discounts. Alternatively if the promotion applied as part of an AB-test, then the associated promotion is determined from the promotionID attribute and the hidden attributes, abTestID and abTestGroupID.", + "id": "script-api:dw/order/PriceAdjustment#promotion", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.promotion", + "sections": [ + { + "body": "Returns the promotion associated with this price adjustment. The\nassociated promotion is determined from the promotionID and campaignID\nattributes which are set by the promotions engine when applying\ndiscounts. Alternatively if the promotion applied as part of an AB-test,\nthen the associated promotion is determined from the promotionID\nattribute and the hidden attributes, abTestID and abTestGroupID.\n\nIf the promotion has been removed from the system since this price\nadjustment was created, or if the promotion still exists but is not\nassigned to any campaign or AB-test, this method returns null. If the\npromotion has been reassigned to a different campaign or AB-test since\nthis price adjustment was created, then the system will return an\nappropriate Promotion instance. This method always returns null for\ncustom price adjustments.", + "heading": "Description" + } + ], + "signature": "readonly promotion: Promotion | null", + "source": "script-api", + "tags": [ + "promotion", + "priceadjustment.promotion" + ], + "title": "PriceAdjustment.promotion" + }, + { + "description": "Returns the ID of the promotion related to this price adjustment.", + "id": "script-api:dw/order/PriceAdjustment#promotionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.promotionID", + "sections": [ + { + "body": "Returns the ID of the promotion related to this price adjustment.", + "heading": "Description" + } + ], + "signature": "readonly promotionID: string", + "source": "script-api", + "tags": [ + "promotionid", + "priceadjustment.promotionid" + ], + "title": "PriceAdjustment.promotionID" + }, + { + "description": "Returns a map representing the product line items to which this price adjustment is \"related\" (in the sense defined below) and the portion of this adjustment's price which applies to each after discount prorating is performed. This information is sometimes useful to display in the storefront but is more often useful for integrating with backend order-management and accounting systems which require all discounts to be itemized.", + "id": "script-api:dw/order/PriceAdjustment#proratedPrices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.proratedPrices", + "sections": [ + { + "body": "Returns a map representing the product line items to which this price\nadjustment is \"related\" (in the sense defined below) and the portion of\nthis adjustment's price which applies to each after discount prorating is\nperformed. This information is sometimes useful to display in the\nstorefront but is more often useful for integrating with backend\norder-management and accounting systems which require all discounts to be\nitemized.\n\nThe definition of \"related\" product line items depends on the type of\npromotion which generated this price adjustment:\n\n- For order promotions, price adjustments are prorated across all\nproduct line items which are not explicitly excluded by the promotion.\nCustom order price adjustments apply to all items in the LineItemCtnr.\n- For Buy-X-Get-Y product promotions, price adjustments are prorated\nacross all items all product line items that are involved in the\npromotion, meaning that the PLI has one or more items contributing to the\nqualifying product count (i.e. the item is one of the X) or receiving the\ndiscount (i.e. the item is one of the Y).\n- Other product promotions are not prorated and simply adjust the\nparent product line item, and so the returned map is of size 1.\n- For shipping promotions, this method returns an empty map.\n\nBuy-X-Get-Y product promotions are prorated as follows: Each price\nadjustment generated by the promotion is sequentially prorated upon the\nrelated items according to the items' adjusted prices after all non-BOGO\nproduct promotions are considered, but before order promotions are\nconsidered.\n\nOrder promotions are prorated sequentially upon non-excluded items\naccording to the order in which they applied during promotion processing.\n\nThe values in the map are inclusive of tax if this price adjustment is\nbased on gross pricing, and exclusive of tax otherwise. The sum of the\nprorated prices always equals the price of this price adjustment.", + "heading": "Description" + } + ], + "signature": "readonly proratedPrices: utilMap", + "source": "script-api", + "tags": [ + "proratedprices", + "priceadjustment.proratedprices" + ], + "title": "PriceAdjustment.proratedPrices" + }, + { + "description": "Returns the number of items this price adjustment applies to. This value is always equal to 1 for price adjustments generated by order or shipping promotions. For price adjustments generated by product promotions, this value represents the number of units of the parent product line item to which the adjustment applies. Because promotions may have a maximum number of applications this value may be less than the product line item quantity.", + "id": "script-api:dw/order/PriceAdjustment#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.quantity", + "sections": [ + { + "body": "Returns the number of items this price adjustment applies to. This value\nis always equal to 1 for price adjustments generated by order or shipping\npromotions. For price adjustments generated by product promotions, this\nvalue represents the number of units of the parent product line item to\nwhich the adjustment applies. Because promotions may have a maximum\nnumber of applications this value may be less than the product line item\nquantity.\n\nFor custom price adjustments, not generated by the promotions engine,\nthis method always returns 0.", + "heading": "Description" + } + ], + "signature": "readonly quantity: number", + "source": "script-api", + "tags": [ + "quantity", + "priceadjustment.quantity" + ], + "title": "PriceAdjustment.quantity" + }, + { + "description": "Returns the reason code of the price adjustment. The list of available reason codes is editable system meta-data. An example for using the reason code is that in a call center application the CSR will explain why he gave a discount to the customer.", + "id": "script-api:dw/order/PriceAdjustment#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.reasonCode", + "sections": [ + { + "body": "Returns the reason code of the price adjustment. The list of available\nreason codes is editable system meta-data. An example for using the\nreason code is that in a call center application the CSR will explain\nwhy he gave a discount to the customer.", + "heading": "Description" + } + ], + "signature": "reasonCode: EnumValue", + "source": "script-api", + "tags": [ + "reasoncode", + "priceadjustment.reasoncode" + ], + "title": "PriceAdjustment.reasonCode" + }, + { + "description": "Marks the current PriceAdjustment as manual/non-manual.", + "id": "script-api:dw/order/PriceAdjustment#setManual", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aFlag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.setManual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Marks the current PriceAdjustment as manual/non-manual.\n\nNote that only custom PriceAdjustment can be marked as manual/non-manual.\n\nA manual PriceAdjustment is one which has been added as a result of\na user interaction e.g. by a user editing an order.\n\nA non-manual PriceAdjustment is one which has been added for a different\nreason, e.g. by custom logic which automatically adjusts the price of\nparticular products when certain conditions are met.", + "heading": "Description" + } + ], + "signature": "setManual(aFlag: boolean): void", + "source": "script-api", + "tags": [ + "setmanual", + "priceadjustment.setmanual" + ], + "throws": [ + { + "description": "if the adjustment is not custom", + "type": "IllegalArgumentException" + } + ], + "title": "PriceAdjustment.setManual" + }, + { + "description": "Set the reason code, using the internal non-localizable value. Standard values are 'PRICE_MATCH', 'BACKORDER' and 'EVEN_EXCHANGE', but the available list is editable system meta-data.", + "id": "script-api:dw/order/PriceAdjustment#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reasonCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/PriceAdjustment", + "qualifiedName": "dw.order.PriceAdjustment.setReasonCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the reason code, using the internal non-localizable value. Standard values are 'PRICE_MATCH',\n'BACKORDER' and 'EVEN_EXCHANGE', but the available list is editable system meta-data.", + "heading": "Description" + } + ], + "signature": "setReasonCode(reasonCode: string): void", + "source": "script-api", + "tags": [ + "setreasoncode", + "priceadjustment.setreasoncode" + ], + "title": "PriceAdjustment.setReasonCode" + }, + { + "description": "Helper class containing price adjustment limit types.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes", + "sections": [ + { + "body": "Helper class containing price adjustment limit types.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "priceadjustmentlimittypes", + "dw.order.priceadjustmentlimittypes", + "dw/order" + ], + "title": "PriceAdjustmentLimitTypes" + }, + { + "description": "Constant for Price Adjustment Limit Type Item.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ITEM", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ITEM", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Item.\n\nThe price adjustment limit was created at the item level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_ITEM: string", + "source": "script-api", + "tags": [ + "type_item", + "priceadjustmentlimittypes.type_item" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ITEM" + }, + { + "description": "Constant for Price Adjustment Limit Type Item.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ITEM", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ITEM", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Item.\n\nThe price adjustment limit was created at the item level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_ITEM: string", + "source": "script-api", + "tags": [ + "type_item", + "priceadjustmentlimittypes.type_item" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ITEM" + }, + { + "description": "Constant for Price Adjustment Limit Type Order.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ORDER", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Order.\n\nThe price adjustment limit was created at the order level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_ORDER: string", + "source": "script-api", + "tags": [ + "type_order", + "priceadjustmentlimittypes.type_order" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ORDER" + }, + { + "description": "Constant for Price Adjustment Limit Type Order.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_ORDER", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_ORDER", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Order.\n\nThe price adjustment limit was created at the order level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_ORDER: string", + "source": "script-api", + "tags": [ + "type_order", + "priceadjustmentlimittypes.type_order" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_ORDER" + }, + { + "description": "Constant for Price Adjustment Limit Type Shipping.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_SHIPPING", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Shipping.\n\nThe price adjustment limit was created at the shipping item level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_shipping", + "priceadjustmentlimittypes.type_shipping" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_SHIPPING" + }, + { + "description": "Constant for Price Adjustment Limit Type Shipping.", + "id": "script-api:dw/order/PriceAdjustmentLimitTypes#TYPE_SHIPPING", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/PriceAdjustmentLimitTypes", + "qualifiedName": "dw.order.PriceAdjustmentLimitTypes.TYPE_SHIPPING", + "sections": [ + { + "body": "Constant for Price Adjustment Limit Type Shipping.\n\nThe price adjustment limit was created at the shipping item level.", + "heading": "Description" + } + ], + "signature": "static readonly TYPE_SHIPPING: string", + "source": "script-api", + "tags": [ + "type_shipping", + "priceadjustmentlimittypes.type_shipping" + ], + "title": "PriceAdjustmentLimitTypes.TYPE_SHIPPING" + }, + { + "description": "Represents a specific product line item.", + "id": "script-api:dw/order/ProductLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductLineItem", + "sections": [ + { + "body": "Represents a specific product line item.", + "heading": "Description" + }, + { + "body": "Extends `LineItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productlineitem", + "dw.order.productlineitem", + "dw/order" + ], + "title": "ProductLineItem" + }, + { + "description": "Returns the gross price of the product line item after applying all product-level adjustments.", + "id": "script-api:dw/order/ProductLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedGrossPrice", + "sections": [ + { + "body": "Returns the gross price of the product line item after applying all product-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedgrossprice", + "productlineitem.adjustedgrossprice" + ], + "title": "ProductLineItem.adjustedGrossPrice" + }, + { + "description": "Returns the net price of the product line item after applying all product-level adjustments.", + "id": "script-api:dw/order/ProductLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedNetPrice", + "sections": [ + { + "body": "Returns the net price of the product line item after applying all product-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustednetprice", + "productlineitem.adjustednetprice" + ], + "title": "ProductLineItem.adjustedNetPrice" + }, + { + "description": "Returns the price of the product line item after applying all product-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice).", + "id": "script-api:dw/order/ProductLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedPrice", + "sections": [ + { + "body": "Returns the price of the product line item after applying all product-level\nadjustments. For net pricing the adjusted net price is returned\n(see getAdjustedNetPrice). For gross pricing, the adjusted\ngross price is returned (see getAdjustedGrossPrice).", + "heading": "Description" + } + ], + "signature": "readonly adjustedPrice: Money", + "source": "script-api", + "tags": [ + "adjustedprice", + "productlineitem.adjustedprice" + ], + "title": "ProductLineItem.adjustedPrice" + }, + { + "description": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/ProductLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.adjustedTax", + "sections": [ + { + "body": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "heading": "Description" + } + ], + "signature": "readonly adjustedTax: Money", + "source": "script-api", + "tags": [ + "adjustedtax", + "productlineitem.adjustedtax" + ], + "title": "ProductLineItem.adjustedTax" + }, + { + "description": "Returns the parent bonus discount line item of this line item. Only bonus product line items that have been selected by the customer as part of a BONUS_CHOICE discount have one of these.", + "id": "script-api:dw/order/ProductLineItem#bonusDiscountLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bonusDiscountLineItem", + "sections": [ + { + "body": "Returns the parent bonus discount line item of this line item. Only\nbonus product line items that have been selected by the customer as\npart of a BONUS_CHOICE discount have one of these.", + "heading": "Description" + } + ], + "signature": "readonly bonusDiscountLineItem: BonusDiscountLineItem | null", + "source": "script-api", + "tags": [ + "bonusdiscountlineitem", + "productlineitem.bonusdiscountlineitem" + ], + "title": "ProductLineItem.bonusDiscountLineItem" + }, + { + "description": "Identifies if the product line item represents a bonus line item.", + "id": "script-api:dw/order/ProductLineItem#bonusProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bonusProductLineItem", + "sections": [ + { + "body": "Identifies if the product line item represents a bonus line item.", + "heading": "Description" + } + ], + "signature": "readonly bonusProductLineItem: boolean", + "source": "script-api", + "tags": [ + "bonusproductlineitem", + "productlineitem.bonusproductlineitem" + ], + "title": "ProductLineItem.bonusProductLineItem" + }, + { + "description": "Identifies if the product line item represents a bundled line item.", + "id": "script-api:dw/order/ProductLineItem#bundledProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bundledProductLineItem", + "sections": [ + { + "body": "Identifies if the product line item represents a bundled line item.", + "heading": "Description" + } + ], + "signature": "readonly bundledProductLineItem: boolean", + "source": "script-api", + "tags": [ + "bundledproductlineitem", + "productlineitem.bundledproductlineitem" + ], + "title": "ProductLineItem.bundledProductLineItem" + }, + { + "description": "Returns a collection containing the bundled product line items.", + "id": "script-api:dw/order/ProductLineItem#bundledProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.bundledProductLineItems", + "sections": [ + { + "body": "Returns a collection containing the bundled product line items.", + "heading": "Description" + } + ], + "signature": "readonly bundledProductLineItems: Collection", + "source": "script-api", + "tags": [ + "bundledproductlineitems", + "productlineitem.bundledproductlineitems" + ], + "title": "ProductLineItem.bundledProductLineItems" + }, + { + "description": "Returns true if the product line item represents a catalog product.", + "examples": [ + "dw.catalog.ProductMgr.getProduct( productID ) != null\n&& dw.catalog.ProductMgr.getProduct( productID ).isAssignedToSiteCatalog()" + ], + "id": "script-api:dw/order/ProductLineItem#catalogProduct", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.catalogProduct", + "sections": [ + { + "body": "Returns true if the product line item represents a catalog product.\n\nThat flag is determined during product line item creation with\ndw.order.LineItemCtnr.createProductLineItem, stored at the line item container and can\nbe accessed as productLineItem.catalogProduct. It represents what can be evaluated with\n\n\nIf the product is not available during product line item creation it is considered a non catalog product line item without\nconnection to a product.", + "heading": "Description" + } + ], + "signature": "readonly catalogProduct: boolean", + "source": "script-api", + "tags": [ + "catalogproduct", + "productlineitem.catalogproduct" + ], + "title": "ProductLineItem.catalogProduct" + }, + { + "description": "Returns the category the product line item is associated with. If the line item is not associated with a category, or the category does not exist in the site catalog, the method returns null.", + "id": "script-api:dw/order/ProductLineItem#category", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.category", + "sections": [ + { + "body": "Returns the category the product line item is associated with. If the\nline item is not associated with a category, or the category does not\nexist in the site catalog, the method returns null.", + "heading": "Description" + } + ], + "signature": "category: Category | null", + "source": "script-api", + "tags": [ + "category", + "productlineitem.category" + ], + "title": "ProductLineItem.category" + }, + { + "description": "Returns the ID of the category the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#categoryID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.categoryID", + "sections": [ + { + "body": "Returns the ID of the category the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "categoryID: string | null", + "source": "script-api", + "tags": [ + "categoryid", + "productlineitem.categoryid" + ], + "title": "ProductLineItem.categoryID" + }, + { + "description": "Creates a product price adjustment.", + "id": "script-api:dw/order/ProductLineItem#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a product price adjustment.\n\nThe price adjustment line item is being initialized with the tax class code and tax rate of the product line\nitem. The promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce. If\nthere already exists a price adjustment for the same promotionID, an exception is thrown.", + "heading": "Description" + } + ], + "signature": "createPriceAdjustment(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "createpriceadjustment", + "productlineitem.createpriceadjustment" + ], + "title": "ProductLineItem.createPriceAdjustment" + }, + { + "description": "Creates a product price adjustment representing a specific discount. The price adjustment line item is initialized with the tax class code and tax rate of the product line item.", + "id": "script-api:dw/order/ProductLineItem#createPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + }, + { + "name": "discount", + "type": "Discount" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a product price adjustment representing a specific discount. The price adjustment line item is\ninitialized with the tax class code and tax rate of the product line item.\n\nThe promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce. If a price\nadjustment already exists for the same promotionID, an exception is thrown.\n\nThe possible discounts are dw.campaign.FixedPriceDiscount, dw.campaign.AmountDiscount,\ndw.campaign.PercentageDiscount. Example:", + "heading": "Description" + } + ], + "signature": "createPriceAdjustment(promotionID: string, discount: Discount): PriceAdjustment", + "source": "script-api", + "tags": [ + "createpriceadjustment", + "productlineitem.createpriceadjustment" + ], + "title": "ProductLineItem.createPriceAdjustment" + }, + { + "description": "Creates the dependent shipping line item for this line item. The shipping line item can define product-specific shipping costs for this product line item. This method has replace semantics: If there is an existing shipping line item it will be replaced with a new shipping line item.", + "id": "script-api:dw/order/ProductLineItem#createShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.createShippingLineItem", + "returns": { + "type": "ProductShippingLineItem" + }, + "sections": [ + { + "body": "Creates the dependent shipping line item for this line item.\nThe shipping line item can define product-specific shipping\ncosts for this product line item.\nThis method has replace semantics: If there is an existing\nshipping line item it will be replaced\nwith a new shipping line item.", + "heading": "Description" + } + ], + "signature": "createShippingLineItem(): ProductShippingLineItem", + "source": "script-api", + "tags": [ + "createshippinglineitem", + "productlineitem.createshippinglineitem" + ], + "title": "ProductLineItem.createShippingLineItem" + }, + { + "description": "Returns the value set for the external line item status or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#externalLineItemStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.externalLineItemStatus", + "sections": [ + { + "body": "Returns the value set for the external line item status\nor null if no value set.", + "heading": "Description" + } + ], + "signature": "externalLineItemStatus: string | null", + "source": "script-api", + "tags": [ + "externallineitemstatus", + "productlineitem.externallineitemstatus" + ], + "title": "ProductLineItem.externalLineItemStatus" + }, + { + "description": "Returns the value set for the external line item text or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#externalLineItemText", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.externalLineItemText", + "sections": [ + { + "body": "Returns the value set for the external line item text\nor null if no value set.", + "heading": "Description" + } + ], + "signature": "externalLineItemText: string | null", + "source": "script-api", + "tags": [ + "externallineitemtext", + "productlineitem.externallineitemtext" + ], + "title": "ProductLineItem.externalLineItemText" + }, + { + "description": "Returns the gross price of the product line item after applying all product-level adjustments.", + "id": "script-api:dw/order/ProductLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the gross price of the product line item after applying all product-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedgrossprice", + "productlineitem.getadjustedgrossprice" + ], + "title": "ProductLineItem.getAdjustedGrossPrice" + }, + { + "description": "Returns the net price of the product line item after applying all product-level adjustments.", + "id": "script-api:dw/order/ProductLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the net price of the product line item after applying all product-level\nadjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustednetprice", + "productlineitem.getadjustednetprice" + ], + "title": "ProductLineItem.getAdjustedNetPrice" + }, + { + "description": "Returns the price of the product line item after applying all product-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice).", + "id": "script-api:dw/order/ProductLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of the product line item after applying all product-level\nadjustments. For net pricing the adjusted net price is returned\n(see getAdjustedNetPrice). For gross pricing, the adjusted\ngross price is returned (see getAdjustedGrossPrice).", + "heading": "Description" + } + ], + "signature": "getAdjustedPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedprice", + "productlineitem.getadjustedprice" + ], + "title": "ProductLineItem.getAdjustedPrice" + }, + { + "description": "Returns the price of this product line item after considering all dependent price adjustments and optionally prorating all order-level price adjustments. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/ProductLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "applyOrderLevelAdjustments", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of this product line item after considering all\ndependent price adjustments and optionally prorating all order-level\nprice adjustments. For net pricing the net price is returned. For gross\npricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedPrice(applyOrderLevelAdjustments: boolean): Money", + "source": "script-api", + "tags": [ + "getadjustedprice", + "productlineitem.getadjustedprice" + ], + "title": "ProductLineItem.getAdjustedPrice" + }, + { + "description": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/ProductLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getAdjustedTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "heading": "Description" + } + ], + "signature": "getAdjustedTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedtax", + "productlineitem.getadjustedtax" + ], + "title": "ProductLineItem.getAdjustedTax" + }, + { + "description": "Returns the parent bonus discount line item of this line item. Only bonus product line items that have been selected by the customer as part of a BONUS_CHOICE discount have one of these.", + "id": "script-api:dw/order/ProductLineItem#getBonusDiscountLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getBonusDiscountLineItem", + "returns": { + "type": "BonusDiscountLineItem | null" + }, + "sections": [ + { + "body": "Returns the parent bonus discount line item of this line item. Only\nbonus product line items that have been selected by the customer as\npart of a BONUS_CHOICE discount have one of these.", + "heading": "Description" + } + ], + "signature": "getBonusDiscountLineItem(): BonusDiscountLineItem | null", + "source": "script-api", + "tags": [ + "getbonusdiscountlineitem", + "productlineitem.getbonusdiscountlineitem" + ], + "title": "ProductLineItem.getBonusDiscountLineItem" + }, + { + "description": "Returns a collection containing the bundled product line items.", + "id": "script-api:dw/order/ProductLineItem#getBundledProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getBundledProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing the bundled product line items.", + "heading": "Description" + } + ], + "signature": "getBundledProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getbundledproductlineitems", + "productlineitem.getbundledproductlineitems" + ], + "title": "ProductLineItem.getBundledProductLineItems" + }, + { + "description": "Returns the category the product line item is associated with. If the line item is not associated with a category, or the category does not exist in the site catalog, the method returns null.", + "id": "script-api:dw/order/ProductLineItem#getCategory", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getCategory", + "returns": { + "type": "Category | null" + }, + "sections": [ + { + "body": "Returns the category the product line item is associated with. If the\nline item is not associated with a category, or the category does not\nexist in the site catalog, the method returns null.", + "heading": "Description" + } + ], + "signature": "getCategory(): Category | null", + "source": "script-api", + "tags": [ + "getcategory", + "productlineitem.getcategory" + ], + "title": "ProductLineItem.getCategory" + }, + { + "description": "Returns the ID of the category the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#getCategoryID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getCategoryID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the category the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "getCategoryID(): string | null", + "source": "script-api", + "tags": [ + "getcategoryid", + "productlineitem.getcategoryid" + ], + "title": "ProductLineItem.getCategoryID" + }, + { + "description": "Returns the value set for the external line item status or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#getExternalLineItemStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getExternalLineItemStatus", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value set for the external line item status\nor null if no value set.", + "heading": "Description" + } + ], + "signature": "getExternalLineItemStatus(): string | null", + "source": "script-api", + "tags": [ + "getexternallineitemstatus", + "productlineitem.getexternallineitemstatus" + ], + "title": "ProductLineItem.getExternalLineItemStatus" + }, + { + "description": "Returns the value set for the external line item text or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#getExternalLineItemText", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getExternalLineItemText", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value set for the external line item text\nor null if no value set.", + "heading": "Description" + } + ], + "signature": "getExternalLineItemText(): string | null", + "source": "script-api", + "tags": [ + "getexternallineitemtext", + "productlineitem.getexternallineitemtext" + ], + "title": "ProductLineItem.getExternalLineItemText" + }, + { + "description": "Returns the value set for gift message or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#getGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getGiftMessage", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value set for gift message or null if no value set.", + "heading": "Description" + } + ], + "signature": "getGiftMessage(): string | null", + "source": "script-api", + "tags": [ + "getgiftmessage", + "productlineitem.getgiftmessage" + ], + "title": "ProductLineItem.getGiftMessage" + }, + { + "description": "Returns the name of the manfacturer of the product.", + "id": "script-api:dw/order/ProductLineItem#getManufacturerName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getManufacturerName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the manfacturer of the product.", + "heading": "Description" + } + ], + "signature": "getManufacturerName(): string", + "source": "script-api", + "tags": [ + "getmanufacturername", + "productlineitem.getmanufacturername" + ], + "title": "ProductLineItem.getManufacturerName" + }, + { + "description": "Returns the name of the manfacturer's SKU of this product line item.", + "id": "script-api:dw/order/ProductLineItem#getManufacturerSKU", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getManufacturerSKU", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the manfacturer's SKU of this product line item.", + "heading": "Description" + } + ], + "signature": "getManufacturerSKU(): string", + "source": "script-api", + "tags": [ + "getmanufacturersku", + "productlineitem.getmanufacturersku" + ], + "title": "ProductLineItem.getManufacturerSKU" + }, + { + "description": "Returns the minimal order quantity allowed for the product represented by the ProductLineItem (copied from product on initialization). Note: the quantity of a ProductLineItem must obey the limits set by the ProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e. for a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values 2.0, 4.5, 7.0... are allowed values.", + "id": "script-api:dw/order/ProductLineItem#getMinOrderQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getMinOrderQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the minimal order quantity allowed for the product represented by the\nProductLineItem (copied from product on initialization).\nNote: the quantity of a ProductLineItem must obey the limits set by the\nProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e.\nfor a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values\n2.0, 4.5, 7.0... are allowed values.", + "heading": "Description" + } + ], + "signature": "getMinOrderQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getminorderquantity", + "productlineitem.getminorderquantity" + ], + "title": "ProductLineItem.getMinOrderQuantity" + }, + { + "description": "Return the value portion of getMinOrderQuantity().", + "id": "script-api:dw/order/ProductLineItem#getMinOrderQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getMinOrderQuantityValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Return the value portion of getMinOrderQuantity().", + "heading": "Description" + } + ], + "signature": "getMinOrderQuantityValue(): number", + "source": "script-api", + "tags": [ + "getminorderquantityvalue", + "productlineitem.getminorderquantityvalue" + ], + "title": "ProductLineItem.getMinOrderQuantityValue" + }, + { + "description": "Returns the ID of the product option this product line item represents. If the product line item does not represent an option, null is returned.", + "id": "script-api:dw/order/ProductLineItem#getOptionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the product option this product line item\nrepresents. If the product line item does not represent an option,\nnull is returned.", + "heading": "Description" + } + ], + "signature": "getOptionID(): string | null", + "source": "script-api", + "tags": [ + "getoptionid", + "productlineitem.getoptionid" + ], + "title": "ProductLineItem.getOptionID" + }, + { + "description": "Returns the product option model for a product line item representing an option product.", + "id": "script-api:dw/order/ProductLineItem#getOptionModel", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionModel", + "returns": { + "type": "ProductOptionModel | null" + }, + "sections": [ + { + "body": "Returns the product option model for a product line item representing an option product.\n\nThe returned option model has preselected values based on the dependent option line items of this product line\nitem. Null is returned if this line item does not represent an option product.", + "heading": "Description" + } + ], + "signature": "getOptionModel(): ProductOptionModel | null", + "source": "script-api", + "tags": [ + "getoptionmodel", + "productlineitem.getoptionmodel" + ], + "title": "ProductLineItem.getOptionModel" + }, + { + "description": "Returns a collection containing option product line items.", + "id": "script-api:dw/order/ProductLineItem#getOptionProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection containing option product line items.", + "heading": "Description" + } + ], + "signature": "getOptionProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getoptionproductlineitems", + "productlineitem.getoptionproductlineitems" + ], + "title": "ProductLineItem.getOptionProductLineItems" + }, + { + "description": "Returns the ID of the product option value this product line item represents. If the product line item does not represent an option, null is returned.", + "id": "script-api:dw/order/ProductLineItem#getOptionValueID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOptionValueID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the product option value this product line item\nrepresents. If the product line item does not represent an option,\nnull is returned.", + "heading": "Description" + } + ], + "signature": "getOptionValueID(): string | null", + "source": "script-api", + "tags": [ + "getoptionvalueid", + "productlineitem.getoptionvalueid" + ], + "title": "ProductLineItem.getOptionValueID" + }, + { + "description": "Returns the dw.order.OrderItem order-item extension for this item, or null. An order-item extension will only exist for a ProductLineItem which belongs to an dw.order.Order.", + "id": "script-api:dw/order/ProductLineItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getOrderItem", + "returns": { + "type": "OrderItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.OrderItem order-item extension for this item, or null. An order-item\nextension will only exist for a ProductLineItem which belongs to an dw.order.Order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getOrderItem(): OrderItem | null", + "source": "script-api", + "tags": [ + "getorderitem", + "productlineitem.getorderitem" + ], + "title": "ProductLineItem.getOrderItem" + }, + { + "description": "Returns the parent line item of this line item or null if the line item is independent.", + "id": "script-api:dw/order/ProductLineItem#getParent", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getParent", + "returns": { + "type": "ProductLineItem | null" + }, + "sections": [ + { + "body": "Returns the parent line item of this line item or null if the line item\nis independent.", + "heading": "Description" + } + ], + "signature": "getParent(): ProductLineItem | null", + "source": "script-api", + "tags": [ + "getparent", + "productlineitem.getparent" + ], + "title": "ProductLineItem.getParent" + }, + { + "description": "Returns the position within the line item container assigned to the ProductLineItem upon its creation, may be used as a sort-order.", + "id": "script-api:dw/order/ProductLineItem#getPosition", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPosition", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the position within the line item container assigned to the ProductLineItem upon its creation, may be\nused as a sort-order.\n\nThe position is updated in the following way:\n\n- When a ProductLineItem is added to the LineItemCtnr, it is assigned the next available position, based on the\ncurrent count\n- When a ProductLineItem is removed from the LineItemCtnr then LineItemCtnr method reassignPositions is called,\nso that the 'gap' left by the removed line-item is refilled. This method is dependent on no 2 ProductLineItem\nhaving the same position.\n- When a LineItemCtnr is copied (e.g. when a PlacedOrder is created from a Basket), no special position\nhandling is necessary as the ProductLineItems are added according to their current position ordering in the\nsource LineItemCtnr.", + "heading": "Description" + } + ], + "signature": "getPosition(): number", + "source": "script-api", + "tags": [ + "getposition", + "productlineitem.getposition" + ], + "title": "ProductLineItem.getPosition" + }, + { + "description": "Returns the first price adjustment associated to the specified promotion ID. It is highly recommended to use getPriceAdjustmentsByPromotionID instead. If there are multiple price adjustments for the same promotion, this method will return the first found. Alternatively, to uniquely identify a price adjustment using its promotion id and coupon code, use getPriceAdjustmentByPromotionIDAndCouponCode", + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentByPromotionID", + "returns": { + "type": "PriceAdjustment | null" + }, + "sections": [ + { + "body": "Returns the first price adjustment associated to the specified promotion ID. It is highly recommended to use\ngetPriceAdjustmentsByPromotionID instead. If there are multiple price adjustments for the same\npromotion, this method will return the first found. Alternatively, to uniquely identify a price adjustment using\nits promotion id and coupon code, use getPriceAdjustmentByPromotionIDAndCouponCode", + "heading": "Description" + } + ], + "signature": "getPriceAdjustmentByPromotionID(promotionID: string): PriceAdjustment | null", + "source": "script-api", + "tags": [ + "getpriceadjustmentbypromotionid", + "productlineitem.getpriceadjustmentbypromotionid" + ], + "title": "ProductLineItem.getPriceAdjustmentByPromotionID" + }, + { + "description": "Returns the price adjustment associated to the specified promotion ID and coupon code combination.", + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentByPromotionIDAndCouponCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + }, + { + "name": "couponCode", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentByPromotionIDAndCouponCode", + "returns": { + "type": "PriceAdjustment | null" + }, + "sections": [ + { + "body": "Returns the price adjustment associated to the specified promotion ID and coupon code combination.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustmentByPromotionIDAndCouponCode(promotionID: string, couponCode: string | null): PriceAdjustment | null", + "source": "script-api", + "tags": [ + "getpriceadjustmentbypromotionidandcouponcode", + "productlineitem.getpriceadjustmentbypromotionidandcouponcode" + ], + "title": "ProductLineItem.getPriceAdjustmentByPromotionIDAndCouponCode" + }, + { + "description": "Returns an iterator of price adjustments that have been applied to this product line item such as promotions on the purchase price (i.e. $10 Off or 10% Off).", + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an iterator of price adjustments that have been applied to this\nproduct line item such as promotions on the purchase price\n(i.e. $10 Off or 10% Off).", + "heading": "Description" + } + ], + "signature": "getPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getpriceadjustments", + "productlineitem.getpriceadjustments" + ], + "title": "ProductLineItem.getPriceAdjustments" + }, + { + "description": "Returns the collection of price adjustments associated to the specified promotion ID. If only one coupon code is allowed per order, then the collection should only ever have a single entry in it. The multiple coupon code feature can cause multiple price adjustments to be returned.", + "id": "script-api:dw/order/ProductLineItem#getPriceAdjustmentsByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getPriceAdjustmentsByPromotionID", + "returns": { + "type": "Collection | null" + }, + "sections": [ + { + "body": "Returns the collection of price adjustments associated to the specified promotion ID. If only one coupon code is\nallowed per order, then the collection should only ever have a single entry in it. The multiple coupon code\nfeature can cause multiple price adjustments to be returned.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustmentsByPromotionID(promotionID: string): Collection | null", + "source": "script-api", + "tags": [ + "getpriceadjustmentsbypromotionid", + "productlineitem.getpriceadjustmentsbypromotionid" + ], + "title": "ProductLineItem.getPriceAdjustmentsByPromotionID" + }, + { + "description": "Returns the product associated with the product line item.", + "id": "script-api:dw/order/ProductLineItem#getProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProduct", + "returns": { + "type": "Product | null" + }, + "sections": [ + { + "body": "Returns the product associated with the product line item.\n\nThe product line item might not be related to an actual catalog product, for example if it represents an option,\nor was not created from a catalog product, or if the product does not exist in the catalog anymore. In these\ncases, the method returns null.", + "heading": "Description" + } + ], + "signature": "getProduct(): Product | null", + "source": "script-api", + "tags": [ + "getproduct", + "productlineitem.getproduct" + ], + "title": "ProductLineItem.getProduct" + }, + { + "description": "Returns the ID of the related product.", + "id": "script-api:dw/order/ProductLineItem#getProductID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the related product.\n\nReturns empty if no product is related.", + "heading": "Description" + } + ], + "signature": "getProductID(): string", + "source": "script-api", + "tags": [ + "getproductid", + "productlineitem.getproductid" + ], + "title": "ProductLineItem.getProductID" + }, + { + "description": "Returns the inventory list the product line item is associated with. If the line item is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/order/ProductLineItem#getProductInventoryList", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductInventoryList", + "returns": { + "type": "ProductInventoryList | null" + }, + "sections": [ + { + "body": "Returns the inventory list the product line item is associated with. If the\nline item is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "getProductInventoryList(): ProductInventoryList | null", + "source": "script-api", + "tags": [ + "getproductinventorylist", + "productlineitem.getproductinventorylist" + ], + "title": "ProductLineItem.getProductInventoryList" + }, + { + "description": "Returns the ID of the inventory list the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#getProductInventoryListID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductInventoryListID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the inventory list the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "getProductInventoryListID(): string | null", + "source": "script-api", + "tags": [ + "getproductinventorylistid", + "productlineitem.getproductinventorylistid" + ], + "title": "ProductLineItem.getProductInventoryListID" + }, + { + "description": "Returns the associated ProductListItem.", + "id": "script-api:dw/order/ProductLineItem#getProductListItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductListItem", + "returns": { + "type": "ProductListItem | null" + }, + "sections": [ + { + "body": "Returns the associated ProductListItem.", + "heading": "Description" + } + ], + "signature": "getProductListItem(): ProductListItem | null", + "source": "script-api", + "tags": [ + "getproductlistitem", + "productlineitem.getproductlistitem" + ], + "title": "ProductLineItem.getProductListItem" + }, + { + "description": "Returns the name of the product that was copied when product was added to line item container.", + "id": "script-api:dw/order/ProductLineItem#getProductName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProductName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the product that was copied when\nproduct was added to line item container.", + "heading": "Description" + } + ], + "signature": "getProductName(): string", + "source": "script-api", + "tags": [ + "getproductname", + "productlineitem.getproductname" + ], + "title": "ProductLineItem.getProductName" + }, + { + "description": "Returns the price of this product line item after considering all dependent price adjustments and prorating all Buy-X-Get-Y and order-level discounts, according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/ProductLineItem#getProratedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProratedPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of this product line item after considering all\ndependent price adjustments and prorating all Buy-X-Get-Y\nand order-level discounts, according to the scheme described in\ndw.order.PriceAdjustment.getProratedPrices. For net pricing the\nnet price is returned. For gross pricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "getProratedPrice(): Money", + "source": "script-api", + "tags": [ + "getproratedprice", + "productlineitem.getproratedprice" + ], + "title": "ProductLineItem.getProratedPrice" + }, + { + "description": "Returns a Map of PriceAdjustment to Money instances. They keys to this map are the price adjustments that apply to this ProductLineItem either directly or indirectly when discounts are prorated according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. The values in the map are the portion of the adjustment which applies to this particular product line item.", + "id": "script-api:dw/order/ProductLineItem#getProratedPriceAdjustmentPrices", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getProratedPriceAdjustmentPrices", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a Map of PriceAdjustment to Money instances. They keys to this\nmap are the price adjustments that apply to this ProductLineItem either\ndirectly or indirectly when discounts are prorated according to the\nscheme described in dw.order.PriceAdjustment.getProratedPrices.\nThe values in the map are the portion of the adjustment which applies to\nthis particular product line item.", + "heading": "Description" + } + ], + "signature": "getProratedPriceAdjustmentPrices(): utilMap", + "source": "script-api", + "tags": [ + "getproratedpriceadjustmentprices", + "productlineitem.getproratedpriceadjustmentprices" + ], + "title": "ProductLineItem.getProratedPriceAdjustmentPrices" + }, + { + "description": "Returns the ProductLineItem that qualified the basket for this bonus product.", + "id": "script-api:dw/order/ProductLineItem#getQualifyingProductLineItemForBonusProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQualifyingProductLineItemForBonusProduct", + "returns": { + "type": "ProductLineItem | null" + }, + "sections": [ + { + "body": "Returns the ProductLineItem that qualified the basket for this bonus product.\n\nThis method is only applicable if the product line item is a bonus product line item, and if the promotion is a\nproduct promotion with number of qualifying products granting a bonus-product discount. If these conditions\naren't met, the method returns null. If there are multiple product line items that triggered this bonus product,\nthis method returns the last one by position within the order.", + "heading": "Description" + } + ], + "signature": "getQualifyingProductLineItemForBonusProduct(): ProductLineItem | null", + "source": "script-api", + "tags": [ + "getqualifyingproductlineitemforbonusproduct", + "productlineitem.getqualifyingproductlineitemforbonusproduct" + ], + "title": "ProductLineItem.getQualifyingProductLineItemForBonusProduct" + }, + { + "description": "Returns the quantity of the product represented by this ProductLineItem.", + "id": "script-api:dw/order/ProductLineItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of the product represented by this ProductLineItem.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "productlineitem.getquantity" + ], + "title": "ProductLineItem.getQuantity" + }, + { + "description": "Returns the value of the quantity of this ProductLineItem.", + "id": "script-api:dw/order/ProductLineItem#getQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getQuantityValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value of the quantity of this ProductLineItem.", + "heading": "Description" + } + ], + "signature": "getQuantityValue(): number", + "source": "script-api", + "tags": [ + "getquantityvalue", + "productlineitem.getquantityvalue" + ], + "title": "ProductLineItem.getQuantityValue" + }, + { + "description": "Returns all bonus product line items for which this line item is a qualifying product line item. This method is usually called when rendering the cart so that bonus products can be shown next to the products that triggered their creation.", + "id": "script-api:dw/order/ProductLineItem#getRelatedBonusProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getRelatedBonusProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all bonus product line items for which this line item is a\nqualifying product line item. This method is usually called when\nrendering the cart so that bonus products can be shown next to the\nproducts that triggered their creation.", + "heading": "Description" + } + ], + "signature": "getRelatedBonusProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getrelatedbonusproductlineitems", + "productlineitem.getrelatedbonusproductlineitems" + ], + "title": "ProductLineItem.getRelatedBonusProductLineItems" + }, + { + "description": "Returns the associated Shipment.", + "id": "script-api:dw/order/ProductLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getShipment", + "returns": { + "type": "Shipment" + }, + "sections": [ + { + "body": "Returns the associated Shipment.", + "heading": "Description" + } + ], + "signature": "getShipment(): Shipment", + "source": "script-api", + "tags": [ + "getshipment", + "productlineitem.getshipment" + ], + "title": "ProductLineItem.getShipment" + }, + { + "description": "Returns the dependent shipping line item of this line item. The shipping line item can define product-specific shipping costs for this product line item.", + "id": "script-api:dw/order/ProductLineItem#getShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getShippingLineItem", + "returns": { + "type": "ProductShippingLineItem | null" + }, + "sections": [ + { + "body": "Returns the dependent shipping line item of this line item.\nThe shipping line item can define product-specific shipping\ncosts for this product line item.", + "heading": "Description" + } + ], + "signature": "getShippingLineItem(): ProductShippingLineItem | null", + "source": "script-api", + "tags": [ + "getshippinglineitem", + "productlineitem.getshippinglineitem" + ], + "title": "ProductLineItem.getShippingLineItem" + }, + { + "description": "Returns step quantity allowed for the product represented by the ProductLineItem (copied from product on initialization). Note: the quantity of a ProductLineItem must obey the limits set by the ProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e. for a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values 2.0, 4.5, 7.0... are allowed values.", + "id": "script-api:dw/order/ProductLineItem#getStepQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getStepQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns step quantity allowed for the product represented by the ProductLineItem\n(copied from product on initialization).\nNote: the quantity of a ProductLineItem must obey the limits set by the\nProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e.\nfor a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values\n2.0, 4.5, 7.0... are allowed values.", + "heading": "Description" + } + ], + "signature": "getStepQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getstepquantity", + "productlineitem.getstepquantity" + ], + "title": "ProductLineItem.getStepQuantity" + }, + { + "description": "Return the value portion of getStepQuantity().", + "id": "script-api:dw/order/ProductLineItem#getStepQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.getStepQuantityValue", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Return the value portion of getStepQuantity().", + "heading": "Description" + } + ], + "signature": "getStepQuantityValue(): number", + "source": "script-api", + "tags": [ + "getstepquantityvalue", + "productlineitem.getstepquantityvalue" + ], + "title": "ProductLineItem.getStepQuantityValue" + }, + { + "description": "Returns true if this line item represents a gift, false otherwise.", + "id": "script-api:dw/order/ProductLineItem#gift", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.gift", + "sections": [ + { + "body": "Returns true if this line item represents a gift, false otherwise.", + "heading": "Description" + } + ], + "signature": "gift: boolean", + "source": "script-api", + "tags": [ + "gift", + "productlineitem.gift" + ], + "title": "ProductLineItem.gift" + }, + { + "description": "Returns the value set for gift message or null if no value set.", + "id": "script-api:dw/order/ProductLineItem#giftMessage", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.giftMessage", + "sections": [ + { + "body": "Returns the value set for gift message or null if no value set.", + "heading": "Description" + } + ], + "signature": "giftMessage: string | null", + "source": "script-api", + "tags": [ + "giftmessage", + "productlineitem.giftmessage" + ], + "title": "ProductLineItem.giftMessage" + }, + { + "description": "Identifies if the product line item represents a bonus line item.", + "id": "script-api:dw/order/ProductLineItem#isBonusProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isBonusProductLineItem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product line item represents a bonus line item.", + "heading": "Description" + } + ], + "signature": "isBonusProductLineItem(): boolean", + "source": "script-api", + "tags": [ + "isbonusproductlineitem", + "productlineitem.isbonusproductlineitem" + ], + "title": "ProductLineItem.isBonusProductLineItem" + }, + { + "description": "Identifies if the product line item represents a bundled line item.", + "id": "script-api:dw/order/ProductLineItem#isBundledProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isBundledProductLineItem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product line item represents a bundled line item.", + "heading": "Description" + } + ], + "signature": "isBundledProductLineItem(): boolean", + "source": "script-api", + "tags": [ + "isbundledproductlineitem", + "productlineitem.isbundledproductlineitem" + ], + "title": "ProductLineItem.isBundledProductLineItem" + }, + { + "description": "Returns true if the product line item represents a catalog product.", + "examples": [ + "dw.catalog.ProductMgr.getProduct( productID ) != null\n&& dw.catalog.ProductMgr.getProduct( productID ).isAssignedToSiteCatalog()" + ], + "id": "script-api:dw/order/ProductLineItem#isCatalogProduct", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isCatalogProduct", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the product line item represents a catalog product.\n\nThat flag is determined during product line item creation with\ndw.order.LineItemCtnr.createProductLineItem, stored at the line item container and can\nbe accessed as productLineItem.catalogProduct. It represents what can be evaluated with\n\n\nIf the product is not available during product line item creation it is considered a non catalog product line item without\nconnection to a product.", + "heading": "Description" + } + ], + "signature": "isCatalogProduct(): boolean", + "source": "script-api", + "tags": [ + "iscatalogproduct", + "productlineitem.iscatalogproduct" + ], + "title": "ProductLineItem.isCatalogProduct" + }, + { + "description": "Returns true if this line item represents a gift, false otherwise.", + "id": "script-api:dw/order/ProductLineItem#isGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isGift", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this line item represents a gift, false otherwise.", + "heading": "Description" + } + ], + "signature": "isGift(): boolean", + "source": "script-api", + "tags": [ + "isgift", + "productlineitem.isgift" + ], + "title": "ProductLineItem.isGift" + }, + { + "description": "Identifies if the product line item represents an option line item. Option line items do not represent true products but rather options of products. An option line item always has a parent product line item representing a true product.", + "id": "script-api:dw/order/ProductLineItem#isOptionProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isOptionProductLineItem", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if the product line item represents an option line item.\nOption line items do not represent true products but rather options of\nproducts. An option line item always has a parent product line item\nrepresenting a true product.", + "heading": "Description" + } + ], + "signature": "isOptionProductLineItem(): boolean", + "source": "script-api", + "tags": [ + "isoptionproductlineitem", + "productlineitem.isoptionproductlineitem" + ], + "title": "ProductLineItem.isOptionProductLineItem" + }, + { + "description": "Returns if the product line item is reserved.", + "id": "script-api:dw/order/ProductLineItem#isReserved", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.isReserved", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns if the product line item is reserved.\n\nReservations for the basket can be created with e.g. dw.order.Basket.reserveInventory.\n\nMethod must only be called for basket product line items. Exception is thrown if called for order product line\nitem.", + "heading": "Description" + } + ], + "signature": "isReserved(): boolean", + "source": "script-api", + "tags": [ + "isreserved", + "productlineitem.isreserved" + ], + "title": "ProductLineItem.isReserved" + }, + { + "description": "Returns the name of the manfacturer of the product.", + "id": "script-api:dw/order/ProductLineItem#manufacturerName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.manufacturerName", + "sections": [ + { + "body": "Returns the name of the manfacturer of the product.", + "heading": "Description" + } + ], + "signature": "manufacturerName: string", + "source": "script-api", + "tags": [ + "manufacturername", + "productlineitem.manufacturername" + ], + "title": "ProductLineItem.manufacturerName" + }, + { + "description": "Returns the name of the manfacturer's SKU of this product line item.", + "id": "script-api:dw/order/ProductLineItem#manufacturerSKU", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.manufacturerSKU", + "sections": [ + { + "body": "Returns the name of the manfacturer's SKU of this product line item.", + "heading": "Description" + } + ], + "signature": "manufacturerSKU: string", + "source": "script-api", + "tags": [ + "manufacturersku", + "productlineitem.manufacturersku" + ], + "title": "ProductLineItem.manufacturerSKU" + }, + { + "description": "Returns the minimal order quantity allowed for the product represented by the ProductLineItem (copied from product on initialization). Note: the quantity of a ProductLineItem must obey the limits set by the ProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e. for a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values 2.0, 4.5, 7.0... are allowed values.", + "id": "script-api:dw/order/ProductLineItem#minOrderQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.minOrderQuantity", + "sections": [ + { + "body": "Returns the minimal order quantity allowed for the product represented by the\nProductLineItem (copied from product on initialization).\nNote: the quantity of a ProductLineItem must obey the limits set by the\nProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e.\nfor a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values\n2.0, 4.5, 7.0... are allowed values.", + "heading": "Description" + } + ], + "signature": "readonly minOrderQuantity: Quantity", + "source": "script-api", + "tags": [ + "minorderquantity", + "productlineitem.minorderquantity" + ], + "title": "ProductLineItem.minOrderQuantity" + }, + { + "description": "Return the value portion of getMinOrderQuantity().", + "id": "script-api:dw/order/ProductLineItem#minOrderQuantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.minOrderQuantityValue", + "sections": [ + { + "body": "Return the value portion of getMinOrderQuantity().", + "heading": "Description" + } + ], + "signature": "minOrderQuantityValue: number", + "source": "script-api", + "tags": [ + "minorderquantityvalue", + "productlineitem.minorderquantityvalue" + ], + "title": "ProductLineItem.minOrderQuantityValue" + }, + { + "description": "Returns the ID of the product option this product line item represents. If the product line item does not represent an option, null is returned.", + "id": "script-api:dw/order/ProductLineItem#optionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionID", + "sections": [ + { + "body": "Returns the ID of the product option this product line item\nrepresents. If the product line item does not represent an option,\nnull is returned.", + "heading": "Description" + } + ], + "signature": "readonly optionID: string | null", + "source": "script-api", + "tags": [ + "optionid", + "productlineitem.optionid" + ], + "title": "ProductLineItem.optionID" + }, + { + "description": "Returns the product option model for a product line item representing an option product.", + "id": "script-api:dw/order/ProductLineItem#optionModel", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionModel", + "sections": [ + { + "body": "Returns the product option model for a product line item representing an option product.\n\nThe returned option model has preselected values based on the dependent option line items of this product line\nitem. Null is returned if this line item does not represent an option product.", + "heading": "Description" + } + ], + "signature": "readonly optionModel: ProductOptionModel | null", + "source": "script-api", + "tags": [ + "optionmodel", + "productlineitem.optionmodel" + ], + "title": "ProductLineItem.optionModel" + }, + { + "description": "Identifies if the product line item represents an option line item. Option line items do not represent true products but rather options of products. An option line item always has a parent product line item representing a true product.", + "id": "script-api:dw/order/ProductLineItem#optionProductLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionProductLineItem", + "sections": [ + { + "body": "Identifies if the product line item represents an option line item.\nOption line items do not represent true products but rather options of\nproducts. An option line item always has a parent product line item\nrepresenting a true product.", + "heading": "Description" + } + ], + "signature": "readonly optionProductLineItem: boolean", + "source": "script-api", + "tags": [ + "optionproductlineitem", + "productlineitem.optionproductlineitem" + ], + "title": "ProductLineItem.optionProductLineItem" + }, + { + "description": "Returns a collection containing option product line items.", + "id": "script-api:dw/order/ProductLineItem#optionProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionProductLineItems", + "sections": [ + { + "body": "Returns a collection containing option product line items.", + "heading": "Description" + } + ], + "signature": "readonly optionProductLineItems: Collection", + "source": "script-api", + "tags": [ + "optionproductlineitems", + "productlineitem.optionproductlineitems" + ], + "title": "ProductLineItem.optionProductLineItems" + }, + { + "description": "Returns the ID of the product option value this product line item represents. If the product line item does not represent an option, null is returned.", + "id": "script-api:dw/order/ProductLineItem#optionValueID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.optionValueID", + "sections": [ + { + "body": "Returns the ID of the product option value this product line item\nrepresents. If the product line item does not represent an option,\nnull is returned.", + "heading": "Description" + } + ], + "signature": "readonly optionValueID: string | null", + "source": "script-api", + "tags": [ + "optionvalueid", + "productlineitem.optionvalueid" + ], + "title": "ProductLineItem.optionValueID" + }, + { + "description": "Returns the dw.order.OrderItem order-item extension for this item, or null. An order-item extension will only exist for a ProductLineItem which belongs to an dw.order.Order.", + "id": "script-api:dw/order/ProductLineItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.orderItem", + "sections": [ + { + "body": "Returns the dw.order.OrderItem order-item extension for this item, or null. An order-item\nextension will only exist for a ProductLineItem which belongs to an dw.order.Order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly orderItem: OrderItem | null", + "source": "script-api", + "tags": [ + "orderitem", + "productlineitem.orderitem" + ], + "title": "ProductLineItem.orderItem" + }, + { + "description": "Returns the parent line item of this line item or null if the line item is independent.", + "id": "script-api:dw/order/ProductLineItem#parent", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.parent", + "sections": [ + { + "body": "Returns the parent line item of this line item or null if the line item\nis independent.", + "heading": "Description" + } + ], + "signature": "readonly parent: ProductLineItem | null", + "source": "script-api", + "tags": [ + "parent", + "productlineitem.parent" + ], + "title": "ProductLineItem.parent" + }, + { + "description": "Returns the position within the line item container assigned to the ProductLineItem upon its creation, may be used as a sort-order.", + "id": "script-api:dw/order/ProductLineItem#position", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.position", + "sections": [ + { + "body": "Returns the position within the line item container assigned to the ProductLineItem upon its creation, may be\nused as a sort-order.\n\nThe position is updated in the following way:\n\n- When a ProductLineItem is added to the LineItemCtnr, it is assigned the next available position, based on the\ncurrent count\n- When a ProductLineItem is removed from the LineItemCtnr then LineItemCtnr method reassignPositions is called,\nso that the 'gap' left by the removed line-item is refilled. This method is dependent on no 2 ProductLineItem\nhaving the same position.\n- When a LineItemCtnr is copied (e.g. when a PlacedOrder is created from a Basket), no special position\nhandling is necessary as the ProductLineItems are added according to their current position ordering in the\nsource LineItemCtnr.", + "heading": "Description" + } + ], + "signature": "position: number", + "source": "script-api", + "tags": [ + "position", + "productlineitem.position" + ], + "title": "ProductLineItem.position" + }, + { + "description": "Returns an iterator of price adjustments that have been applied to this product line item such as promotions on the purchase price (i.e. $10 Off or 10% Off).", + "id": "script-api:dw/order/ProductLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.priceAdjustments", + "sections": [ + { + "body": "Returns an iterator of price adjustments that have been applied to this\nproduct line item such as promotions on the purchase price\n(i.e. $10 Off or 10% Off).", + "heading": "Description" + } + ], + "signature": "readonly priceAdjustments: Collection", + "source": "script-api", + "tags": [ + "priceadjustments", + "productlineitem.priceadjustments" + ], + "title": "ProductLineItem.priceAdjustments" + }, + { + "description": "Returns the product associated with the product line item.", + "id": "script-api:dw/order/ProductLineItem#product", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.product", + "sections": [ + { + "body": "Returns the product associated with the product line item.\n\nThe product line item might not be related to an actual catalog product, for example if it represents an option,\nor was not created from a catalog product, or if the product does not exist in the catalog anymore. In these\ncases, the method returns null.", + "heading": "Description" + } + ], + "signature": "readonly product: Product | null", + "source": "script-api", + "tags": [ + "product", + "productlineitem.product" + ], + "title": "ProductLineItem.product" + }, + { + "description": "Returns the ID of the related product.", + "id": "script-api:dw/order/ProductLineItem#productID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productID", + "sections": [ + { + "body": "Returns the ID of the related product.\n\nReturns empty if no product is related.", + "heading": "Description" + } + ], + "signature": "readonly productID: string", + "source": "script-api", + "tags": [ + "productid", + "productlineitem.productid" + ], + "title": "ProductLineItem.productID" + }, + { + "description": "Returns the inventory list the product line item is associated with. If the line item is not associated with a inventory list, or the inventory list does not exist, the method returns null.", + "id": "script-api:dw/order/ProductLineItem#productInventoryList", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productInventoryList", + "sections": [ + { + "body": "Returns the inventory list the product line item is associated with. If the\nline item is not associated with a inventory list, or the inventory list does not\nexist, the method returns null.", + "heading": "Description" + } + ], + "signature": "productInventoryList: ProductInventoryList | null", + "source": "script-api", + "tags": [ + "productinventorylist", + "productlineitem.productinventorylist" + ], + "title": "ProductLineItem.productInventoryList" + }, + { + "description": "Returns the ID of the inventory list the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#productInventoryListID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productInventoryListID", + "sections": [ + { + "body": "Returns the ID of the inventory list the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "productInventoryListID: string | null", + "source": "script-api", + "tags": [ + "productinventorylistid", + "productlineitem.productinventorylistid" + ], + "title": "ProductLineItem.productInventoryListID" + }, + { + "description": "Returns the associated ProductListItem.", + "id": "script-api:dw/order/ProductLineItem#productListItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productListItem", + "sections": [ + { + "body": "Returns the associated ProductListItem.", + "heading": "Description" + } + ], + "signature": "readonly productListItem: ProductListItem | null", + "source": "script-api", + "tags": [ + "productlistitem", + "productlineitem.productlistitem" + ], + "title": "ProductLineItem.productListItem" + }, + { + "description": "Returns the name of the product that was copied when product was added to line item container.", + "id": "script-api:dw/order/ProductLineItem#productName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.productName", + "sections": [ + { + "body": "Returns the name of the product that was copied when\nproduct was added to line item container.", + "heading": "Description" + } + ], + "signature": "productName: string", + "source": "script-api", + "tags": [ + "productname", + "productlineitem.productname" + ], + "title": "ProductLineItem.productName" + }, + { + "description": "Returns the price of this product line item after considering all dependent price adjustments and prorating all Buy-X-Get-Y and order-level discounts, according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/ProductLineItem#proratedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.proratedPrice", + "sections": [ + { + "body": "Returns the price of this product line item after considering all\ndependent price adjustments and prorating all Buy-X-Get-Y\nand order-level discounts, according to the scheme described in\ndw.order.PriceAdjustment.getProratedPrices. For net pricing the\nnet price is returned. For gross pricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly proratedPrice: Money", + "source": "script-api", + "tags": [ + "proratedprice", + "productlineitem.proratedprice" + ], + "title": "ProductLineItem.proratedPrice" + }, + { + "description": "Returns a Map of PriceAdjustment to Money instances. They keys to this map are the price adjustments that apply to this ProductLineItem either directly or indirectly when discounts are prorated according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. The values in the map are the portion of the adjustment which applies to this particular product line item.", + "id": "script-api:dw/order/ProductLineItem#proratedPriceAdjustmentPrices", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.proratedPriceAdjustmentPrices", + "sections": [ + { + "body": "Returns a Map of PriceAdjustment to Money instances. They keys to this\nmap are the price adjustments that apply to this ProductLineItem either\ndirectly or indirectly when discounts are prorated according to the\nscheme described in dw.order.PriceAdjustment.getProratedPrices.\nThe values in the map are the portion of the adjustment which applies to\nthis particular product line item.", + "heading": "Description" + } + ], + "signature": "readonly proratedPriceAdjustmentPrices: utilMap", + "source": "script-api", + "tags": [ + "proratedpriceadjustmentprices", + "productlineitem.proratedpriceadjustmentprices" + ], + "title": "ProductLineItem.proratedPriceAdjustmentPrices" + }, + { + "description": "Returns the ProductLineItem that qualified the basket for this bonus product.", + "id": "script-api:dw/order/ProductLineItem#qualifyingProductLineItemForBonusProduct", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.qualifyingProductLineItemForBonusProduct", + "sections": [ + { + "body": "Returns the ProductLineItem that qualified the basket for this bonus product.\n\nThis method is only applicable if the product line item is a bonus product line item, and if the promotion is a\nproduct promotion with number of qualifying products granting a bonus-product discount. If these conditions\naren't met, the method returns null. If there are multiple product line items that triggered this bonus product,\nthis method returns the last one by position within the order.", + "heading": "Description" + } + ], + "signature": "readonly qualifyingProductLineItemForBonusProduct: ProductLineItem | null", + "source": "script-api", + "tags": [ + "qualifyingproductlineitemforbonusproduct", + "productlineitem.qualifyingproductlineitemforbonusproduct" + ], + "title": "ProductLineItem.qualifyingProductLineItemForBonusProduct" + }, + { + "description": "Returns the quantity of the product represented by this ProductLineItem.", + "id": "script-api:dw/order/ProductLineItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.quantity", + "sections": [ + { + "body": "Returns the quantity of the product represented by this ProductLineItem.", + "heading": "Description" + } + ], + "signature": "readonly quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "productlineitem.quantity" + ], + "title": "ProductLineItem.quantity" + }, + { + "description": "Returns the value of the quantity of this ProductLineItem.", + "id": "script-api:dw/order/ProductLineItem#quantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.quantityValue", + "sections": [ + { + "body": "Returns the value of the quantity of this ProductLineItem.", + "heading": "Description" + } + ], + "signature": "quantityValue: number", + "source": "script-api", + "tags": [ + "quantityvalue", + "productlineitem.quantityvalue" + ], + "title": "ProductLineItem.quantityValue" + }, + { + "description": "Returns all bonus product line items for which this line item is a qualifying product line item. This method is usually called when rendering the cart so that bonus products can be shown next to the products that triggered their creation.", + "id": "script-api:dw/order/ProductLineItem#relatedBonusProductLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.relatedBonusProductLineItems", + "sections": [ + { + "body": "Returns all bonus product line items for which this line item is a\nqualifying product line item. This method is usually called when\nrendering the cart so that bonus products can be shown next to the\nproducts that triggered their creation.", + "heading": "Description" + } + ], + "signature": "readonly relatedBonusProductLineItems: Collection", + "source": "script-api", + "tags": [ + "relatedbonusproductlineitems", + "productlineitem.relatedbonusproductlineitems" + ], + "title": "ProductLineItem.relatedBonusProductLineItems" + }, + { + "description": "Removes the specified price adjustment from the product line item.", + "id": "script-api:dw/order/ProductLineItem#removePriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustmentLineItem", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.removePriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified price adjustment from the product line item.", + "heading": "Description" + } + ], + "signature": "removePriceAdjustment(priceAdjustmentLineItem: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "removepriceadjustment", + "productlineitem.removepriceadjustment" + ], + "title": "ProductLineItem.removePriceAdjustment" + }, + { + "description": "Removes the dependent shipping line item for this line item.", + "id": "script-api:dw/order/ProductLineItem#removeShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.removeShippingLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the dependent shipping line item for this line item.", + "heading": "Description" + } + ], + "signature": "removeShippingLineItem(): void", + "source": "script-api", + "tags": [ + "removeshippinglineitem", + "productlineitem.removeshippinglineitem" + ], + "title": "ProductLineItem.removeShippingLineItem" + }, + { + "description": "Replaces the current product of the product line item with the product specified in parameter newProduct.", + "id": "script-api:dw/order/ProductLineItem#replaceProduct", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "newProduct", + "type": "Product" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.replaceProduct", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Replaces the current product of the product line item with the product specified in parameter newProduct.\n\nThe following rules apply:\n\n- Preserve line item attributes UUID, Quantity, CategoryID, ExternalLineItemStatus, ExternalLineItemText,\nisGift, GiftMessage, Position, Parent, Shipment\n- Replace product-specific attributes ProductID, ProductName, MinOrderQuantity, StepQuantity, ManufacturerName,\nManufacturerSKU\n- Remove all price adjustments related to the product line item\n- Remove the shipping line item related to the product line item\n- Remove all bundled line items of current product, and add bundled line items if new product is a bundle\n- Remove all option line items of current product, and add option line items if new product is an option\nproduct; use default option selections\n- Set all price attributes to N/A\n- Preserve all custom attributes of line item, but override order-required attributes with values from new\nproduct\n\nThe primary use is to replace one variation product with another, without having to both create a new line item\nfor the replacement and remove the line item for the replaced product.", + "heading": "Description" + } + ], + "signature": "replaceProduct(newProduct: Product): void", + "source": "script-api", + "tags": [ + "replaceproduct", + "productlineitem.replaceproduct" + ], + "title": "ProductLineItem.replaceProduct" + }, + { + "description": "Returns if the product line item is reserved.", + "id": "script-api:dw/order/ProductLineItem#reserved", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.reserved", + "sections": [ + { + "body": "Returns if the product line item is reserved.\n\nReservations for the basket can be created with e.g. dw.order.Basket.reserveInventory.\n\nMethod must only be called for basket product line items. Exception is thrown if called for order product line\nitem.", + "heading": "Description" + } + ], + "signature": "readonly reserved: boolean", + "source": "script-api", + "tags": [ + "reserved", + "productlineitem.reserved" + ], + "title": "ProductLineItem.reserved" + }, + { + "description": "Sets the specified category as the product line item category context.", + "id": "script-api:dw/order/ProductLineItem#setCategory", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "category", + "type": "Category | null" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setCategory", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the specified category as the product line item category context.", + "heading": "Description" + } + ], + "signature": "setCategory(category: Category | null): void", + "source": "script-api", + "tags": [ + "setcategory", + "productlineitem.setcategory" + ], + "title": "ProductLineItem.setCategory" + }, + { + "description": "Sets the ID of the category the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#setCategoryID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "categoryID", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setCategoryID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the ID of the category the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "setCategoryID(categoryID: string | null): void", + "source": "script-api", + "tags": [ + "setcategoryid", + "productlineitem.setcategoryid" + ], + "title": "ProductLineItem.setCategoryID" + }, + { + "description": "Sets the value to set for the external line item status.", + "id": "script-api:dw/order/ProductLineItem#setExternalLineItemStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setExternalLineItemStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value to set for the external line item status.", + "heading": "Description" + } + ], + "signature": "setExternalLineItemStatus(status: string): void", + "source": "script-api", + "tags": [ + "setexternallineitemstatus", + "productlineitem.setexternallineitemstatus" + ], + "title": "ProductLineItem.setExternalLineItemStatus" + }, + { + "description": "Sets the value to set for the external line item text.", + "id": "script-api:dw/order/ProductLineItem#setExternalLineItemText", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "text", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setExternalLineItemText", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value to set for the external line item text.", + "heading": "Description" + } + ], + "signature": "setExternalLineItemText(text: string): void", + "source": "script-api", + "tags": [ + "setexternallineitemtext", + "productlineitem.setexternallineitemtext" + ], + "title": "ProductLineItem.setExternalLineItemText" + }, + { + "description": "Controls if this line item is a gift or not.", + "id": "script-api:dw/order/ProductLineItem#setGift", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "isGift", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setGift", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Controls if this line item is a gift or not.", + "heading": "Description" + } + ], + "signature": "setGift(isGift: boolean): void", + "source": "script-api", + "tags": [ + "setgift", + "productlineitem.setgift" + ], + "title": "ProductLineItem.setGift" + }, + { + "description": "Sets the value to set for the gift message.", + "id": "script-api:dw/order/ProductLineItem#setGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setGiftMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value to set for the gift message.", + "heading": "Description" + } + ], + "signature": "setGiftMessage(message: string): void", + "source": "script-api", + "tags": [ + "setgiftmessage", + "productlineitem.setgiftmessage" + ], + "title": "ProductLineItem.setGiftMessage" + }, + { + "description": "Sets the name of the manufacturer of this product.", + "id": "script-api:dw/order/ProductLineItem#setManufacturerName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setManufacturerName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the manufacturer of this product.", + "heading": "Description" + } + ], + "signature": "setManufacturerName(name: string): void", + "source": "script-api", + "tags": [ + "setmanufacturername", + "productlineitem.setmanufacturername" + ], + "title": "ProductLineItem.setManufacturerName" + }, + { + "description": "Sets the SKU of the manufacturer of this product.", + "id": "script-api:dw/order/ProductLineItem#setManufacturerSKU", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "sku", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setManufacturerSKU", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the SKU of the manufacturer of this product.", + "heading": "Description" + } + ], + "signature": "setManufacturerSKU(sku: string): void", + "source": "script-api", + "tags": [ + "setmanufacturersku", + "productlineitem.setmanufacturersku" + ], + "title": "ProductLineItem.setManufacturerSKU" + }, + { + "description": "Set the minimum order quantity value for this object.", + "id": "script-api:dw/order/ProductLineItem#setMinOrderQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantityValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setMinOrderQuantityValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the minimum order quantity value for this object.\n\nThis will be used to validate and adjust quantities when setQuantityValue() is called. For typical catalog\nproduct line items, it is usually desirable to have this value inherited from the product attributes, but for\nnon-catalog products, it is sometimes desirable to set this value programmatically.\n\nNull is accepted and represents Quantity.NA. Otherwise, the quantity value must be > 0.", + "heading": "Description" + } + ], + "signature": "setMinOrderQuantityValue(quantityValue: number): void", + "source": "script-api", + "tags": [ + "setminorderquantityvalue", + "productlineitem.setminorderquantityvalue" + ], + "title": "ProductLineItem.setMinOrderQuantityValue" + }, + { + "description": "Sets the position within the line item container. This value may be used as a sort-order.", + "id": "script-api:dw/order/ProductLineItem#setPosition", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setPosition", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the position within the line item container. This value may be used as a sort-order.\n\nThe position is updated in the following way:\n\n- When a ProductLineItem is added to the LineItemCtnr, it is assigned the next available position, based on the\ncurrent count\n- When a ProductLineItem is removed from the LineItemCtnr then LineItemCtnr method reassignPositions is called,\nso that the 'gap' left by the removed line-item is refilled. This method is dependent on no 2 ProductLineItem\nhaving the same position.\n- When a LineItemCtnr is copied (e.g. when an Order is created from a Basket), no special position handling is\nnecessary as the ProductLineItems are added according to their current position ordering in the source\nLineItemCtnr.", + "heading": "Description" + } + ], + "signature": "setPosition(aValue: number): void", + "source": "script-api", + "tags": [ + "setposition", + "productlineitem.setposition" + ], + "title": "ProductLineItem.setPosition" + }, + { + "description": "Sets price attributes of the line item based on the current purchase currency, taxation policy and line item quantity.", + "id": "script-api:dw/order/ProductLineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setPriceValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets price attributes of the line item based on the current\npurchase currency, taxation policy and line item quantity.\n\nThe method sets the 'basePrice' attribute of the line item.\nAdditionally, it sets the 'netPrice' attribute of the line item\nif the current taxation policy is 'net', and the 'grossPrice'\nattribute, if the current taxation policy is 'gross'. The\n'netPrice'/'grossPrice' attributes are set by multiplying the\nspecified price value with the line item quantity.\n\nIf null is specified as value, the price attributes are reset to\nMoney.NA.", + "heading": "Description" + } + ], + "signature": "setPriceValue(value: number): void", + "source": "script-api", + "tags": [ + "setpricevalue", + "productlineitem.setpricevalue" + ], + "title": "ProductLineItem.setPriceValue" + }, + { + "description": "Sets the specified inventory list as the product line item inventory context.", + "id": "script-api:dw/order/ProductLineItem#setProductInventoryList", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productInventoryList", + "type": "ProductInventoryList | null" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductInventoryList", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the specified inventory list as the product line item inventory context.", + "heading": "Description" + } + ], + "signature": "setProductInventoryList(productInventoryList: ProductInventoryList | null): void", + "source": "script-api", + "tags": [ + "setproductinventorylist", + "productlineitem.setproductinventorylist" + ], + "title": "ProductLineItem.setProductInventoryList" + }, + { + "description": "Sets the ID of the inventory list the product line item is associated with.", + "id": "script-api:dw/order/ProductLineItem#setProductInventoryListID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "productInventoryListID", + "type": "string | null" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductInventoryListID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the ID of the inventory list the product line item is associated with.", + "heading": "Description" + } + ], + "signature": "setProductInventoryListID(productInventoryListID: string | null): void", + "source": "script-api", + "tags": [ + "setproductinventorylistid", + "productlineitem.setproductinventorylistid" + ], + "title": "ProductLineItem.setProductInventoryListID" + }, + { + "description": "Sets the name of the product.", + "id": "script-api:dw/order/ProductLineItem#setProductName", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setProductName", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name of the product.", + "heading": "Description" + } + ], + "signature": "setProductName(aValue: string): void", + "source": "script-api", + "tags": [ + "setproductname", + "productlineitem.setproductname" + ], + "title": "ProductLineItem.setProductName" + }, + { + "description": "Updates the quantity value of the product line item.", + "id": "script-api:dw/order/ProductLineItem#setQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantityValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setQuantityValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the quantity value of the product line item.\n\nValidates the specified quantity value against the line item's min order and step quantity and adjusts it if\nnecessary. In particular, if 0 is passed, then the value will be adjusted to the min order quantity, not removed\nfrom the line item container.\n\nNull values or values < 0.0 are not accepted.", + "heading": "Description" + } + ], + "signature": "setQuantityValue(quantityValue: number): void", + "source": "script-api", + "tags": [ + "setquantityvalue", + "productlineitem.setquantityvalue" + ], + "title": "ProductLineItem.setQuantityValue" + }, + { + "description": "Associates the specified product line item with the specified shipment.", + "id": "script-api:dw/order/ProductLineItem#setShipment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setShipment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Associates the specified product line item with the specified shipment.\n\nThe method is only applicable for independent product line items. If called for any dependent line item (option\nor bundled line item), the method will throw an exception. The shipment for all dependent line items will be\nupdated automatically by the method. Product line item and shipment must belong to the same line item ctnr.", + "heading": "Description" + } + ], + "signature": "setShipment(shipment: Shipment): void", + "source": "script-api", + "tags": [ + "setshipment", + "productlineitem.setshipment" + ], + "title": "ProductLineItem.setShipment" + }, + { + "description": "Set the step quantity value for this object.", + "id": "script-api:dw/order/ProductLineItem#setStepQuantityValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantityValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.setStepQuantityValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the step quantity value for this object.\n\nThis will be used to validate and adjust quantities when updateQuantity() is called. For typical catalog product\nline items, it is usually desirable to have this value inherited from the product attributes, but for non-catalog\nproducts, it is sometimes desirable to set this value programmatically.\n\nNull is accepted and represents Quantity.NA. Otherwise, the quantity value must be > 0.", + "heading": "Description" + } + ], + "signature": "setStepQuantityValue(quantityValue: number): void", + "source": "script-api", + "tags": [ + "setstepquantityvalue", + "productlineitem.setstepquantityvalue" + ], + "title": "ProductLineItem.setStepQuantityValue" + }, + { + "description": "Returns the associated Shipment.", + "id": "script-api:dw/order/ProductLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.shipment", + "sections": [ + { + "body": "Returns the associated Shipment.", + "heading": "Description" + } + ], + "signature": "shipment: Shipment", + "source": "script-api", + "tags": [ + "shipment", + "productlineitem.shipment" + ], + "title": "ProductLineItem.shipment" + }, + { + "description": "Returns the dependent shipping line item of this line item. The shipping line item can define product-specific shipping costs for this product line item.", + "id": "script-api:dw/order/ProductLineItem#shippingLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.shippingLineItem", + "sections": [ + { + "body": "Returns the dependent shipping line item of this line item.\nThe shipping line item can define product-specific shipping\ncosts for this product line item.", + "heading": "Description" + } + ], + "signature": "readonly shippingLineItem: ProductShippingLineItem | null", + "source": "script-api", + "tags": [ + "shippinglineitem", + "productlineitem.shippinglineitem" + ], + "title": "ProductLineItem.shippingLineItem" + }, + { + "description": "Returns step quantity allowed for the product represented by the ProductLineItem (copied from product on initialization). Note: the quantity of a ProductLineItem must obey the limits set by the ProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e. for a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values 2.0, 4.5, 7.0... are allowed values.", + "id": "script-api:dw/order/ProductLineItem#stepQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.stepQuantity", + "sections": [ + { + "body": "Returns step quantity allowed for the product represented by the ProductLineItem\n(copied from product on initialization).\nNote: the quantity of a ProductLineItem must obey the limits set by the\nProductLineItem's attributes 'MinOrderQuantity' and 'StepQuantity', i.e.\nfor a 'MinOrderQuantity' of 2.0 and a 'StepQuantity' of 2.5 then values\n2.0, 4.5, 7.0... are allowed values.", + "heading": "Description" + } + ], + "signature": "readonly stepQuantity: Quantity", + "source": "script-api", + "tags": [ + "stepquantity", + "productlineitem.stepquantity" + ], + "title": "ProductLineItem.stepQuantity" + }, + { + "description": "Return the value portion of getStepQuantity().", + "id": "script-api:dw/order/ProductLineItem#stepQuantityValue", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.stepQuantityValue", + "sections": [ + { + "body": "Return the value portion of getStepQuantity().", + "heading": "Description" + } + ], + "signature": "stepQuantityValue: number", + "source": "script-api", + "tags": [ + "stepquantityvalue", + "productlineitem.stepquantityvalue" + ], + "title": "ProductLineItem.stepQuantityValue" + }, + { + "description": "Determines and sets the price of a option line item based on the selected option value this line item represents.", + "id": "script-api:dw/order/ProductLineItem#updateOptionPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateOptionPrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Determines and sets the price of a option line item based on the selected option value this line item represents.", + "heading": "Description" + } + ], + "signature": "updateOptionPrice(): void", + "source": "script-api", + "tags": [ + "updateoptionprice", + "productlineitem.updateoptionprice" + ], + "title": "ProductLineItem.updateOptionPrice" + }, + { + "description": "Updates an option line item with a new option value.", + "id": "script-api:dw/order/ProductLineItem#updateOptionValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "optionValue", + "type": "ProductOptionValue" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateOptionValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates an option line item with a new option value.\n\nThis method will not do anything if the current line item is no\noption line item, if the specified value does not exist for the\ncurrent option or if this value is already selected.\n\nNote, that this method will update the attributes optionValueID,\nproductID, productName and lineItemText. It will not update the price\nattributes of the line item. To update the price of the line item you\nneed to call updateOptionPrice in addition. This is\nusually done during calculation in the calculate hook.", + "heading": "Description" + } + ], + "signature": "updateOptionValue(optionValue: ProductOptionValue): void", + "source": "script-api", + "tags": [ + "updateoptionvalue", + "productlineitem.updateoptionvalue" + ], + "title": "ProductLineItem.updateOptionValue" + }, + { + "deprecated": { + "message": "Use setPriceValue" + }, + "description": "Updates the price attributes of the line item based on the specified price. The base price is set to the specified value. If the line item is based on net pricing then the net price attribute is set. If the line item is based on gross pricing then the gross price attribute is set. Whether or not a line item is based on net or gross pricing is a site-wide configuration parameter. In either case, this price is equal to the product of the base price and the quantity of this line item in its container.", + "id": "script-api:dw/order/ProductLineItem#updatePrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "price", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updatePrice", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Updates the price attributes of the line item based\non the specified price. The base price is set to the specified\nvalue. If the line item is based on net pricing then the net price\nattribute is set. If the line item is based on gross pricing then the\ngross price attribute is set. Whether or not a line item is based\non net or gross pricing is a site-wide configuration parameter.\nIn either case, this price is equal to the product of the base price\nand the quantity of this line item in its container.", + "heading": "Description" + } + ], + "signature": "updatePrice(price: Money): void", + "source": "script-api", + "tags": [ + "updateprice", + "productlineitem.updateprice" + ], + "title": "ProductLineItem.updatePrice" + }, + { + "deprecated": { + "message": "Use setQuantityValue followed by getQuantity instead." + }, + "description": "Updates the quantity value of the product line item and all its dependent product line items.", + "id": "script-api:dw/order/ProductLineItem#updateQuantity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantityValue", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductLineItem", + "qualifiedName": "dw.order.ProductLineItem.updateQuantity", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Updates the quantity value of the product line item and all its dependent product line items.\n\nValidates the specified quantity value against the line item's min order and step quantity and adjusts it if\nnecessary. The adjusted quantity value is returned.\n\nIn general, quantity values < 0.0 are not accepted.", + "heading": "Description" + } + ], + "signature": "updateQuantity(quantityValue: number): number", + "source": "script-api", + "tags": [ + "updatequantity", + "productlineitem.updatequantity" + ], + "title": "ProductLineItem.updateQuantity" + }, + { + "description": "Instances of ProductShippingCost represent product specific shipping costs.", + "id": "script-api:dw/order/ProductShippingCost", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingCost", + "sections": [ + { + "body": "Instances of ProductShippingCost represent product specific shipping costs.\n\nUse dw.order.ProductShippingModel.getShippingCost to get\nthe shipping cost for a specific product.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productshippingcost", + "dw.order.productshippingcost", + "dw/order" + ], + "title": "ProductShippingCost" + }, + { + "description": "Returns the shipping amount.", + "id": "script-api:dw/order/ProductShippingCost#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.amount", + "sections": [ + { + "body": "Returns the shipping amount.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "productshippingcost.amount" + ], + "title": "ProductShippingCost.amount" + }, + { + "description": "Returns true if shipping cost is a fixed-price shipping cost, and false if surcharge shipping cost.", + "id": "script-api:dw/order/ProductShippingCost#fixedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.fixedPrice", + "sections": [ + { + "body": "Returns true if shipping cost is a fixed-price shipping cost,\nand false if surcharge shipping cost.", + "heading": "Description" + } + ], + "signature": "readonly fixedPrice: boolean", + "source": "script-api", + "tags": [ + "fixedprice", + "productshippingcost.fixedprice" + ], + "title": "ProductShippingCost.fixedPrice" + }, + { + "description": "Returns the shipping amount.", + "id": "script-api:dw/order/ProductShippingCost#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping amount.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "productshippingcost.getamount" + ], + "title": "ProductShippingCost.getAmount" + }, + { + "description": "Returns true if shipping cost is a fixed-price shipping cost, and false if surcharge shipping cost.", + "id": "script-api:dw/order/ProductShippingCost#isFixedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.isFixedPrice", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if shipping cost is a fixed-price shipping cost,\nand false if surcharge shipping cost.", + "heading": "Description" + } + ], + "signature": "isFixedPrice(): boolean", + "source": "script-api", + "tags": [ + "isfixedprice", + "productshippingcost.isfixedprice" + ], + "title": "ProductShippingCost.isFixedPrice" + }, + { + "description": "Returns true if shipping cost is a surcharge to the shipment shipping cost, and false if fixed-price shipping cost.", + "id": "script-api:dw/order/ProductShippingCost#isSurcharge", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.isSurcharge", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if shipping cost is a surcharge to the shipment\nshipping cost, and false if fixed-price shipping cost.", + "heading": "Description" + } + ], + "signature": "isSurcharge(): boolean", + "source": "script-api", + "tags": [ + "issurcharge", + "productshippingcost.issurcharge" + ], + "title": "ProductShippingCost.isSurcharge" + }, + { + "description": "Returns true if shipping cost is a surcharge to the shipment shipping cost, and false if fixed-price shipping cost.", + "id": "script-api:dw/order/ProductShippingCost#surcharge", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingCost", + "qualifiedName": "dw.order.ProductShippingCost.surcharge", + "sections": [ + { + "body": "Returns true if shipping cost is a surcharge to the shipment\nshipping cost, and false if fixed-price shipping cost.", + "heading": "Description" + } + ], + "signature": "readonly surcharge: boolean", + "source": "script-api", + "tags": [ + "surcharge", + "productshippingcost.surcharge" + ], + "title": "ProductShippingCost.surcharge" + }, + { + "description": "Represents a specific line item in a shipment. A ProductShippingLineItem defines lineitem-specific shipping costs.", + "id": "script-api:dw/order/ProductShippingLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingLineItem", + "sections": [ + { + "body": "Represents a specific line item in a shipment. A ProductShippingLineItem defines\nlineitem-specific shipping costs.", + "heading": "Description" + }, + { + "body": "Extends `LineItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productshippinglineitem", + "dw.order.productshippinglineitem", + "dw/order" + ], + "title": "ProductShippingLineItem" + }, + { + "deprecated": { + "message": "this reserved constant is deprecated." + }, + "description": "Reserved constant.", + "id": "script-api:dw/order/ProductShippingLineItem#PRODUCT_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.PRODUCT_SHIPPING_ID", + "sections": [ + { + "body": "Reserved constant.", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCT_SHIPPING_ID = \"PRODUCT_SHIPPING\"", + "source": "script-api", + "tags": [ + "product_shipping_id", + "productshippinglineitem.product_shipping_id" + ], + "title": "ProductShippingLineItem.PRODUCT_SHIPPING_ID" + }, + { + "deprecated": { + "message": "this reserved constant is deprecated." + }, + "description": "Reserved constant.", + "id": "script-api:dw/order/ProductShippingLineItem#PRODUCT_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.PRODUCT_SHIPPING_ID", + "sections": [ + { + "body": "Reserved constant.", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCT_SHIPPING_ID = \"PRODUCT_SHIPPING\"", + "source": "script-api", + "tags": [ + "product_shipping_id", + "productshippinglineitem.product_shipping_id" + ], + "title": "ProductShippingLineItem.PRODUCT_SHIPPING_ID" + }, + { + "description": "Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments.", + "id": "script-api:dw/order/ProductShippingLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedGrossPrice", + "sections": [ + { + "body": "Returns the gross price of the product shipping line item after applying\nall product-shipping-level adjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedgrossprice", + "productshippinglineitem.adjustedgrossprice" + ], + "title": "ProductShippingLineItem.adjustedGrossPrice" + }, + { + "description": "Returns the net price of the product shipping line item after applying all product-shipping-level adjustments.", + "id": "script-api:dw/order/ProductShippingLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedNetPrice", + "sections": [ + { + "body": "Returns the net price of the product shipping line item after applying\nall product-shipping-level adjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustednetprice", + "productshippinglineitem.adjustednetprice" + ], + "title": "ProductShippingLineItem.adjustedNetPrice" + }, + { + "description": "Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice).", + "id": "script-api:dw/order/ProductShippingLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedPrice", + "sections": [ + { + "body": "Returns the price of the product shipping line item after applying all\npproduct-shipping-level adjustments. For net pricing the adjusted net\nprice is returned (see getAdjustedNetPrice). For gross\npricing, the adjusted gross price is returned (see\ngetAdjustedGrossPrice).", + "heading": "Description" + } + ], + "signature": "readonly adjustedPrice: Money", + "source": "script-api", + "tags": [ + "adjustedprice", + "productshippinglineitem.adjustedprice" + ], + "title": "ProductShippingLineItem.adjustedPrice" + }, + { + "description": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/ProductShippingLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.adjustedTax", + "sections": [ + { + "body": "Returns the tax of the unit after applying adjustments, in the purchase\ncurrency.", + "heading": "Description" + } + ], + "signature": "readonly adjustedTax: Money", + "source": "script-api", + "tags": [ + "adjustedtax", + "productshippinglineitem.adjustedtax" + ], + "title": "ProductShippingLineItem.adjustedTax" + }, + { + "description": "Returns the gross price of the product shipping line item after applying all product-shipping-level adjustments.", + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the gross price of the product shipping line item after applying\nall product-shipping-level adjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedgrossprice", + "productshippinglineitem.getadjustedgrossprice" + ], + "title": "ProductShippingLineItem.getAdjustedGrossPrice" + }, + { + "description": "Returns the net price of the product shipping line item after applying all product-shipping-level adjustments.", + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the net price of the product shipping line item after applying\nall product-shipping-level adjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustednetprice", + "productshippinglineitem.getadjustednetprice" + ], + "title": "ProductShippingLineItem.getAdjustedNetPrice" + }, + { + "description": "Returns the price of the product shipping line item after applying all pproduct-shipping-level adjustments. For net pricing the adjusted net price is returned (see getAdjustedNetPrice). For gross pricing, the adjusted gross price is returned (see getAdjustedGrossPrice).", + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of the product shipping line item after applying all\npproduct-shipping-level adjustments. For net pricing the adjusted net\nprice is returned (see getAdjustedNetPrice). For gross\npricing, the adjusted gross price is returned (see\ngetAdjustedGrossPrice).", + "heading": "Description" + } + ], + "signature": "getAdjustedPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedprice", + "productshippinglineitem.getadjustedprice" + ], + "title": "ProductShippingLineItem.getAdjustedPrice" + }, + { + "description": "Returns the tax of the unit after applying adjustments, in the purchase currency.", + "id": "script-api:dw/order/ProductShippingLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getAdjustedTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of the unit after applying adjustments, in the purchase\ncurrency.", + "heading": "Description" + } + ], + "signature": "getAdjustedTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedtax", + "productshippinglineitem.getadjustedtax" + ], + "title": "ProductShippingLineItem.getAdjustedTax" + }, + { + "description": "Returns an iterator of price adjustments that have been applied to this product shipping line item.", + "id": "script-api:dw/order/ProductShippingLineItem#getPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns an iterator of price adjustments that have been applied to this\nproduct shipping line item.", + "heading": "Description" + } + ], + "signature": "getPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getpriceadjustments", + "productshippinglineitem.getpriceadjustments" + ], + "title": "ProductShippingLineItem.getPriceAdjustments" + }, + { + "description": "Returns the parent product line item this shipping line item belongs to.", + "id": "script-api:dw/order/ProductShippingLineItem#getProductLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getProductLineItem", + "returns": { + "type": "ProductLineItem" + }, + "sections": [ + { + "body": "Returns the parent product line item this shipping line item belongs to.", + "heading": "Description" + } + ], + "signature": "getProductLineItem(): ProductLineItem", + "source": "script-api", + "tags": [ + "getproductlineitem", + "productshippinglineitem.getproductlineitem" + ], + "title": "ProductShippingLineItem.getProductLineItem" + }, + { + "description": "Returns the quantity of the shipping cost.", + "id": "script-api:dw/order/ProductShippingLineItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Returns the quantity of the shipping cost.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "productshippinglineitem.getquantity" + ], + "title": "ProductShippingLineItem.getQuantity" + }, + { + "description": "Returns the shipment this shipping line item belongs to.", + "id": "script-api:dw/order/ProductShippingLineItem#getShipment", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.getShipment", + "returns": { + "type": "Shipment" + }, + "sections": [ + { + "body": "Returns the shipment this shipping line item belongs to.", + "heading": "Description" + } + ], + "signature": "getShipment(): Shipment", + "source": "script-api", + "tags": [ + "getshipment", + "productshippinglineitem.getshipment" + ], + "title": "ProductShippingLineItem.getShipment" + }, + { + "description": "Returns the 'surcharge' flag.", + "id": "script-api:dw/order/ProductShippingLineItem#isSurcharge", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.isSurcharge", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the 'surcharge' flag.", + "heading": "Description" + } + ], + "signature": "isSurcharge(): boolean", + "source": "script-api", + "tags": [ + "issurcharge", + "productshippinglineitem.issurcharge" + ], + "title": "ProductShippingLineItem.isSurcharge" + }, + { + "description": "Returns an iterator of price adjustments that have been applied to this product shipping line item.", + "id": "script-api:dw/order/ProductShippingLineItem#priceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.priceAdjustments", + "sections": [ + { + "body": "Returns an iterator of price adjustments that have been applied to this\nproduct shipping line item.", + "heading": "Description" + } + ], + "signature": "readonly priceAdjustments: Collection", + "source": "script-api", + "tags": [ + "priceadjustments", + "productshippinglineitem.priceadjustments" + ], + "title": "ProductShippingLineItem.priceAdjustments" + }, + { + "description": "Returns the parent product line item this shipping line item belongs to.", + "id": "script-api:dw/order/ProductShippingLineItem#productLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.productLineItem", + "sections": [ + { + "body": "Returns the parent product line item this shipping line item belongs to.", + "heading": "Description" + } + ], + "signature": "readonly productLineItem: ProductLineItem", + "source": "script-api", + "tags": [ + "productlineitem", + "productshippinglineitem.productlineitem" + ], + "title": "ProductShippingLineItem.productLineItem" + }, + { + "description": "Returns the quantity of the shipping cost.", + "id": "script-api:dw/order/ProductShippingLineItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.quantity", + "sections": [ + { + "body": "Returns the quantity of the shipping cost.", + "heading": "Description" + } + ], + "signature": "quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "productshippinglineitem.quantity" + ], + "title": "ProductShippingLineItem.quantity" + }, + { + "description": "Sets price attributes of the line item based on the purchase currency, taxation policy and line item quantity.", + "id": "script-api:dw/order/ProductShippingLineItem#setPriceValue", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setPriceValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets price attributes of the line item based on the\npurchase currency, taxation policy and line item quantity.\n\nThe method sets the 'basePrice' attribute of the line item.\nAdditionally, it sets the 'netPrice' attribute of the line item\nif the current taxation policy is 'net', and the 'grossPrice'\nattribute, if the current taxation policy is 'gross'. The\n'netPrice'/'grossPrice' attributes are set by multiplying the\nspecified price value with the line item quantity.\n\nIf null is specified as value, the price attributes are reset to\nMoney.NA.", + "heading": "Description" + } + ], + "signature": "setPriceValue(value: number): void", + "source": "script-api", + "tags": [ + "setpricevalue", + "productshippinglineitem.setpricevalue" + ], + "title": "ProductShippingLineItem.setPriceValue" + }, + { + "description": "Sets the quantity of the shipping cost.", + "id": "script-api:dw/order/ProductShippingLineItem#setQuantity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setQuantity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the quantity of the shipping cost.", + "heading": "Description" + } + ], + "signature": "setQuantity(quantity: Quantity): void", + "source": "script-api", + "tags": [ + "setquantity", + "productshippinglineitem.setquantity" + ], + "title": "ProductShippingLineItem.setQuantity" + }, + { + "description": "Sets the 'surcharge' flag.", + "id": "script-api:dw/order/ProductShippingLineItem#setSurcharge", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "flag", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.setSurcharge", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the 'surcharge' flag.", + "heading": "Description" + } + ], + "signature": "setSurcharge(flag: boolean): void", + "source": "script-api", + "tags": [ + "setsurcharge", + "productshippinglineitem.setsurcharge" + ], + "title": "ProductShippingLineItem.setSurcharge" + }, + { + "description": "Returns the shipment this shipping line item belongs to.", + "id": "script-api:dw/order/ProductShippingLineItem#shipment", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.shipment", + "sections": [ + { + "body": "Returns the shipment this shipping line item belongs to.", + "heading": "Description" + } + ], + "signature": "readonly shipment: Shipment", + "source": "script-api", + "tags": [ + "shipment", + "productshippinglineitem.shipment" + ], + "title": "ProductShippingLineItem.shipment" + }, + { + "description": "Returns the 'surcharge' flag.", + "id": "script-api:dw/order/ProductShippingLineItem#surcharge", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingLineItem", + "qualifiedName": "dw.order.ProductShippingLineItem.surcharge", + "sections": [ + { + "body": "Returns the 'surcharge' flag.", + "heading": "Description" + } + ], + "signature": "surcharge: boolean", + "source": "script-api", + "tags": [ + "surcharge", + "productshippinglineitem.surcharge" + ], + "title": "ProductShippingLineItem.surcharge" + }, + { + "description": "Instances of ProductShippingModel provide access to product-level shipping information, such as applicable or inapplicable shipping methods and shipping cost defined for the product for a specified shipping method.", + "id": "script-api:dw/order/ProductShippingModel", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ProductShippingModel", + "sections": [ + { + "body": "Instances of ProductShippingModel provide access to product-level\nshipping information, such as applicable or inapplicable shipping methods\nand shipping cost defined for the product for a specified shipping\nmethod.\n\nUse dw.order.ShippingMgr.getProductShippingModel to get\nthe shipping model for a specific product.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "productshippingmodel", + "dw.order.productshippingmodel", + "dw/order" + ], + "title": "ProductShippingModel" + }, + { + "description": "Returns the active applicable shipping methods for the product related to this shipping model, i.e. shipping methods the product can be shipped with. A product can be shipping with a shipping methods if the shipping method is not explicitely marked as inapplicable for this product.", + "id": "script-api:dw/order/ProductShippingModel#applicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.applicableShippingMethods", + "sections": [ + { + "body": "Returns the active applicable shipping methods for the product related\nto this shipping model, i.e. shipping methods the product can be shipped\nwith. A product can be shipping with a shipping methods if the shipping\nmethod is not explicitely marked as inapplicable for this product.", + "heading": "Description" + } + ], + "signature": "readonly applicableShippingMethods: Collection", + "source": "script-api", + "tags": [ + "applicableshippingmethods", + "productshippingmodel.applicableshippingmethods" + ], + "title": "ProductShippingModel.applicableShippingMethods" + }, + { + "description": "Returns the active applicable shipping methods for the product related to this shipping model, i.e. shipping methods the product can be shipped with. A product can be shipping with a shipping methods if the shipping method is not explicitely marked as inapplicable for this product.", + "id": "script-api:dw/order/ProductShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getApplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active applicable shipping methods for the product related\nto this shipping model, i.e. shipping methods the product can be shipped\nwith. A product can be shipping with a shipping methods if the shipping\nmethod is not explicitely marked as inapplicable for this product.", + "heading": "Description" + } + ], + "signature": "getApplicableShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getapplicableshippingmethods", + "productshippingmodel.getapplicableshippingmethods" + ], + "title": "ProductShippingModel.getApplicableShippingMethods" + }, + { + "description": "Returns the active inapplicable shipping methods for the product related to this shipping model, i.e. shipping methods the product cannot be shipped with. A product cannot be shipping with a shipping methods if the shipping method is explicitely marked as inapplicable for this product.", + "id": "script-api:dw/order/ProductShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getInapplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active inapplicable shipping methods for the product related\nto this shipping model, i.e. shipping methods the product cannot be\nshipped with. A product cannot be shipping with a shipping methods if the\nshipping method is explicitely marked as inapplicable for this product.", + "heading": "Description" + } + ], + "signature": "getInapplicableShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getinapplicableshippingmethods", + "productshippingmodel.getinapplicableshippingmethods" + ], + "title": "ProductShippingModel.getInapplicableShippingMethods" + }, + { + "description": "Returns the shipping cost object for the related product and the specified shipping method, or null if no product-level fixed-price or surcharge shipping cost are defined for the specified product.", + "id": "script-api:dw/order/ProductShippingModel#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingMethod", + "type": "ShippingMethod" + } + ], + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getShippingCost", + "returns": { + "type": "ProductShippingCost | null" + }, + "sections": [ + { + "body": "Returns the shipping cost object for the related product and\nthe specified shipping method, or null if no product-level fixed-price or\nsurcharge shipping cost are defined for the specified product.\n\nThe following rules apply:\n\n- if fixed and surcharge shipping cost is defined for a product, the fixed cost takes precedence\n- if a product is member of multiple shipping cost groups, the lowest shipping cost takes precedence", + "heading": "Description" + } + ], + "signature": "getShippingCost(shippingMethod: ShippingMethod): ProductShippingCost | null", + "source": "script-api", + "tags": [ + "getshippingcost", + "productshippingmodel.getshippingcost" + ], + "title": "ProductShippingModel.getShippingCost" + }, + { + "description": "Returns the active shipping methods for which either any fixed-price or surcharge product-level shipping cost is defined for the specified product.", + "id": "script-api:dw/order/ProductShippingModel#getShippingMethodsWithShippingCost", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.getShippingMethodsWithShippingCost", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active shipping methods for which either any fixed-price or\nsurcharge product-level shipping cost is defined for the specified product.\n\nNote that this can include inapplicable shipping methods\n(see getInapplicableShippingMethods).", + "heading": "Description" + } + ], + "signature": "getShippingMethodsWithShippingCost(): Collection", + "source": "script-api", + "tags": [ + "getshippingmethodswithshippingcost", + "productshippingmodel.getshippingmethodswithshippingcost" + ], + "title": "ProductShippingModel.getShippingMethodsWithShippingCost" + }, + { + "description": "Returns the active inapplicable shipping methods for the product related to this shipping model, i.e. shipping methods the product cannot be shipped with. A product cannot be shipping with a shipping methods if the shipping method is explicitely marked as inapplicable for this product.", + "id": "script-api:dw/order/ProductShippingModel#inapplicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.inapplicableShippingMethods", + "sections": [ + { + "body": "Returns the active inapplicable shipping methods for the product related\nto this shipping model, i.e. shipping methods the product cannot be\nshipped with. A product cannot be shipping with a shipping methods if the\nshipping method is explicitely marked as inapplicable for this product.", + "heading": "Description" + } + ], + "signature": "readonly inapplicableShippingMethods: Collection", + "source": "script-api", + "tags": [ + "inapplicableshippingmethods", + "productshippingmodel.inapplicableshippingmethods" + ], + "title": "ProductShippingModel.inapplicableShippingMethods" + }, + { + "description": "Returns the active shipping methods for which either any fixed-price or surcharge product-level shipping cost is defined for the specified product.", + "id": "script-api:dw/order/ProductShippingModel#shippingMethodsWithShippingCost", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ProductShippingModel", + "qualifiedName": "dw.order.ProductShippingModel.shippingMethodsWithShippingCost", + "sections": [ + { + "body": "Returns the active shipping methods for which either any fixed-price or\nsurcharge product-level shipping cost is defined for the specified product.\n\nNote that this can include inapplicable shipping methods\n(see getInapplicableShippingMethods).", + "heading": "Description" + } + ], + "signature": "readonly shippingMethodsWithShippingCost: Collection", + "source": "script-api", + "tags": [ + "shippingmethodswithshippingcost", + "productshippingmodel.shippingmethodswithshippingcost" + ], + "title": "ProductShippingModel.shippingMethodsWithShippingCost" + }, + { + "description": "The Return represents a physical customer return, and contains 1..n dw.order.ReturnItems. The Return is associated with one dw.order.ReturnCase, and each ReturnItem is associated with one dw.order.ReturnCaseItem and (via the ReturnCaseItem) a single dw.order.OrderItem usually representing an dw.order.Order dw.order.ProductLineItem.", + "id": "script-api:dw/order/Return", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Return", + "sections": [ + { + "body": "The Return represents a physical customer return, and contains 1..n\ndw.order.ReturnItems. The Return is associated with one dw.order.ReturnCase, and each\nReturnItem is associated with one dw.order.ReturnCaseItem and (via the\nReturnCaseItem) a single dw.order.OrderItem usually representing an dw.order.Order\ndw.order.ProductLineItem.\n\nThe ReturnItem records the quantity returned.\n\nThe Return can have one of these status values:\n\n- NEW - the return is new, i.e. needs to undergo a check before it can be\nmarked as COMPLETED\n- COMPLETED - the return is complete, this is a precondition for refunding the\ncustomer for a return.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "return", + "dw.order.return", + "dw/order" + ], + "title": "Return" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "return.orderby_itemid" + ], + "title": "Return.ORDERBY_ITEMID" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "return.orderby_itemid" + ], + "title": "Return.ORDERBY_ITEMID" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "return.orderby_itemposition" + ], + "title": "Return.ORDERBY_ITEMPOSITION" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "return.orderby_itemposition" + ], + "title": "Return.ORDERBY_ITEMPOSITION" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "return.orderby_unsorted" + ], + "title": "Return.ORDERBY_UNSORTED" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/Return#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "return.orderby_unsorted" + ], + "title": "Return.ORDERBY_UNSORTED" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Return#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "return.qualifier_productitems" + ], + "title": "Return.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Return#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "return.qualifier_productitems" + ], + "title": "Return.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Return#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "return.qualifier_serviceitems" + ], + "title": "Return.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/Return#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "return.qualifier_serviceitems" + ], + "title": "Return.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Constant for Return Status COMPLETED", + "id": "script-api:dw/order/Return#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_COMPLETED", + "sections": [ + { + "body": "Constant for Return Status COMPLETED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_COMPLETED: string", + "source": "script-api", + "tags": [ + "status_completed", + "return.status_completed" + ], + "title": "Return.STATUS_COMPLETED" + }, + { + "description": "Constant for Return Status COMPLETED", + "id": "script-api:dw/order/Return#STATUS_COMPLETED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_COMPLETED", + "sections": [ + { + "body": "Constant for Return Status COMPLETED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_COMPLETED: string", + "source": "script-api", + "tags": [ + "status_completed", + "return.status_completed" + ], + "title": "Return.STATUS_COMPLETED" + }, + { + "description": "Constant for Return Status NEW", + "id": "script-api:dw/order/Return#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_NEW", + "sections": [ + { + "body": "Constant for Return Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "return.status_new" + ], + "title": "Return.STATUS_NEW" + }, + { + "description": "Constant for Return Status NEW", + "id": "script-api:dw/order/Return#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.STATUS_NEW", + "sections": [ + { + "body": "Constant for Return Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "return.status_new" + ], + "title": "Return.STATUS_NEW" + }, + { + "description": "Creates a new dw.order.Invoice based on this Return. The return-number will be used as the invoice-number. The Invoice can then be accessed using getInvoice or its number using getInvoiceNumber. The method must not be called more than once for a Return, nor may 2 Invoices exist with the same invoice-number.", + "id": "script-api:dw/order/Return#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this Return.\nThe return-number will be used as the invoice-number. The\nInvoice can then be accessed using getInvoice or its\nnumber using getInvoiceNumber. The method must not be called\nmore than once for a Return, nor may 2 Invoices exist\nwith the same invoice-number.\n\nThe new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and\nwill be passed to the refund payment-hook in a separate database\ntransaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "return.createinvoice" + ], + "title": "Return.createInvoice" + }, + { + "description": "Creates a new dw.order.Invoice based on this Return. The invoice-number must be specified as an argument. The Invoice can then be accessed using getInvoice or its number using getInvoiceNumber. The method must not be called more than once for a Return, nor may 2 Invoices exist with the same invoice-number.", + "id": "script-api:dw/order/Return#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this Return. The\ninvoice-number must be specified as an argument. The\nInvoice can then be accessed using getInvoice or its\nnumber using getInvoiceNumber. The method must not be called\nmore than once for a Return, nor may 2 Invoices exist\nwith the same invoice-number.\n\nThe new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and\nwill be passed to the refund payment-hook in a separate database\ntransaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(invoiceNumber: string): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "return.createinvoice" + ], + "title": "Return.createInvoice" + }, + { + "description": "Create a dw.order.ReturnItem based on a dw.order.ReturnCaseItem.", + "id": "script-api:dw/order/Return#createItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnCaseItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.createItem", + "returns": { + "type": "ReturnItem" + }, + "sections": [ + { + "body": "Create a dw.order.ReturnItem based on a dw.order.ReturnCaseItem.", + "heading": "Description" + } + ], + "signature": "createItem(returnCaseItemID: string): ReturnItem", + "source": "script-api", + "tags": [ + "createitem", + "return.createitem" + ], + "title": "Return.createItem" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/Return#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getInvoice", + "returns": { + "type": "Invoice | null" + }, + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "getInvoice(): Invoice | null", + "source": "script-api", + "tags": [ + "getinvoice", + "return.getinvoice" + ], + "title": "Return.getInvoice" + }, + { + "description": "Returns null or the invoice-number.", + "id": "script-api:dw/order/Return#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getInvoiceNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns null or the invoice-number.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string | null", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "return.getinvoicenumber" + ], + "title": "Return.getInvoiceNumber" + }, + { + "description": "A note for the return.", + "id": "script-api:dw/order/Return#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getNote", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "A note for the return.", + "heading": "Description" + } + ], + "signature": "getNote(): string | null", + "source": "script-api", + "tags": [ + "getnote", + "return.getnote" + ], + "title": "Return.getNote" + }, + { + "description": "Returns the dw.order.ReturnCase with which this Return is associated. The ReturnCase may represent an RMA (return merchandise authorization).", + "id": "script-api:dw/order/Return#getReturnCase", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getReturnCase", + "returns": { + "type": "ReturnCase" + }, + "sections": [ + { + "body": "Returns the dw.order.ReturnCase with which this Return is associated. The ReturnCase\nmay represent an RMA (return merchandise authorization).", + "heading": "Description" + } + ], + "signature": "getReturnCase(): ReturnCase", + "source": "script-api", + "tags": [ + "getreturncase", + "return.getreturncase" + ], + "title": "Return.getReturnCase" + }, + { + "description": "The return number identifying this return.", + "id": "script-api:dw/order/Return#getReturnNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getReturnNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The return number identifying this return.", + "heading": "Description" + } + ], + "signature": "getReturnNumber(): string", + "source": "script-api", + "tags": [ + "getreturnnumber", + "return.getreturnnumber" + ], + "title": "Return.getReturnNumber" + }, + { + "description": "Gets the return status.", + "id": "script-api:dw/order/Return#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the return status.\n\nPossible values are STATUS_NEW, STATUS_COMPLETED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "return.getstatus" + ], + "title": "Return.getStatus" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/Return#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.invoice", + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "readonly invoice: Invoice | null", + "source": "script-api", + "tags": [ + "invoice", + "return.invoice" + ], + "title": "Return.invoice" + }, + { + "description": "Returns null or the invoice-number.", + "id": "script-api:dw/order/Return#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.invoiceNumber", + "sections": [ + { + "body": "Returns null or the invoice-number.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string | null", + "source": "script-api", + "tags": [ + "invoicenumber", + "return.invoicenumber" + ], + "title": "Return.invoiceNumber" + }, + { + "description": "A note for the return.", + "id": "script-api:dw/order/Return#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.note", + "sections": [ + { + "body": "A note for the return.", + "heading": "Description" + } + ], + "signature": "note: string | null", + "source": "script-api", + "tags": [ + "note", + "return.note" + ], + "title": "Return.note" + }, + { + "description": "Returns the dw.order.ReturnCase with which this Return is associated. The ReturnCase may represent an RMA (return merchandise authorization).", + "id": "script-api:dw/order/Return#returnCase", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.returnCase", + "sections": [ + { + "body": "Returns the dw.order.ReturnCase with which this Return is associated. The ReturnCase\nmay represent an RMA (return merchandise authorization).", + "heading": "Description" + } + ], + "signature": "readonly returnCase: ReturnCase", + "source": "script-api", + "tags": [ + "returncase", + "return.returncase" + ], + "title": "Return.returnCase" + }, + { + "description": "The return number identifying this return.", + "id": "script-api:dw/order/Return#returnNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.returnNumber", + "sections": [ + { + "body": "The return number identifying this return.", + "heading": "Description" + } + ], + "signature": "readonly returnNumber: string", + "source": "script-api", + "tags": [ + "returnnumber", + "return.returnnumber" + ], + "title": "Return.returnNumber" + }, + { + "description": "Sets a note for the return.", + "id": "script-api:dw/order/Return#setNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "note", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.setNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a note for the return.", + "heading": "Description" + } + ], + "signature": "setNote(note: string): void", + "source": "script-api", + "tags": [ + "setnote", + "return.setnote" + ], + "title": "Return.setNote" + }, + { + "description": "Sets the return status.", + "id": "script-api:dw/order/Return#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "statusName", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the return status.\n\nPossible values are STATUS_NEW, STATUS_COMPLETED\n\nWhen set to status COMPLETED, only the the custom attributes of the return itself and its return items can be changed.", + "heading": "Description" + } + ], + "signature": "setStatus(statusName: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "return.setstatus" + ], + "title": "Return.setStatus" + }, + { + "description": "Gets the return status.", + "id": "script-api:dw/order/Return#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Return", + "qualifiedName": "dw.order.Return.status", + "sections": [ + { + "body": "Gets the return status.\n\nPossible values are STATUS_NEW, STATUS_COMPLETED.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "return.status" + ], + "title": "Return.status" + }, + { + "description": "All returns exist in the context of a ReturnCase, each dw.order.Order can have any number of ReturnCases.", + "id": "script-api:dw/order/ReturnCase", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnCase", + "sections": [ + { + "body": "All returns exist in the context of a ReturnCase, each dw.order.Order\ncan have any number of ReturnCases.\n\nThe ReturnCase has dw.order.ReturnCaseItems, each of which is associated with an\ndw.order.OrderItem (an extension to either a dw.order.ProductLineItem or a dw.order.ShippingLineItem).\n\nEach ReturnCaseItem defines dw.order.ReturnCaseItem.getAuthorizedQuantity representing the maximum\nquantity expected to be returned. The ReturnCaseItem may be associated with\n0..n dw.order.ReturnItems - ReturnItems are added to the ReturnCaseItem when\ndw.order.Returns are created.\n\nEither - a ReturnCase may be used as an RMA, in which case they are\ncreated when a customer first shows a wish to return item(s). The customer\nthen includes the RMA number with the returned item(s). The Return created as\na result is then associated with the existing ReturnCase.\n\nOr - a ReturnCase is automatically created as part of the return\ncreation, i.e. the customer returns some item(s) leading to a creation of\nboth a Return and an associated ReturnCase.\n\nThe scripting api allows access to the ReturnCases, whether the ReturnCase is an RMA or not,\nand the ReturnCase status. Both the ReturnCaseItems and any Returns\nassociated with the ReturnCase can be accessed.\n\nA ReturnCase has one of these status values:\n\n- NEW - the ReturnCase has been created and can be edited previous to\nits authorization\n- CONFIRMED - the ReturnCase is CONFIRMED, can no longer be edited, no\nReturns have been associated with it. Only a NEW- ReturnCase can be\nCONFIRMED\n- PARTIAL_RETURNED - the ReturnCase has been associated with at least one Return,\nbut is not yet complete. Only a CONFIRMED- ReturnCase can be set to\nPARTIAL_RETURNED\n- RETURNED - the ReturnCase has been associated with Returns which match\nthe expected authorized quantity. Only an CONFIRMED- or PARTIAL_RETURNED- return-case\ncan be set to RETURNED\n- CANCELLED - the ReturnCase has been cancelled (only a NEW- or\nCONFIRMED- ReturnCase can be cancelled)\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "returncase", + "dw.order.returncase", + "dw/order" + ], + "title": "ReturnCase" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "returncase.orderby_itemid" + ], + "title": "ReturnCase.ORDERBY_ITEMID" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "returncase.orderby_itemid" + ], + "title": "ReturnCase.ORDERBY_ITEMID" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "returncase.orderby_itemposition" + ], + "title": "ReturnCase.ORDERBY_ITEMPOSITION" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "returncase.orderby_itemposition" + ], + "title": "ReturnCase.ORDERBY_ITEMPOSITION" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "returncase.orderby_unsorted" + ], + "title": "ReturnCase.ORDERBY_UNSORTED" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ReturnCase#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "returncase.orderby_unsorted" + ], + "title": "ReturnCase.ORDERBY_UNSORTED" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ReturnCase#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "returncase.qualifier_productitems" + ], + "title": "ReturnCase.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ReturnCase#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "returncase.qualifier_productitems" + ], + "title": "ReturnCase.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ReturnCase#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "returncase.qualifier_serviceitems" + ], + "title": "ReturnCase.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ReturnCase#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "returncase.qualifier_serviceitems" + ], + "title": "ReturnCase.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Return whether this is an RMA. This is specified when calling dw.order.Order.createReturnCase.", + "id": "script-api:dw/order/ReturnCase#RMA", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.RMA", + "sections": [ + { + "body": "Return whether this is an RMA. This is specified when calling dw.order.Order.createReturnCase.", + "heading": "Description" + } + ], + "signature": "readonly RMA: boolean", + "source": "script-api", + "tags": [ + "rma", + "returncase.rma" + ], + "title": "ReturnCase.RMA" + }, + { + "description": "constant for ReturnCase Status CANCELLED", + "id": "script-api:dw/order/ReturnCase#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CANCELLED", + "sections": [ + { + "body": "constant for ReturnCase Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "returncase.status_cancelled" + ], + "title": "ReturnCase.STATUS_CANCELLED" + }, + { + "description": "constant for ReturnCase Status CANCELLED", + "id": "script-api:dw/order/ReturnCase#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CANCELLED", + "sections": [ + { + "body": "constant for ReturnCase Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "returncase.status_cancelled" + ], + "title": "ReturnCase.STATUS_CANCELLED" + }, + { + "description": "constant for ReturnCase Status CONFIRMED", + "id": "script-api:dw/order/ReturnCase#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for ReturnCase Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "returncase.status_confirmed" + ], + "title": "ReturnCase.STATUS_CONFIRMED" + }, + { + "description": "constant for ReturnCase Status CONFIRMED", + "id": "script-api:dw/order/ReturnCase#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for ReturnCase Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "returncase.status_confirmed" + ], + "title": "ReturnCase.STATUS_CONFIRMED" + }, + { + "description": "constant for ReturnCase Status NEW", + "id": "script-api:dw/order/ReturnCase#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_NEW", + "sections": [ + { + "body": "constant for ReturnCase Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "returncase.status_new" + ], + "title": "ReturnCase.STATUS_NEW" + }, + { + "description": "constant for ReturnCase Status NEW", + "id": "script-api:dw/order/ReturnCase#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_NEW", + "sections": [ + { + "body": "constant for ReturnCase Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "returncase.status_new" + ], + "title": "ReturnCase.STATUS_NEW" + }, + { + "description": "constant for ReturnCase Status PARTIAL RETURNED", + "id": "script-api:dw/order/ReturnCase#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_PARTIAL_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status PARTIAL RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIAL_RETURNED: string", + "source": "script-api", + "tags": [ + "status_partial_returned", + "returncase.status_partial_returned" + ], + "title": "ReturnCase.STATUS_PARTIAL_RETURNED" + }, + { + "description": "constant for ReturnCase Status PARTIAL RETURNED", + "id": "script-api:dw/order/ReturnCase#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_PARTIAL_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status PARTIAL RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIAL_RETURNED: string", + "source": "script-api", + "tags": [ + "status_partial_returned", + "returncase.status_partial_returned" + ], + "title": "ReturnCase.STATUS_PARTIAL_RETURNED" + }, + { + "description": "constant for ReturnCase Status RETURNED", + "id": "script-api:dw/order/ReturnCase#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "returncase.status_returned" + ], + "title": "ReturnCase.STATUS_RETURNED" + }, + { + "description": "constant for ReturnCase Status RETURNED", + "id": "script-api:dw/order/ReturnCase#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.STATUS_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "returncase.status_returned" + ], + "title": "ReturnCase.STATUS_RETURNED" + }, + { + "description": "Attempt to confirm the ReturnCase.", + "id": "script-api:dw/order/ReturnCase#confirm", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.confirm", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Attempt to confirm the ReturnCase.\n\nWithout items the return case will be canceled\n\nWhen confirmed, only the the custom attributes of its return case items can be changed.", + "heading": "Description" + } + ], + "signature": "confirm(): void", + "source": "script-api", + "tags": [ + "confirm", + "returncase.confirm" + ], + "throws": [ + { + "description": "thrown if Status is not STATUS_NEW", + "type": "IllegalStateException" + } + ], + "title": "ReturnCase.confirm" + }, + { + "description": "Creates a new dw.order.Invoice based on this ReturnCase. The return-case-number will be used as the invoice-number. The Invoice can then be accessed using getInvoice or its number using getInvoiceNumber. The method must not be called more than once for a ReturnCase, nor may 2 Invoices exist with the same invoice-number.", + "id": "script-api:dw/order/ReturnCase#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this\nReturnCase. The return-case-number will\nbe used as the invoice-number. The Invoice can then be\naccessed using getInvoice or its number using\ngetInvoiceNumber. The method must not be called more than once\nfor a ReturnCase, nor may 2 Invoices\nexist with the same invoice-number.\n\nThe new Invoice is a credit-invoice with a\ndw.order.Invoice.STATUS_NOT_PAID status, and will be passed to\nthe refund payment-hook in a separate database transaction for\nprocessing.", + "heading": "Description" + } + ], + "signature": "createInvoice(): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "returncase.createinvoice" + ], + "title": "ReturnCase.createInvoice" + }, + { + "description": "Creates a new dw.order.Invoice based on this ReturnCase. The invoice-number must be specified as an argument. The Invoice can then be accessed using getInvoice or its number using getInvoiceNumber. The method must not be called more than once for a ReturnCase, nor may 2 Invoices exist with the same invoice-number.", + "id": "script-api:dw/order/ReturnCase#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this\nReturnCase. The invoice-number must be specified as an\nargument. The Invoice can then be\naccessed using getInvoice or its number using\ngetInvoiceNumber. The method must not be called more than once\nfor a ReturnCase, nor may 2 Invoices\nexist with the same invoice-number.\n\nThe new Invoice is a credit-invoice with a\ndw.order.Invoice.STATUS_NOT_PAID status, and will be passed to\nthe refund payment-hook in a separate database transaction for\nprocessing.", + "heading": "Description" + } + ], + "signature": "createInvoice(invoiceNumber: string): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "returncase.createinvoice" + ], + "title": "ReturnCase.createInvoice" + }, + { + "description": "Creates a new item for a given order item. Note: a ReturnCase may have only one item per order item.", + "id": "script-api:dw/order/ReturnCase#createItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderItemID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createItem", + "returns": { + "type": "ReturnCaseItem | null" + }, + "sections": [ + { + "body": "Creates a new item for a given order item. Note: a ReturnCase may have\nonly one item per order item.", + "heading": "Description" + } + ], + "signature": "createItem(orderItemID: string): ReturnCaseItem | null", + "source": "script-api", + "tags": [ + "createitem", + "returncase.createitem" + ], + "throws": [ + { + "description": "thrown if getItem(orderItem) returns non null", + "type": "IllegalArgumentException" + } + ], + "title": "ReturnCase.createItem" + }, + { + "description": "Creates a new dw.order.Return with the given number and associates it with this ReturnCase.", + "id": "script-api:dw/order/ReturnCase#createReturn", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createReturn", + "returns": { + "type": "Return" + }, + "sections": [ + { + "body": "Creates a new dw.order.Return with the given number and associates it with this ReturnCase.", + "heading": "Description" + } + ], + "signature": "createReturn(returnNumber: string): Return", + "source": "script-api", + "tags": [ + "createreturn", + "returncase.createreturn" + ], + "title": "ReturnCase.createReturn" + }, + { + "description": "Creates a new dw.order.Return with a generated number and associates it with this ReturnCase.", + "id": "script-api:dw/order/ReturnCase#createReturn", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.createReturn", + "returns": { + "type": "Return" + }, + "sections": [ + { + "body": "Creates a new dw.order.Return with a generated number and associates it with this ReturnCase.", + "heading": "Description" + } + ], + "signature": "createReturn(): Return", + "source": "script-api", + "tags": [ + "createreturn", + "returncase.createreturn" + ], + "title": "ReturnCase.createReturn" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/ReturnCase#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getInvoice", + "returns": { + "type": "Invoice | null" + }, + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "getInvoice(): Invoice | null", + "source": "script-api", + "tags": [ + "getinvoice", + "returncase.getinvoice" + ], + "title": "ReturnCase.getInvoice" + }, + { + "description": "Returns null or the invoice-number.", + "id": "script-api:dw/order/ReturnCase#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getInvoiceNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns null or the invoice-number.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string | null", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "returncase.getinvoicenumber" + ], + "title": "ReturnCase.getInvoiceNumber" + }, + { + "description": "Returns the mandatory return case number identifying this document.", + "id": "script-api:dw/order/ReturnCase#getReturnCaseNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getReturnCaseNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the mandatory return case number identifying this document.", + "heading": "Description" + } + ], + "signature": "getReturnCaseNumber(): string", + "source": "script-api", + "tags": [ + "getreturncasenumber", + "returncase.getreturncasenumber" + ], + "title": "ReturnCase.getReturnCaseNumber" + }, + { + "description": "Return the collection of dw.order.Returns associated with this ReturnCase.", + "id": "script-api:dw/order/ReturnCase#getReturns", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getReturns", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Return the collection of dw.order.Returns associated with this ReturnCase.", + "heading": "Description" + } + ], + "signature": "getReturns(): Collection", + "source": "script-api", + "tags": [ + "getreturns", + "returncase.getreturns" + ], + "title": "ReturnCase.getReturns" + }, + { + "description": "Gets the return case item status. The status of a ReturnCase is read-only and calculated from the status of the associated dw.order.ReturnCaseItems.", + "id": "script-api:dw/order/ReturnCase#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the return case item status. The status of a ReturnCase is read-only and calculated from the status of\nthe associated dw.order.ReturnCaseItems.\n\nThe possible values are STATUS_NEW,STATUS_CONFIRMED,\nSTATUS_PARTIAL_RETURNED, STATUS_RETURNED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "returncase.getstatus" + ], + "title": "ReturnCase.getStatus" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/ReturnCase#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.invoice", + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "readonly invoice: Invoice | null", + "source": "script-api", + "tags": [ + "invoice", + "returncase.invoice" + ], + "title": "ReturnCase.invoice" + }, + { + "description": "Returns null or the invoice-number.", + "id": "script-api:dw/order/ReturnCase#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.invoiceNumber", + "sections": [ + { + "body": "Returns null or the invoice-number.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string | null", + "source": "script-api", + "tags": [ + "invoicenumber", + "returncase.invoicenumber" + ], + "title": "ReturnCase.invoiceNumber" + }, + { + "description": "Return whether this is an RMA. This is specified when calling dw.order.Order.createReturnCase.", + "id": "script-api:dw/order/ReturnCase#isRMA", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.isRMA", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Return whether this is an RMA. This is specified when calling dw.order.Order.createReturnCase.", + "heading": "Description" + } + ], + "signature": "isRMA(): boolean", + "source": "script-api", + "tags": [ + "isrma", + "returncase.isrma" + ], + "title": "ReturnCase.isRMA" + }, + { + "description": "Returns the mandatory return case number identifying this document.", + "id": "script-api:dw/order/ReturnCase#returnCaseNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.returnCaseNumber", + "sections": [ + { + "body": "Returns the mandatory return case number identifying this document.", + "heading": "Description" + } + ], + "signature": "readonly returnCaseNumber: string", + "source": "script-api", + "tags": [ + "returncasenumber", + "returncase.returncasenumber" + ], + "title": "ReturnCase.returnCaseNumber" + }, + { + "description": "Return the collection of dw.order.Returns associated with this ReturnCase.", + "id": "script-api:dw/order/ReturnCase#returns", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.returns", + "sections": [ + { + "body": "Return the collection of dw.order.Returns associated with this ReturnCase.", + "heading": "Description" + } + ], + "signature": "readonly returns: Collection", + "source": "script-api", + "tags": [ + "returns", + "returncase.returns" + ], + "title": "ReturnCase.returns" + }, + { + "description": "Gets the return case item status. The status of a ReturnCase is read-only and calculated from the status of the associated dw.order.ReturnCaseItems.", + "id": "script-api:dw/order/ReturnCase#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCase", + "qualifiedName": "dw.order.ReturnCase.status", + "sections": [ + { + "body": "Gets the return case item status. The status of a ReturnCase is read-only and calculated from the status of\nthe associated dw.order.ReturnCaseItems.\n\nThe possible values are STATUS_NEW,STATUS_CONFIRMED,\nSTATUS_PARTIAL_RETURNED, STATUS_RETURNED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "readonly status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "returncase.status" + ], + "title": "ReturnCase.status" + }, + { + "description": "An item of a dw.order.ReturnCase, created using method dw.order.ReturnCase.createItem. Initially the ReturnCaseItem is NEW. No dw.order.Return can be created at this point. From NEW the item transitions in CONFIRMED state. Now Return can be created. Next transition is either to PARTIAL_RETURNED or to CANCELLED. At the end the item can be RETURNED (no other Returns can be created.", + "id": "script-api:dw/order/ReturnCaseItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnCaseItem", + "sections": [ + { + "body": "An item of a dw.order.ReturnCase, created using method\ndw.order.ReturnCase.createItem. Initially the\nReturnCaseItem is NEW. No dw.order.Return can be\ncreated at this point. From NEW the item transitions in CONFIRMED state.\nNow Return can be created. Next transition is either to\nPARTIAL_RETURNED or to CANCELLED. At the end the item can be RETURNED (no other\nReturns can be created.\n\nThe custom code implementing the ReturnHooks is\nresponsible to provide the logic for the transitions. Please refer to the\ndocumentation of dw.order.hooks.ReturnHooks for further\ninformation.\n\nWhen the related ReturnCase were confirmed, only the the custom attributes of the return case item can be changed.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "returncaseitem", + "dw.order.returncaseitem", + "dw/order" + ], + "title": "ReturnCaseItem" + }, + { + "description": "constant for ReturnCase Status CANCELLED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CANCELLED", + "sections": [ + { + "body": "constant for ReturnCase Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "returncaseitem.status_cancelled" + ], + "title": "ReturnCaseItem.STATUS_CANCELLED" + }, + { + "description": "constant for ReturnCase Status CANCELLED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CANCELLED", + "sections": [ + { + "body": "constant for ReturnCase Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "returncaseitem.status_cancelled" + ], + "title": "ReturnCaseItem.STATUS_CANCELLED" + }, + { + "description": "constant for ReturnCase Status CONFIRMED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for ReturnCase Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "returncaseitem.status_confirmed" + ], + "title": "ReturnCaseItem.STATUS_CONFIRMED" + }, + { + "description": "constant for ReturnCase Status CONFIRMED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "constant for ReturnCase Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "returncaseitem.status_confirmed" + ], + "title": "ReturnCaseItem.STATUS_CONFIRMED" + }, + { + "description": "constant for ReturnCase Status NEW", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_NEW", + "sections": [ + { + "body": "constant for ReturnCase Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "returncaseitem.status_new" + ], + "title": "ReturnCaseItem.STATUS_NEW" + }, + { + "description": "constant for ReturnCase Status NEW", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_NEW", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_NEW", + "sections": [ + { + "body": "constant for ReturnCase Status NEW", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_NEW: string", + "source": "script-api", + "tags": [ + "status_new", + "returncaseitem.status_new" + ], + "title": "ReturnCaseItem.STATUS_NEW" + }, + { + "description": "constant for ReturnCase Status PARTIAL RETURNED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_PARTIAL_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status PARTIAL RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIAL_RETURNED: string", + "source": "script-api", + "tags": [ + "status_partial_returned", + "returncaseitem.status_partial_returned" + ], + "title": "ReturnCaseItem.STATUS_PARTIAL_RETURNED" + }, + { + "description": "constant for ReturnCase Status PARTIAL RETURNED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_PARTIAL_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_PARTIAL_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status PARTIAL RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_PARTIAL_RETURNED: string", + "source": "script-api", + "tags": [ + "status_partial_returned", + "returncaseitem.status_partial_returned" + ], + "title": "ReturnCaseItem.STATUS_PARTIAL_RETURNED" + }, + { + "description": "constant for ReturnCase Status RETURNED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "returncaseitem.status_returned" + ], + "title": "ReturnCaseItem.STATUS_RETURNED" + }, + { + "description": "constant for ReturnCase Status RETURNED", + "id": "script-api:dw/order/ReturnCaseItem#STATUS_RETURNED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.STATUS_RETURNED", + "sections": [ + { + "body": "constant for ReturnCase Status RETURNED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_RETURNED: string", + "source": "script-api", + "tags": [ + "status_returned", + "returncaseitem.status_returned" + ], + "title": "ReturnCaseItem.STATUS_RETURNED" + }, + { + "description": "Return the dw.value.Quantity authorized for this ReturnCaseItem, may be N/A.", + "id": "script-api:dw/order/ReturnCaseItem#authorizedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.authorizedQuantity", + "sections": [ + { + "body": "Return the dw.value.Quantity authorized for this ReturnCaseItem, may be N/A.", + "heading": "Description" + } + ], + "signature": "authorizedQuantity: Quantity", + "source": "script-api", + "tags": [ + "authorizedquantity", + "returncaseitem.authorizedquantity" + ], + "title": "ReturnCaseItem.authorizedQuantity" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ReturnCaseItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.basePrice", + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "readonly basePrice: Money", + "source": "script-api", + "tags": [ + "baseprice", + "returncaseitem.baseprice" + ], + "title": "ReturnCaseItem.basePrice" + }, + { + "description": "Create a new dw.order.ReturnItem for this ReturnCaseItem and assign it to the given dw.order.Return.", + "id": "script-api:dw/order/ReturnCaseItem#createReturnItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "returnNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.createReturnItem", + "returns": { + "type": "ReturnItem" + }, + "sections": [ + { + "body": "Create a new dw.order.ReturnItem for this ReturnCaseItem and assign it to the\ngiven dw.order.Return.", + "heading": "Description" + } + ], + "signature": "createReturnItem(returnNumber: string): ReturnItem", + "source": "script-api", + "tags": [ + "createreturnitem", + "returncaseitem.createreturnitem" + ], + "title": "ReturnCaseItem.createReturnItem" + }, + { + "description": "Return the dw.value.Quantity authorized for this ReturnCaseItem, may be N/A.", + "id": "script-api:dw/order/ReturnCaseItem#getAuthorizedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getAuthorizedQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Return the dw.value.Quantity authorized for this ReturnCaseItem, may be N/A.", + "heading": "Description" + } + ], + "signature": "getAuthorizedQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getauthorizedquantity", + "returncaseitem.getauthorizedquantity" + ], + "title": "ReturnCaseItem.getAuthorizedQuantity" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ReturnCaseItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getBasePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "getBasePrice(): Money", + "source": "script-api", + "tags": [ + "getbaseprice", + "returncaseitem.getbaseprice" + ], + "title": "ReturnCaseItem.getBasePrice" + }, + { + "description": "Return the note for this return case item.", + "id": "script-api:dw/order/ReturnCaseItem#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getNote", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Return the note for this return case item.", + "heading": "Description" + } + ], + "signature": "getNote(): string | null", + "source": "script-api", + "tags": [ + "getnote", + "returncaseitem.getnote" + ], + "title": "ReturnCaseItem.getNote" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ReturnCaseItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getParentItem", + "returns": { + "type": "ReturnCaseItem | null" + }, + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "getParentItem(): ReturnCaseItem | null", + "source": "script-api", + "tags": [ + "getparentitem", + "returncaseitem.getparentitem" + ], + "title": "ReturnCaseItem.getParentItem" + }, + { + "description": "Returns the reason code for return case item.", + "id": "script-api:dw/order/ReturnCaseItem#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReasonCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the reason code for return case item.", + "heading": "Description" + } + ], + "signature": "getReasonCode(): EnumValue", + "source": "script-api", + "tags": [ + "getreasoncode", + "returncaseitem.getreasoncode" + ], + "title": "ReturnCaseItem.getReasonCode" + }, + { + "description": "Mandatory number of dw.order.ReturnCase to which this item belongs", + "id": "script-api:dw/order/ReturnCaseItem#getReturnCaseNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReturnCaseNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Mandatory number of dw.order.ReturnCase to which this item belongs", + "heading": "Description" + } + ], + "signature": "getReturnCaseNumber(): string", + "source": "script-api", + "tags": [ + "getreturncasenumber", + "returncaseitem.getreturncasenumber" + ], + "title": "ReturnCaseItem.getReturnCaseNumber" + }, + { + "description": "Unsorted collection of dw.order.ReturnItems associated with this ReturnCaseItem.", + "id": "script-api:dw/order/ReturnCaseItem#getReturnItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getReturnItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Unsorted collection of dw.order.ReturnItems associated with this ReturnCaseItem.", + "heading": "Description" + } + ], + "signature": "getReturnItems(): Collection", + "source": "script-api", + "tags": [ + "getreturnitems", + "returncaseitem.getreturnitems" + ], + "title": "ReturnCaseItem.getReturnItems" + }, + { + "description": "Gets the return case item status.", + "id": "script-api:dw/order/ReturnCaseItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the return case item status.\n\nThe possible values are STATUS_NEW,STATUS_CONFIRMED,\nSTATUS_PARTIAL_RETURNED, STATUS_RETURNED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "returncaseitem.getstatus" + ], + "title": "ReturnCaseItem.getStatus" + }, + { + "description": "Return the note for this return case item.", + "id": "script-api:dw/order/ReturnCaseItem#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.note", + "sections": [ + { + "body": "Return the note for this return case item.", + "heading": "Description" + } + ], + "signature": "note: string | null", + "source": "script-api", + "tags": [ + "note", + "returncaseitem.note" + ], + "title": "ReturnCaseItem.note" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ReturnCaseItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.parentItem", + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "parentItem: ReturnCaseItem | null", + "source": "script-api", + "tags": [ + "parentitem", + "returncaseitem.parentitem" + ], + "title": "ReturnCaseItem.parentItem" + }, + { + "description": "Returns the reason code for return case item.", + "id": "script-api:dw/order/ReturnCaseItem#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.reasonCode", + "sections": [ + { + "body": "Returns the reason code for return case item.", + "heading": "Description" + } + ], + "signature": "reasonCode: EnumValue", + "source": "script-api", + "tags": [ + "reasoncode", + "returncaseitem.reasoncode" + ], + "title": "ReturnCaseItem.reasonCode" + }, + { + "description": "Mandatory number of dw.order.ReturnCase to which this item belongs", + "id": "script-api:dw/order/ReturnCaseItem#returnCaseNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.returnCaseNumber", + "sections": [ + { + "body": "Mandatory number of dw.order.ReturnCase to which this item belongs", + "heading": "Description" + } + ], + "signature": "readonly returnCaseNumber: string", + "source": "script-api", + "tags": [ + "returncasenumber", + "returncaseitem.returncasenumber" + ], + "title": "ReturnCaseItem.returnCaseNumber" + }, + { + "description": "Unsorted collection of dw.order.ReturnItems associated with this ReturnCaseItem.", + "id": "script-api:dw/order/ReturnCaseItem#returnItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.returnItems", + "sections": [ + { + "body": "Unsorted collection of dw.order.ReturnItems associated with this ReturnCaseItem.", + "heading": "Description" + } + ], + "signature": "readonly returnItems: Collection", + "source": "script-api", + "tags": [ + "returnitems", + "returncaseitem.returnitems" + ], + "title": "ReturnCaseItem.returnItems" + }, + { + "description": "Set the optional authorized dw.value.Quantity for this item. Passing null will result in an N/A Quantity being set.", + "id": "script-api:dw/order/ReturnCaseItem#setAuthorizedQuantity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "authorizedQuantity", + "type": "Quantity | null" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setAuthorizedQuantity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the optional authorized dw.value.Quantity for this item. Passing null will result in an N/A Quantity\nbeing set.", + "heading": "Description" + } + ], + "signature": "setAuthorizedQuantity(authorizedQuantity: Quantity | null): void", + "source": "script-api", + "tags": [ + "setauthorizedquantity", + "returncaseitem.setauthorizedquantity" + ], + "title": "ReturnCaseItem.setAuthorizedQuantity" + }, + { + "description": "Sets a note for this return case item.", + "id": "script-api:dw/order/ReturnCaseItem#setNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "note", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a note for this return case item.", + "heading": "Description" + } + ], + "signature": "setNote(note: string): void", + "source": "script-api", + "tags": [ + "setnote", + "returncaseitem.setnote" + ], + "title": "ReturnCaseItem.setNote" + }, + { + "description": "Set a parent item. The parent item must belong to the same dw.order.ReturnCase. An infinite parent-child loop is disallowed as is a parent-child depth greater than 10. Setting a parent item indicates a dependency of the child item on the parent item, and can be used to form a parallel structure to that accessed using dw.order.ProductLineItem.getParent.", + "id": "script-api:dw/order/ReturnCaseItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "parentItem", + "type": "ReturnCaseItem" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setParentItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a parent item. The parent item must belong to the same\ndw.order.ReturnCase. An infinite parent-child loop is disallowed\nas is a parent-child depth greater than 10. Setting a parent item\nindicates a dependency of the child item on the parent item, and can be\nused to form a parallel structure to that accessed using\ndw.order.ProductLineItem.getParent.", + "heading": "Description" + } + ], + "signature": "setParentItem(parentItem: ReturnCaseItem): void", + "source": "script-api", + "tags": [ + "setparentitem", + "returncaseitem.setparentitem" + ], + "title": "ReturnCaseItem.setParentItem" + }, + { + "description": "Changes the reason code. Initially the reason code is set on return case item creation.", + "id": "script-api:dw/order/ReturnCaseItem#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reasonCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setReasonCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Changes the reason code. Initially the reason code is set on return case\nitem creation.", + "heading": "Description" + } + ], + "signature": "setReasonCode(reasonCode: string): void", + "source": "script-api", + "tags": [ + "setreasoncode", + "returncaseitem.setreasoncode" + ], + "title": "ReturnCaseItem.setReasonCode" + }, + { + "description": "Sets the status.", + "id": "script-api:dw/order/ReturnCaseItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "statusString", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status.\n\nThe possible values are STATUS_NEW,STATUS_CONFIRMED,\nSTATUS_PARTIAL_RETURNED, STATUS_RETURNED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "setStatus(statusString: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "returncaseitem.setstatus" + ], + "throws": [ + { + "description": "if status is null", + "type": "NullPointerException" + }, + { + "description": "if the status transition to the status is not allowed", + "type": "IllegalArgumentException" + } + ], + "title": "ReturnCaseItem.setStatus" + }, + { + "description": "Gets the return case item status.", + "id": "script-api:dw/order/ReturnCaseItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnCaseItem", + "qualifiedName": "dw.order.ReturnCaseItem.status", + "sections": [ + { + "body": "Gets the return case item status.\n\nThe possible values are STATUS_NEW,STATUS_CONFIRMED,\nSTATUS_PARTIAL_RETURNED, STATUS_RETURNED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "returncaseitem.status" + ], + "title": "ReturnCaseItem.status" + }, + { + "description": "An item of a dw.order.Return, created using dw.order.Return.createItem. Represents a physically returned order line item. Please refer to the documentation of dw.order.hooks.ReturnHooks for further information.", + "id": "script-api:dw/order/ReturnItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ReturnItem", + "sections": [ + { + "body": "An item of a dw.order.Return, created using dw.order.Return.createItem.\nRepresents a physically returned order line item. Please refer to the documentation of dw.order.hooks.ReturnHooks\nfor further information.\n\nWhen the related Return were set to status COMPLETED, only the the custom attributes of the return item can be changed.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "returnitem", + "dw.order.returnitem", + "dw/order" + ], + "title": "ReturnItem" + }, + { + "description": "Create a new dw.order.TaxItem tax-item and add to this item.", + "id": "script-api:dw/order/ReturnItem#addTaxItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "amount", + "type": "Decimal" + }, + { + "name": "taxGroup", + "type": "TaxGroup" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.addTaxItem", + "returns": { + "type": "TaxItem" + }, + "sections": [ + { + "body": "Create a new dw.order.TaxItem tax-item and add to this item.", + "heading": "Description" + } + ], + "signature": "addTaxItem(amount: Decimal, taxGroup: TaxGroup): TaxItem", + "source": "script-api", + "tags": [ + "addtaxitem", + "returnitem.addtaxitem" + ], + "title": "ReturnItem.addTaxItem" + }, + { + "description": "Apply a rate of (factor / divisor) to the prices in this item, with the option to half round up or half round down to the nearest cent if necessary.", + "id": "script-api:dw/order/ReturnItem#applyPriceRate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "factor", + "type": "Decimal" + }, + { + "name": "divisor", + "type": "Decimal" + }, + { + "name": "roundUp", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.applyPriceRate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Apply a rate of (factor / divisor) to the prices in this item, with the option to half round up or half round down to the\nnearest cent if necessary.\n\nExamples:\n\nTaxBasis before factor divisor roundup Calculation TaxBasis after\n$10.00 1 2 true 10*1/2= $5.00\n$10.00 9 10 true 10*9/10= $9.00\n$10.00 1 3 true 10*1/3=3.3333= $3.33\n$2.47 1 2 true 2.47*1/2=1.235= $1.24\n$2.47 1 2 false 2.47*1/2=1.235= $1.23\n\nWhich prices are updated?:\n\nThe rate described above is applied to tax-basis and tax then the net-price and gross-price are recalculated by adding / subtracting\ndepending on whether the order is based on net price.\n\nExample (order based on net price)\n\nNew TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis=$10.00, GrossPrice=TaxBasis+Tax=$11.00\n\nExample (order based on gross price)\n\nNew TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis-tax=$9.00, GrossPrice=TaxBasis=$10.00", + "heading": "Description" + } + ], + "signature": "applyPriceRate(factor: Decimal, divisor: Decimal, roundUp: boolean): void", + "source": "script-api", + "tags": [ + "applypricerate", + "returnitem.applypricerate" + ], + "title": "ReturnItem.applyPriceRate" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ReturnItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.basePrice", + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "readonly basePrice: Money", + "source": "script-api", + "tags": [ + "baseprice", + "returnitem.baseprice" + ], + "title": "ReturnItem.basePrice" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ReturnItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getBasePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "getBasePrice(): Money", + "source": "script-api", + "tags": [ + "getbaseprice", + "returnitem.getbaseprice" + ], + "title": "ReturnItem.getBasePrice" + }, + { + "description": "Return the note for this return item.", + "id": "script-api:dw/order/ReturnItem#getNote", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getNote", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Return the note for this return item.", + "heading": "Description" + } + ], + "signature": "getNote(): string | null", + "source": "script-api", + "tags": [ + "getnote", + "returnitem.getnote" + ], + "title": "ReturnItem.getNote" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ReturnItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getParentItem", + "returns": { + "type": "ReturnItem | null" + }, + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "getParentItem(): ReturnItem | null", + "source": "script-api", + "tags": [ + "getparentitem", + "returnitem.getparentitem" + ], + "title": "ReturnItem.getParentItem" + }, + { + "description": "Returns the reason code for return item. The list of reason codes can be updated by updating meta-data for ReturnItem.", + "id": "script-api:dw/order/ReturnItem#getReasonCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReasonCode", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the reason code for return item. The list of reason codes can be updated\nby updating meta-data for ReturnItem.", + "heading": "Description" + } + ], + "signature": "getReasonCode(): EnumValue", + "source": "script-api", + "tags": [ + "getreasoncode", + "returnitem.getreasoncode" + ], + "title": "ReturnItem.getReasonCode" + }, + { + "description": "Returns the return case item related to this item. Should never return null.", + "id": "script-api:dw/order/ReturnItem#getReturnCaseItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnCaseItem", + "returns": { + "type": "ReturnCaseItem" + }, + "sections": [ + { + "body": "Returns the return case item related to this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "getReturnCaseItem(): ReturnCaseItem", + "source": "script-api", + "tags": [ + "getreturncaseitem", + "returnitem.getreturncaseitem" + ], + "title": "ReturnItem.getReturnCaseItem" + }, + { + "description": "The mandatory returnNumber of the dw.order.Return to which this item belongs.", + "id": "script-api:dw/order/ReturnItem#getReturnNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The mandatory returnNumber of the dw.order.Return to which this item belongs.", + "heading": "Description" + } + ], + "signature": "getReturnNumber(): string", + "source": "script-api", + "tags": [ + "getreturnnumber", + "returnitem.getreturnnumber" + ], + "title": "ReturnItem.getReturnNumber" + }, + { + "description": "The dw.value.Quantity returned. This may return an N/A quantity.", + "id": "script-api:dw/order/ReturnItem#getReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.getReturnedQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "The dw.value.Quantity returned. This may return an N/A quantity.", + "heading": "Description" + } + ], + "signature": "getReturnedQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getreturnedquantity", + "returnitem.getreturnedquantity" + ], + "title": "ReturnItem.getReturnedQuantity" + }, + { + "description": "Return the note for this return item.", + "id": "script-api:dw/order/ReturnItem#note", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.note", + "sections": [ + { + "body": "Return the note for this return item.", + "heading": "Description" + } + ], + "signature": "note: string | null", + "source": "script-api", + "tags": [ + "note", + "returnitem.note" + ], + "title": "ReturnItem.note" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ReturnItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.parentItem", + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "parentItem: ReturnItem | null", + "source": "script-api", + "tags": [ + "parentitem", + "returnitem.parentitem" + ], + "title": "ReturnItem.parentItem" + }, + { + "description": "Returns the reason code for return item. The list of reason codes can be updated by updating meta-data for ReturnItem.", + "id": "script-api:dw/order/ReturnItem#reasonCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.reasonCode", + "sections": [ + { + "body": "Returns the reason code for return item. The list of reason codes can be updated\nby updating meta-data for ReturnItem.", + "heading": "Description" + } + ], + "signature": "reasonCode: EnumValue", + "source": "script-api", + "tags": [ + "reasoncode", + "returnitem.reasoncode" + ], + "title": "ReturnItem.reasonCode" + }, + { + "description": "Returns the return case item related to this item. Should never return null.", + "id": "script-api:dw/order/ReturnItem#returnCaseItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnCaseItem", + "sections": [ + { + "body": "Returns the return case item related to this item. Should never return null.", + "heading": "Description" + } + ], + "signature": "readonly returnCaseItem: ReturnCaseItem", + "source": "script-api", + "tags": [ + "returncaseitem", + "returnitem.returncaseitem" + ], + "title": "ReturnItem.returnCaseItem" + }, + { + "description": "The mandatory returnNumber of the dw.order.Return to which this item belongs.", + "id": "script-api:dw/order/ReturnItem#returnNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnNumber", + "sections": [ + { + "body": "The mandatory returnNumber of the dw.order.Return to which this item belongs.", + "heading": "Description" + } + ], + "signature": "readonly returnNumber: string", + "source": "script-api", + "tags": [ + "returnnumber", + "returnitem.returnnumber" + ], + "title": "ReturnItem.returnNumber" + }, + { + "description": "The dw.value.Quantity returned. This may return an N/A quantity.", + "id": "script-api:dw/order/ReturnItem#returnedQuantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.returnedQuantity", + "sections": [ + { + "body": "The dw.value.Quantity returned. This may return an N/A quantity.", + "heading": "Description" + } + ], + "signature": "returnedQuantity: Quantity", + "source": "script-api", + "tags": [ + "returnedquantity", + "returnitem.returnedquantity" + ], + "title": "ReturnItem.returnedQuantity" + }, + { + "description": "Sets a note for this return item.", + "id": "script-api:dw/order/ReturnItem#setNote", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "note", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setNote", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a note for this return item.", + "heading": "Description" + } + ], + "signature": "setNote(note: string): void", + "source": "script-api", + "tags": [ + "setnote", + "returnitem.setnote" + ], + "title": "ReturnItem.setNote" + }, + { + "description": "Set a parent item. The parent item must belong to the same dw.order.Return. An infinite parent-child loop is disallowed as is a parent-child depth greater than 10. Setting a parent item indicates a dependency of the child item on the parent item, and can be used to form a parallel structure to that accessed using dw.order.ProductLineItem.getParent.", + "id": "script-api:dw/order/ReturnItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "parentItem", + "type": "ReturnItem" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setParentItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a parent item. The parent item must belong to the same\ndw.order.Return. An infinite parent-child loop is disallowed\nas is a parent-child depth greater than 10. Setting a parent item\nindicates a dependency of the child item on the parent item, and can be\nused to form a parallel structure to that accessed using\ndw.order.ProductLineItem.getParent.", + "heading": "Description" + } + ], + "signature": "setParentItem(parentItem: ReturnItem): void", + "source": "script-api", + "tags": [ + "setparentitem", + "returnitem.setparentitem" + ], + "title": "ReturnItem.setParentItem" + }, + { + "description": "Set the reason code. The list of reason codes can be updated by updating meta-data for ReturnItem.", + "id": "script-api:dw/order/ReturnItem#setReasonCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "reasonCode", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setReasonCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the reason code. The list of reason codes can be updated by updating meta-data for ReturnItem.", + "heading": "Description" + } + ], + "signature": "setReasonCode(reasonCode: string): void", + "source": "script-api", + "tags": [ + "setreasoncode", + "returnitem.setreasoncode" + ], + "title": "ReturnItem.setReasonCode" + }, + { + "description": "Set the dw.value.Quantity returned. Passing null results in an exception being thrown. The quantity must be higher than zero and not be higher than the remaining quantity to return.", + "id": "script-api:dw/order/ReturnItem#setReturnedQuantity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setReturnedQuantity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the dw.value.Quantity returned. Passing null results in an exception being thrown.\nThe quantity must be higher than zero and not be higher than the remaining quantity to return.\n\nThe item prices are recalculated in this method as described in applyPriceRate\nwith the `quantity` argument as the factor, and ordered quantity as divisor\nand `true` as the roundup parameter.", + "heading": "Description" + } + ], + "signature": "setReturnedQuantity(quantity: Quantity): void", + "source": "script-api", + "tags": [ + "setreturnedquantity", + "returnitem.setreturnedquantity" + ], + "title": "ReturnItem.setReturnedQuantity" + }, + { + "description": "Set the tax-basis price for this item.", + "id": "script-api:dw/order/ReturnItem#setTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxBasis", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setTaxBasis", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the tax-basis price for this item.", + "heading": "Description" + } + ], + "signature": "setTaxBasis(taxBasis: Money): void", + "source": "script-api", + "tags": [ + "settaxbasis", + "returnitem.settaxbasis" + ], + "title": "ReturnItem.setTaxBasis" + }, + { + "description": "Set the tax-items for this item.", + "id": "script-api:dw/order/ReturnItem#setTaxItems", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxItems", + "type": "Collection" + } + ], + "parentId": "script-api:dw/order/ReturnItem", + "qualifiedName": "dw.order.ReturnItem.setTaxItems", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the tax-items for this item.", + "heading": "Description" + } + ], + "signature": "setTaxItems(taxItems: Collection): void", + "source": "script-api", + "tags": [ + "settaxitems", + "returnitem.settaxitems" + ], + "title": "ReturnItem.setTaxItems" + }, + { + "description": "Represents an order shipment.", + "id": "script-api:dw/order/Shipment", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.Shipment", + "sections": [ + { + "body": "Represents an order shipment.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "shipment", + "dw.order.shipment", + "dw/order" + ], + "title": "Shipment" + }, + { + "description": "Returns the ID of this shipment (\"me\" for the default shipment).", + "id": "script-api:dw/order/Shipment#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.ID", + "sections": [ + { + "body": "Returns the ID of this shipment (\"me\" for the default shipment).", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "shipment.id" + ], + "title": "Shipment.ID" + }, + { + "deprecated": { + "message": "Use SHIPPING_STATUS_NOTSHIPPED instead." + }, + "description": "Shipment shipping status representing 'Not shipped'.", + "id": "script-api:dw/order/Shipment#SHIPMENT_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_NOTSHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Not shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPMENT_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipment_notshipped", + "shipment.shipment_notshipped" + ], + "title": "Shipment.SHIPMENT_NOTSHIPPED" + }, + { + "deprecated": { + "message": "Use SHIPPING_STATUS_NOTSHIPPED instead." + }, + "description": "Shipment shipping status representing 'Not shipped'.", + "id": "script-api:dw/order/Shipment#SHIPMENT_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_NOTSHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Not shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPMENT_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipment_notshipped", + "shipment.shipment_notshipped" + ], + "title": "Shipment.SHIPMENT_NOTSHIPPED" + }, + { + "deprecated": { + "message": "Use SHIPPING_STATUS_SHIPPED instead." + }, + "description": "Shipment shipping status representing 'Shipped'.", + "id": "script-api:dw/order/Shipment#SHIPMENT_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_SHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPMENT_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipment_shipped", + "shipment.shipment_shipped" + ], + "title": "Shipment.SHIPMENT_SHIPPED" + }, + { + "deprecated": { + "message": "Use SHIPPING_STATUS_SHIPPED instead." + }, + "description": "Shipment shipping status representing 'Shipped'.", + "id": "script-api:dw/order/Shipment#SHIPMENT_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPMENT_SHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPMENT_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipment_shipped", + "shipment.shipment_shipped" + ], + "title": "Shipment.SHIPMENT_SHIPPED" + }, + { + "description": "Shipment shipping status representing 'Not shipped'.", + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_NOTSHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Not shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_notshipped", + "shipment.shipping_status_notshipped" + ], + "title": "Shipment.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "description": "Shipment shipping status representing 'Not shipped'.", + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_NOTSHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_NOTSHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Not shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_NOTSHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_notshipped", + "shipment.shipping_status_notshipped" + ], + "title": "Shipment.SHIPPING_STATUS_NOTSHIPPED" + }, + { + "description": "Shipment shipping status representing 'Shipped'.", + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_SHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_shipped", + "shipment.shipping_status_shipped" + ], + "title": "Shipment.SHIPPING_STATUS_SHIPPED" + }, + { + "description": "Shipment shipping status representing 'Shipped'.", + "id": "script-api:dw/order/Shipment#SHIPPING_STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.SHIPPING_STATUS_SHIPPED", + "sections": [ + { + "body": "Shipment shipping status representing 'Shipped'.", + "heading": "Description" + } + ], + "signature": "static readonly SHIPPING_STATUS_SHIPPED: number", + "source": "script-api", + "tags": [ + "shipping_status_shipped", + "shipment.shipping_status_shipped" + ], + "title": "Shipment.SHIPPING_STATUS_SHIPPED" + }, + { + "description": "Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price represents the sum of product prices and adjustments including tax, excluding services.", + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalGrossPrice", + "sections": [ + { + "body": "Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price\nrepresents the sum of product prices and adjustments including tax, excluding services.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalgrossprice", + "shipment.adjustedmerchandizetotalgrossprice" + ], + "title": "Shipment.adjustedMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the the sum of product prices and adjustments, excluding services and tax.", + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalNetPrice", + "sections": [ + { + "body": "Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the\nthe sum of product prices and adjustments, excluding services and tax.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalnetprice", + "shipment.adjustedmerchandizetotalnetprice" + ], + "title": "Shipment.adjustedMerchandizeTotalNetPrice" + }, + { + "description": "Returns the product total price after all product discounts. If the line item container is based on net pricing the adjusted product total net price is returned. If the line item container is based on gross pricing the adjusted product total gross price is returned.", + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalPrice", + "sections": [ + { + "body": "Returns the product total price after all product discounts. If the line item container is based on net pricing\nthe adjusted product total net price is returned. If the line item container is based on gross pricing the\nadjusted product total gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalPrice: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotalprice", + "shipment.adjustedmerchandizetotalprice" + ], + "title": "Shipment.adjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the tax on products and adjustments, excluding services.", + "id": "script-api:dw/order/Shipment#adjustedMerchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedMerchandizeTotalTax", + "sections": [ + { + "body": "Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the\ntax on products and adjustments, excluding services.", + "heading": "Description" + } + ], + "signature": "readonly adjustedMerchandizeTotalTax: Money", + "source": "script-api", + "tags": [ + "adjustedmerchandizetotaltax", + "shipment.adjustedmerchandizetotaltax" + ], + "title": "Shipment.adjustedMerchandizeTotalTax" + }, + { + "description": "Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax", + "id": "script-api:dw/order/Shipment#adjustedShippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalGrossPrice", + "sections": [ + { + "body": "Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalgrossprice", + "shipment.adjustedshippingtotalgrossprice" + ], + "title": "Shipment.adjustedShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.", + "id": "script-api:dw/order/Shipment#adjustedShippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalNetPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalnetprice", + "shipment.adjustedshippingtotalnetprice" + ], + "title": "Shipment.adjustedShippingTotalNetPrice" + }, + { + "description": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.", + "id": "script-api:dw/order/Shipment#adjustedShippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalPrice", + "sections": [ + { + "body": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted\nshipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping\ntotal gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalPrice: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotalprice", + "shipment.adjustedshippingtotalprice" + ], + "title": "Shipment.adjustedShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the shipment , including shipping adjustments.", + "id": "script-api:dw/order/Shipment#adjustedShippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.adjustedShippingTotalTax", + "sections": [ + { + "body": "Returns the tax of all shipping line items of the shipment , including shipping adjustments.", + "heading": "Description" + } + ], + "signature": "readonly adjustedShippingTotalTax: Money", + "source": "script-api", + "tags": [ + "adjustedshippingtotaltax", + "shipment.adjustedshippingtotaltax" + ], + "title": "Shipment.adjustedShippingTotalTax" + }, + { + "description": "Returns all line items related to the shipment.", + "id": "script-api:dw/order/Shipment#allLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.allLineItems", + "sections": [ + { + "body": "Returns all line items related to the shipment.\n\nThe returned collection may include line items of the following types:\n\n- dw.order.ProductLineItem\n- dw.order.ShippingLineItem\n- dw.order.GiftCertificateLineItem\n- dw.order.PriceAdjustment\n\nTheir common type is dw.order.LineItem.\n\nEach dw.order.ProductLineItem in the collection may itself contain bundled or option product line items,\nas well as a product-level shipping line item.", + "heading": "Description" + } + ], + "signature": "readonly allLineItems: Collection>", + "source": "script-api", + "tags": [ + "alllineitems", + "shipment.alllineitems" + ], + "title": "Shipment.allLineItems" + }, + { + "description": "A shipment has initially no shipping address. This method creates a shipping address for the shipment and replaces an existing shipping address.", + "id": "script-api:dw/order/Shipment#createShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingAddress", + "returns": { + "type": "OrderAddress" + }, + "sections": [ + { + "body": "A shipment has initially no shipping address. This method creates a shipping address for the shipment and\nreplaces an existing shipping address.", + "heading": "Description" + } + ], + "signature": "createShippingAddress(): OrderAddress", + "source": "script-api", + "tags": [ + "createshippingaddress", + "shipment.createshippingaddress" + ], + "title": "Shipment.createShippingAddress" + }, + { + "description": "Creates a new shipping line item for this shipment. If the specified ID is already assigned to any of the existing shipping line items of the shipment, the method throws an exception.", + "id": "script-api:dw/order/Shipment#createShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingLineItem", + "returns": { + "type": "ShippingLineItem" + }, + "sections": [ + { + "body": "Creates a new shipping line item for this shipment. If the specified ID is already assigned to any of the\nexisting shipping line items of the shipment, the method throws an exception.", + "heading": "Description" + } + ], + "signature": "createShippingLineItem(id: string): ShippingLineItem", + "source": "script-api", + "tags": [ + "createshippinglineitem", + "shipment.createshippinglineitem" + ], + "title": "Shipment.createShippingLineItem" + }, + { + "deprecated": { + "message": "Deprecated in favor of dw.order.ShippingLineItem.createShippingPriceAdjustment, which\nexplicitly relates the price adjustment to a shipping line item." + }, + "description": "Creates a shipping price adjustment to be applied to the shipment. The price adjustment implicitly belongs to the standard shipping line item if this line item exists, otherwise it belongs to the shipment itself.", + "id": "script-api:dw/order/Shipment#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.createShippingPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a shipping price adjustment to be applied to the shipment. The price adjustment implicitly belongs to the\nstandard shipping line item if this line item exists, otherwise it belongs to the shipment itself.\n\nThe promotion ID is mandatory and must not be the ID of any actual promotion defined in Salesforce B2C\nCommerce.\n\nIf there already exists a shipping price adjustment line item referring to the specified promotion ID, an\nexception is thrown.", + "heading": "Description" + } + ], + "signature": "createShippingPriceAdjustment(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "createshippingpriceadjustment", + "shipment.createshippingpriceadjustment" + ], + "title": "Shipment.createShippingPriceAdjustment" + }, + { + "description": "Returns true if this is the default shipment. The default is the shipment with ID \"me\". If no shipment with ID \"me\" exists, the shipment with the lowest ID is used as the default. A \"me\" shipment can be absent if dw.order.OrderMgr.createOrder removed it for being empty, in which case another shipment becomes the default.", + "id": "script-api:dw/order/Shipment#default", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.default", + "sections": [ + { + "body": "Returns true if this is the default shipment. The default is the shipment with ID \"me\". If no shipment with\nID \"me\" exists, the shipment with the lowest ID is used as the default. A \"me\" shipment can be absent if\ndw.order.OrderMgr.createOrder removed it for being empty, in which case another\nshipment becomes the default.", + "heading": "Description" + } + ], + "signature": "readonly default: boolean", + "source": "script-api", + "tags": [ + "default", + "shipment.default" + ], + "title": "Shipment.default" + }, + { + "description": "Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price represents the sum of product prices and adjustments including tax, excluding services.", + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted total gross price, including tax, in the purchase currency. The adjusted total gross price\nrepresents the sum of product prices and adjustments including tax, excluding services.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalgrossprice", + "shipment.getadjustedmerchandizetotalgrossprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the the sum of product prices and adjustments, excluding services and tax.", + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted net price, excluding tax, in the purchase currency. The adjusted net price represents the\nthe sum of product prices and adjustments, excluding services and tax.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalnetprice", + "shipment.getadjustedmerchandizetotalnetprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalNetPrice" + }, + { + "description": "Returns the product total price after all product discounts. If the line item container is based on net pricing the adjusted product total net price is returned. If the line item container is based on gross pricing the adjusted product total gross price is returned.", + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the product total price after all product discounts. If the line item container is based on net pricing\nthe adjusted product total net price is returned. If the line item container is based on gross pricing the\nadjusted product total gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalprice", + "shipment.getadjustedmerchandizetotalprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the total product price including product-level adjustments and, optionally, prorated order-level adjustments. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "applyOrderLevelAdjustments", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total product price including product-level adjustments and, optionally, prorated order-level\nadjustments. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalPrice(applyOrderLevelAdjustments: boolean): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotalprice", + "shipment.getadjustedmerchandizetotalprice" + ], + "title": "Shipment.getAdjustedMerchandizeTotalPrice" + }, + { + "description": "Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the tax on products and adjustments, excluding services.", + "id": "script-api:dw/order/Shipment#getAdjustedMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedMerchandizeTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total adjusted product tax in the purchase currency. The total adjusted product tax represents the\ntax on products and adjustments, excluding services.", + "heading": "Description" + } + ], + "signature": "getAdjustedMerchandizeTotalTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedmerchandizetotaltax", + "shipment.getadjustedmerchandizetotaltax" + ], + "title": "Shipment.getAdjustedMerchandizeTotalTax" + }, + { + "description": "Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax", + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted sum of all shipping line items of the shipment, including shipping adjustuments and tax", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalgrossprice", + "shipment.getadjustedshippingtotalgrossprice" + ], + "title": "Shipment.getAdjustedShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.", + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, including shipping adjustments, excluding tax.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalnetprice", + "shipment.getadjustedshippingtotalnetprice" + ], + "title": "Shipment.getAdjustedShippingTotalNetPrice" + }, + { + "description": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted shipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping total gross price is returned.", + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted shipping total price. If the line item container is based on net pricing the adjusted\nshipping total net price is returned. If the line item container is based on gross pricing the adjusted shipping\ntotal gross price is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotalprice", + "shipment.getadjustedshippingtotalprice" + ], + "title": "Shipment.getAdjustedShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the shipment , including shipping adjustments.", + "id": "script-api:dw/order/Shipment#getAdjustedShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAdjustedShippingTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of all shipping line items of the shipment , including shipping adjustments.", + "heading": "Description" + } + ], + "signature": "getAdjustedShippingTotalTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedshippingtotaltax", + "shipment.getadjustedshippingtotaltax" + ], + "title": "Shipment.getAdjustedShippingTotalTax" + }, + { + "description": "Returns all line items related to the shipment.", + "id": "script-api:dw/order/Shipment#getAllLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getAllLineItems", + "returns": { + "type": "Collection>" + }, + "sections": [ + { + "body": "Returns all line items related to the shipment.\n\nThe returned collection may include line items of the following types:\n\n- dw.order.ProductLineItem\n- dw.order.ShippingLineItem\n- dw.order.GiftCertificateLineItem\n- dw.order.PriceAdjustment\n\nTheir common type is dw.order.LineItem.\n\nEach dw.order.ProductLineItem in the collection may itself contain bundled or option product line items,\nas well as a product-level shipping line item.", + "heading": "Description" + } + ], + "signature": "getAllLineItems(): Collection>", + "source": "script-api", + "tags": [ + "getalllineitems", + "shipment.getalllineitems" + ], + "title": "Shipment.getAllLineItems" + }, + { + "description": "Returns all gift certificate line items of the shipment.", + "id": "script-api:dw/order/Shipment#getGiftCertificateLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getGiftCertificateLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns all gift certificate line items of the shipment.", + "heading": "Description" + } + ], + "signature": "getGiftCertificateLineItems(): Collection", + "source": "script-api", + "tags": [ + "getgiftcertificatelineitems", + "shipment.getgiftcertificatelineitems" + ], + "title": "Shipment.getGiftCertificateLineItems" + }, + { + "description": "Returns the value set for gift message or null if no value set.", + "id": "script-api:dw/order/Shipment#getGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getGiftMessage", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the value set for gift message or null if no value set.", + "heading": "Description" + } + ], + "signature": "getGiftMessage(): string | null", + "source": "script-api", + "tags": [ + "getgiftmessage", + "shipment.getgiftmessage" + ], + "title": "Shipment.getGiftMessage" + }, + { + "description": "Returns the ID of this shipment (\"me\" for the default shipment).", + "id": "script-api:dw/order/Shipment#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this shipment (\"me\" for the default shipment).", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "shipment.getid" + ], + "title": "Shipment.getID" + }, + { + "description": "Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of product prices including tax, excluding services and adjustments.", + "id": "script-api:dw/order/Shipment#getMerchandizeTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of\nproduct prices including tax, excluding services and adjustments.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalgrossprice", + "shipment.getmerchandizetotalgrossprice" + ], + "title": "Shipment.getMerchandizeTotalGrossPrice" + }, + { + "description": "Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents the sum of product prices, excluding services, adjustments, and tax.", + "id": "script-api:dw/order/Shipment#getMerchandizeTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents\nthe sum of product prices, excluding services, adjustments, and tax.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalnetprice", + "shipment.getmerchandizetotalnetprice" + ], + "title": "Shipment.getMerchandizeTotalNetPrice" + }, + { + "description": "Returns the product total price. If the line item container is based on net pricing the product total net price is returned. If the line item container is based on gross pricing the product total gross price is returned.", + "id": "script-api:dw/order/Shipment#getMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the product total price. If the line item container is based on net pricing the product total net\nprice is returned. If the line item container is based on gross pricing the product total gross price is\nreturned.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotalprice", + "shipment.getmerchandizetotalprice" + ], + "title": "Shipment.getMerchandizeTotalPrice" + }, + { + "deprecated": { + "message": "Shipments cannot have product price adjustments, therefore this method will always return an\nempty collection" + }, + "description": "Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e. $10 Off or 10% Off).", + "id": "script-api:dw/order/Shipment#getMerchandizeTotalPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the\npurchase value (i.e. $10 Off or 10% Off).", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getmerchandizetotalpriceadjustments", + "shipment.getmerchandizetotalpriceadjustments" + ], + "title": "Shipment.getMerchandizeTotalPriceAdjustments" + }, + { + "description": "Returns the total product tax in the purchase currency. The total product tax represents the tax on products, excluding services and adjustments.", + "id": "script-api:dw/order/Shipment#getMerchandizeTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getMerchandizeTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total product tax in the purchase currency. The total product tax represents the tax on products,\nexcluding services and adjustments.", + "heading": "Description" + } + ], + "signature": "getMerchandizeTotalTax(): Money", + "source": "script-api", + "tags": [ + "getmerchandizetotaltax", + "shipment.getmerchandizetotaltax" + ], + "title": "Shipment.getMerchandizeTotalTax" + }, + { + "description": "Returns a collection of all product line items related to this shipment.", + "id": "script-api:dw/order/Shipment#getProductLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getProductLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all product line items related to this shipment.", + "heading": "Description" + } + ], + "signature": "getProductLineItems(): Collection", + "source": "script-api", + "tags": [ + "getproductlineitems", + "shipment.getproductlineitems" + ], + "title": "Shipment.getProductLineItems" + }, + { + "description": "Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/Shipment#getProratedMerchandizeTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getProratedMerchandizeTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total product price of the shipment, including product-level adjustments and prorating all\nBuy-X-Get-Y and order-level adjustments, according to the scheme described in\ndw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross\npricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "getProratedMerchandizeTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getproratedmerchandizetotalprice", + "shipment.getproratedmerchandizetotalprice" + ], + "title": "Shipment.getProratedMerchandizeTotalPrice" + }, + { + "description": "Returns the shipment number for this shipment.", + "id": "script-api:dw/order/Shipment#getShipmentNo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShipmentNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the shipment number for this shipment.\n\nWhen an order is placed (dw.order.OrderMgr.placeOrder) shipment number will be filled using a\nsequence. Before order was placed `null` will be returned.", + "heading": "Description" + } + ], + "signature": "getShipmentNo(): string | null", + "source": "script-api", + "tags": [ + "getshipmentno", + "shipment.getshipmentno" + ], + "title": "Shipment.getShipmentNo" + }, + { + "description": "Returns the shipping address or null if none is set.", + "id": "script-api:dw/order/Shipment#getShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingAddress", + "returns": { + "type": "OrderAddress | null" + }, + "sections": [ + { + "body": "Returns the shipping address or null if none is set.", + "heading": "Description" + } + ], + "signature": "getShippingAddress(): OrderAddress | null", + "source": "script-api", + "tags": [ + "getshippingaddress", + "shipment.getshippingaddress" + ], + "title": "Shipment.getShippingAddress" + }, + { + "description": "Returns the shipping line item identified by the specified ID, or null if not found.", + "id": "script-api:dw/order/Shipment#getShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingLineItem", + "returns": { + "type": "ShippingLineItem | null" + }, + "sections": [ + { + "body": "Returns the shipping line item identified by the specified ID, or null if not found.\n\nTo get the standard shipping line item for this shipment, use the identifier\ndw.order.ShippingLineItem.STANDARD_SHIPPING_ID.", + "heading": "Description" + } + ], + "signature": "getShippingLineItem(id: string): ShippingLineItem | null", + "source": "script-api", + "tags": [ + "getshippinglineitem", + "shipment.getshippinglineitem" + ], + "title": "Shipment.getShippingLineItem" + }, + { + "description": "Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with dw.order.ProductLineItems of the shipment.", + "id": "script-api:dw/order/Shipment#getShippingLineItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingLineItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that\nare associated with dw.order.ProductLineItems of the shipment.", + "heading": "Description" + } + ], + "signature": "getShippingLineItems(): Collection", + "source": "script-api", + "tags": [ + "getshippinglineitems", + "shipment.getshippinglineitems" + ], + "title": "Shipment.getShippingLineItems" + }, + { + "description": "Returns the shipping method or null if none is set.", + "id": "script-api:dw/order/Shipment#getShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingMethod", + "returns": { + "type": "ShippingMethod | null" + }, + "sections": [ + { + "body": "Returns the shipping method or null if none is set.", + "heading": "Description" + } + ], + "signature": "getShippingMethod(): ShippingMethod | null", + "source": "script-api", + "tags": [ + "getshippingmethod", + "shipment.getshippingmethod" + ], + "title": "Shipment.getShippingMethod" + }, + { + "description": "Returns the shipping method ID or null if none is set.", + "id": "script-api:dw/order/Shipment#getShippingMethodID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingMethodID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the shipping method ID or null if none is set.", + "heading": "Description" + } + ], + "signature": "getShippingMethodID(): string | null", + "source": "script-api", + "tags": [ + "getshippingmethodid", + "shipment.getshippingmethodid" + ], + "title": "Shipment.getShippingMethodID" + }, + { + "deprecated": {}, + "description": "Returns the shipping price adjustment associated with the specified promotion ID.", + "id": "script-api:dw/order/Shipment#getShippingPriceAdjustmentByPromotionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingPriceAdjustmentByPromotionID", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Returns the shipping price adjustment associated with the specified promotion ID.", + "heading": "Description" + } + ], + "signature": "getShippingPriceAdjustmentByPromotionID(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "getshippingpriceadjustmentbypromotionid", + "shipment.getshippingpriceadjustmentbypromotionid" + ], + "title": "Shipment.getShippingPriceAdjustmentByPromotionID" + }, + { + "description": "Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.", + "id": "script-api:dw/order/Shipment#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for\nexample by the promotions engine.\n\nNote that this method returns all shipping price adjustments in this shipment, regardless of which shipping line\nitem they belong to. Use dw.order.ShippingLineItem.getShippingPriceAdjustments to retrieve the shipping\nprice adjustments associated with a specific shipping line item.", + "heading": "Description" + } + ], + "signature": "getShippingPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getshippingpriceadjustments", + "shipment.getshippingpriceadjustments" + ], + "title": "Shipment.getShippingPriceAdjustments" + }, + { + "description": "Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.", + "id": "script-api:dw/order/Shipment#getShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.", + "heading": "Description" + } + ], + "signature": "getShippingStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getshippingstatus", + "shipment.getshippingstatus" + ], + "title": "Shipment.getShippingStatus" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.", + "id": "script-api:dw/order/Shipment#getShippingTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.", + "heading": "Description" + } + ], + "signature": "getShippingTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalgrossprice", + "shipment.getshippingtotalgrossprice" + ], + "title": "Shipment.getShippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.", + "id": "script-api:dw/order/Shipment#getShippingTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.", + "heading": "Description" + } + ], + "signature": "getShippingTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalnetprice", + "shipment.getshippingtotalnetprice" + ], + "title": "Shipment.getShippingTotalNetPrice" + }, + { + "description": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "id": "script-api:dw/order/Shipment#getShippingTotalPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price\nis returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "heading": "Description" + } + ], + "signature": "getShippingTotalPrice(): Money", + "source": "script-api", + "tags": [ + "getshippingtotalprice", + "shipment.getshippingtotalprice" + ], + "title": "Shipment.getShippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.", + "id": "script-api:dw/order/Shipment#getShippingTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getShippingTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "getShippingTotalTax(): Money", + "source": "script-api", + "tags": [ + "getshippingtotaltax", + "shipment.getshippingtotaltax" + ], + "title": "Shipment.getShippingTotalTax" + }, + { + "description": "Convenience method. Same as `getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)`", + "id": "script-api:dw/order/Shipment#getStandardShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getStandardShippingLineItem", + "returns": { + "type": "ShippingLineItem | null" + }, + "sections": [ + { + "body": "Convenience method. Same as `getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)`", + "heading": "Description" + } + ], + "signature": "getStandardShippingLineItem(): ShippingLineItem | null", + "source": "script-api", + "tags": [ + "getstandardshippinglineitem", + "shipment.getstandardshippinglineitem" + ], + "title": "Shipment.getStandardShippingLineItem" + }, + { + "description": "Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of product prices, service prices, adjustments, and tax.", + "id": "script-api:dw/order/Shipment#getTotalGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of\nproduct prices, service prices, adjustments, and tax.", + "heading": "Description" + } + ], + "signature": "getTotalGrossPrice(): Money", + "source": "script-api", + "tags": [ + "gettotalgrossprice", + "shipment.gettotalgrossprice" + ], + "title": "Shipment.getTotalGrossPrice" + }, + { + "description": "Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product prices, service prices, and adjustments, excluding tax.", + "id": "script-api:dw/order/Shipment#getTotalNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product\nprices, service prices, and adjustments, excluding tax.", + "heading": "Description" + } + ], + "signature": "getTotalNetPrice(): Money", + "source": "script-api", + "tags": [ + "gettotalnetprice", + "shipment.gettotalnetprice" + ], + "title": "Shipment.getTotalNetPrice" + }, + { + "description": "Returns the total tax for the shipment in the purchase currency.", + "id": "script-api:dw/order/Shipment#getTotalTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTotalTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the total tax for the shipment in the purchase currency.", + "heading": "Description" + } + ], + "signature": "getTotalTax(): Money", + "source": "script-api", + "tags": [ + "gettotaltax", + "shipment.gettotaltax" + ], + "title": "Shipment.getTotalTax" + }, + { + "description": "Returns the tracking number of this shipment.", + "id": "script-api:dw/order/Shipment#getTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.getTrackingNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tracking number of this shipment.", + "heading": "Description" + } + ], + "signature": "getTrackingNumber(): string", + "source": "script-api", + "tags": [ + "gettrackingnumber", + "shipment.gettrackingnumber" + ], + "title": "Shipment.getTrackingNumber" + }, + { + "description": "Returns true if this line item represents a gift, false otherwise.", + "id": "script-api:dw/order/Shipment#gift", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.gift", + "sections": [ + { + "body": "Returns true if this line item represents a gift, false otherwise.", + "heading": "Description" + } + ], + "signature": "gift: boolean", + "source": "script-api", + "tags": [ + "gift", + "shipment.gift" + ], + "title": "Shipment.gift" + }, + { + "description": "Returns all gift certificate line items of the shipment.", + "id": "script-api:dw/order/Shipment#giftCertificateLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.giftCertificateLineItems", + "sections": [ + { + "body": "Returns all gift certificate line items of the shipment.", + "heading": "Description" + } + ], + "signature": "readonly giftCertificateLineItems: Collection", + "source": "script-api", + "tags": [ + "giftcertificatelineitems", + "shipment.giftcertificatelineitems" + ], + "title": "Shipment.giftCertificateLineItems" + }, + { + "description": "Returns the value set for gift message or null if no value set.", + "id": "script-api:dw/order/Shipment#giftMessage", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.giftMessage", + "sections": [ + { + "body": "Returns the value set for gift message or null if no value set.", + "heading": "Description" + } + ], + "signature": "giftMessage: string | null", + "source": "script-api", + "tags": [ + "giftmessage", + "shipment.giftmessage" + ], + "title": "Shipment.giftMessage" + }, + { + "description": "Returns true if this is the default shipment. The default is the shipment with ID \"me\". If no shipment with ID \"me\" exists, the shipment with the lowest ID is used as the default. A \"me\" shipment can be absent if dw.order.OrderMgr.createOrder removed it for being empty, in which case another shipment becomes the default.", + "id": "script-api:dw/order/Shipment#isDefault", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.isDefault", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this is the default shipment. The default is the shipment with ID \"me\". If no shipment with\nID \"me\" exists, the shipment with the lowest ID is used as the default. A \"me\" shipment can be absent if\ndw.order.OrderMgr.createOrder removed it for being empty, in which case another\nshipment becomes the default.", + "heading": "Description" + } + ], + "signature": "isDefault(): boolean", + "source": "script-api", + "tags": [ + "isdefault", + "shipment.isdefault" + ], + "title": "Shipment.isDefault" + }, + { + "description": "Returns true if this line item represents a gift, false otherwise.", + "id": "script-api:dw/order/Shipment#isGift", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.isGift", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this line item represents a gift, false otherwise.", + "heading": "Description" + } + ], + "signature": "isGift(): boolean", + "source": "script-api", + "tags": [ + "isgift", + "shipment.isgift" + ], + "title": "Shipment.isGift" + }, + { + "description": "Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of product prices including tax, excluding services and adjustments.", + "id": "script-api:dw/order/Shipment#merchandizeTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalGrossPrice", + "sections": [ + { + "body": "Returns the gross product subtotal in the purchase currency. The gross product subtotal represents the sum of\nproduct prices including tax, excluding services and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalgrossprice", + "shipment.merchandizetotalgrossprice" + ], + "title": "Shipment.merchandizeTotalGrossPrice" + }, + { + "description": "Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents the sum of product prices, excluding services, adjustments, and tax.", + "id": "script-api:dw/order/Shipment#merchandizeTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalNetPrice", + "sections": [ + { + "body": "Returns the net product subtotal, excluding tax, in the purchase currency. The net product subtotal represents\nthe sum of product prices, excluding services, adjustments, and tax.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalnetprice", + "shipment.merchandizetotalnetprice" + ], + "title": "Shipment.merchandizeTotalNetPrice" + }, + { + "description": "Returns the product total price. If the line item container is based on net pricing the product total net price is returned. If the line item container is based on gross pricing the product total gross price is returned.", + "id": "script-api:dw/order/Shipment#merchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalPrice", + "sections": [ + { + "body": "Returns the product total price. If the line item container is based on net pricing the product total net\nprice is returned. If the line item container is based on gross pricing the product total gross price is\nreturned.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalPrice: Money", + "source": "script-api", + "tags": [ + "merchandizetotalprice", + "shipment.merchandizetotalprice" + ], + "title": "Shipment.merchandizeTotalPrice" + }, + { + "deprecated": { + "message": "Shipments cannot have product price adjustments, therefore this method will always return an\nempty collection" + }, + "description": "Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the purchase value (i.e. $10 Off or 10% Off).", + "id": "script-api:dw/order/Shipment#merchandizeTotalPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalPriceAdjustments", + "sections": [ + { + "body": "Returns a collection of price adjustments that have been applied to the totals, such as a promotion on the\npurchase value (i.e. $10 Off or 10% Off).", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalPriceAdjustments: Collection", + "source": "script-api", + "tags": [ + "merchandizetotalpriceadjustments", + "shipment.merchandizetotalpriceadjustments" + ], + "title": "Shipment.merchandizeTotalPriceAdjustments" + }, + { + "description": "Returns the total product tax in the purchase currency. The total product tax represents the tax on products, excluding services and adjustments.", + "id": "script-api:dw/order/Shipment#merchandizeTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.merchandizeTotalTax", + "sections": [ + { + "body": "Returns the total product tax in the purchase currency. The total product tax represents the tax on products,\nexcluding services and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly merchandizeTotalTax: Money", + "source": "script-api", + "tags": [ + "merchandizetotaltax", + "shipment.merchandizetotaltax" + ], + "title": "Shipment.merchandizeTotalTax" + }, + { + "description": "Returns a collection of all product line items related to this shipment.", + "id": "script-api:dw/order/Shipment#productLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.productLineItems", + "sections": [ + { + "body": "Returns a collection of all product line items related to this shipment.", + "heading": "Description" + } + ], + "signature": "readonly productLineItems: Collection", + "source": "script-api", + "tags": [ + "productlineitems", + "shipment.productlineitems" + ], + "title": "Shipment.productLineItems" + }, + { + "description": "Returns the total product price of the shipment, including product-level adjustments and prorating all Buy-X-Get-Y and order-level adjustments, according to the scheme described in dw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross pricing, the gross price is returned.", + "id": "script-api:dw/order/Shipment#proratedMerchandizeTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.proratedMerchandizeTotalPrice", + "sections": [ + { + "body": "Returns the total product price of the shipment, including product-level adjustments and prorating all\nBuy-X-Get-Y and order-level adjustments, according to the scheme described in\ndw.order.PriceAdjustment.getProratedPrices. For net pricing the net price is returned. For gross\npricing, the gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly proratedMerchandizeTotalPrice: Money", + "source": "script-api", + "tags": [ + "proratedmerchandizetotalprice", + "shipment.proratedmerchandizetotalprice" + ], + "title": "Shipment.proratedMerchandizeTotalPrice" + }, + { + "description": "Removes the specified shipping line item and any of its dependent shipping price adjustments.", + "id": "script-api:dw/order/Shipment#removeShippingLineItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingLineItem", + "type": "ShippingLineItem" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.removeShippingLineItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified shipping line item and any of its dependent shipping price adjustments.", + "heading": "Description" + } + ], + "signature": "removeShippingLineItem(shippingLineItem: ShippingLineItem): void", + "source": "script-api", + "tags": [ + "removeshippinglineitem", + "shipment.removeshippinglineitem" + ], + "title": "Shipment.removeShippingLineItem" + }, + { + "deprecated": { + "message": "Deprecated in favor of\ndw.order.ShippingLineItem.removeShippingPriceAdjustment since shipping price\nadjustments belong to a specific shipping line item." + }, + "description": "Removes the specified shipping price adjustment from the shipment.", + "id": "script-api:dw/order/Shipment#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustment", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.removeShippingPriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified shipping price adjustment from the shipment.", + "heading": "Description" + } + ], + "signature": "removeShippingPriceAdjustment(priceAdjustment: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "removeshippingpriceadjustment", + "shipment.removeshippingpriceadjustment" + ], + "title": "Shipment.removeShippingPriceAdjustment" + }, + { + "description": "Controls if this line item is a gift or not.", + "id": "script-api:dw/order/Shipment#setGift", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "isGift", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setGift", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Controls if this line item is a gift or not.", + "heading": "Description" + } + ], + "signature": "setGift(isGift: boolean): void", + "source": "script-api", + "tags": [ + "setgift", + "shipment.setgift" + ], + "title": "Shipment.setGift" + }, + { + "description": "Sets the value to set for the gift message.", + "id": "script-api:dw/order/Shipment#setGiftMessage", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setGiftMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the value to set for the gift message.", + "heading": "Description" + } + ], + "signature": "setGiftMessage(message: string): void", + "source": "script-api", + "tags": [ + "setgiftmessage", + "shipment.setgiftmessage" + ], + "title": "Shipment.setGiftMessage" + }, + { + "description": "Set the specified shipping method for the specified shipment.", + "id": "script-api:dw/order/Shipment#setShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "method", + "type": "ShippingMethod" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setShippingMethod", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the specified shipping method for the specified shipment.", + "heading": "Description" + } + ], + "signature": "setShippingMethod(method: ShippingMethod): void", + "source": "script-api", + "tags": [ + "setshippingmethod", + "shipment.setshippingmethod" + ], + "title": "Shipment.setShippingMethod" + }, + { + "description": "Sets the shipping status of the shipment.", + "id": "script-api:dw/order/Shipment#setShippingStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setShippingStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping status of the shipment.\n\nPossible values are SHIPPING_STATUS_NOTSHIPPED or SHIPPING_STATUS_SHIPPED.", + "heading": "Description" + } + ], + "signature": "setShippingStatus(status: number): void", + "source": "script-api", + "tags": [ + "setshippingstatus", + "shipment.setshippingstatus" + ], + "title": "Shipment.setShippingStatus" + }, + { + "description": "Sets the tracking number of this shipment.", + "id": "script-api:dw/order/Shipment#setTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.setTrackingNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tracking number of this shipment.", + "heading": "Description" + } + ], + "signature": "setTrackingNumber(aValue: string): void", + "source": "script-api", + "tags": [ + "settrackingnumber", + "shipment.settrackingnumber" + ], + "title": "Shipment.setTrackingNumber" + }, + { + "description": "Returns the shipment number for this shipment.", + "id": "script-api:dw/order/Shipment#shipmentNo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shipmentNo", + "sections": [ + { + "body": "Returns the shipment number for this shipment.\n\nWhen an order is placed (dw.order.OrderMgr.placeOrder) shipment number will be filled using a\nsequence. Before order was placed `null` will be returned.", + "heading": "Description" + } + ], + "signature": "readonly shipmentNo: string | null", + "source": "script-api", + "tags": [ + "shipmentno", + "shipment.shipmentno" + ], + "title": "Shipment.shipmentNo" + }, + { + "description": "Returns the shipping address or null if none is set.", + "id": "script-api:dw/order/Shipment#shippingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingAddress", + "sections": [ + { + "body": "Returns the shipping address or null if none is set.", + "heading": "Description" + } + ], + "signature": "readonly shippingAddress: OrderAddress | null", + "source": "script-api", + "tags": [ + "shippingaddress", + "shipment.shippingaddress" + ], + "title": "Shipment.shippingAddress" + }, + { + "description": "Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that are associated with dw.order.ProductLineItems of the shipment.", + "id": "script-api:dw/order/Shipment#shippingLineItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingLineItems", + "sections": [ + { + "body": "Returns a collection of all shipping line items of the shipment, excluding any product-level shipping costs that\nare associated with dw.order.ProductLineItems of the shipment.", + "heading": "Description" + } + ], + "signature": "readonly shippingLineItems: Collection", + "source": "script-api", + "tags": [ + "shippinglineitems", + "shipment.shippinglineitems" + ], + "title": "Shipment.shippingLineItems" + }, + { + "description": "Returns the shipping method or null if none is set.", + "id": "script-api:dw/order/Shipment#shippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingMethod", + "sections": [ + { + "body": "Returns the shipping method or null if none is set.", + "heading": "Description" + } + ], + "signature": "shippingMethod: ShippingMethod | null", + "source": "script-api", + "tags": [ + "shippingmethod", + "shipment.shippingmethod" + ], + "title": "Shipment.shippingMethod" + }, + { + "description": "Returns the shipping method ID or null if none is set.", + "id": "script-api:dw/order/Shipment#shippingMethodID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingMethodID", + "sections": [ + { + "body": "Returns the shipping method ID or null if none is set.", + "heading": "Description" + } + ], + "signature": "readonly shippingMethodID: string | null", + "source": "script-api", + "tags": [ + "shippingmethodid", + "shipment.shippingmethodid" + ], + "title": "Shipment.shippingMethodID" + }, + { + "description": "Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for example by the promotions engine.", + "id": "script-api:dw/order/Shipment#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingPriceAdjustments", + "sections": [ + { + "body": "Returns a collection of price adjustments that have been applied to the shipping costs of the shipment, for\nexample by the promotions engine.\n\nNote that this method returns all shipping price adjustments in this shipment, regardless of which shipping line\nitem they belong to. Use dw.order.ShippingLineItem.getShippingPriceAdjustments to retrieve the shipping\nprice adjustments associated with a specific shipping line item.", + "heading": "Description" + } + ], + "signature": "readonly shippingPriceAdjustments: Collection", + "source": "script-api", + "tags": [ + "shippingpriceadjustments", + "shipment.shippingpriceadjustments" + ], + "title": "Shipment.shippingPriceAdjustments" + }, + { + "description": "Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.", + "id": "script-api:dw/order/Shipment#shippingStatus", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingStatus", + "sections": [ + { + "body": "Returns the shipping status. Possible values are SHIPMENT_NOTSHIPPED or SHIPMENT_SHIPPED.", + "heading": "Description" + } + ], + "signature": "shippingStatus: EnumValue", + "source": "script-api", + "tags": [ + "shippingstatus", + "shipment.shippingstatus" + ], + "title": "Shipment.shippingStatus" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.", + "id": "script-api:dw/order/Shipment#shippingTotalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalGrossPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, including tax, excluding shipping adjustments.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalGrossPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalgrossprice", + "shipment.shippingtotalgrossprice" + ], + "title": "Shipment.shippingTotalGrossPrice" + }, + { + "description": "Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.", + "id": "script-api:dw/order/Shipment#shippingTotalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalNetPrice", + "sections": [ + { + "body": "Returns the sum of all shipping line items of the shipment, excluding tax and adjustments.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalNetPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalnetprice", + "shipment.shippingtotalnetprice" + ], + "title": "Shipment.shippingTotalNetPrice" + }, + { + "description": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price is returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "id": "script-api:dw/order/Shipment#shippingTotalPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalPrice", + "sections": [ + { + "body": "Returns the shipping total price. If the line item container is based on net pricing the shipping total net price\nis returned. If the line item container is based on gross pricing the shipping total gross price is returned.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalPrice: Money", + "source": "script-api", + "tags": [ + "shippingtotalprice", + "shipment.shippingtotalprice" + ], + "title": "Shipment.shippingTotalPrice" + }, + { + "description": "Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.", + "id": "script-api:dw/order/Shipment#shippingTotalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.shippingTotalTax", + "sections": [ + { + "body": "Returns the tax of all shipping line items of the shipment before shipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "readonly shippingTotalTax: Money", + "source": "script-api", + "tags": [ + "shippingtotaltax", + "shipment.shippingtotaltax" + ], + "title": "Shipment.shippingTotalTax" + }, + { + "description": "Convenience method. Same as `getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)`", + "id": "script-api:dw/order/Shipment#standardShippingLineItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.standardShippingLineItem", + "sections": [ + { + "body": "Convenience method. Same as `getShippingLineItem(ShippingLineItem.STANDARD_SHIPPING_ID)`", + "heading": "Description" + } + ], + "signature": "readonly standardShippingLineItem: ShippingLineItem | null", + "source": "script-api", + "tags": [ + "standardshippinglineitem", + "shipment.standardshippinglineitem" + ], + "title": "Shipment.standardShippingLineItem" + }, + { + "description": "Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of product prices, service prices, adjustments, and tax.", + "id": "script-api:dw/order/Shipment#totalGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalGrossPrice", + "sections": [ + { + "body": "Returns the total gross price of the shipment in the purchase currency. The total gross price is the sum of\nproduct prices, service prices, adjustments, and tax.", + "heading": "Description" + } + ], + "signature": "readonly totalGrossPrice: Money", + "source": "script-api", + "tags": [ + "totalgrossprice", + "shipment.totalgrossprice" + ], + "title": "Shipment.totalGrossPrice" + }, + { + "description": "Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product prices, service prices, and adjustments, excluding tax.", + "id": "script-api:dw/order/Shipment#totalNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalNetPrice", + "sections": [ + { + "body": "Returns the total net price of the shipment in the purchase currency. The total net price is the sum of product\nprices, service prices, and adjustments, excluding tax.", + "heading": "Description" + } + ], + "signature": "readonly totalNetPrice: Money", + "source": "script-api", + "tags": [ + "totalnetprice", + "shipment.totalnetprice" + ], + "title": "Shipment.totalNetPrice" + }, + { + "description": "Returns the total tax for the shipment in the purchase currency.", + "id": "script-api:dw/order/Shipment#totalTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.totalTax", + "sections": [ + { + "body": "Returns the total tax for the shipment in the purchase currency.", + "heading": "Description" + } + ], + "signature": "readonly totalTax: Money", + "source": "script-api", + "tags": [ + "totaltax", + "shipment.totaltax" + ], + "title": "Shipment.totalTax" + }, + { + "description": "Returns the tracking number of this shipment.", + "id": "script-api:dw/order/Shipment#trackingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/Shipment", + "qualifiedName": "dw.order.Shipment.trackingNumber", + "sections": [ + { + "body": "Returns the tracking number of this shipment.", + "heading": "Description" + } + ], + "signature": "trackingNumber: string", + "source": "script-api", + "tags": [ + "trackingnumber", + "shipment.trackingnumber" + ], + "title": "Shipment.trackingNumber" + }, + { + "description": "Represents shipping cost applied to shipments.", + "id": "script-api:dw/order/ShipmentShippingCost", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShipmentShippingCost", + "sections": [ + { + "body": "Represents shipping cost applied to shipments.\n\nReturned by\ndw.order.ShipmentShippingModel.getShippingCost.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shipmentshippingcost", + "dw.order.shipmentshippingcost", + "dw/order" + ], + "title": "ShipmentShippingCost" + }, + { + "description": "Returns the shipping amount.", + "id": "script-api:dw/order/ShipmentShippingCost#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingCost", + "qualifiedName": "dw.order.ShipmentShippingCost.amount", + "sections": [ + { + "body": "Returns the shipping amount.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "shipmentshippingcost.amount" + ], + "title": "ShipmentShippingCost.amount" + }, + { + "description": "Returns the shipping amount.", + "id": "script-api:dw/order/ShipmentShippingCost#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingCost", + "qualifiedName": "dw.order.ShipmentShippingCost.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping amount.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "shipmentshippingcost.getamount" + ], + "title": "ShipmentShippingCost.getAmount" + }, + { + "description": "Instances of ShipmentShippingModel provide access to shipment-level shipping information, such as applicable and inapplicable shipping methods and shipping cost.", + "id": "script-api:dw/order/ShipmentShippingModel", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShipmentShippingModel", + "sections": [ + { + "body": "Instances of ShipmentShippingModel provide access to shipment-level\nshipping information, such as applicable and inapplicable shipping methods\nand shipping cost.\n\nUse dw.order.ShippingMgr.getShipmentShippingModel to get\nthe shipping model for a specific shipment.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shipmentshippingmodel", + "dw.order.shipmentshippingmodel", + "dw/order" + ], + "title": "ShipmentShippingModel" + }, + { + "description": "Returns the active applicable shipping methods for the shipment related to this shipping model. A shipping method is applicable for a shipment if it does not exclude any of the products in the shipment, and does not exclude the shipment's shipping address, if this is set. Also checks that the the shipment customer belongs to an assigned customer group of the shipment (if any are assigned).", + "id": "script-api:dw/order/ShipmentShippingModel#applicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.applicableShippingMethods", + "sections": [ + { + "body": "Returns the active applicable shipping methods for the shipment related\nto this shipping model. A shipping method is applicable for a shipment\nif it does not exclude any of the products in the shipment, and does\nnot exclude the shipment's shipping address, if this is set. Also checks\nthat the the shipment customer belongs to an assigned customer group of the shipment\n(if any are assigned).", + "heading": "Description" + } + ], + "signature": "readonly applicableShippingMethods: Collection", + "source": "script-api", + "tags": [ + "applicableshippingmethods", + "shipmentshippingmodel.applicableshippingmethods" + ], + "title": "ShipmentShippingModel.applicableShippingMethods" + }, + { + "description": "Returns the active applicable shipping methods for the shipment related to this shipping model. A shipping method is applicable for a shipment if it does not exclude any of the products in the shipment, and does not exclude the shipment's shipping address, if this is set. Also checks that the the shipment customer belongs to an assigned customer group of the shipment (if any are assigned).", + "id": "script-api:dw/order/ShipmentShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getApplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active applicable shipping methods for the shipment related\nto this shipping model. A shipping method is applicable for a shipment\nif it does not exclude any of the products in the shipment, and does\nnot exclude the shipment's shipping address, if this is set. Also checks\nthat the the shipment customer belongs to an assigned customer group of the shipment\n(if any are assigned).", + "heading": "Description" + } + ], + "signature": "getApplicableShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getapplicableshippingmethods", + "shipmentshippingmodel.getapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getApplicableShippingMethods" + }, + { + "description": "Returns the active applicable shipping methods for the shipment related to this shipping model and the specified shipping address. A shipping method is applicable if it does not exclude any of the products in the shipment, it does not exclude the specified shipping address, and the shipment customer belongs to an assigned customer group for the shipment (if any are assigned).", + "examples": [ + "model.getApplicableShippingMethods (\n{ countryCode: \"US\",\nstateCode: \"MA,\ncustom { POBox : true }\n}\n)" + ], + "id": "script-api:dw/order/ShipmentShippingModel#getApplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingAddressObj", + "type": "any" + } + ], + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getApplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active applicable shipping methods for the shipment related\nto this shipping model and the specified shipping address. A shipping\nmethod is applicable if it does not exclude any of the products in the\nshipment, it does not exclude the specified shipping address, and the\nshipment customer belongs to an assigned customer group for the shipment (if\nany are assigned).\n\nThe parameter shippingAddressObj must be a JavaScript literal with the\nsame properties as an OrderAddress object, or alternatively a Map.\nFor example:\n\n\nThis method is useful when it is needed to retrieve the list of\napplicable shipping methods for an address before the address is saved to\nthe shipment.", + "heading": "Description" + } + ], + "signature": "getApplicableShippingMethods(shippingAddressObj: any): Collection", + "source": "script-api", + "tags": [ + "getapplicableshippingmethods", + "shipmentshippingmodel.getapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getApplicableShippingMethods" + }, + { + "description": "Returns the active inapplicable shipping methods for the shipment related to this shipping model. A shipping method is inapplicable for a shipment if it is inapplicable for at least one product contained in the shipment, or the shipping address is excluded by the shipping method, or the shipping method is restricted to customer groups that the shipment customer is not a part of.", + "id": "script-api:dw/order/ShipmentShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getInapplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active inapplicable shipping methods for the shipment related\nto this shipping model. A shipping method is inapplicable for a shipment\nif it is inapplicable for at least one product contained in the\nshipment, or the shipping address is excluded by the shipping method, or the\nshipping method is restricted to customer groups that the shipment customer\nis not a part of.", + "heading": "Description" + } + ], + "signature": "getInapplicableShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getinapplicableshippingmethods", + "shipmentshippingmodel.getinapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getInapplicableShippingMethods" + }, + { + "description": "Returns the active inapplicable shipping methods for the shipment related to this shipping model and the specified shipping address. A shipping method is inapplicable if it is inapplicable for at least one product contained in the shipment, or the specified shipping address is excluded by the shipping method, or the shipping method is restricted to customer groups that the shipment customer is not a part of.", + "examples": [ + "model.getApplicableShippingMethods (\n{ countryCode: \"US\",\nstateCode: \"MA,\ncustom { POBox : true }\n}\n)" + ], + "id": "script-api:dw/order/ShipmentShippingModel#getInapplicableShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingAddressObj", + "type": "any" + } + ], + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getInapplicableShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active inapplicable shipping methods for the shipment related\nto this shipping model and the specified shipping address. A shipping\nmethod is inapplicable if it is inapplicable for at least one product\ncontained in the shipment, or the specified shipping address is excluded\nby the shipping method, or the shipping method is restricted to customer\ngroups that the shipment customer is not a part of.\n\nThe parameter shippingAddressObj must be a JavaScript literal with the\nsame properties as an OrderAddress object, or alternatively a Map.\nFor example:\n\n\nThis method is useful when it is needed to retrieve the list of\napplicable shipping methods for an address before the address is saved to\nthe shipment.", + "heading": "Description" + } + ], + "signature": "getInapplicableShippingMethods(shippingAddressObj: any): Collection", + "source": "script-api", + "tags": [ + "getinapplicableshippingmethods", + "shipmentshippingmodel.getinapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.getInapplicableShippingMethods" + }, + { + "description": "Returns the shipping cost object for the related shipment and the specified shipping method. Shipping cost for shipments depended on the merchandise total of the shipment. The method uses the adjusted merchandise total after product and order discounts, and excluding products with product-level fixed-price shipping cost.", + "id": "script-api:dw/order/ShipmentShippingModel#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingMethod", + "type": "ShippingMethod" + } + ], + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.getShippingCost", + "returns": { + "type": "ShipmentShippingCost" + }, + "sections": [ + { + "body": "Returns the shipping cost object for the related shipment and\nthe specified shipping method. Shipping cost for shipments\ndepended on the merchandise total of the shipment. The method\nuses the adjusted merchandise total after product and order discounts,\nand excluding products with product-level fixed-price shipping\ncost.", + "heading": "Description" + } + ], + "signature": "getShippingCost(shippingMethod: ShippingMethod): ShipmentShippingCost", + "source": "script-api", + "tags": [ + "getshippingcost", + "shipmentshippingmodel.getshippingcost" + ], + "title": "ShipmentShippingModel.getShippingCost" + }, + { + "description": "Returns the active inapplicable shipping methods for the shipment related to this shipping model. A shipping method is inapplicable for a shipment if it is inapplicable for at least one product contained in the shipment, or the shipping address is excluded by the shipping method, or the shipping method is restricted to customer groups that the shipment customer is not a part of.", + "id": "script-api:dw/order/ShipmentShippingModel#inapplicableShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShipmentShippingModel", + "qualifiedName": "dw.order.ShipmentShippingModel.inapplicableShippingMethods", + "sections": [ + { + "body": "Returns the active inapplicable shipping methods for the shipment related\nto this shipping model. A shipping method is inapplicable for a shipment\nif it is inapplicable for at least one product contained in the\nshipment, or the shipping address is excluded by the shipping method, or the\nshipping method is restricted to customer groups that the shipment customer\nis not a part of.", + "heading": "Description" + } + ], + "signature": "readonly inapplicableShippingMethods: Collection", + "source": "script-api", + "tags": [ + "inapplicableshippingmethods", + "shipmentshippingmodel.inapplicableshippingmethods" + ], + "title": "ShipmentShippingModel.inapplicableShippingMethods" + }, + { + "description": "Represents a specific line item in a shipment. The ShippingLineItem defines the general shipping costs of a shipment.", + "id": "script-api:dw/order/ShippingLineItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingLineItem", + "sections": [ + { + "body": "Represents a specific line item in a shipment. The ShippingLineItem defines\nthe general shipping costs of a shipment.", + "heading": "Description" + }, + { + "body": "Extends `LineItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "shippinglineitem", + "dw.order.shippinglineitem", + "dw/order" + ], + "title": "ShippingLineItem" + }, + { + "description": "Returns the ID of this ShippingLineItem.", + "id": "script-api:dw/order/ShippingLineItem#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.ID", + "sections": [ + { + "body": "Returns the ID of this ShippingLineItem.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "shippinglineitem.id" + ], + "title": "ShippingLineItem.ID" + }, + { + "description": "Constant used to get the standard shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#STANDARD_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.STANDARD_SHIPPING_ID", + "sections": [ + { + "body": "Constant used to get the standard shipping line item.", + "heading": "Description" + } + ], + "signature": "static readonly STANDARD_SHIPPING_ID = \"STANDARD_SHIPPING\"", + "source": "script-api", + "tags": [ + "standard_shipping_id", + "shippinglineitem.standard_shipping_id" + ], + "title": "ShippingLineItem.STANDARD_SHIPPING_ID" + }, + { + "description": "Constant used to get the standard shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#STANDARD_SHIPPING_ID", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.STANDARD_SHIPPING_ID", + "sections": [ + { + "body": "Constant used to get the standard shipping line item.", + "heading": "Description" + } + ], + "signature": "static readonly STANDARD_SHIPPING_ID = \"STANDARD_SHIPPING\"", + "source": "script-api", + "tags": [ + "standard_shipping_id", + "shippinglineitem.standard_shipping_id" + ], + "title": "ShippingLineItem.STANDARD_SHIPPING_ID" + }, + { + "description": "Returns the price of this shipping line item including tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#adjustedGrossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedGrossPrice", + "sections": [ + { + "body": "Returns the price of this shipping line item including tax after\nshipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedGrossPrice: Money", + "source": "script-api", + "tags": [ + "adjustedgrossprice", + "shippinglineitem.adjustedgrossprice" + ], + "title": "ShippingLineItem.adjustedGrossPrice" + }, + { + "description": "Returns the price of this shipping line item, excluding tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#adjustedNetPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedNetPrice", + "sections": [ + { + "body": "Returns the price of this shipping line item, excluding tax after\nshipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedNetPrice: Money", + "source": "script-api", + "tags": [ + "adjustednetprice", + "shippinglineitem.adjustednetprice" + ], + "title": "ShippingLineItem.adjustedNetPrice" + }, + { + "description": "Returns the adjusted price of this shipping line item. If the line item container is based on net pricing, the adjusted net price is returned. If the line item container is based on gross pricing, the adjusted gross price is returned.", + "id": "script-api:dw/order/ShippingLineItem#adjustedPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedPrice", + "sections": [ + { + "body": "Returns the adjusted price of this shipping line item. If the line item\ncontainer is based on net pricing, the adjusted net price is returned. If\nthe line item container is based on gross pricing, the adjusted gross\nprice is returned.", + "heading": "Description" + } + ], + "signature": "readonly adjustedPrice: Money", + "source": "script-api", + "tags": [ + "adjustedprice", + "shippinglineitem.adjustedprice" + ], + "title": "ShippingLineItem.adjustedPrice" + }, + { + "description": "Returns the tax of this shipping line item after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#adjustedTax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.adjustedTax", + "sections": [ + { + "body": "Returns the tax of this shipping line item after shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "readonly adjustedTax: Money", + "source": "script-api", + "tags": [ + "adjustedtax", + "shippinglineitem.adjustedtax" + ], + "title": "ShippingLineItem.adjustedTax" + }, + { + "description": "Creates a shipping price adjustment to be applied to the shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.createShippingPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a shipping price adjustment to be applied to the shipping line item.\n\nThe promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce.\n\nIf there already exists a shipping price adjustment on this shipping line item referring to the specified\npromotion ID, an exception is thrown.", + "heading": "Description" + } + ], + "signature": "createShippingPriceAdjustment(promotionID: string): PriceAdjustment", + "source": "script-api", + "tags": [ + "createshippingpriceadjustment", + "shippinglineitem.createshippingpriceadjustment" + ], + "title": "ShippingLineItem.createShippingPriceAdjustment" + }, + { + "description": "Creates a shipping price adjustment to be applied to the shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#createShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "promotionID", + "type": "string" + }, + { + "name": "discount", + "type": "Discount" + } + ], + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.createShippingPriceAdjustment", + "returns": { + "type": "PriceAdjustment" + }, + "sections": [ + { + "body": "Creates a shipping price adjustment to be applied to the shipping line item.\n\nThe promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce. If a\nshipping price adjustment on this shipping line item referring to the specified promotion ID already exists, an\nexception is thrown.\n\nThe possible values for discount are dw.campaign.PercentageDiscount, dw.campaign.AmountDiscount,\ndw.campaign.FixedPriceShippingDiscount.\n\nExamples:\n\n`\nvar myShippingItem : dw.order.ShippingLineItem; // assume known\n\nvar paFixedShippingPrice12 : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment(\"myPromotionID1\", new FixedPriceShippingDiscount(12));\n\nvar paTenPercent : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment(\"myPromotionID2\", new PercentageDiscount(10));\n\nvar paReduceBy2 : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment(\"myPromotionID3\", new AmountDiscount(2));\n\n`", + "heading": "Description" + } + ], + "signature": "createShippingPriceAdjustment(promotionID: string, discount: Discount): PriceAdjustment", + "source": "script-api", + "tags": [ + "createshippingpriceadjustment", + "shippinglineitem.createshippingpriceadjustment" + ], + "title": "ShippingLineItem.createShippingPriceAdjustment" + }, + { + "description": "Returns the price of this shipping line item including tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#getAdjustedGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of this shipping line item including tax after\nshipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "getAdjustedGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedgrossprice", + "shippinglineitem.getadjustedgrossprice" + ], + "title": "ShippingLineItem.getAdjustedGrossPrice" + }, + { + "description": "Returns the price of this shipping line item, excluding tax after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#getAdjustedNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the price of this shipping line item, excluding tax after\nshipping adjustments have been applied.", + "heading": "Description" + } + ], + "signature": "getAdjustedNetPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustednetprice", + "shippinglineitem.getadjustednetprice" + ], + "title": "ShippingLineItem.getAdjustedNetPrice" + }, + { + "description": "Returns the adjusted price of this shipping line item. If the line item container is based on net pricing, the adjusted net price is returned. If the line item container is based on gross pricing, the adjusted gross price is returned.", + "id": "script-api:dw/order/ShippingLineItem#getAdjustedPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the adjusted price of this shipping line item. If the line item\ncontainer is based on net pricing, the adjusted net price is returned. If\nthe line item container is based on gross pricing, the adjusted gross\nprice is returned.", + "heading": "Description" + } + ], + "signature": "getAdjustedPrice(): Money", + "source": "script-api", + "tags": [ + "getadjustedprice", + "shippinglineitem.getadjustedprice" + ], + "title": "ShippingLineItem.getAdjustedPrice" + }, + { + "description": "Returns the tax of this shipping line item after shipping adjustments have been applied.", + "id": "script-api:dw/order/ShippingLineItem#getAdjustedTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getAdjustedTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the tax of this shipping line item after shipping adjustments\nhave been applied.", + "heading": "Description" + } + ], + "signature": "getAdjustedTax(): Money", + "source": "script-api", + "tags": [ + "getadjustedtax", + "shippinglineitem.getadjustedtax" + ], + "title": "ShippingLineItem.getAdjustedTax" + }, + { + "description": "Returns the ID of this ShippingLineItem.", + "id": "script-api:dw/order/ShippingLineItem#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of this ShippingLineItem.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "shippinglineitem.getid" + ], + "title": "ShippingLineItem.getID" + }, + { + "description": "Returns the dw.order.OrderItem order-item extension for this item, or `null`. An order-item extension will only exist for a ShippingLineItem which belongs to an dw.order.Order.", + "id": "script-api:dw/order/ShippingLineItem#getOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getOrderItem", + "returns": { + "type": "OrderItem | null" + }, + "sections": [ + { + "body": "Returns the dw.order.OrderItem order-item extension for this item, or `null`.\nAn order-item extension will only exist for a ShippingLineItem which\nbelongs to an dw.order.Order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "getOrderItem(): OrderItem | null", + "source": "script-api", + "tags": [ + "getorderitem", + "shippinglineitem.getorderitem" + ], + "title": "ShippingLineItem.getOrderItem" + }, + { + "description": "Returns the collection of shipping price adjustments that have been applied to this shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#getShippingPriceAdjustments", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.getShippingPriceAdjustments", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the collection of shipping price adjustments that have been\napplied to this shipping line item.", + "heading": "Description" + } + ], + "signature": "getShippingPriceAdjustments(): Collection", + "source": "script-api", + "tags": [ + "getshippingpriceadjustments", + "shippinglineitem.getshippingpriceadjustments" + ], + "title": "ShippingLineItem.getShippingPriceAdjustments" + }, + { + "description": "Returns the dw.order.OrderItem order-item extension for this item, or `null`. An order-item extension will only exist for a ShippingLineItem which belongs to an dw.order.Order.", + "id": "script-api:dw/order/ShippingLineItem#orderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.orderItem", + "sections": [ + { + "body": "Returns the dw.order.OrderItem order-item extension for this item, or `null`.\nAn order-item extension will only exist for a ShippingLineItem which\nbelongs to an dw.order.Order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "signature": "readonly orderItem: OrderItem | null", + "source": "script-api", + "tags": [ + "orderitem", + "shippinglineitem.orderitem" + ], + "title": "ShippingLineItem.orderItem" + }, + { + "description": "Removes the specified shipping price adjustment from this shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#removeShippingPriceAdjustment", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "priceAdjustment", + "type": "PriceAdjustment" + } + ], + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.removeShippingPriceAdjustment", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the specified shipping price adjustment from this shipping line\nitem.", + "heading": "Description" + } + ], + "signature": "removeShippingPriceAdjustment(priceAdjustment: PriceAdjustment): void", + "source": "script-api", + "tags": [ + "removeshippingpriceadjustment", + "shippinglineitem.removeshippingpriceadjustment" + ], + "title": "ShippingLineItem.removeShippingPriceAdjustment" + }, + { + "description": "Returns the collection of shipping price adjustments that have been applied to this shipping line item.", + "id": "script-api:dw/order/ShippingLineItem#shippingPriceAdjustments", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLineItem", + "qualifiedName": "dw.order.ShippingLineItem.shippingPriceAdjustments", + "sections": [ + { + "body": "Returns the collection of shipping price adjustments that have been\napplied to this shipping line item.", + "heading": "Description" + } + ], + "signature": "readonly shippingPriceAdjustments: Collection", + "source": "script-api", + "tags": [ + "shippingpriceadjustments", + "shippinglineitem.shippingpriceadjustments" + ], + "title": "ShippingLineItem.shippingPriceAdjustments" + }, + { + "description": "Represents a specific location for a shipment.", + "id": "script-api:dw/order/ShippingLocation", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingLocation", + "sections": [ + { + "body": "Represents a specific location for a shipment.\n\nNote: this class allows access to sensitive personal and private information.\nPay attention to appropriate legal and regulatory requirements related to this data.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shippinglocation", + "dw.order.shippinglocation", + "dw/order" + ], + "title": "ShippingLocation" + }, + { + "description": "Returns the shipping location's first address.", + "id": "script-api:dw/order/ShippingLocation#address1", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.address1", + "sections": [ + { + "body": "Returns the shipping location's first address.", + "heading": "Description" + } + ], + "signature": "address1: string", + "source": "script-api", + "tags": [ + "address1", + "shippinglocation.address1" + ], + "title": "ShippingLocation.address1" + }, + { + "description": "Returns the shipping location's second address.", + "id": "script-api:dw/order/ShippingLocation#address2", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.address2", + "sections": [ + { + "body": "Returns the shipping location's second address.", + "heading": "Description" + } + ], + "signature": "address2: string", + "source": "script-api", + "tags": [ + "address2", + "shippinglocation.address2" + ], + "title": "ShippingLocation.address2" + }, + { + "description": "Returns the shipping location's city.", + "id": "script-api:dw/order/ShippingLocation#city", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.city", + "sections": [ + { + "body": "Returns the shipping location's city.", + "heading": "Description" + } + ], + "signature": "city: string", + "source": "script-api", + "tags": [ + "city", + "shippinglocation.city" + ], + "title": "ShippingLocation.city" + }, + { + "description": "Returns the shipping location's country code.", + "id": "script-api:dw/order/ShippingLocation#countryCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.countryCode", + "sections": [ + { + "body": "Returns the shipping location's country code.", + "heading": "Description" + } + ], + "signature": "countryCode: string", + "source": "script-api", + "tags": [ + "countrycode", + "shippinglocation.countrycode" + ], + "title": "ShippingLocation.countryCode" + }, + { + "description": "Returns the shipping location's first address.", + "id": "script-api:dw/order/ShippingLocation#getAddress1", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getAddress1", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's first address.", + "heading": "Description" + } + ], + "signature": "getAddress1(): string", + "source": "script-api", + "tags": [ + "getaddress1", + "shippinglocation.getaddress1" + ], + "title": "ShippingLocation.getAddress1" + }, + { + "description": "Returns the shipping location's second address.", + "id": "script-api:dw/order/ShippingLocation#getAddress2", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getAddress2", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's second address.", + "heading": "Description" + } + ], + "signature": "getAddress2(): string", + "source": "script-api", + "tags": [ + "getaddress2", + "shippinglocation.getaddress2" + ], + "title": "ShippingLocation.getAddress2" + }, + { + "description": "Returns the shipping location's city.", + "id": "script-api:dw/order/ShippingLocation#getCity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's city.", + "heading": "Description" + } + ], + "signature": "getCity(): string", + "source": "script-api", + "tags": [ + "getcity", + "shippinglocation.getcity" + ], + "title": "ShippingLocation.getCity" + }, + { + "description": "Returns the shipping location's country code.", + "id": "script-api:dw/order/ShippingLocation#getCountryCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getCountryCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's country code.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): string", + "source": "script-api", + "tags": [ + "getcountrycode", + "shippinglocation.getcountrycode" + ], + "title": "ShippingLocation.getCountryCode" + }, + { + "description": "Returns the shipping location's post box.", + "id": "script-api:dw/order/ShippingLocation#getPostBox", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getPostBox", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's post box.", + "heading": "Description" + } + ], + "signature": "getPostBox(): string", + "source": "script-api", + "tags": [ + "getpostbox", + "shippinglocation.getpostbox" + ], + "title": "ShippingLocation.getPostBox" + }, + { + "description": "Returns the shipping location's postal code.", + "id": "script-api:dw/order/ShippingLocation#getPostalCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's postal code.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "shippinglocation.getpostalcode" + ], + "title": "ShippingLocation.getPostalCode" + }, + { + "description": "Returns the shipping location's state code.", + "id": "script-api:dw/order/ShippingLocation#getStateCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getStateCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's state code.", + "heading": "Description" + } + ], + "signature": "getStateCode(): string", + "source": "script-api", + "tags": [ + "getstatecode", + "shippinglocation.getstatecode" + ], + "title": "ShippingLocation.getStateCode" + }, + { + "description": "Returns the shipping location's suite.", + "id": "script-api:dw/order/ShippingLocation#getSuite", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.getSuite", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the shipping location's suite.", + "heading": "Description" + } + ], + "signature": "getSuite(): string", + "source": "script-api", + "tags": [ + "getsuite", + "shippinglocation.getsuite" + ], + "title": "ShippingLocation.getSuite" + }, + { + "description": "Returns the shipping location's post box.", + "id": "script-api:dw/order/ShippingLocation#postBox", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.postBox", + "sections": [ + { + "body": "Returns the shipping location's post box.", + "heading": "Description" + } + ], + "signature": "postBox: string", + "source": "script-api", + "tags": [ + "postbox", + "shippinglocation.postbox" + ], + "title": "ShippingLocation.postBox" + }, + { + "description": "Returns the shipping location's postal code.", + "id": "script-api:dw/order/ShippingLocation#postalCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.postalCode", + "sections": [ + { + "body": "Returns the shipping location's postal code.", + "heading": "Description" + } + ], + "signature": "postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "shippinglocation.postalcode" + ], + "title": "ShippingLocation.postalCode" + }, + { + "description": "Sets the shipping location's first address.", + "id": "script-api:dw/order/ShippingLocation#setAddress1", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setAddress1", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's first address.", + "heading": "Description" + } + ], + "signature": "setAddress1(aValue: string): void", + "source": "script-api", + "tags": [ + "setaddress1", + "shippinglocation.setaddress1" + ], + "title": "ShippingLocation.setAddress1" + }, + { + "description": "Sets the shipping location's second address.", + "id": "script-api:dw/order/ShippingLocation#setAddress2", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setAddress2", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's second address.", + "heading": "Description" + } + ], + "signature": "setAddress2(aValue: string): void", + "source": "script-api", + "tags": [ + "setaddress2", + "shippinglocation.setaddress2" + ], + "title": "ShippingLocation.setAddress2" + }, + { + "description": "Sets the shipping location's city.", + "id": "script-api:dw/order/ShippingLocation#setCity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setCity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's city.", + "heading": "Description" + } + ], + "signature": "setCity(aValue: string): void", + "source": "script-api", + "tags": [ + "setcity", + "shippinglocation.setcity" + ], + "title": "ShippingLocation.setCity" + }, + { + "description": "Sets the shipping location's country code.", + "id": "script-api:dw/order/ShippingLocation#setCountryCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setCountryCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's country code.", + "heading": "Description" + } + ], + "signature": "setCountryCode(aValue: string): void", + "source": "script-api", + "tags": [ + "setcountrycode", + "shippinglocation.setcountrycode" + ], + "title": "ShippingLocation.setCountryCode" + }, + { + "description": "Sets the shipping location's post box.", + "id": "script-api:dw/order/ShippingLocation#setPostBox", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setPostBox", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's post box.", + "heading": "Description" + } + ], + "signature": "setPostBox(aValue: string): void", + "source": "script-api", + "tags": [ + "setpostbox", + "shippinglocation.setpostbox" + ], + "title": "ShippingLocation.setPostBox" + }, + { + "description": "Sets the shipping location's postal code.", + "id": "script-api:dw/order/ShippingLocation#setPostalCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setPostalCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's postal code.", + "heading": "Description" + } + ], + "signature": "setPostalCode(aValue: string): void", + "source": "script-api", + "tags": [ + "setpostalcode", + "shippinglocation.setpostalcode" + ], + "title": "ShippingLocation.setPostalCode" + }, + { + "description": "Sets the shipping location's state code.", + "id": "script-api:dw/order/ShippingLocation#setStateCode", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setStateCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's state code.", + "heading": "Description" + } + ], + "signature": "setStateCode(aValue: string): void", + "source": "script-api", + "tags": [ + "setstatecode", + "shippinglocation.setstatecode" + ], + "title": "ShippingLocation.setStateCode" + }, + { + "description": "Sets the shipping location's suite.", + "id": "script-api:dw/order/ShippingLocation#setSuite", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "aValue", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.setSuite", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping location's suite.", + "heading": "Description" + } + ], + "signature": "setSuite(aValue: string): void", + "source": "script-api", + "tags": [ + "setsuite", + "shippinglocation.setsuite" + ], + "title": "ShippingLocation.setSuite" + }, + { + "description": "Returns the shipping location's state code.", + "id": "script-api:dw/order/ShippingLocation#stateCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.stateCode", + "sections": [ + { + "body": "Returns the shipping location's state code.", + "heading": "Description" + } + ], + "signature": "stateCode: string", + "source": "script-api", + "tags": [ + "statecode", + "shippinglocation.statecode" + ], + "title": "ShippingLocation.stateCode" + }, + { + "description": "Returns the shipping location's suite.", + "id": "script-api:dw/order/ShippingLocation#suite", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingLocation", + "qualifiedName": "dw.order.ShippingLocation.suite", + "sections": [ + { + "body": "Returns the shipping location's suite.", + "heading": "Description" + } + ], + "signature": "suite: string", + "source": "script-api", + "tags": [ + "suite", + "shippinglocation.suite" + ], + "title": "ShippingLocation.suite" + }, + { + "description": "ShippingMethod represents how the shipment will be shipped.", + "id": "script-api:dw/order/ShippingMethod", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingMethod", + "sections": [ + { + "body": "ShippingMethod represents how the shipment will be shipped.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "shippingmethod", + "dw.order.shippingmethod", + "dw/order" + ], + "title": "ShippingMethod" + }, + { + "description": "Returns the ID of the shipping method.", + "id": "script-api:dw/order/ShippingMethod#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.ID", + "sections": [ + { + "body": "Returns the ID of the shipping method.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "shippingmethod.id" + ], + "title": "ShippingMethod.ID" + }, + { + "description": "Returns the base shipping method or null if undefined.", + "id": "script-api:dw/order/ShippingMethod#baseMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.baseMethod", + "sections": [ + { + "body": "Returns the base shipping method or null if undefined.", + "heading": "Description" + } + ], + "signature": "readonly baseMethod: ShippingMethod | null", + "source": "script-api", + "tags": [ + "basemethod", + "shippingmethod.basemethod" + ], + "title": "ShippingMethod.baseMethod" + }, + { + "description": "Returns the currency code associated with the shipping method", + "id": "script-api:dw/order/ShippingMethod#currencyCode", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.currencyCode", + "sections": [ + { + "body": "Returns the currency code associated with the shipping method", + "heading": "Description" + } + ], + "signature": "readonly currencyCode: string", + "source": "script-api", + "tags": [ + "currencycode", + "shippingmethod.currencycode" + ], + "title": "ShippingMethod.currencyCode" + }, + { + "description": "Returns the customer groups assigned to the shipping method. Assigned ids that do not belong to an existing customer group are ignored.", + "id": "script-api:dw/order/ShippingMethod#customerGroups", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.customerGroups", + "sections": [ + { + "body": "Returns the customer groups assigned to the shipping method.\nAssigned ids that do not belong to an existing customer group are ignored.", + "heading": "Description" + } + ], + "signature": "readonly customerGroups: Collection", + "source": "script-api", + "tags": [ + "customergroups", + "shippingmethod.customergroups" + ], + "title": "ShippingMethod.customerGroups" + }, + { + "description": "Returns 'true' if the shipping method is marked as 'default' for the current session's currency. Otherwise 'false' is returned.", + "id": "script-api:dw/order/ShippingMethod#defaultMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.defaultMethod", + "sections": [ + { + "body": "Returns 'true' if the shipping method is marked as 'default' for the current session's currency.\nOtherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "readonly defaultMethod: boolean", + "source": "script-api", + "tags": [ + "defaultmethod", + "shippingmethod.defaultmethod" + ], + "title": "ShippingMethod.defaultMethod" + }, + { + "description": "Returns the dependent shipping methods of this shipping method, regardless of the online status of the methods.", + "id": "script-api:dw/order/ShippingMethod#dependentMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.dependentMethods", + "sections": [ + { + "body": "Returns the dependent shipping methods of this shipping method,\nregardless of the online status of the methods.\n\nDependent shipping methods have this method as their base method.", + "heading": "Description" + } + ], + "signature": "readonly dependentMethods: Collection", + "source": "script-api", + "tags": [ + "dependentmethods", + "shippingmethod.dependentmethods" + ], + "title": "ShippingMethod.dependentMethods" + }, + { + "description": "Returns the description of the shipping method as specified in the current locale or null if it could not be found.", + "id": "script-api:dw/order/ShippingMethod#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.description", + "sections": [ + { + "body": "Returns the description of the shipping method as specified in the current locale or\nnull if it could not be found.", + "heading": "Description" + } + ], + "signature": "readonly description: string | null", + "source": "script-api", + "tags": [ + "description", + "shippingmethod.description" + ], + "title": "ShippingMethod.description" + }, + { + "description": "Returns the display name of the shipping method in the current locale or null if it could not be found.", + "id": "script-api:dw/order/ShippingMethod#displayName", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.displayName", + "sections": [ + { + "body": "Returns the display name of the shipping method in the current locale or\nnull if it could not be found.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string | null", + "source": "script-api", + "tags": [ + "displayname", + "shippingmethod.displayname" + ], + "title": "ShippingMethod.displayName" + }, + { + "description": "Returns the base shipping method or null if undefined.", + "id": "script-api:dw/order/ShippingMethod#getBaseMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getBaseMethod", + "returns": { + "type": "ShippingMethod | null" + }, + "sections": [ + { + "body": "Returns the base shipping method or null if undefined.", + "heading": "Description" + } + ], + "signature": "getBaseMethod(): ShippingMethod | null", + "source": "script-api", + "tags": [ + "getbasemethod", + "shippingmethod.getbasemethod" + ], + "title": "ShippingMethod.getBaseMethod" + }, + { + "description": "Returns the currency code associated with the shipping method", + "id": "script-api:dw/order/ShippingMethod#getCurrencyCode", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getCurrencyCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the currency code associated with the shipping method", + "heading": "Description" + } + ], + "signature": "getCurrencyCode(): string", + "source": "script-api", + "tags": [ + "getcurrencycode", + "shippingmethod.getcurrencycode" + ], + "title": "ShippingMethod.getCurrencyCode" + }, + { + "description": "Returns the customer groups assigned to the shipping method. Assigned ids that do not belong to an existing customer group are ignored.", + "id": "script-api:dw/order/ShippingMethod#getCustomerGroups", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getCustomerGroups", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the customer groups assigned to the shipping method.\nAssigned ids that do not belong to an existing customer group are ignored.", + "heading": "Description" + } + ], + "signature": "getCustomerGroups(): Collection", + "source": "script-api", + "tags": [ + "getcustomergroups", + "shippingmethod.getcustomergroups" + ], + "title": "ShippingMethod.getCustomerGroups" + }, + { + "description": "Returns the dependent shipping methods of this shipping method, regardless of the online status of the methods.", + "id": "script-api:dw/order/ShippingMethod#getDependentMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDependentMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the dependent shipping methods of this shipping method,\nregardless of the online status of the methods.\n\nDependent shipping methods have this method as their base method.", + "heading": "Description" + } + ], + "signature": "getDependentMethods(): Collection", + "source": "script-api", + "tags": [ + "getdependentmethods", + "shippingmethod.getdependentmethods" + ], + "title": "ShippingMethod.getDependentMethods" + }, + { + "description": "Returns the description of the shipping method as specified in the current locale or null if it could not be found.", + "id": "script-api:dw/order/ShippingMethod#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDescription", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the description of the shipping method as specified in the current locale or\nnull if it could not be found.", + "heading": "Description" + } + ], + "signature": "getDescription(): string | null", + "source": "script-api", + "tags": [ + "getdescription", + "shippingmethod.getdescription" + ], + "title": "ShippingMethod.getDescription" + }, + { + "description": "Returns the display name of the shipping method in the current locale or null if it could not be found.", + "id": "script-api:dw/order/ShippingMethod#getDisplayName", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getDisplayName", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the display name of the shipping method in the current locale or\nnull if it could not be found.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string | null", + "source": "script-api", + "tags": [ + "getdisplayname", + "shippingmethod.getdisplayname" + ], + "title": "ShippingMethod.getDisplayName" + }, + { + "description": "Returns the ID of the shipping method.", + "id": "script-api:dw/order/ShippingMethod#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the shipping method.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "shippingmethod.getid" + ], + "title": "ShippingMethod.getID" + }, + { + "description": "Returns the tax class id of the shipping method.", + "id": "script-api:dw/order/ShippingMethod#getTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.getTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the tax class id of the shipping method.", + "heading": "Description" + } + ], + "signature": "getTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxclassid", + "shippingmethod.gettaxclassid" + ], + "title": "ShippingMethod.getTaxClassID" + }, + { + "description": "Returns 'true' if the shipping method is marked as 'default' for the current session's currency. Otherwise 'false' is returned.", + "id": "script-api:dw/order/ShippingMethod#isDefaultMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.isDefaultMethod", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if the shipping method is marked as 'default' for the current session's currency.\nOtherwise 'false' is returned.", + "heading": "Description" + } + ], + "signature": "isDefaultMethod(): boolean", + "source": "script-api", + "tags": [ + "isdefaultmethod", + "shippingmethod.isdefaultmethod" + ], + "title": "ShippingMethod.isDefaultMethod" + }, + { + "description": "Returns true if shipping method is online, false otherwise", + "id": "script-api:dw/order/ShippingMethod#isOnline", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.isOnline", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if shipping method is online, false otherwise", + "heading": "Description" + } + ], + "signature": "isOnline(): boolean", + "source": "script-api", + "tags": [ + "isonline", + "shippingmethod.isonline" + ], + "title": "ShippingMethod.isOnline" + }, + { + "description": "Returns true if shipping method is online, false otherwise", + "id": "script-api:dw/order/ShippingMethod#online", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.online", + "sections": [ + { + "body": "Returns true if shipping method is online, false otherwise", + "heading": "Description" + } + ], + "signature": "readonly online: boolean", + "source": "script-api", + "tags": [ + "online", + "shippingmethod.online" + ], + "title": "ShippingMethod.online" + }, + { + "description": "Returns the tax class id of the shipping method.", + "id": "script-api:dw/order/ShippingMethod#taxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMethod", + "qualifiedName": "dw.order.ShippingMethod.taxClassID", + "sections": [ + { + "body": "Returns the tax class id of the shipping method.", + "heading": "Description" + } + ], + "signature": "readonly taxClassID: string", + "source": "script-api", + "tags": [ + "taxclassid", + "shippingmethod.taxclassid" + ], + "title": "ShippingMethod.taxClassID" + }, + { + "description": "Provides methods to access the shipping information.", + "id": "script-api:dw/order/ShippingMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingMgr", + "sections": [ + { + "body": "Provides methods to access the shipping information.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shippingmgr", + "dw.order.shippingmgr", + "dw/order" + ], + "title": "ShippingMgr" + }, + { + "description": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "id": "script-api:dw/order/ShippingMgr#allShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.allShippingMethods", + "sections": [ + { + "body": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "heading": "Description" + } + ], + "signature": "static readonly allShippingMethods: Collection", + "source": "script-api", + "tags": [ + "allshippingmethods", + "shippingmgr.allshippingmethods" + ], + "title": "ShippingMgr.allShippingMethods" + }, + { + "description": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "id": "script-api:dw/order/ShippingMgr#allShippingMethods", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.allShippingMethods", + "sections": [ + { + "body": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "heading": "Description" + } + ], + "signature": "static readonly allShippingMethods: Collection", + "source": "script-api", + "tags": [ + "allshippingmethods", + "shippingmgr.allshippingmethods" + ], + "title": "ShippingMgr.allShippingMethods" + }, + { + "description": "Applies product and shipment-level shipping cost to the specified line item container.", + "id": "script-api:dw/order/ShippingMgr#applyShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.applyShippingCost", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies product and shipment-level shipping cost to the specified line\nitem container.\n\nFor each product line item in the specified line item container, a\nproduct shipping line item is created if product-level shipping cost is\ndefined for the product. If no product-level shipping cost is defined for\nthe product, an existing product shipping line item is removed.\n\nFor each shipment in the specified line item container, shipment-level\nshipping cost is calculated. This cost is determined based on the\nmerchandise total of the shipment after all product and order discounts.\nOnly products without or with surcharge product-specific shipping cost\ncount towards this merchandise total. Products with fixed\nproduct-specific shipping cost don't count towards the merchandise total\nused to calculate shipment-level shipping cost. The calculated shipping\ncost is set at the standard shipping line item of the shipment.\n\nIf 'net' taxation is configured for the site, the merchandise total\nbefore tax is used. If 'gross' taxation is configured for the site, the\nmerchandise total after tax is used.\n\nIf no shipping method is set for a shipment, neither product nor\nshipment-level shipping cost can be calculated. In this case, the amount\nof the standard shipment shipping line item will be set to N/A, and\nshipping line items of product line items in this shipment will be\nremoved from the line item container.\n\nSpecial cases for product-level shipping cost:\n\n- if a product is member of multiple shipping cost groups, the lowest\nshipping cost takes precedence\n- if fixed and surcharge shipping cost is defined for a product, the\nfixed cost takes precedence\n- shipping cost defined for a master product is also defined for all\nvariants of this master\n- shipping cost is not applied to bundled product line items or options\nline items", + "heading": "Description" + } + ], + "signature": "static applyShippingCost(lineItemCtnr: LineItemCtnr): void", + "source": "script-api", + "tags": [ + "applyshippingcost", + "shippingmgr.applyshippingcost" + ], + "title": "ShippingMgr.applyShippingCost" + }, + { + "description": "Applies product and shipment-level shipping cost to the specified line item container.", + "id": "script-api:dw/order/ShippingMgr#applyShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.applyShippingCost", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies product and shipment-level shipping cost to the specified line\nitem container.\n\nFor each product line item in the specified line item container, a\nproduct shipping line item is created if product-level shipping cost is\ndefined for the product. If no product-level shipping cost is defined for\nthe product, an existing product shipping line item is removed.\n\nFor each shipment in the specified line item container, shipment-level\nshipping cost is calculated. This cost is determined based on the\nmerchandise total of the shipment after all product and order discounts.\nOnly products without or with surcharge product-specific shipping cost\ncount towards this merchandise total. Products with fixed\nproduct-specific shipping cost don't count towards the merchandise total\nused to calculate shipment-level shipping cost. The calculated shipping\ncost is set at the standard shipping line item of the shipment.\n\nIf 'net' taxation is configured for the site, the merchandise total\nbefore tax is used. If 'gross' taxation is configured for the site, the\nmerchandise total after tax is used.\n\nIf no shipping method is set for a shipment, neither product nor\nshipment-level shipping cost can be calculated. In this case, the amount\nof the standard shipment shipping line item will be set to N/A, and\nshipping line items of product line items in this shipment will be\nremoved from the line item container.\n\nSpecial cases for product-level shipping cost:\n\n- if a product is member of multiple shipping cost groups, the lowest\nshipping cost takes precedence\n- if fixed and surcharge shipping cost is defined for a product, the\nfixed cost takes precedence\n- shipping cost defined for a master product is also defined for all\nvariants of this master\n- shipping cost is not applied to bundled product line items or options\nline items", + "heading": "Description" + } + ], + "signature": "static applyShippingCost(lineItemCtnr: LineItemCtnr): void", + "source": "script-api", + "tags": [ + "applyshippingcost", + "shippingmgr.applyshippingcost" + ], + "title": "ShippingMgr.applyShippingCost" + }, + { + "description": "Returns the default shipping method of the current site applicable to the session currency.", + "id": "script-api:dw/order/ShippingMgr#defaultShippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.defaultShippingMethod", + "sections": [ + { + "body": "Returns the default shipping method of the current site applicable to the session currency.\n\nDoes an additional check if there is a base method and if their currencies are\nthe same. Returns NULL if the two currencies are different.", + "heading": "Description" + } + ], + "signature": "static readonly defaultShippingMethod: ShippingMethod | null", + "source": "script-api", + "tags": [ + "defaultshippingmethod", + "shippingmgr.defaultshippingmethod" + ], + "title": "ShippingMgr.defaultShippingMethod" + }, + { + "description": "Returns the default shipping method of the current site applicable to the session currency.", + "id": "script-api:dw/order/ShippingMgr#defaultShippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.defaultShippingMethod", + "sections": [ + { + "body": "Returns the default shipping method of the current site applicable to the session currency.\n\nDoes an additional check if there is a base method and if their currencies are\nthe same. Returns NULL if the two currencies are different.", + "heading": "Description" + } + ], + "signature": "static readonly defaultShippingMethod: ShippingMethod | null", + "source": "script-api", + "tags": [ + "defaultshippingmethod", + "shippingmgr.defaultshippingmethod" + ], + "title": "ShippingMgr.defaultShippingMethod" + }, + { + "description": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "id": "script-api:dw/order/ShippingMgr#getAllShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getAllShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "heading": "Description" + } + ], + "signature": "static getAllShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getallshippingmethods", + "shippingmgr.getallshippingmethods" + ], + "title": "ShippingMgr.getAllShippingMethods" + }, + { + "description": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "id": "script-api:dw/order/ShippingMgr#getAllShippingMethods", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getAllShippingMethods", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns the active shipping methods of the current site applicable to the session currency and current customer group.", + "heading": "Description" + } + ], + "signature": "static getAllShippingMethods(): Collection", + "source": "script-api", + "tags": [ + "getallshippingmethods", + "shippingmgr.getallshippingmethods" + ], + "title": "ShippingMgr.getAllShippingMethods" + }, + { + "description": "Returns the default shipping method of the current site applicable to the session currency.", + "id": "script-api:dw/order/ShippingMgr#getDefaultShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getDefaultShippingMethod", + "returns": { + "type": "ShippingMethod | null" + }, + "sections": [ + { + "body": "Returns the default shipping method of the current site applicable to the session currency.\n\nDoes an additional check if there is a base method and if their currencies are\nthe same. Returns NULL if the two currencies are different.", + "heading": "Description" + } + ], + "signature": "static getDefaultShippingMethod(): ShippingMethod | null", + "source": "script-api", + "tags": [ + "getdefaultshippingmethod", + "shippingmgr.getdefaultshippingmethod" + ], + "title": "ShippingMgr.getDefaultShippingMethod" + }, + { + "description": "Returns the default shipping method of the current site applicable to the session currency.", + "id": "script-api:dw/order/ShippingMgr#getDefaultShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getDefaultShippingMethod", + "returns": { + "type": "ShippingMethod | null" + }, + "sections": [ + { + "body": "Returns the default shipping method of the current site applicable to the session currency.\n\nDoes an additional check if there is a base method and if their currencies are\nthe same. Returns NULL if the two currencies are different.", + "heading": "Description" + } + ], + "signature": "static getDefaultShippingMethod(): ShippingMethod | null", + "source": "script-api", + "tags": [ + "getdefaultshippingmethod", + "shippingmgr.getdefaultshippingmethod" + ], + "title": "ShippingMgr.getDefaultShippingMethod" + }, + { + "description": "Returns the shipping model for the specified product.", + "id": "script-api:dw/order/ShippingMgr#getProductShippingModel", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getProductShippingModel", + "returns": { + "type": "ProductShippingModel" + }, + "sections": [ + { + "body": "Returns the shipping model for the specified product.", + "heading": "Description" + } + ], + "signature": "static getProductShippingModel(product: Product): ProductShippingModel", + "source": "script-api", + "tags": [ + "getproductshippingmodel", + "shippingmgr.getproductshippingmodel" + ], + "title": "ShippingMgr.getProductShippingModel" + }, + { + "description": "Returns the shipping model for the specified product.", + "id": "script-api:dw/order/ShippingMgr#getProductShippingModel", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "product", + "type": "Product" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getProductShippingModel", + "returns": { + "type": "ProductShippingModel" + }, + "sections": [ + { + "body": "Returns the shipping model for the specified product.", + "heading": "Description" + } + ], + "signature": "static getProductShippingModel(product: Product): ProductShippingModel", + "source": "script-api", + "tags": [ + "getproductshippingmodel", + "shippingmgr.getproductshippingmodel" + ], + "title": "ShippingMgr.getProductShippingModel" + }, + { + "description": "Returns the shipping model for the specified shipment.", + "id": "script-api:dw/order/ShippingMgr#getShipmentShippingModel", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShipmentShippingModel", + "returns": { + "type": "ShipmentShippingModel" + }, + "sections": [ + { + "body": "Returns the shipping model for the specified shipment.", + "heading": "Description" + } + ], + "signature": "static getShipmentShippingModel(shipment: Shipment): ShipmentShippingModel", + "source": "script-api", + "tags": [ + "getshipmentshippingmodel", + "shippingmgr.getshipmentshippingmodel" + ], + "title": "ShippingMgr.getShipmentShippingModel" + }, + { + "description": "Returns the shipping model for the specified shipment.", + "id": "script-api:dw/order/ShippingMgr#getShipmentShippingModel", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipment", + "type": "Shipment" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShipmentShippingModel", + "returns": { + "type": "ShipmentShippingModel" + }, + "sections": [ + { + "body": "Returns the shipping model for the specified shipment.", + "heading": "Description" + } + ], + "signature": "static getShipmentShippingModel(shipment: Shipment): ShipmentShippingModel", + "source": "script-api", + "tags": [ + "getshipmentshippingmodel", + "shippingmgr.getshipmentshippingmodel" + ], + "title": "ShippingMgr.getShipmentShippingModel" + }, + { + "description": "Returns the shipping cost amount for the specified shipping method and the specified order value.", + "id": "script-api:dw/order/ShippingMgr#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingMethod", + "type": "ShippingMethod" + }, + { + "name": "orderValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShippingCost", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping cost amount for the specified shipping method and\nthe specified order value.\n\nIf shipping cost cannot be calculated for any reason, Money.NA is\nreturned.", + "heading": "Description" + } + ], + "signature": "static getShippingCost(shippingMethod: ShippingMethod, orderValue: Money): Money", + "source": "script-api", + "tags": [ + "getshippingcost", + "shippingmgr.getshippingcost" + ], + "title": "ShippingMgr.getShippingCost" + }, + { + "description": "Returns the shipping cost amount for the specified shipping method and the specified order value.", + "id": "script-api:dw/order/ShippingMgr#getShippingCost", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingMethod", + "type": "ShippingMethod" + }, + { + "name": "orderValue", + "type": "Money" + } + ], + "parentId": "script-api:dw/order/ShippingMgr", + "qualifiedName": "dw.order.ShippingMgr.getShippingCost", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Returns the shipping cost amount for the specified shipping method and\nthe specified order value.\n\nIf shipping cost cannot be calculated for any reason, Money.NA is\nreturned.", + "heading": "Description" + } + ], + "signature": "static getShippingCost(shippingMethod: ShippingMethod, orderValue: Money): Money", + "source": "script-api", + "tags": [ + "getshippingcost", + "shippingmgr.getshippingcost" + ], + "title": "ShippingMgr.getShippingCost" + }, + { + "description": "A shipping order is used to specify items that should be shipped, and is typically exported to, and updated by a back-office warehouse management system.", + "id": "script-api:dw/order/ShippingOrder", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingOrder", + "sections": [ + { + "body": "A shipping order is used to specify items that should be shipped, and is\ntypically exported to, and updated by a back-office warehouse management\nsystem.\n\nAn dw.order.Order can have n shipping orders expressing how the order\nis to be shipped. The creation, export and update of shipping orders is\nlargely handled by custom logic in scripts by implementing\ndw.order.hooks.ShippingOrderHooks. Use method\ndw.order.Order.createShippingOrder for creation and add items using\ncreateShippingOrderItem - each item is related\nto an order item which in turn represents a product- or shipping- line item\nin the order.\n\nA shipping order has a status calculated from its item status, one of\n\n- CONFIRMED - shipping order not yet exported, with 0 items, or all items\nin status CONFIRMED.\n- WAREHOUSE - shipping order exported, with all items in status WAREHOUSE.\n- SHIPPED - exported shipping order has been updated, with 1-n items in\nstatus SHIPPED and 0-n CANCELLED.\n- CANCELLED - exported shipping order has been updated, with all items in\nstatus CANCELLED.\n\nThe following status transitions are supported. Every status transition is\ndocumented by the addition of an order note such as 'Shipping order 123456\nstatus changed to WAREHOUSE.':\n\nFrom\nTo\nWhen\nUse\n\nCONFIRMED\nWAREHOUSE\nShipping order exported\nCall setStatusWarehouse - note this is the only way to set the\nitems to status WAREHOUSE\n\nWAREHOUSE\nSHIPPED\nOne or more items have been SHIPPED\nCall dw.order.ShippingOrderItem.setStatus using\ndw.order.ShippingOrderItem.STATUS_SHIPPED\n\nWAREHOUSE\nCANCELLED\nAll items have been CANCELLED\nCall dw.order.ShippingOrderItem.setStatus using\ndw.order.ShippingOrderItem.STATUS_CANCELLED\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItemCtnr`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "shippingorder", + "dw.order.shippingorder", + "dw/order" + ], + "title": "ShippingOrder" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "shippingorder.orderby_itemid" + ], + "title": "ShippingOrder.ORDERBY_ITEMID" + }, + { + "description": "Sorting by item id. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMID", + "sections": [ + { + "body": "Sorting by item id. Use with method getItems as an argument to\nmethod dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMID: any", + "source": "script-api", + "tags": [ + "orderby_itemid", + "shippingorder.orderby_itemid" + ], + "title": "ShippingOrder.ORDERBY_ITEMID" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method\ngetItems as an argument to method\ndw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "shippingorder.orderby_itemposition" + ], + "title": "ShippingOrder.ORDERBY_ITEMPOSITION" + }, + { + "description": "Sorting by the position of the related oder item. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_ITEMPOSITION", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_ITEMPOSITION", + "sections": [ + { + "body": "Sorting by the position of the related oder item. Use with method\ngetItems as an argument to method\ndw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_ITEMPOSITION: any", + "source": "script-api", + "tags": [ + "orderby_itemposition", + "shippingorder.orderby_itemposition" + ], + "title": "ShippingOrder.ORDERBY_ITEMPOSITION" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "shippingorder.orderby_unsorted" + ], + "title": "ShippingOrder.ORDERBY_UNSORTED" + }, + { + "description": "Unsorted , as it is. Use with method getItems as an argument to method dw.util.FilteringCollection.sort.", + "id": "script-api:dw/order/ShippingOrder#ORDERBY_UNSORTED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.ORDERBY_UNSORTED", + "sections": [ + { + "body": "Unsorted , as it is. Use with method getItems as an argument\nto method dw.util.FilteringCollection.sort.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_UNSORTED: any", + "source": "script-api", + "tags": [ + "orderby_unsorted", + "shippingorder.orderby_unsorted" + ], + "title": "ShippingOrder.ORDERBY_UNSORTED" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "shippingorder.qualifier_productitems" + ], + "title": "ShippingOrder.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects the product items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_PRODUCTITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_PRODUCTITEMS", + "sections": [ + { + "body": "Selects the product items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_PRODUCTITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_productitems", + "shippingorder.qualifier_productitems" + ], + "title": "ShippingOrder.QUALIFIER_PRODUCTITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "shippingorder.qualifier_serviceitems" + ], + "title": "ShippingOrder.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Selects for the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.", + "id": "script-api:dw/order/ShippingOrder#QUALIFIER_SERVICEITEMS", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.QUALIFIER_SERVICEITEMS", + "sections": [ + { + "body": "Selects for the service items. Use with method getItems as an\nargument to method dw.util.FilteringCollection.select.", + "heading": "Description" + } + ], + "signature": "static readonly QUALIFIER_SERVICEITEMS: any", + "source": "script-api", + "tags": [ + "qualifier_serviceitems", + "shippingorder.qualifier_serviceitems" + ], + "title": "ShippingOrder.QUALIFIER_SERVICEITEMS" + }, + { + "description": "Constant for Shipping Order Status CANCELLED", + "id": "script-api:dw/order/ShippingOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Shipping Order Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "shippingorder.status_cancelled" + ], + "title": "ShippingOrder.STATUS_CANCELLED" + }, + { + "description": "Constant for Shipping Order Status CANCELLED", + "id": "script-api:dw/order/ShippingOrder#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Shipping Order Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "shippingorder.status_cancelled" + ], + "title": "ShippingOrder.STATUS_CANCELLED" + }, + { + "description": "Constant for Shipping Order Status CONFIRMED", + "id": "script-api:dw/order/ShippingOrder#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Shipping Order Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "shippingorder.status_confirmed" + ], + "title": "ShippingOrder.STATUS_CONFIRMED" + }, + { + "description": "Constant for Shipping Order Status CONFIRMED", + "id": "script-api:dw/order/ShippingOrder#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Shipping Order Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "shippingorder.status_confirmed" + ], + "title": "ShippingOrder.STATUS_CONFIRMED" + }, + { + "description": "Constant for Shipping Order Status SHIPPED", + "id": "script-api:dw/order/ShippingOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Shipping Order Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "shippingorder.status_shipped" + ], + "title": "ShippingOrder.STATUS_SHIPPED" + }, + { + "description": "Constant for Shipping Order Status SHIPPED", + "id": "script-api:dw/order/ShippingOrder#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Shipping Order Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "shippingorder.status_shipped" + ], + "title": "ShippingOrder.STATUS_SHIPPED" + }, + { + "description": "Constant for Shipping Order Status WAREHOUSE", + "id": "script-api:dw/order/ShippingOrder#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Shipping Order Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "shippingorder.status_warehouse" + ], + "title": "ShippingOrder.STATUS_WAREHOUSE" + }, + { + "description": "Constant for Shipping Order Status WAREHOUSE", + "id": "script-api:dw/order/ShippingOrder#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Shipping Order Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "shippingorder.status_warehouse" + ], + "title": "ShippingOrder.STATUS_WAREHOUSE" + }, + { + "description": "Adds a tracking info to this shipping order with the given ID.", + "id": "script-api:dw/order/ShippingOrder#addTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "trackingInfoID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.addTrackingInfo", + "returns": { + "type": "TrackingInfo" + }, + "sections": [ + { + "body": "Adds a tracking info to this shipping order with the given ID.", + "heading": "Description" + } + ], + "signature": "addTrackingInfo(trackingInfoID: string): TrackingInfo", + "source": "script-api", + "tags": [ + "addtrackinginfo", + "shippingorder.addtrackinginfo" + ], + "title": "ShippingOrder.addTrackingInfo" + }, + { + "description": "Creates a new dw.order.Invoice based on this ShippingOrder.", + "id": "script-api:dw/order/ShippingOrder#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this\nShippingOrder.\n\nThe shipping-order-number will be used as the\ninvoice-number. The Invoice can then be accessed using\ngetInvoice or getInvoiceNumber can be used.\nThe method must not be called more than once for a ShippingOrder,\nnor may 2 Invoices exist with the same invoice-number.\n\nThe new Invoice is a debit-invoice with a status\ndw.order.Invoice.STATUS_NOT_PAID, and will be passed to the\ncapture payment-hook in a separate database transaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "shippingorder.createinvoice" + ], + "title": "ShippingOrder.createInvoice" + }, + { + "description": "Creates a new dw.order.Invoice based on this ShippingOrder.", + "id": "script-api:dw/order/ShippingOrder#createInvoice", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "invoiceNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createInvoice", + "returns": { + "type": "Invoice" + }, + "sections": [ + { + "body": "Creates a new dw.order.Invoice based on this ShippingOrder.\n\nThe invoice-number must be specified as an argument.The Invoice can then be accessed using\ngetInvoice or getInvoiceNumber can be used.\nThe method must not be called more than once for a ShippingOrder,\nnor may 2 Invoices exist with the same invoice-number.\n\nThe new Invoice is a debit-invoice with a status dw.order.Invoice.STATUS_NOT_PAID, and\nwill be passed to the capture payment-hook in a separate database\ntransaction for processing.", + "heading": "Description" + } + ], + "signature": "createInvoice(invoiceNumber: string): Invoice", + "source": "script-api", + "tags": [ + "createinvoice", + "shippingorder.createinvoice" + ], + "title": "ShippingOrder.createInvoice" + }, + { + "description": "Create a dw.order.ShippingOrderItem in the shipping order with the number `shippingOrderNumber`.", + "id": "script-api:dw/order/ShippingOrder#createShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderItem", + "type": "OrderItem" + }, + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createShippingOrderItem", + "returns": { + "type": "ShippingOrderItem" + }, + "sections": [ + { + "body": "Create a dw.order.ShippingOrderItem in the shipping order with\nthe number `shippingOrderNumber`.\n\nThe quantity of the new item can be optionally specified. A quantity of\n`null` indicates the new item should be based on the entire order item and\nis recommended for dw.order.ShippingLineItems. If a quantity is\nspecified for a dw.order.ProductLineItem which is less than\nProductLineItem.getQuantity the\nProductLineItem will be split, creating a new\nProductLineItem. The new\nShippingOrderItem will be associated with the new\nProductLineItem, which will receive the specified\nquantity.\nSee also createShippingOrderItem.", + "heading": "Description" + } + ], + "signature": "createShippingOrderItem(orderItem: OrderItem, quantity: Quantity): ShippingOrderItem", + "source": "script-api", + "tags": [ + "createshippingorderitem", + "shippingorder.createshippingorderitem" + ], + "title": "ShippingOrder.createShippingOrderItem" + }, + { + "description": "Create a dw.order.ShippingOrderItem in the shipping order with the number `shippingOrderNumber`.", + "id": "script-api:dw/order/ShippingOrder#createShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "orderItem", + "type": "OrderItem" + }, + { + "name": "quantity", + "type": "Quantity" + }, + { + "name": "splitIfPartial", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.createShippingOrderItem", + "returns": { + "type": "ShippingOrderItem" + }, + "sections": [ + { + "body": "Create a dw.order.ShippingOrderItem in the shipping order with\nthe number `shippingOrderNumber`.\n\nThe quantity of the new item can be optionally specified. A quantity of\n`null` indicates the new item should be based on the entire order item and\nis recommended for dw.order.ShippingLineItems.\nIf the specified quantity is less than ProductLineItem.getQuantity the\nProductLineItem will be split or not depending on `splitIfPartial` parameter.\nWhen `split` is `true`, the method is equivalent to\ncreateShippingOrderItem.", + "heading": "Description" + } + ], + "signature": "createShippingOrderItem(orderItem: OrderItem, quantity: Quantity, splitIfPartial: boolean): ShippingOrderItem", + "source": "script-api", + "tags": [ + "createshippingorderitem", + "shippingorder.createshippingorderitem" + ], + "title": "ShippingOrder.createShippingOrderItem" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/ShippingOrder#getInvoice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getInvoice", + "returns": { + "type": "Invoice | null" + }, + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "getInvoice(): Invoice | null", + "source": "script-api", + "tags": [ + "getinvoice", + "shippingorder.getinvoice" + ], + "title": "ShippingOrder.getInvoice" + }, + { + "description": "Returns `null` or the invoice-number.", + "id": "script-api:dw/order/ShippingOrder#getInvoiceNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getInvoiceNumber", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns `null` or the invoice-number.", + "heading": "Description" + } + ], + "signature": "getInvoiceNumber(): string | null", + "source": "script-api", + "tags": [ + "getinvoicenumber", + "shippingorder.getinvoicenumber" + ], + "title": "ShippingOrder.getInvoiceNumber" + }, + { + "description": "Gets the shipping date.", + "id": "script-api:dw/order/ShippingOrder#getShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShipDate", + "returns": { + "type": "Date | null" + }, + "sections": [ + { + "body": "Gets the shipping date.\n\nReturns `null` if this shipping order is not yet shipped.", + "heading": "Description" + } + ], + "signature": "getShipDate(): Date | null", + "source": "script-api", + "tags": [ + "getshipdate", + "shippingorder.getshipdate" + ], + "title": "ShippingOrder.getShipDate" + }, + { + "description": "Returns the shipping address (optional, can be null).", + "id": "script-api:dw/order/ShippingOrder#getShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingAddress", + "returns": { + "type": "OrderAddress | null" + }, + "sections": [ + { + "body": "Returns the shipping address (optional, can be null).\n\nNote: the shipping address is not copied into the\nShippingOrder but is a link to a\ndw.order.OrderAddress held in the dw.order.Order.", + "heading": "Description" + } + ], + "signature": "getShippingAddress(): OrderAddress | null", + "source": "script-api", + "tags": [ + "getshippingaddress", + "shippingorder.getshippingaddress" + ], + "title": "ShippingOrder.getShippingAddress" + }, + { + "description": "Returns the shipping method of the shipping order.", + "id": "script-api:dw/order/ShippingOrder#getShippingMethod", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingMethod", + "returns": { + "type": "ShippingMethod | null" + }, + "sections": [ + { + "body": "Returns the shipping method of the shipping order.\n\nCan be `null`.", + "heading": "Description" + } + ], + "signature": "getShippingMethod(): ShippingMethod | null", + "source": "script-api", + "tags": [ + "getshippingmethod", + "shippingorder.getshippingmethod" + ], + "title": "ShippingOrder.getShippingMethod" + }, + { + "description": "Gets the shipping order number.", + "id": "script-api:dw/order/ShippingOrder#getShippingOrderNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getShippingOrderNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the shipping order number.", + "heading": "Description" + } + ], + "signature": "getShippingOrderNumber(): string", + "source": "script-api", + "tags": [ + "getshippingordernumber", + "shippingorder.getshippingordernumber" + ], + "title": "ShippingOrder.getShippingOrderNumber" + }, + { + "description": "Gets the status of this shipping order. The status is read-only and calculated from the item status. See class documentation for more details.", + "id": "script-api:dw/order/ShippingOrder#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the status of this shipping order. The status is read-only and\ncalculated from the item status. See class documentation for more\ndetails.\n\nThe possible values are STATUS_CONFIRMED,\nSTATUS_WAREHOUSE, STATUS_SHIPPED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "shippingorder.getstatus" + ], + "title": "ShippingOrder.getStatus" + }, + { + "description": "Gets a tracking info for this shipping order.", + "id": "script-api:dw/order/ShippingOrder#getTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "trackingInfoID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getTrackingInfo", + "returns": { + "type": "TrackingInfo | null" + }, + "sections": [ + { + "body": "Gets a tracking info for this shipping order.", + "heading": "Description" + } + ], + "signature": "getTrackingInfo(trackingInfoID: string): TrackingInfo | null", + "source": "script-api", + "tags": [ + "gettrackinginfo", + "shippingorder.gettrackinginfo" + ], + "title": "ShippingOrder.getTrackingInfo" + }, + { + "description": "Gets all tracking informations for this shipping order.", + "id": "script-api:dw/order/ShippingOrder#getTrackingInfos", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.getTrackingInfos", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Gets all tracking informations for this shipping order.", + "heading": "Description" + } + ], + "signature": "getTrackingInfos(): Collection", + "source": "script-api", + "tags": [ + "gettrackinginfos", + "shippingorder.gettrackinginfos" + ], + "title": "ShippingOrder.getTrackingInfos" + }, + { + "description": "Returns null or the previously created dw.order.Invoice.", + "id": "script-api:dw/order/ShippingOrder#invoice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.invoice", + "sections": [ + { + "body": "Returns null or the previously created dw.order.Invoice.", + "heading": "Description" + } + ], + "signature": "readonly invoice: Invoice | null", + "source": "script-api", + "tags": [ + "invoice", + "shippingorder.invoice" + ], + "title": "ShippingOrder.invoice" + }, + { + "description": "Returns `null` or the invoice-number.", + "id": "script-api:dw/order/ShippingOrder#invoiceNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.invoiceNumber", + "sections": [ + { + "body": "Returns `null` or the invoice-number.", + "heading": "Description" + } + ], + "signature": "readonly invoiceNumber: string | null", + "source": "script-api", + "tags": [ + "invoicenumber", + "shippingorder.invoicenumber" + ], + "title": "ShippingOrder.invoiceNumber" + }, + { + "description": "Sets the shipping date.", + "id": "script-api:dw/order/ShippingOrder#setShipDate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "date", + "type": "Date" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShipDate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the shipping date.", + "heading": "Description" + } + ], + "signature": "setShipDate(date: Date): void", + "source": "script-api", + "tags": [ + "setshipdate", + "shippingorder.setshipdate" + ], + "title": "ShippingOrder.setShipDate" + }, + { + "description": "Set a shipping address for the shipping order.", + "id": "script-api:dw/order/ShippingOrder#setShippingAddress", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "address", + "type": "OrderAddress" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShippingAddress", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a shipping address for the shipping order.", + "heading": "Description" + } + ], + "signature": "setShippingAddress(address: OrderAddress): void", + "source": "script-api", + "tags": [ + "setshippingaddress", + "shippingorder.setshippingaddress" + ], + "title": "ShippingOrder.setShippingAddress" + }, + { + "description": "Set the id of shipping method.", + "id": "script-api:dw/order/ShippingOrder#setShippingMethodID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shippingMethodID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setShippingMethodID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the id of shipping method.", + "heading": "Description" + } + ], + "signature": "setShippingMethodID(shippingMethodID: string): void", + "source": "script-api", + "tags": [ + "setshippingmethodid", + "shippingorder.setshippingmethodid" + ], + "title": "ShippingOrder.setShippingMethodID" + }, + { + "description": "Set a CONFIRMED shipping order (all items in status CONFIRMED) to status WAREHOUSE (all items in status WAREHOUSE).", + "id": "script-api:dw/order/ShippingOrder#setStatusWarehouse", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.setStatusWarehouse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a CONFIRMED shipping order (all items in status CONFIRMED) to status\nWAREHOUSE (all items in status WAREHOUSE).\n\nNote - this method is the only way to transition a shipping order from\nCONFIRMED to WAREHOUSE.", + "heading": "Description" + } + ], + "signature": "setStatusWarehouse(): void", + "source": "script-api", + "tags": [ + "setstatuswarehouse", + "shippingorder.setstatuswarehouse" + ], + "throws": [ + { + "description": "if the shipping order is in a status other than CONFIRMED.", + "type": "IllegalArgumentException" + } + ], + "title": "ShippingOrder.setStatusWarehouse" + }, + { + "description": "Gets the shipping date.", + "id": "script-api:dw/order/ShippingOrder#shipDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shipDate", + "sections": [ + { + "body": "Gets the shipping date.\n\nReturns `null` if this shipping order is not yet shipped.", + "heading": "Description" + } + ], + "signature": "shipDate: Date | null", + "source": "script-api", + "tags": [ + "shipdate", + "shippingorder.shipdate" + ], + "title": "ShippingOrder.shipDate" + }, + { + "description": "Returns the shipping address (optional, can be null).", + "id": "script-api:dw/order/ShippingOrder#shippingAddress", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingAddress", + "sections": [ + { + "body": "Returns the shipping address (optional, can be null).\n\nNote: the shipping address is not copied into the\nShippingOrder but is a link to a\ndw.order.OrderAddress held in the dw.order.Order.", + "heading": "Description" + } + ], + "signature": "shippingAddress: OrderAddress | null", + "source": "script-api", + "tags": [ + "shippingaddress", + "shippingorder.shippingaddress" + ], + "title": "ShippingOrder.shippingAddress" + }, + { + "description": "Returns the shipping method of the shipping order.", + "id": "script-api:dw/order/ShippingOrder#shippingMethod", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingMethod", + "sections": [ + { + "body": "Returns the shipping method of the shipping order.\n\nCan be `null`.", + "heading": "Description" + } + ], + "signature": "readonly shippingMethod: ShippingMethod | null", + "source": "script-api", + "tags": [ + "shippingmethod", + "shippingorder.shippingmethod" + ], + "title": "ShippingOrder.shippingMethod" + }, + { + "description": "Gets the shipping order number.", + "id": "script-api:dw/order/ShippingOrder#shippingOrderNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.shippingOrderNumber", + "sections": [ + { + "body": "Gets the shipping order number.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderNumber: string", + "source": "script-api", + "tags": [ + "shippingordernumber", + "shippingorder.shippingordernumber" + ], + "title": "ShippingOrder.shippingOrderNumber" + }, + { + "description": "Gets the status of this shipping order. The status is read-only and calculated from the item status. See class documentation for more details.", + "id": "script-api:dw/order/ShippingOrder#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.status", + "sections": [ + { + "body": "Gets the status of this shipping order. The status is read-only and\ncalculated from the item status. See class documentation for more\ndetails.\n\nThe possible values are STATUS_CONFIRMED,\nSTATUS_WAREHOUSE, STATUS_SHIPPED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "readonly status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "shippingorder.status" + ], + "title": "ShippingOrder.status" + }, + { + "description": "Gets all tracking informations for this shipping order.", + "id": "script-api:dw/order/ShippingOrder#trackingInfos", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrder", + "qualifiedName": "dw.order.ShippingOrder.trackingInfos", + "sections": [ + { + "body": "Gets all tracking informations for this shipping order.", + "heading": "Description" + } + ], + "signature": "readonly trackingInfos: Collection", + "source": "script-api", + "tags": [ + "trackinginfos", + "shippingorder.trackinginfos" + ], + "title": "ShippingOrder.trackingInfos" + }, + { + "description": "One or more ShippingOrderItems are contained in a dw.order.ShippingOrder, created using dw.order.ShippingOrder.createShippingOrderItem and can be retrieved by dw.order.ShippingOrder.getItems. A ShippingOrderItem references a single dw.order.OrderItem which in turn references a dw.order.LineItem associated with an dw.order.Order.", + "id": "script-api:dw/order/ShippingOrderItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.ShippingOrderItem", + "sections": [ + { + "body": "One or more ShippingOrderItems are contained in a\ndw.order.ShippingOrder, created using\ndw.order.ShippingOrder.createShippingOrderItem\nand can be retrieved by\ndw.order.ShippingOrder.getItems. A\nShippingOrderItem references a single\ndw.order.OrderItem which in turn references a\ndw.order.LineItem associated with an dw.order.Order.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + }, + { + "body": "Extends `AbstractItem`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "shippingorderitem", + "dw.order.shippingorderitem", + "dw/order" + ], + "title": "ShippingOrderItem" + }, + { + "description": "Constant for Order Item Status CANCELLED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Order Item Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "shippingorderitem.status_cancelled" + ], + "title": "ShippingOrderItem.STATUS_CANCELLED" + }, + { + "description": "Constant for Order Item Status CANCELLED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CANCELLED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CANCELLED", + "sections": [ + { + "body": "Constant for Order Item Status CANCELLED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CANCELLED: string", + "source": "script-api", + "tags": [ + "status_cancelled", + "shippingorderitem.status_cancelled" + ], + "title": "ShippingOrderItem.STATUS_CANCELLED" + }, + { + "description": "Constant for Order Item Status CONFIRMED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Order Item Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "shippingorderitem.status_confirmed" + ], + "title": "ShippingOrderItem.STATUS_CONFIRMED" + }, + { + "description": "Constant for Order Item Status CONFIRMED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_CONFIRMED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_CONFIRMED", + "sections": [ + { + "body": "Constant for Order Item Status CONFIRMED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_CONFIRMED: string", + "source": "script-api", + "tags": [ + "status_confirmed", + "shippingorderitem.status_confirmed" + ], + "title": "ShippingOrderItem.STATUS_CONFIRMED" + }, + { + "description": "Constant for Order Item Status SHIPPED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Order Item Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "shippingorderitem.status_shipped" + ], + "title": "ShippingOrderItem.STATUS_SHIPPED" + }, + { + "description": "Constant for Order Item Status SHIPPED", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_SHIPPED", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_SHIPPED", + "sections": [ + { + "body": "Constant for Order Item Status SHIPPED", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_SHIPPED: string", + "source": "script-api", + "tags": [ + "status_shipped", + "shippingorderitem.status_shipped" + ], + "title": "ShippingOrderItem.STATUS_SHIPPED" + }, + { + "description": "Constant for Order Item Status WAREHOUSE", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Order Item Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "shippingorderitem.status_warehouse" + ], + "title": "ShippingOrderItem.STATUS_WAREHOUSE" + }, + { + "description": "Constant for Order Item Status WAREHOUSE", + "id": "script-api:dw/order/ShippingOrderItem#STATUS_WAREHOUSE", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.STATUS_WAREHOUSE", + "sections": [ + { + "body": "Constant for Order Item Status WAREHOUSE", + "heading": "Description" + } + ], + "signature": "static readonly STATUS_WAREHOUSE: string", + "source": "script-api", + "tags": [ + "status_warehouse", + "shippingorderitem.status_warehouse" + ], + "title": "ShippingOrderItem.STATUS_WAREHOUSE" + }, + { + "description": "A shipping order item can be assigned to one or many dw.order.TrackingInfo tracking infos with different quantities. For example an item with quantity 3 may have been shipped in 2 packages, each represented by its own tracking info - 2 dw.order.TrackingRefs would exist with quantities 1 and 2.", + "id": "script-api:dw/order/ShippingOrderItem#addTrackingRef", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "trackingInfoID", + "type": "string" + }, + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.addTrackingRef", + "returns": { + "type": "TrackingRef" + }, + "sections": [ + { + "body": "A shipping order item can be assigned\nto one or many dw.order.TrackingInfo tracking infos with\ndifferent quantities. For example an item with quantity 3 may have been\nshipped in 2 packages, each represented by its own\ntracking info - 2\ndw.order.TrackingRefs would exist with quantities 1 and 2.\n\nThis method creates and adds a new tracking\nreference to this shipping order item for a given\ntracking info and quantity. The new\ninstance is returned.", + "heading": "Description" + } + ], + "signature": "addTrackingRef(trackingInfoID: string, quantity: Quantity): TrackingRef", + "source": "script-api", + "tags": [ + "addtrackingref", + "shippingorderitem.addtrackingref" + ], + "title": "ShippingOrderItem.addTrackingRef" + }, + { + "description": "Apply a rate of (factor / divisor) to the prices in this item, with the option to half round up or half round down to the nearest cent if necessary.", + "id": "script-api:dw/order/ShippingOrderItem#applyPriceRate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "factor", + "type": "Decimal" + }, + { + "name": "divisor", + "type": "Decimal" + }, + { + "name": "roundUp", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.applyPriceRate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Apply a rate of (factor / divisor) to the prices in this item, with the option to half round up or half round down to the\nnearest cent if necessary.\n\nExamples:\n\nTaxBasis before factor divisor roundup Calculation TaxBasis after\n$10.00 1 2 true 10*1/2= $5.00\n$10.00 9 10 true 10*9/10= $9.00\n$10.00 1 3 true 10*1/3=3.3333= $3.33\n$2.47 1 2 true 2.47*1/2=1.235= $1.24\n$2.47 1 2 false 2.47*1/2=1.235= $1.23\n\nWhich prices are updated?:\n\nThe rate described above is applied to tax-basis and tax then the net-price and gross-price are recalculated by adding / subtracting\ndepending on whether the order is based on net price.\n\nExample (order based on net price)\n\nNew TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis=$10.00, GrossPrice=TaxBasis+Tax=$11.00\n\nExample (order based on gross price)\n\nNew TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis-tax=$9.00, GrossPrice=TaxBasis=$10.00", + "heading": "Description" + } + ], + "signature": "applyPriceRate(factor: Decimal, divisor: Decimal, roundUp: boolean): void", + "source": "script-api", + "tags": [ + "applypricerate", + "shippingorderitem.applypricerate" + ], + "title": "ShippingOrderItem.applyPriceRate" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ShippingOrderItem#basePrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.basePrice", + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "readonly basePrice: Money", + "source": "script-api", + "tags": [ + "baseprice", + "shippingorderitem.baseprice" + ], + "title": "ShippingOrderItem.basePrice" + }, + { + "description": "Price of a single unit before discount application.", + "id": "script-api:dw/order/ShippingOrderItem#getBasePrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getBasePrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of a single unit before discount application.", + "heading": "Description" + } + ], + "signature": "getBasePrice(): Money", + "source": "script-api", + "tags": [ + "getbaseprice", + "shippingorderitem.getbaseprice" + ], + "title": "ShippingOrderItem.getBasePrice" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ShippingOrderItem#getParentItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getParentItem", + "returns": { + "type": "ShippingOrderItem | null" + }, + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "getParentItem(): ShippingOrderItem | null", + "source": "script-api", + "tags": [ + "getparentitem", + "shippingorderitem.getparentitem" + ], + "title": "ShippingOrderItem.getParentItem" + }, + { + "description": "The quantity of the shipping order item.", + "id": "script-api:dw/order/ShippingOrderItem#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "The quantity of the shipping order item.\n\nThe dw.value.Quantity is equal to the related line item quantity.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "shippingorderitem.getquantity" + ], + "title": "ShippingOrderItem.getQuantity" + }, + { + "description": "The mandatory shipping order number of the related dw.order.ShippingOrder.", + "id": "script-api:dw/order/ShippingOrderItem#getShippingOrderNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getShippingOrderNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The mandatory shipping order number of the related\ndw.order.ShippingOrder.", + "heading": "Description" + } + ], + "signature": "getShippingOrderNumber(): string", + "source": "script-api", + "tags": [ + "getshippingordernumber", + "shippingorderitem.getshippingordernumber" + ], + "title": "ShippingOrderItem.getShippingOrderNumber" + }, + { + "description": "Gets the order item status.", + "id": "script-api:dw/order/ShippingOrderItem#getStatus", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getStatus", + "returns": { + "type": "EnumValue" + }, + "sections": [ + { + "body": "Gets the order item status.\n\nThe possible values are STATUS_CONFIRMED,\nSTATUS_WAREHOUSE, STATUS_SHIPPED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "getStatus(): EnumValue", + "source": "script-api", + "tags": [ + "getstatus", + "shippingorderitem.getstatus" + ], + "title": "ShippingOrderItem.getStatus" + }, + { + "description": "Gets the tracking refs (tracking infos) the shipping order item is assigned to.", + "id": "script-api:dw/order/ShippingOrderItem#getTrackingRefs", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.getTrackingRefs", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Gets the tracking refs (tracking infos) the shipping order item is\nassigned to.", + "heading": "Description" + } + ], + "signature": "getTrackingRefs(): FilteringCollection", + "source": "script-api", + "tags": [ + "gettrackingrefs", + "shippingorderitem.gettrackingrefs" + ], + "title": "ShippingOrderItem.getTrackingRefs" + }, + { + "description": "Returns null or the parent item.", + "id": "script-api:dw/order/ShippingOrderItem#parentItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.parentItem", + "sections": [ + { + "body": "Returns null or the parent item.", + "heading": "Description" + } + ], + "signature": "parentItem: ShippingOrderItem | null", + "source": "script-api", + "tags": [ + "parentitem", + "shippingorderitem.parentitem" + ], + "title": "ShippingOrderItem.parentItem" + }, + { + "description": "The quantity of the shipping order item.", + "id": "script-api:dw/order/ShippingOrderItem#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.quantity", + "sections": [ + { + "body": "The quantity of the shipping order item.\n\nThe dw.value.Quantity is equal to the related line item quantity.", + "heading": "Description" + } + ], + "signature": "readonly quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "shippingorderitem.quantity" + ], + "title": "ShippingOrderItem.quantity" + }, + { + "description": "Set a parent item. The parent item must belong to the same dw.order.ShippingOrder. An infinite parent-child loop is disallowed as is a parent-child depth greater than 10. Setting a parent item indicates a dependency of the child item on the parent item, and can be used to form a parallel structure to that accessed using dw.order.ProductLineItem.getParent.", + "id": "script-api:dw/order/ShippingOrderItem#setParentItem", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "parentItem", + "type": "ShippingOrderItem" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.setParentItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a parent item. The parent item must belong to the same\ndw.order.ShippingOrder. An infinite parent-child loop is disallowed\nas is a parent-child depth greater than 10. Setting a parent item\nindicates a dependency of the child item on the parent item, and can be\nused to form a parallel structure to that accessed using\ndw.order.ProductLineItem.getParent.", + "heading": "Description" + } + ], + "signature": "setParentItem(parentItem: ShippingOrderItem): void", + "source": "script-api", + "tags": [ + "setparentitem", + "shippingorderitem.setparentitem" + ], + "title": "ShippingOrderItem.setParentItem" + }, + { + "description": "Sets the status. See dw.order.ShippingOrder for details of shipping order status transitions. Do not use this method to set a shipping order to status WAREHOUSE, instead use dw.order.ShippingOrder.setStatusWarehouse", + "id": "script-api:dw/order/ShippingOrderItem#setStatus", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "status", + "type": "string" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the status. See dw.order.ShippingOrder for details of\nshipping order status transitions. Do not use this method to set a\nshipping order to status WAREHOUSE, instead use\ndw.order.ShippingOrder.setStatusWarehouse\n\nThis also triggers the setting of the status of the\ndw.order.LineItem when appropriate. Setting this status can also have an impact on\nthe order status, accessed using dw.order.Order.getStatus and the\nshipping order status, accessed using dw.order.ShippingOrder.getStatus.", + "heading": "Description" + } + ], + "signature": "setStatus(status: string): void", + "source": "script-api", + "tags": [ + "setstatus", + "shippingorderitem.setstatus" + ], + "throws": [ + { + "description": "if status is null", + "type": "NullPointerException" + }, + { + "description": "if the status transition to the status is not allowed", + "type": "IllegalArgumentException" + } + ], + "title": "ShippingOrderItem.setStatus" + }, + { + "description": "The mandatory shipping order number of the related dw.order.ShippingOrder.", + "id": "script-api:dw/order/ShippingOrderItem#shippingOrderNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.shippingOrderNumber", + "sections": [ + { + "body": "The mandatory shipping order number of the related\ndw.order.ShippingOrder.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderNumber: string", + "source": "script-api", + "tags": [ + "shippingordernumber", + "shippingorderitem.shippingordernumber" + ], + "title": "ShippingOrderItem.shippingOrderNumber" + }, + { + "description": "Split the shipping order item.", + "id": "script-api:dw/order/ShippingOrderItem#split", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.split", + "returns": { + "type": "ShippingOrderItem" + }, + "sections": [ + { + "body": "Split the shipping order item.\n\nThis will also lead to a split of the related dw.order.LineItem.\nSplit means that for the passed quantity a new item is created with this\nquantity as an exact copy of this item. The remaining amount will stay in\nthis item.\n\nIf quantity is equal to getQuantity no split is done and this\nitem is returned itself.\n\nThis method is equivalent to split called\nwith `splitOrderItem` equals to `true`.", + "heading": "Description" + } + ], + "signature": "split(quantity: Quantity): ShippingOrderItem", + "source": "script-api", + "tags": [ + "split", + "shippingorderitem.split" + ], + "throws": [ + { + "description": "if quantity is greater than getQuantity", + "type": "IllegalArgumentException" + } + ], + "title": "ShippingOrderItem.split" + }, + { + "description": "Split the shipping order item.", + "id": "script-api:dw/order/ShippingOrderItem#split", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantity", + "type": "Quantity" + }, + { + "name": "splitOrderItem", + "type": "boolean" + } + ], + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.split", + "returns": { + "type": "ShippingOrderItem" + }, + "sections": [ + { + "body": "Split the shipping order item.\n\nThis will also lead to a split of the related dw.order.LineItem\nwhen `splitOrderItem` is `true`.\nSplit means that for the passed quantity a new item is created with this\nquantity as an exact copy of this item. The remaining amount will stay in\nthis item.\n\nIf quantity is equal to getQuantity no split is done and this\nitem is returned itself.", + "heading": "Description" + } + ], + "signature": "split(quantity: Quantity, splitOrderItem: boolean): ShippingOrderItem", + "source": "script-api", + "tags": [ + "split", + "shippingorderitem.split" + ], + "throws": [ + { + "description": "if quantity is greater than getQuantity", + "type": "IllegalArgumentException" + } + ], + "title": "ShippingOrderItem.split" + }, + { + "description": "Gets the order item status.", + "id": "script-api:dw/order/ShippingOrderItem#status", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.status", + "sections": [ + { + "body": "Gets the order item status.\n\nThe possible values are STATUS_CONFIRMED,\nSTATUS_WAREHOUSE, STATUS_SHIPPED,\nSTATUS_CANCELLED.", + "heading": "Description" + } + ], + "signature": "status: EnumValue", + "source": "script-api", + "tags": [ + "status", + "shippingorderitem.status" + ], + "title": "ShippingOrderItem.status" + }, + { + "description": "Gets the tracking refs (tracking infos) the shipping order item is assigned to.", + "id": "script-api:dw/order/ShippingOrderItem#trackingRefs", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/ShippingOrderItem", + "qualifiedName": "dw.order.ShippingOrderItem.trackingRefs", + "sections": [ + { + "body": "Gets the tracking refs (tracking infos) the shipping order item is\nassigned to.", + "heading": "Description" + } + ], + "signature": "readonly trackingRefs: FilteringCollection", + "source": "script-api", + "tags": [ + "trackingrefs", + "shippingorderitem.trackingrefs" + ], + "title": "ShippingOrderItem.trackingRefs" + }, + { + "description": "Container used to represent an subtotal or grandtotal item which contains various prices and a tax breakdown held in a collection of tax-items.", + "id": "script-api:dw/order/SumItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.SumItem", + "sections": [ + { + "body": "Container used to represent an subtotal or grandtotal item which contains various prices and a tax breakdown\nheld in a collection of tax-items.\n\nUsage example:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sumitem", + "dw.order.sumitem", + "dw/order" + ], + "title": "SumItem" + }, + { + "description": "Gross price of SumItem.", + "id": "script-api:dw/order/SumItem#getGrossPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getGrossPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Gross price of SumItem.", + "heading": "Description" + } + ], + "signature": "getGrossPrice(): Money", + "source": "script-api", + "tags": [ + "getgrossprice", + "sumitem.getgrossprice" + ], + "title": "SumItem.getGrossPrice" + }, + { + "description": "Net price of SumItem.", + "id": "script-api:dw/order/SumItem#getNetPrice", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getNetPrice", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Net price of SumItem.", + "heading": "Description" + } + ], + "signature": "getNetPrice(): Money", + "source": "script-api", + "tags": [ + "getnetprice", + "sumitem.getnetprice" + ], + "title": "SumItem.getNetPrice" + }, + { + "description": "Total tax for SumItem.", + "id": "script-api:dw/order/SumItem#getTax", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTax", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Total tax for SumItem.", + "heading": "Description" + } + ], + "signature": "getTax(): Money", + "source": "script-api", + "tags": [ + "gettax", + "sumitem.gettax" + ], + "title": "SumItem.getTax" + }, + { + "description": "Price of entire SumItem on which tax calculation is based. Same as getNetPrice or getGrossPrice depending on whether the order is based on net or gross prices.", + "id": "script-api:dw/order/SumItem#getTaxBasis", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTaxBasis", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Price of entire SumItem on which tax calculation is based. Same as getNetPrice\nor getGrossPrice depending on whether the order is based on net or gross prices.", + "heading": "Description" + } + ], + "signature": "getTaxBasis(): Money", + "source": "script-api", + "tags": [ + "gettaxbasis", + "sumitem.gettaxbasis" + ], + "title": "SumItem.getTaxBasis" + }, + { + "description": "Tax items representing a tax breakdown for the SumItem.", + "id": "script-api:dw/order/SumItem#getTaxItems", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.getTaxItems", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Tax items representing a tax breakdown for the SumItem.", + "heading": "Description" + } + ], + "signature": "getTaxItems(): Collection", + "source": "script-api", + "tags": [ + "gettaxitems", + "sumitem.gettaxitems" + ], + "title": "SumItem.getTaxItems" + }, + { + "description": "Gross price of SumItem.", + "id": "script-api:dw/order/SumItem#grossPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.grossPrice", + "sections": [ + { + "body": "Gross price of SumItem.", + "heading": "Description" + } + ], + "signature": "readonly grossPrice: Money", + "source": "script-api", + "tags": [ + "grossprice", + "sumitem.grossprice" + ], + "title": "SumItem.grossPrice" + }, + { + "description": "Net price of SumItem.", + "id": "script-api:dw/order/SumItem#netPrice", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.netPrice", + "sections": [ + { + "body": "Net price of SumItem.", + "heading": "Description" + } + ], + "signature": "readonly netPrice: Money", + "source": "script-api", + "tags": [ + "netprice", + "sumitem.netprice" + ], + "title": "SumItem.netPrice" + }, + { + "description": "Total tax for SumItem.", + "id": "script-api:dw/order/SumItem#tax", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.tax", + "sections": [ + { + "body": "Total tax for SumItem.", + "heading": "Description" + } + ], + "signature": "readonly tax: Money", + "source": "script-api", + "tags": [ + "tax", + "sumitem.tax" + ], + "title": "SumItem.tax" + }, + { + "description": "Price of entire SumItem on which tax calculation is based. Same as getNetPrice or getGrossPrice depending on whether the order is based on net or gross prices.", + "id": "script-api:dw/order/SumItem#taxBasis", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.taxBasis", + "sections": [ + { + "body": "Price of entire SumItem on which tax calculation is based. Same as getNetPrice\nor getGrossPrice depending on whether the order is based on net or gross prices.", + "heading": "Description" + } + ], + "signature": "readonly taxBasis: Money", + "source": "script-api", + "tags": [ + "taxbasis", + "sumitem.taxbasis" + ], + "title": "SumItem.taxBasis" + }, + { + "description": "Tax items representing a tax breakdown for the SumItem.", + "id": "script-api:dw/order/SumItem#taxItems", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/SumItem", + "qualifiedName": "dw.order.SumItem.taxItems", + "sections": [ + { + "body": "Tax items representing a tax breakdown for the SumItem.", + "heading": "Description" + } + ], + "signature": "readonly taxItems: Collection", + "source": "script-api", + "tags": [ + "taxitems", + "sumitem.taxitems" + ], + "title": "SumItem.taxItems" + }, + { + "description": "Contains the formal definition of a tax including a type (it's just the key), a getRate if provided, a getCaption and a getDescription.", + "id": "script-api:dw/order/TaxGroup", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxGroup", + "sections": [ + { + "body": "Contains the formal definition of a tax including a type (it's just the key), a getRate\nif provided, a getCaption and a getDescription.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "taxgroup", + "dw.order.taxgroup", + "dw/order" + ], + "title": "TaxGroup" + }, + { + "description": "Gets the caption.", + "id": "script-api:dw/order/TaxGroup#caption", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.caption", + "sections": [ + { + "body": "Gets the caption.", + "heading": "Description" + } + ], + "signature": "readonly caption: string", + "source": "script-api", + "tags": [ + "caption", + "taxgroup.caption" + ], + "title": "TaxGroup.caption" + }, + { + "description": "Creates a TaxGroup.", + "id": "script-api:dw/order/TaxGroup#create", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxType", + "type": "string" + }, + { + "name": "caption", + "type": "string" + }, + { + "name": "description", + "type": "string" + }, + { + "name": "taxRate", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.create", + "returns": { + "type": "TaxGroup" + }, + "sections": [ + { + "body": "Creates a TaxGroup.\n\nThis TaxGroup can be used for example in ReturnItem.addTaxItem.", + "heading": "Description" + } + ], + "signature": "static create(taxType: string, caption: string, description: string, taxRate: Decimal): TaxGroup", + "source": "script-api", + "tags": [ + "create", + "taxgroup.create" + ], + "title": "TaxGroup.create" + }, + { + "description": "Creates a TaxGroup.", + "id": "script-api:dw/order/TaxGroup#create", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxType", + "type": "string" + }, + { + "name": "caption", + "type": "string" + }, + { + "name": "description", + "type": "string" + }, + { + "name": "taxRate", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.create", + "returns": { + "type": "TaxGroup" + }, + "sections": [ + { + "body": "Creates a TaxGroup.\n\nThis TaxGroup can be used for example in ReturnItem.addTaxItem.", + "heading": "Description" + } + ], + "signature": "static create(taxType: string, caption: string, description: string, taxRate: Decimal): TaxGroup", + "source": "script-api", + "tags": [ + "create", + "taxgroup.create" + ], + "title": "TaxGroup.create" + }, + { + "description": "Gets the description.", + "id": "script-api:dw/order/TaxGroup#description", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.description", + "sections": [ + { + "body": "Gets the description.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "taxgroup.description" + ], + "title": "TaxGroup.description" + }, + { + "description": "Gets the caption.", + "id": "script-api:dw/order/TaxGroup#getCaption", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getCaption", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the caption.", + "heading": "Description" + } + ], + "signature": "getCaption(): string", + "source": "script-api", + "tags": [ + "getcaption", + "taxgroup.getcaption" + ], + "title": "TaxGroup.getCaption" + }, + { + "description": "Gets the description.", + "id": "script-api:dw/order/TaxGroup#getDescription", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the description.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "taxgroup.getdescription" + ], + "title": "TaxGroup.getDescription" + }, + { + "description": "Gets the percentage amount of the rate.", + "id": "script-api:dw/order/TaxGroup#getRate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Gets the percentage amount of the rate.", + "heading": "Description" + } + ], + "signature": "getRate(): number", + "source": "script-api", + "tags": [ + "getrate", + "taxgroup.getrate" + ], + "title": "TaxGroup.getRate" + }, + { + "description": "Gets the tax type.", + "id": "script-api:dw/order/TaxGroup#getTaxType", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.getTaxType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the tax type.", + "heading": "Description" + } + ], + "signature": "getTaxType(): string", + "source": "script-api", + "tags": [ + "gettaxtype", + "taxgroup.gettaxtype" + ], + "title": "TaxGroup.getTaxType" + }, + { + "description": "Gets the percentage amount of the rate.", + "id": "script-api:dw/order/TaxGroup#rate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.rate", + "sections": [ + { + "body": "Gets the percentage amount of the rate.", + "heading": "Description" + } + ], + "signature": "readonly rate: number", + "source": "script-api", + "tags": [ + "rate", + "taxgroup.rate" + ], + "title": "TaxGroup.rate" + }, + { + "description": "Gets the tax type.", + "id": "script-api:dw/order/TaxGroup#taxType", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxGroup", + "qualifiedName": "dw.order.TaxGroup.taxType", + "sections": [ + { + "body": "Gets the tax type.", + "heading": "Description" + } + ], + "signature": "readonly taxType: string", + "source": "script-api", + "tags": [ + "taxtype", + "taxgroup.taxtype" + ], + "title": "TaxGroup.taxType" + }, + { + "description": "An item containing tax information allowing a tax breakdown between a number of dw.order.TaxGroups.", + "id": "script-api:dw/order/TaxItem", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxItem", + "sections": [ + { + "body": "An item containing tax information allowing a tax breakdown between a number of dw.order.TaxGroups.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "taxitem", + "dw.order.taxitem", + "dw/order" + ], + "title": "TaxItem" + }, + { + "description": "Gets the amount.", + "id": "script-api:dw/order/TaxItem#amount", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.amount", + "sections": [ + { + "body": "Gets the amount.", + "heading": "Description" + } + ], + "signature": "readonly amount: Money", + "source": "script-api", + "tags": [ + "amount", + "taxitem.amount" + ], + "title": "TaxItem.amount" + }, + { + "description": "Gets the amount.", + "id": "script-api:dw/order/TaxItem#getAmount", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.getAmount", + "returns": { + "type": "Money" + }, + "sections": [ + { + "body": "Gets the amount.", + "heading": "Description" + } + ], + "signature": "getAmount(): Money", + "source": "script-api", + "tags": [ + "getamount", + "taxitem.getamount" + ], + "title": "TaxItem.getAmount" + }, + { + "description": "Returns the TaxGroup tax group.", + "id": "script-api:dw/order/TaxItem#getTaxGroup", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.getTaxGroup", + "returns": { + "type": "TaxGroup" + }, + "sections": [ + { + "body": "Returns the TaxGroup tax group.", + "heading": "Description" + } + ], + "signature": "getTaxGroup(): TaxGroup", + "source": "script-api", + "tags": [ + "gettaxgroup", + "taxitem.gettaxgroup" + ], + "title": "TaxItem.getTaxGroup" + }, + { + "description": "Returns the TaxGroup tax group.", + "id": "script-api:dw/order/TaxItem#taxGroup", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxItem", + "qualifiedName": "dw.order.TaxItem.taxGroup", + "sections": [ + { + "body": "Returns the TaxGroup tax group.", + "heading": "Description" + } + ], + "signature": "readonly taxGroup: TaxGroup", + "source": "script-api", + "tags": [ + "taxgroup", + "taxitem.taxgroup" + ], + "title": "TaxItem.taxGroup" + }, + { + "description": "Provides methods to access the tax table.", + "id": "script-api:dw/order/TaxMgr", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TaxMgr", + "sections": [ + { + "body": "Provides methods to access the tax table.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "taxmgr", + "dw.order.taxmgr", + "dw/order" + ], + "title": "TaxMgr" + }, + { + "description": "Constant representing the gross taxation policy.", + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_GROSS", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_GROSS", + "sections": [ + { + "body": "Constant representing the gross taxation policy.", + "heading": "Description" + } + ], + "signature": "static readonly TAX_POLICY_GROSS = 0", + "source": "script-api", + "tags": [ + "tax_policy_gross", + "taxmgr.tax_policy_gross" + ], + "title": "TaxMgr.TAX_POLICY_GROSS" + }, + { + "description": "Constant representing the gross taxation policy.", + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_GROSS", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_GROSS", + "sections": [ + { + "body": "Constant representing the gross taxation policy.", + "heading": "Description" + } + ], + "signature": "static readonly TAX_POLICY_GROSS = 0", + "source": "script-api", + "tags": [ + "tax_policy_gross", + "taxmgr.tax_policy_gross" + ], + "title": "TaxMgr.TAX_POLICY_GROSS" + }, + { + "description": "Constant representing the net taxation policy.", + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_NET", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_NET", + "sections": [ + { + "body": "Constant representing the net taxation policy.", + "heading": "Description" + } + ], + "signature": "static readonly TAX_POLICY_NET = 1", + "source": "script-api", + "tags": [ + "tax_policy_net", + "taxmgr.tax_policy_net" + ], + "title": "TaxMgr.TAX_POLICY_NET" + }, + { + "description": "Constant representing the net taxation policy.", + "id": "script-api:dw/order/TaxMgr#TAX_POLICY_NET", + "kind": "constant", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.TAX_POLICY_NET", + "sections": [ + { + "body": "Constant representing the net taxation policy.", + "heading": "Description" + } + ], + "signature": "static readonly TAX_POLICY_NET = 1", + "source": "script-api", + "tags": [ + "tax_policy_net", + "taxmgr.tax_policy_net" + ], + "title": "TaxMgr.TAX_POLICY_NET" + }, + { + "description": "Applies externally set tax rates to the given dw.order.Basket. Only use when dw.order.LineItemCtnr.isExternallyTaxed returns true. Note: a basket can only be created in EXTERNAL tax mode using SCAPI.", + "id": "script-api:dw/order/TaxMgr#applyExternalTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyExternalTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies externally set tax rates to the given dw.order.Basket. Only use when\ndw.order.LineItemCtnr.isExternallyTaxed returns true. Note: a basket can only be created in EXTERNAL\ntax mode using SCAPI.\n\nTypical usage in tax calculation:", + "heading": "Description" + } + ], + "signature": "static applyExternalTax(basket: Basket): void", + "source": "script-api", + "tags": [ + "applyexternaltax", + "taxmgr.applyexternaltax" + ], + "title": "TaxMgr.applyExternalTax" + }, + { + "description": "Applies externally set tax rates to the given dw.order.Basket. Only use when dw.order.LineItemCtnr.isExternallyTaxed returns true. Note: a basket can only be created in EXTERNAL tax mode using SCAPI.", + "id": "script-api:dw/order/TaxMgr#applyExternalTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyExternalTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies externally set tax rates to the given dw.order.Basket. Only use when\ndw.order.LineItemCtnr.isExternallyTaxed returns true. Note: a basket can only be created in EXTERNAL\ntax mode using SCAPI.\n\nTypical usage in tax calculation:", + "heading": "Description" + } + ], + "signature": "static applyExternalTax(basket: Basket): void", + "source": "script-api", + "tags": [ + "applyexternaltax", + "taxmgr.applyexternaltax" + ], + "title": "TaxMgr.applyExternalTax" + }, + { + "description": "Applies tax to the given dw.order.Basket using the platform's tax hook dispatch logic.", + "id": "script-api:dw/order/TaxMgr#applyTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies tax to the given dw.order.Basket using the platform's tax hook dispatch logic.\n\nThis method is intended for use in custom dw.order.calculate hook implementations (e.g., in SFRA or\nSiteGenesis) that override the default basket calculation. Calling this method instead of directly invoking\ndw.order.calculateTax ensures that Commerce App tax providers registered via\nsfcc.app.tax.calculate are invoked when available, with automatic fallback to the legacy\ndw.order.calculateTax hook or the platform default tax calculation.\n\nWARNING: Do NOT call this method from within a dw.order.calculateTax hook\nimplementation, as this will cause infinite recursion. This method is designed to be called from\ndw.order.calculate hooks only.\n\nThe dispatch precedence is:\n\n- sfcc.app.tax.calculate — if a Commerce App tax provider is installed and the feature is\nenabled.\n- dw.order.calculateTax — if registered by the storefront.\n- Platform default tax calculation — using the site's tax tables.\n\nTypical usage in a custom dw.order.calculate hook:", + "heading": "Description" + } + ], + "signature": "static applyTax(basket: Basket): void", + "source": "script-api", + "tags": [ + "applytax", + "taxmgr.applytax" + ], + "title": "TaxMgr.applyTax" + }, + { + "description": "Applies tax to the given dw.order.Basket using the platform's tax hook dispatch logic.", + "id": "script-api:dw/order/TaxMgr#applyTax", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "basket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.applyTax", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Applies tax to the given dw.order.Basket using the platform's tax hook dispatch logic.\n\nThis method is intended for use in custom dw.order.calculate hook implementations (e.g., in SFRA or\nSiteGenesis) that override the default basket calculation. Calling this method instead of directly invoking\ndw.order.calculateTax ensures that Commerce App tax providers registered via\nsfcc.app.tax.calculate are invoked when available, with automatic fallback to the legacy\ndw.order.calculateTax hook or the platform default tax calculation.\n\nWARNING: Do NOT call this method from within a dw.order.calculateTax hook\nimplementation, as this will cause infinite recursion. This method is designed to be called from\ndw.order.calculate hooks only.\n\nThe dispatch precedence is:\n\n- sfcc.app.tax.calculate — if a Commerce App tax provider is installed and the feature is\nenabled.\n- dw.order.calculateTax — if registered by the storefront.\n- Platform default tax calculation — using the site's tax tables.\n\nTypical usage in a custom dw.order.calculate hook:", + "heading": "Description" + } + ], + "signature": "static applyTax(basket: Basket): void", + "source": "script-api", + "tags": [ + "applytax", + "taxmgr.applytax" + ], + "title": "TaxMgr.applyTax" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#customRateTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.customRateTaxClassID", + "sections": [ + { + "body": "Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation\nprocess assumes that such line items are initialized with a tax rate and a being ignored during the tax rate\nlookup sequence of the calculation process.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static readonly customRateTaxClassID: string", + "source": "script-api", + "tags": [ + "customratetaxclassid", + "taxmgr.customratetaxclassid" + ], + "title": "TaxMgr.customRateTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#customRateTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.customRateTaxClassID", + "sections": [ + { + "body": "Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation\nprocess assumes that such line items are initialized with a tax rate and a being ignored during the tax rate\nlookup sequence of the calculation process.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static readonly customRateTaxClassID: string", + "source": "script-api", + "tags": [ + "customratetaxclassid", + "taxmgr.customratetaxclassid" + ], + "title": "TaxMgr.customRateTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#defaultTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxClassID", + "sections": [ + { + "body": "Returns the ID of the default tax class defined for the site. This class might be used in case a product or\nservice does not define a tax class.\n\nIf no default tax class is defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "static readonly defaultTaxClassID: string | null", + "source": "script-api", + "tags": [ + "defaulttaxclassid", + "taxmgr.defaulttaxclassid" + ], + "title": "TaxMgr.defaultTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#defaultTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxClassID", + "sections": [ + { + "body": "Returns the ID of the default tax class defined for the site. This class might be used in case a product or\nservice does not define a tax class.\n\nIf no default tax class is defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "static readonly defaultTaxClassID: string | null", + "source": "script-api", + "tags": [ + "defaulttaxclassid", + "taxmgr.defaulttaxclassid" + ], + "title": "TaxMgr.defaultTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#defaultTaxJurisdictionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxJurisdictionID", + "sections": [ + { + "body": "Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no\njurisdiction is defined for a specific address.\n\nIf no default tax jurisdiction is defined, this method returns null.", + "heading": "Description" + } + ], + "signature": "static readonly defaultTaxJurisdictionID: string | null", + "source": "script-api", + "tags": [ + "defaulttaxjurisdictionid", + "taxmgr.defaulttaxjurisdictionid" + ], + "title": "TaxMgr.defaultTaxJurisdictionID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#defaultTaxJurisdictionID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.defaultTaxJurisdictionID", + "sections": [ + { + "body": "Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no\njurisdiction is defined for a specific address.\n\nIf no default tax jurisdiction is defined, this method returns null.", + "heading": "Description" + } + ], + "signature": "static readonly defaultTaxJurisdictionID: string | null", + "source": "script-api", + "tags": [ + "defaulttaxjurisdictionid", + "taxmgr.defaulttaxjurisdictionid" + ], + "title": "TaxMgr.defaultTaxJurisdictionID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getCustomRateTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getCustomRateTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation\nprocess assumes that such line items are initialized with a tax rate and a being ignored during the tax rate\nlookup sequence of the calculation process.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static getCustomRateTaxClassID(): string", + "source": "script-api", + "tags": [ + "getcustomratetaxclassid", + "taxmgr.getcustomratetaxclassid" + ], + "title": "TaxMgr.getCustomRateTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getCustomRateTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getCustomRateTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation\nprocess assumes that such line items are initialized with a tax rate and a being ignored during the tax rate\nlookup sequence of the calculation process.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static getCustomRateTaxClassID(): string", + "source": "script-api", + "tags": [ + "getcustomratetaxclassid", + "taxmgr.getcustomratetaxclassid" + ], + "title": "TaxMgr.getCustomRateTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getDefaultTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxClassID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the default tax class defined for the site. This class might be used in case a product or\nservice does not define a tax class.\n\nIf no default tax class is defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "static getDefaultTaxClassID(): string | null", + "source": "script-api", + "tags": [ + "getdefaulttaxclassid", + "taxmgr.getdefaulttaxclassid" + ], + "title": "TaxMgr.getDefaultTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getDefaultTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxClassID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the default tax class defined for the site. This class might be used in case a product or\nservice does not define a tax class.\n\nIf no default tax class is defined, the method returns null.", + "heading": "Description" + } + ], + "signature": "static getDefaultTaxClassID(): string | null", + "source": "script-api", + "tags": [ + "getdefaulttaxclassid", + "taxmgr.getdefaulttaxclassid" + ], + "title": "TaxMgr.getDefaultTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getDefaultTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxJurisdictionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no\njurisdiction is defined for a specific address.\n\nIf no default tax jurisdiction is defined, this method returns null.", + "heading": "Description" + } + ], + "signature": "static getDefaultTaxJurisdictionID(): string | null", + "source": "script-api", + "tags": [ + "getdefaulttaxjurisdictionid", + "taxmgr.getdefaulttaxjurisdictionid" + ], + "title": "TaxMgr.getDefaultTaxJurisdictionID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getDefaultTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getDefaultTaxJurisdictionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no\njurisdiction is defined for a specific address.\n\nIf no default tax jurisdiction is defined, this method returns null.", + "heading": "Description" + } + ], + "signature": "static getDefaultTaxJurisdictionID(): string | null", + "source": "script-api", + "tags": [ + "getdefaulttaxjurisdictionid", + "taxmgr.getdefaulttaxjurisdictionid" + ], + "title": "TaxMgr.getDefaultTaxJurisdictionID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getTaxExemptTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxExemptTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0\nfor this tax class.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static getTaxExemptTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxexempttaxclassid", + "taxmgr.gettaxexempttaxclassid" + ], + "title": "TaxMgr.getTaxExemptTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getTaxExemptTaxClassID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxExemptTaxClassID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0\nfor this tax class.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static getTaxExemptTaxClassID(): string", + "source": "script-api", + "tags": [ + "gettaxexempttaxclassid", + "taxmgr.gettaxexempttaxclassid" + ], + "title": "TaxMgr.getTaxExemptTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "location", + "type": "ShippingLocation" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxJurisdictionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the tax jurisdiction for the specified address. If no tax jurisdiction defined for the site\nmatches the specified address, this method returns null.", + "heading": "Description" + } + ], + "signature": "static getTaxJurisdictionID(location: ShippingLocation): string | null", + "source": "script-api", + "tags": [ + "gettaxjurisdictionid", + "taxmgr.gettaxjurisdictionid" + ], + "title": "TaxMgr.getTaxJurisdictionID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#getTaxJurisdictionID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "location", + "type": "ShippingLocation" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxJurisdictionID", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the ID of the tax jurisdiction for the specified address. If no tax jurisdiction defined for the site\nmatches the specified address, this method returns null.", + "heading": "Description" + } + ], + "signature": "static getTaxJurisdictionID(location: ShippingLocation): string | null", + "source": "script-api", + "tags": [ + "gettaxjurisdictionid", + "taxmgr.gettaxjurisdictionid" + ], + "title": "TaxMgr.getTaxJurisdictionID" + }, + { + "description": "Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.", + "id": "script-api:dw/order/TaxMgr#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxClassID", + "type": "string" + }, + { + "name": "taxJurisdictionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.\n\nMethod returns null if no tax rate is defined.\n\nMethod returns 0.0 of 'nontaxable' tax rate is specified (see method 'getNontaxableTaxClassID'.", + "heading": "Description" + } + ], + "signature": "static getTaxRate(taxClassID: string, taxJurisdictionID: string): number", + "source": "script-api", + "tags": [ + "gettaxrate", + "taxmgr.gettaxrate" + ], + "title": "TaxMgr.getTaxRate" + }, + { + "description": "Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.", + "id": "script-api:dw/order/TaxMgr#getTaxRate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "taxClassID", + "type": "string" + }, + { + "name": "taxJurisdictionID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxRate", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.\n\nMethod returns null if no tax rate is defined.\n\nMethod returns 0.0 of 'nontaxable' tax rate is specified (see method 'getNontaxableTaxClassID'.", + "heading": "Description" + } + ], + "signature": "static getTaxRate(taxClassID: string, taxJurisdictionID: string): number", + "source": "script-api", + "tags": [ + "gettaxrate", + "taxmgr.gettaxrate" + ], + "title": "TaxMgr.getTaxRate" + }, + { + "description": "Returns the taxation policy (net/gross) configured for the current site.", + "id": "script-api:dw/order/TaxMgr#getTaxationPolicy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxationPolicy", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the taxation policy (net/gross) configured for the current site.", + "heading": "Description" + } + ], + "signature": "static getTaxationPolicy(): number", + "source": "script-api", + "tags": [ + "gettaxationpolicy", + "taxmgr.gettaxationpolicy" + ], + "title": "TaxMgr.getTaxationPolicy" + }, + { + "description": "Returns the taxation policy (net/gross) configured for the current site.", + "id": "script-api:dw/order/TaxMgr#getTaxationPolicy", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.getTaxationPolicy", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the taxation policy (net/gross) configured for the current site.", + "heading": "Description" + } + ], + "signature": "static getTaxationPolicy(): number", + "source": "script-api", + "tags": [ + "gettaxationpolicy", + "taxmgr.gettaxationpolicy" + ], + "title": "TaxMgr.getTaxationPolicy" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#taxExemptTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxExemptTaxClassID", + "sections": [ + { + "body": "Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0\nfor this tax class.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static readonly taxExemptTaxClassID: string", + "source": "script-api", + "tags": [ + "taxexempttaxclassid", + "taxmgr.taxexempttaxclassid" + ], + "title": "TaxMgr.taxExemptTaxClassID" + }, + { + "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.", + "id": "script-api:dw/order/TaxMgr#taxExemptTaxClassID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxExemptTaxClassID", + "sections": [ + { + "body": "Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0\nfor this tax class.\n\nNote that this tax class does not appear in the Business Manager tax module.", + "heading": "Description" + } + ], + "signature": "static readonly taxExemptTaxClassID: string", + "source": "script-api", + "tags": [ + "taxexempttaxclassid", + "taxmgr.taxexempttaxclassid" + ], + "title": "TaxMgr.taxExemptTaxClassID" + }, + { + "description": "Returns the taxation policy (net/gross) configured for the current site.", + "id": "script-api:dw/order/TaxMgr#taxationPolicy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxationPolicy", + "sections": [ + { + "body": "Returns the taxation policy (net/gross) configured for the current site.", + "heading": "Description" + } + ], + "signature": "static readonly taxationPolicy: number", + "source": "script-api", + "tags": [ + "taxationpolicy", + "taxmgr.taxationpolicy" + ], + "title": "TaxMgr.taxationPolicy" + }, + { + "description": "Returns the taxation policy (net/gross) configured for the current site.", + "id": "script-api:dw/order/TaxMgr#taxationPolicy", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TaxMgr", + "qualifiedName": "dw.order.TaxMgr.taxationPolicy", + "sections": [ + { + "body": "Returns the taxation policy (net/gross) configured for the current site.", + "heading": "Description" + } + ], + "signature": "static readonly taxationPolicy: number", + "source": "script-api", + "tags": [ + "taxationpolicy", + "taxmgr.taxationpolicy" + ], + "title": "TaxMgr.taxationPolicy" + }, + { + "description": "Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems using dw.order.TrackingRefs. This also allows one dw.order.ShippingOrderItem to be associated with n TrackingInfo.", + "id": "script-api:dw/order/TrackingInfo", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TrackingInfo", + "sections": [ + { + "body": "Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems\nusing dw.order.TrackingRefs. This also allows one dw.order.ShippingOrderItem to be associated with n TrackingInfo.", + "heading": "Description" + }, + { + "body": "Extends `Extensible`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "trackinginfo", + "dw.order.trackinginfo", + "dw/order" + ], + "title": "TrackingInfo" + }, + { + "description": "Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from dw.order.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.", + "id": "script-api:dw/order/TrackingInfo#ID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.ID", + "sections": [ + { + "body": "Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from\ndw.order.TrackingRefs. To support short shipping a shipping-order-item can manage a list of\nTrackingRefs, each with an optional quantity value allowing individual items to ship in multiple\nparcels with known item quantity in each.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "trackinginfo.id" + ], + "title": "TrackingInfo.ID" + }, + { + "description": "Get the Carrier.", + "id": "script-api:dw/order/TrackingInfo#carrier", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.carrier", + "sections": [ + { + "body": "Get the Carrier.", + "heading": "Description" + } + ], + "signature": "carrier: string", + "source": "script-api", + "tags": [ + "carrier", + "trackinginfo.carrier" + ], + "title": "TrackingInfo.carrier" + }, + { + "description": "Get the service(ship method) of the used carrier.", + "id": "script-api:dw/order/TrackingInfo#carrierService", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.carrierService", + "sections": [ + { + "body": "Get the service(ship method) of the used carrier.", + "heading": "Description" + } + ], + "signature": "carrierService: string", + "source": "script-api", + "tags": [ + "carrierservice", + "trackinginfo.carrierservice" + ], + "title": "TrackingInfo.carrierService" + }, + { + "description": "Get the Carrier.", + "id": "script-api:dw/order/TrackingInfo#getCarrier", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getCarrier", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the Carrier.", + "heading": "Description" + } + ], + "signature": "getCarrier(): string", + "source": "script-api", + "tags": [ + "getcarrier", + "trackinginfo.getcarrier" + ], + "title": "TrackingInfo.getCarrier" + }, + { + "description": "Get the service(ship method) of the used carrier.", + "id": "script-api:dw/order/TrackingInfo#getCarrierService", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getCarrierService", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the service(ship method) of the used carrier.", + "heading": "Description" + } + ], + "signature": "getCarrierService(): string", + "source": "script-api", + "tags": [ + "getcarrierservice", + "trackinginfo.getcarrierservice" + ], + "title": "TrackingInfo.getCarrierService" + }, + { + "description": "Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from dw.order.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.", + "id": "script-api:dw/order/TrackingInfo#getID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from\ndw.order.TrackingRefs. To support short shipping a shipping-order-item can manage a list of\nTrackingRefs, each with an optional quantity value allowing individual items to ship in multiple\nparcels with known item quantity in each.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "trackinginfo.getid" + ], + "title": "TrackingInfo.getID" + }, + { + "description": "Get the ship date.", + "id": "script-api:dw/order/TrackingInfo#getShipDate", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getShipDate", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Get the ship date.", + "heading": "Description" + } + ], + "signature": "getShipDate(): Date", + "source": "script-api", + "tags": [ + "getshipdate", + "trackinginfo.getshipdate" + ], + "title": "TrackingInfo.getShipDate" + }, + { + "description": "Gets the shipping order.", + "id": "script-api:dw/order/TrackingInfo#getShippingOrder", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getShippingOrder", + "returns": { + "type": "ShippingOrder" + }, + "sections": [ + { + "body": "Gets the shipping order.", + "heading": "Description" + } + ], + "signature": "getShippingOrder(): ShippingOrder", + "source": "script-api", + "tags": [ + "getshippingorder", + "trackinginfo.getshippingorder" + ], + "title": "TrackingInfo.getShippingOrder" + }, + { + "description": "Get the tracking number.", + "id": "script-api:dw/order/TrackingInfo#getTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getTrackingNumber", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the tracking number.", + "heading": "Description" + } + ], + "signature": "getTrackingNumber(): string", + "source": "script-api", + "tags": [ + "gettrackingnumber", + "trackinginfo.gettrackingnumber" + ], + "title": "TrackingInfo.getTrackingNumber" + }, + { + "description": "Gets the tracking refs (shipping order items) which are assigned to this tracking info.", + "id": "script-api:dw/order/TrackingInfo#getTrackingRefs", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getTrackingRefs", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Gets the tracking refs (shipping order items) which are assigned to this tracking info.", + "heading": "Description" + } + ], + "signature": "getTrackingRefs(): Collection", + "source": "script-api", + "tags": [ + "gettrackingrefs", + "trackinginfo.gettrackingrefs" + ], + "title": "TrackingInfo.getTrackingRefs" + }, + { + "description": "Get the id of the shipping warehouse.", + "id": "script-api:dw/order/TrackingInfo#getWarehouseID", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.getWarehouseID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the id of the shipping warehouse.", + "heading": "Description" + } + ], + "signature": "getWarehouseID(): string", + "source": "script-api", + "tags": [ + "getwarehouseid", + "trackinginfo.getwarehouseid" + ], + "title": "TrackingInfo.getWarehouseID" + }, + { + "description": "Set the Carrier.", + "id": "script-api:dw/order/TrackingInfo#setCarrier", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "carrier", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setCarrier", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the Carrier.", + "heading": "Description" + } + ], + "signature": "setCarrier(carrier: string): void", + "source": "script-api", + "tags": [ + "setcarrier", + "trackinginfo.setcarrier" + ], + "title": "TrackingInfo.setCarrier" + }, + { + "description": "Set the service(ship method) of the used carrier.", + "id": "script-api:dw/order/TrackingInfo#setCarrierService", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "carrierService", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setCarrierService", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the service(ship method) of the used carrier.", + "heading": "Description" + } + ], + "signature": "setCarrierService(carrierService: string): void", + "source": "script-api", + "tags": [ + "setcarrierservice", + "trackinginfo.setcarrierservice" + ], + "title": "TrackingInfo.setCarrierService" + }, + { + "description": "Set the ship date.", + "id": "script-api:dw/order/TrackingInfo#setShipDate", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "shipDate", + "type": "Date" + } + ], + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setShipDate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the ship date.", + "heading": "Description" + } + ], + "signature": "setShipDate(shipDate: Date): void", + "source": "script-api", + "tags": [ + "setshipdate", + "trackinginfo.setshipdate" + ], + "title": "TrackingInfo.setShipDate" + }, + { + "description": "Set the TrackingNumber.", + "id": "script-api:dw/order/TrackingInfo#setTrackingNumber", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "trackingNumber", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setTrackingNumber", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the TrackingNumber.", + "heading": "Description" + } + ], + "signature": "setTrackingNumber(trackingNumber: string): void", + "source": "script-api", + "tags": [ + "settrackingnumber", + "trackinginfo.settrackingnumber" + ], + "title": "TrackingInfo.setTrackingNumber" + }, + { + "description": "Set the id of the shipping warehouse.", + "id": "script-api:dw/order/TrackingInfo#setWarehouseID", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "warehouseID", + "type": "string" + } + ], + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.setWarehouseID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the id of the shipping warehouse.", + "heading": "Description" + } + ], + "signature": "setWarehouseID(warehouseID: string): void", + "source": "script-api", + "tags": [ + "setwarehouseid", + "trackinginfo.setwarehouseid" + ], + "title": "TrackingInfo.setWarehouseID" + }, + { + "description": "Get the ship date.", + "id": "script-api:dw/order/TrackingInfo#shipDate", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.shipDate", + "sections": [ + { + "body": "Get the ship date.", + "heading": "Description" + } + ], + "signature": "shipDate: Date", + "source": "script-api", + "tags": [ + "shipdate", + "trackinginfo.shipdate" + ], + "title": "TrackingInfo.shipDate" + }, + { + "description": "Gets the shipping order.", + "id": "script-api:dw/order/TrackingInfo#shippingOrder", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.shippingOrder", + "sections": [ + { + "body": "Gets the shipping order.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrder: ShippingOrder", + "source": "script-api", + "tags": [ + "shippingorder", + "trackinginfo.shippingorder" + ], + "title": "TrackingInfo.shippingOrder" + }, + { + "description": "Get the tracking number.", + "id": "script-api:dw/order/TrackingInfo#trackingNumber", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.trackingNumber", + "sections": [ + { + "body": "Get the tracking number.", + "heading": "Description" + } + ], + "signature": "trackingNumber: string", + "source": "script-api", + "tags": [ + "trackingnumber", + "trackinginfo.trackingnumber" + ], + "title": "TrackingInfo.trackingNumber" + }, + { + "description": "Gets the tracking refs (shipping order items) which are assigned to this tracking info.", + "id": "script-api:dw/order/TrackingInfo#trackingRefs", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.trackingRefs", + "sections": [ + { + "body": "Gets the tracking refs (shipping order items) which are assigned to this tracking info.", + "heading": "Description" + } + ], + "signature": "readonly trackingRefs: Collection", + "source": "script-api", + "tags": [ + "trackingrefs", + "trackinginfo.trackingrefs" + ], + "title": "TrackingInfo.trackingRefs" + }, + { + "description": "Get the id of the shipping warehouse.", + "id": "script-api:dw/order/TrackingInfo#warehouseID", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingInfo", + "qualifiedName": "dw.order.TrackingInfo.warehouseID", + "sections": [ + { + "body": "Get the id of the shipping warehouse.", + "heading": "Description" + } + ], + "signature": "warehouseID: string", + "source": "script-api", + "tags": [ + "warehouseid", + "trackinginfo.warehouseid" + ], + "title": "TrackingInfo.warehouseID" + }, + { + "description": "Provides basic information about the dw.order.TrackingInfo a dw.order.ShippingOrderItem is contained.", + "id": "script-api:dw/order/TrackingRef", + "kind": "class", + "packagePath": "dw/order", + "parentId": "script-api:dw/order", + "qualifiedName": "dw.order.TrackingRef", + "sections": [ + { + "body": "Provides basic information about the dw.order.TrackingInfo a\ndw.order.ShippingOrderItem is contained.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "trackingref", + "dw.order.trackingref", + "dw/order" + ], + "title": "TrackingRef" + }, + { + "description": "Gets the quantity, the shipping order item is assigned to the tracking info.", + "id": "script-api:dw/order/TrackingRef#getQuantity", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getQuantity", + "returns": { + "type": "Quantity" + }, + "sections": [ + { + "body": "Gets the quantity, the shipping order item is assigned to the tracking\ninfo.", + "heading": "Description" + } + ], + "signature": "getQuantity(): Quantity", + "source": "script-api", + "tags": [ + "getquantity", + "trackingref.getquantity" + ], + "title": "TrackingRef.getQuantity" + }, + { + "description": "Gets the shipping order item which is assigned to the tracking info.", + "id": "script-api:dw/order/TrackingRef#getShippingOrderItem", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getShippingOrderItem", + "returns": { + "type": "ShippingOrderItem" + }, + "sections": [ + { + "body": "Gets the shipping order item which is assigned to the tracking info.", + "heading": "Description" + } + ], + "signature": "getShippingOrderItem(): ShippingOrderItem", + "source": "script-api", + "tags": [ + "getshippingorderitem", + "trackingref.getshippingorderitem" + ], + "title": "TrackingRef.getShippingOrderItem" + }, + { + "description": "Gets the tracking info, the shipping order item is assigned to.", + "id": "script-api:dw/order/TrackingRef#getTrackingInfo", + "kind": "method", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.getTrackingInfo", + "returns": { + "type": "TrackingInfo" + }, + "sections": [ + { + "body": "Gets the tracking info, the shipping order item is assigned to.", + "heading": "Description" + } + ], + "signature": "getTrackingInfo(): TrackingInfo", + "source": "script-api", + "tags": [ + "gettrackinginfo", + "trackingref.gettrackinginfo" + ], + "title": "TrackingRef.getTrackingInfo" + }, + { + "description": "Gets the quantity, the shipping order item is assigned to the tracking info.", + "id": "script-api:dw/order/TrackingRef#quantity", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.quantity", + "sections": [ + { + "body": "Gets the quantity, the shipping order item is assigned to the tracking\ninfo.", + "heading": "Description" + } + ], + "signature": "quantity: Quantity", + "source": "script-api", + "tags": [ + "quantity", + "trackingref.quantity" + ], + "title": "TrackingRef.quantity" + }, + { + "description": "Sets the quantity, the shipping order item is assigned to the tracking info.", + "id": "script-api:dw/order/TrackingRef#setQuantity", + "kind": "method", + "packagePath": "dw/order", + "params": [ + { + "name": "quantity", + "type": "Quantity" + } + ], + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.setQuantity", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the quantity, the shipping order item is assigned to the tracking\ninfo.", + "heading": "Description" + } + ], + "signature": "setQuantity(quantity: Quantity): void", + "source": "script-api", + "tags": [ + "setquantity", + "trackingref.setquantity" + ], + "title": "TrackingRef.setQuantity" + }, + { + "description": "Gets the shipping order item which is assigned to the tracking info.", + "id": "script-api:dw/order/TrackingRef#shippingOrderItem", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.shippingOrderItem", + "sections": [ + { + "body": "Gets the shipping order item which is assigned to the tracking info.", + "heading": "Description" + } + ], + "signature": "readonly shippingOrderItem: ShippingOrderItem", + "source": "script-api", + "tags": [ + "shippingorderitem", + "trackingref.shippingorderitem" + ], + "title": "TrackingRef.shippingOrderItem" + }, + { + "description": "Gets the tracking info, the shipping order item is assigned to.", + "id": "script-api:dw/order/TrackingRef#trackingInfo", + "kind": "property", + "packagePath": "dw/order", + "parentId": "script-api:dw/order/TrackingRef", + "qualifiedName": "dw.order.TrackingRef.trackingInfo", + "sections": [ + { + "body": "Gets the tracking info, the shipping order item is assigned to.", + "heading": "Description" + } + ], + "signature": "readonly trackingInfo: TrackingInfo", + "source": "script-api", + "tags": [ + "trackinginfo", + "trackingref.trackinginfo" + ], + "title": "TrackingRef.trackingInfo" + }, + { + "description": "8 declarations", + "id": "script-api:dw/order/hooks", + "kind": "package", + "packagePath": "dw/order/hooks", + "qualifiedName": "dw.order.hooks", + "source": "script-api", + "tags": [ + "dw/order/hooks", + "dw.order.hooks" + ], + "title": "dw.order.hooks" + }, + { + "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.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.order.mergeBasket\", \"script\": \"./mergeBasket.js\"}\n]" + ], + "id": "script-api:dw/order/hooks/BasketMergeHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to merge baskets. It contains the extension points\n(hook names), and the functions that are called by each extension point. A function must be defined inside a\nJavaScript source and must be exported. The script with the exported hook function must be located inside a site\ncartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "basketmergehooks", + "dw.order.hooks.basketmergehooks", + "dw/order/hooks" + ], + "title": "BasketMergeHooks" + }, + { + "description": "The extension point name extensionPointMerge.", + "id": "script-api:dw/order/hooks/BasketMergeHooks#extensionPointMerge", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/BasketMergeHooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks.extensionPointMerge", + "sections": [ + { + "body": "The extension point name extensionPointMerge.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointMerge: \"dw.order.mergeBasket\"", + "source": "script-api", + "tags": [ + "extensionpointmerge", + "basketmergehooks.extensionpointmerge" + ], + "title": "BasketMergeHooks.extensionPointMerge" + }, + { + "description": "Merges content from a source basket (typically a former registered shopper's basket) into the current basket (usually a former guest shopper's basket that was transferred to the registered shopper).", + "id": "script-api:dw/order/hooks/BasketMergeHooks#mergeBasket", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "source", + "type": "Basket | null" + }, + { + "name": "currentBasket", + "type": "Basket" + } + ], + "parentId": "script-api:dw/order/hooks/BasketMergeHooks", + "qualifiedName": "dw.order.hooks.BasketMergeHooks.mergeBasket", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Merges content from a source basket (typically a former registered shopper's basket) into the current basket\n(usually a former guest shopper's basket that was transferred to the registered shopper).\n\nIf no override script is registered, the system defaults to the platform's standard basket merging logic.\n\nThis method is automatically invoked after a successful execution of the /transfer REST API with the query\nparameter merge=true, if either the guest or the registered users had baskets assigned. The registered shopper's\nbasket will be the source for the merge, and the transferred guest shopper's basket will be the current basket.", + "heading": "Description" + } + ], + "signature": "mergeBasket(source: Basket | null, currentBasket: Basket): Status", + "source": "script-api", + "tags": [ + "mergebasket", + "basketmergehooks.mergebasket" + ], + "title": "BasketMergeHooks.mergeBasket" + }, + { + "description": "This interface represents all script hooks that can be registered to customize the order and basket calculation 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.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.order.calculate\", \"script\": \"./calculate.js\"}\n]" + ], + "id": "script-api:dw/order/hooks/CalculateHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.CalculateHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to customize the order and basket calculation\nfunctionality. It contains the extension points (hook names), and the functions that are called by each extension\npoint. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook\nfunction must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks'\nentry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "calculatehooks", + "dw.order.hooks.calculatehooks", + "dw/order/hooks" + ], + "title": "CalculateHooks" + }, + { + "description": "The function is called by extension point extensionPointCalculate. It provides a single place for the line item container calculation.", + "id": "script-api:dw/order/hooks/CalculateHooks#calculate", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculate", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointCalculate. It provides a single place for\nthe line item container calculation.\n\nTo provide a fallback for existing implementations, the default implementation calls the hook\ndw.ocapi.shop.basket.calculate. However, this hook is deprecated, and calling it will create entries in the\ndeprecated API usage logs. You should override this function to use dw.order.calculate instead.\n\nIf you provide your own implementation, you should provide and use the following hooks. Best practice is\nto use the hook manager to retrieve them in the calculate hook, and avoid calling them directly.\n\n- extensionPointCalculateTax for tax calculation\n- extensionPointCalculateShipping for shipping calculation", + "heading": "Description" + } + ], + "signature": "calculate(lineItemCtnr: LineItemCtnr): Status", + "source": "script-api", + "tags": [ + "calculate", + "calculatehooks.calculate" + ], + "title": "CalculateHooks.calculate" + }, + { + "description": "The function is called by extension point extensionPointCalculateShipping. It provides a single place for shipping calculation during the line item container calculation.", + "id": "script-api:dw/order/hooks/CalculateHooks#calculateShipping", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculateShipping", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointCalculateShipping. It provides a single\nplace for shipping calculation during the line item container calculation.", + "heading": "Description" + } + ], + "signature": "calculateShipping(lineItemCtnr: LineItemCtnr): Status", + "source": "script-api", + "tags": [ + "calculateshipping", + "calculatehooks.calculateshipping" + ], + "title": "CalculateHooks.calculateShipping" + }, + { + "description": "The function is called by extension point extensionPointCalculateTax. It provides a single place for tax calculation during the line item container calculation.", + "id": "script-api:dw/order/hooks/CalculateHooks#calculateTax", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.calculateTax", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointCalculateTax. It provides a single place\nfor tax calculation during the line item container calculation.", + "heading": "Description" + } + ], + "signature": "calculateTax(lineItemCtnr: LineItemCtnr): Status", + "source": "script-api", + "tags": [ + "calculatetax", + "calculatehooks.calculatetax" + ], + "title": "CalculateHooks.calculateTax" + }, + { + "description": "The extension point name extensionPointCalculate.", + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculate", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculate", + "sections": [ + { + "body": "The extension point name extensionPointCalculate.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCalculate: \"dw.order.calculate\"", + "source": "script-api", + "tags": [ + "extensionpointcalculate", + "calculatehooks.extensionpointcalculate" + ], + "title": "CalculateHooks.extensionPointCalculate" + }, + { + "description": "The extension point name extensionPointCalculateShipping.", + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculateShipping", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculateShipping", + "sections": [ + { + "body": "The extension point name extensionPointCalculateShipping.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCalculateShipping: \"dw.order.calculateShipping\"", + "source": "script-api", + "tags": [ + "extensionpointcalculateshipping", + "calculatehooks.extensionpointcalculateshipping" + ], + "title": "CalculateHooks.extensionPointCalculateShipping" + }, + { + "description": "The extension point name extensionPointCalculateTax.", + "id": "script-api:dw/order/hooks/CalculateHooks#extensionPointCalculateTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CalculateHooks", + "qualifiedName": "dw.order.hooks.CalculateHooks.extensionPointCalculateTax", + "sections": [ + { + "body": "The extension point name extensionPointCalculateTax.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCalculateTax: \"dw.order.calculateTax\"", + "source": "script-api", + "tags": [ + "extensionpointcalculatetax", + "calculatehooks.extensionpointcalculatetax" + ], + "title": "CalculateHooks.extensionPointCalculateTax" + }, + { + "description": "This interface represents script hooks that can be registered to populate customer details into a basket. 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.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.order.populateCustomerDetails\", \"script\": \"./populateCustomerDetails.js\"}\n]" + ], + "id": "script-api:dw/order/hooks/CheckoutHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks", + "sections": [ + { + "body": "This interface represents script hooks that can be registered to populate customer details into a basket. It contains\nthe extension points (hook names), and the functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the exported hook function must be located\ninside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "checkouthooks", + "dw.order.hooks.checkouthooks", + "dw/order/hooks" + ], + "title": "CheckoutHooks" + }, + { + "description": "The extension point name extensionPointPopulateCustomerDetails.", + "id": "script-api:dw/order/hooks/CheckoutHooks#extensionPointPopulateCustomerDetails", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/CheckoutHooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks.extensionPointPopulateCustomerDetails", + "sections": [ + { + "body": "The extension point name extensionPointPopulateCustomerDetails.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPopulateCustomerDetails: \"dw.order.populateCustomerDetails\"", + "source": "script-api", + "tags": [ + "extensionpointpopulatecustomerdetails", + "checkouthooks.extensionpointpopulatecustomerdetails" + ], + "title": "CheckoutHooks.extensionPointPopulateCustomerDetails" + }, + { + "description": "Populates registered customer details into a basket. This includes the default shipping address and default payment instrument from the registered customer's profile.", + "id": "script-api:dw/order/hooks/CheckoutHooks#populateCustomerDetails", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "basket", + "type": "Basket" + }, + { + "name": "customer", + "type": "Customer" + } + ], + "parentId": "script-api:dw/order/hooks/CheckoutHooks", + "qualifiedName": "dw.order.hooks.CheckoutHooks.populateCustomerDetails", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Populates registered customer details into a basket. This includes the default shipping address and default\npayment instrument from the registered customer's profile.\n\nIf no override script is registered, the system defaults to the platform's standard population logic which copies\nthe customer's default or first address to the basket's default shipment and billing address, then creates a\npayment instrument from the customer's default or first payment instrument.\n\nThis method is automatically invoked when the populateCustomerDetails query parameter is set to\ntrue on createBasket and transferBasket endpoints.", + "heading": "Description" + } + ], + "signature": "populateCustomerDetails(basket: Basket, customer: Customer): Status", + "source": "script-api", + "tags": [ + "populatecustomerdetails", + "checkouthooks.populatecustomerdetails" + ], + "title": "CheckoutHooks.populateCustomerDetails" + }, + { + "description": "This interface represents all script hooks that can be registered to customize the order logic. 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.", + "examples": [ + "\"hooks\": [\n{\"name\": \"dw.order.createOrderNo\", \"script\": \"./orders.ds\"},\n]" + ], + "id": "script-api:dw/order/hooks/OrderHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.OrderHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to customize the order logic. It contains the\nextension points (hook names), and the functions that are called by each extension point. A function must be defined\ninside a JavaScript source and must be exported. The script with the exported hook function must be located inside a\nsite cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\"hooks\": \"./hooks.json\"\n\nThe hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks\ninside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "orderhooks", + "dw.order.hooks.orderhooks", + "dw/order/hooks" + ], + "title": "OrderHooks" + }, + { + "description": "This hook is responsible for creating a new order number.", + "examples": [ + "exports.createOrderNo = function(){\nvar orderSeqNo = OrderMgr.createOrderSequenceNo();\nvar prefix = Site.getCurrent().getSiteId();\nreturn prefix + \"_\"+orderSeqNo;\n};" + ], + "id": "script-api:dw/order/hooks/OrderHooks#createOrderNo", + "kind": "method", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/OrderHooks", + "qualifiedName": "dw.order.hooks.OrderHooks.createOrderNo", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "This hook is responsible for creating a new order number.\n\nBy default order numbers are generated by using dw.order.OrderMgr.createOrderSequenceNo. Use this hook\nto customize the order number generation. E.g. a prefix or suffix could be added.\n\n\nIf the method returns `null` or an blank string order number generation will fall\nback to dw.order.OrderMgr.createOrderSequenceNo.\n\nThe maximum length of the order number is 50 characters.", + "heading": "Description" + } + ], + "signature": "createOrderNo(): string | null", + "source": "script-api", + "tags": [ + "createorderno", + "orderhooks.createorderno" + ], + "title": "OrderHooks.createOrderNo" + }, + { + "description": "The extension point name extensionPointCreateOrderNo.", + "id": "script-api:dw/order/hooks/OrderHooks#extensionPointCreateOrderNo", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/OrderHooks", + "qualifiedName": "dw.order.hooks.OrderHooks.extensionPointCreateOrderNo", + "sections": [ + { + "body": "The extension point name extensionPointCreateOrderNo.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCreateOrderNo: \"dw.order.createOrderNo\"", + "source": "script-api", + "tags": [ + "extensionpointcreateorderno", + "orderhooks.extensionpointcreateorderno" + ], + "title": "OrderHooks.extensionPointCreateOrderNo" + }, + { + "description": "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.", + "examples": [ + "\"hooks\": [\n{\"name\": \"dw.order.payment.authorize\", \"script\": \"./authorize.js\"},\n{\"name\": \"dw.order.payment.validateAuthorization\", \"script\": \"./validateAuthorization.js\"},\n]" + ], + "id": "script-api:dw/order/hooks/PaymentHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.PaymentHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to\ncustomize the order center payment functionality. It contains the extension\npoints (hook names), and the functions that are called by each extension\npoint. A function must be defined inside a JavaScript source and must be\nexported. The script with the exported hook function must be located inside a\nsite cartridge. Inside the site cartridge a 'package.json' file with a\n'hooks' entry must exist.\n\n\"hooks\": \"./hooks.json\"\n\nThe hooks entry links to a json file, relative to the 'package.json' file.\nThis file lists all registered hooks inside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the\nexported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "paymenthooks", + "dw.order.hooks.paymenthooks", + "dw/order/hooks" + ], + "title": "PaymentHooks" + }, + { + "description": "The function is called by extension point extensionPointAuthorize. Custom payment authorization - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#authorize", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "paymentDetails", + "type": "OrderPaymentInstrument" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.authorize", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointAuthorize. Custom payment authorization - modify the\norder as needed.\n\n- Prerequisite: An order has been created using the data api or via the storefront.\n- Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this).\n- Return Status.ERROR: Order is held, authorization needs to be repeated.", + "heading": "Description" + } + ], + "signature": "authorize(order: Order, paymentDetails: OrderPaymentInstrument): Status", + "source": "script-api", + "tags": [ + "authorize", + "paymenthooks.authorize" + ], + "title": "PaymentHooks.authorize" + }, + { + "description": "The function is called by extension point extensionPointAuthorizeCreditCard. Custom payment authorization of a credit card - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#authorizeCreditCard", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + }, + { + "name": "paymentDetails", + "type": "OrderPaymentInstrument" + }, + { + "name": "cvn", + "type": "string" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.authorizeCreditCard", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point\nextensionPointAuthorizeCreditCard. Custom payment authorization\nof a credit card - modify the order as needed.\n\n- Prerequisite: An order has been created using the data api or via the\nstorefront.\n- Return Status.OK: Corresponding payment transaction is marked as\nauthorized (usually a custom property is used for this).\n- Return Status.ERROR: Order is held, authorization needs to be\nrepeated.", + "heading": "Description" + } + ], + "signature": "authorizeCreditCard(order: Order, paymentDetails: OrderPaymentInstrument, cvn: string): Status", + "source": "script-api", + "tags": [ + "authorizecreditcard", + "paymenthooks.authorizecreditcard" + ], + "title": "PaymentHooks.authorizeCreditCard" + }, + { + "description": "The function is called by extension point extensionPointCapture. Custom payment capture - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#capture", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "invoice", + "type": "Invoice" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.capture", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointCapture. Custom payment capture - modify the order as needed.\n\n- Prerequisite:\n\n[ either ] As a result of shipping (or part-shipping) a shipping -order the warehouse updates the status of the shipping-order\nresulting in the creation of an unpaid debit invoice (the creation of the invoice is usually handled in\ndw.order.hooks.ShippingOrderHooks.changeStatus).\n\n[ or ] A unpaid debit invoice has been created using the data api.\n- Context: An unpaid debit invoice is passed to the payment system for capture. The capture attempt can either succeed (complete\ninvoice amount captured) or fail. As a result the invoice status is updated by ordercenter for further processing. See dw.order.Invoice.\n- Hook responsibility: The hook should attempt to capture the amount located in invoice.grandTotal.grossPrice. When successful,\nthe capture hook should also update the invoice by calling\ndw.order.Invoice.addCaptureTransaction\nwhich serves to record the capturedAmount and associate the invoice with the payment-transaction.\n- Return Status.OK: Indicates capture succeeded: Order Center sets the Invoice status to dw.order.Invoice.STATUS_PAID.\n- Return Status.ERROR: Indicates capture failed: Order Center sets the Invoice status to dw.order.Invoice.STATUS_FAILED for\nfurther processing.\n- Post processing: When the capture hook returns with success, order center not only sets the relevant invoice status, but also\nsets the relevant capturedAmount values on the invoice item. Returning success means the entire invoice total has been captured, so each item\nwithin the invoice can also be marked as completely captured. Note the script implementing the hook can take responsibility for this if desired\norder center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related\norder item can return a capturedAmount, useful for calculating possible refunds.", + "heading": "Description" + } + ], + "signature": "capture(invoice: Invoice): Status", + "source": "script-api", + "tags": [ + "capture", + "paymenthooks.capture" + ], + "title": "PaymentHooks.capture" + }, + { + "description": "The extension point name extensionPointAuthorize.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointAuthorize", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointAuthorize", + "sections": [ + { + "body": "The extension point name extensionPointAuthorize.\n\nThis hook is optional.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAuthorize: \"dw.order.payment.authorize\"", + "source": "script-api", + "tags": [ + "extensionpointauthorize", + "paymenthooks.extensionpointauthorize" + ], + "title": "PaymentHooks.extensionPointAuthorize" + }, + { + "description": "The extension point name extensionPointAuthorizeCreditCard.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointAuthorizeCreditCard", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointAuthorizeCreditCard", + "sections": [ + { + "body": "The extension point name extensionPointAuthorizeCreditCard.\n\nThis hook is optional.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAuthorizeCreditCard: \"dw.order.payment.authorizeCreditCard\"", + "source": "script-api", + "tags": [ + "extensionpointauthorizecreditcard", + "paymenthooks.extensionpointauthorizecreditcard" + ], + "title": "PaymentHooks.extensionPointAuthorizeCreditCard" + }, + { + "description": "The extension point name extensionPointCapture.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointCapture", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointCapture", + "sections": [ + { + "body": "The extension point name extensionPointCapture.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCapture: \"dw.order.payment.capture\"", + "source": "script-api", + "tags": [ + "extensionpointcapture", + "paymenthooks.extensionpointcapture" + ], + "title": "PaymentHooks.extensionPointCapture" + }, + { + "description": "The extension point name extensionPointReauthorize.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointReauthorize", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointReauthorize", + "sections": [ + { + "body": "The extension point name extensionPointReauthorize.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointReauthorize: \"dw.order.payment.reauthorize\"", + "source": "script-api", + "tags": [ + "extensionpointreauthorize", + "paymenthooks.extensionpointreauthorize" + ], + "title": "PaymentHooks.extensionPointReauthorize" + }, + { + "description": "The extension point name extensionPointRefund.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointRefund", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointRefund", + "sections": [ + { + "body": "The extension point name extensionPointRefund.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointRefund: \"dw.order.payment.refund\"", + "source": "script-api", + "tags": [ + "extensionpointrefund", + "paymenthooks.extensionpointrefund" + ], + "title": "PaymentHooks.extensionPointRefund" + }, + { + "description": "The extension point name extensionPointReleaseAuthorization.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointReleaseAuthorization", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointReleaseAuthorization", + "sections": [ + { + "body": "The extension point name extensionPointReleaseAuthorization.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointReleaseAuthorization: \"dw.order.payment.releaseAuthorization\"", + "source": "script-api", + "tags": [ + "extensionpointreleaseauthorization", + "paymenthooks.extensionpointreleaseauthorization" + ], + "title": "PaymentHooks.extensionPointReleaseAuthorization" + }, + { + "description": "The extension point name extensionPointValidateAuthorization.", + "id": "script-api:dw/order/hooks/PaymentHooks#extensionPointValidateAuthorization", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.extensionPointValidateAuthorization", + "sections": [ + { + "body": "The extension point name extensionPointValidateAuthorization.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointValidateAuthorization: \"dw.order.payment.validateAuthorization\"", + "source": "script-api", + "tags": [ + "extensionpointvalidateauthorization", + "paymenthooks.extensionpointvalidateauthorization" + ], + "title": "PaymentHooks.extensionPointValidateAuthorization" + }, + { + "description": "The function is called by extension point extensionPointReauthorize. Custom payment authorization - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#reauthorize", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.reauthorize", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointReauthorize. Custom payment authorization - modify the\norder as needed.\n\n- Prerequisite:\n\n[ 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)\nis to be created ready for export to the warehouse system.\n\n[ or ] A dw.order.ShippingOrder is to be directly created using the data api.\n- Context: The related order is passed to the payment hook to check its authorization has not become invalid. Two hooks are called:\n\na. validateAuthorization is used to check the orders authorization is still valid\n\nb. reauthorize is called if step a. returns Error\n\n- Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this).\nIf the order had been previously authorized, the custom property values may be overwritten during reauthorization.\n- Return Status.ERROR: Order is held, authorization needs to be repeated.", + "heading": "Description" + } + ], + "signature": "reauthorize(order: Order): Status", + "source": "script-api", + "tags": [ + "reauthorize", + "paymenthooks.reauthorize" + ], + "title": "PaymentHooks.reauthorize" + }, + { + "description": "The function is called by extension point extensionPointRefund. Custom payment refund - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#refund", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "invoice", + "type": "Invoice" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.refund", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointRefund. Custom payment refund - modify the order as needed.\n\n- Prerequisite:\n\n[ either ] Goods returned by the customer result in the creation of one or more return documents, resulting in the creation of an\nunpaid customer credit invoice (the creation of the invoice is usually handled in dw.order.hooks.ReturnHooks.changeStatus).\n\n[ or ] An unpaid customer credit invoice is created using the data api (perhaps as a result of the creation of a customer appeasement).\n- Context: An unpaid credit invoice is passed to the payment system for refund. The refund attempt can either succeed (complete\ninvoice amount refunded) or fail. As a result the invoice status is updated by ordercenter for further processing. See dw.order.Invoice.\n- Hook responsibility: The hook should attempt to refund the amount located in invoice.grandTotal.grossPrice. When successful,\nthe refund hook should also update the invoice by calling\ndw.order.Invoice.addRefundTransaction\nwhich serves to record the refundedAmount and associate the invoice with the payment-transaction.\n- Return Status.OK: Indicates refund succeeded: Order Center sets the Invoice status to dw.order.Invoice.STATUS_PAID.\n- Return Status.ERROR: Indicates refund failed: Order Center sets the Invoice status to dw.order.Invoice.STATUS_FAILED for\nfurther processing.\n- Post processing: When the refund hook returns with success, order center not only sets the relevant invoice status, but also\nsets the relevant refundAmount values on the invoice item. Returning success means the entire invoice total has been refunded, so each item\nwithin the invoice can also be marked as completely refunded. Note the script implementing the hook can take responsibility for this if desired\norder center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related\norder item can return a refundedAmount, useful for calculating further possible refunds.", + "heading": "Description" + } + ], + "signature": "refund(invoice: Invoice): Status", + "source": "script-api", + "tags": [ + "refund", + "paymenthooks.refund" + ], + "title": "PaymentHooks.refund" + }, + { + "description": "The function is called by extension point extensionPointReleaseAuthorization. Custom payment release authorization - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#releaseAuthorization", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.releaseAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointReleaseAuthorization.\nCustom payment release authorization - modify the order as needed.\n\n- Prerequisite: an authorized order is updated resulting in a need to release the remaining authorization. This happens when:\n\n- order is cancelled\n\n- order is complete after remaining order items are cancelled.\n- Return Status.OK - successful release authorization\n- Return Status.ERROR - failed release authorization", + "heading": "Description" + } + ], + "signature": "releaseAuthorization(order: Order): Status", + "source": "script-api", + "tags": [ + "releaseauthorization", + "paymenthooks.releaseauthorization" + ], + "title": "PaymentHooks.releaseAuthorization" + }, + { + "description": "The function is called by extension point extensionPointValidateAuthorization. Custom payment authorization - modify the order as needed.", + "id": "script-api:dw/order/hooks/PaymentHooks#validateAuthorization", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/PaymentHooks", + "qualifiedName": "dw.order.hooks.PaymentHooks.validateAuthorization", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointValidateAuthorization. Custom payment authorization - modify the\norder as needed.\n\n- Context: This hook is called to validate whether a payment authorization exists for the order. It should usually check:\n\n- Whether the authorize or reauthorize hook was previously successfully executed for the order, e.g. by checking whether custom property has been previously set.\n\n- Whether an existing authorization has expired e.g. by comparing a timestamp set on authorization with the current time.\n- Return Status.OK: indicates the order has a valid payment authorization.\n- Return Status.ERROR: indicates reauthorize should be called.\nSee reauthorize for more details.", + "heading": "Description" + } + ], + "signature": "validateAuthorization(order: Order): Status", + "source": "script-api", + "tags": [ + "validateauthorization", + "paymenthooks.validateauthorization" + ], + "title": "PaymentHooks.validateAuthorization" + }, + { + "description": "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.", + "examples": [ + "\"hooks\": [\n{\"name\": \"dw.order.return.createReturn\", \"script\": \"./returns.ds\"},\n{\"name\": \"dw.order.return.addReturnItem\", \"script\": \"./returns.ds\"},\n{\"name\": \"dw.order.return.changeStatus\", \"script\": \"./returns.ds\"},\n]" + ], + "id": "script-api:dw/order/hooks/ReturnHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.ReturnHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered to\ncustomizing the order center return resource. It contains the extension\npoints (hook names), and the functions that are called by each extension\npoint. A function must be defined inside a JavaScript source and must be\nexported. The script with the exported hook function must be located inside a\nsite cartridge. Inside the site cartridge a 'package.json' file with a\n'hooks' entry must exist.\n\n\"hooks\": \"./hooks.json\"\n\nThe hooks entry links to a json file, relative to the 'package.json' file.\nThis file lists all registered hooks inside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the\nexported hook function.\n\nOverview Return Functionality Business objects\ndw.order.ReturnCase All returns exist in the context of a\ndw.order.ReturnCase, each dw.order.Order can have any number\nof dw.order.ReturnCases.\n\nA dw.order.ReturnCase has dw.order.ReturnCaseItems, each of\nwhich is associated with an dw.order.OrderItem (an extension to\neither a dw.order.ProductLineItem or a\ndw.order.ShippingLineItem).\n\nEach dw.order.ReturnCaseItem defines an\ndw.order.ReturnCaseItem.getAuthorizedQuantity representing the\nmaximum quantity expected to be returned. A dw.order.ReturnCaseItem\nmay be associated with 0..n dw.order.ReturnItems -\ndw.order.ReturnItems are added to the dw.order.ReturnCaseItem\nwhen dw.order.Returns are created.\n\nEither - a dw.order.ReturnCase may be used as an RMA, in which\ncase they are created when a customer first shows a wish to return item(s).\nThe customer then includes the RMA number with the returned item(s). The\ndw.order.Return created as a result is then associated with the\nexisting dw.order.ReturnCase.\n\nOr - a dw.order.ReturnCase is automatically created as part of\nthe return creation, i.e. the customer returns some item(s) leading to a\ncreation of both a dw.order.Return and an associated\ndw.order.ReturnCase.\n\nThe scripting api allows access to the dw.order.ReturnCases, whether\nthe dw.order.ReturnCase is an RMA or not, and the\ndw.order.ReturnCase status. Both the dw.order.ReturnCaseItems\nand any dw.order.Returns associated with the\ndw.order.ReturnCase can be accessed.\n\nA dw.order.ReturnCase has one of these status values:\n\n- New - the dw.order.ReturnCase has been created and can be edited\nprevious to its authorization\n- CONFIRMED - the dw.order.ReturnCase is CONFIRMED, can no longer\nbe edited, no dw.order.Returns have been associated with it. Only an\nNew- dw.order.ReturnCase can be CONFIRMED\n- PARTIAL_RETURNED - the dw.order.ReturnCase has been associated\nwith at least one dw.order.Return, but is not yet complete. Only an\nCONFIRMED- dw.order.ReturnCase can be set to PARTIAL_RETURNED\n- RETURNED - the dw.order.ReturnCase has been associated with\ndw.order.Returns which match the expected authorized quantity. Only\nan CONFIRMED- or PARTIAL_RETURNED- return-case can be set to RETURNED\n- Cancelled - the dw.order.ReturnCase has been cancelled (only a\nNew- or CONFIRMED- dw.order.ReturnCase can be cancelled)\n\ndw.order.Return\nA dw.order.Return represents a physical customer return, and contains\n1..n dw.order.ReturnItems. A dw.order.Return is associated\nwith one dw.order.ReturnCase, and each dw.order.ReturnItem is\nassociated with one dw.order.ReturnCaseItem and (via the\ndw.order.ReturnCaseItem) a single dw.order.OrderItem usually\nrepresenting an dw.order.Order dw.order.ProductLineItem.\n\nA dw.order.ReturnItem records the quantity returned.\n\nA dw.order.Return can have one of these status values:\n\n- NEW - the dw.order.Return is new, i.e. needs to undergo a check\nbefore it can be marked as COMPLETED\n- COMPLETED - the return is complete, this is a precondition for refunding\nthe customer for a return.\n\nCredit Invoice\nAs a result of making a dw.order.Return, the customer may be\nrefunded. The refund amount is held in a credit dw.order.Invoice\nwhich may be associated either with one dw.order.Return\nor with one dw.order.ReturnCase. The dw.order.Invoice\nis passed to the refund payment hook allowing custom code to handle\nthe payment refund.\n\nProcess overview\nCreate dw.order.ReturnCase\nThe creation of dw.order.ReturnCases is supported using the data-api.\nThe api supports, within the context of an dw.order.Order, the\nspecification of an (optional) RMA-number and addition of\ndw.order.ReturnCaseItems for a given order-item and quantity.\nAuthorize dw.order.ReturnCase\nFollowing its creation, a dw.order.ReturnCase needs to be CONFIRMED -\nan CONFIRMED dw.order.ReturnCase cannot be modified.\nCancel dw.order.ReturnCase\nFollowing its creation or authorization, a dw.order.ReturnCase may be\ncancelled.\nCreate dw.order.Return\ndw.order.Returns may be imported or created via the data-api. These\napis specify an (optional) RMA allowing a dw.order.Return to be\nassociated with a dw.order.ReturnCase, and\ndw.order.ReturnItems with a quantity and a key allowing them to be\nassociated with an order-item. The process is delegated to custom scripts\nwhich control the creation of the dw.order.Return and the addition of\nthe dw.order.ReturnItems:\n\nHook extensionPointCreateReturn\nThe creation of the new dw.order.Return is delegated to the custom\nscript when this hook is called, passing the order, and details of the\ndw.order.Return to be created to the script. Typically the script\naccesses the dw.order.ReturnCase from the order and creates the\nreturn with the provided return-number. It may also update the\ndw.order.Order, dw.order.ReturnCase or\ndw.order.Return using custom values passed in the\ndw.order.Return details.\n\n`\n\nexports.createReturn = function (order:Order, returnDetails) {\n\nvar returnNumber=returnDetails.returnNumber;\n\nvar returnCase = order.getReturnCase(returnDetails.returnCaseNumber);\n\nvar newReturn = returnCase.createReturn(returnNumber);\n\nreturn newReturn;\n\n}`\n\nHook extensionPointAddReturnItem\nThis call delegates the creation of individual dw.order.ReturnItems\nto a custom script, passing the dw.order.Order, returnNumber,\nreturnCaseItemId and return-item-details. Typically the script will access\nthe dw.order.ReturnCaseItem from the order and create a new\ndw.order.ReturnItem for it.\n\n`exports.addReturnItem = function (retrn:Return, returnItemDetails) {\n\nvar returnCaseItem = order.getReturnCaseItem(returnCaseItemId);\n\nvar item = returnCaseItem.createReturnItem(returnNr);\n\n`\n\nHook extensionPointChangeStatus\nThis call delegates the update of the return-status to a custom script,\npassing the dw.order.Order, returnNumber and new status. The custom\nscript is responsible for setting the status and taking any other actions\nnecessary, including the possibility of creating a credit invoice:\n\n`changeStatus = function (retrn:Return, status) {\n\nretrn.status=status;\n\n`\n\nHook extensionPointAfterStatusChange\nThis call delegates the update of the return-status to a custom script,\npassing the dw.order.Order, returnNumber and new status. The custom\nscript is responsible for setting the status and taking any other actions\nnecessary, including the possibility of creating a credit invoice:\n\n`changeStatus = function (retrn:Return, status) {\n\nretrn.status=status;\n\n`\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "returnhooks", + "dw.order.hooks.returnhooks", + "dw/order/hooks" + ], + "title": "ReturnHooks" + }, + { + "description": "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.", + "id": "script-api:dw/order/hooks/ReturnHooks#addReturnItem", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "retrn", + "type": "Return" + }, + { + "name": "inputData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.addReturnItem", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The hook provides customization in the process of assigning the returned\namount, quantity etc. Here it is possible to refund differently based on\nthe return reason code for example. Also one could correct the inventory\nbased on the return information. Utilize\ndw.order.ReturnCaseItem.createReturnItem to create a new\ndw.order.ReturnItem.", + "heading": "Description" + } + ], + "signature": "addReturnItem(retrn: Return, inputData: any): Status", + "source": "script-api", + "tags": [ + "addreturnitem", + "returnhooks.addreturnitem" + ], + "title": "ReturnHooks.addReturnItem" + }, + { + "description": "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.", + "id": "script-api:dw/order/hooks/ReturnHooks#afterStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "retrn", + "type": "Return" + } + ], + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.afterStatusChange", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after method changeStatus returns\nStatus.OK. The call is made in a separate database transaction allowing\nthe script implementation to make an independent remote call if desired.", + "heading": "Description" + } + ], + "signature": "afterStatusChange(retrn: Return): Status", + "source": "script-api", + "tags": [ + "afterstatuschange", + "returnhooks.afterstatuschange" + ], + "title": "ReturnHooks.afterStatusChange" + }, + { + "description": "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.", + "id": "script-api:dw/order/hooks/ReturnHooks#changeStatus", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "retrn", + "type": "Return" + }, + { + "name": "inputData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.changeStatus", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Responsible to change the status of a dw.order.Return: the custom\nscript is responsible for setting the new status using\ndw.order.Return.setStatus.\n\nThe invoice handling should be implemented here using\ndw.order.Return.createInvoice or\ndw.order.ReturnCase.createInvoice. For example create an\ndw.order.Invoice for a dw.order.Return moving to status\ndw.order.Return.STATUS_COMPLETED.", + "heading": "Description" + } + ], + "signature": "changeStatus(retrn: Return, inputData: any): Status", + "source": "script-api", + "tags": [ + "changestatus", + "returnhooks.changestatus" + ], + "title": "ReturnHooks.changeStatus" + }, + { + "description": "This hook is responsible for creating a new dw.order.Return, based on a dw.order.ReturnCase. 2 basic workflows are supported:", + "id": "script-api:dw/order/hooks/ReturnHooks#createReturn", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "inputData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.createReturn", + "returns": { + "type": "Return" + }, + "sections": [ + { + "body": "This hook is responsible for creating a new dw.order.Return,\nbased on a dw.order.ReturnCase. 2 basic workflows are supported:\n\n-\nOn-the-fly return: create the parent dw.order.ReturnCase using\ndw.order.Order.createReturnCase.\n-\nReturn-merchandise-authorization (RMA) workflow: resolve an existing\ndw.order.ReturnCase using\ndw.order.Order.getReturnCase.\n\nIn both cases use dw.order.ReturnCase.createReturn to create the dw.order.Return based on the inputData.\n\nAdditional functionality like creating history entry, handling the return\nfees or the shipping cost credit can be implemented in the hook after the\ndw.order.Return is created.", + "heading": "Description" + } + ], + "signature": "createReturn(inputData: any): Return", + "source": "script-api", + "tags": [ + "createreturn", + "returnhooks.createreturn" + ], + "title": "ReturnHooks.createReturn" + }, + { + "description": "The extension point name extensionPointAddReturnItem.", + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointAddReturnItem", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointAddReturnItem", + "sections": [ + { + "body": "The extension point name extensionPointAddReturnItem.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAddReturnItem: \"dw.order.return.addReturnItem\"", + "source": "script-api", + "tags": [ + "extensionpointaddreturnitem", + "returnhooks.extensionpointaddreturnitem" + ], + "title": "ReturnHooks.extensionPointAddReturnItem" + }, + { + "description": "The extension point name extensionPointAfterStatusChange.", + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointAfterStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointAfterStatusChange", + "sections": [ + { + "body": "The extension point name extensionPointAfterStatusChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAfterStatusChange: \"dw.order.return.afterStatusChange\"", + "source": "script-api", + "tags": [ + "extensionpointafterstatuschange", + "returnhooks.extensionpointafterstatuschange" + ], + "title": "ReturnHooks.extensionPointAfterStatusChange" + }, + { + "description": "The extension point name extensionPointChangeStatus.", + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointChangeStatus", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointChangeStatus", + "sections": [ + { + "body": "The extension point name extensionPointChangeStatus.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointChangeStatus: \"dw.order.return.changeStatus\"", + "source": "script-api", + "tags": [ + "extensionpointchangestatus", + "returnhooks.extensionpointchangestatus" + ], + "title": "ReturnHooks.extensionPointChangeStatus" + }, + { + "description": "The extension point name extensionPointCreateReturn.", + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointCreateReturn", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointCreateReturn", + "sections": [ + { + "body": "The extension point name extensionPointCreateReturn.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCreateReturn: \"dw.order.return.createReturn\"", + "source": "script-api", + "tags": [ + "extensionpointcreatereturn", + "returnhooks.extensionpointcreatereturn" + ], + "title": "ReturnHooks.extensionPointCreateReturn" + }, + { + "description": "The extension point name extensionPointNotifyStatusChange.", + "id": "script-api:dw/order/hooks/ReturnHooks#extensionPointNotifyStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.extensionPointNotifyStatusChange", + "sections": [ + { + "body": "The extension point name extensionPointNotifyStatusChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointNotifyStatusChange: \"dw.order.return.notifyStatusChange\"", + "source": "script-api", + "tags": [ + "extensionpointnotifystatuschange", + "returnhooks.extensionpointnotifystatuschange" + ], + "title": "ReturnHooks.extensionPointNotifyStatusChange" + }, + { + "description": "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", + "id": "script-api:dw/order/hooks/ReturnHooks#notifyStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "retrn", + "type": "Return" + } + ], + "parentId": "script-api:dw/order/hooks/ReturnHooks", + "qualifiedName": "dw.order.hooks.ReturnHooks.notifyStatusChange", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called after method changeStatus returns\nStatus.OK (and after method afterStatusChange)\nto inform of a successful status change. The call is made outside any\ndatabase transaction. This is the best hook in which to send customer\nnotifications as the status change has already been successfully written\nto the database", + "heading": "Description" + } + ], + "signature": "notifyStatusChange(retrn: Return): Status", + "source": "script-api", + "tags": [ + "notifystatuschange", + "returnhooks.notifystatuschange" + ], + "title": "ReturnHooks.notifyStatusChange" + }, + { + "description": "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.", + "examples": [ + "\"hooks\": [\n{\"name\": \"dw.order.shippingorder.updateShippingOrderItem\", \"script\": \"./shippingOrderUpdate.ds\"},\n]" + ], + "id": "script-api:dw/order/hooks/ShippingOrderHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks", + "sections": [ + { + "body": "This interface represents all script hooks that can be registered around\nshipping order lifecycle. It contains the extension points (hook names), and\nthe functions that are called by each extension point. A function must be\ndefined inside a JavaScript source and must be exported. The script with the\nexported hook function must be located inside a site cartridge. Inside the\nsite cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\"hooks\": \"./hooks.json\"\n\nThe hooks entry links to a json file, relative to the 'package.json' file.\nThis file lists all registered hooks inside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the\nexported hook function.\n\nOrder post-processing APIs (gillian) are now inactive by default and will throw\nan exception if accessed. Activation needs preliminary approval by Product Management.\nPlease contact support in this case. Existing customers using these APIs are not\naffected by this change and can use the APIs until further notice.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "shippingorderhooks", + "dw.order.hooks.shippingorderhooks", + "dw/order/hooks" + ], + "title": "ShippingOrderHooks" + }, + { + "description": "After Status change hook.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#afterStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "shippingOrder", + "type": "ShippingOrder" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.afterStatusChange", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "After Status change hook.\n\nThe function is called by extension point\nextensionPointAfterStatusChange.\n\nThe implementation of this hook is optional. If defined the hook is\ncalled after extensionPointChangeStatus or respectively after\nextensionPointShippingOrderShipped,\nextensionPointShippingOrderCancelled or\nextensionPointShippingOrderWarehouse\n\nRuns inside of a transaction.", + "heading": "Description" + } + ], + "signature": "afterStatusChange(shippingOrder: ShippingOrder): Status", + "source": "script-api", + "tags": [ + "afterstatuschange", + "shippingorderhooks.afterstatuschange" + ], + "title": "ShippingOrderHooks.afterStatusChange" + }, + { + "description": "Change the status of a shipping order.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#changeStatus", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "shippingOrder", + "type": "ShippingOrder" + }, + { + "name": "updateData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.changeStatus", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Change the status of a shipping order.\n\nThe function is called by extension point\nextensionPointChangeStatus.\n\nRuns inside a transaction together with the hooks\nextensionPointResolveShippingOrder\nextensionPointUpdateShippingOrderItem.\n\nRuns after the iteration over the input's items collection as the last\nstep in this transaction. The implementation of this hook is mandatory.", + "heading": "Description" + } + ], + "signature": "changeStatus(shippingOrder: ShippingOrder, updateData: any): Status", + "source": "script-api", + "tags": [ + "changestatus", + "shippingorderhooks.changestatus" + ], + "title": "ShippingOrderHooks.changeStatus" + }, + { + "description": "Called during shipping order creation for an order.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#createShippingOrders", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.createShippingOrders", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called during shipping order creation for an order.\n\nThe function is called by extension point\nextensionPointCreateShippingOrders. It is responsible for\ncreating shipping orders and its items for the order. Preparations for\nshipping order creation can be done before in hook\nextensionPointPrepareCreateShippingOrders.\n\nRuns inside of a transaction. The implementation of this hook is\nmandatory.", + "heading": "Description" + } + ], + "signature": "createShippingOrders(order: Order): Status", + "source": "script-api", + "tags": [ + "createshippingorders", + "shippingorderhooks.createshippingorders" + ], + "title": "ShippingOrderHooks.createShippingOrders" + }, + { + "description": "The extension point name extensionPointAfterStatusChange.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointAfterStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointAfterStatusChange", + "sections": [ + { + "body": "The extension point name extensionPointAfterStatusChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAfterStatusChange: \"dw.order.shippingorder.afterStatusChange\"", + "source": "script-api", + "tags": [ + "extensionpointafterstatuschange", + "shippingorderhooks.extensionpointafterstatuschange" + ], + "title": "ShippingOrderHooks.extensionPointAfterStatusChange" + }, + { + "description": "The extension point name extensionPointChangeStatus.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointChangeStatus", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointChangeStatus", + "sections": [ + { + "body": "The extension point name extensionPointChangeStatus.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointChangeStatus: \"dw.order.shippingorder.changeStatus\"", + "source": "script-api", + "tags": [ + "extensionpointchangestatus", + "shippingorderhooks.extensionpointchangestatus" + ], + "title": "ShippingOrderHooks.extensionPointChangeStatus" + }, + { + "description": "The extension point name extensionPointCreateShippingOrders.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointCreateShippingOrders", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointCreateShippingOrders", + "sections": [ + { + "body": "The extension point name extensionPointCreateShippingOrders.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointCreateShippingOrders: \"dw.order.shippingorder.createShippingOrders\"", + "source": "script-api", + "tags": [ + "extensionpointcreateshippingorders", + "shippingorderhooks.extensionpointcreateshippingorders" + ], + "title": "ShippingOrderHooks.extensionPointCreateShippingOrders" + }, + { + "description": "The extension point name extensionPointNotifyStatusChange.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointNotifyStatusChange", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointNotifyStatusChange", + "sections": [ + { + "body": "The extension point name extensionPointNotifyStatusChange.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointNotifyStatusChange: \"dw.order.shippingorder.notifyStatusChange\"", + "source": "script-api", + "tags": [ + "extensionpointnotifystatuschange", + "shippingorderhooks.extensionpointnotifystatuschange" + ], + "title": "ShippingOrderHooks.extensionPointNotifyStatusChange" + }, + { + "description": "The extension point name extensionPointPrepareCreateShippingOrders.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointPrepareCreateShippingOrders", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointPrepareCreateShippingOrders", + "sections": [ + { + "body": "The extension point name\nextensionPointPrepareCreateShippingOrders.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointPrepareCreateShippingOrders: \"dw.order.shippingorder.prepareCreateShippingOrders\"", + "source": "script-api", + "tags": [ + "extensionpointpreparecreateshippingorders", + "shippingorderhooks.extensionpointpreparecreateshippingorders" + ], + "title": "ShippingOrderHooks.extensionPointPrepareCreateShippingOrders" + }, + { + "description": "The extension point name extensionPointResolveShippingOrder .", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointResolveShippingOrder", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointResolveShippingOrder", + "sections": [ + { + "body": "The extension point name extensionPointResolveShippingOrder .", + "heading": "Description" + } + ], + "signature": "readonly extensionPointResolveShippingOrder: \"dw.order.shippingorder.resolveShippingOrder\"", + "source": "script-api", + "tags": [ + "extensionpointresolveshippingorder", + "shippingorderhooks.extensionpointresolveshippingorder" + ], + "title": "ShippingOrderHooks.extensionPointResolveShippingOrder" + }, + { + "description": "The extension point name extensionPointShippingOrderCancelled.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderCancelled", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderCancelled", + "sections": [ + { + "body": "The extension point name extensionPointShippingOrderCancelled.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingOrderCancelled: \"dw.order.shippingorder.setShippingOrderCancelled\"", + "source": "script-api", + "tags": [ + "extensionpointshippingordercancelled", + "shippingorderhooks.extensionpointshippingordercancelled" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderCancelled" + }, + { + "description": "The extension point name extensionPointShippingOrderShipped.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderShipped", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderShipped", + "sections": [ + { + "body": "The extension point name extensionPointShippingOrderShipped.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingOrderShipped: \"dw.order.shippingorder.setShippingOrderShipped\"", + "source": "script-api", + "tags": [ + "extensionpointshippingordershipped", + "shippingorderhooks.extensionpointshippingordershipped" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderShipped" + }, + { + "description": "The extension point name extensionPointShippingOrderWarehouse.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointShippingOrderWarehouse", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointShippingOrderWarehouse", + "sections": [ + { + "body": "The extension point name extensionPointShippingOrderWarehouse.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointShippingOrderWarehouse: \"dw.order.shippingorder.setShippingOrderWarehouse\"", + "source": "script-api", + "tags": [ + "extensionpointshippingorderwarehouse", + "shippingorderhooks.extensionpointshippingorderwarehouse" + ], + "title": "ShippingOrderHooks.extensionPointShippingOrderWarehouse" + }, + { + "description": "The extension point name extensionPointUpdateShippingOrderItem.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#extensionPointUpdateShippingOrderItem", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.extensionPointUpdateShippingOrderItem", + "sections": [ + { + "body": "The extension point name extensionPointUpdateShippingOrderItem.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointUpdateShippingOrderItem: \"dw.order.shippingorder.updateShippingOrderItem\"", + "source": "script-api", + "tags": [ + "extensionpointupdateshippingorderitem", + "shippingorderhooks.extensionpointupdateshippingorderitem" + ], + "title": "ShippingOrderHooks.extensionPointUpdateShippingOrderItem" + }, + { + "description": "Notify Status change hook.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#notifyStatusChange", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "shippingOrder", + "type": "ShippingOrder" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.notifyStatusChange", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Notify Status change hook.\n\nThe function is called by extension point\nextensionPointNotifyStatusChange.\n\nThe implementation of this hook is optional. If defined the hook is\ncalled after extensionPointAfterStatusChange as the last step\nin the shipping order update process.\n\nRuns outside of a transaction.", + "heading": "Description" + } + ], + "signature": "notifyStatusChange(shippingOrder: ShippingOrder): Status", + "source": "script-api", + "tags": [ + "notifystatuschange", + "shippingorderhooks.notifystatuschange" + ], + "title": "ShippingOrderHooks.notifyStatusChange" + }, + { + "description": "Called before shipping order creation for an order takes place. Typically the hook is used to check the payment authorization status of the order.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#prepareCreateShippingOrders", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.prepareCreateShippingOrders", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Called before shipping order creation for an order takes place. Typically\nthe hook is used to check the payment authorization status of the order.\n\nThe function is called by extension point\nextensionPointPrepareCreateShippingOrders.\n\nRuns inside its own transaction. The value of the return status is used\nto control whether hook createShippingOrders is called\nfor the order or not. The implementation of this hook is mandatory.", + "heading": "Description" + } + ], + "signature": "prepareCreateShippingOrders(order: Order): Status", + "source": "script-api", + "tags": [ + "preparecreateshippingorders", + "shippingorderhooks.preparecreateshippingorders" + ], + "title": "ShippingOrderHooks.prepareCreateShippingOrders" + }, + { + "description": "Resolve the shipping order. Will be called as first step of the update.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#resolveShippingOrder", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "updateData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.resolveShippingOrder", + "returns": { + "type": "ShippingOrder" + }, + "sections": [ + { + "body": "Resolve the shipping order. Will be called as first step of the update.\n\nThe function is called by extension point\nextensionPointResolveShippingOrder.\n\nRuns inside a transaction together with the hooks\n\nextensionPointUpdateShippingOrderItem\nextensionPointChangeStatus. The implementation of this hook is\nmandatory.", + "heading": "Description" + } + ], + "signature": "resolveShippingOrder(updateData: any): ShippingOrder", + "source": "script-api", + "tags": [ + "resolveshippingorder", + "shippingorderhooks.resolveshippingorder" + ], + "title": "ShippingOrderHooks.resolveShippingOrder" + }, + { + "description": "Change the status of a shipping order to cancelled.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderCancelled", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "updateData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderCancelled", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Change the status of a shipping order to cancelled.\n\nThe function is called by extension point\nextensionPointShippingOrderCancelled.\n\nThis is an optional hook that can be implemented to have full control\nover status change to destination status Cancelled. The following hooks\nwill be skipped if an implementation for this hook is registered:\nextensionPointResolveShippingOrder,\nextensionPointUpdateShippingOrderItem,\nextensionPointChangeStatus.\n\nRuns inside of a transaction.", + "heading": "Description" + } + ], + "signature": "setShippingOrderCancelled(updateData: any): Order", + "source": "script-api", + "tags": [ + "setshippingordercancelled", + "shippingorderhooks.setshippingordercancelled" + ], + "title": "ShippingOrderHooks.setShippingOrderCancelled" + }, + { + "description": "Change the status of a shipping order to shipped.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderShipped", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "updateData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderShipped", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Change the status of a shipping order to shipped.\n\nThe function is called by extension point\nextensionPointShippingOrderShipped.\n\nThis is an optional hook that can be implemented to have full control\nover status change to destination status Shipped. The following hooks\nwill be skipped if an implementation for this hook is registered:\nextensionPointResolveShippingOrder\nextensionPointUpdateShippingOrderItem,\nextensionPointChangeStatus.\n\nRuns inside of a transaction.", + "heading": "Description" + } + ], + "signature": "setShippingOrderShipped(updateData: any): Order", + "source": "script-api", + "tags": [ + "setshippingordershipped", + "shippingorderhooks.setshippingordershipped" + ], + "title": "ShippingOrderHooks.setShippingOrderShipped" + }, + { + "description": "Change the status of a shipping order to warehouse.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#setShippingOrderWarehouse", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "updateData", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.setShippingOrderWarehouse", + "returns": { + "type": "Order" + }, + "sections": [ + { + "body": "Change the status of a shipping order to warehouse.\n\nThe function is called by extension point\nextensionPointShippingOrderWarehouse.\n\nThis is an optional hook that can be implemented to have full control\nover status change to destination status Warehouse. The following hooks\nwill be skipped if an implementation for this hook is registered:\nextensionPointResolveShippingOrder,\nextensionPointUpdateShippingOrderItem,\nextensionPointChangeStatus.\n\nRuns inside of a transaction.", + "heading": "Description" + } + ], + "signature": "setShippingOrderWarehouse(updateData: any): Order", + "source": "script-api", + "tags": [ + "setshippingorderwarehouse", + "shippingorderhooks.setshippingorderwarehouse" + ], + "title": "ShippingOrderHooks.setShippingOrderWarehouse" + }, + { + "description": "Updates the status of a shipping order item.", + "id": "script-api:dw/order/hooks/ShippingOrderHooks#updateShippingOrderItem", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "shippingOrder", + "type": "ShippingOrder" + }, + { + "name": "updateItem", + "type": "any" + } + ], + "parentId": "script-api:dw/order/hooks/ShippingOrderHooks", + "qualifiedName": "dw.order.hooks.ShippingOrderHooks.updateShippingOrderItem", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Updates the status of a shipping order item.\n\nThe function is called by extension point\nextensionPointUpdateShippingOrderItem.\n\nRuns inside a transaction together with the hooks\n\nextensionPointResolveShippingOrder\nextensionPointChangeStatus. The implementation of this hook is\nmandatory.", + "heading": "Description" + } + ], + "signature": "updateShippingOrderItem(shippingOrder: ShippingOrder, updateItem: any): Status", + "source": "script-api", + "tags": [ + "updateshippingorderitem", + "shippingorderhooks.updateshippingorderitem" + ], + "title": "ShippingOrderHooks.updateShippingOrderItem" + }, + { + "description": "This interface represents tax extension points for Commerce App tax providers.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"sfcc.app.tax.calculate\", \"script\": \"./calculate.js\"},\n{\"name\": \"sfcc.app.tax.commit\", \"script\": \"./commit.js\"},\n{\"name\": \"sfcc.app.tax.cancel\", \"script\": \"./cancel.js\"}\n]", + "return new Status(Status.ERROR, 'TAX_COMMIT_FAILED', 'Details about the failure');", + "throw new Error('Tax provider unavailable');", + "return new Status(Status.ERROR, 'TAX_CANCEL_FAILED', 'Details about the failure');" + ], + "id": "script-api:dw/order/hooks/TaxHooks", + "kind": "interface", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks", + "qualifiedName": "dw.order.hooks.TaxHooks", + "sections": [ + { + "body": "This interface represents tax extension points for Commerce App tax providers.\n\nThese hooks provide integration points for external tax calculation services installed via the Commerce App\nframework. They are distinct from the legacy `dw.order.calculateTax` extension point.\n\nIMPORTANT: These hooks should only be implemented and registered by Commerce Apps\n(applications installed via the Commerce App framework with a CAP file). They are not intended for custom merchant\ncartridges or storefront implementations. Merchants who want custom tax calculation logic should use the legacy\n`dw.order.calculateTax` extension point instead.\n\nHook Registration A function must be defined inside a JavaScript source and must be exported. The script\nwith the exported hook function must be located inside a site cartridge. Inside the site cartridge a\n`package.json` file with a 'hooks' entry must exist:\n\n\nThe hooks entry links to a JSON file, relative to the `package.json` file. This file lists all registered\nhooks inside the hooks property:\n\n\nA hook entry has a `name` and a `script` property:\n\n- The `name` contains the extension point name (the hook name).\n- The `script` contains the script path relative to the hooks file, with the exported hook\nfunction.\n\nFunction Naming Convention: The exported JavaScript function name must match the last segment of the\nextension point name, for example, `calculate`, `commit`, `cancel`..\n\nOrder Lifecycle Context Each hook fires at a specific point in the order lifecycle:\n\n- calculate: Fires during basket calculation on every basket operation (e.g., adding items,\nchanging quantities, updating shipping). Calculates tax amounts for the basket line items.\n- commit: Fires immediately after successful order creation (order status `CREATED`).\nNotifies the tax provider that the order has been created and tax amounts should be committed.\n- cancel: Fires on order cancellation or failure. Notifies the tax provider to void or cancel\npreviously committed tax amounts.\n\nHook Precedence\n\n- When `sfcc.app.tax.calculate` is registered, it takes precedence over the legacy\n`dw.order.calculateTax` hook.\n- If the Commerce App hook is not registered, the platform falls back to `dw.order.calculateTax` (if\nregistered).\n- If neither hook is available, the platform uses default platform tax calculation.\n\nImportant: If you override the `dw.order.calculate` hook (the parent basket calculation\nhook), the platform's tax hook selection logic is bypassed entirely. In this case, if you want to use Commerce App\ntax providers, you must manually invoke the `sfcc.app.tax.calculate` hook from within your custom\n`dw.order.calculate` implementation.\n\nSCAPI Behavior\n\nSCAPI requests with `ScapiHookExecutionEnabled` disabled bypass all hooks (both Commerce App tax hooks and\nthe legacy `dw.order.calculateTax` hook) and go straight to the default platform tax calculation.\n\nHook Arguments and Return Types\n\n- calculate: Receives a `dw.order.LineItemCtnr` (typically a\n`dw.order.Basket`) as the first argument. Must return a `dw.system.Status` object (or\n`null` for success).\n- commit: Receives a `dw.order.Order` object as the first argument. Must return a\n`dw.system.Status` object (or `null` for success).\n- cancel: Receives a `dw.order.Order` object as the first argument. Must return a\n`dw.system.Status` object (or `null` for success).\n\nError Handling\nFor calculate hook:\n\n- Always blocks on error: Both returning a `Status.ERROR` and throwing an exception\nprevent the basket calculation from completing successfully. The platform logs the error and halts the current basket\noperation. Since order creation requires a successful basket calculation, this also prevents orders from being\ncreated with incorrect tax amounts.\n\nFor commit hook:\n\nThe Commerce App developer chooses whether errors should block order creation by how they handle errors in their hook\nimplementation:\n\n- Non-blocking error: Catch exceptions and return a `Status.ERROR`. The platform logs\nthe error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily\nunavailable but the order should still be created.\n\n\n- Blocking error: Let exceptions propagate (don't catch them). The platform logs the error and\nrolls back the order lifecycle operation, preventing the order from being created.\n\n\nFor cancel hook:\n\nThe Commerce App developer chooses whether errors should block order cancellation by how they handle errors in their\nhook implementation:\n\n- Non-blocking error: Catch exceptions and return a `Status.ERROR`. The platform logs\nthe error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily\nunavailable but the order cancellation should still proceed.\n\n\n- Blocking error: Let exceptions propagate (don't catch them). The platform logs the error and\nrolls back the order cancellation operation.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "taxhooks", + "dw.order.hooks.taxhooks", + "dw/order/hooks" + ], + "title": "TaxHooks" + }, + { + "description": "The function is called by extension point extensionPointAppCalculateTax. It calculates tax amounts for the basket line items during basket calculation. This hook fires on every basket operation (e.g., adding items, changing quantities, updating shipping), not only before order creation.", + "examples": [ + "function calculate(basket) {\nvar TaxMgr = require('dw/order/TaxMgr');\nvar Status = require('dw/system/Status');\nvar HTTPClient = require('dw/net/HTTPClient');\n\n// 1. Extract shipping address and line items\nvar shipment = basket.getDefaultShipment();\nvar shippingAddress = shipment.getShippingAddress();\n\n// 2. Build request for external tax provider\nvar taxRequest = {\naddresses: {\nshipTo: {\nline1: shippingAddress.getAddress1(),\ncity: shippingAddress.getCity(),\nregion: shippingAddress.getStateCode(),\ncountry: shippingAddress.getCountryCode().getValue(),\npostalCode: shippingAddress.getPostalCode()\n}\n},\nlines: []\n};\n\n// Add product line items\nvar pliIterator = basket.getProductLineItems().iterator();\nwhile (pliIterator.hasNext()) {\nvar pli = pliIterator.next();\ntaxRequest.lines.push({\nitemCode: pli.getProductID(),\nquantity: pli.getQuantityValue(),\namount: pli.getAdjustedPrice().getValue(),\ntaxCode: pli.getTaxClassID() // Product tax category\n});\n}\n\n// 3. Call external tax service\nvar httpClient = new HTTPClient();\nhttpClient.open('POST', 'https://api.taxprovider.com/calculate');\nhttpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);\nhttpClient.send(JSON.stringify(taxRequest));\n\nif (httpClient.statusCode !== 200) {\nreturn new Status(Status.ERROR, 'TAX_CALC_FAILED', 'Tax calculation failed: ' + httpClient.errorText);\n}\n\nvar taxResponse = JSON.parse(httpClient.text);\n\n// 4. Apply tax amounts to basket line items using TaxMgr\ntaxResponse.lines.forEach(function(line, index) {\nvar pli = basket.getProductLineItems()[index];\nTaxMgr.setProductLineTax(pli, line.tax);\n});\n\n// Set shipping tax if applicable\nif (taxResponse.shippingTax) {\nTaxMgr.setShippingTax(shipment, taxResponse.shippingTax);\n}\n\nreturn new Status(Status.OK);\n}\n\nexports.calculate = calculate;" + ], + "id": "script-api:dw/order/hooks/TaxHooks#calculate", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "lineItemCtnr", + "type": "LineItemCtnr" + } + ], + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.calculate", + "returns": { + "type": "Status | null" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointAppCalculateTax. It calculates tax amounts for\nthe basket line items during basket calculation. This hook fires on every basket operation (e.g., adding items,\nchanging quantities, updating shipping), not only before order creation.\n\nNote: If the `dw.order.calculate` hook is overridden, the platform's automatic tax\nhook selection is bypassed. You must manually invoke this hook from within your custom\n`dw.order.calculate` implementation if you want to use Commerce App tax providers.\n\nError Handling: Both returning a `Status.ERROR` and throwing an exception will\nprevent the basket calculation from completing successfully. The platform logs the error and halts the current\nbasket operation. Since order creation requires a successful basket calculation, this also prevents orders from\nbeing created with incorrect tax amounts.\n\nSCAPI Behavior: When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass\nthis hook and use default platform tax calculation.\n\nSample Implementation:\n\n\nCommon APIs used: `dw.order.TaxMgr` (setProductLineTax, setShippingTax),\ndw.net.HTTPClient, `dw.order.LineItemCtnr` (getProductLineItems, getShipments),\n`dw.order.ProductLineItem` (getProductID, getTaxClassID), `dw.order.OrderAddress`\n(getAddress1, getCity, getStateCode).", + "heading": "Description" + } + ], + "signature": "calculate(lineItemCtnr: LineItemCtnr): Status | null", + "source": "script-api", + "tags": [ + "calculate", + "taxhooks.calculate" + ], + "title": "TaxHooks.calculate" + }, + { + "description": "The function is called by extension point extensionPointAppCancelTax during OrderMgr.failOrder() or OrderMgr.cancelOrder(). It notifies the Commerce App tax provider that the order has been cancelled or has failed, and that previously committed tax amounts should be voided or cancelled in the tax provider.", + "examples": [ + "function cancel(order) {\nvar Status = require('dw/system/Status');\nvar HTTPClient = require('dw/net/HTTPClient');\n\n// 1. Retrieve the external transaction ID stored during commit\nvar taxProviderTransactionId = order.custom.taxProviderTransactionId;\n\nif (!taxProviderTransactionId) {\n// No transaction to cancel - tax was never committed\nreturn new Status(Status.OK);\n}\n\n// 2. Build void/cancel request for external tax provider\nvar cancelRequest = {\ncode: order.getOrderNo(),\ntype: 'SalesInvoice'\n};\n\n// 3. Call external tax service to void/cancel the transaction\nvar httpClient = new HTTPClient();\nhttpClient.open('POST', 'https://api.taxprovider.com/transactions/' + taxProviderTransactionId + '/void');\nhttpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);\nhttpClient.send(JSON.stringify(cancelRequest));\n\nif (httpClient.statusCode !== 200 && httpClient.statusCode !== 204) {\n// Non-blocking error: log warning but allow order cancellation to proceed\nreturn new Status(Status.ERROR, 'TAX_CANCEL_FAILED',\n'Failed to void tax transaction in provider, order cancellation will proceed. Error: ' + httpClient.errorText);\n}\n\nreturn new Status(Status.OK);\n}\n\nexports.cancel = cancel;" + ], + "id": "script-api:dw/order/hooks/TaxHooks#cancel", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.cancel", + "returns": { + "type": "Status | null" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointAppCancelTax during OrderMgr.failOrder() or\nOrderMgr.cancelOrder(). It notifies the Commerce App tax provider that the order has been cancelled or has\nfailed, and that previously committed tax amounts should be voided or cancelled in the tax provider.\n\nError Handling:\n\n- Non-blocking error: Return `Status.ERROR`. The platform logs the error as a\nwarning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the\norder cancellation should still proceed.\n- Blocking error: Throw an exception. The platform logs the error and rolls back the order\nlifecycle operation.\n\nSCAPI Behavior: When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass\nthis hook.\n\nSample Implementation:\n\n\nCommon APIs used: dw.net.HTTPClient, `dw.order.Order` (getOrderNo, custom\nattributes), dw.system.Status.", + "heading": "Description" + } + ], + "signature": "cancel(order: Order): Status | null", + "source": "script-api", + "tags": [ + "cancel", + "taxhooks.cancel" + ], + "title": "TaxHooks.cancel" + }, + { + "description": "The function is called by extension point extensionPointAppCommitTax during order creation in the order creation transaction. It notifies the Commerce App tax provider that the order has been successfully created and that tax amounts should be committed to the tax provider. The order is in `CREATED` status at this point (before being placed).", + "examples": [ + "function commit(order) {\nvar Transaction = require('dw/system/Transaction');\nvar Status = require('dw/system/Status');\nvar HTTPClient = require('dw/net/HTTPClient');\n\n// 1. Build commit request for external tax provider\nvar commitRequest = {\ncode: order.getOrderNo(), // Use order number as unique transaction ID\ntype: 'SalesInvoice',\ncompanyCode: 'DEFAULT',\ndate: order.getCreationDate(),\ncustomerCode: order.getCustomerNo(),\naddresses: {\nshipTo: {\nline1: order.getDefaultShipment().getShippingAddress().getAddress1(),\ncity: order.getDefaultShipment().getShippingAddress().getCity(),\nregion: order.getDefaultShipment().getShippingAddress().getStateCode(),\ncountry: order.getDefaultShipment().getShippingAddress().getCountryCode().getValue(),\npostalCode: order.getDefaultShipment().getShippingAddress().getPostalCode()\n}\n},\nlines: [],\ncommit: true // Tell provider to commit the transaction\n};\n\n// Add order line items\nvar pliIterator = order.getProductLineItems().iterator();\nwhile (pliIterator.hasNext()) {\nvar pli = pliIterator.next();\ncommitRequest.lines.push({\nitemCode: pli.getProductID(),\nquantity: pli.getQuantityValue(),\namount: pli.getAdjustedPrice().getValue(),\ntax: pli.getAdjustedTax().getValue()\n});\n}\n\n// 2. Call external tax service to commit transaction\nvar httpClient = new HTTPClient();\nhttpClient.open('POST', 'https://api.taxprovider.com/transactions');\nhttpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);\nhttpClient.send(JSON.stringify(commitRequest));\n\nif (httpClient.statusCode !== 200 && httpClient.statusCode !== 201) {\n// Non-blocking error: log warning but allow order to proceed\nreturn new Status(Status.ERROR, 'TAX_COMMIT_FAILED',\n'Failed to commit tax to provider, order will proceed. Error: ' + httpClient.errorText);\n}\n\nvar commitResponse = JSON.parse(httpClient.text);\n\n// 3. Store external transaction ID in order custom attribute for later reference (cancel/refund)\nTransaction.wrap(function() {\norder.custom.taxProviderTransactionId = commitResponse.id;\n});\n\nreturn new Status(Status.OK);\n}\n\nexports.commit = commit;" + ], + "id": "script-api:dw/order/hooks/TaxHooks#commit", + "kind": "method", + "packagePath": "dw/order/hooks", + "params": [ + { + "name": "order", + "type": "Order" + } + ], + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.commit", + "returns": { + "type": "Status | null" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointAppCommitTax during order creation in the order\ncreation transaction. It notifies the Commerce App tax provider that the order has been successfully created and\nthat tax amounts should be committed to the tax provider. The order is in `CREATED` status at this\npoint (before being placed).\n\nError Handling:\n\n- Non-blocking error: Return `Status.ERROR`. The platform logs the error as a\nwarning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the\norder should still be created.\n- Blocking error: Throw an exception. The platform logs the error and rolls back the order\nlifecycle operation, preventing the order from being created.\n\nSCAPI Behavior: When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass\nthis hook.\n\nSample Implementation:\n\n\nCommon APIs used: dw.system.Transaction, dw.net.HTTPClient, `dw.order.Order`\n(getOrderNo, getProductLineItems, getDefaultShipment, custom attributes), `dw.order.ProductLineItem`\n(getAdjustedTax).", + "heading": "Description" + } + ], + "signature": "commit(order: Order): Status | null", + "source": "script-api", + "tags": [ + "commit", + "taxhooks.commit" + ], + "title": "TaxHooks.commit" + }, + { + "description": "The extension point name extensionPointAppCalculateTax.", + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCalculateTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCalculateTax", + "sections": [ + { + "body": "The extension point name extensionPointAppCalculateTax.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAppCalculateTax: \"sfcc.app.tax.calculate\"", + "source": "script-api", + "tags": [ + "extensionpointappcalculatetax", + "taxhooks.extensionpointappcalculatetax" + ], + "title": "TaxHooks.extensionPointAppCalculateTax" + }, + { + "description": "The extension point name extensionPointAppCancelTax.", + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCancelTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCancelTax", + "sections": [ + { + "body": "The extension point name extensionPointAppCancelTax.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAppCancelTax: \"sfcc.app.tax.cancel\"", + "source": "script-api", + "tags": [ + "extensionpointappcanceltax", + "taxhooks.extensionpointappcanceltax" + ], + "title": "TaxHooks.extensionPointAppCancelTax" + }, + { + "description": "The extension point name extensionPointAppCommitTax.", + "id": "script-api:dw/order/hooks/TaxHooks#extensionPointAppCommitTax", + "kind": "property", + "packagePath": "dw/order/hooks", + "parentId": "script-api:dw/order/hooks/TaxHooks", + "qualifiedName": "dw.order.hooks.TaxHooks.extensionPointAppCommitTax", + "sections": [ + { + "body": "The extension point name extensionPointAppCommitTax.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointAppCommitTax: \"sfcc.app.tax.commit\"", + "source": "script-api", + "tags": [ + "extensionpointappcommittax", + "taxhooks.extensionpointappcommittax" + ], + "title": "TaxHooks.extensionPointAppCommitTax" + }, + { + "description": "3 declarations", + "id": "script-api:dw/rpc", + "kind": "package", + "packagePath": "dw/rpc", + "qualifiedName": "dw.rpc", + "source": "script-api", + "tags": [ + "dw/rpc", + "dw.rpc" + ], + "title": "dw.rpc" + }, + { + "deprecated": { + "message": "This class is deprecated, please use webreferences2 instead (see also dw.ws.WSUtil)." + }, + "description": "Utility class for working with SOAP web services. This class provides methods for setting SOAP headers and a set of constants representing the supported header names.", + "id": "script-api:dw/rpc/SOAPUtil", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.SOAPUtil", + "sections": [ + { + "body": "Utility class for working with SOAP web services. This class provides\nmethods for setting SOAP headers and a set of constants representing the\nsupported header names.\n\nIf you want to use ws-security features, such as signing and encryption,\nwith your RPC-style SOAP web service, use this class to construct a HashMap with\nsecurity constants and values.\n\nNote: this method handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.\nThe following example configures the ws-security actions taken for the request and response to a web service.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "soaputil", + "dw.rpc.soaputil", + "dw/rpc" + ], + "title": "SOAPUtil" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action property name. Allowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or a space separated String with multiple values.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ACTION", + "sections": [ + { + "body": "WS-Security action property name.\nAllowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or\na space separated String with multiple values.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ACTION = \"action\"", + "source": "script-api", + "tags": [ + "ws_action", + "soaputil.ws_action" + ], + "title": "SOAPUtil.WS_ACTION" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action property name. Allowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or a space separated String with multiple values.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ACTION", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ACTION", + "sections": [ + { + "body": "WS-Security action property name.\nAllowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or\na space separated String with multiple values.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ACTION = \"action\"", + "source": "script-api", + "tags": [ + "ws_action", + "soaputil.ws_action" + ], + "title": "SOAPUtil.WS_ACTION" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: encrypt the message. The encryption-specific parameters define how to encrypt, which keys to use, and other parameters.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPT", + "sections": [ + { + "body": "WS-Security action: encrypt the message.\nThe encryption-specific parameters define how to encrypt, which keys\nto use, and other parameters.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPT = \"Encrypt\"", + "source": "script-api", + "tags": [ + "ws_encrypt", + "soaputil.ws_encrypt" + ], + "title": "SOAPUtil.WS_ENCRYPT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: encrypt the message. The encryption-specific parameters define how to encrypt, which keys to use, and other parameters.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPT", + "sections": [ + { + "body": "WS-Security action: encrypt the message.\nThe encryption-specific parameters define how to encrypt, which keys\nto use, and other parameters.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPT = \"Encrypt\"", + "source": "script-api", + "tags": [ + "ws_encrypt", + "soaputil.ws_encrypt" + ], + "title": "SOAPUtil.WS_ENCRYPT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: defines which parts of the request are encrypted.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_PARTS", + "sections": [ + { + "body": "WS-Security encryption: defines which parts of the request are encrypted.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPTION_PARTS = \"encryptionParts\"", + "source": "script-api", + "tags": [ + "ws_encryption_parts", + "soaputil.ws_encryption_parts" + ], + "title": "SOAPUtil.WS_ENCRYPTION_PARTS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: defines which parts of the request are encrypted.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_PARTS", + "sections": [ + { + "body": "WS-Security encryption: defines which parts of the request are encrypted.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPTION_PARTS = \"encryptionParts\"", + "source": "script-api", + "tags": [ + "ws_encryption_parts", + "soaputil.ws_encryption_parts" + ], + "title": "SOAPUtil.WS_ENCRYPTION_PARTS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the user's name for encryption.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_USER", + "sections": [ + { + "body": "WS-Security encryption: the user's name for encryption.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPTION_USER = \"encryptionUser\"", + "source": "script-api", + "tags": [ + "ws_encryption_user", + "soaputil.ws_encryption_user" + ], + "title": "SOAPUtil.WS_ENCRYPTION_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the user's name for encryption.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENCRYPTION_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENCRYPTION_USER", + "sections": [ + { + "body": "WS-Security encryption: the user's name for encryption.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENCRYPTION_USER = \"encryptionUser\"", + "source": "script-api", + "tags": [ + "ws_encryption_user", + "soaputil.ws_encryption_user" + ], + "title": "SOAPUtil.WS_ENCRYPTION_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore alias name", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore alias name", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_ALIAS = \"__EncryptionPropKeystoreAlias\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_alias", + "soaputil.ws_enc_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore alias name", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore alias name", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_ALIAS = \"__EncryptionPropKeystoreAlias\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_alias", + "soaputil.ws_enc_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore password", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_PW", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore password", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_PW = \"__EncryptionPropKeystorePassword\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_pw", + "soaputil.ws_enc_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore password", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_PW", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore password", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_PW = \"__EncryptionPropKeystorePassword\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_pw", + "soaputil.ws_enc_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_PW" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ), default is jks.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ),\ndefault is jks.\n\nNote: the keystore file must have the basename of the WSDL file and the\nfile extension based on the keystore type. For example: MyService.jks.\nThe keystore file must be placed in the same cartridge directory\nas the WSDL file.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_TYPE = \"__EncryptionPropKeystoreType\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_type", + "soaputil.ws_enc_prop_keystore_type" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ), default is jks.", + "id": "script-api:dw/rpc/SOAPUtil#WS_ENC_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE", + "sections": [ + { + "body": "WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ),\ndefault is jks.\n\nNote: the keystore file must have the basename of the WSDL file and the\nfile extension based on the keystore type. For example: MyService.jks.\nThe keystore file must be placed in the same cartridge directory\nas the WSDL file.", + "heading": "Description" + } + ], + "signature": "static readonly WS_ENC_PROP_KEYSTORE_TYPE = \"__EncryptionPropKeystoreType\"", + "source": "script-api", + "tags": [ + "ws_enc_prop_keystore_type", + "soaputil.ws_enc_prop_keystore_type" + ], + "title": "SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: no security", + "id": "script-api:dw/rpc/SOAPUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_NO_SECURITY", + "sections": [ + { + "body": "WS-Security action: no security", + "heading": "Description" + } + ], + "signature": "static readonly WS_NO_SECURITY = \"NoSecurity\"", + "source": "script-api", + "tags": [ + "ws_no_security", + "soaputil.ws_no_security" + ], + "title": "SOAPUtil.WS_NO_SECURITY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: no security", + "id": "script-api:dw/rpc/SOAPUtil#WS_NO_SECURITY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_NO_SECURITY", + "sections": [ + { + "body": "WS-Security action: no security", + "heading": "Description" + } + ], + "signature": "static readonly WS_NO_SECURITY = \"NoSecurity\"", + "source": "script-api", + "tags": [ + "ws_no_security", + "soaputil.ws_no_security" + ], + "title": "SOAPUtil.WS_NO_SECURITY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password type: parameter for UsernameToken action to define the encoding of the password. Allowed values are PW_DIGEST or PW_TEXT.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PASSWORD_TYPE", + "sections": [ + { + "body": "WS-Security password type: parameter for UsernameToken action to define the encoding\nof the password. Allowed values are PW_DIGEST or PW_TEXT.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PASSWORD_TYPE = \"passwordType\"", + "source": "script-api", + "tags": [ + "ws_password_type", + "soaputil.ws_password_type" + ], + "title": "SOAPUtil.WS_PASSWORD_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password type: parameter for UsernameToken action to define the encoding of the password. Allowed values are PW_DIGEST or PW_TEXT.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PASSWORD_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PASSWORD_TYPE", + "sections": [ + { + "body": "WS-Security password type: parameter for UsernameToken action to define the encoding\nof the password. Allowed values are PW_DIGEST or PW_TEXT.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PASSWORD_TYPE = \"passwordType\"", + "source": "script-api", + "tags": [ + "ws_password_type", + "soaputil.ws_password_type" + ], + "title": "SOAPUtil.WS_PASSWORD_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password of type digest: use a password digest to send the password information.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_DIGEST", + "sections": [ + { + "body": "WS-Security password of type digest: use a password digest to send the password information.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PW_DIGEST = \"PasswordDigest\"", + "source": "script-api", + "tags": [ + "ws_pw_digest", + "soaputil.ws_pw_digest" + ], + "title": "SOAPUtil.WS_PW_DIGEST" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password of type digest: use a password digest to send the password information.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_DIGEST", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_DIGEST", + "sections": [ + { + "body": "WS-Security password of type digest: use a password digest to send the password information.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PW_DIGEST = \"PasswordDigest\"", + "source": "script-api", + "tags": [ + "ws_pw_digest", + "soaputil.ws_pw_digest" + ], + "title": "SOAPUtil.WS_PW_DIGEST" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password of type text: send the password information in clear text.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_TEXT", + "sections": [ + { + "body": "WS-Security password of type text: send the password information in clear text.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PW_TEXT = \"PasswordText\"", + "source": "script-api", + "tags": [ + "ws_pw_text", + "soaputil.ws_pw_text" + ], + "title": "SOAPUtil.WS_PW_TEXT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security password of type text: send the password information in clear text.", + "id": "script-api:dw/rpc/SOAPUtil#WS_PW_TEXT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_PW_TEXT", + "sections": [ + { + "body": "WS-Security password of type text: send the password information in clear text.", + "heading": "Description" + } + ], + "signature": "static readonly WS_PW_TEXT = \"PasswordText\"", + "source": "script-api", + "tags": [ + "ws_pw_text", + "soaputil.ws_pw_text" + ], + "title": "SOAPUtil.WS_PW_TEXT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "A secrets map with the username/password entries is needed to create the password callback object.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SECRETS_MAP", + "sections": [ + { + "body": "A secrets map with the username/password entries is needed to create the password\ncallback object.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SECRETS_MAP = \"__SecretsMap\"", + "source": "script-api", + "tags": [ + "ws_secrets_map", + "soaputil.ws_secrets_map" + ], + "title": "SOAPUtil.WS_SECRETS_MAP" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "A secrets map with the username/password entries is needed to create the password callback object.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SECRETS_MAP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SECRETS_MAP", + "sections": [ + { + "body": "A secrets map with the username/password entries is needed to create the password\ncallback object.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SECRETS_MAP = \"__SecretsMap\"", + "source": "script-api", + "tags": [ + "ws_secrets_map", + "soaputil.ws_secrets_map" + ], + "title": "SOAPUtil.WS_SECRETS_MAP" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: sign the message. The signature-specific parameters define how to sign, which keys to use, and other parameters.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE", + "sections": [ + { + "body": "WS-Security action: sign the message.\nThe signature-specific parameters define how to sign, which keys\nto use, and other parameters.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE = \"Signature\"", + "source": "script-api", + "tags": [ + "ws_signature", + "soaputil.ws_signature" + ], + "title": "SOAPUtil.WS_SIGNATURE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: sign the message. The signature-specific parameters define how to sign, which keys to use, and other parameters.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE", + "sections": [ + { + "body": "WS-Security action: sign the message.\nThe signature-specific parameters define how to sign, which keys\nto use, and other parameters.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE = \"Signature\"", + "source": "script-api", + "tags": [ + "ws_signature", + "soaputil.ws_signature" + ], + "title": "SOAPUtil.WS_SIGNATURE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: defines which parts of the request are signed.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_PARTS", + "sections": [ + { + "body": "WS-Security signature: defines which parts of the request are signed.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE_PARTS = \"signatureParts\"", + "source": "script-api", + "tags": [ + "ws_signature_parts", + "soaputil.ws_signature_parts" + ], + "title": "SOAPUtil.WS_SIGNATURE_PARTS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: defines which parts of the request are signed.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_PARTS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_PARTS", + "sections": [ + { + "body": "WS-Security signature: defines which parts of the request are signed.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE_PARTS = \"signatureParts\"", + "source": "script-api", + "tags": [ + "ws_signature_parts", + "soaputil.ws_signature_parts" + ], + "title": "SOAPUtil.WS_SIGNATURE_PARTS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the user's name for signature.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_USER", + "sections": [ + { + "body": "WS-Security signature: the user's name for signature.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE_USER = \"signatureUser\"", + "source": "script-api", + "tags": [ + "ws_signature_user", + "soaputil.ws_signature_user" + ], + "title": "SOAPUtil.WS_SIGNATURE_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the user's name for signature.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIGNATURE_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIGNATURE_USER", + "sections": [ + { + "body": "WS-Security signature: the user's name for signature.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIGNATURE_USER = \"signatureUser\"", + "source": "script-api", + "tags": [ + "ws_signature_user", + "soaputil.ws_signature_user" + ], + "title": "SOAPUtil.WS_SIGNATURE_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: sets the signature digest algorithm to use.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_DIGEST_ALGO", + "sections": [ + { + "body": "WS-Security signature: sets the signature digest algorithm to use.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_DIGEST_ALGO = \"signatureDigestAlgorithm\"", + "source": "script-api", + "tags": [ + "ws_sig_digest_algo", + "soaputil.ws_sig_digest_algo" + ], + "title": "SOAPUtil.WS_SIG_DIGEST_ALGO" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: sets the signature digest algorithm to use.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_DIGEST_ALGO", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_DIGEST_ALGO", + "sections": [ + { + "body": "WS-Security signature: sets the signature digest algorithm to use.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_DIGEST_ALGO = \"signatureDigestAlgorithm\"", + "source": "script-api", + "tags": [ + "ws_sig_digest_algo", + "soaputil.ws_sig_digest_algo" + ], + "title": "SOAPUtil.WS_SIG_DIGEST_ALGO" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the signature keystore alias name", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "sections": [ + { + "body": "WS-Security signature: the signature keystore alias name", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_ALIAS = \"__SignaturePropKeystoreAlias\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_alias", + "soaputil.ws_sig_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the signature keystore alias name", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_ALIAS", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS", + "sections": [ + { + "body": "WS-Security signature: the signature keystore alias name", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_ALIAS = \"__SignaturePropKeystoreAlias\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_alias", + "soaputil.ws_sig_prop_keystore_alias" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the signature keystore password.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_PW", + "sections": [ + { + "body": "WS-Security signature: the signature keystore password.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_PW = \"__SignaturePropKeystorePassword\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_pw", + "soaputil.ws_sig_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security signature: the signature keystore password.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_PW", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_PW", + "sections": [ + { + "body": "WS-Security signature: the signature keystore password.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_PW = \"__SignaturePropKeystorePassword\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_pw", + "soaputil.ws_sig_prop_keystore_pw" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_PW" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "sections": [ + { + "body": "WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.\n\nNote: The keystore file must have the basename of the WSDL file and the\nfile extension of the keystore type. For example: MyService.jks.\nThe keystore file must be placed in the same cartridge directory\nas the WSDL file.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_TYPE = \"__SignaturePropKeystoreType\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_type", + "soaputil.ws_sig_prop_keystore_type" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.", + "id": "script-api:dw/rpc/SOAPUtil#WS_SIG_PROP_KEYSTORE_TYPE", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE", + "sections": [ + { + "body": "WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.\n\nNote: The keystore file must have the basename of the WSDL file and the\nfile extension of the keystore type. For example: MyService.jks.\nThe keystore file must be placed in the same cartridge directory\nas the WSDL file.", + "heading": "Description" + } + ], + "signature": "static readonly WS_SIG_PROP_KEYSTORE_TYPE = \"__SignaturePropKeystoreType\"", + "source": "script-api", + "tags": [ + "ws_sig_prop_keystore_type", + "soaputil.ws_sig_prop_keystore_type" + ], + "title": "SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: add a timestamp to the security header.", + "id": "script-api:dw/rpc/SOAPUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_TIMESTAMP", + "sections": [ + { + "body": "WS-Security action: add a timestamp to the security header.", + "heading": "Description" + } + ], + "signature": "static readonly WS_TIMESTAMP = \"Timestamp\"", + "source": "script-api", + "tags": [ + "ws_timestamp", + "soaputil.ws_timestamp" + ], + "title": "SOAPUtil.WS_TIMESTAMP" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: add a timestamp to the security header.", + "id": "script-api:dw/rpc/SOAPUtil#WS_TIMESTAMP", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_TIMESTAMP", + "sections": [ + { + "body": "WS-Security action: add a timestamp to the security header.", + "heading": "Description" + } + ], + "signature": "static readonly WS_TIMESTAMP = \"Timestamp\"", + "source": "script-api", + "tags": [ + "ws_timestamp", + "soaputil.ws_timestamp" + ], + "title": "SOAPUtil.WS_TIMESTAMP" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security user name.", + "id": "script-api:dw/rpc/SOAPUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USER", + "sections": [ + { + "body": "WS-Security user name.", + "heading": "Description" + } + ], + "signature": "static readonly WS_USER = \"user\"", + "source": "script-api", + "tags": [ + "ws_user", + "soaputil.ws_user" + ], + "title": "SOAPUtil.WS_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security user name.", + "id": "script-api:dw/rpc/SOAPUtil#WS_USER", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USER", + "sections": [ + { + "body": "WS-Security user name.", + "heading": "Description" + } + ], + "signature": "static readonly WS_USER = \"user\"", + "source": "script-api", + "tags": [ + "ws_user", + "soaputil.ws_user" + ], + "title": "SOAPUtil.WS_USER" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: add a UsernameToken identification.", + "id": "script-api:dw/rpc/SOAPUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USERNAME_TOKEN", + "sections": [ + { + "body": "WS-Security action: add a UsernameToken identification.", + "heading": "Description" + } + ], + "signature": "static readonly WS_USERNAME_TOKEN = \"UsernameToken\"", + "source": "script-api", + "tags": [ + "ws_username_token", + "soaputil.ws_username_token" + ], + "title": "SOAPUtil.WS_USERNAME_TOKEN" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "WS-Security action: add a UsernameToken identification.", + "id": "script-api:dw/rpc/SOAPUtil#WS_USERNAME_TOKEN", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.WS_USERNAME_TOKEN", + "sections": [ + { + "body": "WS-Security action: add a UsernameToken identification.", + "heading": "Description" + } + ], + "signature": "static readonly WS_USERNAME_TOKEN = \"UsernameToken\"", + "source": "script-api", + "tags": [ + "ws_username_token", + "soaputil.ws_username_token" + ], + "title": "SOAPUtil.WS_USERNAME_TOKEN" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns an HTTP request header property value using the specified key. Null is returned if the key does not represent an HTTP header property.", + "id": "script-api:dw/rpc/SOAPUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPRequestHeader", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns an HTTP request header property value using the specified key. Null is returned\nif the key does not represent an HTTP header property.", + "heading": "Description" + } + ], + "signature": "static getHTTPRequestHeader(svc: any, key: string): string | null", + "source": "script-api", + "tags": [ + "gethttprequestheader", + "soaputil.gethttprequestheader" + ], + "title": "SOAPUtil.getHTTPRequestHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns an HTTP request header property value using the specified key. Null is returned if the key does not represent an HTTP header property.", + "id": "script-api:dw/rpc/SOAPUtil#getHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPRequestHeader", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns an HTTP request header property value using the specified key. Null is returned\nif the key does not represent an HTTP header property.", + "heading": "Description" + } + ], + "signature": "static getHTTPRequestHeader(svc: any, key: string): string | null", + "source": "script-api", + "tags": [ + "gethttprequestheader", + "soaputil.gethttprequestheader" + ], + "title": "SOAPUtil.getHTTPRequestHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns an HTTP response header property value using the specified key. Null is returned if the key does not represent an HTTP response header property.", + "id": "script-api:dw/rpc/SOAPUtil#getHTTPResponseHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPResponseHeader", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns an HTTP response header property value using the specified key. Null is returned\nif the key does not represent an HTTP response header property.", + "heading": "Description" + } + ], + "signature": "static getHTTPResponseHeader(svc: any, key: string): string | null", + "source": "script-api", + "tags": [ + "gethttpresponseheader", + "soaputil.gethttpresponseheader" + ], + "title": "SOAPUtil.getHTTPResponseHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns an HTTP response header property value using the specified key. Null is returned if the key does not represent an HTTP response header property.", + "id": "script-api:dw/rpc/SOAPUtil#getHTTPResponseHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.getHTTPResponseHeader", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns an HTTP response header property value using the specified key. Null is returned\nif the key does not represent an HTTP response header property.", + "heading": "Description" + } + ], + "signature": "static getHTTPResponseHeader(svc: any, key: string): string | null", + "source": "script-api", + "tags": [ + "gethttpresponseheader", + "soaputil.gethttpresponseheader" + ], + "title": "SOAPUtil.getHTTPResponseHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets an HTTP request header property using the specified key and value.", + "id": "script-api:dw/rpc/SOAPUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHTTPRequestHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets an HTTP request header property using the specified key and value.", + "heading": "Description" + } + ], + "signature": "static setHTTPRequestHeader(svc: any, key: string, value: string): void", + "source": "script-api", + "tags": [ + "sethttprequestheader", + "soaputil.sethttprequestheader" + ], + "title": "SOAPUtil.setHTTPRequestHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets an HTTP request header property using the specified key and value.", + "id": "script-api:dw/rpc/SOAPUtil#setHTTPRequestHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHTTPRequestHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets an HTTP request header property using the specified key and value.", + "heading": "Description" + } + ], + "signature": "static setHTTPRequestHeader(svc: any, key: string, value: string): void", + "source": "script-api", + "tags": [ + "sethttprequestheader", + "soaputil.sethttprequestheader" + ], + "title": "SOAPUtil.setHTTPRequestHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "xml", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of\nthe XML content.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, xml: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of\nthe XML content.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, xml: string, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + }, + { + "name": "actor", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean, actor: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + }, + { + "name": "mustUnderstand", + "type": "boolean" + }, + { + "name": "actor", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean, actor: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "xml", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of\nthe XML content.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, xml: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of the XML content.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets a new SOAPHeaderElement in the SOAP request with the namespace of\nthe XML content.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, xml: string, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "string" + }, + { + "name": "mustUnderstand", + "type": "boolean" + }, + { + "name": "actor", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean, actor: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + }, + { + "name": "mustUnderstand", + "type": "boolean" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Creates a new SOAPHeaderElement with the name and namespace and places the given XML into it.", + "id": "script-api:dw/rpc/SOAPUtil#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "xml", + "type": "any" + }, + { + "name": "mustUnderstand", + "type": "boolean" + }, + { + "name": "actor", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Creates a new SOAPHeaderElement with the name and namespace and places\nthe given XML into it.", + "heading": "Description" + } + ], + "signature": "static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean, actor: string): void", + "source": "script-api", + "tags": [ + "setheader", + "soaputil.setheader" + ], + "title": "SOAPUtil.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the WS-Security configuration for the request and response based on the constants defined.", + "id": "script-api:dw/rpc/SOAPUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "requestConfigMap", + "type": "any" + }, + { + "name": "responseConfigMap", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setWSSecurityConfig", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the WS-Security configuration for the request and response based on the\nconstants defined.", + "heading": "Description" + } + ], + "signature": "static setWSSecurityConfig(svc: any, requestConfigMap: any, responseConfigMap: any): void", + "source": "script-api", + "tags": [ + "setwssecurityconfig", + "soaputil.setwssecurityconfig" + ], + "title": "SOAPUtil.setWSSecurityConfig" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the WS-Security configuration for the request and response based on the constants defined.", + "id": "script-api:dw/rpc/SOAPUtil#setWSSecurityConfig", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "svc", + "type": "any" + }, + { + "name": "requestConfigMap", + "type": "any" + }, + { + "name": "responseConfigMap", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/SOAPUtil", + "qualifiedName": "dw.rpc.SOAPUtil.setWSSecurityConfig", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the WS-Security configuration for the request and response based on the\nconstants defined.", + "heading": "Description" + } + ], + "signature": "static setWSSecurityConfig(svc: any, requestConfigMap: any, responseConfigMap: any): void", + "source": "script-api", + "tags": [ + "setwssecurityconfig", + "soaputil.setwssecurityconfig" + ], + "title": "SOAPUtil.setWSSecurityConfig" + }, + { + "deprecated": { + "message": "This class is deprecated, please use webreferences2 instead (see also dw.ws.Port)." + }, + "description": "This is the base class for all service stubs accessible through a WebReference object. The Stub provides access to the WSDL operations.", + "id": "script-api:dw/rpc/Stub", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.Stub", + "sections": [ + { + "body": "This is the base class for all service stubs accessible\nthrough a WebReference object. The Stub provides access to the WSDL operations.\n\nDemandware recommends a low timeout to ensure responsiveness\nof the site and to avoid thread exhaustion. Use the Services module\nin Business Manager to set timeout values, not the methods for this class.\nThe Services module provides better analytics and timeout management.\n\nThe default timeout, if not set, is 15 minutes when the web service is used in a job,\nand 2 minutes otherwise. If the timeout of the calling script is lower,\nthe script timeout is used.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "stub", + "dw.rpc.stub", + "dw/rpc" + ], + "title": "Stub" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "This property allows the user to set the web service connection timeout value in milliseconds. By default, the web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds and the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values in Business Manager Services module as it provides better analytics and timeout management.", + "id": "script-api:dw/rpc/Stub#CONNECTION_TIMEOUT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.CONNECTION_TIMEOUT", + "sections": [ + { + "body": "This property allows the user to set the web service connection timeout value in milliseconds. By default,\nthe web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds\nand the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values\nin Business Manager Services module as it provides better analytics and timeout management.", + "heading": "Description" + } + ], + "signature": "static readonly CONNECTION_TIMEOUT = \"demandware.script.webReference.connectionTimeout\"", + "source": "script-api", + "tags": [ + "connection_timeout", + "stub.connection_timeout" + ], + "title": "Stub.CONNECTION_TIMEOUT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "This property allows the user to set the web service connection timeout value in milliseconds. By default, the web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds and the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values in Business Manager Services module as it provides better analytics and timeout management.", + "id": "script-api:dw/rpc/Stub#CONNECTION_TIMEOUT", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.CONNECTION_TIMEOUT", + "sections": [ + { + "body": "This property allows the user to set the web service connection timeout value in milliseconds. By default,\nthe web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds\nand the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values\nin Business Manager Services module as it provides better analytics and timeout management.", + "heading": "Description" + } + ], + "signature": "static readonly CONNECTION_TIMEOUT = \"demandware.script.webReference.connectionTimeout\"", + "source": "script-api", + "tags": [ + "connection_timeout", + "stub.connection_timeout" + ], + "title": "Stub.CONNECTION_TIMEOUT" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: target service endpoint address. The URI scheme for the endpoint address specification must correspond to the protocol/transport binding for this stub class.", + "id": "script-api:dw/rpc/Stub#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY", + "sections": [ + { + "body": "Standard property: target service endpoint address. The\nURI scheme for the endpoint address specification must\ncorrespond to the protocol/transport binding for this\nstub class.", + "heading": "Description" + } + ], + "signature": "static readonly ENDPOINT_ADDRESS_PROPERTY = \"javax.xml.rpc.service.endpoint.address\"", + "source": "script-api", + "tags": [ + "endpoint_address_property", + "stub.endpoint_address_property" + ], + "title": "Stub.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: target service endpoint address. The URI scheme for the endpoint address specification must correspond to the protocol/transport binding for this stub class.", + "id": "script-api:dw/rpc/Stub#ENDPOINT_ADDRESS_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY", + "sections": [ + { + "body": "Standard property: target service endpoint address. The\nURI scheme for the endpoint address specification must\ncorrespond to the protocol/transport binding for this\nstub class.", + "heading": "Description" + } + ], + "signature": "static readonly ENDPOINT_ADDRESS_PROPERTY = \"javax.xml.rpc.service.endpoint.address\"", + "source": "script-api", + "tags": [ + "endpoint_address_property", + "stub.endpoint_address_property" + ], + "title": "Stub.ENDPOINT_ADDRESS_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: password for authentication.", + "id": "script-api:dw/rpc/Stub#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.PASSWORD_PROPERTY", + "sections": [ + { + "body": "Standard property: password for authentication.", + "heading": "Description" + } + ], + "signature": "static readonly PASSWORD_PROPERTY = \"javax.xml.rpc.security.auth.password\"", + "source": "script-api", + "tags": [ + "password_property", + "stub.password_property" + ], + "title": "Stub.PASSWORD_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: password for authentication.", + "id": "script-api:dw/rpc/Stub#PASSWORD_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.PASSWORD_PROPERTY", + "sections": [ + { + "body": "Standard property: password for authentication.", + "heading": "Description" + } + ], + "signature": "static readonly PASSWORD_PROPERTY = \"javax.xml.rpc.security.auth.password\"", + "source": "script-api", + "tags": [ + "password_property", + "stub.password_property" + ], + "title": "Stub.PASSWORD_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: this boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false.", + "id": "script-api:dw/rpc/Stub#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.SESSION_MAINTAIN_PROPERTY", + "sections": [ + { + "body": "Standard property: this boolean property is used by a service\nclient to indicate whether or not it wants to participate in\na session with a service endpoint. If this property is set to\ntrue, the service client indicates that it wants the session\nto be maintained. If set to false, the session is not maintained.\nThe default value for this property is false.", + "heading": "Description" + } + ], + "signature": "static readonly SESSION_MAINTAIN_PROPERTY = \"javax.xml.rpc.session.maintain\"", + "source": "script-api", + "tags": [ + "session_maintain_property", + "stub.session_maintain_property" + ], + "title": "Stub.SESSION_MAINTAIN_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: this boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false.", + "id": "script-api:dw/rpc/Stub#SESSION_MAINTAIN_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.SESSION_MAINTAIN_PROPERTY", + "sections": [ + { + "body": "Standard property: this boolean property is used by a service\nclient to indicate whether or not it wants to participate in\na session with a service endpoint. If this property is set to\ntrue, the service client indicates that it wants the session\nto be maintained. If set to false, the session is not maintained.\nThe default value for this property is false.", + "heading": "Description" + } + ], + "signature": "static readonly SESSION_MAINTAIN_PROPERTY = \"javax.xml.rpc.session.maintain\"", + "source": "script-api", + "tags": [ + "session_maintain_property", + "stub.session_maintain_property" + ], + "title": "Stub.SESSION_MAINTAIN_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: user name for authentication.", + "id": "script-api:dw/rpc/Stub#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.USERNAME_PROPERTY", + "sections": [ + { + "body": "Standard property: user name for authentication.", + "heading": "Description" + } + ], + "signature": "static readonly USERNAME_PROPERTY = \"javax.xml.rpc.security.auth.username\"", + "source": "script-api", + "tags": [ + "username_property", + "stub.username_property" + ], + "title": "Stub.USERNAME_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Standard property: user name for authentication.", + "id": "script-api:dw/rpc/Stub#USERNAME_PROPERTY", + "kind": "constant", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.USERNAME_PROPERTY", + "sections": [ + { + "body": "Standard property: user name for authentication.", + "heading": "Description" + } + ], + "signature": "static readonly USERNAME_PROPERTY = \"javax.xml.rpc.security.auth.username\"", + "source": "script-api", + "tags": [ + "username_property", + "stub.username_property" + ], + "title": "Stub.USERNAME_PROPERTY" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Gets the value of a specific configuration property.", + "id": "script-api:dw/rpc/Stub#_getProperty", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub._getProperty", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Gets the value of a specific configuration property.", + "heading": "Description" + } + ], + "signature": "_getProperty(name: string): any", + "source": "script-api", + "tags": [ + "_getproperty", + "stub._getproperty" + ], + "title": "Stub._getProperty" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the name and value of a configuration property for this Stub instance. If the Stub instance contains a value for the same property, the old value is replaced.", + "id": "script-api:dw/rpc/Stub#_setProperty", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub._setProperty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the name and value of a configuration property\nfor this Stub instance. If the Stub instance contains\na value for the same property, the old value is replaced.\n\nNote: the `_setProperty` method may not\nperform a validity check on a configured property value. An\nexample is the standard property for the target service\nendpoint address, which is not checked for validity in the\n`_setProperty` method.\nIn this case, stub configuration errors are detected at\nthe remote method invocation.", + "heading": "Description" + } + ], + "signature": "_setProperty(name: string, value: any): void", + "source": "script-api", + "tags": [ + "_setproperty", + "stub._setproperty" + ], + "title": "Stub._setProperty" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the password.", + "id": "script-api:dw/rpc/Stub#getPassword", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getPassword", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the password.", + "heading": "Description" + } + ], + "signature": "getPassword(): string", + "source": "script-api", + "tags": [ + "getpassword", + "stub.getpassword" + ], + "title": "Stub.getPassword" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the current read timeout value in milliseconds for this Stub.", + "id": "script-api:dw/rpc/Stub#getTimeout", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getTimeout", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the current read timeout value in milliseconds for this Stub.", + "heading": "Description" + } + ], + "signature": "getTimeout(): number", + "source": "script-api", + "tags": [ + "gettimeout", + "stub.gettimeout" + ], + "title": "Stub.getTimeout" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the user name.", + "id": "script-api:dw/rpc/Stub#getUsername", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.getUsername", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the user name.\n\nNote: this method handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "signature": "getUsername(): string", + "source": "script-api", + "tags": [ + "getusername", + "stub.getusername" + ], + "title": "Stub.getUsername" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the password.", + "id": "script-api:dw/rpc/Stub#password", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.password", + "sections": [ + { + "body": "Returns the password.", + "heading": "Description" + } + ], + "signature": "password: string", + "source": "script-api", + "tags": [ + "password", + "stub.password" + ], + "title": "Stub.password" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets an additional SOAP header value for the next operation.", + "id": "script-api:dw/rpc/Stub#setHeader", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "namespace", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets an additional SOAP header value for the next\noperation.", + "heading": "Description" + } + ], + "signature": "setHeader(namespace: string, name: string, value: any): void", + "source": "script-api", + "tags": [ + "setheader", + "stub.setheader" + ], + "title": "Stub.setHeader" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the password.", + "id": "script-api:dw/rpc/Stub#setPassword", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "password", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setPassword", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the password.", + "heading": "Description" + } + ], + "signature": "setPassword(password: string): void", + "source": "script-api", + "tags": [ + "setpassword", + "stub.setpassword" + ], + "title": "Stub.setPassword" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the timeout in milliseconds for the next call through this Stub.", + "id": "script-api:dw/rpc/Stub#setTimeout", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "timeout", + "type": "number" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setTimeout", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the timeout in milliseconds for the next call through this Stub.\n\nThis timeout value controls \"read timeout\" (how\nlong, after connecting, it will wait without any data being read).\nTo control \"connection timeout\" you use the _setProperty\nmethod where the name parameter is CONNECTION_TIMEOUT.", + "heading": "Description" + } + ], + "signature": "setTimeout(timeout: number): void", + "source": "script-api", + "tags": [ + "settimeout", + "stub.settimeout" + ], + "title": "Stub.setTimeout" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Sets the user name.", + "id": "script-api:dw/rpc/Stub#setUsername", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "username", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.setUsername", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the user name.", + "heading": "Description" + } + ], + "signature": "setUsername(username: string): void", + "source": "script-api", + "tags": [ + "setusername", + "stub.setusername" + ], + "title": "Stub.setUsername" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the current read timeout value in milliseconds for this Stub.", + "id": "script-api:dw/rpc/Stub#timeout", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.timeout", + "sections": [ + { + "body": "Returns the current read timeout value in milliseconds for this Stub.", + "heading": "Description" + } + ], + "signature": "timeout: number", + "source": "script-api", + "tags": [ + "timeout", + "stub.timeout" + ], + "title": "Stub.timeout" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the user name.", + "id": "script-api:dw/rpc/Stub#username", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/Stub", + "qualifiedName": "dw.rpc.Stub.username", + "sections": [ + { + "body": "Returns the user name.\n\nNote: this method handles sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "signature": "username: string", + "source": "script-api", + "tags": [ + "username", + "stub.username" + ], + "title": "Stub.username" + }, + { + "deprecated": { + "message": "This class is deprecated, please use webreferences2 instead (see also dw.ws.WebReference2).\n\nIn migrating from webreferences to webreferences2 the property `collectionType=indexed` may be helpful.\nSetting this in the property file for the WSDL will make the generated API more closely resemble the API generated by webreferences." + }, + "description": "Represents a web service defined in a WSDL file. The implementation is backed by a JAX-RPC framework. You should use the newer dw.ws package and dw.ws.WebReference2 class instead, which is based on JAX-WS.", + "examples": [ + "`\nvar webref : WebReference = webreferences.MyWSDL;\nvar stub : Stub = webref.getDefaultService();\n`" + ], + "id": "script-api:dw/rpc/WebReference", + "kind": "class", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc", + "qualifiedName": "dw.rpc.WebReference", + "sections": [ + { + "body": "Represents a web service defined in a WSDL file. The implementation is backed by a JAX-RPC framework.\nYou should use the newer dw.ws package and dw.ws.WebReference2 class instead, which is based on JAX-WS.\n\nUse the Services module in Business Manager to set timeout values, not the methods for this class.\nThe Services module provides better analytics and timeout management.\n\nTo create an instance of a WebReference object, in a B2C Commerce Script file, reference a WSDL file in the `webreferences`\ndirectory and request the service Stub using one of the get service methods.\nFor example, if your WSDL file is `MyWSDL.wsdl`,\nto create an instance of WebReference and access the Stub:\n\n\nNote: script classes representing your WSDL file are are generated by the platform and then placed in the `WebReferences`\npackage. You do not need to include the `importPackage`\nstatement in your B2C Commerce Script file to use classes in the `WebReferences` package.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "webreference", + "dw.rpc.webreference", + "dw/rpc" + ], + "title": "WebReference" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the default service of the WebReference object. If you have more than one service defined in your WSDL, the default service is the first service alphabetically. If the service has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.", + "id": "script-api:dw/rpc/WebReference#defaultService", + "kind": "property", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.defaultService", + "sections": [ + { + "body": "Returns the default service of the WebReference object. If you have more than one service\ndefined in your WSDL, the default service is the first service alphabetically. If the service\nhas multiple ports defined, the default service uses the SOAP port name that is first alphabetically.", + "heading": "Description" + } + ], + "signature": "readonly defaultService: Stub", + "source": "script-api", + "tags": [ + "defaultservice", + "webreference.defaultservice" + ], + "title": "WebReference.defaultService" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns the default service of the WebReference object. If you have more than one service defined in your WSDL, the default service is the first service alphabetically. If the service has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.", + "id": "script-api:dw/rpc/WebReference#getDefaultService", + "kind": "method", + "packagePath": "dw/rpc", + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.getDefaultService", + "returns": { + "type": "Stub" + }, + "sections": [ + { + "body": "Returns the default service of the WebReference object. If you have more than one service\ndefined in your WSDL, the default service is the first service alphabetically. If the service\nhas multiple ports defined, the default service uses the SOAP port name that is first alphabetically.", + "heading": "Description" + } + ], + "signature": "getDefaultService(): Stub", + "source": "script-api", + "tags": [ + "getdefaultservice", + "webreference.getdefaultservice" + ], + "title": "WebReference.getDefaultService" + }, + { + "deprecated": { + "message": "use webreferences2 instead" + }, + "description": "Returns a specific service from this WebReference.", + "id": "script-api:dw/rpc/WebReference#getService", + "kind": "method", + "packagePath": "dw/rpc", + "params": [ + { + "name": "service", + "type": "string" + }, + { + "name": "port", + "type": "string" + } + ], + "parentId": "script-api:dw/rpc/WebReference", + "qualifiedName": "dw.rpc.WebReference.getService", + "returns": { + "type": "Stub" + }, + "sections": [ + { + "body": "Returns a specific service from this WebReference.", + "heading": "Description" + } + ], + "signature": "getService(service: string, port: string): Stub", + "source": "script-api", + "tags": [ + "getservice", + "webreference.getservice" + ], + "title": "WebReference.getService" + }, + { + "description": "2 declarations", + "id": "script-api:dw/sitemap", + "kind": "package", + "packagePath": "dw/sitemap", + "qualifiedName": "dw.sitemap", + "source": "script-api", + "tags": [ + "dw/sitemap", + "dw.sitemap" + ], + "title": "dw.sitemap" + }, + { + "description": "Instances of this class represent sitemap files located in the appservers shared file system. Methods are used to get details of a sitemap file, such as the hostname it is associated with.", + "id": "script-api:dw/sitemap/SitemapFile", + "kind": "class", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap", + "qualifiedName": "dw.sitemap.SitemapFile", + "sections": [ + { + "body": "Instances of this class represent sitemap files located in the appservers shared file system. Methods are used to get\ndetails of a sitemap file, such as the hostname it is associated with.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sitemapfile", + "dw.sitemap.sitemapfile", + "dw/sitemap" + ], + "title": "SitemapFile" + }, + { + "description": "Returns the name of the file e.g. sitemap_index.xml", + "id": "script-api:dw/sitemap/SitemapFile#fileName", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileName", + "sections": [ + { + "body": "Returns the name of the file e.g. sitemap_index.xml", + "heading": "Description" + } + ], + "signature": "readonly fileName: string", + "source": "script-api", + "tags": [ + "filename", + "sitemapfile.filename" + ], + "title": "SitemapFile.fileName" + }, + { + "description": "Returns the size of the file in bytes.", + "id": "script-api:dw/sitemap/SitemapFile#fileSize", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileSize", + "sections": [ + { + "body": "Returns the size of the file in bytes.", + "heading": "Description" + } + ], + "signature": "readonly fileSize: number", + "source": "script-api", + "tags": [ + "filesize", + "sitemapfile.filesize" + ], + "title": "SitemapFile.fileSize" + }, + { + "description": "Returns the URL used to access this file in a storefront request.", + "id": "script-api:dw/sitemap/SitemapFile#fileURL", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.fileURL", + "sections": [ + { + "body": "Returns the URL used to access this file in a storefront request.", + "heading": "Description" + } + ], + "signature": "readonly fileURL: string", + "source": "script-api", + "tags": [ + "fileurl", + "sitemapfile.fileurl" + ], + "title": "SitemapFile.fileURL" + }, + { + "description": "Returns the name of the file e.g. sitemap_index.xml", + "id": "script-api:dw/sitemap/SitemapFile#getFileName", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the file e.g. sitemap_index.xml", + "heading": "Description" + } + ], + "signature": "getFileName(): string", + "source": "script-api", + "tags": [ + "getfilename", + "sitemapfile.getfilename" + ], + "title": "SitemapFile.getFileName" + }, + { + "description": "Returns the size of the file in bytes.", + "id": "script-api:dw/sitemap/SitemapFile#getFileSize", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileSize", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the file in bytes.", + "heading": "Description" + } + ], + "signature": "getFileSize(): number", + "source": "script-api", + "tags": [ + "getfilesize", + "sitemapfile.getfilesize" + ], + "title": "SitemapFile.getFileSize" + }, + { + "description": "Returns the URL used to access this file in a storefront request.", + "id": "script-api:dw/sitemap/SitemapFile#getFileURL", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getFileURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the URL used to access this file in a storefront request.", + "heading": "Description" + } + ], + "signature": "getFileURL(): string", + "source": "script-api", + "tags": [ + "getfileurl", + "sitemapfile.getfileurl" + ], + "title": "SitemapFile.getFileURL" + }, + { + "description": "Returns the host name this file is associated with.", + "id": "script-api:dw/sitemap/SitemapFile#getHostName", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.getHostName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the host name this file is associated with.", + "heading": "Description" + } + ], + "signature": "getHostName(): string", + "source": "script-api", + "tags": [ + "gethostname", + "sitemapfile.gethostname" + ], + "title": "SitemapFile.getHostName" + }, + { + "description": "Returns the host name this file is associated with.", + "id": "script-api:dw/sitemap/SitemapFile#hostName", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.hostName", + "sections": [ + { + "body": "Returns the host name this file is associated with.", + "heading": "Description" + } + ], + "signature": "readonly hostName: string", + "source": "script-api", + "tags": [ + "hostname", + "sitemapfile.hostname" + ], + "title": "SitemapFile.hostName" + }, + { + "description": "Checks if this instance of sitemap file is valid. Examples for invalid files are:", + "id": "script-api:dw/sitemap/SitemapFile#isValid", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.isValid", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if this instance of sitemap file is valid. Examples for invalid files are:\n\n- file size > 10mb\n\nAdditional violations might be added later.", + "heading": "Description" + } + ], + "signature": "isValid(): boolean", + "source": "script-api", + "tags": [ + "isvalid", + "sitemapfile.isvalid" + ], + "title": "SitemapFile.isValid" + }, + { + "description": "Checks if this instance of sitemap file is valid. Examples for invalid files are:", + "id": "script-api:dw/sitemap/SitemapFile#valid", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapFile", + "qualifiedName": "dw.sitemap.SitemapFile.valid", + "sections": [ + { + "body": "Checks if this instance of sitemap file is valid. Examples for invalid files are:\n\n- file size > 10mb\n\nAdditional violations might be added later.", + "heading": "Description" + } + ], + "signature": "readonly valid: boolean", + "source": "script-api", + "tags": [ + "valid", + "sitemapfile.valid" + ], + "title": "SitemapFile.valid" + }, + { + "description": "dw.sitemap.SitemapMgr is used to access and modify custom sitemap files.", + "id": "script-api:dw/sitemap/SitemapMgr", + "kind": "class", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap", + "qualifiedName": "dw.sitemap.SitemapMgr", + "sections": [ + { + "body": "dw.sitemap.SitemapMgr is used to access and modify custom sitemap files.\n\nTo access custom sitemap files, use methods getCustomSitemapFiles.\n\nTo delete custom sitemap files, use methods deleteCustomSitemapFile,\ndeleteCustomSitemapFiles and deleteCustomSitemapFiles.\n\nTo add custom sitemap files, use methods addCustomSitemapFile. The file will be copied from\nWebDAV (dw.io.File represent a file in WebDAV) to the appservers shared file system.\n\nPlease note that all provided methods are operating in appservers shared file system. These modifications are visible\nvia \"Custom Sitemaps\" tab under Merchant Tools => SEO => Sitemaps - Custom Sitemaps in\nBusiness Manager. To publish all changes, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "sitemapmgr", + "dw.sitemap.sitemapmgr", + "dw/sitemap" + ], + "title": "SitemapMgr" + }, + { + "description": "Adds the given dw.io.File to the appservers custom sitemap directory. All content of the appservers custom sitemap directory is considered by the system job \"Create Sitemap Schedule\".", + "id": "script-api:dw/sitemap/SitemapMgr#addCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "hostName", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.addCustomSitemapFile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the given dw.io.File to the appservers custom sitemap directory. All content of the appservers\ncustom sitemap directory is considered by the system job \"Create Sitemap Schedule\".\n\nThe files are added to the directory which is accessible via \"Custom Sitemaps\" tab under Merchant Tools =>\nSEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static addCustomSitemapFile(hostName: string, file: File): void", + "source": "script-api", + "tags": [ + "addcustomsitemapfile", + "sitemapmgr.addcustomsitemapfile" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "SitemapMgr.addCustomSitemapFile" + }, + { + "description": "Adds the given dw.io.File to the appservers custom sitemap directory. All content of the appservers custom sitemap directory is considered by the system job \"Create Sitemap Schedule\".", + "id": "script-api:dw/sitemap/SitemapMgr#addCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "hostName", + "type": "string" + }, + { + "name": "file", + "type": "File" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.addCustomSitemapFile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the given dw.io.File to the appservers custom sitemap directory. All content of the appservers\ncustom sitemap directory is considered by the system job \"Create Sitemap Schedule\".\n\nThe files are added to the directory which is accessible via \"Custom Sitemaps\" tab under Merchant Tools =>\nSEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static addCustomSitemapFile(hostName: string, file: File): void", + "source": "script-api", + "tags": [ + "addcustomsitemapfile", + "sitemapmgr.addcustomsitemapfile" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "SitemapMgr.addCustomSitemapFile" + }, + { + "description": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory and returns them in a Map containing mappings like", + "id": "script-api:dw/sitemap/SitemapMgr#customSitemapFiles", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.customSitemapFiles", + "sections": [ + { + "body": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory\nand returns them in a Map containing mappings like\n\n- Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]\n- Hostname 2 => [SitemapFile hostname2_sitemapfile1]", + "heading": "Description" + } + ], + "signature": "static readonly customSitemapFiles: utilMap", + "source": "script-api", + "tags": [ + "customsitemapfiles", + "sitemapmgr.customsitemapfiles" + ], + "title": "SitemapMgr.customSitemapFiles" + }, + { + "description": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory and returns them in a Map containing mappings like", + "id": "script-api:dw/sitemap/SitemapMgr#customSitemapFiles", + "kind": "property", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.customSitemapFiles", + "sections": [ + { + "body": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory\nand returns them in a Map containing mappings like\n\n- Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]\n- Hostname 2 => [SitemapFile hostname2_sitemapfile1]", + "heading": "Description" + } + ], + "signature": "static readonly customSitemapFiles: utilMap", + "source": "script-api", + "tags": [ + "customsitemapfiles", + "sitemapmgr.customsitemapfiles" + ], + "title": "SitemapMgr.customSitemapFiles" + }, + { + "description": "Deletes the given custom sitemap file from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "sitemapFile", + "type": "SitemapFile" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes the given custom sitemap file from the appservers shared file system.\n\nThe file is deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant Tools\n=> SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFile(sitemapFile: SitemapFile): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfile", + "sitemapmgr.deletecustomsitemapfile" + ], + "title": "SitemapMgr.deleteCustomSitemapFile" + }, + { + "description": "Deletes the given custom sitemap file from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFile", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "sitemapFile", + "type": "SitemapFile" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFile", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes the given custom sitemap file from the appservers shared file system.\n\nThe file is deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant Tools\n=> SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFile(sitemapFile: SitemapFile): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfile", + "sitemapmgr.deletecustomsitemapfile" + ], + "title": "SitemapMgr.deleteCustomSitemapFile" + }, + { + "description": "Deletes all custom sitemap files for the given hostname from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "hostName", + "type": "string" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes all custom sitemap files for the given hostname from the appservers shared file system.\n\nThe files are deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant\nTools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFiles(hostName: string): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "description": "Deletes all custom sitemap files for all hostnames from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes all custom sitemap files for all hostnames from the appservers shared file system.\n\nThe files are deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant\nTools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFiles(): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "description": "Deletes all custom sitemap files for the given hostname from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "params": [ + { + "name": "hostName", + "type": "string" + } + ], + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes all custom sitemap files for the given hostname from the appservers shared file system.\n\nThe files are deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant\nTools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFiles(hostName: string): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "description": "Deletes all custom sitemap files for all hostnames from the appservers shared file system.", + "id": "script-api:dw/sitemap/SitemapMgr#deleteCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.deleteCustomSitemapFiles", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Deletes all custom sitemap files for all hostnames from the appservers shared file system.\n\nThe files are deleted from the directory which is accessible via \"Custom Sitemaps\" tab under Merchant\nTools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.", + "heading": "Description" + } + ], + "signature": "static deleteCustomSitemapFiles(): void", + "source": "script-api", + "tags": [ + "deletecustomsitemapfiles", + "sitemapmgr.deletecustomsitemapfiles" + ], + "title": "SitemapMgr.deleteCustomSitemapFiles" + }, + { + "description": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory and returns them in a Map containing mappings like", + "id": "script-api:dw/sitemap/SitemapMgr#getCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.getCustomSitemapFiles", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory\nand returns them in a Map containing mappings like\n\n- Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]\n- Hostname 2 => [SitemapFile hostname2_sitemapfile1]", + "heading": "Description" + } + ], + "signature": "static getCustomSitemapFiles(): utilMap", + "source": "script-api", + "tags": [ + "getcustomsitemapfiles", + "sitemapmgr.getcustomsitemapfiles" + ], + "title": "SitemapMgr.getCustomSitemapFiles" + }, + { + "description": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory and returns them in a Map containing mappings like", + "id": "script-api:dw/sitemap/SitemapMgr#getCustomSitemapFiles", + "kind": "method", + "packagePath": "dw/sitemap", + "parentId": "script-api:dw/sitemap/SitemapMgr", + "qualifiedName": "dw.sitemap.SitemapMgr.getCustomSitemapFiles", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory\nand returns them in a Map containing mappings like\n\n- Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]\n- Hostname 2 => [SitemapFile hostname2_sitemapfile1]", + "heading": "Description" + } + ], + "signature": "static getCustomSitemapFiles(): utilMap", + "source": "script-api", + "tags": [ + "getcustomsitemapfiles", + "sitemapmgr.getcustomsitemapfiles" + ], + "title": "SitemapMgr.getCustomSitemapFiles" + }, + { + "description": "14 declarations", + "id": "script-api:dw/suggest", + "kind": "package", + "packagePath": "dw/suggest", + "qualifiedName": "dw.suggest", + "source": "script-api", + "tags": [ + "dw/suggest", + "dw.suggest" + ], + "title": "dw.suggest" + }, + { + "description": "The brands suggestion container provides access to brands found using the suggested terms.", + "id": "script-api:dw/suggest/BrandSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.BrandSuggestions", + "sections": [ + { + "body": "The brands suggestion container provides access to\nbrands found using the suggested terms.\n\nThe method SearchPhraseSuggestions.getSuggestedPhrases can be used to\nget the list of found brand names. The brand lookup\nis being executed in the current catalog and locale.\n\nFurthermore the list of suggested terms, after processing\nthe original user input search query, is accessible\nthrough SearchPhraseSuggestions.getSuggestedTerms method.", + "heading": "Description" + }, + { + "body": "Extends `Suggestions`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "brandsuggestions", + "dw.suggest.brandsuggestions", + "dw/suggest" + ], + "title": "BrandSuggestions" + }, + { + "description": "The category suggestion container provides access to categories found using the suggested terms as search criteria. The method getSuggestedCategories can be used to get the list of found categories.", + "id": "script-api:dw/suggest/CategorySuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.CategorySuggestions", + "sections": [ + { + "body": "The category suggestion container provides access to\ncategories found using the suggested terms as search criteria.\nThe method getSuggestedCategories can be used to\nget the list of found categories.\n\nFurthermore the list of suggested terms, after processing\nthe original user input search query, is accessible\nthrough SearchPhraseSuggestions.getSuggestedTerms method.", + "heading": "Description" + }, + { + "body": "Extends `Suggestions`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "categorysuggestions", + "dw.suggest.categorysuggestions", + "dw/suggest" + ], + "title": "CategorySuggestions" + }, + { + "description": "This method returns a list of categories which were found using the suggested terms as search criteria. The category lookup is being executed in the current catalog and locale.", + "id": "script-api:dw/suggest/CategorySuggestions#getSuggestedCategories", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/CategorySuggestions", + "qualifiedName": "dw.suggest.CategorySuggestions.getSuggestedCategories", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "This method returns a list of categories which were found\nusing the suggested terms as search criteria.\nThe category lookup is being executed in the current catalog and locale.", + "heading": "Description" + } + ], + "signature": "getSuggestedCategories(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedcategories", + "categorysuggestions.getsuggestedcategories" + ], + "title": "CategorySuggestions.getSuggestedCategories" + }, + { + "description": "This method returns a list of categories which were found using the suggested terms as search criteria. The category lookup is being executed in the current catalog and locale.", + "id": "script-api:dw/suggest/CategorySuggestions#suggestedCategories", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/CategorySuggestions", + "qualifiedName": "dw.suggest.CategorySuggestions.suggestedCategories", + "sections": [ + { + "body": "This method returns a list of categories which were found\nusing the suggested terms as search criteria.\nThe category lookup is being executed in the current catalog and locale.", + "heading": "Description" + } + ], + "signature": "readonly suggestedCategories: utilIterator", + "source": "script-api", + "tags": [ + "suggestedcategories", + "categorysuggestions.suggestedcategories" + ], + "title": "CategorySuggestions.suggestedCategories" + }, + { + "description": "The content suggestion container provides access to content pages found using the suggested terms as search criteria. The method getSuggestedContent can be used to get the list of found content pages.", + "id": "script-api:dw/suggest/ContentSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.ContentSuggestions", + "sections": [ + { + "body": "The content suggestion container provides access to\ncontent pages found using the suggested terms as search criteria.\nThe method getSuggestedContent can be used to\nget the list of found content pages.\n\nFurthermore the list of suggested terms, after processing\nthe original user input search query, is accessible\nthrough SearchPhraseSuggestions.getSuggestedTerms method.", + "heading": "Description" + }, + { + "body": "Extends `Suggestions`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "contentsuggestions", + "dw.suggest.contentsuggestions", + "dw/suggest" + ], + "title": "ContentSuggestions" + }, + { + "description": "This method returns a list of content pages which were found using the suggested terms as search criteria. The content lookup is being executed in the current library and locale.", + "id": "script-api:dw/suggest/ContentSuggestions#getSuggestedContent", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ContentSuggestions", + "qualifiedName": "dw.suggest.ContentSuggestions.getSuggestedContent", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "This method returns a list of content pages which were found\nusing the suggested terms as search criteria.\nThe content lookup is being executed in the current library and locale.", + "heading": "Description" + } + ], + "signature": "getSuggestedContent(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedcontent", + "contentsuggestions.getsuggestedcontent" + ], + "title": "ContentSuggestions.getSuggestedContent" + }, + { + "description": "This method returns a list of content pages which were found using the suggested terms as search criteria. The content lookup is being executed in the current library and locale.", + "id": "script-api:dw/suggest/ContentSuggestions#suggestedContent", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ContentSuggestions", + "qualifiedName": "dw.suggest.ContentSuggestions.suggestedContent", + "sections": [ + { + "body": "This method returns a list of content pages which were found\nusing the suggested terms as search criteria.\nThe content lookup is being executed in the current library and locale.", + "heading": "Description" + } + ], + "signature": "readonly suggestedContent: utilIterator", + "source": "script-api", + "tags": [ + "suggestedcontent", + "contentsuggestions.suggestedcontent" + ], + "title": "ContentSuggestions.suggestedContent" + }, + { + "description": "The custom suggestion container provides access to merchant provided search phrases found using the suggested terms as search criteria.", + "id": "script-api:dw/suggest/CustomSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.CustomSuggestions", + "sections": [ + { + "body": "The custom suggestion container provides access to\nmerchant provided search phrases\nfound using the suggested terms as search criteria.\n\nThe method SearchPhraseSuggestions.getSuggestedPhrases can be used to\nget the list of found search phrases. The custom phrases\nlookup is being executed in the current site.\n\nFurthermore the list of suggested terms is accessible\nthrough SearchPhraseSuggestions.getSuggestedTerms method.", + "heading": "Description" + }, + { + "body": "Extends `Suggestions`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "customsuggestions", + "dw.suggest.customsuggestions", + "dw/suggest" + ], + "title": "CustomSuggestions" + }, + { + "description": "The product suggestion container provides access to products found using the suggested terms. The method getSuggestedProducts can be used to get the list of found products.", + "id": "script-api:dw/suggest/ProductSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.ProductSuggestions", + "sections": [ + { + "body": "The product suggestion container provides access to\nproducts found using the suggested terms.\nThe method getSuggestedProducts can be used to\nget the list of found products.\n\nFurthermore the list of suggested terms, after processing\nthe original user input search query, is accessible\nthrough SearchPhraseSuggestions.getSuggestedTerms method.", + "heading": "Description" + }, + { + "body": "Extends `Suggestions`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "productsuggestions", + "dw.suggest.productsuggestions", + "dw/suggest" + ], + "title": "ProductSuggestions" + }, + { + "description": "This method returns a list of products which were found using the suggested terms as search criteria. The product lookup is being executed in the current catalog and locale.", + "id": "script-api:dw/suggest/ProductSuggestions#getSuggestedProducts", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ProductSuggestions", + "qualifiedName": "dw.suggest.ProductSuggestions.getSuggestedProducts", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "This method returns a list of products which were found\nusing the suggested terms as search criteria.\nThe product lookup is being executed in the current catalog and locale.", + "heading": "Description" + } + ], + "signature": "getSuggestedProducts(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedproducts", + "productsuggestions.getsuggestedproducts" + ], + "title": "ProductSuggestions.getSuggestedProducts" + }, + { + "description": "This method returns a list of products which were found using the suggested terms as search criteria. The product lookup is being executed in the current catalog and locale.", + "id": "script-api:dw/suggest/ProductSuggestions#suggestedProducts", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/ProductSuggestions", + "qualifiedName": "dw.suggest.ProductSuggestions.suggestedProducts", + "sections": [ + { + "body": "This method returns a list of products which were found\nusing the suggested terms as search criteria.\nThe product lookup is being executed in the current catalog and locale.", + "heading": "Description" + } + ], + "signature": "readonly suggestedProducts: utilIterator", + "source": "script-api", + "tags": [ + "suggestedproducts", + "productsuggestions.suggestedproducts" + ], + "title": "ProductSuggestions.suggestedProducts" + }, + { + "description": "The search phrase suggestions contain a list of suggested search phrases (see dw.suggest.SuggestedPhrase) as well as, for each of the search phrase terms, a list with corrected and completed alternative terms.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions", + "sections": [ + { + "body": "The search phrase suggestions contain a list of suggested search phrases\n(see dw.suggest.SuggestedPhrase)\nas well as, for each of the search phrase terms, a list with corrected and\ncompleted alternative terms.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "searchphrasesuggestions", + "dw.suggest.searchphrasesuggestions", + "dw/suggest" + ], + "title": "SearchPhraseSuggestions" + }, + { + "description": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the user input search phrase.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#getSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.getSuggestedPhrases", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the\nuser input search phrase.", + "heading": "Description" + } + ], + "signature": "getSuggestedPhrases(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedphrases", + "searchphrasesuggestions.getsuggestedphrases" + ], + "title": "SearchPhraseSuggestions.getSuggestedPhrases" + }, + { + "description": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#getSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.getSuggestedTerms", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned\ninstances represents a set of terms suggested for a particular single term\nof the user input search phrase.", + "heading": "Description" + } + ], + "signature": "getSuggestedTerms(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedterms", + "searchphrasesuggestions.getsuggestedterms" + ], + "title": "SearchPhraseSuggestions.getSuggestedTerms" + }, + { + "description": "Returns whether this suggestions container has any suggested phrases.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#hasSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.hasSuggestedPhrases", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggestions container has any suggested phrases.\n\nNote that this method only looks for suggested phrases. It does not account\nfor suggested terms.", + "heading": "Description" + } + ], + "signature": "hasSuggestedPhrases(): boolean", + "source": "script-api", + "tags": [ + "hassuggestedphrases", + "searchphrasesuggestions.hassuggestedphrases" + ], + "title": "SearchPhraseSuggestions.hasSuggestedPhrases" + }, + { + "description": "Returns whether this suggestions container has any suggested terms.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#hasSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.hasSuggestedTerms", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggestions container has any suggested terms.\n\nNote that this method checks suggested terms only,\nbut not suggested phrases.", + "heading": "Description" + } + ], + "signature": "hasSuggestedTerms(): boolean", + "source": "script-api", + "tags": [ + "hassuggestedterms", + "searchphrasesuggestions.hassuggestedterms" + ], + "title": "SearchPhraseSuggestions.hasSuggestedTerms" + }, + { + "description": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the user input search phrase.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#suggestedPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.suggestedPhrases", + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the\nuser input search phrase.", + "heading": "Description" + } + ], + "signature": "readonly suggestedPhrases: utilIterator", + "source": "script-api", + "tags": [ + "suggestedphrases", + "searchphrasesuggestions.suggestedphrases" + ], + "title": "SearchPhraseSuggestions.suggestedPhrases" + }, + { + "description": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.", + "id": "script-api:dw/suggest/SearchPhraseSuggestions#suggestedTerms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SearchPhraseSuggestions", + "qualifiedName": "dw.suggest.SearchPhraseSuggestions.suggestedTerms", + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned\ninstances represents a set of terms suggested for a particular single term\nof the user input search phrase.", + "heading": "Description" + } + ], + "signature": "readonly suggestedTerms: utilIterator", + "source": "script-api", + "tags": [ + "suggestedterms", + "searchphrasesuggestions.suggestedterms" + ], + "title": "SearchPhraseSuggestions.suggestedTerms" + }, + { + "description": "The Suggest model provides methods and functions to access search suggestions.", + "id": "script-api:dw/suggest/SuggestModel", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestModel", + "sections": [ + { + "body": "The Suggest model provides methods and functions\nto access search suggestions.\n\nThe search suggestion feature basically covers two functional areas.\nFirst is just to suggest words, based on the users input,\nutilizing spell correction or prediction (also known as auto completion).\nThe second functional area is also often referred to as search-as-you-type,\nwhere, based on the users input, specific items are\nalready looked up, before the user actually has completed typing a word\nor even fired up the search.\n\nThis model combines both functional areas and provides access to both - the\nsuggested words and the items found while using the predicted words.\n\nThis model supports various types of items that are being suggested, like\nproducts, categories, brands, content pages as well merchant provided search phrases.\nFor each type, there is a Suggestions implementation\navailable and accessible through this model: ProductSuggestions,\nCategorySuggestions, BrandSuggestions, ContentSuggestions,\nand CustomSuggestions.\n\nFor each type of suggestions, the actual suggested items (like\nproducts) can by obtained, and, on the other hand, a list of terms\nis provided which were used to lookup the found items.\nThe terms can be used to present a advanced user experience in the\nstorefront, e.g. show auto completed words, spell corrections and so on.\nThe SuggestModel script API will always create suggestions with Autocorrections\nregardless of the value of \"Search Autocorrections\" search preference.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestmodel", + "dw.suggest.suggestmodel", + "dw/suggest" + ], + "title": "SuggestModel" + }, + { + "description": "The maximum number of suggestions that can be obtain from this model: `10`", + "id": "script-api:dw/suggest/SuggestModel#MAX_SUGGESTIONS", + "kind": "constant", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.MAX_SUGGESTIONS", + "sections": [ + { + "body": "The maximum number of suggestions that can be obtain from this model: `10`", + "heading": "Description" + } + ], + "signature": "static readonly MAX_SUGGESTIONS = 10", + "source": "script-api", + "tags": [ + "max_suggestions", + "suggestmodel.max_suggestions" + ], + "title": "SuggestModel.MAX_SUGGESTIONS" + }, + { + "description": "The maximum number of suggestions that can be obtain from this model: `10`", + "id": "script-api:dw/suggest/SuggestModel#MAX_SUGGESTIONS", + "kind": "constant", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.MAX_SUGGESTIONS", + "sections": [ + { + "body": "The maximum number of suggestions that can be obtain from this model: `10`", + "heading": "Description" + } + ], + "signature": "static readonly MAX_SUGGESTIONS = 10", + "source": "script-api", + "tags": [ + "max_suggestions", + "suggestmodel.max_suggestions" + ], + "title": "SuggestModel.MAX_SUGGESTIONS" + }, + { + "description": "Adds a refinement for product suggestions. The method can be called to add an additional query parameter specified as name-value pair. The values string may encode multiple values delimited by the pipe symbol ('|').", + "id": "script-api:dw/suggest/SuggestModel#addRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.addRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a refinement for product suggestions.\nThe method can be called to add an additional query\nparameter specified as name-value pair. The values string may encode\nmultiple values delimited by the pipe symbol ('|').", + "heading": "Description" + } + ], + "signature": "addRefinementValues(attributeID: string, values: string): void", + "source": "script-api", + "tags": [ + "addrefinementvalues", + "suggestmodel.addrefinementvalues" + ], + "title": "SuggestModel.addRefinementValues" + }, + { + "description": "Returns a BrandSuggestions container for the current search phrase. The BrandSuggestions container provides access to the found brands (if any) and the terms suggested by the system with respect to the known product brands in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#brandSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.brandSuggestions", + "sections": [ + { + "body": "Returns a BrandSuggestions container for the current search phrase.\nThe BrandSuggestions container provides access to the found brands (if any) and\nthe terms suggested by the system with respect to the known product brands in the catalog.", + "heading": "Description" + } + ], + "signature": "readonly brandSuggestions: BrandSuggestions", + "source": "script-api", + "tags": [ + "brandsuggestions", + "suggestmodel.brandsuggestions" + ], + "title": "SuggestModel.brandSuggestions" + }, + { + "description": "Returns a CategorySuggestions container for the current search phrase. The CategorySuggestions container provides access to the found categories (if any) and the terms suggested by the system with respect to the known categories in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#categorySuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.categorySuggestions", + "sections": [ + { + "body": "Returns a CategorySuggestions container for the current search phrase.\nThe CategorySuggestions container provides access to the found categories (if any) and\nthe terms suggested by the system with respect to the known categories in the catalog.", + "heading": "Description" + } + ], + "signature": "readonly categorySuggestions: CategorySuggestions", + "source": "script-api", + "tags": [ + "categorysuggestions", + "suggestmodel.categorysuggestions" + ], + "title": "SuggestModel.categorySuggestions" + }, + { + "description": "Returns a ContentSuggestions container for the current search phrase. The ContentSuggestions container provides access to the found content pages (if any) and the terms suggested by the system with respect to the known content in the library.", + "id": "script-api:dw/suggest/SuggestModel#contentSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.contentSuggestions", + "sections": [ + { + "body": "Returns a ContentSuggestions container for the current search phrase.\nThe ContentSuggestions container provides access to the found content pages (if any) and\nthe terms suggested by the system with respect to the known content in the library.", + "heading": "Description" + } + ], + "signature": "readonly contentSuggestions: ContentSuggestions", + "source": "script-api", + "tags": [ + "contentsuggestions", + "suggestmodel.contentsuggestions" + ], + "title": "SuggestModel.contentSuggestions" + }, + { + "description": "Returns a CustomSuggestions container for the current search phrase. The CustomSuggestions container provides access to matching custom phrases (if any) and the terms suggested by the system with respect to the merchant provided custom phrases.", + "id": "script-api:dw/suggest/SuggestModel#customSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.customSuggestions", + "sections": [ + { + "body": "Returns a CustomSuggestions container for the current search phrase.\nThe CustomSuggestions container provides access to matching\ncustom phrases (if any) and the terms suggested\nby the system with respect to the merchant provided custom phrases.", + "heading": "Description" + } + ], + "signature": "readonly customSuggestions: CustomSuggestions", + "source": "script-api", + "tags": [ + "customsuggestions", + "suggestmodel.customsuggestions" + ], + "title": "SuggestModel.customSuggestions" + }, + { + "description": "The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not possible for search suggestions to contain Page Designer content as it belongs to no folder.", + "id": "script-api:dw/suggest/SuggestModel#filteredByFolder", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.filteredByFolder", + "sections": [ + { + "body": "The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not\npossible for search suggestions to contain Page Designer content as it belongs to no folder.", + "heading": "Description" + } + ], + "signature": "filteredByFolder: boolean", + "source": "script-api", + "tags": [ + "filteredbyfolder", + "suggestmodel.filteredbyfolder" + ], + "title": "SuggestModel.filteredByFolder" + }, + { + "description": "Returns a BrandSuggestions container for the current search phrase. The BrandSuggestions container provides access to the found brands (if any) and the terms suggested by the system with respect to the known product brands in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#getBrandSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getBrandSuggestions", + "returns": { + "type": "BrandSuggestions" + }, + "sections": [ + { + "body": "Returns a BrandSuggestions container for the current search phrase.\nThe BrandSuggestions container provides access to the found brands (if any) and\nthe terms suggested by the system with respect to the known product brands in the catalog.", + "heading": "Description" + } + ], + "signature": "getBrandSuggestions(): BrandSuggestions", + "source": "script-api", + "tags": [ + "getbrandsuggestions", + "suggestmodel.getbrandsuggestions" + ], + "title": "SuggestModel.getBrandSuggestions" + }, + { + "description": "Returns a CategorySuggestions container for the current search phrase. The CategorySuggestions container provides access to the found categories (if any) and the terms suggested by the system with respect to the known categories in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#getCategorySuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getCategorySuggestions", + "returns": { + "type": "CategorySuggestions" + }, + "sections": [ + { + "body": "Returns a CategorySuggestions container for the current search phrase.\nThe CategorySuggestions container provides access to the found categories (if any) and\nthe terms suggested by the system with respect to the known categories in the catalog.", + "heading": "Description" + } + ], + "signature": "getCategorySuggestions(): CategorySuggestions", + "source": "script-api", + "tags": [ + "getcategorysuggestions", + "suggestmodel.getcategorysuggestions" + ], + "title": "SuggestModel.getCategorySuggestions" + }, + { + "description": "Returns a ContentSuggestions container for the current search phrase. The ContentSuggestions container provides access to the found content pages (if any) and the terms suggested by the system with respect to the known content in the library.", + "id": "script-api:dw/suggest/SuggestModel#getContentSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getContentSuggestions", + "returns": { + "type": "ContentSuggestions" + }, + "sections": [ + { + "body": "Returns a ContentSuggestions container for the current search phrase.\nThe ContentSuggestions container provides access to the found content pages (if any) and\nthe terms suggested by the system with respect to the known content in the library.", + "heading": "Description" + } + ], + "signature": "getContentSuggestions(): ContentSuggestions", + "source": "script-api", + "tags": [ + "getcontentsuggestions", + "suggestmodel.getcontentsuggestions" + ], + "title": "SuggestModel.getContentSuggestions" + }, + { + "description": "Returns a CustomSuggestions container for the current search phrase. The CustomSuggestions container provides access to matching custom phrases (if any) and the terms suggested by the system with respect to the merchant provided custom phrases.", + "id": "script-api:dw/suggest/SuggestModel#getCustomSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getCustomSuggestions", + "returns": { + "type": "CustomSuggestions" + }, + "sections": [ + { + "body": "Returns a CustomSuggestions container for the current search phrase.\nThe CustomSuggestions container provides access to matching\ncustom phrases (if any) and the terms suggested\nby the system with respect to the merchant provided custom phrases.", + "heading": "Description" + } + ], + "signature": "getCustomSuggestions(): CustomSuggestions", + "source": "script-api", + "tags": [ + "getcustomsuggestions", + "suggestmodel.getcustomsuggestions" + ], + "title": "SuggestModel.getCustomSuggestions" + }, + { + "description": "Use this method to obtain a list of search phrases that currently are very popular among all users across the Site.", + "id": "script-api:dw/suggest/SuggestModel#getPopularSearchPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getPopularSearchPhrases", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Use this method to obtain a list of search phrases\nthat currently are very popular among all users across the Site.\n\nThe search phrases are specific to the region (based on user's IP address),\nlanguage (locale) and the user's browser type (agent).", + "heading": "Description" + } + ], + "signature": "getPopularSearchPhrases(): utilIterator", + "source": "script-api", + "tags": [ + "getpopularsearchphrases", + "suggestmodel.getpopularsearchphrases" + ], + "title": "SuggestModel.getPopularSearchPhrases" + }, + { + "description": "Returns a ProductSuggestions container for the current search phrase. The ProductSuggestions container provides access to the found products (if any) and the terms suggested by the system with respect to the known products in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#getProductSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getProductSuggestions", + "returns": { + "type": "ProductSuggestions" + }, + "sections": [ + { + "body": "Returns a ProductSuggestions container for the current search phrase.\nThe ProductSuggestions container provides access to the found products (if any) and\nthe terms suggested by the system with respect to the known products in the catalog.", + "heading": "Description" + } + ], + "signature": "getProductSuggestions(): ProductSuggestions", + "source": "script-api", + "tags": [ + "getproductsuggestions", + "suggestmodel.getproductsuggestions" + ], + "title": "SuggestModel.getProductSuggestions" + }, + { + "description": "Use this method to obtain a list of personalized search phrases that the current user entered recently.", + "id": "script-api:dw/suggest/SuggestModel#getRecentSearchPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.getRecentSearchPhrases", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Use this method to obtain a list of personalized search phrases\nthat the current user entered recently.\n\nThe user is being identified by the CQuotient tracking cookie.", + "heading": "Description" + } + ], + "signature": "getRecentSearchPhrases(): utilIterator", + "source": "script-api", + "tags": [ + "getrecentsearchphrases", + "suggestmodel.getrecentsearchphrases" + ], + "title": "SuggestModel.getRecentSearchPhrases" + }, + { + "description": "The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not possible for search suggestions to contain Page Designer content as it belongs to no folder.", + "id": "script-api:dw/suggest/SuggestModel#isFilteredByFolder", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.isFilteredByFolder", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not\npossible for search suggestions to contain Page Designer content as it belongs to no folder.", + "heading": "Description" + } + ], + "signature": "isFilteredByFolder(): boolean", + "source": "script-api", + "tags": [ + "isfilteredbyfolder", + "suggestmodel.isfilteredbyfolder" + ], + "title": "SuggestModel.isFilteredByFolder" + }, + { + "description": "Use this method to obtain a list of search phrases that currently are very popular among all users across the Site.", + "id": "script-api:dw/suggest/SuggestModel#popularSearchPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.popularSearchPhrases", + "sections": [ + { + "body": "Use this method to obtain a list of search phrases\nthat currently are very popular among all users across the Site.\n\nThe search phrases are specific to the region (based on user's IP address),\nlanguage (locale) and the user's browser type (agent).", + "heading": "Description" + } + ], + "signature": "readonly popularSearchPhrases: utilIterator", + "source": "script-api", + "tags": [ + "popularsearchphrases", + "suggestmodel.popularsearchphrases" + ], + "title": "SuggestModel.popularSearchPhrases" + }, + { + "description": "Returns a ProductSuggestions container for the current search phrase. The ProductSuggestions container provides access to the found products (if any) and the terms suggested by the system with respect to the known products in the catalog.", + "id": "script-api:dw/suggest/SuggestModel#productSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.productSuggestions", + "sections": [ + { + "body": "Returns a ProductSuggestions container for the current search phrase.\nThe ProductSuggestions container provides access to the found products (if any) and\nthe terms suggested by the system with respect to the known products in the catalog.", + "heading": "Description" + } + ], + "signature": "readonly productSuggestions: ProductSuggestions", + "source": "script-api", + "tags": [ + "productsuggestions", + "suggestmodel.productsuggestions" + ], + "title": "SuggestModel.productSuggestions" + }, + { + "description": "Use this method to obtain a list of personalized search phrases that the current user entered recently.", + "id": "script-api:dw/suggest/SuggestModel#recentSearchPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.recentSearchPhrases", + "sections": [ + { + "body": "Use this method to obtain a list of personalized search phrases\nthat the current user entered recently.\n\nThe user is being identified by the CQuotient tracking cookie.", + "heading": "Description" + } + ], + "signature": "readonly recentSearchPhrases: utilIterator", + "source": "script-api", + "tags": [ + "recentsearchphrases", + "suggestmodel.recentsearchphrases" + ], + "title": "SuggestModel.recentSearchPhrases" + }, + { + "description": "Removes a refinement. The method can be called to remove previously added refinement values. The values string may encode multiple values delimited by the pipe symbol ('|').", + "id": "script-api:dw/suggest/SuggestModel#removeRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string | null" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.removeRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes a refinement. The method can be called to remove previously added\nrefinement values. The values string may encode multiple values delimited\nby the pipe symbol ('|').", + "heading": "Description" + } + ], + "signature": "removeRefinementValues(attributeID: string, values: string | null): void", + "source": "script-api", + "tags": [ + "removerefinementvalues", + "suggestmodel.removerefinementvalues" + ], + "title": "SuggestModel.removeRefinementValues" + }, + { + "description": "Apply a category ID to filter product, brand and category suggestions.", + "id": "script-api:dw/suggest/SuggestModel#setCategoryID", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "categoryID", + "type": "string" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setCategoryID", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Apply a category ID to filter product, brand and category suggestions.\n\nSuggested products, brands and categories, as well as corrected and completed\nterms are specific to the given category or one of it's sub categories.\n\nFor example, in the specified category \"television\", the search term \"pla\"\nwill be auto completed to \"plasma\" (instead of e.g. \"player\") and\nonly televisions will be included in the list of suggested products.", + "heading": "Description" + } + ], + "signature": "setCategoryID(categoryID: string): void", + "source": "script-api", + "tags": [ + "setcategoryid", + "suggestmodel.setcategoryid" + ], + "title": "SuggestModel.setCategoryID" + }, + { + "description": "Set a flag to indicate if the search suggestions filter for elements that do not belong to a folder. Must be set to false to return content assets that do not belong to any folder.", + "id": "script-api:dw/suggest/SuggestModel#setFilteredByFolder", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "filteredByFolder", + "type": "boolean" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setFilteredByFolder", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set a flag to indicate if the search suggestions filter for elements that do not belong to a folder.\nMust be set to false to return content assets that do not belong to any folder.", + "heading": "Description" + } + ], + "signature": "setFilteredByFolder(filteredByFolder: boolean): void", + "source": "script-api", + "tags": [ + "setfilteredbyfolder", + "suggestmodel.setfilteredbyfolder" + ], + "title": "SuggestModel.setFilteredByFolder" + }, + { + "description": "Use this method to setup the maximum number of returned suggested items. For example, set this to 3 in order to only retrieve the 3 most relevant suggested products.", + "id": "script-api:dw/suggest/SuggestModel#setMaxSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "maxSuggestions", + "type": "number" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setMaxSuggestions", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Use this method to setup the maximum number of returned suggested\nitems. For example, set this to 3 in order to only retrieve the\n3 most relevant suggested products.\n\nThe maximum number of suggestions that can be queried are defined as MAX_SUGGESTIONS.", + "heading": "Description" + } + ], + "signature": "setMaxSuggestions(maxSuggestions: number): void", + "source": "script-api", + "tags": [ + "setmaxsuggestions", + "suggestmodel.setmaxsuggestions" + ], + "title": "SuggestModel.setMaxSuggestions" + }, + { + "description": "Sets product suggestion refinement values for an attribute. The method can be called to set an additional query parameter specified as name-value pair. The value string may encode multiple values delimited by the pipe symbol ('|'). Existing refinement values for the attribute will be removed.", + "id": "script-api:dw/suggest/SuggestModel#setRefinementValues", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "attributeID", + "type": "string" + }, + { + "name": "values", + "type": "string | null" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setRefinementValues", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets product suggestion refinement values for an attribute.\nThe method can be called to set\nan additional query parameter specified as name-value pair. The value\nstring may encode multiple values delimited by the pipe symbol ('|').\nExisting refinement values for the attribute will be removed.", + "heading": "Description" + } + ], + "signature": "setRefinementValues(attributeID: string, values: string | null): void", + "source": "script-api", + "tags": [ + "setrefinementvalues", + "suggestmodel.setrefinementvalues" + ], + "title": "SuggestModel.setRefinementValues" + }, + { + "description": "Sets the user input search phrase. This search phrase is being processed by applying auto completion, spell correction and enhancement with alternative similar search terms.", + "id": "script-api:dw/suggest/SuggestModel#setSearchPhrase", + "kind": "method", + "packagePath": "dw/suggest", + "params": [ + { + "name": "searchPhrase", + "type": "string" + } + ], + "parentId": "script-api:dw/suggest/SuggestModel", + "qualifiedName": "dw.suggest.SuggestModel.setSearchPhrase", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the user input search phrase. This search phrase is being processed\nby applying auto completion, spell correction and enhancement with alternative\nsimilar search terms.\n\nThe resulting search phrase is used to lookup the actual items,\nlike products or categories (search-as-you-type).\n\nIn order to access the processed terms, one can use the\nSearchPhraseSuggestions.getSuggestedTerms method of each of the respective\nresults returned by the methods in this model.", + "heading": "Description" + } + ], + "signature": "setSearchPhrase(searchPhrase: string): void", + "source": "script-api", + "tags": [ + "setsearchphrase", + "suggestmodel.setsearchphrase" + ], + "title": "SuggestModel.setSearchPhrase" + }, + { + "description": "This class represents a suggested catalog category. Use getCategory method to get access to the actual dw.catalog.Category object.", + "id": "script-api:dw/suggest/SuggestedCategory", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedCategory", + "sections": [ + { + "body": "This class represents a suggested catalog category.\nUse getCategory method to get access to the actual dw.catalog.Category object.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedcategory", + "dw.suggest.suggestedcategory", + "dw/suggest" + ], + "title": "SuggestedCategory" + }, + { + "description": "This method returns the actual dw.catalog.Category object corresponding to this suggested category.", + "id": "script-api:dw/suggest/SuggestedCategory#category", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedCategory", + "qualifiedName": "dw.suggest.SuggestedCategory.category", + "sections": [ + { + "body": "This method returns the actual dw.catalog.Category object corresponding to this suggested category.", + "heading": "Description" + } + ], + "signature": "readonly category: Category", + "source": "script-api", + "tags": [ + "category", + "suggestedcategory.category" + ], + "title": "SuggestedCategory.category" + }, + { + "description": "This method returns the actual dw.catalog.Category object corresponding to this suggested category.", + "id": "script-api:dw/suggest/SuggestedCategory#getCategory", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedCategory", + "qualifiedName": "dw.suggest.SuggestedCategory.getCategory", + "returns": { + "type": "Category" + }, + "sections": [ + { + "body": "This method returns the actual dw.catalog.Category object corresponding to this suggested category.", + "heading": "Description" + } + ], + "signature": "getCategory(): Category", + "source": "script-api", + "tags": [ + "getcategory", + "suggestedcategory.getcategory" + ], + "title": "SuggestedCategory.getCategory" + }, + { + "description": "This class represents a suggested content page. Use getContent method to get access to the actual dw.content.Content object.", + "id": "script-api:dw/suggest/SuggestedContent", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedContent", + "sections": [ + { + "body": "This class represents a suggested content page.\nUse getContent method to get access to the actual dw.content.Content object.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedcontent", + "dw.suggest.suggestedcontent", + "dw/suggest" + ], + "title": "SuggestedContent" + }, + { + "description": "This method returns the actual dw.content.Content object corresponding to this suggested content.", + "id": "script-api:dw/suggest/SuggestedContent#content", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedContent", + "qualifiedName": "dw.suggest.SuggestedContent.content", + "sections": [ + { + "body": "This method returns the actual dw.content.Content object corresponding to this suggested content.", + "heading": "Description" + } + ], + "signature": "readonly content: Content", + "source": "script-api", + "tags": [ + "content", + "suggestedcontent.content" + ], + "title": "SuggestedContent.content" + }, + { + "description": "This method returns the actual dw.content.Content object corresponding to this suggested content.", + "id": "script-api:dw/suggest/SuggestedContent#getContent", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedContent", + "qualifiedName": "dw.suggest.SuggestedContent.getContent", + "returns": { + "type": "Content" + }, + "sections": [ + { + "body": "This method returns the actual dw.content.Content object corresponding to this suggested content.", + "heading": "Description" + } + ], + "signature": "getContent(): Content", + "source": "script-api", + "tags": [ + "getcontent", + "suggestedcontent.getcontent" + ], + "title": "SuggestedContent.getContent" + }, + { + "description": "This class represents a suggested phrase. Use getPhrase method to get access to the phrase.", + "id": "script-api:dw/suggest/SuggestedPhrase", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedPhrase", + "sections": [ + { + "body": "This class represents a suggested phrase.\nUse getPhrase method to get access to the phrase.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedphrase", + "dw.suggest.suggestedphrase", + "dw/suggest" + ], + "title": "SuggestedPhrase" + }, + { + "description": "This method returns a flag signaling whether this phrase is a exact match.", + "id": "script-api:dw/suggest/SuggestedPhrase#exactMatch", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.exactMatch", + "sections": [ + { + "body": "This method returns a flag signaling whether this phrase is a exact match.", + "heading": "Description" + } + ], + "signature": "readonly exactMatch: boolean", + "source": "script-api", + "tags": [ + "exactmatch", + "suggestedphrase.exactmatch" + ], + "title": "SuggestedPhrase.exactMatch" + }, + { + "description": "This method returns the actual phrase as a string value.", + "id": "script-api:dw/suggest/SuggestedPhrase#getPhrase", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.getPhrase", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "This method returns the actual phrase as a string value.", + "heading": "Description" + } + ], + "signature": "getPhrase(): string", + "source": "script-api", + "tags": [ + "getphrase", + "suggestedphrase.getphrase" + ], + "title": "SuggestedPhrase.getPhrase" + }, + { + "description": "This method returns a flag signaling whether this phrase is a exact match.", + "id": "script-api:dw/suggest/SuggestedPhrase#isExactMatch", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.isExactMatch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns a flag signaling whether this phrase is a exact match.", + "heading": "Description" + } + ], + "signature": "isExactMatch(): boolean", + "source": "script-api", + "tags": [ + "isexactmatch", + "suggestedphrase.isexactmatch" + ], + "title": "SuggestedPhrase.isExactMatch" + }, + { + "description": "This method returns the actual phrase as a string value.", + "id": "script-api:dw/suggest/SuggestedPhrase#phrase", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedPhrase", + "qualifiedName": "dw.suggest.SuggestedPhrase.phrase", + "sections": [ + { + "body": "This method returns the actual phrase as a string value.", + "heading": "Description" + } + ], + "signature": "readonly phrase: string", + "source": "script-api", + "tags": [ + "phrase", + "suggestedphrase.phrase" + ], + "title": "SuggestedPhrase.phrase" + }, + { + "description": "This class represents a suggested product. Use getProductSearchHit method to get access to the actual dw.catalog.ProductSearchHit object.", + "id": "script-api:dw/suggest/SuggestedProduct", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedProduct", + "sections": [ + { + "body": "This class represents a suggested product.\nUse getProductSearchHit method to get access to the actual dw.catalog.ProductSearchHit object.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedproduct", + "dw.suggest.suggestedproduct", + "dw/suggest" + ], + "title": "SuggestedProduct" + }, + { + "description": "This method returns the actual dw.catalog.ProductSearchHit object corresponding to this suggested product.", + "id": "script-api:dw/suggest/SuggestedProduct#getProductSearchHit", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedProduct", + "qualifiedName": "dw.suggest.SuggestedProduct.getProductSearchHit", + "returns": { + "type": "ProductSearchHit" + }, + "sections": [ + { + "body": "This method returns the actual dw.catalog.ProductSearchHit object\ncorresponding to this suggested product.", + "heading": "Description" + } + ], + "signature": "getProductSearchHit(): ProductSearchHit", + "source": "script-api", + "tags": [ + "getproductsearchhit", + "suggestedproduct.getproductsearchhit" + ], + "title": "SuggestedProduct.getProductSearchHit" + }, + { + "description": "This method returns the actual dw.catalog.ProductSearchHit object corresponding to this suggested product.", + "id": "script-api:dw/suggest/SuggestedProduct#productSearchHit", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedProduct", + "qualifiedName": "dw.suggest.SuggestedProduct.productSearchHit", + "sections": [ + { + "body": "This method returns the actual dw.catalog.ProductSearchHit object\ncorresponding to this suggested product.", + "heading": "Description" + } + ], + "signature": "readonly productSearchHit: ProductSearchHit", + "source": "script-api", + "tags": [ + "productsearchhit", + "suggestedproduct.productsearchhit" + ], + "title": "SuggestedProduct.productSearchHit" + }, + { + "description": "A single suggested term.", + "id": "script-api:dw/suggest/SuggestedTerm", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedTerm", + "sections": [ + { + "body": "A single suggested term.\n\nEach user input term of the search phrase\nis being processed separately by the suggestion engine. For each\noriginal term, a list of terms will be suggested, either completed terms,\ncorrected terms or even the exact term if it is known to the engine.\n\nEach suggested term is represented by a instance of this class. The list of suggested terms\nbelonging to a single original term is represented by a instance of SuggestedTerms class.\n\nThe suggested term value can either be the completed version of the original term,\nthe corrected version of the original term or exactly the original term.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedterm", + "dw.suggest.suggestedterm", + "dw/suggest" + ], + "title": "SuggestedTerm" + }, + { + "description": "Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.", + "id": "script-api:dw/suggest/SuggestedTerm#additional", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.additional", + "sections": [ + { + "body": "Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.", + "heading": "Description" + } + ], + "signature": "readonly additional: boolean", + "source": "script-api", + "tags": [ + "additional", + "suggestedterm.additional" + ], + "title": "SuggestedTerm.additional" + }, + { + "description": "Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.", + "id": "script-api:dw/suggest/SuggestedTerm#completed", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.completed", + "sections": [ + { + "body": "Returns whether this suggested term is a auto completed version of the original term.\nIn other words, this method returns true if the original term is a prefix of this suggested term.", + "heading": "Description" + } + ], + "signature": "readonly completed: boolean", + "source": "script-api", + "tags": [ + "completed", + "suggestedterm.completed" + ], + "title": "SuggestedTerm.completed" + }, + { + "description": "Returns whether this suggested term is a corrected version of the original term.", + "id": "script-api:dw/suggest/SuggestedTerm#corrected", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.corrected", + "sections": [ + { + "body": "Returns whether this suggested term is a corrected version of the original term.", + "heading": "Description" + } + ], + "signature": "readonly corrected: boolean", + "source": "script-api", + "tags": [ + "corrected", + "suggestedterm.corrected" + ], + "title": "SuggestedTerm.corrected" + }, + { + "description": "Returns whether this suggested term is exactly matching the original term.", + "id": "script-api:dw/suggest/SuggestedTerm#exactMatch", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.exactMatch", + "sections": [ + { + "body": "Returns whether this suggested term is exactly matching the original term.", + "heading": "Description" + } + ], + "signature": "readonly exactMatch: boolean", + "source": "script-api", + "tags": [ + "exactmatch", + "suggestedterm.exactmatch" + ], + "title": "SuggestedTerm.exactMatch" + }, + { + "description": "Returns this suggested term as String value.", + "id": "script-api:dw/suggest/SuggestedTerm#getValue", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.getValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns this suggested term as String value.", + "heading": "Description" + } + ], + "signature": "getValue(): string", + "source": "script-api", + "tags": [ + "getvalue", + "suggestedterm.getvalue" + ], + "title": "SuggestedTerm.getValue" + }, + { + "description": "Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.", + "id": "script-api:dw/suggest/SuggestedTerm#isAdditional", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isAdditional", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.", + "heading": "Description" + } + ], + "signature": "isAdditional(): boolean", + "source": "script-api", + "tags": [ + "isadditional", + "suggestedterm.isadditional" + ], + "title": "SuggestedTerm.isAdditional" + }, + { + "description": "Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.", + "id": "script-api:dw/suggest/SuggestedTerm#isCompleted", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isCompleted", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggested term is a auto completed version of the original term.\nIn other words, this method returns true if the original term is a prefix of this suggested term.", + "heading": "Description" + } + ], + "signature": "isCompleted(): boolean", + "source": "script-api", + "tags": [ + "iscompleted", + "suggestedterm.iscompleted" + ], + "title": "SuggestedTerm.isCompleted" + }, + { + "description": "Returns whether this suggested term is a corrected version of the original term.", + "id": "script-api:dw/suggest/SuggestedTerm#isCorrected", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isCorrected", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggested term is a corrected version of the original term.", + "heading": "Description" + } + ], + "signature": "isCorrected(): boolean", + "source": "script-api", + "tags": [ + "iscorrected", + "suggestedterm.iscorrected" + ], + "title": "SuggestedTerm.isCorrected" + }, + { + "description": "Returns whether this suggested term is exactly matching the original term.", + "id": "script-api:dw/suggest/SuggestedTerm#isExactMatch", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.isExactMatch", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggested term is exactly matching the original term.", + "heading": "Description" + } + ], + "signature": "isExactMatch(): boolean", + "source": "script-api", + "tags": [ + "isexactmatch", + "suggestedterm.isexactmatch" + ], + "title": "SuggestedTerm.isExactMatch" + }, + { + "description": "Returns this suggested term as String value.", + "id": "script-api:dw/suggest/SuggestedTerm#value", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerm", + "qualifiedName": "dw.suggest.SuggestedTerm.value", + "sections": [ + { + "body": "Returns this suggested term as String value.", + "heading": "Description" + } + ], + "signature": "readonly value: string", + "source": "script-api", + "tags": [ + "value", + "suggestedterm.value" + ], + "title": "SuggestedTerm.value" + }, + { + "description": "This container represents a list of suggested terms, all belonging to a particular single original term of the users input search phrase.", + "id": "script-api:dw/suggest/SuggestedTerms", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.SuggestedTerms", + "sections": [ + { + "body": "This container represents a list of suggested terms, all belonging to a\nparticular single original term of the users input search phrase.\n\nEach user input term of the search phrase\nis being processed separately by the suggestion engine. For each\noriginal term, a list of terms will be suggested, either completed terms,\ncorrected terms or even the exact term if they are known to the engine as they are.\n\nA instance of this class refers to the original unmodified term, as well as\nto a list of SuggestedTerms objects representing a single suggested term.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestedterms", + "dw.suggest.suggestedterms", + "dw/suggest" + ], + "title": "SuggestedTerms" + }, + { + "description": "Returns true if this set of suggested terms is empty.", + "id": "script-api:dw/suggest/SuggestedTerms#empty", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.empty", + "sections": [ + { + "body": "Returns true if this set of suggested terms is empty.", + "heading": "Description" + } + ], + "signature": "readonly empty: boolean", + "source": "script-api", + "tags": [ + "empty", + "suggestedterms.empty" + ], + "title": "SuggestedTerms.empty" + }, + { + "description": "This method returns the suggested term which is considered best matching with the original term. See getTerms for a note on ordering of suggested terms.", + "id": "script-api:dw/suggest/SuggestedTerms#firstTerm", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.firstTerm", + "sections": [ + { + "body": "This method returns the suggested term which is considered best matching\nwith the original term. See getTerms for a note on ordering of\nsuggested terms.", + "heading": "Description" + } + ], + "signature": "readonly firstTerm: SuggestedTerm", + "source": "script-api", + "tags": [ + "firstterm", + "suggestedterms.firstterm" + ], + "title": "SuggestedTerms.firstTerm" + }, + { + "description": "This method returns the suggested term which is considered best matching with the original term. See getTerms for a note on ordering of suggested terms.", + "id": "script-api:dw/suggest/SuggestedTerms#getFirstTerm", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getFirstTerm", + "returns": { + "type": "SuggestedTerm" + }, + "sections": [ + { + "body": "This method returns the suggested term which is considered best matching\nwith the original term. See getTerms for a note on ordering of\nsuggested terms.", + "heading": "Description" + } + ], + "signature": "getFirstTerm(): SuggestedTerm", + "source": "script-api", + "tags": [ + "getfirstterm", + "suggestedterms.getfirstterm" + ], + "title": "SuggestedTerms.getFirstTerm" + }, + { + "description": "Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.", + "id": "script-api:dw/suggest/SuggestedTerms#getOriginalTerm", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getOriginalTerm", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the original term of the user input, for which this instance\nprovides a list of suggested terms. Suggested terms can either be corrected,\nor completed or exact matching.", + "heading": "Description" + } + ], + "signature": "getOriginalTerm(): string", + "source": "script-api", + "tags": [ + "getoriginalterm", + "suggestedterms.getoriginalterm" + ], + "title": "SuggestedTerms.getOriginalTerm" + }, + { + "description": "Returns the list of SuggestedTerms suggested for the original term.", + "id": "script-api:dw/suggest/SuggestedTerms#getTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.getTerms", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns the list of SuggestedTerms suggested for the original term.", + "heading": "Description" + } + ], + "signature": "getTerms(): utilIterator", + "source": "script-api", + "tags": [ + "getterms", + "suggestedterms.getterms" + ], + "title": "SuggestedTerms.getTerms" + }, + { + "description": "Returns true if this set of suggested terms is empty.", + "id": "script-api:dw/suggest/SuggestedTerms#isEmpty", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.isEmpty", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if this set of suggested terms is empty.", + "heading": "Description" + } + ], + "signature": "isEmpty(): boolean", + "source": "script-api", + "tags": [ + "isempty", + "suggestedterms.isempty" + ], + "title": "SuggestedTerms.isEmpty" + }, + { + "description": "Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.", + "id": "script-api:dw/suggest/SuggestedTerms#originalTerm", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.originalTerm", + "sections": [ + { + "body": "Returns the original term of the user input, for which this instance\nprovides a list of suggested terms. Suggested terms can either be corrected,\nor completed or exact matching.", + "heading": "Description" + } + ], + "signature": "readonly originalTerm: string", + "source": "script-api", + "tags": [ + "originalterm", + "suggestedterms.originalterm" + ], + "title": "SuggestedTerms.originalTerm" + }, + { + "description": "Returns the list of SuggestedTerms suggested for the original term.", + "id": "script-api:dw/suggest/SuggestedTerms#terms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/SuggestedTerms", + "qualifiedName": "dw.suggest.SuggestedTerms.terms", + "sections": [ + { + "body": "Returns the list of SuggestedTerms suggested for the original term.", + "heading": "Description" + } + ], + "signature": "readonly terms: utilIterator", + "source": "script-api", + "tags": [ + "terms", + "suggestedterms.terms" + ], + "title": "SuggestedTerms.terms" + }, + { + "description": "This is the base class for suggestions containers. For each type of items, a sub class provides methods to access the actual items.", + "id": "script-api:dw/suggest/Suggestions", + "kind": "class", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest", + "qualifiedName": "dw.suggest.Suggestions", + "sections": [ + { + "body": "This is the base class for suggestions containers.\nFor each type of items, a sub class provides methods to\naccess the actual items.\n\nSee the sub classes for more specific information.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "suggestions", + "dw.suggest.suggestions", + "dw/suggest" + ], + "title": "Suggestions" + }, + { + "description": "Returns the suggested search phrases that are associated to this suggestions.", + "id": "script-api:dw/suggest/Suggestions#getSearchPhraseSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSearchPhraseSuggestions", + "returns": { + "type": "SearchPhraseSuggestions" + }, + "sections": [ + { + "body": "Returns the suggested search phrases that are associated to this suggestions.\n\nIn contrast to the suggested items, the suggested phrases contains the corrected and\ncompleted versions of the original search phrase.", + "heading": "Description" + } + ], + "signature": "getSearchPhraseSuggestions(): SearchPhraseSuggestions", + "source": "script-api", + "tags": [ + "getsearchphrasesuggestions", + "suggestions.getsearchphrasesuggestions" + ], + "title": "Suggestions.getSearchPhraseSuggestions" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the user input search phrase.", + "id": "script-api:dw/suggest/Suggestions#getSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSuggestedPhrases", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the\nuser input search phrase.", + "heading": "Description" + } + ], + "signature": "getSuggestedPhrases(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedphrases", + "suggestions.getsuggestedphrases" + ], + "title": "Suggestions.getSuggestedPhrases" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.", + "id": "script-api:dw/suggest/Suggestions#getSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.getSuggestedTerms", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned\ninstances represents a set of terms suggested for a particular single term\nof the user input search phrase.", + "heading": "Description" + } + ], + "signature": "getSuggestedTerms(): utilIterator", + "source": "script-api", + "tags": [ + "getsuggestedterms", + "suggestions.getsuggestedterms" + ], + "title": "Suggestions.getSuggestedTerms" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns whether this suggestions container has any suggested phrases.", + "id": "script-api:dw/suggest/Suggestions#hasSuggestedPhrases", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestedPhrases", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggestions container has any suggested phrases.\n\nNote that this method only looks for suggested phrases. It does not account\nfor suggested terms or suggested objects. In other words,\neven if there are suggested terms or objects, this method\nwill return false if this suggestions container has no phrases.", + "heading": "Description" + } + ], + "signature": "hasSuggestedPhrases(): boolean", + "source": "script-api", + "tags": [ + "hassuggestedphrases", + "suggestions.hassuggestedphrases" + ], + "title": "Suggestions.hasSuggestedPhrases" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns whether this suggestions container has any suggested terms.", + "id": "script-api:dw/suggest/Suggestions#hasSuggestedTerms", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestedTerms", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggestions container has any suggested terms.\n\nNote that this method checks suggested terms only,\nbut not suggested phrases or suggested objects.", + "heading": "Description" + } + ], + "signature": "hasSuggestedTerms(): boolean", + "source": "script-api", + "tags": [ + "hassuggestedterms", + "suggestions.hassuggestedterms" + ], + "title": "Suggestions.hasSuggestedTerms" + }, + { + "description": "Returns whether this suggestions container has any suggested items, i.e. products.", + "id": "script-api:dw/suggest/Suggestions#hasSuggestions", + "kind": "method", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.hasSuggestions", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this suggestions container has any suggested items, i.e. products.\n\nNote that this method only looks for concrete suggested items. It does not account\nfor suggested terms. In other words, even if there are suggested terms, this method\nwill return false if no matching items, like products or categories, were found\nfor the suggested terms.\n\nTo find out whether there are suggested terms and how they match with respect to\nthe original search phrase, one can use dw.suggest.Suggestions.getSuggestedTerms to obtain\na list of dw.suggest.SuggestedTerms.", + "heading": "Description" + } + ], + "signature": "hasSuggestions(): boolean", + "source": "script-api", + "tags": [ + "hassuggestions", + "suggestions.hassuggestions" + ], + "title": "Suggestions.hasSuggestions" + }, + { + "description": "Returns the suggested search phrases that are associated to this suggestions.", + "id": "script-api:dw/suggest/Suggestions#searchPhraseSuggestions", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.searchPhraseSuggestions", + "sections": [ + { + "body": "Returns the suggested search phrases that are associated to this suggestions.\n\nIn contrast to the suggested items, the suggested phrases contains the corrected and\ncompleted versions of the original search phrase.", + "heading": "Description" + } + ], + "signature": "readonly searchPhraseSuggestions: SearchPhraseSuggestions", + "source": "script-api", + "tags": [ + "searchphrasesuggestions", + "suggestions.searchphrasesuggestions" + ], + "title": "Suggestions.searchPhraseSuggestions" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the user input search phrase.", + "id": "script-api:dw/suggest/Suggestions#suggestedPhrases", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.suggestedPhrases", + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedPhrase objects that relates to the\nuser input search phrase.", + "heading": "Description" + } + ], + "signature": "readonly suggestedPhrases: utilIterator", + "source": "script-api", + "tags": [ + "suggestedphrases", + "suggestions.suggestedphrases" + ], + "title": "Suggestions.suggestedPhrases" + }, + { + "deprecated": { + "message": "Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases." + }, + "description": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.", + "id": "script-api:dw/suggest/Suggestions#suggestedTerms", + "kind": "property", + "packagePath": "dw/suggest", + "parentId": "script-api:dw/suggest/Suggestions", + "qualifiedName": "dw.suggest.Suggestions.suggestedTerms", + "sections": [ + { + "body": "Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned\ninstances represents a set of terms suggested for a particular single term\nof the user input search phrase.", + "heading": "Description" + } + ], + "signature": "readonly suggestedTerms: utilIterator", + "source": "script-api", + "tags": [ + "suggestedterms", + "suggestions.suggestedterms" + ], + "title": "Suggestions.suggestedTerms" + }, + { + "description": "17 declarations", + "id": "script-api:dw/svc", + "kind": "package", + "packagePath": "dw/svc", + "qualifiedName": "dw.svc", + "source": "script-api", + "tags": [ + "dw/svc", + "dw.svc" + ], + "title": "dw.svc" + }, + { + "description": "Represents an FTP or SFTP Service.", + "id": "script-api:dw/svc/FTPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.FTPService", + "sections": [ + { + "body": "Represents an FTP or SFTP Service.\n\nThere are two basic styles of configuration for this service.\n\nIn the first style, `createRequest` is implemented to call the setOperation method on the Service. This\nwill cause the single operation to be performed and returned as the data object in the `parseResponse`\nmethod. Any error status is set automatically based on the returned value of the operation.\n\nIn the second style, `execute` is implemented to perform one or more operations using the serviceClient\navailable on the Service object. This serviceClient will be either an dw.net.FTPClient or an\ndw.net.SFTPClient. The return value of execute will be passed as the data object in the\n`parseResponse` method.\n\nNote that the use of the FTP client is deprecated, and SFTP should be used instead.", + "heading": "Description" + }, + { + "body": "Extends `Service`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "ftpservice", + "dw.svc.ftpservice", + "dw/svc" + ], + "title": "FTPService" + }, + { + "description": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "id": "script-api:dw/svc/FTPService#autoDisconnect", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.autoDisconnect", + "sections": [ + { + "body": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "heading": "Description" + } + ], + "signature": "autoDisconnect: boolean", + "source": "script-api", + "tags": [ + "autodisconnect", + "ftpservice.autodisconnect" + ], + "title": "FTPService.autoDisconnect" + }, + { + "description": "Returns the underlying client object.", + "id": "script-api:dw/svc/FTPService#client", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.client", + "sections": [ + { + "body": "Returns the underlying client object.\n\nThis is either an dw.net.FTPClient or dw.net.SFTPClient, depending on the protocol.", + "heading": "Description" + } + ], + "signature": "readonly client: any", + "source": "script-api", + "tags": [ + "client", + "ftpservice.client" + ], + "title": "FTPService.client" + }, + { + "description": "Returns the underlying client object.", + "id": "script-api:dw/svc/FTPService#getClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.getClient", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the underlying client object.\n\nThis is either an dw.net.FTPClient or dw.net.SFTPClient, depending on the protocol.", + "heading": "Description" + } + ], + "signature": "getClient(): any", + "source": "script-api", + "tags": [ + "getclient", + "ftpservice.getclient" + ], + "title": "FTPService.getClient" + }, + { + "description": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "id": "script-api:dw/svc/FTPService#isAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.isAutoDisconnect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "heading": "Description" + } + ], + "signature": "isAutoDisconnect(): boolean", + "source": "script-api", + "tags": [ + "isautodisconnect", + "ftpservice.isautodisconnect" + ], + "title": "FTPService.isAutoDisconnect" + }, + { + "description": "Sets the auto-disconnect flag.", + "id": "script-api:dw/svc/FTPService#setAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "b", + "type": "boolean" + } + ], + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.setAutoDisconnect", + "returns": { + "type": "FTPService" + }, + "sections": [ + { + "body": "Sets the auto-disconnect flag.\n\nIf true, the underlying FTP connection will be disconnected after the service call. If false then it will remain\nopen. The default value is true.", + "heading": "Description" + } + ], + "signature": "setAutoDisconnect(b: boolean): FTPService", + "source": "script-api", + "tags": [ + "setautodisconnect", + "ftpservice.setautodisconnect" + ], + "title": "FTPService.setAutoDisconnect" + }, + { + "description": "Sets a single operation to perform during the execute phase of the service.", + "id": "script-api:dw/svc/FTPService#setOperation", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/svc/FTPService", + "qualifiedName": "dw.svc.FTPService.setOperation", + "returns": { + "type": "FTPService" + }, + "sections": [ + { + "body": "Sets a single operation to perform during the execute phase of the service.\n\nThe given arguments make up a method name and arguments on the underlying getClient object. This\nmethod will be invoked during execution, with the result passed into the callback's parseResponse method.\n\nThis is required unless the callback defines an execute method.", + "heading": "Description" + } + ], + "signature": "setOperation(name: string, args?: any[]): FTPService", + "source": "script-api", + "tags": [ + "setoperation", + "ftpservice.setoperation" + ], + "title": "FTPService.setOperation" + }, + { + "deprecated": { + "message": "This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry\ninstead, which allows configuration on the FTPService directly." + }, + "description": "Represents an FTP or SFTP Service Definition.", + "id": "script-api:dw/svc/FTPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.FTPServiceDefinition", + "sections": [ + { + "body": "Represents an FTP or SFTP Service Definition.\n\nThere are two basic styles of configuration for this service.\n\nIn the first style, `createRequest` is implemented to call the setOperation method on the Service. This\nwill cause the single operation to be performed and returned as the data object in the `parseResponse`\nmethod. Any error status is set automatically based on the returned value of the operation.\n\nIn the second style, `execute` is implemented to perform one or more operations using the serviceClient\navailable on the Service object. This serviceClient will be either an dw.net.FTPClient or an\ndw.net.SFTPClient. The return value of execute will be passed as the data object in the\n`parseResponse` method.", + "heading": "Description" + }, + { + "body": "Extends `ServiceDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "ftpservicedefinition", + "dw.svc.ftpservicedefinition", + "dw/svc" + ], + "title": "FTPServiceDefinition" + }, + { + "description": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "id": "script-api:dw/svc/FTPServiceDefinition#autoDisconnect", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.autoDisconnect", + "sections": [ + { + "body": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "heading": "Description" + } + ], + "signature": "autoDisconnect: boolean", + "source": "script-api", + "tags": [ + "autodisconnect", + "ftpservicedefinition.autodisconnect" + ], + "title": "FTPServiceDefinition.autoDisconnect" + }, + { + "description": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "id": "script-api:dw/svc/FTPServiceDefinition#isAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.isAutoDisconnect", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the underlying FTP connection will be disconnected after the service call.", + "heading": "Description" + } + ], + "signature": "isAutoDisconnect(): boolean", + "source": "script-api", + "tags": [ + "isautodisconnect", + "ftpservicedefinition.isautodisconnect" + ], + "title": "FTPServiceDefinition.isAutoDisconnect" + }, + { + "description": "Sets the auto-disconnect flag.", + "id": "script-api:dw/svc/FTPServiceDefinition#setAutoDisconnect", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "b", + "type": "boolean" + } + ], + "parentId": "script-api:dw/svc/FTPServiceDefinition", + "qualifiedName": "dw.svc.FTPServiceDefinition.setAutoDisconnect", + "returns": { + "type": "FTPServiceDefinition" + }, + "sections": [ + { + "body": "Sets the auto-disconnect flag.\n\nIf true, the underlying FTP connection will be disconnected after the service call. If false then it will remain\nopen. The default value is true.", + "heading": "Description" + } + ], + "signature": "setAutoDisconnect(b: boolean): FTPServiceDefinition", + "source": "script-api", + "tags": [ + "setautodisconnect", + "ftpservicedefinition.setautodisconnect" + ], + "title": "FTPServiceDefinition.setAutoDisconnect" + }, + { + "description": "Represents an HTTP Form POST Service.", + "id": "script-api:dw/svc/HTTPFormService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPFormService", + "sections": [ + { + "body": "Represents an HTTP Form POST Service.\n\nAll arguments passed to the Service.call method will be URL-encoded and set as name/value\npairs in the HTTP request body. The HTTP request will be a POST with a content-type of\n`application/x-www-form-urlencoded`.", + "heading": "Description" + }, + { + "body": "Extends `HTTPService`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "httpformservice", + "dw.svc.httpformservice", + "dw/svc" + ], + "title": "HTTPFormService" + }, + { + "deprecated": { + "message": "This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry\ninstead, which allows configuration on the HTTPFormService directly." + }, + "description": "Represents an HTTP Form POST Service Definition.", + "id": "script-api:dw/svc/HTTPFormServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPFormServiceDefinition", + "sections": [ + { + "body": "Represents an HTTP Form POST Service Definition.", + "heading": "Description" + }, + { + "body": "Extends `HTTPServiceDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "httpformservicedefinition", + "dw.svc.httpformservicedefinition", + "dw/svc" + ], + "title": "HTTPFormServiceDefinition" + }, + { + "description": "Represents an HTTP Service.", + "id": "script-api:dw/svc/HTTPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPService", + "sections": [ + { + "body": "Represents an HTTP Service.\n\nThe HTTP Service will use the return value of the createRequest callback as the request body (if supported by the\nHTTP method). If this is an array of non-null dw.net.HTTPRequestPart objects, then a multi-part request will\nbe formed. Otherwise the object is converted to a String and used.\n\nSee also TopLevel.XML.toXMLString and TopLevel.JSON.stringify, which must be\nexplicitly called if needed.", + "heading": "Description" + }, + { + "body": "Extends `Service`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "httpservice", + "dw.svc.httpservice", + "dw/svc" + ], + "title": "HTTPService" + }, + { + "description": "Adds an HTTP Header.", + "id": "script-api:dw/svc/HTTPService#addHeader", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "val", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.addHeader", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Adds an HTTP Header.", + "heading": "Description" + } + ], + "signature": "addHeader(name: string, val: string): HTTPService", + "source": "script-api", + "tags": [ + "addheader", + "httpservice.addheader" + ], + "title": "HTTPService.addHeader" + }, + { + "description": "Adds a query parameter that will be appended to the URL.", + "id": "script-api:dw/svc/HTTPService#addParam", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "val", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.addParam", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Adds a query parameter that will be appended to the URL.", + "heading": "Description" + } + ], + "signature": "addParam(name: string, val: string): HTTPService", + "source": "script-api", + "tags": [ + "addparam", + "httpservice.addparam" + ], + "title": "HTTPService.addParam" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/HTTPService#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.authentication", + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "authentication: string", + "source": "script-api", + "tags": [ + "authentication", + "httpservice.authentication" + ], + "title": "HTTPService.authentication" + }, + { + "description": "Returns the caching time to live value.", + "id": "script-api:dw/svc/HTTPService#cachingTTL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.cachingTTL", + "sections": [ + { + "body": "Returns the caching time to live value.", + "heading": "Description" + } + ], + "signature": "cachingTTL: number", + "source": "script-api", + "tags": [ + "cachingttl", + "httpservice.cachingttl" + ], + "title": "HTTPService.cachingTTL" + }, + { + "description": "Returns the underlying HTTP client object.", + "id": "script-api:dw/svc/HTTPService#client", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.client", + "sections": [ + { + "body": "Returns the underlying HTTP client object.", + "heading": "Description" + } + ], + "signature": "readonly client: HTTPClient", + "source": "script-api", + "tags": [ + "client", + "httpservice.client" + ], + "title": "HTTPService.client" + }, + { + "description": "Returns the request body encoding to declare.", + "id": "script-api:dw/svc/HTTPService#encoding", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.encoding", + "sections": [ + { + "body": "Returns the request body encoding to declare.", + "heading": "Description" + } + ], + "signature": "encoding: string", + "source": "script-api", + "tags": [ + "encoding", + "httpservice.encoding" + ], + "title": "HTTPService.encoding" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/HTTPService#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getAuthentication", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "getAuthentication(): string", + "source": "script-api", + "tags": [ + "getauthentication", + "httpservice.getauthentication" + ], + "title": "HTTPService.getAuthentication" + }, + { + "description": "Returns the caching time to live value.", + "id": "script-api:dw/svc/HTTPService#getCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getCachingTTL", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the caching time to live value.", + "heading": "Description" + } + ], + "signature": "getCachingTTL(): number", + "source": "script-api", + "tags": [ + "getcachingttl", + "httpservice.getcachingttl" + ], + "title": "HTTPService.getCachingTTL" + }, + { + "description": "Returns the underlying HTTP client object.", + "id": "script-api:dw/svc/HTTPService#getClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getClient", + "returns": { + "type": "HTTPClient" + }, + "sections": [ + { + "body": "Returns the underlying HTTP client object.", + "heading": "Description" + } + ], + "signature": "getClient(): HTTPClient", + "source": "script-api", + "tags": [ + "getclient", + "httpservice.getclient" + ], + "title": "HTTPService.getClient" + }, + { + "description": "Returns the request body encoding to declare.", + "id": "script-api:dw/svc/HTTPService#getEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getEncoding", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the request body encoding to declare.", + "heading": "Description" + } + ], + "signature": "getEncoding(): string", + "source": "script-api", + "tags": [ + "getencoding", + "httpservice.getencoding" + ], + "title": "HTTPService.getEncoding" + }, + { + "description": "Determines whether host name verification is enabled.", + "id": "script-api:dw/svc/HTTPService#getHostNameVerification", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getHostNameVerification", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Determines whether host name verification is enabled.", + "heading": "Description" + } + ], + "signature": "getHostNameVerification(): boolean", + "source": "script-api", + "tags": [ + "gethostnameverification", + "httpservice.gethostnameverification" + ], + "title": "HTTPService.getHostNameVerification" + }, + { + "description": "Gets the identity used for mutual TLS (mTLS).", + "id": "script-api:dw/svc/HTTPService#getIdentity", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getIdentity", + "returns": { + "type": "KeyRef | null" + }, + "sections": [ + { + "body": "Gets the identity used for mutual TLS (mTLS).", + "heading": "Description" + } + ], + "signature": "getIdentity(): KeyRef | null", + "source": "script-api", + "tags": [ + "getidentity", + "httpservice.getidentity" + ], + "title": "HTTPService.getIdentity" + }, + { + "description": "Returns the output file, or null if there is none.", + "id": "script-api:dw/svc/HTTPService#getOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getOutFile", + "returns": { + "type": "File | null" + }, + "sections": [ + { + "body": "Returns the output file, or null if there is none.", + "heading": "Description" + } + ], + "signature": "getOutFile(): File | null", + "source": "script-api", + "tags": [ + "getoutfile", + "httpservice.getoutfile" + ], + "title": "HTTPService.getOutFile" + }, + { + "description": "Returns the request method.", + "id": "script-api:dw/svc/HTTPService#getRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.getRequestMethod", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the request method.", + "heading": "Description" + } + ], + "signature": "getRequestMethod(): string", + "source": "script-api", + "tags": [ + "getrequestmethod", + "httpservice.getrequestmethod" + ], + "title": "HTTPService.getRequestMethod" + }, + { + "description": "Determines whether host name verification is enabled.", + "id": "script-api:dw/svc/HTTPService#hostNameVerification", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.hostNameVerification", + "sections": [ + { + "body": "Determines whether host name verification is enabled.", + "heading": "Description" + } + ], + "signature": "hostNameVerification: boolean", + "source": "script-api", + "tags": [ + "hostnameverification", + "httpservice.hostnameverification" + ], + "title": "HTTPService.hostNameVerification" + }, + { + "description": "Gets the identity used for mutual TLS (mTLS).", + "id": "script-api:dw/svc/HTTPService#identity", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.identity", + "sections": [ + { + "body": "Gets the identity used for mutual TLS (mTLS).", + "heading": "Description" + } + ], + "signature": "identity: KeyRef | null", + "source": "script-api", + "tags": [ + "identity", + "httpservice.identity" + ], + "title": "HTTPService.identity" + }, + { + "description": "Returns the output file, or null if there is none.", + "id": "script-api:dw/svc/HTTPService#outFile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.outFile", + "sections": [ + { + "body": "Returns the output file, or null if there is none.", + "heading": "Description" + } + ], + "signature": "outFile: File | null", + "source": "script-api", + "tags": [ + "outfile", + "httpservice.outfile" + ], + "title": "HTTPService.outFile" + }, + { + "description": "Returns the request method.", + "id": "script-api:dw/svc/HTTPService#requestMethod", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.requestMethod", + "sections": [ + { + "body": "Returns the request method.", + "heading": "Description" + } + ], + "signature": "requestMethod: string", + "source": "script-api", + "tags": [ + "requestmethod", + "httpservice.requestmethod" + ], + "title": "HTTPService.requestMethod" + }, + { + "description": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".", + "id": "script-api:dw/svc/HTTPService#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "authentication", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setAuthentication", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".\n\nThe default value is BASIC.", + "heading": "Description" + } + ], + "signature": "setAuthentication(authentication: string): HTTPService", + "source": "script-api", + "tags": [ + "setauthentication", + "httpservice.setauthentication" + ], + "title": "HTTPService.setAuthentication" + }, + { + "description": "Enables caching for GET requests.", + "id": "script-api:dw/svc/HTTPService#setCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "ttl", + "type": "number" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setCachingTTL", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Enables caching for GET requests.\n\nThis only caches status codes 2xx with a content length and size of less than 50k that are not immediately\nwritten to file. The URL and the user name are used as cache keys. The total size of cacheable content and the\nnumber of cached items is limited and automatically managed by the system.\n\nCache control information sent by the remote server is ignored.\n\nCaching HTTP responses should be done very carefully. It is important to ensure that the response really depends\nonly on the URL and doesn't contain any remote state information or time information which is independent of the\nURL. It is also important to verify that the application sends exactly the same URL multiple times.", + "heading": "Description" + } + ], + "signature": "setCachingTTL(ttl: number): HTTPService", + "source": "script-api", + "tags": [ + "setcachingttl", + "httpservice.setcachingttl" + ], + "title": "HTTPService.setCachingTTL" + }, + { + "description": "Sets the encoding of the request body (if any).", + "id": "script-api:dw/svc/HTTPService#setEncoding", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setEncoding", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets the encoding of the request body (if any).\n\nThe default value is UTF-8.", + "heading": "Description" + } + ], + "signature": "setEncoding(encoding: string): HTTPService", + "source": "script-api", + "tags": [ + "setencoding", + "httpservice.setencoding" + ], + "title": "HTTPService.setEncoding" + }, + { + "description": "Sets whether certificate host name verification is enabled. The default value is true. Set it to false to disable host name verification.", + "id": "script-api:dw/svc/HTTPService#setHostNameVerification", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "enable", + "type": "boolean" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setHostNameVerification", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets whether certificate host name verification is enabled.\nThe default value is true. Set it to false to disable host name verification.", + "heading": "Description" + } + ], + "signature": "setHostNameVerification(enable: boolean): HTTPService", + "source": "script-api", + "tags": [ + "sethostnameverification", + "httpservice.sethostnameverification" + ], + "title": "HTTPService.setHostNameVerification" + }, + { + "description": "Sets the identity (private key) to use when mutual TLS (mTLS) is configured.", + "id": "script-api:dw/svc/HTTPService#setIdentity", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "keyRef", + "type": "KeyRef" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setIdentity", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets the identity (private key) to use when mutual TLS (mTLS) is configured.\n\nIf this is not set and mTLS is used then the private key will be chosen from the key store based on the host\nname.\nIf this is set to a reference named \"__NONE__\" then no private key will be used even if one is requested by the remote server.", + "heading": "Description" + } + ], + "signature": "setIdentity(keyRef: KeyRef): HTTPService", + "source": "script-api", + "tags": [ + "setidentity", + "httpservice.setidentity" + ], + "title": "HTTPService.setIdentity" + }, + { + "description": "Sets the output file in which to write the HTTP response body.", + "id": "script-api:dw/svc/HTTPService#setOutFile", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "outFile", + "type": "File | null" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setOutFile", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets the output file in which to write the HTTP response body.\n\nThe default behavior is to not write a file.", + "heading": "Description" + } + ], + "signature": "setOutFile(outFile: File | null): HTTPService", + "source": "script-api", + "tags": [ + "setoutfile", + "httpservice.setoutfile" + ], + "title": "HTTPService.setOutFile" + }, + { + "description": "Sets the HTTP request method.", + "id": "script-api:dw/svc/HTTPService#setRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "requestMethod", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPService", + "qualifiedName": "dw.svc.HTTPService.setRequestMethod", + "returns": { + "type": "HTTPService" + }, + "sections": [ + { + "body": "Sets the HTTP request method.\n\nValid values include GET, PUT, POST, and DELETE.\n\nThe default value is POST.", + "heading": "Description" + } + ], + "signature": "setRequestMethod(requestMethod: string): HTTPService", + "source": "script-api", + "tags": [ + "setrequestmethod", + "httpservice.setrequestmethod" + ], + "title": "HTTPService.setRequestMethod" + }, + { + "deprecated": { + "message": "This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry\ninstead, which allows configuration on the HTTPService directly." + }, + "description": "Represents an HTTP Service Definition.", + "id": "script-api:dw/svc/HTTPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.HTTPServiceDefinition", + "sections": [ + { + "body": "Represents an HTTP Service Definition.\n\nThe HTTP Service will use the return value of the createRequest callback as the request body (if supported by the\nHTTP method). If this is an array of non-null dw.net.HTTPRequestPart objects, then a multi-part request will\nbe formed. Otherwise the object is converted to a String and used.\n\nSee also TopLevel.XML.toXMLString and TopLevel.JSON.stringify, which must be\nexplicitly called if needed.", + "heading": "Description" + }, + { + "body": "Extends `ServiceDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "httpservicedefinition", + "dw.svc.httpservicedefinition", + "dw/svc" + ], + "title": "HTTPServiceDefinition" + }, + { + "description": "Adds an HTTP Header.", + "id": "script-api:dw/svc/HTTPServiceDefinition#addHeader", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "val", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.addHeader", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Adds an HTTP Header.", + "heading": "Description" + } + ], + "signature": "addHeader(name: string, val: string): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "addheader", + "httpservicedefinition.addheader" + ], + "title": "HTTPServiceDefinition.addHeader" + }, + { + "description": "Adds a query parameter that will be appended to the URL.", + "id": "script-api:dw/svc/HTTPServiceDefinition#addParam", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "val", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.addParam", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Adds a query parameter that will be appended to the URL.", + "heading": "Description" + } + ], + "signature": "addParam(name: string, val: string): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "addparam", + "httpservicedefinition.addparam" + ], + "title": "HTTPServiceDefinition.addParam" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/HTTPServiceDefinition#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.authentication", + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "authentication: string", + "source": "script-api", + "tags": [ + "authentication", + "httpservicedefinition.authentication" + ], + "title": "HTTPServiceDefinition.authentication" + }, + { + "description": "Returns the caching time to live value.", + "id": "script-api:dw/svc/HTTPServiceDefinition#cachingTTL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.cachingTTL", + "sections": [ + { + "body": "Returns the caching time to live value.", + "heading": "Description" + } + ], + "signature": "cachingTTL: number", + "source": "script-api", + "tags": [ + "cachingttl", + "httpservicedefinition.cachingttl" + ], + "title": "HTTPServiceDefinition.cachingTTL" + }, + { + "description": "Returns the request body encoding to declare.", + "id": "script-api:dw/svc/HTTPServiceDefinition#encoding", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.encoding", + "sections": [ + { + "body": "Returns the request body encoding to declare.", + "heading": "Description" + } + ], + "signature": "encoding: string", + "source": "script-api", + "tags": [ + "encoding", + "httpservicedefinition.encoding" + ], + "title": "HTTPServiceDefinition.encoding" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/HTTPServiceDefinition#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getAuthentication", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "getAuthentication(): string", + "source": "script-api", + "tags": [ + "getauthentication", + "httpservicedefinition.getauthentication" + ], + "title": "HTTPServiceDefinition.getAuthentication" + }, + { + "description": "Returns the caching time to live value.", + "id": "script-api:dw/svc/HTTPServiceDefinition#getCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getCachingTTL", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the caching time to live value.", + "heading": "Description" + } + ], + "signature": "getCachingTTL(): number", + "source": "script-api", + "tags": [ + "getcachingttl", + "httpservicedefinition.getcachingttl" + ], + "title": "HTTPServiceDefinition.getCachingTTL" + }, + { + "description": "Returns the request body encoding to declare.", + "id": "script-api:dw/svc/HTTPServiceDefinition#getEncoding", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getEncoding", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the request body encoding to declare.", + "heading": "Description" + } + ], + "signature": "getEncoding(): string", + "source": "script-api", + "tags": [ + "getencoding", + "httpservicedefinition.getencoding" + ], + "title": "HTTPServiceDefinition.getEncoding" + }, + { + "description": "Returns the output file, or null if there is none.", + "id": "script-api:dw/svc/HTTPServiceDefinition#getOutFile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getOutFile", + "returns": { + "type": "File | null" + }, + "sections": [ + { + "body": "Returns the output file, or null if there is none.", + "heading": "Description" + } + ], + "signature": "getOutFile(): File | null", + "source": "script-api", + "tags": [ + "getoutfile", + "httpservicedefinition.getoutfile" + ], + "title": "HTTPServiceDefinition.getOutFile" + }, + { + "description": "Returns the request method.", + "id": "script-api:dw/svc/HTTPServiceDefinition#getRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.getRequestMethod", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the request method.", + "heading": "Description" + } + ], + "signature": "getRequestMethod(): string", + "source": "script-api", + "tags": [ + "getrequestmethod", + "httpservicedefinition.getrequestmethod" + ], + "title": "HTTPServiceDefinition.getRequestMethod" + }, + { + "description": "Returns the output file, or null if there is none.", + "id": "script-api:dw/svc/HTTPServiceDefinition#outFile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.outFile", + "sections": [ + { + "body": "Returns the output file, or null if there is none.", + "heading": "Description" + } + ], + "signature": "outFile: File | null", + "source": "script-api", + "tags": [ + "outfile", + "httpservicedefinition.outfile" + ], + "title": "HTTPServiceDefinition.outFile" + }, + { + "description": "Returns the request method.", + "id": "script-api:dw/svc/HTTPServiceDefinition#requestMethod", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.requestMethod", + "sections": [ + { + "body": "Returns the request method.", + "heading": "Description" + } + ], + "signature": "requestMethod: string", + "source": "script-api", + "tags": [ + "requestmethod", + "httpservicedefinition.requestmethod" + ], + "title": "HTTPServiceDefinition.requestMethod" + }, + { + "description": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".", + "id": "script-api:dw/svc/HTTPServiceDefinition#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "authentication", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setAuthentication", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".\n\nThe default value is BASIC.", + "heading": "Description" + } + ], + "signature": "setAuthentication(authentication: string): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "setauthentication", + "httpservicedefinition.setauthentication" + ], + "title": "HTTPServiceDefinition.setAuthentication" + }, + { + "description": "Enables caching for GET requests.", + "id": "script-api:dw/svc/HTTPServiceDefinition#setCachingTTL", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "ttl", + "type": "number" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setCachingTTL", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Enables caching for GET requests.\n\nThis only caches status codes 2xx with a content length and size of less than 50k that are not immediately\nwritten to file. The URL and the user name are used as cache keys. The total size of cacheable content and the\nnumber of cached items is limited and automatically managed by the system.\n\nCache control information sent by the remote server is ignored.\n\nCaching HTTP responses should be done very carefully. It is important to ensure that the response really depends\nonly on the URL and doesn't contain any remote state information or time information which is independent of the\nURL. It is also important to verify that the application sends exactly the same URL multiple times.", + "heading": "Description" + } + ], + "signature": "setCachingTTL(ttl: number): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "setcachingttl", + "httpservicedefinition.setcachingttl" + ], + "title": "HTTPServiceDefinition.setCachingTTL" + }, + { + "description": "Sets the encoding of the request body (if any).", + "id": "script-api:dw/svc/HTTPServiceDefinition#setEncoding", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setEncoding", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Sets the encoding of the request body (if any).\n\nThe default value is UTF-8.", + "heading": "Description" + } + ], + "signature": "setEncoding(encoding: string): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "setencoding", + "httpservicedefinition.setencoding" + ], + "title": "HTTPServiceDefinition.setEncoding" + }, + { + "description": "Sets the output file in which to write the HTTP response body.", + "id": "script-api:dw/svc/HTTPServiceDefinition#setOutFile", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "outFile", + "type": "File | null" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setOutFile", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Sets the output file in which to write the HTTP response body.\n\nThe default behavior is to not write a file.", + "heading": "Description" + } + ], + "signature": "setOutFile(outFile: File | null): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "setoutfile", + "httpservicedefinition.setoutfile" + ], + "title": "HTTPServiceDefinition.setOutFile" + }, + { + "description": "Sets the HTTP request method.", + "id": "script-api:dw/svc/HTTPServiceDefinition#setRequestMethod", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "requestMethod", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/HTTPServiceDefinition", + "qualifiedName": "dw.svc.HTTPServiceDefinition.setRequestMethod", + "returns": { + "type": "HTTPServiceDefinition" + }, + "sections": [ + { + "body": "Sets the HTTP request method.\n\nValid values include GET, PUT, POST, and DELETE.\n\nThe default value is POST.", + "heading": "Description" + } + ], + "signature": "setRequestMethod(requestMethod: string): HTTPServiceDefinition", + "source": "script-api", + "tags": [ + "setrequestmethod", + "httpservicedefinition.setrequestmethod" + ], + "title": "HTTPServiceDefinition.setRequestMethod" + }, + { + "description": "The LocalServiceRegistry is responsible for managing Service instances.", + "examples": [ + "var myFTPService = LocalServiceRegistry.createService(\"MyFTPService\", {\n    mockExec : function(svc:FTPService, params) {\n        return [\n            { \"name\": \"file1\", \"timestamp\": new Date(2011, 02, 21)},\n            { \"name\": \"file2\", \"timestamp\": new Date(2012, 02, 21)},\n            { \"name\": \"file3\", \"timestamp\": new Date(2013, 02, 21)}\n        ];\n    },\n    createRequest: function(svc:FTPService, params) {\n        svc.setOperation(\"list\", \"/\");\n    },\n    parseResponse : function(svc:FTPService, listOutput) {\n        var x : Array = [];\n        var resp : Array = listOutput;\n        for(var i = 0; i < resp.length; i++) {\n            var f = resp[i];\n            x.push( { \"name\": f['name'], \"timestamp\": f['timestamp'] } );\n        }\n        return x;\n    }\n});", + "var result : Result = myFTPService.call();\nif(result.status == 'OK') {\n// The result.object is the object returned by the 'after' callback.\n} else {\n// Handle the error. See result.error for more information.\n}" + ], + "id": "script-api:dw/svc/LocalServiceRegistry", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.LocalServiceRegistry", + "sections": [ + { + "body": "The LocalServiceRegistry is responsible for managing Service instances.\n\nTypical usage involves several steps:\n\n- The service is defined in the Business Manager and configured with necessary credentials.\n- An instance of the service is created and configured in a script:\n\n\n- The service is called in order to perform the operation:\n\n\nUnlike ServiceRegistry, the configured service is local to the current script call,\nso this deals directly with Service instances rather than the intermediate ServiceDefinition.\nThis means that a cartridge-level initialization script (and the package.json) is no longer needed.\n\nSee ServiceCallback for all the callback options, and individual Service\nclasses for customization specific to a service type.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "localserviceregistry", + "dw.svc.localserviceregistry", + "dw/svc" + ], + "title": "LocalServiceRegistry" + }, + { + "description": "Constructs and configures a service with a callback.", + "id": "script-api:dw/svc/LocalServiceRegistry#createService", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + }, + { + "name": "configObj", + "type": "object" + } + ], + "parentId": "script-api:dw/svc/LocalServiceRegistry", + "qualifiedName": "dw.svc.LocalServiceRegistry.createService", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Constructs and configures a service with a callback.", + "heading": "Description" + } + ], + "signature": "static createService(serviceID: string, configObj: object): T", + "source": "script-api", + "tags": [ + "createservice", + "localserviceregistry.createservice" + ], + "title": "LocalServiceRegistry.createService" + }, + { + "description": "Constructs and configures a service with a callback.", + "id": "script-api:dw/svc/LocalServiceRegistry#createService", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + }, + { + "name": "configObj", + "type": "object" + } + ], + "parentId": "script-api:dw/svc/LocalServiceRegistry", + "qualifiedName": "dw.svc.LocalServiceRegistry.createService", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Constructs and configures a service with a callback.", + "heading": "Description" + } + ], + "signature": "static createService(serviceID: string, configObj: object): T", + "source": "script-api", + "tags": [ + "createservice", + "localserviceregistry.createservice" + ], + "title": "LocalServiceRegistry.createService" + }, + { + "description": "Represents the result of a service call.", + "id": "script-api:dw/svc/Result", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.Result", + "sections": [ + { + "body": "Represents the result of a service call.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "result", + "dw.svc.result", + "dw/svc" + ], + "title": "Result" + }, + { + "description": "Status indicating a general service error.", + "id": "script-api:dw/svc/Result#ERROR", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ERROR", + "sections": [ + { + "body": "Status indicating a general service error.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR = \"ERROR\"", + "source": "script-api", + "tags": [ + "error", + "result.error" + ], + "title": "Result.ERROR" + }, + { + "description": "Status indicating a general service error.", + "id": "script-api:dw/svc/Result#ERROR", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ERROR", + "sections": [ + { + "body": "Status indicating a general service error.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR = \"ERROR\"", + "source": "script-api", + "tags": [ + "error", + "result.error" + ], + "title": "Result.ERROR" + }, + { + "description": "Status indicating a successful service call.", + "id": "script-api:dw/svc/Result#OK", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.OK", + "sections": [ + { + "body": "Status indicating a successful service call.", + "heading": "Description" + } + ], + "signature": "static readonly OK = \"OK\"", + "source": "script-api", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.OK" + }, + { + "description": "Status indicating a successful service call.", + "id": "script-api:dw/svc/Result#OK", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.OK", + "sections": [ + { + "body": "Status indicating a successful service call.", + "heading": "Description" + } + ], + "signature": "static readonly OK = \"OK\"", + "source": "script-api", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.OK" + }, + { + "description": "Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.", + "id": "script-api:dw/svc/Result#SERVICE_UNAVAILABLE", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.SERVICE_UNAVAILABLE", + "sections": [ + { + "body": "Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.", + "heading": "Description" + } + ], + "signature": "static readonly SERVICE_UNAVAILABLE = \"SERVICE_UNAVAILABLE\"", + "source": "script-api", + "tags": [ + "service_unavailable", + "result.service_unavailable" + ], + "title": "Result.SERVICE_UNAVAILABLE" + }, + { + "description": "Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.", + "id": "script-api:dw/svc/Result#SERVICE_UNAVAILABLE", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.SERVICE_UNAVAILABLE", + "sections": [ + { + "body": "Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.", + "heading": "Description" + } + ], + "signature": "static readonly SERVICE_UNAVAILABLE = \"SERVICE_UNAVAILABLE\"", + "source": "script-api", + "tags": [ + "service_unavailable", + "result.service_unavailable" + ], + "title": "Result.SERVICE_UNAVAILABLE" + }, + { + "description": "Unavailable reason: No call was made because the circuit breaker prevented it.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_CIRCUIT_BROKEN", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CIRCUIT_BROKEN", + "sections": [ + { + "body": "Unavailable reason: No call was made because the circuit breaker prevented it.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_CIRCUIT_BROKEN = \"CIRCUIT_BROKEN\"", + "source": "script-api", + "tags": [ + "unavailable_circuit_broken", + "result.unavailable_circuit_broken" + ], + "title": "Result.UNAVAILABLE_CIRCUIT_BROKEN" + }, + { + "description": "Unavailable reason: No call was made because the circuit breaker prevented it.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_CIRCUIT_BROKEN", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CIRCUIT_BROKEN", + "sections": [ + { + "body": "Unavailable reason: No call was made because the circuit breaker prevented it.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_CIRCUIT_BROKEN = \"CIRCUIT_BROKEN\"", + "source": "script-api", + "tags": [ + "unavailable_circuit_broken", + "result.unavailable_circuit_broken" + ], + "title": "Result.UNAVAILABLE_CIRCUIT_BROKEN" + }, + { + "description": "Unavailable reason: No call was made because the service was not configured correctly.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_CONFIG_PROBLEM", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CONFIG_PROBLEM", + "sections": [ + { + "body": "Unavailable reason: No call was made because the service was not configured correctly.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_CONFIG_PROBLEM = \"CONFIG_PROBLEM\"", + "source": "script-api", + "tags": [ + "unavailable_config_problem", + "result.unavailable_config_problem" + ], + "title": "Result.UNAVAILABLE_CONFIG_PROBLEM" + }, + { + "description": "Unavailable reason: No call was made because the service was not configured correctly.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_CONFIG_PROBLEM", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_CONFIG_PROBLEM", + "sections": [ + { + "body": "Unavailable reason: No call was made because the service was not configured correctly.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_CONFIG_PROBLEM = \"CONFIG_PROBLEM\"", + "source": "script-api", + "tags": [ + "unavailable_config_problem", + "result.unavailable_config_problem" + ], + "title": "Result.UNAVAILABLE_CONFIG_PROBLEM" + }, + { + "description": "Unavailable reason: No call was made because the service is disabled.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_DISABLED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_DISABLED", + "sections": [ + { + "body": "Unavailable reason: No call was made because the service is disabled.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_DISABLED = \"DISABLED\"", + "source": "script-api", + "tags": [ + "unavailable_disabled", + "result.unavailable_disabled" + ], + "title": "Result.UNAVAILABLE_DISABLED" + }, + { + "description": "Unavailable reason: No call was made because the service is disabled.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_DISABLED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_DISABLED", + "sections": [ + { + "body": "Unavailable reason: No call was made because the service is disabled.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_DISABLED = \"DISABLED\"", + "source": "script-api", + "tags": [ + "unavailable_disabled", + "result.unavailable_disabled" + ], + "title": "Result.UNAVAILABLE_DISABLED" + }, + { + "description": "Unavailable reason: No call was made because the rate limit was hit.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_RATE_LIMITED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_RATE_LIMITED", + "sections": [ + { + "body": "Unavailable reason: No call was made because the rate limit was hit.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_RATE_LIMITED = \"RATE_LIMITED\"", + "source": "script-api", + "tags": [ + "unavailable_rate_limited", + "result.unavailable_rate_limited" + ], + "title": "Result.UNAVAILABLE_RATE_LIMITED" + }, + { + "description": "Unavailable reason: No call was made because the rate limit was hit.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_RATE_LIMITED", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_RATE_LIMITED", + "sections": [ + { + "body": "Unavailable reason: No call was made because the rate limit was hit.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_RATE_LIMITED = \"RATE_LIMITED\"", + "source": "script-api", + "tags": [ + "unavailable_rate_limited", + "result.unavailable_rate_limited" + ], + "title": "Result.UNAVAILABLE_RATE_LIMITED" + }, + { + "description": "Unavailable reason: A real call was made but a timeout occurred.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_TIMEOUT", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_TIMEOUT", + "sections": [ + { + "body": "Unavailable reason: A real call was made but a timeout occurred.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_TIMEOUT = \"TIMEOUT\"", + "source": "script-api", + "tags": [ + "unavailable_timeout", + "result.unavailable_timeout" + ], + "title": "Result.UNAVAILABLE_TIMEOUT" + }, + { + "description": "Unavailable reason: A real call was made but a timeout occurred.", + "id": "script-api:dw/svc/Result#UNAVAILABLE_TIMEOUT", + "kind": "constant", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.UNAVAILABLE_TIMEOUT", + "sections": [ + { + "body": "Unavailable reason: A real call was made but a timeout occurred.", + "heading": "Description" + } + ], + "signature": "static readonly UNAVAILABLE_TIMEOUT = \"TIMEOUT\"", + "source": "script-api", + "tags": [ + "unavailable_timeout", + "result.unavailable_timeout" + ], + "title": "Result.UNAVAILABLE_TIMEOUT" + }, + { + "description": "Returns an error-specific code if applicable. For example, this is the HTTP response code for an HTTPService.", + "id": "script-api:dw/svc/Result#error", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.error", + "sections": [ + { + "body": "Returns an error-specific code if applicable. For example, this is the HTTP response code for an\nHTTPService.", + "heading": "Description" + } + ], + "signature": "readonly error: number", + "source": "script-api", + "tags": [ + "error", + "result.error" + ], + "title": "Result.error" + }, + { + "description": "Returns an error message on a non-OK status.", + "id": "script-api:dw/svc/Result#errorMessage", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.errorMessage", + "sections": [ + { + "body": "Returns an error message on a non-OK status.", + "heading": "Description" + } + ], + "signature": "readonly errorMessage: string", + "source": "script-api", + "tags": [ + "errormessage", + "result.errormessage" + ], + "title": "Result.errorMessage" + }, + { + "description": "Returns an error-specific code if applicable. For example, this is the HTTP response code for an HTTPService.", + "id": "script-api:dw/svc/Result#getError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getError", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns an error-specific code if applicable. For example, this is the HTTP response code for an\nHTTPService.", + "heading": "Description" + } + ], + "signature": "getError(): number", + "source": "script-api", + "tags": [ + "geterror", + "result.geterror" + ], + "title": "Result.getError" + }, + { + "description": "Returns an error message on a non-OK status.", + "id": "script-api:dw/svc/Result#getErrorMessage", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getErrorMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns an error message on a non-OK status.", + "heading": "Description" + } + ], + "signature": "getErrorMessage(): string", + "source": "script-api", + "tags": [ + "geterrormessage", + "result.geterrormessage" + ], + "title": "Result.getErrorMessage" + }, + { + "description": "Returns an extra error message on failure (if any).", + "id": "script-api:dw/svc/Result#getMsg", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getMsg", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns an extra error message on failure (if any).", + "heading": "Description" + } + ], + "signature": "getMsg(): string | null", + "source": "script-api", + "tags": [ + "getmsg", + "result.getmsg" + ], + "title": "Result.getMsg" + }, + { + "description": "Returns the actual object returned by the service when the status is OK.", + "id": "script-api:dw/svc/Result#getObject", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getObject", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the actual object returned by the service when the status is OK.", + "heading": "Description" + } + ], + "signature": "getObject(): any", + "source": "script-api", + "tags": [ + "getobject", + "result.getobject" + ], + "title": "Result.getObject" + }, + { + "description": "Returns the status. This is \"OK\" on success. Failure codes include \"ERROR\" and \"SERVICE_UNAVAILABLE\".", + "id": "script-api:dw/svc/Result#getStatus", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getStatus", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the status. This is \"OK\" on success. Failure codes include \"ERROR\" and \"SERVICE_UNAVAILABLE\".\n\nIf the status is \"SERVICE_UNAVAILABLE\", then the unavailableReason is guaranteed to be non-null.", + "heading": "Description" + } + ], + "signature": "getStatus(): string", + "source": "script-api", + "tags": [ + "getstatus", + "result.getstatus" + ], + "title": "Result.getStatus" + }, + { + "description": "Returns the reason the status is SERVICE_UNAVAILABLE.", + "id": "script-api:dw/svc/Result#getUnavailableReason", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.getUnavailableReason", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the reason the status is SERVICE_UNAVAILABLE.", + "heading": "Description" + } + ], + "signature": "getUnavailableReason(): string | null", + "source": "script-api", + "tags": [ + "getunavailablereason", + "result.getunavailablereason" + ], + "title": "Result.getUnavailableReason" + }, + { + "description": "Returns the status of whether the response is the result of a \"mock\" service call.", + "id": "script-api:dw/svc/Result#isMockResult", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.isMockResult", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the response is the result of a \"mock\" service call.", + "heading": "Description" + } + ], + "signature": "isMockResult(): boolean", + "source": "script-api", + "tags": [ + "ismockresult", + "result.ismockresult" + ], + "title": "Result.isMockResult" + }, + { + "description": "Returns the status of whether the service call was successful.", + "id": "script-api:dw/svc/Result#isOk", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.isOk", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the service call was successful.", + "heading": "Description" + } + ], + "signature": "isOk(): boolean", + "source": "script-api", + "tags": [ + "isok", + "result.isok" + ], + "title": "Result.isOk" + }, + { + "description": "Returns the status of whether the response is the result of a \"mock\" service call.", + "id": "script-api:dw/svc/Result#mockResult", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.mockResult", + "sections": [ + { + "body": "Returns the status of whether the response is the result of a \"mock\" service call.", + "heading": "Description" + } + ], + "signature": "readonly mockResult: boolean", + "source": "script-api", + "tags": [ + "mockresult", + "result.mockresult" + ], + "title": "Result.mockResult" + }, + { + "description": "Returns an extra error message on failure (if any).", + "id": "script-api:dw/svc/Result#msg", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.msg", + "sections": [ + { + "body": "Returns an extra error message on failure (if any).", + "heading": "Description" + } + ], + "signature": "readonly msg: string | null", + "source": "script-api", + "tags": [ + "msg", + "result.msg" + ], + "title": "Result.msg" + }, + { + "description": "Returns the actual object returned by the service when the status is OK.", + "id": "script-api:dw/svc/Result#object", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.object", + "sections": [ + { + "body": "Returns the actual object returned by the service when the status is OK.", + "heading": "Description" + } + ], + "signature": "readonly object: any", + "source": "script-api", + "tags": [ + "object", + "result.object" + ], + "title": "Result.object" + }, + { + "description": "Returns the status of whether the service call was successful.", + "id": "script-api:dw/svc/Result#ok", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.ok", + "sections": [ + { + "body": "Returns the status of whether the service call was successful.", + "heading": "Description" + } + ], + "signature": "readonly ok: boolean", + "source": "script-api", + "tags": [ + "ok", + "result.ok" + ], + "title": "Result.ok" + }, + { + "description": "Returns the status. This is \"OK\" on success. Failure codes include \"ERROR\" and \"SERVICE_UNAVAILABLE\".", + "id": "script-api:dw/svc/Result#status", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.status", + "sections": [ + { + "body": "Returns the status. This is \"OK\" on success. Failure codes include \"ERROR\" and \"SERVICE_UNAVAILABLE\".\n\nIf the status is \"SERVICE_UNAVAILABLE\", then the unavailableReason is guaranteed to be non-null.", + "heading": "Description" + } + ], + "signature": "readonly status: string", + "source": "script-api", + "tags": [ + "status", + "result.status" + ], + "title": "Result.status" + }, + { + "description": "Returns a string representation of the result.", + "id": "script-api:dw/svc/Result#toString", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of the result.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "result.tostring" + ], + "title": "Result.toString" + }, + { + "description": "Returns the reason the status is SERVICE_UNAVAILABLE.", + "id": "script-api:dw/svc/Result#unavailableReason", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Result", + "qualifiedName": "dw.svc.Result.unavailableReason", + "sections": [ + { + "body": "Returns the reason the status is SERVICE_UNAVAILABLE.", + "heading": "Description" + } + ], + "signature": "readonly unavailableReason: string | null", + "source": "script-api", + "tags": [ + "unavailablereason", + "result.unavailablereason" + ], + "title": "Result.unavailableReason" + }, + { + "description": "Represents a SOAP WebService.", + "id": "script-api:dw/svc/SOAPService", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.SOAPService", + "sections": [ + { + "body": "Represents a SOAP WebService.", + "heading": "Description" + }, + { + "body": "Extends `Service`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "soapservice", + "dw.svc.soapservice", + "dw/svc" + ], + "title": "SOAPService" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/SOAPService#authentication", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.authentication", + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "authentication: string", + "source": "script-api", + "tags": [ + "authentication", + "soapservice.authentication" + ], + "title": "SOAPService.authentication" + }, + { + "description": "Returns the authentication type.", + "id": "script-api:dw/svc/SOAPService#getAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.getAuthentication", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the authentication type.", + "heading": "Description" + } + ], + "signature": "getAuthentication(): string", + "source": "script-api", + "tags": [ + "getauthentication", + "soapservice.getauthentication" + ], + "title": "SOAPService.getAuthentication" + }, + { + "description": "Returns the serviceClient object.", + "id": "script-api:dw/svc/SOAPService#getServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.getServiceClient", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the serviceClient object.", + "heading": "Description" + } + ], + "signature": "getServiceClient(): any", + "source": "script-api", + "tags": [ + "getserviceclient", + "soapservice.getserviceclient" + ], + "title": "SOAPService.getServiceClient" + }, + { + "description": "Returns the serviceClient object.", + "id": "script-api:dw/svc/SOAPService#serviceClient", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.serviceClient", + "sections": [ + { + "body": "Returns the serviceClient object.", + "heading": "Description" + } + ], + "signature": "serviceClient: any", + "source": "script-api", + "tags": [ + "serviceclient", + "soapservice.serviceclient" + ], + "title": "SOAPService.serviceClient" + }, + { + "description": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".", + "id": "script-api:dw/svc/SOAPService#setAuthentication", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "authentication", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.setAuthentication", + "returns": { + "type": "SOAPService" + }, + "sections": [ + { + "body": "Sets the type of authentication. Valid values include \"BASIC\" and \"NONE\".\n\nThe default value is BASIC.", + "heading": "Description" + } + ], + "signature": "setAuthentication(authentication: string): SOAPService", + "source": "script-api", + "tags": [ + "setauthentication", + "soapservice.setauthentication" + ], + "title": "SOAPService.setAuthentication" + }, + { + "description": "Sets the serviceClient object. This must be set in the prepareCall method, prior to execute being called.", + "id": "script-api:dw/svc/SOAPService#setServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "o", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/SOAPService", + "qualifiedName": "dw.svc.SOAPService.setServiceClient", + "returns": { + "type": "SOAPService" + }, + "sections": [ + { + "body": "Sets the serviceClient object. This must be set in the prepareCall method, prior to execute being called.", + "heading": "Description" + } + ], + "signature": "setServiceClient(o: any): SOAPService", + "source": "script-api", + "tags": [ + "setserviceclient", + "soapservice.setserviceclient" + ], + "title": "SOAPService.setServiceClient" + }, + { + "deprecated": { + "message": "This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry\ninstead, which allows configuration on the SOAPService directly." + }, + "description": "Represents a SOAP WebService definition.", + "id": "script-api:dw/svc/SOAPServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.SOAPServiceDefinition", + "sections": [ + { + "body": "Represents a SOAP WebService definition.", + "heading": "Description" + }, + { + "body": "Extends `ServiceDefinition`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "soapservicedefinition", + "dw.svc.soapservicedefinition", + "dw/svc" + ], + "title": "SOAPServiceDefinition" + }, + { + "description": "Base class of Services.", + "id": "script-api:dw/svc/Service", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.Service", + "sections": [ + { + "body": "Base class of Services.\n\nA service represents a call-specific configuration. Any configuration set here is local to the currently executing\ncall.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "service", + "dw.svc.service", + "dw/svc" + ], + "title": "Service" + }, + { + "description": "Returns the current URL, excluding any custom query parameters.", + "id": "script-api:dw/svc/Service#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.URL", + "sections": [ + { + "body": "Returns the current URL, excluding any custom query parameters.", + "heading": "Description" + } + ], + "signature": "URL: string", + "source": "script-api", + "tags": [ + "url", + "service.url" + ], + "title": "Service.URL" + }, + { + "description": "Invokes the service.", + "id": "script-api:dw/svc/Service#call", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.call", + "returns": { + "type": "Result" + }, + "sections": [ + { + "body": "Invokes the service.", + "heading": "Description" + } + ], + "signature": "call(args?: any[]): Result", + "source": "script-api", + "tags": [ + "call", + "service.call" + ], + "title": "Service.call" + }, + { + "description": "Returns the Service Configuration.", + "id": "script-api:dw/svc/Service#configuration", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.configuration", + "sections": [ + { + "body": "Returns the Service Configuration.", + "heading": "Description" + } + ], + "signature": "readonly configuration: ServiceConfig", + "source": "script-api", + "tags": [ + "configuration", + "service.configuration" + ], + "title": "Service.configuration" + }, + { + "description": "Returns the ID of the currently associated Credential.", + "id": "script-api:dw/svc/Service#credentialID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.credentialID", + "sections": [ + { + "body": "Returns the ID of the currently associated Credential.", + "heading": "Description" + } + ], + "signature": "credentialID: string", + "source": "script-api", + "tags": [ + "credentialid", + "service.credentialid" + ], + "title": "Service.credentialID" + }, + { + "description": "Returns the Service Configuration.", + "id": "script-api:dw/svc/Service#getConfiguration", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getConfiguration", + "returns": { + "type": "ServiceConfig" + }, + "sections": [ + { + "body": "Returns the Service Configuration.", + "heading": "Description" + } + ], + "signature": "getConfiguration(): ServiceConfig", + "source": "script-api", + "tags": [ + "getconfiguration", + "service.getconfiguration" + ], + "title": "Service.getConfiguration" + }, + { + "description": "Returns the ID of the currently associated Credential.", + "id": "script-api:dw/svc/Service#getCredentialID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getCredentialID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the currently associated Credential.", + "heading": "Description" + } + ], + "signature": "getCredentialID(): string", + "source": "script-api", + "tags": [ + "getcredentialid", + "service.getcredentialid" + ], + "title": "Service.getCredentialID" + }, + { + "description": "Returns the property that stores the object returned by createRequest.", + "id": "script-api:dw/svc/Service#getRequestData", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getRequestData", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the property that stores the object returned by createRequest.", + "heading": "Description" + } + ], + "signature": "getRequestData(): any", + "source": "script-api", + "tags": [ + "getrequestdata", + "service.getrequestdata" + ], + "title": "Service.getRequestData" + }, + { + "description": "Returns the property that stores the object returned by the service.", + "id": "script-api:dw/svc/Service#getResponse", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getResponse", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the property that stores the object returned by the service.\n\nThis property is only useful after the service call completes, and is the same as the object\ninside the Result.", + "heading": "Description" + } + ], + "signature": "getResponse(): any", + "source": "script-api", + "tags": [ + "getresponse", + "service.getresponse" + ], + "title": "Service.getResponse" + }, + { + "description": "Returns the current URL, excluding any custom query parameters.", + "id": "script-api:dw/svc/Service#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.getURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current URL, excluding any custom query parameters.", + "heading": "Description" + } + ], + "signature": "getURL(): string", + "source": "script-api", + "tags": [ + "geturl", + "service.geturl" + ], + "title": "Service.getURL" + }, + { + "description": "Returns the status of whether this service is executing in mock mode.", + "id": "script-api:dw/svc/Service#isMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.isMock", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether this service is executing in mock mode.", + "heading": "Description" + } + ], + "signature": "isMock(): boolean", + "source": "script-api", + "tags": [ + "ismock", + "service.ismock" + ], + "title": "Service.isMock" + }, + { + "description": "Returns the status of whether this service will throw an error when encountering a problem.", + "id": "script-api:dw/svc/Service#isThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.isThrowOnError", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether this service will throw an error when encountering a problem.", + "heading": "Description" + } + ], + "signature": "isThrowOnError(): boolean", + "source": "script-api", + "tags": [ + "isthrowonerror", + "service.isthrowonerror" + ], + "title": "Service.isThrowOnError" + }, + { + "description": "Returns the status of whether this service is executing in mock mode.", + "id": "script-api:dw/svc/Service#mock", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.mock", + "sections": [ + { + "body": "Returns the status of whether this service is executing in mock mode.", + "heading": "Description" + } + ], + "signature": "readonly mock: boolean", + "source": "script-api", + "tags": [ + "mock", + "service.mock" + ], + "title": "Service.mock" + }, + { + "description": "Returns the property that stores the object returned by createRequest.", + "id": "script-api:dw/svc/Service#requestData", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.requestData", + "sections": [ + { + "body": "Returns the property that stores the object returned by createRequest.", + "heading": "Description" + } + ], + "signature": "readonly requestData: any", + "source": "script-api", + "tags": [ + "requestdata", + "service.requestdata" + ], + "title": "Service.requestData" + }, + { + "description": "Returns the property that stores the object returned by the service.", + "id": "script-api:dw/svc/Service#response", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.response", + "sections": [ + { + "body": "Returns the property that stores the object returned by the service.\n\nThis property is only useful after the service call completes, and is the same as the object\ninside the Result.", + "heading": "Description" + } + ], + "signature": "readonly response: any", + "source": "script-api", + "tags": [ + "response", + "service.response" + ], + "title": "Service.response" + }, + { + "description": "Override the Credential by the credential object with the given ID.", + "id": "script-api:dw/svc/Service#setCredentialID", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setCredentialID", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Override the Credential by the credential object with the given ID.\n\nIf the URL is also overridden, that URL will continue to override the URL in this credential.", + "heading": "Description" + } + ], + "signature": "setCredentialID(id: string): Service", + "source": "script-api", + "tags": [ + "setcredentialid", + "service.setcredentialid" + ], + "title": "Service.setCredentialID" + }, + { + "description": "Forces the mock mode to be enabled.", + "id": "script-api:dw/svc/Service#setMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setMock", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Forces the mock mode to be enabled.", + "heading": "Description" + } + ], + "signature": "setMock(): Service", + "source": "script-api", + "tags": [ + "setmock", + "service.setmock" + ], + "title": "Service.setMock" + }, + { + "description": "Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.", + "id": "script-api:dw/svc/Service#setThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setThrowOnError", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.", + "heading": "Description" + } + ], + "signature": "setThrowOnError(): Service", + "source": "script-api", + "tags": [ + "setthrowonerror", + "service.setthrowonerror" + ], + "title": "Service.setThrowOnError" + }, + { + "description": "Override the URL to the given value. Any query parameters (if applicable) will be appended to this URL.", + "id": "script-api:dw/svc/Service#setURL", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "url", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.setURL", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Override the URL to the given value. Any query parameters (if applicable) will be appended to this URL.", + "heading": "Description" + } + ], + "signature": "setURL(url: string): Service", + "source": "script-api", + "tags": [ + "seturl", + "service.seturl" + ], + "title": "Service.setURL" + }, + { + "description": "Returns the status of whether this service will throw an error when encountering a problem.", + "id": "script-api:dw/svc/Service#throwOnError", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/Service", + "qualifiedName": "dw.svc.Service.throwOnError", + "sections": [ + { + "body": "Returns the status of whether this service will throw an error when encountering a problem.", + "heading": "Description" + } + ], + "signature": "readonly throwOnError: boolean", + "source": "script-api", + "tags": [ + "throwonerror", + "service.throwonerror" + ], + "title": "Service.throwOnError" + }, + { + "description": "Defines callbacks for use with the LocalServiceRegistry.", + "id": "script-api:dw/svc/ServiceCallback", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceCallback", + "sections": [ + { + "body": "Defines callbacks for use with the LocalServiceRegistry.\n\nNote this class itself is not used directly, and is present only for documentation of the available callback methods.\n\nThese methods are called in sequence when a service is called:\n\n- initServiceClient -- Creates the underlying client that will be used to make the call. This is\nintended for SOAP Services and optionally for setting configuration options on the HTTP client. Other client types\nwill be created automatically.\n- createRequest -- Given arguments to the Service.call, configure\nthe actual service request. This may include setting request headers, defining the message body, etc.\n- execute -- Perform the actual request. At this point the client has been configured\nwith the relevant credentials, so the call should be made. This is required for SOAP services.\n- parseResponse -- Convert the result of the call into an object to be returned from the\nService.call method.\n\nIf the service is mocked (see Service.isMock), then mockFull takes the place\nof this entire sequence. If that is not implemented, then mockCall takes the place of just\nthe execute method.\n\nThe URL, request, and response objects may be logged. To avoid logging sensitive data,\nfilterLogMessage and/or getRequestLogMessage and\ngetResponseLogMessage must be implemented. If they are not implemented then this logging will not be\ndone on Production environments.\n\nThere are some special considerations for the combination of service type and callback:\n\nService Type\ninitServiceClient\ncreateRequest\nexecute\nparseResponse\n\nHTTP\nThis is only required to use non-default options. It must return either a dw.net.HTTPClient or a Map\ncontaining the dw.net.HTTPClient.HTTPClient options.\nRequired unless execute is provided. The return value is expected to be either a String or array of\ndw.net.HTTPRequestPart, which will be used as the request body\nNot called unless a boolean \"executeOverride:true\" is set on the callback. This is a temporary limitation, a\nfuture release will always call this callback if it is present\nRequired unless execute is provided.\n\nHTTPForm\nNot normally implemented. Must return a dw.net.HTTPClient\nNot normally implemented. Default behavior constructs an \"application/x-www-form-urlencoded\" request based on a\nMap given as an argument.\nNot normally implemented. The same limitations as HTTP regarding the \"executeOverride\" flag apply here.\nOptional. Default behavior is to return the response body as a String.\n\nSOAP\nOptional. This must return the Webservice stub or port\nRequired. If initServiceClient was not provided, then this function must call\nSOAPService.setServiceClient with the stub or port\nRequired. A typical implementation will call the webservice via a method on the service client\nOptional. Default behavior returns the output of execute\n\nFTP\nNot normally implemented. Must return a dw.net.FTPClient or dw.net.SFTPClient\nRequired unless execute is defined. If present, it should call\nFTPService.setOperation\nOptional. An implementation may call any required methods on the given client. The default implementation calls\nthe Operation that was set up and returns the result.\nOptional. Default behavior returns the output of execute\n\nGENERIC\nOptional.\nOptional.\nRequired. The GENERIC type allows any code to be wrapped in the service framework layer, and it's up to this\nexecute method to define what that logic is.\nOptional.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "servicecallback", + "dw.svc.servicecallback", + "dw/svc" + ], + "title": "ServiceCallback" + }, + { + "description": "Allows overriding the URL provided by the service configuration.", + "id": "script-api:dw/svc/ServiceCallback#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.URL", + "sections": [ + { + "body": "Allows overriding the URL provided by the service configuration.\n\nIt is usually better to call Service.setURL within createRequest\nbecause that allows you to modify the existing URL based on call parameters.", + "heading": "Description" + } + ], + "signature": "readonly URL: string", + "source": "script-api", + "tags": [ + "url", + "servicecallback.url" + ], + "title": "ServiceCallback.URL" + }, + { + "description": "Creates a request object to be used when calling the service.", + "id": "script-api:dw/svc/ServiceCallback#createRequest", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + }, + { + "name": "params", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.createRequest", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Creates a request object to be used when calling the service.\n\nThe type of the object expected is dependent on the service. For example, the HTTPService expects the\nHTTP request body to be returned.\n\nThis is required unless the execute method is implemented.\n\nIt is not recommended to have a service accept a single array or list as a parameter, since doing so requires\nsome extra work when actually calling the service. See Service.call for more details.", + "heading": "Description" + } + ], + "signature": "createRequest(service: Service, params?: any[]): any", + "source": "script-api", + "tags": [ + "createrequest", + "servicecallback.createrequest" + ], + "title": "ServiceCallback.createRequest" + }, + { + "description": "Provides service-specific execution logic.", + "id": "script-api:dw/svc/ServiceCallback#execute", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + }, + { + "name": "request", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.execute", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Provides service-specific execution logic.\n\nThis can be overridden to execute a chain of FTP commands in the FTPService, or perform the actual remote\ncall on a webservice stub in the SOAPService.", + "heading": "Description" + } + ], + "signature": "execute(service: Service, request: any): any", + "source": "script-api", + "tags": [ + "execute", + "servicecallback.execute" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "ServiceCallback.execute" + }, + { + "description": "Allows filtering communication URL, request, and response log messages.", + "id": "script-api:dw/svc/ServiceCallback#filterLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.filterLogMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Allows filtering communication URL, request, and response log messages.\n\nIf not implemented, then no filtering will be performed and the message will be logged as-is.", + "heading": "Description" + } + ], + "signature": "filterLogMessage(msg: string): string", + "source": "script-api", + "tags": [ + "filterlogmessage", + "servicecallback.filterlogmessage" + ], + "title": "ServiceCallback.filterLogMessage" + }, + { + "description": "Creates a communication log message for the given request.", + "id": "script-api:dw/svc/ServiceCallback#getRequestLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "request", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getRequestLogMessage", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Creates a communication log message for the given request.\n\nIf not implemented then the default logic will be used to convert the request into a log message.", + "heading": "Description" + } + ], + "signature": "getRequestLogMessage(request: any): string | null", + "source": "script-api", + "tags": [ + "getrequestlogmessage", + "servicecallback.getrequestlogmessage" + ], + "title": "ServiceCallback.getRequestLogMessage" + }, + { + "description": "Creates a response log message for the given request.", + "id": "script-api:dw/svc/ServiceCallback#getResponseLogMessage", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "response", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getResponseLogMessage", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Creates a response log message for the given request.\n\nIf not implemented then the default logic will be used to convert the response into a log message.", + "heading": "Description" + } + ], + "signature": "getResponseLogMessage(response: any): string | null", + "source": "script-api", + "tags": [ + "getresponselogmessage", + "servicecallback.getresponselogmessage" + ], + "title": "ServiceCallback.getResponseLogMessage" + }, + { + "description": "Allows overriding the URL provided by the service configuration.", + "id": "script-api:dw/svc/ServiceCallback#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.getURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Allows overriding the URL provided by the service configuration.\n\nIt is usually better to call Service.setURL within createRequest\nbecause that allows you to modify the existing URL based on call parameters.", + "heading": "Description" + } + ], + "signature": "getURL(): string", + "source": "script-api", + "tags": [ + "geturl", + "servicecallback.geturl" + ], + "title": "ServiceCallback.getURL" + }, + { + "description": "Creates a protocol-specific client object.", + "examples": [ + "initServiceClient: function( svc ) {\nreturn webreferences2.MyWSDL.getDefaultService();\n}" + ], + "id": "script-api:dw/svc/ServiceCallback#initServiceClient", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.initServiceClient", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Creates a protocol-specific client object.\n\nThis does not normally need to be implemented, except in the case of SOAP services.\n\nIt may also be used for HTTP services to override the default configuration.\n\nExample SOAP service:\n\n\nExample configuration override for an HTTP service:", + "heading": "Description" + } + ], + "signature": "initServiceClient(service: Service): any", + "source": "script-api", + "tags": [ + "initserviceclient", + "servicecallback.initserviceclient" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "ServiceCallback.initServiceClient" + }, + { + "description": "Override this method to mock the remote portion of the service call.", + "id": "script-api:dw/svc/ServiceCallback#mockCall", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + }, + { + "name": "requestObj", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.mockCall", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Override this method to mock the remote portion of the service call.\n\nOther callbacks like createRequest and parseResponse are still called.", + "heading": "Description" + } + ], + "signature": "mockCall(service: Service, requestObj: any): any", + "source": "script-api", + "tags": [ + "mockcall", + "servicecallback.mockcall" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "ServiceCallback.mockCall" + }, + { + "description": "Override this method to mock the entire service call, including the createRequest, execute, and parseResponse phases.", + "id": "script-api:dw/svc/ServiceCallback#mockFull", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.mockFull", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Override this method to mock the entire service call, including the createRequest, execute, and parseResponse phases.", + "heading": "Description" + } + ], + "signature": "mockFull(service: Service, args?: any[]): any", + "source": "script-api", + "tags": [ + "mockfull", + "servicecallback.mockfull" + ], + "throws": [ + { + "type": "Exception" + } + ], + "title": "ServiceCallback.mockFull" + }, + { + "description": "Creates a response object from a successful service call.", + "id": "script-api:dw/svc/ServiceCallback#parseResponse", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "service", + "type": "Service" + }, + { + "name": "response", + "type": "any" + } + ], + "parentId": "script-api:dw/svc/ServiceCallback", + "qualifiedName": "dw.svc.ServiceCallback.parseResponse", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Creates a response object from a successful service call.\n\nThis response object will be the output object of the call method's Result.", + "heading": "Description" + } + ], + "signature": "parseResponse(service: Service, response: any): any", + "source": "script-api", + "tags": [ + "parseresponse", + "servicecallback.parseresponse" + ], + "title": "ServiceCallback.parseResponse" + }, + { + "description": "Configuration object for Services.", + "id": "script-api:dw/svc/ServiceConfig", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceConfig", + "sections": [ + { + "body": "Configuration object for Services.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "serviceconfig", + "dw.svc.serviceconfig", + "dw/svc" + ], + "title": "ServiceConfig" + }, + { + "description": "Returns the unique Service ID.", + "id": "script-api:dw/svc/ServiceConfig#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.ID", + "sections": [ + { + "body": "Returns the unique Service ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "serviceconfig.id" + ], + "title": "ServiceConfig.ID" + }, + { + "description": "Returns the related service credentials.", + "id": "script-api:dw/svc/ServiceConfig#credential", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.credential", + "sections": [ + { + "body": "Returns the related service credentials.", + "heading": "Description" + } + ], + "signature": "readonly credential: ServiceCredential", + "source": "script-api", + "tags": [ + "credential", + "serviceconfig.credential" + ], + "title": "ServiceConfig.credential" + }, + { + "description": "Returns the related service credentials.", + "id": "script-api:dw/svc/ServiceConfig#getCredential", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getCredential", + "returns": { + "type": "ServiceCredential" + }, + "sections": [ + { + "body": "Returns the related service credentials.", + "heading": "Description" + } + ], + "signature": "getCredential(): ServiceCredential", + "source": "script-api", + "tags": [ + "getcredential", + "serviceconfig.getcredential" + ], + "title": "ServiceConfig.getCredential" + }, + { + "description": "Returns the unique Service ID.", + "id": "script-api:dw/svc/ServiceConfig#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique Service ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "serviceconfig.getid" + ], + "title": "ServiceConfig.getID" + }, + { + "description": "Returns the related service profile.", + "id": "script-api:dw/svc/ServiceConfig#getProfile", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getProfile", + "returns": { + "type": "ServiceProfile" + }, + "sections": [ + { + "body": "Returns the related service profile.", + "heading": "Description" + } + ], + "signature": "getProfile(): ServiceProfile", + "source": "script-api", + "tags": [ + "getprofile", + "serviceconfig.getprofile" + ], + "title": "ServiceConfig.getProfile" + }, + { + "description": "Returns the type of the service, such as HTTP or SOAP.", + "id": "script-api:dw/svc/ServiceConfig#getServiceType", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.getServiceType", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the type of the service, such as HTTP or SOAP.", + "heading": "Description" + } + ], + "signature": "getServiceType(): string", + "source": "script-api", + "tags": [ + "getservicetype", + "serviceconfig.getservicetype" + ], + "title": "ServiceConfig.getServiceType" + }, + { + "description": "Returns the related service profile.", + "id": "script-api:dw/svc/ServiceConfig#profile", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.profile", + "sections": [ + { + "body": "Returns the related service profile.", + "heading": "Description" + } + ], + "signature": "readonly profile: ServiceProfile", + "source": "script-api", + "tags": [ + "profile", + "serviceconfig.profile" + ], + "title": "ServiceConfig.profile" + }, + { + "description": "Returns the type of the service, such as HTTP or SOAP.", + "id": "script-api:dw/svc/ServiceConfig#serviceType", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceConfig", + "qualifiedName": "dw.svc.ServiceConfig.serviceType", + "sections": [ + { + "body": "Returns the type of the service, such as HTTP or SOAP.", + "heading": "Description" + } + ], + "signature": "readonly serviceType: string", + "source": "script-api", + "tags": [ + "servicetype", + "serviceconfig.servicetype" + ], + "title": "ServiceConfig.serviceType" + }, + { + "description": "Configuration object for Service Credentials.", + "id": "script-api:dw/svc/ServiceCredential", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceCredential", + "sections": [ + { + "body": "Configuration object for Service Credentials.", + "heading": "Description" + }, + { + "body": "Extends `EncryptedObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "servicecredential", + "dw.svc.servicecredential", + "dw/svc" + ], + "title": "ServiceCredential" + }, + { + "deprecated": { + "message": "Use dw.crypto.Cipher to encrypt data as needed." + }, + "description": "Constant for specification of the public key encryption algorithm RSA.", + "id": "script-api:dw/svc/ServiceCredential#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ENCRYPTION_ALGORITHM_RSA", + "sections": [ + { + "body": "Constant for specification of the public key encryption algorithm RSA.", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA: string", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa", + "servicecredential.encryption_algorithm_rsa" + ], + "title": "ServiceCredential.ENCRYPTION_ALGORITHM_RSA" + }, + { + "deprecated": { + "message": "Use dw.crypto.Cipher to encrypt data as needed." + }, + "description": "Constant for specification of the public key encryption algorithm RSA.", + "id": "script-api:dw/svc/ServiceCredential#ENCRYPTION_ALGORITHM_RSA", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ENCRYPTION_ALGORITHM_RSA", + "sections": [ + { + "body": "Constant for specification of the public key encryption algorithm RSA.", + "heading": "Description" + } + ], + "signature": "static readonly ENCRYPTION_ALGORITHM_RSA: string", + "source": "script-api", + "tags": [ + "encryption_algorithm_rsa", + "servicecredential.encryption_algorithm_rsa" + ], + "title": "ServiceCredential.ENCRYPTION_ALGORITHM_RSA" + }, + { + "description": "Returns the unique Credential ID.", + "id": "script-api:dw/svc/ServiceCredential#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.ID", + "sections": [ + { + "body": "Returns the unique Credential ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "servicecredential.id" + ], + "title": "ServiceCredential.ID" + }, + { + "description": "Return the URL.", + "id": "script-api:dw/svc/ServiceCredential#URL", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.URL", + "sections": [ + { + "body": "Return the URL.", + "heading": "Description" + } + ], + "signature": "readonly URL: string", + "source": "script-api", + "tags": [ + "url", + "servicecredential.url" + ], + "title": "ServiceCredential.URL" + }, + { + "deprecated": { + "message": "Use dw.crypto.Cipher to encrypt data as needed." + }, + "description": "Encrypts the password from this object with the given algorithm and the public key taken from a certificate in the keystore. Returned is the base64-encoded representation of the result.", + "id": "script-api:dw/svc/ServiceCredential#getEncryptedPassword", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "algorithm", + "type": "string" + }, + { + "name": "publicKey", + "type": "CertificateRef" + } + ], + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getEncryptedPassword", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encrypts the password from this object with the given algorithm\nand the public key taken from a certificate in the keystore.\nReturned is the base64-encoded representation of the result.\n\nSee also dw.crypto.Cipher.encrypt_2 on how to generate RSA key pairs.", + "heading": "Description" + } + ], + "signature": "getEncryptedPassword(algorithm: string, publicKey: CertificateRef): string", + "source": "script-api", + "tags": [ + "getencryptedpassword", + "servicecredential.getencryptedpassword" + ], + "title": "ServiceCredential.getEncryptedPassword" + }, + { + "description": "Returns the unique Credential ID.", + "id": "script-api:dw/svc/ServiceCredential#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique Credential ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "servicecredential.getid" + ], + "title": "ServiceCredential.getID" + }, + { + "description": "Returns the Password in plain text.", + "id": "script-api:dw/svc/ServiceCredential#getPassword", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getPassword", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Password in plain text.", + "heading": "Description" + } + ], + "signature": "getPassword(): string", + "source": "script-api", + "tags": [ + "getpassword", + "servicecredential.getpassword" + ], + "title": "ServiceCredential.getPassword" + }, + { + "description": "Return the URL.", + "id": "script-api:dw/svc/ServiceCredential#getURL", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getURL", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return the URL.", + "heading": "Description" + } + ], + "signature": "getURL(): string", + "source": "script-api", + "tags": [ + "geturl", + "servicecredential.geturl" + ], + "title": "ServiceCredential.getURL" + }, + { + "description": "Returns the User ID.", + "id": "script-api:dw/svc/ServiceCredential#getUser", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.getUser", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the User ID.", + "heading": "Description" + } + ], + "signature": "getUser(): string", + "source": "script-api", + "tags": [ + "getuser", + "servicecredential.getuser" + ], + "title": "ServiceCredential.getUser" + }, + { + "description": "Returns the Password in plain text.", + "id": "script-api:dw/svc/ServiceCredential#password", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.password", + "sections": [ + { + "body": "Returns the Password in plain text.", + "heading": "Description" + } + ], + "signature": "readonly password: string", + "source": "script-api", + "tags": [ + "password", + "servicecredential.password" + ], + "title": "ServiceCredential.password" + }, + { + "description": "Returns the User ID.", + "id": "script-api:dw/svc/ServiceCredential#user", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceCredential", + "qualifiedName": "dw.svc.ServiceCredential.user", + "sections": [ + { + "body": "Returns the User ID.", + "heading": "Description" + } + ], + "signature": "readonly user: string", + "source": "script-api", + "tags": [ + "user", + "servicecredential.user" + ], + "title": "ServiceCredential.user" + }, + { + "deprecated": { + "message": "This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry\ninstead, which allows configuration on the Service directly." + }, + "description": "Base class of Service Definitions.", + "id": "script-api:dw/svc/ServiceDefinition", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceDefinition", + "sections": [ + { + "body": "Base class of Service Definitions.\n\nA service definition represents configuration that is shared across all Service instances.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "servicedefinition", + "dw.svc.servicedefinition", + "dw/svc" + ], + "title": "ServiceDefinition" + }, + { + "description": "Returns the Service Configuration stored in the database.", + "id": "script-api:dw/svc/ServiceDefinition#configuration", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.configuration", + "sections": [ + { + "body": "Returns the Service Configuration stored in the database.", + "heading": "Description" + } + ], + "signature": "readonly configuration: ServiceConfig", + "source": "script-api", + "tags": [ + "configuration", + "servicedefinition.configuration" + ], + "title": "ServiceDefinition.configuration" + }, + { + "description": "Register a callback to handle custom portions of the service.", + "id": "script-api:dw/svc/ServiceDefinition#configure", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "config", + "type": "Object" + } + ], + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.configure", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Register a callback to handle custom portions of the service.\n\nThis callback may declare multiple methods:", + "heading": "Description" + } + ], + "signature": "configure(config: Object): ServiceDefinition", + "source": "script-api", + "tags": [ + "configure", + "servicedefinition.configure" + ], + "title": "ServiceDefinition.configure" + }, + { + "description": "Returns the Service Configuration stored in the database.", + "id": "script-api:dw/svc/ServiceDefinition#getConfiguration", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.getConfiguration", + "returns": { + "type": "ServiceConfig" + }, + "sections": [ + { + "body": "Returns the Service Configuration stored in the database.", + "heading": "Description" + } + ], + "signature": "getConfiguration(): ServiceConfig", + "source": "script-api", + "tags": [ + "getconfiguration", + "servicedefinition.getconfiguration" + ], + "title": "ServiceDefinition.getConfiguration" + }, + { + "description": "Returns the name of this service.", + "id": "script-api:dw/svc/ServiceDefinition#getServiceName", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.getServiceName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of this service.", + "heading": "Description" + } + ], + "signature": "getServiceName(): string", + "source": "script-api", + "tags": [ + "getservicename", + "servicedefinition.getservicename" + ], + "title": "ServiceDefinition.getServiceName" + }, + { + "description": "Returns the status of whether mock mode is enabled for all instances of this definition.", + "id": "script-api:dw/svc/ServiceDefinition#isMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.isMock", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether mock mode is enabled for all instances of this definition.", + "heading": "Description" + } + ], + "signature": "isMock(): boolean", + "source": "script-api", + "tags": [ + "ismock", + "servicedefinition.ismock" + ], + "title": "ServiceDefinition.isMock" + }, + { + "description": "Returns the status of whether the shared throwOnError flag is set.", + "id": "script-api:dw/svc/ServiceDefinition#isThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.isThrowOnError", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the shared throwOnError flag is set.", + "heading": "Description" + } + ], + "signature": "isThrowOnError(): boolean", + "source": "script-api", + "tags": [ + "isthrowonerror", + "servicedefinition.isthrowonerror" + ], + "title": "ServiceDefinition.isThrowOnError" + }, + { + "description": "Returns the status of whether mock mode is enabled for all instances of this definition.", + "id": "script-api:dw/svc/ServiceDefinition#mock", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.mock", + "sections": [ + { + "body": "Returns the status of whether mock mode is enabled for all instances of this definition.", + "heading": "Description" + } + ], + "signature": "readonly mock: boolean", + "source": "script-api", + "tags": [ + "mock", + "servicedefinition.mock" + ], + "title": "ServiceDefinition.mock" + }, + { + "description": "Returns the name of this service.", + "id": "script-api:dw/svc/ServiceDefinition#serviceName", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.serviceName", + "sections": [ + { + "body": "Returns the name of this service.", + "heading": "Description" + } + ], + "signature": "readonly serviceName: string", + "source": "script-api", + "tags": [ + "servicename", + "servicedefinition.servicename" + ], + "title": "ServiceDefinition.serviceName" + }, + { + "description": "Sets the mock mode for all Service instances that use this definition.", + "id": "script-api:dw/svc/ServiceDefinition#setMock", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.setMock", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Sets the mock mode for all Service instances that use this definition.", + "heading": "Description" + } + ], + "signature": "setMock(): ServiceDefinition", + "source": "script-api", + "tags": [ + "setmock", + "servicedefinition.setmock" + ], + "title": "ServiceDefinition.setMock" + }, + { + "description": "Sets the throwOnError flag to true for all Service instances that use this definition.", + "id": "script-api:dw/svc/ServiceDefinition#setThrowOnError", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.setThrowOnError", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Sets the throwOnError flag to true for all Service instances that use this definition.", + "heading": "Description" + } + ], + "signature": "setThrowOnError(): ServiceDefinition", + "source": "script-api", + "tags": [ + "setthrowonerror", + "servicedefinition.setthrowonerror" + ], + "title": "ServiceDefinition.setThrowOnError" + }, + { + "description": "Returns the status of whether the shared throwOnError flag is set.", + "id": "script-api:dw/svc/ServiceDefinition#throwOnError", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceDefinition", + "qualifiedName": "dw.svc.ServiceDefinition.throwOnError", + "sections": [ + { + "body": "Returns the status of whether the shared throwOnError flag is set.", + "heading": "Description" + } + ], + "signature": "readonly throwOnError: boolean", + "source": "script-api", + "tags": [ + "throwonerror", + "servicedefinition.throwonerror" + ], + "title": "ServiceDefinition.throwOnError" + }, + { + "description": "Configuration object for Service Profiles.", + "id": "script-api:dw/svc/ServiceProfile", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceProfile", + "sections": [ + { + "body": "Configuration object for Service Profiles.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "serviceprofile", + "dw.svc.serviceprofile", + "dw/svc" + ], + "title": "ServiceProfile" + }, + { + "description": "Returns the unique Service ID.", + "id": "script-api:dw/svc/ServiceProfile#ID", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.ID", + "sections": [ + { + "body": "Returns the unique Service ID.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "serviceprofile.id" + ], + "title": "ServiceProfile.ID" + }, + { + "description": "Returns the maximum number of errors in an interval allowed by the circuit breaker.", + "id": "script-api:dw/svc/ServiceProfile#cbCalls", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.cbCalls", + "sections": [ + { + "body": "Returns the maximum number of errors in an interval allowed by the circuit breaker.", + "heading": "Description" + } + ], + "signature": "readonly cbCalls: number", + "source": "script-api", + "tags": [ + "cbcalls", + "serviceprofile.cbcalls" + ], + "title": "ServiceProfile.cbCalls" + }, + { + "description": "Returns the interval of the circuit breaker in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#cbMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.cbMillis", + "sections": [ + { + "body": "Returns the interval of the circuit breaker in milliseconds.", + "heading": "Description" + } + ], + "signature": "readonly cbMillis: number", + "source": "script-api", + "tags": [ + "cbmillis", + "serviceprofile.cbmillis" + ], + "title": "ServiceProfile.cbMillis" + }, + { + "description": "Returns the maximum number of errors in an interval allowed by the circuit breaker.", + "id": "script-api:dw/svc/ServiceProfile#getCbCalls", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getCbCalls", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum number of errors in an interval allowed by the circuit breaker.", + "heading": "Description" + } + ], + "signature": "getCbCalls(): number", + "source": "script-api", + "tags": [ + "getcbcalls", + "serviceprofile.getcbcalls" + ], + "title": "ServiceProfile.getCbCalls" + }, + { + "description": "Returns the interval of the circuit breaker in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#getCbMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getCbMillis", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the interval of the circuit breaker in milliseconds.", + "heading": "Description" + } + ], + "signature": "getCbMillis(): number", + "source": "script-api", + "tags": [ + "getcbmillis", + "serviceprofile.getcbmillis" + ], + "title": "ServiceProfile.getCbMillis" + }, + { + "description": "Returns the unique Service ID.", + "id": "script-api:dw/svc/ServiceProfile#getID", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique Service ID.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "serviceprofile.getid" + ], + "title": "ServiceProfile.getID" + }, + { + "description": "Returns the maximum number of calls in an interval allowed by the rate limiter.", + "id": "script-api:dw/svc/ServiceProfile#getRateLimitCalls", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getRateLimitCalls", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum number of calls in an interval allowed by the rate limiter.", + "heading": "Description" + } + ], + "signature": "getRateLimitCalls(): number", + "source": "script-api", + "tags": [ + "getratelimitcalls", + "serviceprofile.getratelimitcalls" + ], + "title": "ServiceProfile.getRateLimitCalls" + }, + { + "description": "Returns the interval of the rate limiter in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#getRateLimitMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getRateLimitMillis", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the interval of the rate limiter in milliseconds.", + "heading": "Description" + } + ], + "signature": "getRateLimitMillis(): number", + "source": "script-api", + "tags": [ + "getratelimitmillis", + "serviceprofile.getratelimitmillis" + ], + "title": "ServiceProfile.getRateLimitMillis" + }, + { + "description": "Returns the service call timeout in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#getTimeoutMillis", + "kind": "method", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.getTimeoutMillis", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the service call timeout in milliseconds.", + "heading": "Description" + } + ], + "signature": "getTimeoutMillis(): number", + "source": "script-api", + "tags": [ + "gettimeoutmillis", + "serviceprofile.gettimeoutmillis" + ], + "title": "ServiceProfile.getTimeoutMillis" + }, + { + "description": "Returns the maximum number of calls in an interval allowed by the rate limiter.", + "id": "script-api:dw/svc/ServiceProfile#rateLimitCalls", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.rateLimitCalls", + "sections": [ + { + "body": "Returns the maximum number of calls in an interval allowed by the rate limiter.", + "heading": "Description" + } + ], + "signature": "readonly rateLimitCalls: number", + "source": "script-api", + "tags": [ + "ratelimitcalls", + "serviceprofile.ratelimitcalls" + ], + "title": "ServiceProfile.rateLimitCalls" + }, + { + "description": "Returns the interval of the rate limiter in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#rateLimitMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.rateLimitMillis", + "sections": [ + { + "body": "Returns the interval of the rate limiter in milliseconds.", + "heading": "Description" + } + ], + "signature": "readonly rateLimitMillis: number", + "source": "script-api", + "tags": [ + "ratelimitmillis", + "serviceprofile.ratelimitmillis" + ], + "title": "ServiceProfile.rateLimitMillis" + }, + { + "description": "Returns the service call timeout in milliseconds.", + "id": "script-api:dw/svc/ServiceProfile#timeoutMillis", + "kind": "property", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc/ServiceProfile", + "qualifiedName": "dw.svc.ServiceProfile.timeoutMillis", + "sections": [ + { + "body": "Returns the service call timeout in milliseconds.", + "heading": "Description" + } + ], + "signature": "readonly timeoutMillis: number", + "source": "script-api", + "tags": [ + "timeoutmillis", + "serviceprofile.timeoutmillis" + ], + "title": "ServiceProfile.timeoutMillis" + }, + { + "deprecated": { + "message": "It is recommended to use the LocalServiceRegistry instead of this class." + }, + "description": "The ServiceRegistry is responsible for managing Service definitions and their instances.", + "examples": [ + "ServiceRegistry.configure(\"MyFTPService\", {\n    mockExec : function(svc:FTPService, params) {\n        return [\n            { \"name\": \"file1\", \"timestamp\": new Date(2011, 02, 21)},\n            { \"name\": \"file2\", \"timestamp\": new Date(2012, 02, 21)},\n            { \"name\": \"file3\", \"timestamp\": new Date(2013, 02, 21)}\n        ];\n    },\n    createRequest: function(svc:FTPService, params) {\n        svc.setOperation(\"list\", \"/\");\n    },\n    parseResponse : function(svc:FTPService, listOutput) {\n        var x : Array = [];\n        var resp : Array = listOutput;\n        for(var i = 0; i < resp.length; i++) {\n            var f = resp[i];\n            x.push( { \"name\": f['name'], \"timestamp\": f['timestamp'] } );\n        }\n        return x;\n    }\n});", + "var result : Result = ServiceRegistry.get(\"MyFTPService\").call();\nif(result.status == 'OK') {\n// The result.object is the object returned by the 'after' callback.\n} else {\n// Handle the error. See result.error for more information.\n}" + ], + "id": "script-api:dw/svc/ServiceRegistry", + "kind": "class", + "packagePath": "dw/svc", + "parentId": "script-api:dw/svc", + "qualifiedName": "dw.svc.ServiceRegistry", + "sections": [ + { + "body": "The ServiceRegistry is responsible for managing Service definitions and their instances.\n\nTypical usage involves several steps:\n\n- The service is defined in the Business Manager and configured with necessary credentials.\n- The service callback is configured once during cartridge initialization:\n\n\n- A new service instance is created and called in order to perform the operation:\n\n\nSee ServiceCallback for all the callback options, and individual ServiceDefinition\nclasses for customization specific to a service type.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "serviceregistry", + "dw.svc.serviceregistry", + "dw/svc" + ], + "title": "ServiceRegistry" + }, + { + "description": "Configure the given serviceId with a callback.", + "id": "script-api:dw/svc/ServiceRegistry#configure", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + }, + { + "name": "configObj", + "type": "Object" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.configure", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Configure the given serviceId with a callback.\n\nIf the service is already configured, the given callback will replace any existing one.", + "heading": "Description" + } + ], + "signature": "static configure(serviceID: string, configObj: Object): ServiceDefinition", + "source": "script-api", + "tags": [ + "configure", + "serviceregistry.configure" + ], + "title": "ServiceRegistry.configure" + }, + { + "description": "Configure the given serviceId with a callback.", + "id": "script-api:dw/svc/ServiceRegistry#configure", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + }, + { + "name": "configObj", + "type": "Object" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.configure", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Configure the given serviceId with a callback.\n\nIf the service is already configured, the given callback will replace any existing one.", + "heading": "Description" + } + ], + "signature": "static configure(serviceID: string, configObj: Object): ServiceDefinition", + "source": "script-api", + "tags": [ + "configure", + "serviceregistry.configure" + ], + "title": "ServiceRegistry.configure" + }, + { + "description": "Constructs a new instance of the given service.", + "id": "script-api:dw/svc/ServiceRegistry#get", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.get", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Constructs a new instance of the given service.", + "heading": "Description" + } + ], + "signature": "static get(serviceID: string): Service", + "source": "script-api", + "tags": [ + "get", + "serviceregistry.get" + ], + "title": "ServiceRegistry.get" + }, + { + "description": "Constructs a new instance of the given service.", + "id": "script-api:dw/svc/ServiceRegistry#get", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.get", + "returns": { + "type": "Service" + }, + "sections": [ + { + "body": "Constructs a new instance of the given service.", + "heading": "Description" + } + ], + "signature": "static get(serviceID: string): Service", + "source": "script-api", + "tags": [ + "get", + "serviceregistry.get" + ], + "title": "ServiceRegistry.get" + }, + { + "description": "Gets a Service Definition.", + "id": "script-api:dw/svc/ServiceRegistry#getDefinition", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.getDefinition", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Gets a Service Definition.\n\nThis Service Definition is shared across all Service instances returned by get.", + "heading": "Description" + } + ], + "signature": "static getDefinition(serviceID: string): ServiceDefinition", + "source": "script-api", + "tags": [ + "getdefinition", + "serviceregistry.getdefinition" + ], + "title": "ServiceRegistry.getDefinition" + }, + { + "description": "Gets a Service Definition.", + "id": "script-api:dw/svc/ServiceRegistry#getDefinition", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.getDefinition", + "returns": { + "type": "ServiceDefinition" + }, + "sections": [ + { + "body": "Gets a Service Definition.\n\nThis Service Definition is shared across all Service instances returned by get.", + "heading": "Description" + } + ], + "signature": "static getDefinition(serviceID: string): ServiceDefinition", + "source": "script-api", + "tags": [ + "getdefinition", + "serviceregistry.getdefinition" + ], + "title": "ServiceRegistry.getDefinition" + }, + { + "description": "Returns the status of whether the given service has been configured with a callback.", + "id": "script-api:dw/svc/ServiceRegistry#isConfigured", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.isConfigured", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the given service has been configured with a callback.", + "heading": "Description" + } + ], + "signature": "static isConfigured(serviceID: string): boolean", + "source": "script-api", + "tags": [ + "isconfigured", + "serviceregistry.isconfigured" + ], + "title": "ServiceRegistry.isConfigured" + }, + { + "description": "Returns the status of whether the given service has been configured with a callback.", + "id": "script-api:dw/svc/ServiceRegistry#isConfigured", + "kind": "method", + "packagePath": "dw/svc", + "params": [ + { + "name": "serviceID", + "type": "string" + } + ], + "parentId": "script-api:dw/svc/ServiceRegistry", + "qualifiedName": "dw.svc.ServiceRegistry.isConfigured", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns the status of whether the given service has been configured with a callback.", + "heading": "Description" + } + ], + "signature": "static isConfigured(serviceID: string): boolean", + "source": "script-api", + "tags": [ + "isconfigured", + "serviceregistry.isconfigured" + ], + "title": "ServiceRegistry.isConfigured" + }, + { + "description": "27 declarations", + "id": "script-api:dw/system", + "kind": "package", + "packagePath": "dw/system", + "qualifiedName": "dw.system", + "source": "script-api", + "tags": [ + "dw/system", + "dw.system" + ], + "title": "dw.system" + }, + { + "deprecated": { + "message": "see dw.customer.AgentUserStatusCodes - this class should only be used for the LoginAgentUser / LoginOnBehalfCustomer pipelets" + }, + "description": "AgentUserStatusCodes contains constants representing status codes that can be used with a Status object to indicate the success or failure of the agent user login process.", + "id": "script-api:dw/system/AgentUserStatusCodes", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.AgentUserStatusCodes", + "sections": [ + { + "body": "AgentUserStatusCodes contains constants representing status codes that can be\nused with a Status object to indicate the success or failure of the agent\nuser login process.", + "heading": "Description" + }, + { + "body": "Extends `customerAgentUserStatusCodes`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "agentuserstatuscodes", + "dw.system.agentuserstatuscodes", + "dw/system" + ], + "title": "AgentUserStatusCodes" + }, + { + "description": "The Cache class represents a custom cache.", + "examples": [ + "var cache = CacheMgr.getCache( 'SiteConfigurations' );\ncache.get( Site.current.ID + \"config\", function loadSiteConfiguration() {return loadCfg( Site.current );} );" + ], + "id": "script-api:dw/system/Cache", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Cache", + "sections": [ + { + "body": "The Cache class represents a custom cache.\n\nA cache stores data over multiple requests. Each cartridge can define its own\ncaches for different business requirements. To limit the\nvisibility of cache entries by scope, for example, by site, catalog, or\nexternal system, include the scope reference when constructing the\nkey. For example:\n\n\nDo not build the cache key using personal user data, since the key might be\nvisible in log messages.\n\nThere is never a guarantee that a stored object can be retrieved from the\ncache. The storage allocated for entries is limited and clearing or\ninvalidation might occur at any time. To maintain the cache size limits, the\ncache evicts entries that are less likely to be used again. For example, the\ncache might evict an entry because it hasn't been used recently or very\noften. Cache entries aren't synchronized between different application\nservers.\n\nThe cache returns immutable copies of the original objects put into the\ncache. Lists are converted to arrays during this process. Only JavaScript\nprimitive values and tree-like object structures can be stored as entries.\nObject structures can consist of arrays, lists, and basic JavaScript\nobjects. Script API classes are not supported, except dw.util.List\nand its subclasses. `null` can be stored as a value.\n`undefined` can't be stored.\n\nSee CacheMgr for details about how to configure a custom cache.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "cache", + "dw.system.cache", + "dw/system" + ], + "title": "Cache" + }, + { + "description": "Returns the value associated with key in this cache, or invokes the loader function to generate the entry if there is no entry found. The generated entry is stored for future retrieval. If the loader function returns `undefined`, this value is not stored in the cache.", + "id": "script-api:dw/system/Cache#get", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + }, + { + "name": "loader", + "type": "Function" + } + ], + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.get", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the value associated with key in this cache, or invokes the loader function to generate the entry if\nthere is no entry found. The generated entry is stored for future retrieval. If the loader function returns\n`undefined`, this value is not stored in the cache.", + "heading": "Description" + } + ], + "signature": "get(key: string, loader: Function): any", + "source": "script-api", + "tags": [ + "get", + "cache.get" + ], + "title": "Cache.get" + }, + { + "description": "Returns the value associated with key in this cache. If there is no entry in the cache then `undefined` is returned.", + "id": "script-api:dw/system/Cache#get", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.get", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the value associated with key in this cache. If there is no entry in the cache then\n`undefined` is returned.", + "heading": "Description" + } + ], + "signature": "get(key: string): any", + "source": "script-api", + "tags": [ + "get", + "cache.get" + ], + "title": "Cache.get" + }, + { + "description": "Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect.", + "id": "script-api:dw/system/Cache#invalidate", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.invalidate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect.", + "heading": "Description" + } + ], + "signature": "invalidate(key: string): void", + "source": "script-api", + "tags": [ + "invalidate", + "cache.invalidate" + ], + "title": "Cache.invalidate" + }, + { + "description": "Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists. Storing `undefined` as value has the same effect as calling invalidate for that key.", + "id": "script-api:dw/system/Cache#put", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/system/Cache", + "qualifiedName": "dw.system.Cache.put", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists.\nStoring `undefined` as value has the same effect as calling invalidate for that key.", + "heading": "Description" + } + ], + "signature": "put(key: string, value: any): void", + "source": "script-api", + "tags": [ + "put", + "cache.put" + ], + "title": "Cache.put" + }, + { + "description": "The CacheMgr class is the entry point for using custom caches.", + "examples": [ + "\"caches\": \"./caches.json\"" + ], + "id": "script-api:dw/system/CacheMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.CacheMgr", + "sections": [ + { + "body": "The CacheMgr class is the entry point for using custom caches.\n\nThe CacheMgr can manage multiple custom caches that share one storage space. Each individual cache has a unique ID\nand an optional expiration time that specifies the maximum time (in seconds) an entry is stored in the cache. For\nregistering caches inside the cartridge root folder, a 'package.json' file with a 'caches' entry must exist. The\nregistration of caches is independent of any site context.\n\n\nThe caches entry links to a JSON file, with a path relative to the 'package.json' file. This file lists all\nregistered caches inside the caches property:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "cachemgr", + "dw.system.cachemgr", + "dw/system" + ], + "title": "CacheMgr" + }, + { + "description": "Returns the defined cache instance for the given ID. Throws an exception when the requested cache has not been defined in any caches.json descriptor.", + "id": "script-api:dw/system/CacheMgr#getCache", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "cacheID", + "type": "string" + } + ], + "parentId": "script-api:dw/system/CacheMgr", + "qualifiedName": "dw.system.CacheMgr.getCache", + "returns": { + "type": "Cache" + }, + "sections": [ + { + "body": "Returns the defined cache instance for the given ID. Throws an exception when the requested cache has not been\ndefined in any caches.json descriptor.", + "heading": "Description" + } + ], + "signature": "static getCache(cacheID: string): Cache", + "source": "script-api", + "tags": [ + "getcache", + "cachemgr.getcache" + ], + "title": "CacheMgr.getCache" + }, + { + "description": "Returns the defined cache instance for the given ID. Throws an exception when the requested cache has not been defined in any caches.json descriptor.", + "id": "script-api:dw/system/CacheMgr#getCache", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "cacheID", + "type": "string" + } + ], + "parentId": "script-api:dw/system/CacheMgr", + "qualifiedName": "dw.system.CacheMgr.getCache", + "returns": { + "type": "Cache" + }, + "sections": [ + { + "body": "Returns the defined cache instance for the given ID. Throws an exception when the requested cache has not been\ndefined in any caches.json descriptor.", + "heading": "Description" + } + ], + "signature": "static getCache(cacheID: string): Cache", + "source": "script-api", + "tags": [ + "getcache", + "cachemgr.getcache" + ], + "title": "CacheMgr.getCache" + }, + { + "description": "This class provides functionality to call hooks. A hook is an extension point in the business logic, where you can register scripts to customize functionality.", + "id": "script-api:dw/system/HookMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.HookMgr", + "sections": [ + { + "body": "This class provides functionality to call hooks. A hook is an extension point in the business logic,\nwhere you can register scripts to customize functionality.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "hookmgr", + "dw.system.hookmgr", + "dw/system" + ], + "title": "HookMgr" + }, + { + "description": "Calls a hook on base of the specified extensionPoint and function. If a hook throws an exception, then this method will also throw an exception. If no hook and no system default implementation is provided, then this method will return undefined.", + "id": "script-api:dw/system/HookMgr#callHook", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "extensionPoint", + "type": "string" + }, + { + "name": "function_", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.callHook", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Calls a hook on base of the specified extensionPoint and function. If a hook throws an exception, then\nthis method will also throw an exception. If no hook and no system default implementation is provided,\nthen this method will return undefined.\n\nSample:", + "heading": "Description" + } + ], + "signature": "static callHook(extensionPoint: string, function_: string, args?: any[]): any", + "source": "script-api", + "tags": [ + "callhook", + "hookmgr.callhook" + ], + "title": "HookMgr.callHook" + }, + { + "description": "Calls a hook on base of the specified extensionPoint and function. If a hook throws an exception, then this method will also throw an exception. If no hook and no system default implementation is provided, then this method will return undefined.", + "id": "script-api:dw/system/HookMgr#callHook", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "extensionPoint", + "type": "string" + }, + { + "name": "function_", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.callHook", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Calls a hook on base of the specified extensionPoint and function. If a hook throws an exception, then\nthis method will also throw an exception. If no hook and no system default implementation is provided,\nthen this method will return undefined.\n\nSample:", + "heading": "Description" + } + ], + "signature": "static callHook(extensionPoint: string, function_: string, args?: any[]): any", + "source": "script-api", + "tags": [ + "callhook", + "hookmgr.callhook" + ], + "title": "HookMgr.callHook" + }, + { + "description": "Checks whether a hook is registered or a system default implementation exists for this extension point.", + "id": "script-api:dw/system/HookMgr#hasHook", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "extensionPoint", + "type": "string" + } + ], + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.hasHook", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks whether a hook is registered or a system default implementation exists for this extension point.\n\nextensionPoint refers to the same name used to register a script as implementation. With this method it's only\npossible to check for a whole script registered but it is not possible to check, whether an individual function\nis implemented.\n\nSample:", + "heading": "Description" + } + ], + "signature": "static hasHook(extensionPoint: string): boolean", + "source": "script-api", + "tags": [ + "hashook", + "hookmgr.hashook" + ], + "title": "HookMgr.hasHook" + }, + { + "description": "Checks whether a hook is registered or a system default implementation exists for this extension point.", + "id": "script-api:dw/system/HookMgr#hasHook", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "extensionPoint", + "type": "string" + } + ], + "parentId": "script-api:dw/system/HookMgr", + "qualifiedName": "dw.system.HookMgr.hasHook", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks whether a hook is registered or a system default implementation exists for this extension point.\n\nextensionPoint refers to the same name used to register a script as implementation. With this method it's only\npossible to check for a whole script registered but it is not possible to check, whether an individual function\nis implemented.\n\nSample:", + "heading": "Description" + } + ], + "signature": "static hasHook(extensionPoint: string): boolean", + "source": "script-api", + "tags": [ + "hashook", + "hookmgr.hashook" + ], + "title": "HookMgr.hasHook" + }, + { + "description": "Class used to wrap internal objects to hide them from B2C Commerce Script code.", + "id": "script-api:dw/system/InternalObject", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.InternalObject", + "sections": [ + { + "body": "Class used to wrap internal objects to hide them from\nB2C Commerce Script code.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "internalobject", + "dw.system.internalobject", + "dw/system" + ], + "title": "InternalObject" + }, + { + "description": "Returns a string representation of this object.", + "id": "script-api:dw/system/InternalObject#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/InternalObject", + "qualifiedName": "dw.system.InternalObject.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this object.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "internalobject.tostring" + ], + "title": "InternalObject.toString" + }, + { + "description": "Returns a string representation of this object.", + "id": "script-api:dw/system/InternalObject#valueOf", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/InternalObject", + "qualifiedName": "dw.system.InternalObject.valueOf", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this object.", + "heading": "Description" + } + ], + "signature": "valueOf(): string", + "source": "script-api", + "tags": [ + "valueof", + "internalobject.valueof" + ], + "title": "InternalObject.valueOf" + }, + { + "description": "Reserved for future use.", + "id": "script-api:dw/system/JobProcessMonitor", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.JobProcessMonitor", + "sections": [ + { + "body": "Reserved for future use.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "jobprocessmonitor", + "dw.system.jobprocessmonitor", + "dw/system" + ], + "title": "JobProcessMonitor" + }, + { + "description": "Reserved for future use. Gets the total work count.", + "id": "script-api:dw/system/JobProcessMonitor#getTotalWork", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.getTotalWork", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Reserved for future use. Gets the total work count.", + "heading": "Description" + } + ], + "signature": "getTotalWork(): number", + "source": "script-api", + "tags": [ + "gettotalwork", + "jobprocessmonitor.gettotalwork" + ], + "title": "JobProcessMonitor.getTotalWork" + }, + { + "description": "Reserved for future use. Gets the work message.", + "id": "script-api:dw/system/JobProcessMonitor#getWorkMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.getWorkMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Reserved for future use. Gets the work message.", + "heading": "Description" + } + ], + "signature": "getWorkMessage(): string", + "source": "script-api", + "tags": [ + "getworkmessage", + "jobprocessmonitor.getworkmessage" + ], + "title": "JobProcessMonitor.getWorkMessage" + }, + { + "description": "Reserved for future use. Sets the total work count.", + "id": "script-api:dw/system/JobProcessMonitor#setTotalWork", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "totalWork", + "type": "number" + } + ], + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.setTotalWork", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Reserved for future use. Sets the total work count.", + "heading": "Description" + } + ], + "signature": "setTotalWork(totalWork: number): void", + "source": "script-api", + "tags": [ + "settotalwork", + "jobprocessmonitor.settotalwork" + ], + "title": "JobProcessMonitor.setTotalWork" + }, + { + "description": "Reserved for future use. Sets the work message.", + "id": "script-api:dw/system/JobProcessMonitor#setWorkMessage", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.setWorkMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Reserved for future use. Sets the work message.", + "heading": "Description" + } + ], + "signature": "setWorkMessage(msg: string): void", + "source": "script-api", + "tags": [ + "setworkmessage", + "jobprocessmonitor.setworkmessage" + ], + "title": "JobProcessMonitor.setWorkMessage" + }, + { + "description": "Reserved for future use. Gets the total work count.", + "id": "script-api:dw/system/JobProcessMonitor#totalWork", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.totalWork", + "sections": [ + { + "body": "Reserved for future use. Gets the total work count.", + "heading": "Description" + } + ], + "signature": "totalWork: number", + "source": "script-api", + "tags": [ + "totalwork", + "jobprocessmonitor.totalwork" + ], + "title": "JobProcessMonitor.totalWork" + }, + { + "description": "Reserved for future use. Gets the work message.", + "id": "script-api:dw/system/JobProcessMonitor#workMessage", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.workMessage", + "sections": [ + { + "body": "Reserved for future use. Gets the work message.", + "heading": "Description" + } + ], + "signature": "workMessage: string", + "source": "script-api", + "tags": [ + "workmessage", + "jobprocessmonitor.workmessage" + ], + "title": "JobProcessMonitor.workMessage" + }, + { + "description": "Reserved for future use. Increments the count of work items by the value of the specified parameter.", + "id": "script-api:dw/system/JobProcessMonitor#worked", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "worked", + "type": "number" + } + ], + "parentId": "script-api:dw/system/JobProcessMonitor", + "qualifiedName": "dw.system.JobProcessMonitor.worked", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Reserved for future use. Increments the count of work items by the value of the specified\nparameter.", + "heading": "Description" + } + ], + "signature": "worked(worked: number): void", + "source": "script-api", + "tags": [ + "worked", + "jobprocessmonitor.worked" + ], + "title": "JobProcessMonitor.worked" + }, + { + "description": "A log4j like logger instance. To obtain such an instance, use the dw.system.Logger.getRootLogger or dw.system.Logger.getLogger or dw.system.Logger.getLogger methods.", + "id": "script-api:dw/system/Log", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Log", + "sections": [ + { + "body": "A log4j like logger instance. To obtain such an instance, use the dw.system.Logger.getRootLogger or\ndw.system.Logger.getLogger or dw.system.Logger.getLogger methods.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "log", + "dw.system.log", + "dw/system" + ], + "title": "Log" + }, + { + "description": "Returns the Nested Diagnostic Context for this script call.", + "id": "script-api:dw/system/Log#NDC", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.NDC", + "sections": [ + { + "body": "Returns the Nested Diagnostic Context for this script call.", + "heading": "Description" + } + ], + "signature": "static readonly NDC: LogNDC", + "source": "script-api", + "tags": [ + "ndc", + "log.ndc" + ], + "title": "Log.NDC" + }, + { + "description": "Returns the Nested Diagnostic Context for this script call.", + "id": "script-api:dw/system/Log#NDC", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.NDC", + "sections": [ + { + "body": "Returns the Nested Diagnostic Context for this script call.", + "heading": "Description" + } + ], + "signature": "static readonly NDC: LogNDC", + "source": "script-api", + "tags": [ + "ndc", + "log.ndc" + ], + "title": "Log.NDC" + }, + { + "description": "The method reports an debug level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Log#debug", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.debug", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an debug level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in\n{1}\". The method implements the Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "debug(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "debug", + "log.debug" + ], + "title": "Log.debug" + }, + { + "description": "This method returns true if debug logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.debugEnabled", + "sections": [ + { + "body": "This method returns true if debug logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "readonly debugEnabled: boolean", + "source": "script-api", + "tags": [ + "debugenabled", + "log.debugenabled" + ], + "title": "Log.debugEnabled" + }, + { + "description": "The method reports an error level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Log#error", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.error", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an error level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in\n{1}\". The method implements the Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "error(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "error", + "log.error" + ], + "title": "Log.error" + }, + { + "description": "This method returns true if error logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.errorEnabled", + "sections": [ + { + "body": "This method returns true if error logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "readonly errorEnabled: boolean", + "source": "script-api", + "tags": [ + "errorenabled", + "log.errorenabled" + ], + "title": "Log.errorEnabled" + }, + { + "description": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax. Note: Fatal log messages are always enabled and optionally send via E-Mail.", + "id": "script-api:dw/system/Log#fatal", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.fatal", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0}\nin {1}\". The method implements the Java MessageFormat.format() syntax. Note: Fatal log messages are always\nenabled and optionally send via E-Mail.", + "heading": "Description" + } + ], + "signature": "fatal(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "fatal", + "log.fatal" + ], + "title": "Log.fatal" + }, + { + "description": "Returns the Nested Diagnostic Context for this script call.", + "id": "script-api:dw/system/Log#getNDC", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.getNDC", + "returns": { + "type": "LogNDC" + }, + "sections": [ + { + "body": "Returns the Nested Diagnostic Context for this script call.", + "heading": "Description" + } + ], + "signature": "static getNDC(): LogNDC", + "source": "script-api", + "tags": [ + "getndc", + "log.getndc" + ], + "title": "Log.getNDC" + }, + { + "description": "Returns the Nested Diagnostic Context for this script call.", + "id": "script-api:dw/system/Log#getNDC", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.getNDC", + "returns": { + "type": "LogNDC" + }, + "sections": [ + { + "body": "Returns the Nested Diagnostic Context for this script call.", + "heading": "Description" + } + ], + "signature": "static getNDC(): LogNDC", + "source": "script-api", + "tags": [ + "getndc", + "log.getndc" + ], + "title": "Log.getNDC" + }, + { + "description": "The method reports an information level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Log#info", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.info", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an information level message. Arguments can be embedded into the message, e.g. like \"Failure\n{0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "info(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "info", + "log.info" + ], + "title": "Log.info" + }, + { + "description": "This method returns true if information logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.infoEnabled", + "sections": [ + { + "body": "This method returns true if information logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "readonly infoEnabled: boolean", + "source": "script-api", + "tags": [ + "infoenabled", + "log.infoenabled" + ], + "title": "Log.infoEnabled" + }, + { + "description": "This method returns true if debug logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isDebugEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if debug logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "isDebugEnabled(): boolean", + "source": "script-api", + "tags": [ + "isdebugenabled", + "log.isdebugenabled" + ], + "title": "Log.isDebugEnabled" + }, + { + "description": "This method returns true if error logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isErrorEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if error logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "isErrorEnabled(): boolean", + "source": "script-api", + "tags": [ + "iserrorenabled", + "log.iserrorenabled" + ], + "title": "Log.isErrorEnabled" + }, + { + "description": "This method returns true if information logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isInfoEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if information logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "isInfoEnabled(): boolean", + "source": "script-api", + "tags": [ + "isinfoenabled", + "log.isinfoenabled" + ], + "title": "Log.isInfoEnabled" + }, + { + "description": "This method returns true if warning logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.isWarnEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if warning logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "isWarnEnabled(): boolean", + "source": "script-api", + "tags": [ + "iswarnenabled", + "log.iswarnenabled" + ], + "title": "Log.isWarnEnabled" + }, + { + "description": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Log#warn", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.warn", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0}\nin {1}\". The method implements the Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "warn(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "warn", + "log.warn" + ], + "title": "Log.warn" + }, + { + "description": "This method returns true if warning logging is enabled for this logging instance.", + "id": "script-api:dw/system/Log#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Log", + "qualifiedName": "dw.system.Log.warnEnabled", + "sections": [ + { + "body": "This method returns true if warning logging is enabled for this logging instance.", + "heading": "Description" + } + ], + "signature": "readonly warnEnabled: boolean", + "source": "script-api", + "tags": [ + "warnenabled", + "log.warnenabled" + ], + "title": "Log.warnEnabled" + }, + { + "description": "A Nested Diagnostic Context, or NDC in short, is an instrument to distinguish interleaved log output from different sources. Log output is typically interleaved when a server handles multiple script calls near-simultaneously.", + "id": "script-api:dw/system/LogNDC", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.LogNDC", + "sections": [ + { + "body": "A Nested Diagnostic Context, or NDC in short, is an instrument to distinguish\ninterleaved log output from different sources. Log output is typically\ninterleaved when a server handles multiple script calls near-simultaneously.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "logndc", + "dw.system.logndc", + "dw/system" + ], + "title": "LogNDC" + }, + { + "description": "Looks at the last diagnostic context at the top of this NDC without removing it. The returned value is the value that was pushed last. If no context is available, then the empty string \"\" is returned.", + "id": "script-api:dw/system/LogNDC#peek", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.peek", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Looks at the last diagnostic context at the top of this NDC without\nremoving it.\nThe returned value is the value that was pushed last. If no context is\navailable, then the empty string \"\" is returned.", + "heading": "Description" + } + ], + "signature": "peek(): string", + "source": "script-api", + "tags": [ + "peek", + "logndc.peek" + ], + "title": "LogNDC.peek" + }, + { + "description": "Clients should call this method before leaving a diagnostic context. The returned value is the value that was pushed last. If no context is available, then the empty string \"\" is returned. NOTE: The NDC is removed after every script execution.", + "id": "script-api:dw/system/LogNDC#pop", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.pop", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Clients should call this method before leaving a diagnostic context.\nThe returned value is the value that was pushed last.\nIf no context is available, then the empty string \"\" is returned.\nNOTE: The NDC is removed after every script execution.", + "heading": "Description" + } + ], + "signature": "pop(): string", + "source": "script-api", + "tags": [ + "pop", + "logndc.pop" + ], + "title": "LogNDC.pop" + }, + { + "description": "Push new diagnostic context information for the current script execution.", + "id": "script-api:dw/system/LogNDC#push", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.push", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Push new diagnostic context information for the current script execution.", + "heading": "Description" + } + ], + "signature": "push(message: string): void", + "source": "script-api", + "tags": [ + "push", + "logndc.push" + ], + "title": "LogNDC.push" + }, + { + "description": "Remove the diagnostic context for this script call.", + "id": "script-api:dw/system/LogNDC#remove", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/LogNDC", + "qualifiedName": "dw.system.LogNDC.remove", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Remove the diagnostic context for this script call.", + "heading": "Description" + } + ], + "signature": "remove(): void", + "source": "script-api", + "tags": [ + "remove", + "logndc.remove" + ], + "title": "LogNDC.remove" + }, + { + "description": "The Logger class provides logging utility methods.", + "id": "script-api:dw/system/Logger", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Logger", + "sections": [ + { + "body": "The Logger class provides logging utility methods.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "logger", + "dw.system.logger", + "dw/system" + ], + "title": "Logger" + }, + { + "description": "The method reports an debug level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#debug", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debug", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an debug level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static debug(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "debug", + "logger.debug" + ], + "title": "Logger.debug" + }, + { + "description": "The method reports an debug level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#debug", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debug", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an debug level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static debug(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "debug", + "logger.debug" + ], + "title": "Logger.debug" + }, + { + "description": "This method returns true if debug logging is enabled.", + "id": "script-api:dw/system/Logger#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debugEnabled", + "sections": [ + { + "body": "This method returns true if debug logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly debugEnabled: boolean", + "source": "script-api", + "tags": [ + "debugenabled", + "logger.debugenabled" + ], + "title": "Logger.debugEnabled" + }, + { + "description": "This method returns true if debug logging is enabled.", + "id": "script-api:dw/system/Logger#debugEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.debugEnabled", + "sections": [ + { + "body": "This method returns true if debug logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly debugEnabled: boolean", + "source": "script-api", + "tags": [ + "debugenabled", + "logger.debugenabled" + ], + "title": "Logger.debugEnabled" + }, + { + "description": "The method reports an error level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#error", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.error", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an error level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static error(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "error", + "logger.error" + ], + "title": "Logger.error" + }, + { + "description": "The method reports an error level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#error", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.error", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an error level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static error(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "error", + "logger.error" + ], + "title": "Logger.error" + }, + { + "description": "This method returns true if error logging is enabled.", + "id": "script-api:dw/system/Logger#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.errorEnabled", + "sections": [ + { + "body": "This method returns true if error logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly errorEnabled: boolean", + "source": "script-api", + "tags": [ + "errorenabled", + "logger.errorenabled" + ], + "title": "Logger.errorEnabled" + }, + { + "description": "This method returns true if error logging is enabled.", + "id": "script-api:dw/system/Logger#errorEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.errorEnabled", + "sections": [ + { + "body": "This method returns true if error logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly errorEnabled: boolean", + "source": "script-api", + "tags": [ + "errorenabled", + "logger.errorenabled" + ], + "title": "Logger.errorEnabled" + }, + { + "description": "Returns the logger object for the given category.", + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "category", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the logger object for the given category.", + "heading": "Description" + } + ], + "signature": "static getLogger(category: string): Log", + "source": "script-api", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "description": "Returns the logger object for the given file name prefix and category. Throws an exception if maximum number of custom log files per day has already been obtained.", + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "fileNamePrefix", + "type": "string | null" + }, + { + "name": "category", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the logger object for the given file name prefix and category.\nThrows an exception if maximum number of custom log files per day has already been obtained.", + "heading": "Description" + } + ], + "signature": "static getLogger(fileNamePrefix: string | null, category: string): Log", + "source": "script-api", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "description": "Returns the logger object for the given category.", + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "category", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the logger object for the given category.", + "heading": "Description" + } + ], + "signature": "static getLogger(category: string): Log", + "source": "script-api", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "description": "Returns the logger object for the given file name prefix and category. Throws an exception if maximum number of custom log files per day has already been obtained.", + "id": "script-api:dw/system/Logger#getLogger", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "fileNamePrefix", + "type": "string | null" + }, + { + "name": "category", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the logger object for the given file name prefix and category.\nThrows an exception if maximum number of custom log files per day has already been obtained.", + "heading": "Description" + } + ], + "signature": "static getLogger(fileNamePrefix: string | null, category: string): Log", + "source": "script-api", + "tags": [ + "getlogger", + "logger.getlogger" + ], + "title": "Logger.getLogger" + }, + { + "description": "Returns the root logger object.", + "id": "script-api:dw/system/Logger#getRootLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getRootLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the root logger object.", + "heading": "Description" + } + ], + "signature": "static getRootLogger(): Log", + "source": "script-api", + "tags": [ + "getrootlogger", + "logger.getrootlogger" + ], + "title": "Logger.getRootLogger" + }, + { + "description": "Returns the root logger object.", + "id": "script-api:dw/system/Logger#getRootLogger", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.getRootLogger", + "returns": { + "type": "Log" + }, + "sections": [ + { + "body": "Returns the root logger object.", + "heading": "Description" + } + ], + "signature": "static getRootLogger(): Log", + "source": "script-api", + "tags": [ + "getrootlogger", + "logger.getrootlogger" + ], + "title": "Logger.getRootLogger" + }, + { + "description": "The method reports an information level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#info", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.info", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an information level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static info(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "info", + "logger.info" + ], + "title": "Logger.info" + }, + { + "description": "The method reports an information level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#info", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.info", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an information level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static info(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "info", + "logger.info" + ], + "title": "Logger.info" + }, + { + "description": "This method returns true if info logging is enabled.", + "id": "script-api:dw/system/Logger#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.infoEnabled", + "sections": [ + { + "body": "This method returns true if info logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly infoEnabled: boolean", + "source": "script-api", + "tags": [ + "infoenabled", + "logger.infoenabled" + ], + "title": "Logger.infoEnabled" + }, + { + "description": "This method returns true if info logging is enabled.", + "id": "script-api:dw/system/Logger#infoEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.infoEnabled", + "sections": [ + { + "body": "This method returns true if info logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly infoEnabled: boolean", + "source": "script-api", + "tags": [ + "infoenabled", + "logger.infoenabled" + ], + "title": "Logger.infoEnabled" + }, + { + "description": "This method returns true if debug logging is enabled.", + "id": "script-api:dw/system/Logger#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isDebugEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if debug logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isDebugEnabled(): boolean", + "source": "script-api", + "tags": [ + "isdebugenabled", + "logger.isdebugenabled" + ], + "title": "Logger.isDebugEnabled" + }, + { + "description": "This method returns true if debug logging is enabled.", + "id": "script-api:dw/system/Logger#isDebugEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isDebugEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if debug logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isDebugEnabled(): boolean", + "source": "script-api", + "tags": [ + "isdebugenabled", + "logger.isdebugenabled" + ], + "title": "Logger.isDebugEnabled" + }, + { + "description": "This method returns true if error logging is enabled.", + "id": "script-api:dw/system/Logger#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isErrorEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if error logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isErrorEnabled(): boolean", + "source": "script-api", + "tags": [ + "iserrorenabled", + "logger.iserrorenabled" + ], + "title": "Logger.isErrorEnabled" + }, + { + "description": "This method returns true if error logging is enabled.", + "id": "script-api:dw/system/Logger#isErrorEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isErrorEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if error logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isErrorEnabled(): boolean", + "source": "script-api", + "tags": [ + "iserrorenabled", + "logger.iserrorenabled" + ], + "title": "Logger.isErrorEnabled" + }, + { + "description": "This method returns true if info logging is enabled.", + "id": "script-api:dw/system/Logger#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isInfoEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if info logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isInfoEnabled(): boolean", + "source": "script-api", + "tags": [ + "isinfoenabled", + "logger.isinfoenabled" + ], + "title": "Logger.isInfoEnabled" + }, + { + "description": "This method returns true if info logging is enabled.", + "id": "script-api:dw/system/Logger#isInfoEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isInfoEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if info logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isInfoEnabled(): boolean", + "source": "script-api", + "tags": [ + "isinfoenabled", + "logger.isinfoenabled" + ], + "title": "Logger.isInfoEnabled" + }, + { + "description": "This method returns true if warning logging is enabled.", + "id": "script-api:dw/system/Logger#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isWarnEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if warning logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isWarnEnabled(): boolean", + "source": "script-api", + "tags": [ + "iswarnenabled", + "logger.iswarnenabled" + ], + "title": "Logger.isWarnEnabled" + }, + { + "description": "This method returns true if warning logging is enabled.", + "id": "script-api:dw/system/Logger#isWarnEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.isWarnEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "This method returns true if warning logging is enabled.", + "heading": "Description" + } + ], + "signature": "static isWarnEnabled(): boolean", + "source": "script-api", + "tags": [ + "iswarnenabled", + "logger.iswarnenabled" + ], + "title": "Logger.isWarnEnabled" + }, + { + "description": "Returns the root logger object.", + "id": "script-api:dw/system/Logger#rootLogger", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.rootLogger", + "sections": [ + { + "body": "Returns the root logger object.", + "heading": "Description" + } + ], + "signature": "static readonly rootLogger: Log", + "source": "script-api", + "tags": [ + "rootlogger", + "logger.rootlogger" + ], + "title": "Logger.rootLogger" + }, + { + "description": "Returns the root logger object.", + "id": "script-api:dw/system/Logger#rootLogger", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.rootLogger", + "sections": [ + { + "body": "Returns the root logger object.", + "heading": "Description" + } + ], + "signature": "static readonly rootLogger: Log", + "source": "script-api", + "tags": [ + "rootlogger", + "logger.rootlogger" + ], + "title": "Logger.rootLogger" + }, + { + "description": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#warn", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warn", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an warning level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static warn(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "warn", + "logger.warn" + ], + "title": "Logger.warn" + }, + { + "description": "The method reports an warning level message. Arguments can be embedded into the message, e.g. like \"Failure {0} in {1}\". The method implements the Java MessageFormat.format() syntax.", + "id": "script-api:dw/system/Logger#warn", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "msg", + "type": "string" + }, + { + "name": "args", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warn", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method reports an warning level message. Arguments can be embedded\ninto the message, e.g. like \"Failure {0} in {1}\". The method implements\nthe Java MessageFormat.format() syntax.", + "heading": "Description" + } + ], + "signature": "static warn(msg: string, args?: any[]): void", + "source": "script-api", + "tags": [ + "warn", + "logger.warn" + ], + "title": "Logger.warn" + }, + { + "description": "This method returns true if warning logging is enabled.", + "id": "script-api:dw/system/Logger#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warnEnabled", + "sections": [ + { + "body": "This method returns true if warning logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly warnEnabled: boolean", + "source": "script-api", + "tags": [ + "warnenabled", + "logger.warnenabled" + ], + "title": "Logger.warnEnabled" + }, + { + "description": "This method returns true if warning logging is enabled.", + "id": "script-api:dw/system/Logger#warnEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Logger", + "qualifiedName": "dw.system.Logger.warnEnabled", + "sections": [ + { + "body": "This method returns true if warning logging is enabled.", + "heading": "Description" + } + ], + "signature": "static readonly warnEnabled: boolean", + "source": "script-api", + "tags": [ + "warnenabled", + "logger.warnenabled" + ], + "title": "Logger.warnEnabled" + }, + { + "description": "OrganizationPreferences is a container for custom global (i.e. organization-level) attributes. The object corresponds with system object definition \"OrganizationPreferences\". It has no system attributes and exists only as a place for merchants to define custom attributes which need to be available to all of their sites.", + "examples": [ + "var orgPrefs : OrganizationPreferences = dw.system.System.getPreferences();\nvar myOrgPrefValue : String = orgPrefs.getCustom()[\"myOrgPref\"];" + ], + "id": "script-api:dw/system/OrganizationPreferences", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.OrganizationPreferences", + "sections": [ + { + "body": "OrganizationPreferences is a container for custom global (i.e.\norganization-level) attributes. The object corresponds with system object\ndefinition \"OrganizationPreferences\". It has no system attributes and exists\nonly as a place for merchants to define custom attributes which need to be\navailable to all of their sites.\n\nAn instance is obtained by calling dw.system.System.getPreferences.\nOnce an instance of the container is obtained, it is possible to read/write\norganization preference values by using the usual syntax for\ndw.object.ExtensibleObject instances. For example:\n\n\nNote: this class allows access to sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.\n\nCommerce Cloud Digital defines many organization-level preferences, relating to\nlocale, timezone, geolocations, etc, which can be managed within the\n\"Global Preferences\" module of the Business Manager, but these preferences\nare not accessible through this object.", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "organizationpreferences", + "dw.system.organizationpreferences", + "dw/system" + ], + "title": "OrganizationPreferences" + }, + { + "description": "A helper for executing pipelines from JavaScript. The main purpose for this API is to invoke process pipelines from JavaScript controllers, e.g. pipelines that return with an end node and that do not perform user interactions. Pipelines that span across multiple requests (e.g. that contain Interaction-Continue-Nodes) are not supported and may not work as expected. The pipeline will be executed within the current request and not by a remote call, so this API works roughly like a Call node in a pipeline. The called pipeline will get its own local pipeline dictionary. The dictionary can be populated with initial values from an argument object. Any results from the pipeline can be read from the pipeline dictionary that is returned by the execute methods.", + "examples": [ + "let Pipeline = require('dw/system/Pipeline');\nlet pdict = Pipeline.execute('MyPipeline-Start', {\nMyArgString: 'someStringValue',\nMyArgNumber: 12345,\nMyArgBoolean: true\n});\nlet result = pdict.MyReturnValue;" + ], + "id": "script-api:dw/system/Pipeline", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Pipeline", + "sections": [ + { + "body": "A helper for executing pipelines from JavaScript. The main purpose for this API is to invoke process pipelines from\nJavaScript controllers, e.g. pipelines that return with an end node and that do not perform user interactions.\nPipelines that span across multiple requests (e.g. that contain Interaction-Continue-Nodes) are not supported and may\nnot work as expected. The pipeline will be executed within the current request and not by a remote call, so this API\nworks roughly like a Call node in a pipeline. The called pipeline will get its own local pipeline dictionary. The\ndictionary can be populated with initial values from an argument object. Any results from the pipeline can be read\nfrom the pipeline dictionary that is returned by the execute methods.\n\nIf an exception occurs during the pipeline processing, the Error-branch of the pipeline will be called. If no error\nhandling exists for the pipeline, the exception will be propagated and can be handled by the script code.\n\nIf the pipeline finishes with an End node, the name of the end node can be obtained from the returned pipeline\ndictionary under the key 'EndNodeName'.\n\nExample:\n\n\nThis feature requires an API version >=15.5.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pipeline", + "dw.system.pipeline", + "dw/system" + ], + "title": "Pipeline" + }, + { + "description": "Executes a pipeline.", + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "pipeline", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "returns": { + "type": "PipelineDictionary" + }, + "sections": [ + { + "body": "Executes a pipeline.", + "heading": "Description" + } + ], + "signature": "static execute(pipeline: string): PipelineDictionary", + "sinceApiVersion": "15.5", + "source": "script-api", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "description": "Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.", + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "pipeline", + "type": "string" + }, + { + "name": "args", + "type": "any" + } + ], + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "returns": { + "type": "PipelineDictionary" + }, + "sections": [ + { + "body": "Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.", + "heading": "Description" + } + ], + "signature": "static execute(pipeline: string, args: any): PipelineDictionary", + "sinceApiVersion": "15.5", + "source": "script-api", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "description": "Executes a pipeline.", + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "pipeline", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "returns": { + "type": "PipelineDictionary" + }, + "sections": [ + { + "body": "Executes a pipeline.", + "heading": "Description" + } + ], + "signature": "static execute(pipeline: string): PipelineDictionary", + "sinceApiVersion": "15.5", + "source": "script-api", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "description": "Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.", + "id": "script-api:dw/system/Pipeline#execute", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "pipeline", + "type": "string" + }, + { + "name": "args", + "type": "any" + } + ], + "parentId": "script-api:dw/system/Pipeline", + "qualifiedName": "dw.system.Pipeline.execute", + "returns": { + "type": "PipelineDictionary" + }, + "sections": [ + { + "body": "Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.", + "heading": "Description" + } + ], + "signature": "static execute(pipeline: string, args: any): PipelineDictionary", + "sinceApiVersion": "15.5", + "source": "script-api", + "tags": [ + "execute", + "pipeline.execute" + ], + "title": "Pipeline.execute" + }, + { + "description": "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'];", + "id": "script-api:dw/system/PipelineDictionary", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.PipelineDictionary", + "sections": [ + { + "body": "The class provides access to the values in the pipeline dictionary. You use\ndynamic properties to access values, such as pdict.myvalue or\npdict['myvalue'];\n\nThe class is used in two different contexts, one where access is limited to\nthe declared input/output values and second to a context with full access.\nInside scripts, the PipelineDictionary allows you to access declared in/out\nvalues (regardless of the alias used in the pipeline and the actual key under\nwhich the value is stored). In templates and pipelines, all values can be\naccessed. In templates the pipeline dictionary is exposed as variable pdict\n(e.g. ${pdict.Product.ID}).\n\nThere are several values that are automatically stored in the\nPipelineDictionary with each request. These include but are not limited to:\n\n- CurrentSession\n- CurrentRequest\n- CurrentHttpParameterMap\n- CurrentForms\n- CurrentCustomer\n- etc.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "pipelinedictionary", + "dw.system.pipelinedictionary", + "dw/system" + ], + "title": "PipelineDictionary" + }, + { + "description": "This class represents a REST error response that is compliant with RFC 9457. It can only be instantiated using the `createError` methods in RESTResponseMgr.", + "examples": [ + "`\nvar error = RESTResponseMgr.createError(400);\nerror.custom.foo = \"bar\";\nerror.render();\n`", + "`\n{\n\"type\": \"https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/bad-request\",\n\"c_foo\": \"bar\"\n}\n`" + ], + "id": "script-api:dw/system/RESTErrorResponse", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTErrorResponse", + "sections": [ + { + "body": "This class represents a REST error response that is compliant with\nRFC 9457. It can only be instantiated using the\n`createError` methods in RESTResponseMgr.\n\nHere is an example:\n\n\nThe above script would result in an HTTP response with status code 400 and the following body:\n\n\nNOTE:\n\n- Custom attributes are rendered with \"c_\" prefix as shown in the example above.\n- Rendering works as described in TopLevel.JSON.stringify.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "resterrorresponse", + "dw.system.resterrorresponse", + "dw/system" + ], + "title": "RESTErrorResponse" + }, + { + "description": "Returns all the custom attributes associated with the error response object. The attributes are stored for the lifetime of the error response object.", + "id": "script-api:dw/system/RESTErrorResponse#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.custom", + "sections": [ + { + "body": "Returns all the custom attributes associated with the error response object. The attributes are stored for the\nlifetime of the error response object.", + "heading": "Description" + } + ], + "signature": "readonly custom: CustomAttributes", + "source": "script-api", + "tags": [ + "custom", + "resterrorresponse.custom" + ], + "title": "RESTErrorResponse.custom" + }, + { + "description": "Returns all the custom attributes associated with the error response object. The attributes are stored for the lifetime of the error response object.", + "id": "script-api:dw/system/RESTErrorResponse#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.getCustom", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns all the custom attributes associated with the error response object. The attributes are stored for the\nlifetime of the error response object.", + "heading": "Description" + } + ], + "signature": "getCustom(): CustomAttributes", + "source": "script-api", + "tags": [ + "getcustom", + "resterrorresponse.getcustom" + ], + "title": "RESTErrorResponse.getCustom" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTErrorResponse#render", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTErrorResponse", + "qualifiedName": "dw.system.RESTErrorResponse.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends the RESTErrorResponse object as an HTTP error response to the client, adhering to\nRFC 9457. This method sets the \"Content-Type\" header to\n\"application/problem+json\", HTTP Status Code to statusCode attribute and constructs the body from type, title,\ndetail and custom attributes of the object. Custom attributes are rendered with \"c_\" prefix to the attribute\nname.", + "heading": "Description" + } + ], + "signature": "render(): void", + "source": "script-api", + "tags": [ + "render", + "resterrorresponse.render" + ], + "throws": [ + { + "description": "If the RESTErrorResponse object is already rendered.", + "type": "IllegalStateException" + }, + { + "description": "If there is an error while serializing the RESTErrorResponse object.", + "type": "Exception" + } + ], + "title": "RESTErrorResponse.render" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTResponseMgr", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTResponseMgr", + "sections": [ + { + "body": "This class provides helper methods for creating REST error and success responses. It is mainly intended to be used to\nbuild Custom REST APIs. But, any controller implementation planning to provide REST-like responses can use these\nmethods. If these methods are being used in the controllers, note that a few defaults like URL prefix for\n`type` in `createError` methods will correspond to Custom REST APIs.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "restresponsemgr", + "dw.system.restresponsemgr", + "dw/system" + ], + "title": "RESTResponseMgr" + }, + { + "description": "Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body is not expected (e.g. statusCode is 204).", + "id": "script-api:dw/system/RESTResponseMgr#createEmptySuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createEmptySuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body\nis not expected (e.g. statusCode is 204).", + "heading": "Description" + } + ], + "signature": "static createEmptySuccess(statusCode: number): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createemptysuccess", + "restresponsemgr.createemptysuccess" + ], + "throws": [ + { + "description": "If the statusCode is not in the (100..299) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createEmptySuccess" + }, + { + "description": "Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body is not expected (e.g. statusCode is 204).", + "id": "script-api:dw/system/RESTResponseMgr#createEmptySuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createEmptySuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body\nis not expected (e.g. statusCode is 204).", + "heading": "Description" + } + ], + "signature": "static createEmptySuccess(statusCode: number): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createemptysuccess", + "restresponsemgr.createemptysuccess" + ], + "throws": [ + { + "description": "If the statusCode is not in the (100..299) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createEmptySuccess" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you have just the statusCode\nof the error and want the type of error to be inferred.\n\n'type' of the error is inferred from the status code as follows:\n\n- `400` - `bad-request`\n- `401` - `unauthorized`\n- `403` - `forbidden`\n- `404` - `resource-not-found`\n- `409` - `conflict`\n- `412` - `precondition-failed`\n- `429` - `too-many-requests`\n- `500` - `internal-server-error`\n- `default` - `about:blank`", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "If the statusCode is not in the (400..599) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'title' and\n'detail' of the error. With this method, custom error codes and types apart from the standard ones can be\nconstructed.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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'.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'detail' of\nthe error but want to have valid 'statusCode', 'type' and 'title'.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string, title: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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`.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "title", + "type": "string" + }, + { + "name": "detail", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method can be used to construct error responses with\nvalid 'statusCode', 'type', 'title' and 'detail'. If you want to omit title or detail, you can pass in\n`null`.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string, title: string, detail: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you have just the statusCode\nof the error and want the type of error to be inferred.\n\n'type' of the error is inferred from the status code as follows:\n\n- `400` - `bad-request`\n- `401` - `unauthorized`\n- `403` - `forbidden`\n- `404` - `resource-not-found`\n- `409` - `conflict`\n- `412` - `precondition-failed`\n- `429` - `too-many-requests`\n- `500` - `internal-server-error`\n- `default` - `about:blank`", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "If the statusCode is not in the (400..599) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'title' and\n'detail' of the error. With this method, custom error codes and types apart from the standard ones can be\nconstructed.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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'.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "title", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'detail' of\nthe error but want to have valid 'statusCode', 'type' and 'title'.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string, title: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "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`.", + "id": "script-api:dw/system/RESTResponseMgr#createError", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "statusCode", + "type": "number" + }, + { + "name": "type", + "type": "string" + }, + { + "name": "title", + "type": "string" + }, + { + "name": "detail", + "type": "string" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createError", + "returns": { + "type": "RESTErrorResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTErrorResponse object. This method can be used to construct error responses with\nvalid 'statusCode', 'type', 'title' and 'detail'. If you want to omit title or detail, you can pass in\n`null`.", + "heading": "Description" + } + ], + "signature": "static createError(statusCode: number, type: string, title: string, detail: string): RESTErrorResponse", + "source": "script-api", + "tags": [ + "createerror", + "restresponsemgr.createerror" + ], + "throws": [ + { + "description": "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.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createError" + }, + { + "description": "Constructs a new RemoteInclude object specific for the SCAPI include path. Usage: SCAPI remote include URL have following form:", + "examples": [ + "BASE_PATH/{apiFamily}/{apiName}/{apiVersion}/organizations/ORG_ID/{resourcePath}[?params]", + "BASE_PATH/product/shopper-products/v1/organizations/ORG_ID/categories/root?siteId=YourShopHere", + "let include = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"product\", \"shopper-products\", \"v1\", \"categories/root\",\ndw.web.URLParameter(\"siteId\", \"YourShopHere\"));" + ], + "id": "script-api:dw/system/RESTResponseMgr#createScapiRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "apiFamily", + "type": "string" + }, + { + "name": "apiName", + "type": "string" + }, + { + "name": "apiVersion", + "type": "string" + }, + { + "name": "resourcePath", + "type": "string" + }, + { + "name": "params", + "optional": true, + "type": "URLParameter[]" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createScapiRemoteInclude", + "returns": { + "type": "RemoteInclude" + }, + "sections": [ + { + "body": "Constructs a new RemoteInclude object specific for the SCAPI include path.\nUsage:\nSCAPI remote include URL have following form:\n\n\nFor the given SCAPI resource path:\n\n\nRemoteInclude object can be constructed in a script like following:\n\n\nPlease notice that 'BASE_PATH' and 'ORG_ID' are automatically resolved.", + "heading": "Description" + } + ], + "signature": "static createScapiRemoteInclude(apiFamily: string, apiName: string, apiVersion: string, resourcePath: string, params?: URLParameter[]): RemoteInclude", + "source": "script-api", + "tags": [ + "createscapiremoteinclude", + "restresponsemgr.createscapiremoteinclude" + ], + "title": "RESTResponseMgr.createScapiRemoteInclude" + }, + { + "description": "Constructs a new RemoteInclude object specific for the SCAPI include path. Usage: SCAPI remote include URL have following form:", + "examples": [ + "BASE_PATH/{apiFamily}/{apiName}/{apiVersion}/organizations/ORG_ID/{resourcePath}[?params]", + "BASE_PATH/product/shopper-products/v1/organizations/ORG_ID/categories/root?siteId=YourShopHere", + "let include = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"product\", \"shopper-products\", \"v1\", \"categories/root\",\ndw.web.URLParameter(\"siteId\", \"YourShopHere\"));" + ], + "id": "script-api:dw/system/RESTResponseMgr#createScapiRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "apiFamily", + "type": "string" + }, + { + "name": "apiName", + "type": "string" + }, + { + "name": "apiVersion", + "type": "string" + }, + { + "name": "resourcePath", + "type": "string" + }, + { + "name": "params", + "optional": true, + "type": "URLParameter[]" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createScapiRemoteInclude", + "returns": { + "type": "RemoteInclude" + }, + "sections": [ + { + "body": "Constructs a new RemoteInclude object specific for the SCAPI include path.\nUsage:\nSCAPI remote include URL have following form:\n\n\nFor the given SCAPI resource path:\n\n\nRemoteInclude object can be constructed in a script like following:\n\n\nPlease notice that 'BASE_PATH' and 'ORG_ID' are automatically resolved.", + "heading": "Description" + } + ], + "signature": "static createScapiRemoteInclude(apiFamily: string, apiName: string, apiVersion: string, resourcePath: string, params?: URLParameter[]): RemoteInclude", + "source": "script-api", + "tags": [ + "createscapiremoteinclude", + "restresponsemgr.createscapiremoteinclude" + ], + "title": "RESTResponseMgr.createScapiRemoteInclude" + }, + { + "description": "Constructs a new RemoteInclude object specific for the Storefront Controller include path.", + "id": "script-api:dw/system/RESTResponseMgr#createStorefrontControllerRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "action", + "type": "URLAction" + }, + { + "name": "params", + "optional": true, + "type": "URLParameter[]" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude", + "returns": { + "type": "RemoteInclude" + }, + "sections": [ + { + "body": "Constructs a new RemoteInclude object specific for the Storefront Controller include path.", + "heading": "Description" + } + ], + "signature": "static createStorefrontControllerRemoteInclude(action: URLAction, params?: URLParameter[]): RemoteInclude", + "source": "script-api", + "tags": [ + "createstorefrontcontrollerremoteinclude", + "restresponsemgr.createstorefrontcontrollerremoteinclude" + ], + "title": "RESTResponseMgr.createStorefrontControllerRemoteInclude" + }, + { + "description": "Constructs a new RemoteInclude object specific for the Storefront Controller include path.", + "id": "script-api:dw/system/RESTResponseMgr#createStorefrontControllerRemoteInclude", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "action", + "type": "URLAction" + }, + { + "name": "params", + "optional": true, + "type": "URLParameter[]" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude", + "returns": { + "type": "RemoteInclude" + }, + "sections": [ + { + "body": "Constructs a new RemoteInclude object specific for the Storefront Controller include path.", + "heading": "Description" + } + ], + "signature": "static createStorefrontControllerRemoteInclude(action: URLAction, params?: URLParameter[]): RemoteInclude", + "source": "script-api", + "tags": [ + "createstorefrontcontrollerremoteinclude", + "restresponsemgr.createstorefrontcontrollerremoteinclude" + ], + "title": "RESTResponseMgr.createStorefrontControllerRemoteInclude" + }, + { + "description": "Constructs a new RESTSuccessResponse object.", + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "body", + "type": "Object" + }, + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object.", + "heading": "Description" + } + ], + "signature": "static createSuccess(body: Object, statusCode: number): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "throws": [ + { + "description": "If the statusCode is not in the (100..299) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "description": "Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.", + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "body", + "type": "Object" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.", + "heading": "Description" + } + ], + "signature": "static createSuccess(body: Object): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "description": "Constructs a new RESTSuccessResponse object.", + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "body", + "type": "Object" + }, + { + "name": "statusCode", + "type": "number" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object.", + "heading": "Description" + } + ], + "signature": "static createSuccess(body: Object, statusCode: number): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "throws": [ + { + "description": "If the statusCode is not in the (100..299) range.", + "type": "IllegalArgumentException" + } + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "description": "Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.", + "id": "script-api:dw/system/RESTResponseMgr#createSuccess", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "body", + "type": "Object" + } + ], + "parentId": "script-api:dw/system/RESTResponseMgr", + "qualifiedName": "dw.system.RESTResponseMgr.createSuccess", + "returns": { + "type": "RESTSuccessResponse" + }, + "sections": [ + { + "body": "Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.", + "heading": "Description" + } + ], + "signature": "static createSuccess(body: Object): RESTSuccessResponse", + "source": "script-api", + "tags": [ + "createsuccess", + "restresponsemgr.createsuccess" + ], + "title": "RESTResponseMgr.createSuccess" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTSuccessResponse", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RESTSuccessResponse", + "sections": [ + { + "body": "This class represents a REST success response that is compliant with the RFC standards. It can only be instantiated\nusing the `createSuccess` methods in RESTResponseMgr.\n\nHere is an example:\n\n`\nvar body = {\"hello\": \"world\"}\n\nvar success = RESTResponseMgr.createSuccess(body);\n\nsuccess.render();\n\n`\n\nThe above script would result in an HTTP response with status code 200 and the following body:\n\n`\n{\n\n \"hello\": \"world\"\n\n}\n\n`", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "restsuccessresponse", + "dw.system.restsuccessresponse", + "dw/system" + ], + "title": "RESTSuccessResponse" + }, + { + "description": "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.", + "id": "script-api:dw/system/RESTSuccessResponse#render", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RESTSuccessResponse", + "qualifiedName": "dw.system.RESTSuccessResponse.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends the RESTSuccessResponse object as an HTTP response to the client. This sets the \"Content-Type\"\nheader to \"application/json\" and expects the body to be a valid JavaScript JSON object.", + "heading": "Description" + } + ], + "signature": "render(): void", + "source": "script-api", + "tags": [ + "render", + "restsuccessresponse.render" + ], + "throws": [ + { + "description": "If the RESTSuccessResponse object is already rendered.", + "type": "IllegalStateException" + }, + { + "description": "If there is an error while serializing the body.", + "type": "Exception" + } + ], + "title": "RESTSuccessResponse.render" + }, + { + "description": "The class represents a remote include value that can be assigned to JSON Object properties.", + "examples": [ + "function specifyRemoteIncludeProperties() {\nvar includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"custom\", \"sample\", \"v1\", \"resource/path/0\", dw.web.URLParameter(\"siteId\", \"TestWapi\"));\nvar includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"custom\", \"sample\", \"v1\", \"resource/path/1\", dw.web.URLParameter(\"siteId\", \"TestWapi\"));\nvar greeting = { \"hello\": \"world\", \"includeProperty0\": includeValue0, \"includeProperty1\": includeValue1 };\n\ndw.system.RESTResponseMgr.createSuccess(greeting).render();\n}", + "function specifyArrayOfRemoteIncludes() {\nvar includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"custom\", \"sample\", \"v1\", \"resource/path/0\", dw.web.URLParameter(\"siteId\", \"TestWapi\"));\nvar includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude(\"custom\", \"sample\", \"v1\", \"resource/path/1\", dw.web.URLParameter(\"siteId\", \"TestWapi\"));\nvar greeting = { \"hello\": \"world\", \"includeArray\": [includeValue0, includeValue1] };\n\ndw.system.RESTResponseMgr.createSuccess(greeting).render();\n}", + "function storefrontRemoteInclude()\n{\nlet remoteInclude = dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude(new URLAction(\"Category-Show\", \"Sites-MyShop-Site\", dw.web.URLParameter(\"cid\", \"root\")));\nlet json = {\nstatus: \"JSONOK\",\ninclude: remoteInclude\n};\ndw.system.RESTResponseMgr.createSuccess(json).render();\n}" + ], + "id": "script-api:dw/system/RemoteInclude", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RemoteInclude", + "sections": [ + { + "body": "The class represents a remote include value that can be assigned to JSON Object properties.\n\nImportant notes:\n\n- Authentication and authorization checks are performed only for the top\nlevel request, but NOT for remote include requests.\n- The `RestResponseMgr` method `createScapiRemoteInclude()` allows only SCAPI URLs.\n- The `RestResponseMgr` method `createStorefrontControllerRemoteInclude()` allows only Controller URLs.\n- Correct rendering of RemoteInclude-containing objects is only performed\nwhen processed by `dw.system.RESTSuccessResponse.render()` method. Please check the provided examples.\n\nExample 1. Specify remote include properties.\n\n\nExample 2. Specify array of remote include properties.\n\n\nExample 3. Storefront controller remote include.\n\n\nError handling:\n\nSCAPI:\n\n- In case of 404 response received on included resource, an empty JSON object '{}' will be supplied in final JSON.\n- In case of 201..299, 3xx, 4xx (excluding 404), 5xx response from included resource, final response status will be 500 'Internal Server Error'\n\nControllers:\n\n- In case of any non 200 response from the included resource an empty string will be included.\n- Note: In case your response format is JSON be aware that this can result in invalid JSON.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "remoteinclude", + "dw.system.remoteinclude", + "dw/system" + ], + "title": "RemoteInclude" + }, + { + "description": "Returns the URL string value specified for the current instance.", + "id": "script-api:dw/system/RemoteInclude#getUrl", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.getUrl", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the URL string value specified for the current instance.", + "heading": "Description" + } + ], + "signature": "getUrl(): string", + "source": "script-api", + "tags": [ + "geturl", + "remoteinclude.geturl" + ], + "title": "RemoteInclude.getUrl" + }, + { + "description": "Returns the URL string value specified for the current instance, same as getUrl.", + "id": "script-api:dw/system/RemoteInclude#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the URL string value specified for the current instance, same as\ngetUrl.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "remoteinclude.tostring" + ], + "title": "RemoteInclude.toString" + }, + { + "description": "Returns the URL string value specified for the current instance.", + "id": "script-api:dw/system/RemoteInclude#url", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.url", + "sections": [ + { + "body": "Returns the URL string value specified for the current instance.", + "heading": "Description" + } + ], + "signature": "readonly url: string", + "source": "script-api", + "tags": [ + "url", + "remoteinclude.url" + ], + "title": "RemoteInclude.url" + }, + { + "description": "Returns the URL string value specified for the current instance, same as getUrl.", + "id": "script-api:dw/system/RemoteInclude#valueOf", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RemoteInclude", + "qualifiedName": "dw.system.RemoteInclude.valueOf", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the URL string value specified for the current instance, same as\ngetUrl.", + "heading": "Description" + } + ], + "signature": "valueOf(): any", + "source": "script-api", + "tags": [ + "valueof", + "remoteinclude.valueof" + ], + "title": "RemoteInclude.valueOf" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Request", + "sections": [ + { + "body": "Represents a request in Commerce Cloud Digital. Each pipeline dictionary contains a CurrentRequest object, which is of\ntype dw.system.Request. Most requests are HTTP requests, so you can use this object to get information about the HTTP\nrequest, such as the HTTP headers. You can also get a list of cookies, if any, associated with the request. If the\nrequest is issued from a job, the request is not an HTTP request, so HTTP-related methods return null.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "request", + "dw.system.request", + "dw/system" + ], + "title": "Request" + }, + { + "description": "Returns whether the request originated in SCAPI.", + "id": "script-api:dw/system/Request#SCAPI", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPI", + "sections": [ + { + "body": "Returns whether the request originated in SCAPI.", + "heading": "Description" + } + ], + "signature": "readonly SCAPI: boolean", + "source": "script-api", + "tags": [ + "scapi", + "request.scapi" + ], + "title": "Request.SCAPI" + }, + { + "description": "Returns a map containing all path parameters of current SCAPI request in the following way:", + "id": "script-api:dw/system/Request#SCAPIPathParameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPIPathParameters", + "sections": [ + { + "body": "Returns a map containing all path parameters of current SCAPI request in the following way:\n\n- keys: path parameter names from path pattern\n- values: corresponding path parameter values from current request\n\nReturns null if isSCAPI returns false i.e. if the request is not a SCAPI request.\n\nFor example:\n\n- Current request: `/product/shopper-products/v1/organizations/sfcc_org/products/apple-ipod-shuffle`\n- Path pattern: `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`\n- Result: dw.util.Map with 2 key:value pairs: `organizationId:sfcc_org` and `id:apple-ipod-shuffle`.", + "heading": "Description" + } + ], + "signature": "readonly SCAPIPathParameters: utilMap | null", + "source": "script-api", + "tags": [ + "scapipathparameters", + "request.scapipathparameters" + ], + "title": "Request.SCAPIPathParameters" + }, + { + "description": "Returns the SCAPI path pattern in the following way:", + "id": "script-api:dw/system/Request#SCAPIPathPattern", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.SCAPIPathPattern", + "sections": [ + { + "body": "Returns the SCAPI path pattern in the following way:\n\n- The first three segments `/api-family/api-name/version` with concrete values.\n- The /organizations part with the path parameter name `organizationId` in curly brackets.\n- The actual resource path additional path parameter names in curly brackets.\n\nReturns null if isSCAPI returns false i.e. if the request is not a SCAPI request.\n\nFor example, in the context of a request to get a single product from shopper-products API, this method would\nreturn `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`", + "heading": "Description" + } + ], + "signature": "readonly SCAPIPathPattern: string | null", + "source": "script-api", + "tags": [ + "scapipathpattern", + "request.scapipathpattern" + ], + "title": "Request.SCAPIPathPattern" + }, + { + "deprecated": { + "message": "Use dw.system.Response.addHttpCookie instead." + }, + "description": "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).", + "id": "script-api:dw/system/Request#addHttpCookie", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "cookie", + "type": "Cookie" + } + ], + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.addHttpCookie", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the specified cookie to the outgoing response. This method can be called multiple times to set more than one\ncookie. If a cookie with the same cookie name, domain and path is set multiple times for the same response, only\nthe last set cookie with this name is send to the client. This method can be used to set, update or delete\ncookies at the client. If the cookie doesn't exist at the client, it is set initially. If a cookie with the same\nname, domain and path already exists at the client, it is updated. A cookie can be deleted at the client by\nsubmitting a cookie with the maxAge attribute set to 0 (see `Cookie.setMaxAge()\n` for more information).", + "heading": "Description" + } + ], + "signature": "addHttpCookie(cookie: Cookie): void", + "source": "script-api", + "tags": [ + "addhttpcookie", + "request.addhttpcookie" + ], + "title": "Request.addHttpCookie" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#clientId", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.clientId", + "sections": [ + { + "body": "Returns the client id of the current SCAPI or OCAPI request. If the request is not a SCAPI request or not an\nOCAPI request 'null' is returned. For client ids owned by Commerce Cloud Digital an alias is returned.", + "heading": "Description" + } + ], + "signature": "readonly clientId: string | null", + "source": "script-api", + "tags": [ + "clientid", + "request.clientid" + ], + "title": "Request.clientId" + }, + { + "description": "Returns all of the custom attributes associated with the request. The attributes are stored for the life time of the request.", + "id": "script-api:dw/system/Request#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.custom", + "sections": [ + { + "body": "Returns all of the custom attributes associated with the request. The attributes are stored for the life time of\nthe request.", + "heading": "Description" + } + ], + "signature": "readonly custom: CustomAttributes", + "source": "script-api", + "tags": [ + "custom", + "request.custom" + ], + "title": "Request.custom" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#geolocation", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.geolocation", + "sections": [ + { + "body": "Returns the physical location for the current request, if available. The\nlocation is calculated based on the IP address of the request. Note, if\nthe geolocation tracking feature is not enabled, this method always\nreturns null.", + "heading": "Description" + } + ], + "signature": "geolocation: Geolocation | null", + "source": "script-api", + "tags": [ + "geolocation", + "request.geolocation" + ], + "title": "Request.geolocation" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getClientId", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getClientId", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the client id of the current SCAPI or OCAPI request. If the request is not a SCAPI request or not an\nOCAPI request 'null' is returned. For client ids owned by Commerce Cloud Digital an alias is returned.", + "heading": "Description" + } + ], + "signature": "getClientId(): string | null", + "source": "script-api", + "tags": [ + "getclientid", + "request.getclientid" + ], + "title": "Request.getClientId" + }, + { + "description": "Returns all of the custom attributes associated with the request. The attributes are stored for the life time of the request.", + "id": "script-api:dw/system/Request#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getCustom", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns all of the custom attributes associated with the request. The attributes are stored for the life time of\nthe request.", + "heading": "Description" + } + ], + "signature": "getCustom(): CustomAttributes", + "source": "script-api", + "tags": [ + "getcustom", + "request.getcustom" + ], + "title": "Request.getCustom" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getGeolocation", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getGeolocation", + "returns": { + "type": "Geolocation | null" + }, + "sections": [ + { + "body": "Returns the physical location for the current request, if available. The\nlocation is calculated based on the IP address of the request. Note, if\nthe geolocation tracking feature is not enabled, this method always\nreturns null.", + "heading": "Description" + } + ], + "signature": "getGeolocation(): Geolocation | null", + "source": "script-api", + "tags": [ + "getgeolocation", + "request.getgeolocation" + ], + "title": "Request.getGeolocation" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getHttpCookies", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpCookies", + "returns": { + "type": "Cookies | null" + }, + "sections": [ + { + "body": "Returns the Cookies object, which can be used to read cookies sent by the client. Use the method\n`Response.addHttpCookie()` to add a cookie to the outgoing response.", + "heading": "Description" + } + ], + "signature": "getHttpCookies(): Cookies | null", + "source": "script-api", + "tags": [ + "gethttpcookies", + "request.gethttpcookies" + ], + "title": "Request.getHttpCookies" + }, + { + "description": "Returns a Map containing all HTTP header values.", + "id": "script-api:dw/system/Request#getHttpHeaders", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpHeaders", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a Map containing all HTTP header values.", + "heading": "Description" + } + ], + "signature": "getHttpHeaders(): utilMap", + "source": "script-api", + "tags": [ + "gethttpheaders", + "request.gethttpheaders" + ], + "title": "Request.getHttpHeaders" + }, + { + "description": "Returns the host name or null if there is no host name.", + "id": "script-api:dw/system/Request#getHttpHost", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpHost", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the host name or null if there is no host name.", + "heading": "Description" + } + ], + "signature": "getHttpHost(): string | null", + "source": "script-api", + "tags": [ + "gethttphost", + "request.gethttphost" + ], + "title": "Request.getHttpHost" + }, + { + "description": "Returns the locale or null if there is no associated locale.", + "id": "script-api:dw/system/Request#getHttpLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpLocale", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the locale or null if there is no associated locale.", + "heading": "Description" + } + ], + "signature": "getHttpLocale(): string | null", + "source": "script-api", + "tags": [ + "gethttplocale", + "request.gethttplocale" + ], + "title": "Request.getHttpLocale" + }, + { + "description": "Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.", + "id": "script-api:dw/system/Request#getHttpMethod", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpMethod", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.", + "heading": "Description" + } + ], + "signature": "getHttpMethod(): string", + "source": "script-api", + "tags": [ + "gethttpmethod", + "request.gethttpmethod" + ], + "title": "Request.getHttpMethod" + }, + { + "description": "Returns the parameter map that contains the HTTP parameters for the current request.", + "id": "script-api:dw/system/Request#getHttpParameterMap", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpParameterMap", + "returns": { + "type": "HttpParameterMap" + }, + "sections": [ + { + "body": "Returns the parameter map that contains the HTTP parameters for the current request.", + "heading": "Description" + } + ], + "signature": "getHttpParameterMap(): HttpParameterMap", + "source": "script-api", + "tags": [ + "gethttpparametermap", + "request.gethttpparametermap" + ], + "title": "Request.getHttpParameterMap" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getHttpParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpParameters", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a Map containing the raw HTTP parameters sent to the server. The Map contains name/value pairs. Each name\nis a String and each value is a String array.", + "heading": "Description" + } + ], + "signature": "getHttpParameters(): utilMap", + "source": "script-api", + "tags": [ + "gethttpparameters", + "request.gethttpparameters" + ], + "title": "Request.getHttpParameters" + }, + { + "description": "Returns the path.", + "id": "script-api:dw/system/Request#getHttpPath", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpPath", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the path.", + "heading": "Description" + } + ], + "signature": "getHttpPath(): string | null", + "source": "script-api", + "tags": [ + "gethttppath", + "request.gethttppath" + ], + "title": "Request.getHttpPath" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getHttpProtocol", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpProtocol", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the HTTP protocol used for this request. Possible values are \"http\" or \"https\". If the current activity\nis not related to an HTTP request, for example, when the request is part of a job, this method returns null.", + "heading": "Description" + } + ], + "signature": "getHttpProtocol(): string | null", + "source": "script-api", + "tags": [ + "gethttpprotocol", + "request.gethttpprotocol" + ], + "title": "Request.getHttpProtocol" + }, + { + "description": "Returns the query string or null if there is no query string.", + "id": "script-api:dw/system/Request#getHttpQueryString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpQueryString", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the query string or null if there is no query string.", + "heading": "Description" + } + ], + "signature": "getHttpQueryString(): string | null", + "source": "script-api", + "tags": [ + "gethttpquerystring", + "request.gethttpquerystring" + ], + "title": "Request.getHttpQueryString" + }, + { + "description": "Returns the referer or null if there is no referer.", + "id": "script-api:dw/system/Request#getHttpReferer", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpReferer", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the referer or null if there is no referer.", + "heading": "Description" + } + ], + "signature": "getHttpReferer(): string | null", + "source": "script-api", + "tags": [ + "gethttpreferer", + "request.gethttpreferer" + ], + "title": "Request.getHttpReferer" + }, + { + "description": "Returns the remote address or null if no remote address is found.", + "id": "script-api:dw/system/Request#getHttpRemoteAddress", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpRemoteAddress", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the remote address or null if no remote address is found.", + "heading": "Description" + } + ], + "signature": "getHttpRemoteAddress(): string | null", + "source": "script-api", + "tags": [ + "gethttpremoteaddress", + "request.gethttpremoteaddress" + ], + "title": "Request.getHttpRemoteAddress" + }, + { + "description": "Returns the complete URL of the request which was received at the server. This URL does not include SEO optimizations.", + "id": "script-api:dw/system/Request#getHttpURL", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpURL", + "returns": { + "type": "URL" + }, + "sections": [ + { + "body": "Returns the complete URL of the request which was received at the server.\nThis URL does not include SEO optimizations.", + "heading": "Description" + } + ], + "signature": "getHttpURL(): URL", + "source": "script-api", + "tags": [ + "gethttpurl", + "request.gethttpurl" + ], + "title": "Request.getHttpURL" + }, + { + "description": "Returns the HTTP user agent or null if there is no user agent.", + "id": "script-api:dw/system/Request#getHttpUserAgent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getHttpUserAgent", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the HTTP user agent or null if there is no user agent.", + "heading": "Description" + } + ], + "signature": "getHttpUserAgent(): string | null", + "source": "script-api", + "tags": [ + "gethttpuseragent", + "request.gethttpuseragent" + ], + "title": "Request.getHttpUserAgent" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getLocale", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the locale of the current request. This locale is set by the system based on the information in the URL.\nIt may be different from the locale returned by getHttpLocale, which is the preferred locale sent by the user agent.", + "heading": "Description" + } + ], + "signature": "getLocale(): string", + "source": "script-api", + "tags": [ + "getlocale", + "request.getlocale" + ], + "title": "Request.getLocale" + }, + { + "description": "Returns the OCAPI version of the current request. If this is not an OCAPI request, 'null' is returned.", + "id": "script-api:dw/system/Request#getOcapiVersion", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getOcapiVersion", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the OCAPI version of the current request. If this is not\nan OCAPI request, 'null' is returned.", + "heading": "Description" + } + ], + "signature": "getOcapiVersion(): string", + "source": "script-api", + "tags": [ + "getocapiversion", + "request.getocapiversion" + ], + "title": "Request.getOcapiVersion" + }, + { + "description": "Returns the page meta data that are associated with the current request.", + "id": "script-api:dw/system/Request#getPageMetaData", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getPageMetaData", + "returns": { + "type": "PageMetaData" + }, + "sections": [ + { + "body": "Returns the page meta data that are associated with the current request.", + "heading": "Description" + } + ], + "signature": "getPageMetaData(): PageMetaData", + "source": "script-api", + "tags": [ + "getpagemetadata", + "request.getpagemetadata" + ], + "title": "Request.getPageMetaData" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#getRequestID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getRequestID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique identifier of the current request. The unique id is helpful for debugging purpose, e.g. relate\ndebug messages to a particular request.", + "heading": "Description" + } + ], + "signature": "getRequestID(): string", + "source": "script-api", + "tags": [ + "getrequestid", + "request.getrequestid" + ], + "title": "Request.getRequestID" + }, + { + "description": "Returns a map containing all path parameters of current SCAPI request in the following way:", + "id": "script-api:dw/system/Request#getSCAPIPathParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSCAPIPathParameters", + "returns": { + "type": "utilMap | null" + }, + "sections": [ + { + "body": "Returns a map containing all path parameters of current SCAPI request in the following way:\n\n- keys: path parameter names from path pattern\n- values: corresponding path parameter values from current request\n\nReturns null if isSCAPI returns false i.e. if the request is not a SCAPI request.\n\nFor example:\n\n- Current request: `/product/shopper-products/v1/organizations/sfcc_org/products/apple-ipod-shuffle`\n- Path pattern: `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`\n- Result: dw.util.Map with 2 key:value pairs: `organizationId:sfcc_org` and `id:apple-ipod-shuffle`.", + "heading": "Description" + } + ], + "signature": "getSCAPIPathParameters(): utilMap | null", + "source": "script-api", + "tags": [ + "getscapipathparameters", + "request.getscapipathparameters" + ], + "title": "Request.getSCAPIPathParameters" + }, + { + "description": "Returns the SCAPI path pattern in the following way:", + "id": "script-api:dw/system/Request#getSCAPIPathPattern", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSCAPIPathPattern", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Returns the SCAPI path pattern in the following way:\n\n- The first three segments `/api-family/api-name/version` with concrete values.\n- The /organizations part with the path parameter name `organizationId` in curly brackets.\n- The actual resource path additional path parameter names in curly brackets.\n\nReturns null if isSCAPI returns false i.e. if the request is not a SCAPI request.\n\nFor example, in the context of a request to get a single product from shopper-products API, this method would\nreturn `/product/shopper-products/v1/organizations/{organizationId}/products/{id}`", + "heading": "Description" + } + ], + "signature": "getSCAPIPathPattern(): string | null", + "source": "script-api", + "tags": [ + "getscapipathpattern", + "request.getscapipathpattern" + ], + "title": "Request.getSCAPIPathPattern" + }, + { + "description": "Returns the session associated with this request.", + "id": "script-api:dw/system/Request#getSession", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getSession", + "returns": { + "type": "Session" + }, + "sections": [ + { + "body": "Returns the session associated with this request.", + "heading": "Description" + } + ], + "signature": "getSession(): Session", + "source": "script-api", + "tags": [ + "getsession", + "request.getsession" + ], + "title": "Request.getSession" + }, + { + "description": "Returns the form that was submitted by the client if the request represents a form submission.", + "id": "script-api:dw/system/Request#getTriggeredForm", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getTriggeredForm", + "returns": { + "type": "Form" + }, + "sections": [ + { + "body": "Returns the form that was submitted by the client if the request represents a form submission.", + "heading": "Description" + } + ], + "signature": "getTriggeredForm(): Form", + "source": "script-api", + "tags": [ + "gettriggeredform", + "request.gettriggeredform" + ], + "title": "Request.getTriggeredForm" + }, + { + "description": "Returns the form action that was triggered by the client if the request represents a form submission.", + "id": "script-api:dw/system/Request#getTriggeredFormAction", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.getTriggeredFormAction", + "returns": { + "type": "FormAction" + }, + "sections": [ + { + "body": "Returns the form action that was triggered by the client if the request represents a form submission.", + "heading": "Description" + } + ], + "signature": "getTriggeredFormAction(): FormAction", + "source": "script-api", + "tags": [ + "gettriggeredformaction", + "request.gettriggeredformaction" + ], + "title": "Request.getTriggeredFormAction" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#httpCookies", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpCookies", + "sections": [ + { + "body": "Returns the Cookies object, which can be used to read cookies sent by the client. Use the method\n`Response.addHttpCookie()` to add a cookie to the outgoing response.", + "heading": "Description" + } + ], + "signature": "readonly httpCookies: Cookies | null", + "source": "script-api", + "tags": [ + "httpcookies", + "request.httpcookies" + ], + "title": "Request.httpCookies" + }, + { + "description": "Returns a Map containing all HTTP header values.", + "id": "script-api:dw/system/Request#httpHeaders", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpHeaders", + "sections": [ + { + "body": "Returns a Map containing all HTTP header values.", + "heading": "Description" + } + ], + "signature": "readonly httpHeaders: utilMap", + "source": "script-api", + "tags": [ + "httpheaders", + "request.httpheaders" + ], + "title": "Request.httpHeaders" + }, + { + "description": "Returns the host name or null if there is no host name.", + "id": "script-api:dw/system/Request#httpHost", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpHost", + "sections": [ + { + "body": "Returns the host name or null if there is no host name.", + "heading": "Description" + } + ], + "signature": "readonly httpHost: string | null", + "source": "script-api", + "tags": [ + "httphost", + "request.httphost" + ], + "title": "Request.httpHost" + }, + { + "description": "Returns the locale or null if there is no associated locale.", + "id": "script-api:dw/system/Request#httpLocale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpLocale", + "sections": [ + { + "body": "Returns the locale or null if there is no associated locale.", + "heading": "Description" + } + ], + "signature": "readonly httpLocale: string | null", + "source": "script-api", + "tags": [ + "httplocale", + "request.httplocale" + ], + "title": "Request.httpLocale" + }, + { + "description": "Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.", + "id": "script-api:dw/system/Request#httpMethod", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpMethod", + "sections": [ + { + "body": "Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.", + "heading": "Description" + } + ], + "signature": "readonly httpMethod: string", + "source": "script-api", + "tags": [ + "httpmethod", + "request.httpmethod" + ], + "title": "Request.httpMethod" + }, + { + "description": "Returns the parameter map that contains the HTTP parameters for the current request.", + "id": "script-api:dw/system/Request#httpParameterMap", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpParameterMap", + "sections": [ + { + "body": "Returns the parameter map that contains the HTTP parameters for the current request.", + "heading": "Description" + } + ], + "signature": "readonly httpParameterMap: HttpParameterMap", + "source": "script-api", + "tags": [ + "httpparametermap", + "request.httpparametermap" + ], + "title": "Request.httpParameterMap" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#httpParameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpParameters", + "sections": [ + { + "body": "Returns a Map containing the raw HTTP parameters sent to the server. The Map contains name/value pairs. Each name\nis a String and each value is a String array.", + "heading": "Description" + } + ], + "signature": "readonly httpParameters: utilMap", + "source": "script-api", + "tags": [ + "httpparameters", + "request.httpparameters" + ], + "title": "Request.httpParameters" + }, + { + "description": "Returns the path.", + "id": "script-api:dw/system/Request#httpPath", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpPath", + "sections": [ + { + "body": "Returns the path.", + "heading": "Description" + } + ], + "signature": "readonly httpPath: string | null", + "source": "script-api", + "tags": [ + "httppath", + "request.httppath" + ], + "title": "Request.httpPath" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#httpProtocol", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpProtocol", + "sections": [ + { + "body": "Returns the HTTP protocol used for this request. Possible values are \"http\" or \"https\". If the current activity\nis not related to an HTTP request, for example, when the request is part of a job, this method returns null.", + "heading": "Description" + } + ], + "signature": "readonly httpProtocol: string | null", + "source": "script-api", + "tags": [ + "httpprotocol", + "request.httpprotocol" + ], + "title": "Request.httpProtocol" + }, + { + "description": "Returns the query string or null if there is no query string.", + "id": "script-api:dw/system/Request#httpQueryString", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpQueryString", + "sections": [ + { + "body": "Returns the query string or null if there is no query string.", + "heading": "Description" + } + ], + "signature": "readonly httpQueryString: string | null", + "source": "script-api", + "tags": [ + "httpquerystring", + "request.httpquerystring" + ], + "title": "Request.httpQueryString" + }, + { + "description": "Returns the referer or null if there is no referer.", + "id": "script-api:dw/system/Request#httpReferer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpReferer", + "sections": [ + { + "body": "Returns the referer or null if there is no referer.", + "heading": "Description" + } + ], + "signature": "readonly httpReferer: string | null", + "source": "script-api", + "tags": [ + "httpreferer", + "request.httpreferer" + ], + "title": "Request.httpReferer" + }, + { + "description": "Returns the remote address or null if no remote address is found.", + "id": "script-api:dw/system/Request#httpRemoteAddress", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpRemoteAddress", + "sections": [ + { + "body": "Returns the remote address or null if no remote address is found.", + "heading": "Description" + } + ], + "signature": "readonly httpRemoteAddress: string | null", + "source": "script-api", + "tags": [ + "httpremoteaddress", + "request.httpremoteaddress" + ], + "title": "Request.httpRemoteAddress" + }, + { + "deprecated": { + "message": "Effectively always returns true." + }, + "description": "Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a HTTP request.", + "id": "script-api:dw/system/Request#httpRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpRequest", + "sections": [ + { + "body": "Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a\nHTTP request.", + "heading": "Description" + } + ], + "signature": "readonly httpRequest: boolean", + "source": "script-api", + "tags": [ + "httprequest", + "request.httprequest" + ], + "title": "Request.httpRequest" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#httpSecure", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpSecure", + "sections": [ + { + "body": "Returns whether the HTTP communication is secure, which basically means that the communication happens via https.\nIf the current activity is not related to an HTTP request the method returns false.", + "heading": "Description" + } + ], + "signature": "readonly httpSecure: boolean", + "source": "script-api", + "tags": [ + "httpsecure", + "request.httpsecure" + ], + "title": "Request.httpSecure" + }, + { + "description": "Returns the complete URL of the request which was received at the server. This URL does not include SEO optimizations.", + "id": "script-api:dw/system/Request#httpURL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpURL", + "sections": [ + { + "body": "Returns the complete URL of the request which was received at the server.\nThis URL does not include SEO optimizations.", + "heading": "Description" + } + ], + "signature": "readonly httpURL: URL", + "source": "script-api", + "tags": [ + "httpurl", + "request.httpurl" + ], + "title": "Request.httpURL" + }, + { + "description": "Returns the HTTP user agent or null if there is no user agent.", + "id": "script-api:dw/system/Request#httpUserAgent", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.httpUserAgent", + "sections": [ + { + "body": "Returns the HTTP user agent or null if there is no user agent.", + "heading": "Description" + } + ], + "signature": "readonly httpUserAgent: string | null", + "source": "script-api", + "tags": [ + "httpuseragent", + "request.httpuseragent" + ], + "title": "Request.httpUserAgent" + }, + { + "description": "Returns true if the request represents a request for a remote include, false if it is a top-level request.", + "id": "script-api:dw/system/Request#includeRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.includeRequest", + "sections": [ + { + "body": "Returns true if the request represents a request for a remote include, false if it is a top-level request.", + "heading": "Description" + } + ], + "signature": "readonly includeRequest: boolean", + "source": "script-api", + "tags": [ + "includerequest", + "request.includerequest" + ], + "title": "Request.includeRequest" + }, + { + "deprecated": { + "message": "Effectively always returns true." + }, + "description": "Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a HTTP request.", + "id": "script-api:dw/system/Request#isHttpRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isHttpRequest", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this request is an HTTP request. The method returns true, if the current processing is related to a\nHTTP request.", + "heading": "Description" + } + ], + "signature": "isHttpRequest(): boolean", + "source": "script-api", + "tags": [ + "ishttprequest", + "request.ishttprequest" + ], + "title": "Request.isHttpRequest" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#isHttpSecure", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isHttpSecure", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the HTTP communication is secure, which basically means that the communication happens via https.\nIf the current activity is not related to an HTTP request the method returns false.", + "heading": "Description" + } + ], + "signature": "isHttpSecure(): boolean", + "source": "script-api", + "tags": [ + "ishttpsecure", + "request.ishttpsecure" + ], + "title": "Request.isHttpSecure" + }, + { + "description": "Returns true if the request represents a request for a remote include, false if it is a top-level request.", + "id": "script-api:dw/system/Request#isIncludeRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isIncludeRequest", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the request represents a request for a remote include, false if it is a top-level request.", + "heading": "Description" + } + ], + "signature": "isIncludeRequest(): boolean", + "source": "script-api", + "tags": [ + "isincluderequest", + "request.isincluderequest" + ], + "title": "Request.isIncludeRequest" + }, + { + "description": "Returns whether the request originated in SCAPI.", + "id": "script-api:dw/system/Request#isSCAPI", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.isSCAPI", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the request originated in SCAPI.", + "heading": "Description" + } + ], + "signature": "isSCAPI(): boolean", + "source": "script-api", + "tags": [ + "isscapi", + "request.isscapi" + ], + "title": "Request.isSCAPI" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#locale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.locale", + "sections": [ + { + "body": "Returns the locale of the current request. This locale is set by the system based on the information in the URL.\nIt may be different from the locale returned by getHttpLocale, which is the preferred locale sent by the user agent.", + "heading": "Description" + } + ], + "signature": "locale: string", + "source": "script-api", + "tags": [ + "locale", + "request.locale" + ], + "title": "Request.locale" + }, + { + "description": "Returns the OCAPI version of the current request. If this is not an OCAPI request, 'null' is returned.", + "id": "script-api:dw/system/Request#ocapiVersion", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.ocapiVersion", + "sections": [ + { + "body": "Returns the OCAPI version of the current request. If this is not\nan OCAPI request, 'null' is returned.", + "heading": "Description" + } + ], + "signature": "readonly ocapiVersion: string", + "source": "script-api", + "tags": [ + "ocapiversion", + "request.ocapiversion" + ], + "title": "Request.ocapiVersion" + }, + { + "description": "Returns the page meta data that are associated with the current request.", + "id": "script-api:dw/system/Request#pageMetaData", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.pageMetaData", + "sections": [ + { + "body": "Returns the page meta data that are associated with the current request.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaData: PageMetaData", + "source": "script-api", + "tags": [ + "pagemetadata", + "request.pagemetadata" + ], + "title": "Request.pageMetaData" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#requestID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.requestID", + "sections": [ + { + "body": "Returns the unique identifier of the current request. The unique id is helpful for debugging purpose, e.g. relate\ndebug messages to a particular request.", + "heading": "Description" + } + ], + "signature": "readonly requestID: string", + "source": "script-api", + "tags": [ + "requestid", + "request.requestid" + ], + "title": "Request.requestID" + }, + { + "description": "Returns the session associated with this request.", + "id": "script-api:dw/system/Request#session", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.session", + "sections": [ + { + "body": "Returns the session associated with this request.", + "heading": "Description" + } + ], + "signature": "readonly session: Session", + "source": "script-api", + "tags": [ + "session", + "request.session" + ], + "title": "Request.session" + }, + { + "description": "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", + "id": "script-api:dw/system/Request#setGeolocation", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "geoLocation", + "type": "Geolocation" + } + ], + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.setGeolocation", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the physical location for the current request and remembers the new\nvalue for the duration of the user session. So any subsequent calls to\ndw.system.Request.getGeolocation will return this value", + "heading": "Description" + } + ], + "signature": "setGeolocation(geoLocation: Geolocation): void", + "source": "script-api", + "tags": [ + "setgeolocation", + "request.setgeolocation" + ], + "title": "Request.setGeolocation" + }, + { + "description": "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.", + "id": "script-api:dw/system/Request#setLocale", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "localeID", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.setLocale", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Sets the given locale for the request. The locale is only set if it is valid, if it is active and if it is\nallowed for the current site.", + "heading": "Description" + } + ], + "signature": "setLocale(localeID: string): boolean", + "source": "script-api", + "tags": [ + "setlocale", + "request.setlocale" + ], + "title": "Request.setLocale" + }, + { + "description": "Returns the form that was submitted by the client if the request represents a form submission.", + "id": "script-api:dw/system/Request#triggeredForm", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.triggeredForm", + "sections": [ + { + "body": "Returns the form that was submitted by the client if the request represents a form submission.", + "heading": "Description" + } + ], + "signature": "readonly triggeredForm: Form", + "source": "script-api", + "tags": [ + "triggeredform", + "request.triggeredform" + ], + "title": "Request.triggeredForm" + }, + { + "description": "Returns the form action that was triggered by the client if the request represents a form submission.", + "id": "script-api:dw/system/Request#triggeredFormAction", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Request", + "qualifiedName": "dw.system.Request.triggeredFormAction", + "sections": [ + { + "body": "Returns the form action that was triggered by the client if the request represents a form submission.", + "heading": "Description" + } + ], + "signature": "readonly triggeredFormAction: FormAction", + "source": "script-api", + "tags": [ + "triggeredformaction", + "request.triggeredformaction" + ], + "title": "Request.triggeredFormAction" + }, + { + "description": "This class represents all script hooks that can be registered to receive notifications about storefront requests. 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.", + "examples": [ + "\"hooks\": \"./hooks.json\"", + "\"hooks\": [\n{\"name\": \"dw.system.request.onSession\", \"script\": \"./script.js\"},\n{\"name\": \"dw.system.request.onRequest\", \"script\": \"./script.js\"},\n]" + ], + "id": "script-api:dw/system/RequestHooks", + "kind": "interface", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.RequestHooks", + "sections": [ + { + "body": "This class represents all script hooks that can be registered to receive notifications about storefront requests.\nIt contains the extension points (hook names), and the functions that are called by each extension point.\nA function must be defined inside a JavaScript source and must be exported.\nThe script with the exported hook function must be located inside a site cartridge.\nInside the site cartridge a 'package.json' file with a 'hooks' entry must exist.\n\n\nThe hooks entry links to a json file, relative to the 'package.json' file.\nThis file lists all registered hooks inside the hooks property:\n\n\nA hook entry has a 'name' and a 'script' property.\n\n- The 'name' contains the extension point, the hook name.\n- The 'script' contains the script relative to the hooks file, with the exported hook function.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "requesthooks", + "dw.system.requesthooks", + "dw/system" + ], + "title": "RequestHooks" + }, + { + "description": "The extension point name extensionPointOnRequest.", + "id": "script-api:dw/system/RequestHooks#extensionPointOnRequest", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.extensionPointOnRequest", + "sections": [ + { + "body": "The extension point name extensionPointOnRequest.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointOnRequest: \"dw.system.request.onRequest\"", + "source": "script-api", + "tags": [ + "extensionpointonrequest", + "requesthooks.extensionpointonrequest" + ], + "title": "RequestHooks.extensionPointOnRequest" + }, + { + "description": "The extension point name extensionPointOnSession.", + "id": "script-api:dw/system/RequestHooks#extensionPointOnSession", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.extensionPointOnSession", + "sections": [ + { + "body": "The extension point name extensionPointOnSession.", + "heading": "Description" + } + ], + "signature": "readonly extensionPointOnSession: \"dw.system.request.onSession\"", + "source": "script-api", + "tags": [ + "extensionpointonsession", + "requesthooks.extensionpointonsession" + ], + "title": "RequestHooks.extensionPointOnSession" + }, + { + "description": "The function is called by extension point extensionPointOnRequest. It is called when a storefront request was received from the client.", + "id": "script-api:dw/system/RequestHooks#onRequest", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.onRequest", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointOnRequest.\nIt is called when a storefront request was received from the client.", + "heading": "Description" + } + ], + "signature": "onRequest(): Status", + "source": "script-api", + "tags": [ + "onrequest", + "requesthooks.onrequest" + ], + "title": "RequestHooks.onRequest" + }, + { + "description": "The function is called by extension point extensionPointOnSession. It is called when a new storefront session was started.", + "id": "script-api:dw/system/RequestHooks#onSession", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/RequestHooks", + "qualifiedName": "dw.system.RequestHooks.onSession", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "The function is called by extension point extensionPointOnSession.\nIt is called when a new storefront session was started.", + "heading": "Description" + } + ], + "signature": "onSession(): Status", + "source": "script-api", + "tags": [ + "onsession", + "requesthooks.onsession" + ], + "title": "RequestHooks.onSession" + }, + { + "description": "Represents an HTTP response in Commerce Cloud Digital. An instance of this class is implicitly available within Digital script under the variable \"response\". The Response object can be used to set cookies and specific HTTP headers, for directly accessing the output stream or for sending redirects.", + "id": "script-api:dw/system/Response", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Response", + "sections": [ + { + "body": "Represents an HTTP response in Commerce Cloud Digital. An instance of this class is implicitly available within\nDigital script under the variable \"response\". The Response object can be used to set cookies and specific HTTP\nheaders, for directly accessing the output stream or for sending redirects.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "response", + "dw.system.response", + "dw/system" + ], + "title": "Response" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Credentials", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_CREDENTIALS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_CREDENTIALS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Credentials", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_CREDENTIALS = \"Access-Control-Allow-Credentials\"", + "source": "script-api", + "tags": [ + "access_control_allow_credentials", + "response.access_control_allow_credentials" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_CREDENTIALS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Credentials", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_CREDENTIALS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_CREDENTIALS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Credentials", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_CREDENTIALS = \"Access-Control-Allow-Credentials\"", + "source": "script-api", + "tags": [ + "access_control_allow_credentials", + "response.access_control_allow_credentials" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_CREDENTIALS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Headers", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_HEADERS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Headers", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_HEADERS = \"Access-Control-Allow-Headers\"", + "source": "script-api", + "tags": [ + "access_control_allow_headers", + "response.access_control_allow_headers" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_HEADERS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Headers", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_HEADERS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Headers", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_HEADERS = \"Access-Control-Allow-Headers\"", + "source": "script-api", + "tags": [ + "access_control_allow_headers", + "response.access_control_allow_headers" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_HEADERS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Methods", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_METHODS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_METHODS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Methods", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_METHODS = \"Access-Control-Allow-Methods\"", + "source": "script-api", + "tags": [ + "access_control_allow_methods", + "response.access_control_allow_methods" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_METHODS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Methods", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_METHODS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_METHODS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Methods", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_METHODS = \"Access-Control-Allow-Methods\"", + "source": "script-api", + "tags": [ + "access_control_allow_methods", + "response.access_control_allow_methods" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_METHODS" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Origin", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_ORIGIN", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_ORIGIN", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Origin", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_ORIGIN = \"Access-Control-Allow-Origin\"", + "source": "script-api", + "tags": [ + "access_control_allow_origin", + "response.access_control_allow_origin" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_ORIGIN" + }, + { + "description": "An allowed header name constant for Access-Control-Allow-Origin", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_ALLOW_ORIGIN", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_ALLOW_ORIGIN", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Allow-Origin", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_ALLOW_ORIGIN = \"Access-Control-Allow-Origin\"", + "source": "script-api", + "tags": [ + "access_control_allow_origin", + "response.access_control_allow_origin" + ], + "title": "Response.ACCESS_CONTROL_ALLOW_ORIGIN" + }, + { + "description": "An allowed header name constant for Access-Control-Expose-Headers", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_EXPOSE_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_EXPOSE_HEADERS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Expose-Headers", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_EXPOSE_HEADERS = \"Access-Control-Expose-Headers\"", + "source": "script-api", + "tags": [ + "access_control_expose_headers", + "response.access_control_expose_headers" + ], + "title": "Response.ACCESS_CONTROL_EXPOSE_HEADERS" + }, + { + "description": "An allowed header name constant for Access-Control-Expose-Headers", + "id": "script-api:dw/system/Response#ACCESS_CONTROL_EXPOSE_HEADERS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ACCESS_CONTROL_EXPOSE_HEADERS", + "sections": [ + { + "body": "An allowed header name constant for Access-Control-Expose-Headers", + "heading": "Description" + } + ], + "signature": "static readonly ACCESS_CONTROL_EXPOSE_HEADERS = \"Access-Control-Expose-Headers\"", + "source": "script-api", + "tags": [ + "access_control_expose_headers", + "response.access_control_expose_headers" + ], + "title": "Response.ACCESS_CONTROL_EXPOSE_HEADERS" + }, + { + "description": "An allowed header name constant for Allow", + "id": "script-api:dw/system/Response#ALLOW", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ALLOW", + "sections": [ + { + "body": "An allowed header name constant for Allow", + "heading": "Description" + } + ], + "signature": "static readonly ALLOW = \"Allow\"", + "source": "script-api", + "tags": [ + "allow", + "response.allow" + ], + "title": "Response.ALLOW" + }, + { + "description": "An allowed header name constant for Allow", + "id": "script-api:dw/system/Response#ALLOW", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.ALLOW", + "sections": [ + { + "body": "An allowed header name constant for Allow", + "heading": "Description" + } + ], + "signature": "static readonly ALLOW = \"Allow\"", + "source": "script-api", + "tags": [ + "allow", + "response.allow" + ], + "title": "Response.ALLOW" + }, + { + "description": "An allowed header name constant for Content-Disposition", + "id": "script-api:dw/system/Response#CONTENT_DISPOSITION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_DISPOSITION", + "sections": [ + { + "body": "An allowed header name constant for Content-Disposition", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_DISPOSITION = \"Content-Disposition\"", + "source": "script-api", + "tags": [ + "content_disposition", + "response.content_disposition" + ], + "title": "Response.CONTENT_DISPOSITION" + }, + { + "description": "An allowed header name constant for Content-Disposition", + "id": "script-api:dw/system/Response#CONTENT_DISPOSITION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_DISPOSITION", + "sections": [ + { + "body": "An allowed header name constant for Content-Disposition", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_DISPOSITION = \"Content-Disposition\"", + "source": "script-api", + "tags": [ + "content_disposition", + "response.content_disposition" + ], + "title": "Response.CONTENT_DISPOSITION" + }, + { + "description": "An allowed header name constant for Content-Language", + "id": "script-api:dw/system/Response#CONTENT_LANGUAGE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LANGUAGE", + "sections": [ + { + "body": "An allowed header name constant for Content-Language", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_LANGUAGE = \"Content-Language\"", + "source": "script-api", + "tags": [ + "content_language", + "response.content_language" + ], + "title": "Response.CONTENT_LANGUAGE" + }, + { + "description": "An allowed header name constant for Content-Language", + "id": "script-api:dw/system/Response#CONTENT_LANGUAGE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LANGUAGE", + "sections": [ + { + "body": "An allowed header name constant for Content-Language", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_LANGUAGE = \"Content-Language\"", + "source": "script-api", + "tags": [ + "content_language", + "response.content_language" + ], + "title": "Response.CONTENT_LANGUAGE" + }, + { + "description": "An allowed header name constant for Content-Location", + "id": "script-api:dw/system/Response#CONTENT_LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LOCATION", + "sections": [ + { + "body": "An allowed header name constant for Content-Location", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_LOCATION = \"Content-Location\"", + "source": "script-api", + "tags": [ + "content_location", + "response.content_location" + ], + "title": "Response.CONTENT_LOCATION" + }, + { + "description": "An allowed header name constant for Content-Location", + "id": "script-api:dw/system/Response#CONTENT_LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_LOCATION", + "sections": [ + { + "body": "An allowed header name constant for Content-Location", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_LOCATION = \"Content-Location\"", + "source": "script-api", + "tags": [ + "content_location", + "response.content_location" + ], + "title": "Response.CONTENT_LOCATION" + }, + { + "description": "An allowed header name constant for Content-MD5", + "id": "script-api:dw/system/Response#CONTENT_MD5", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_MD5", + "sections": [ + { + "body": "An allowed header name constant for Content-MD5", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_MD5 = \"Content-MD5\"", + "source": "script-api", + "tags": [ + "content_md5", + "response.content_md5" + ], + "title": "Response.CONTENT_MD5" + }, + { + "description": "An allowed header name constant for Content-MD5", + "id": "script-api:dw/system/Response#CONTENT_MD5", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_MD5", + "sections": [ + { + "body": "An allowed header name constant for Content-MD5", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_MD5 = \"Content-MD5\"", + "source": "script-api", + "tags": [ + "content_md5", + "response.content_md5" + ], + "title": "Response.CONTENT_MD5" + }, + { + "description": "An allowed header name constant for Content-Security-Policy.", + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Content-Security-Policy.\n\nNote: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_SECURITY_POLICY = \"Content-Security-Policy\"", + "source": "script-api", + "tags": [ + "content_security_policy", + "response.content_security_policy" + ], + "title": "Response.CONTENT_SECURITY_POLICY" + }, + { + "description": "An allowed header name constant for Content-Security-Policy.", + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Content-Security-Policy.\n\nNote: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_SECURITY_POLICY = \"Content-Security-Policy\"", + "source": "script-api", + "tags": [ + "content_security_policy", + "response.content_security_policy" + ], + "title": "Response.CONTENT_SECURITY_POLICY" + }, + { + "description": "An allowed header name constant for Content-Security-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Content-Security-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_SECURITY_POLICY_REPORT_ONLY = \"Content-Security-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "content_security_policy_report_only", + "response.content_security_policy_report_only" + ], + "title": "Response.CONTENT_SECURITY_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Content-Security-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CONTENT_SECURITY_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_SECURITY_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Content-Security-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_SECURITY_POLICY_REPORT_ONLY = \"Content-Security-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "content_security_policy_report_only", + "response.content_security_policy_report_only" + ], + "title": "Response.CONTENT_SECURITY_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Content-Type", + "id": "script-api:dw/system/Response#CONTENT_TYPE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_TYPE", + "sections": [ + { + "body": "An allowed header name constant for Content-Type", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_TYPE = \"Content-Type\"", + "source": "script-api", + "tags": [ + "content_type", + "response.content_type" + ], + "title": "Response.CONTENT_TYPE" + }, + { + "description": "An allowed header name constant for Content-Type", + "id": "script-api:dw/system/Response#CONTENT_TYPE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CONTENT_TYPE", + "sections": [ + { + "body": "An allowed header name constant for Content-Type", + "heading": "Description" + } + ], + "signature": "static readonly CONTENT_TYPE = \"Content-Type\"", + "source": "script-api", + "tags": [ + "content_type", + "response.content_type" + ], + "title": "Response.CONTENT_TYPE" + }, + { + "description": "An allowed header name constant for Cross-Origin-Embedder-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Embedder-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_EMBEDDER_POLICY = \"Cross-Origin-Embedder-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_embedder_policy", + "response.cross_origin_embedder_policy" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Embedder-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Embedder-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_EMBEDDER_POLICY = \"Cross-Origin-Embedder-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_embedder_policy", + "response.cross_origin_embedder_policy" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Embedder-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Embedder-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY = \"Cross-Origin-Embedder-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "cross_origin_embedder_policy_report_only", + "response.cross_origin_embedder_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Embedder-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Embedder-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY = \"Cross-Origin-Embedder-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "cross_origin_embedder_policy_report_only", + "response.cross_origin_embedder_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Opener-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Opener-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_OPENER_POLICY = \"Cross-Origin-Opener-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_opener_policy", + "response.cross_origin_opener_policy" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Opener-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Opener-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_OPENER_POLICY = \"Cross-Origin-Opener-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_opener_policy", + "response.cross_origin_opener_policy" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Opener-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Opener-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY = \"Cross-Origin-Opener-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "cross_origin_opener_policy_report_only", + "response.cross_origin_opener_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Opener-Policy-Report-Only.", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Opener-Policy-Report-Only.\n\nYou can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY = \"Cross-Origin-Opener-Policy-Report-Only\"", + "source": "script-api", + "tags": [ + "cross_origin_opener_policy_report_only", + "response.cross_origin_opener_policy_report_only" + ], + "title": "Response.CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Resource-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_RESOURCE_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_RESOURCE_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Resource-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_RESOURCE_POLICY = \"Cross-Origin-Resource-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_resource_policy", + "response.cross_origin_resource_policy" + ], + "title": "Response.CROSS_ORIGIN_RESOURCE_POLICY" + }, + { + "description": "An allowed header name constant for Cross-Origin-Resource-Policy", + "id": "script-api:dw/system/Response#CROSS_ORIGIN_RESOURCE_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.CROSS_ORIGIN_RESOURCE_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Cross-Origin-Resource-Policy", + "heading": "Description" + } + ], + "signature": "static readonly CROSS_ORIGIN_RESOURCE_POLICY = \"Cross-Origin-Resource-Policy\"", + "source": "script-api", + "tags": [ + "cross_origin_resource_policy", + "response.cross_origin_resource_policy" + ], + "title": "Response.CROSS_ORIGIN_RESOURCE_POLICY" + }, + { + "description": "An allowed header name constant for Link", + "id": "script-api:dw/system/Response#LINK", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LINK", + "sections": [ + { + "body": "An allowed header name constant for Link", + "heading": "Description" + } + ], + "signature": "static readonly LINK = \"Link\"", + "source": "script-api", + "tags": [ + "link", + "response.link" + ], + "title": "Response.LINK" + }, + { + "description": "An allowed header name constant for Link", + "id": "script-api:dw/system/Response#LINK", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LINK", + "sections": [ + { + "body": "An allowed header name constant for Link", + "heading": "Description" + } + ], + "signature": "static readonly LINK = \"Link\"", + "source": "script-api", + "tags": [ + "link", + "response.link" + ], + "title": "Response.LINK" + }, + { + "description": "An allowed header name constant for Location", + "id": "script-api:dw/system/Response#LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LOCATION", + "sections": [ + { + "body": "An allowed header name constant for Location", + "heading": "Description" + } + ], + "signature": "static readonly LOCATION = \"Location\"", + "source": "script-api", + "tags": [ + "location", + "response.location" + ], + "title": "Response.LOCATION" + }, + { + "description": "An allowed header name constant for Location", + "id": "script-api:dw/system/Response#LOCATION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.LOCATION", + "sections": [ + { + "body": "An allowed header name constant for Location", + "heading": "Description" + } + ], + "signature": "static readonly LOCATION = \"Location\"", + "source": "script-api", + "tags": [ + "location", + "response.location" + ], + "title": "Response.LOCATION" + }, + { + "description": "An allowed header name constant for Permissions-Policy", + "id": "script-api:dw/system/Response#PERMISSIONS_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PERMISSIONS_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Permissions-Policy", + "heading": "Description" + } + ], + "signature": "static readonly PERMISSIONS_POLICY = \"Permissions-Policy\"", + "source": "script-api", + "tags": [ + "permissions_policy", + "response.permissions_policy" + ], + "title": "Response.PERMISSIONS_POLICY" + }, + { + "description": "An allowed header name constant for Permissions-Policy", + "id": "script-api:dw/system/Response#PERMISSIONS_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PERMISSIONS_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Permissions-Policy", + "heading": "Description" + } + ], + "signature": "static readonly PERMISSIONS_POLICY = \"Permissions-Policy\"", + "source": "script-api", + "tags": [ + "permissions_policy", + "response.permissions_policy" + ], + "title": "Response.PERMISSIONS_POLICY" + }, + { + "description": "An allowed header name constant for Platform for Privacy Preferences Project", + "id": "script-api:dw/system/Response#PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "sections": [ + { + "body": "An allowed header name constant for Platform for Privacy Preferences Project", + "heading": "Description" + } + ], + "signature": "static readonly PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT = \"P3P\"", + "source": "script-api", + "tags": [ + "platform_for_privacy_preferences_project", + "response.platform_for_privacy_preferences_project" + ], + "title": "Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT" + }, + { + "description": "An allowed header name constant for Platform for Privacy Preferences Project", + "id": "script-api:dw/system/Response#PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT", + "sections": [ + { + "body": "An allowed header name constant for Platform for Privacy Preferences Project", + "heading": "Description" + } + ], + "signature": "static readonly PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT = \"P3P\"", + "source": "script-api", + "tags": [ + "platform_for_privacy_preferences_project", + "response.platform_for_privacy_preferences_project" + ], + "title": "Response.PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT" + }, + { + "description": "An allowed header name constant for Referrer-Policy", + "id": "script-api:dw/system/Response#REFERRER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFERRER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Referrer-Policy", + "heading": "Description" + } + ], + "signature": "static readonly REFERRER_POLICY = \"Referrer-Policy\"", + "source": "script-api", + "tags": [ + "referrer_policy", + "response.referrer_policy" + ], + "title": "Response.REFERRER_POLICY" + }, + { + "description": "An allowed header name constant for Referrer-Policy", + "id": "script-api:dw/system/Response#REFERRER_POLICY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFERRER_POLICY", + "sections": [ + { + "body": "An allowed header name constant for Referrer-Policy", + "heading": "Description" + } + ], + "signature": "static readonly REFERRER_POLICY = \"Referrer-Policy\"", + "source": "script-api", + "tags": [ + "referrer_policy", + "response.referrer_policy" + ], + "title": "Response.REFERRER_POLICY" + }, + { + "description": "An allowed header name constant for Refresh", + "id": "script-api:dw/system/Response#REFRESH", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFRESH", + "sections": [ + { + "body": "An allowed header name constant for Refresh", + "heading": "Description" + } + ], + "signature": "static readonly REFRESH = \"Refresh\"", + "source": "script-api", + "tags": [ + "refresh", + "response.refresh" + ], + "title": "Response.REFRESH" + }, + { + "description": "An allowed header name constant for Refresh", + "id": "script-api:dw/system/Response#REFRESH", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.REFRESH", + "sections": [ + { + "body": "An allowed header name constant for Refresh", + "heading": "Description" + } + ], + "signature": "static readonly REFRESH = \"Refresh\"", + "source": "script-api", + "tags": [ + "refresh", + "response.refresh" + ], + "title": "Response.REFRESH" + }, + { + "description": "An allowed header name constant for Retry-After", + "id": "script-api:dw/system/Response#RETRY_AFTER", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.RETRY_AFTER", + "sections": [ + { + "body": "An allowed header name constant for Retry-After", + "heading": "Description" + } + ], + "signature": "static readonly RETRY_AFTER = \"Retry-After\"", + "source": "script-api", + "tags": [ + "retry_after", + "response.retry_after" + ], + "title": "Response.RETRY_AFTER" + }, + { + "description": "An allowed header name constant for Retry-After", + "id": "script-api:dw/system/Response#RETRY_AFTER", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.RETRY_AFTER", + "sections": [ + { + "body": "An allowed header name constant for Retry-After", + "heading": "Description" + } + ], + "signature": "static readonly RETRY_AFTER = \"Retry-After\"", + "source": "script-api", + "tags": [ + "retry_after", + "response.retry_after" + ], + "title": "Response.RETRY_AFTER" + }, + { + "description": "An allowed header name constant for service-worker-allowed", + "id": "script-api:dw/system/Response#SERVICE_WORKER_ALLOWED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.SERVICE_WORKER_ALLOWED", + "sections": [ + { + "body": "An allowed header name constant for service-worker-allowed", + "heading": "Description" + } + ], + "signature": "static readonly SERVICE_WORKER_ALLOWED = \"service-worker-allowed\"", + "source": "script-api", + "tags": [ + "service_worker_allowed", + "response.service_worker_allowed" + ], + "title": "Response.SERVICE_WORKER_ALLOWED" + }, + { + "description": "An allowed header name constant for service-worker-allowed", + "id": "script-api:dw/system/Response#SERVICE_WORKER_ALLOWED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.SERVICE_WORKER_ALLOWED", + "sections": [ + { + "body": "An allowed header name constant for service-worker-allowed", + "heading": "Description" + } + ], + "signature": "static readonly SERVICE_WORKER_ALLOWED = \"service-worker-allowed\"", + "source": "script-api", + "tags": [ + "service_worker_allowed", + "response.service_worker_allowed" + ], + "title": "Response.SERVICE_WORKER_ALLOWED" + }, + { + "description": "An allowed header name constant for Vary", + "id": "script-api:dw/system/Response#VARY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.VARY", + "sections": [ + { + "body": "An allowed header name constant for Vary", + "heading": "Description" + } + ], + "signature": "static readonly VARY = \"Vary\"", + "source": "script-api", + "tags": [ + "vary", + "response.vary" + ], + "title": "Response.VARY" + }, + { + "description": "An allowed header name constant for Vary", + "id": "script-api:dw/system/Response#VARY", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.VARY", + "sections": [ + { + "body": "An allowed header name constant for Vary", + "heading": "Description" + } + ], + "signature": "static readonly VARY = \"Vary\"", + "source": "script-api", + "tags": [ + "vary", + "response.vary" + ], + "title": "Response.VARY" + }, + { + "description": "An allowed header name constant for X-Content-Type-Options", + "id": "script-api:dw/system/Response#X_CONTENT_TYPE_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_CONTENT_TYPE_OPTIONS", + "sections": [ + { + "body": "An allowed header name constant for X-Content-Type-Options", + "heading": "Description" + } + ], + "signature": "static readonly X_CONTENT_TYPE_OPTIONS = \"X-Content-Type-Options\"", + "source": "script-api", + "tags": [ + "x_content_type_options", + "response.x_content_type_options" + ], + "title": "Response.X_CONTENT_TYPE_OPTIONS" + }, + { + "description": "An allowed header name constant for X-Content-Type-Options", + "id": "script-api:dw/system/Response#X_CONTENT_TYPE_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_CONTENT_TYPE_OPTIONS", + "sections": [ + { + "body": "An allowed header name constant for X-Content-Type-Options", + "heading": "Description" + } + ], + "signature": "static readonly X_CONTENT_TYPE_OPTIONS = \"X-Content-Type-Options\"", + "source": "script-api", + "tags": [ + "x_content_type_options", + "response.x_content_type_options" + ], + "title": "Response.X_CONTENT_TYPE_OPTIONS" + }, + { + "description": "An allowed header name constant for X-FRAME-OPTIONS.", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS", + "sections": [ + { + "body": "An allowed header name constant for X-FRAME-OPTIONS.\n\nNote: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS = \"X-FRAME-OPTIONS\"", + "source": "script-api", + "tags": [ + "x_frame_options", + "response.x_frame_options" + ], + "title": "Response.X_FRAME_OPTIONS" + }, + { + "description": "An allowed header name constant for X-FRAME-OPTIONS.", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS", + "sections": [ + { + "body": "An allowed header name constant for X-FRAME-OPTIONS.\n\nNote: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS = \"X-FRAME-OPTIONS\"", + "source": "script-api", + "tags": [ + "x_frame_options", + "response.x_frame_options" + ], + "title": "Response.X_FRAME_OPTIONS" + }, + { + "description": "An allowed value ALLOW-FROM for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_ALLOW_FROM", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_ALLOW_FROM", + "sections": [ + { + "body": "An allowed value ALLOW-FROM for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_ALLOW_FROM = \"ALLOW-FROM\"", + "source": "script-api", + "tags": [ + "x_frame_options_allow_from", + "response.x_frame_options_allow_from" + ], + "title": "Response.X_FRAME_OPTIONS_ALLOW_FROM" + }, + { + "description": "An allowed value ALLOW-FROM for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_ALLOW_FROM", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_ALLOW_FROM", + "sections": [ + { + "body": "An allowed value ALLOW-FROM for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_ALLOW_FROM = \"ALLOW-FROM\"", + "source": "script-api", + "tags": [ + "x_frame_options_allow_from", + "response.x_frame_options_allow_from" + ], + "title": "Response.X_FRAME_OPTIONS_ALLOW_FROM" + }, + { + "description": "An allowed value DENY for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_DENY_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_DENY_VALUE", + "sections": [ + { + "body": "An allowed value DENY for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_DENY_VALUE = \"DENY\"", + "source": "script-api", + "tags": [ + "x_frame_options_deny_value", + "response.x_frame_options_deny_value" + ], + "title": "Response.X_FRAME_OPTIONS_DENY_VALUE" + }, + { + "description": "An allowed value DENY for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_DENY_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_DENY_VALUE", + "sections": [ + { + "body": "An allowed value DENY for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_DENY_VALUE = \"DENY\"", + "source": "script-api", + "tags": [ + "x_frame_options_deny_value", + "response.x_frame_options_deny_value" + ], + "title": "Response.X_FRAME_OPTIONS_DENY_VALUE" + }, + { + "description": "An allowed value SAME-ORIGIN value for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "sections": [ + { + "body": "An allowed value SAME-ORIGIN value for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_SAMEORIGIN_VALUE = \"SAMEORIGIN\"", + "source": "script-api", + "tags": [ + "x_frame_options_sameorigin_value", + "response.x_frame_options_sameorigin_value" + ], + "title": "Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE" + }, + { + "description": "An allowed value SAME-ORIGIN value for X-FRAME-OPTIONS", + "id": "script-api:dw/system/Response#X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE", + "sections": [ + { + "body": "An allowed value SAME-ORIGIN value for X-FRAME-OPTIONS", + "heading": "Description" + } + ], + "signature": "static readonly X_FRAME_OPTIONS_SAMEORIGIN_VALUE = \"SAMEORIGIN\"", + "source": "script-api", + "tags": [ + "x_frame_options_sameorigin_value", + "response.x_frame_options_sameorigin_value" + ], + "title": "Response.X_FRAME_OPTIONS_SAMEORIGIN_VALUE" + }, + { + "description": "An allowed header name constant for X-Robots-Tag", + "id": "script-api:dw/system/Response#X_ROBOTS_TAG", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_ROBOTS_TAG", + "sections": [ + { + "body": "An allowed header name constant for X-Robots-Tag", + "heading": "Description" + } + ], + "signature": "static readonly X_ROBOTS_TAG = \"X-Robots-Tag\"", + "source": "script-api", + "tags": [ + "x_robots_tag", + "response.x_robots_tag" + ], + "title": "Response.X_ROBOTS_TAG" + }, + { + "description": "An allowed header name constant for X-Robots-Tag", + "id": "script-api:dw/system/Response#X_ROBOTS_TAG", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_ROBOTS_TAG", + "sections": [ + { + "body": "An allowed header name constant for X-Robots-Tag", + "heading": "Description" + } + ], + "signature": "static readonly X_ROBOTS_TAG = \"X-Robots-Tag\"", + "source": "script-api", + "tags": [ + "x_robots_tag", + "response.x_robots_tag" + ], + "title": "Response.X_ROBOTS_TAG" + }, + { + "description": "An allowed header name constant for X-XSS-Protection", + "id": "script-api:dw/system/Response#X_XSS_PROTECTION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_XSS_PROTECTION", + "sections": [ + { + "body": "An allowed header name constant for X-XSS-Protection", + "heading": "Description" + } + ], + "signature": "static readonly X_XSS_PROTECTION = \"X-XSS-Protection\"", + "source": "script-api", + "tags": [ + "x_xss_protection", + "response.x_xss_protection" + ], + "title": "Response.X_XSS_PROTECTION" + }, + { + "description": "An allowed header name constant for X-XSS-Protection", + "id": "script-api:dw/system/Response#X_XSS_PROTECTION", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.X_XSS_PROTECTION", + "sections": [ + { + "body": "An allowed header name constant for X-XSS-Protection", + "heading": "Description" + } + ], + "signature": "static readonly X_XSS_PROTECTION = \"X-XSS-Protection\"", + "source": "script-api", + "tags": [ + "x_xss_protection", + "response.x_xss_protection" + ], + "title": "Response.X_XSS_PROTECTION" + }, + { + "description": "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 sent 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).", + "examples": [ + "Example, how a cookie can be deleted at the client:\n\nvar cookie : Cookie = new Cookie(\"SomeName\", \"Simple Value\");\n\ncookie.setMaxAge(0);\n\nresponse.addHttpCookie(cookie);" + ], + "id": "script-api:dw/system/Response#addHttpCookie", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "cookie", + "type": "Cookie" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.addHttpCookie", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the specified cookie to the outgoing response. This method can be called multiple times to set more than one\ncookie. If a cookie with the same cookie name, domain and path is set multiple times for the same response, only\nthe last set cookie with this name is sent to the client. This method can be used to set, update or delete\ncookies at the client. If the cookie doesn't exist at the client, it is set initially. If a cookie with the same\nname, domain and path already exists at the client, it is updated. A cookie can be deleted at the client by\nsubmitting a cookie with the maxAge attribute set to 0 (see `Cookie.setMaxAge()\n` for more information).\n\n\nYou can't set a cookie's SameSite attribute using the API. The server sets SameSite to None if either the\ndeveloper sets the cookie's Secure flag or the global security preference Enforce HTTPS is enabled, in which case\nthe Secure flag is also set. Otherwise, the server doesn't set the SameSite attribute and the browser uses its\nown default SameSite setting. The SameSite attribute is not sent with a cookie if the server detects that the\nclient doesn't correctly interpret the attribute.", + "heading": "Description" + } + ], + "signature": "addHttpCookie(cookie: Cookie): void", + "source": "script-api", + "tags": [ + "addhttpcookie", + "response.addhttpcookie" + ], + "title": "Response.addHttpCookie" + }, + { + "description": "Adds a response header with the given name and value. This method allows response headers to have multiple values.", + "id": "script-api:dw/system/Response#addHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.addHttpHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a response header with the given name and value. This method allows response headers to have multiple\nvalues.\n\nFor public headers, only the names listed in the \"Constants\" section are allowed. Custom header names must begin\nwith the prefix \"X-SF-CC-\" and can contain only alphanumeric characters, dash, and underscore.", + "heading": "Description" + } + ], + "signature": "addHttpHeader(name: string, value: string): void", + "source": "script-api", + "tags": [ + "addhttpheader", + "response.addhttpheader" + ], + "title": "Response.addHttpHeader" + }, + { + "description": "Checks whether the response message header has a field with the specified name.", + "id": "script-api:dw/system/Response#containsHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.containsHttpHeader", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks whether the response message header has a field with the specified name.", + "heading": "Description" + } + ], + "signature": "containsHttpHeader(name: string): boolean", + "source": "script-api", + "tags": [ + "containshttpheader", + "response.containshttpheader" + ], + "title": "Response.containsHttpHeader" + }, + { + "description": "Returns a print writer which can be used to print content directly to the response.", + "id": "script-api:dw/system/Response#getWriter", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.getWriter", + "returns": { + "type": "PrintWriter" + }, + "sections": [ + { + "body": "Returns a print writer which can be used to print content directly to the response.", + "heading": "Description" + } + ], + "signature": "getWriter(): PrintWriter", + "source": "script-api", + "tags": [ + "getwriter", + "response.getwriter" + ], + "title": "Response.getWriter" + }, + { + "description": "Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL.", + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "url", + "type": "URL" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL.", + "heading": "Description" + } + ], + "signature": "redirect(url: URL): void", + "source": "script-api", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "description": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "url", + "type": "URL" + }, + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "heading": "Description" + } + ], + "signature": "redirect(url: URL, status: number): void", + "source": "script-api", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "description": "Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL. The target location must be a relative or an absolute URL.", + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "location", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL. The\ntarget location must be a relative or an absolute URL.", + "heading": "Description" + } + ], + "signature": "redirect(location: string): void", + "source": "script-api", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "description": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "location", + "type": "string" + }, + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "heading": "Description" + } + ], + "signature": "redirect(location: string, status: number): void", + "source": "script-api", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "description": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "id": "script-api:dw/system/Response#redirect", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "redirect", + "type": "URLRedirect" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.redirect", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sends a redirect response with the given status to the client for the specified redirect location URL.", + "heading": "Description" + } + ], + "signature": "redirect(redirect: URLRedirect): void", + "source": "script-api", + "tags": [ + "redirect", + "response.redirect" + ], + "title": "Response.redirect" + }, + { + "description": "Sets whether the output should be buffered or streamed directly to the client. By default, buffering is enabled. The mode can only be changed before anything has been written to the response. Switching buffering off and using streaming mode is recommended for sending large responses.", + "id": "script-api:dw/system/Response#setBuffered", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "buffered", + "type": "boolean" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setBuffered", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets whether the output should be buffered or streamed directly to the client. By default, buffering is enabled.\nThe mode can only be changed before anything has been written to the response. Switching buffering off and using\nstreaming mode is recommended for sending large responses.", + "heading": "Description" + } + ], + "signature": "setBuffered(buffered: boolean): void", + "source": "script-api", + "tags": [ + "setbuffered", + "response.setbuffered" + ], + "title": "Response.setBuffered" + }, + { + "description": "Sets the content type for this response. This method may only be called before any output is written to the response.", + "id": "script-api:dw/system/Response#setContentType", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "contentType", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setContentType", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the content type for this response. This method may only be called before any output is written to the\nresponse.", + "heading": "Description" + } + ], + "signature": "setContentType(contentType: string): void", + "source": "script-api", + "tags": [ + "setcontenttype", + "response.setcontenttype" + ], + "title": "Response.setContentType" + }, + { + "description": "Sets the cache expiration time for the response. The response will only be cached if caching was not disabled previously. By default, responses are not cached. This method can be called multiple times during request processing. If caching is enabled, the lowest expiration time, resulting from the invocations of the method becomes the cache expiration time. This is only used for HTTP requests. Streamed responses cannot be cached. This method is an alternative for setting the cache time using the tag in ISML templates.", + "id": "script-api:dw/system/Response#setExpires", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "expires", + "type": "number" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setExpires", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the cache expiration time for the response. The response will only be cached if caching was not disabled\npreviously. By default, responses are not cached. This method can be called multiple times during request\nprocessing. If caching is enabled, the lowest expiration time, resulting from the invocations of the method\nbecomes the cache expiration time. This is only used for HTTP requests. Streamed responses cannot be cached. This\nmethod is an alternative for setting the cache time using the tag in ISML templates.", + "heading": "Description" + } + ], + "signature": "setExpires(expires: number): void", + "source": "script-api", + "tags": [ + "setexpires", + "response.setexpires" + ], + "title": "Response.setExpires" + }, + { + "description": "Convenience method for setExpires which takes a Date object.", + "id": "script-api:dw/system/Response#setExpires", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "expires", + "type": "Date" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setExpires", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Convenience method for setExpires which takes a Date object.", + "heading": "Description" + } + ], + "signature": "setExpires(expires: Date): void", + "source": "script-api", + "tags": [ + "setexpires", + "response.setexpires" + ], + "title": "Response.setExpires" + }, + { + "description": "Adds a response header with the given name and value. If one or more value(s) have already been set, the new value overwrites the previous one. The containsHttpHeader method can be used to test for the presence of a header before setting its value.", + "id": "script-api:dw/system/Response#setHttpHeader", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setHttpHeader", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds a response header with the given name and value. If one or more value(s) have already been set, the new\nvalue overwrites the previous one. The containsHttpHeader method can be used to test for the\npresence of a header before setting its value.\n\nFor public headers, only the names listed in the \"Constants\" section are allowed. Custom header names must begin\nwith the prefix \"X-SF-CC-\" and can contain only alphanumeric characters, dash, and underscore.", + "heading": "Description" + } + ], + "signature": "setHttpHeader(name: string, value: string): void", + "source": "script-api", + "tags": [ + "sethttpheader", + "response.sethttpheader" + ], + "title": "Response.setHttpHeader" + }, + { + "description": "Sets the HTTP response code.", + "id": "script-api:dw/system/Response#setStatus", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the HTTP response code.", + "heading": "Description" + } + ], + "signature": "setStatus(status: number): void", + "source": "script-api", + "tags": [ + "setstatus", + "response.setstatus" + ], + "title": "Response.setStatus" + }, + { + "description": "Marks the response as personalized with the given variant identifier. Commerce Cloud Digital identifies unique pages based on a combination of pricebook, promotion, sorting rule and A/B test segments, caches the different variants of the page, and then delivers the correct version to the user. If a page is personalized by means other than pricebook, promotion, sorting rule and A/B test, the page must not be cached, because the wrong variants of the page would be delivered to the user. For performance reasons, a page should only be marked as personalized if it really is. Otherwise, the performance can unnecessarily degrade.", + "id": "script-api:dw/system/Response#setVaryBy", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "varyBy", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.setVaryBy", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Marks the response as personalized with the given variant identifier. Commerce Cloud Digital identifies unique\npages based on a combination of pricebook, promotion, sorting rule and A/B test segments, caches the different\nvariants of the page, and then delivers the correct version to the user. If a page is personalized by means other\nthan pricebook, promotion, sorting rule and A/B test, the page must not be cached, because the wrong variants of\nthe page would be delivered to the user. For performance reasons, a page should only be marked as personalized if\nit really is. Otherwise, the performance can unnecessarily degrade.\n\nThis method has the same effect as using tag in an ISML template. Once\nthe vary-by value was set, either using this method or by the tag in a template, the entire\nresponse is treated as personalized.", + "heading": "Description" + } + ], + "signature": "setVaryBy(varyBy: string): void", + "source": "script-api", + "tags": [ + "setvaryby", + "response.setvaryby" + ], + "title": "Response.setVaryBy" + }, + { + "description": "Returns a print writer which can be used to print content directly to the response.", + "id": "script-api:dw/system/Response#writer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Response", + "qualifiedName": "dw.system.Response.writer", + "sections": [ + { + "body": "Returns a print writer which can be used to print content directly to the response.", + "heading": "Description" + } + ], + "signature": "readonly writer: PrintWriter", + "source": "script-api", + "tags": [ + "writer", + "response.writer" + ], + "title": "Response.writer" + }, + { + "description": "A SearchStatus is used for communicating a Search API status back to a client. A status consists of status code and description. More information about search API call can be fetched by using SearchStatus class method getStatusCode and getDescription, which can be used by clients to perform different operations.", + "id": "script-api:dw/system/SearchStatus", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.SearchStatus", + "sections": [ + { + "body": "A SearchStatus is used for communicating a Search API status back to a client. A status consists of status code and\ndescription. More information about search API call can be fetched by using SearchStatus class method getStatusCode\nand getDescription, which can be used by clients to perform different operations.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "searchstatus", + "dw.system.searchstatus", + "dw/system" + ], + "title": "SearchStatus" + }, + { + "description": "EMPTY_QUERY search result status code 6, this indicates that search has been made with empty query.", + "id": "script-api:dw/system/SearchStatus#EMPTY_QUERY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.EMPTY_QUERY", + "sections": [ + { + "body": "EMPTY_QUERY search result status code 6, this indicates that search has been made with empty query.", + "heading": "Description" + } + ], + "signature": "static readonly EMPTY_QUERY: number", + "source": "script-api", + "tags": [ + "empty_query", + "searchstatus.empty_query" + ], + "title": "SearchStatus.EMPTY_QUERY" + }, + { + "description": "EMPTY_QUERY search result status code 6, this indicates that search has been made with empty query.", + "id": "script-api:dw/system/SearchStatus#EMPTY_QUERY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.EMPTY_QUERY", + "sections": [ + { + "body": "EMPTY_QUERY search result status code 6, this indicates that search has been made with empty query.", + "heading": "Description" + } + ], + "signature": "static readonly EMPTY_QUERY: number", + "source": "script-api", + "tags": [ + "empty_query", + "searchstatus.empty_query" + ], + "title": "SearchStatus.EMPTY_QUERY" + }, + { + "description": "ERROR search result status code 9, this indicates that internal server error has been occurred.", + "id": "script-api:dw/system/SearchStatus#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ERROR", + "sections": [ + { + "body": "ERROR search result status code 9, this indicates that internal server error has been occurred.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR: number", + "source": "script-api", + "tags": [ + "error", + "searchstatus.error" + ], + "title": "SearchStatus.ERROR" + }, + { + "description": "ERROR search result status code 9, this indicates that internal server error has been occurred.", + "id": "script-api:dw/system/SearchStatus#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ERROR", + "sections": [ + { + "body": "ERROR search result status code 9, this indicates that internal server error has been occurred.", + "heading": "Description" + } + ], + "signature": "static readonly ERROR: number", + "source": "script-api", + "tags": [ + "error", + "searchstatus.error" + ], + "title": "SearchStatus.ERROR" + }, + { + "description": "LIMITED search result status code 2, this indicates that limitations on search result have been applied and full search result is not returned.", + "id": "script-api:dw/system/SearchStatus#LIMITED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.LIMITED", + "sections": [ + { + "body": "LIMITED search result status code 2, this indicates that limitations on search result have been applied and\nfull search result is not returned.", + "heading": "Description" + } + ], + "signature": "static readonly LIMITED: number", + "source": "script-api", + "tags": [ + "limited", + "searchstatus.limited" + ], + "title": "SearchStatus.LIMITED" + }, + { + "description": "LIMITED search result status code 2, this indicates that limitations on search result have been applied and full search result is not returned.", + "id": "script-api:dw/system/SearchStatus#LIMITED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.LIMITED", + "sections": [ + { + "body": "LIMITED search result status code 2, this indicates that limitations on search result have been applied and\nfull search result is not returned.", + "heading": "Description" + } + ], + "signature": "static readonly LIMITED: number", + "source": "script-api", + "tags": [ + "limited", + "searchstatus.limited" + ], + "title": "SearchStatus.LIMITED" + }, + { + "description": "NOT_EXECUTED search result status code 0, this indicates that search API call has not been made on SearchModel.", + "id": "script-api:dw/system/SearchStatus#NOT_EXECUTED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NOT_EXECUTED", + "sections": [ + { + "body": "NOT_EXECUTED search result status code 0, this indicates that search API call has not been made on SearchModel.", + "heading": "Description" + } + ], + "signature": "static readonly NOT_EXECUTED: number", + "source": "script-api", + "tags": [ + "not_executed", + "searchstatus.not_executed" + ], + "title": "SearchStatus.NOT_EXECUTED" + }, + { + "description": "NOT_EXECUTED search result status code 0, this indicates that search API call has not been made on SearchModel.", + "id": "script-api:dw/system/SearchStatus#NOT_EXECUTED", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NOT_EXECUTED", + "sections": [ + { + "body": "NOT_EXECUTED search result status code 0, this indicates that search API call has not been made on SearchModel.", + "heading": "Description" + } + ], + "signature": "static readonly NOT_EXECUTED: number", + "source": "script-api", + "tags": [ + "not_executed", + "searchstatus.not_executed" + ], + "title": "SearchStatus.NOT_EXECUTED" + }, + { + "description": "NO_CATALOG search result status code 4, this indicates that there is no catalog associated for search query.", + "id": "script-api:dw/system/SearchStatus#NO_CATALOG", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATALOG", + "sections": [ + { + "body": "NO_CATALOG search result status code 4, this indicates that there is no catalog associated for search query.", + "heading": "Description" + } + ], + "signature": "static readonly NO_CATALOG: number", + "source": "script-api", + "tags": [ + "no_catalog", + "searchstatus.no_catalog" + ], + "title": "SearchStatus.NO_CATALOG" + }, + { + "description": "NO_CATALOG search result status code 4, this indicates that there is no catalog associated for search query.", + "id": "script-api:dw/system/SearchStatus#NO_CATALOG", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATALOG", + "sections": [ + { + "body": "NO_CATALOG search result status code 4, this indicates that there is no catalog associated for search query.", + "heading": "Description" + } + ], + "signature": "static readonly NO_CATALOG: number", + "source": "script-api", + "tags": [ + "no_catalog", + "searchstatus.no_catalog" + ], + "title": "SearchStatus.NO_CATALOG" + }, + { + "description": "NO_CATEGORY search result status code 5, this indicates that there is no category associated for search query.", + "id": "script-api:dw/system/SearchStatus#NO_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATEGORY", + "sections": [ + { + "body": "NO_CATEGORY search result status code 5, this indicates that there is no category associated for search query.", + "heading": "Description" + } + ], + "signature": "static readonly NO_CATEGORY: number", + "source": "script-api", + "tags": [ + "no_category", + "searchstatus.no_category" + ], + "title": "SearchStatus.NO_CATEGORY" + }, + { + "description": "NO_CATEGORY search result status code 5, this indicates that there is no category associated for search query.", + "id": "script-api:dw/system/SearchStatus#NO_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_CATEGORY", + "sections": [ + { + "body": "NO_CATEGORY search result status code 5, this indicates that there is no category associated for search query.", + "heading": "Description" + } + ], + "signature": "static readonly NO_CATEGORY: number", + "source": "script-api", + "tags": [ + "no_category", + "searchstatus.no_category" + ], + "title": "SearchStatus.NO_CATEGORY" + }, + { + "description": "NO_INDEX search result status code 8, this indicates that there is no active search index available.", + "id": "script-api:dw/system/SearchStatus#NO_INDEX", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_INDEX", + "sections": [ + { + "body": "NO_INDEX search result status code 8, this indicates that there is no active search index available.", + "heading": "Description" + } + ], + "signature": "static readonly NO_INDEX: number", + "source": "script-api", + "tags": [ + "no_index", + "searchstatus.no_index" + ], + "title": "SearchStatus.NO_INDEX" + }, + { + "description": "NO_INDEX search result status code 8, this indicates that there is no active search index available.", + "id": "script-api:dw/system/SearchStatus#NO_INDEX", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.NO_INDEX", + "sections": [ + { + "body": "NO_INDEX search result status code 8, this indicates that there is no active search index available.", + "heading": "Description" + } + ], + "signature": "static readonly NO_INDEX: number", + "source": "script-api", + "tags": [ + "no_index", + "searchstatus.no_index" + ], + "title": "SearchStatus.NO_INDEX" + }, + { + "description": "OFFLINE_CATEGORY search result status code 7, this indicates that the category associated with search query is offline.", + "id": "script-api:dw/system/SearchStatus#OFFLINE_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.OFFLINE_CATEGORY", + "sections": [ + { + "body": "OFFLINE_CATEGORY search result status code 7, this indicates that the category associated with search query\nis offline.", + "heading": "Description" + } + ], + "signature": "static readonly OFFLINE_CATEGORY: number", + "source": "script-api", + "tags": [ + "offline_category", + "searchstatus.offline_category" + ], + "title": "SearchStatus.OFFLINE_CATEGORY" + }, + { + "description": "OFFLINE_CATEGORY search result status code 7, this indicates that the category associated with search query is offline.", + "id": "script-api:dw/system/SearchStatus#OFFLINE_CATEGORY", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.OFFLINE_CATEGORY", + "sections": [ + { + "body": "OFFLINE_CATEGORY search result status code 7, this indicates that the category associated with search query\nis offline.", + "heading": "Description" + } + ], + "signature": "static readonly OFFLINE_CATEGORY: number", + "source": "script-api", + "tags": [ + "offline_category", + "searchstatus.offline_category" + ], + "title": "SearchStatus.OFFLINE_CATEGORY" + }, + { + "description": "ROOT_SEARCH search result status code 3, this indicates that search result is returned for ROOT search.", + "id": "script-api:dw/system/SearchStatus#ROOT_SEARCH", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ROOT_SEARCH", + "sections": [ + { + "body": "ROOT_SEARCH search result status code 3, this indicates that search result is returned for ROOT search.", + "heading": "Description" + } + ], + "signature": "static readonly ROOT_SEARCH: number", + "source": "script-api", + "tags": [ + "root_search", + "searchstatus.root_search" + ], + "title": "SearchStatus.ROOT_SEARCH" + }, + { + "description": "ROOT_SEARCH search result status code 3, this indicates that search result is returned for ROOT search.", + "id": "script-api:dw/system/SearchStatus#ROOT_SEARCH", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.ROOT_SEARCH", + "sections": [ + { + "body": "ROOT_SEARCH search result status code 3, this indicates that search result is returned for ROOT search.", + "heading": "Description" + } + ], + "signature": "static readonly ROOT_SEARCH: number", + "source": "script-api", + "tags": [ + "root_search", + "searchstatus.root_search" + ], + "title": "SearchStatus.ROOT_SEARCH" + }, + { + "description": "SUCCESSFUL search result status code 1, this indicates that search API call is executed without any issue.", + "id": "script-api:dw/system/SearchStatus#SUCCESSFUL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.SUCCESSFUL", + "sections": [ + { + "body": "SUCCESSFUL search result status code 1, this indicates that search API call is executed without any issue.", + "heading": "Description" + } + ], + "signature": "static readonly SUCCESSFUL: number", + "source": "script-api", + "tags": [ + "successful", + "searchstatus.successful" + ], + "title": "SearchStatus.SUCCESSFUL" + }, + { + "description": "SUCCESSFUL search result status code 1, this indicates that search API call is executed without any issue.", + "id": "script-api:dw/system/SearchStatus#SUCCESSFUL", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.SUCCESSFUL", + "sections": [ + { + "body": "SUCCESSFUL search result status code 1, this indicates that search API call is executed without any issue.", + "heading": "Description" + } + ], + "signature": "static readonly SUCCESSFUL: number", + "source": "script-api", + "tags": [ + "successful", + "searchstatus.successful" + ], + "title": "SearchStatus.SUCCESSFUL" + }, + { + "description": "Returns status code description of search result, it provides more details about search API call status.", + "id": "script-api:dw/system/SearchStatus#description", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.description", + "sections": [ + { + "body": "Returns status code description of search result, it provides more details about search API call status.", + "heading": "Description" + } + ], + "signature": "readonly description: string", + "source": "script-api", + "tags": [ + "description", + "searchstatus.description" + ], + "title": "SearchStatus.description" + }, + { + "description": "Returns status code description of search result, it provides more details about search API call status.", + "id": "script-api:dw/system/SearchStatus#getDescription", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.getDescription", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns status code description of search result, it provides more details about search API call status.", + "heading": "Description" + } + ], + "signature": "getDescription(): string", + "source": "script-api", + "tags": [ + "getdescription", + "searchstatus.getdescription" + ], + "title": "SearchStatus.getDescription" + }, + { + "description": "Returns status code of search result, by default it will return 0 which means that search has not been executed on SearchModel.", + "id": "script-api:dw/system/SearchStatus#getStatusCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.getStatusCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns status code of search result, by default it will return 0 which means that search has not been executed\non SearchModel.", + "heading": "Description" + } + ], + "signature": "getStatusCode(): number", + "source": "script-api", + "tags": [ + "getstatuscode", + "searchstatus.getstatuscode" + ], + "title": "SearchStatus.getStatusCode" + }, + { + "description": "Returns status code of search result, by default it will return 0 which means that search has not been executed on SearchModel.", + "id": "script-api:dw/system/SearchStatus#statusCode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.statusCode", + "sections": [ + { + "body": "Returns status code of search result, by default it will return 0 which means that search has not been executed\non SearchModel.", + "heading": "Description" + } + ], + "signature": "readonly statusCode: number", + "source": "script-api", + "tags": [ + "statuscode", + "searchstatus.statuscode" + ], + "title": "SearchStatus.statusCode" + }, + { + "description": "Returns string values of status code and description.", + "id": "script-api:dw/system/SearchStatus#toString", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SearchStatus", + "qualifiedName": "dw.system.SearchStatus.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns string values of status code and description.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "searchstatus.tostring" + ], + "title": "SearchStatus.toString" + }, + { + "description": "Represents a session in B2C Commerce. The session has some well-defined attributes like the current authenticated customer or the click stream, but also supports storing custom values in the session.", + "id": "script-api:dw/system/Session", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Session", + "sections": [ + { + "body": "Represents a session in B2C Commerce. The session has some well-defined\nattributes like the current authenticated customer or the click stream, but also\nsupports storing custom values in the session.\n\nThe Digital session handling works in the following way:\n\n-\nA session is created in Digital on the first user click. This is guaranteed even if\nB2C Commerce caches the HTML pages. It is not guaranteed when the pages are cached by a CDN.\n\n-\nA session is identified with a unique ID, called the session ID.\n\n-\nWhen a session is created, the application server calls the pipeline OnSession-Start. It can\nbe used to pre-initialize the session, before the actual request hits the server.\n\n-\nDigital uses session stickiness and always routes requests within a single session to the same\napplication server.\n\n-\nSession data is also stored in a persistent location.\n\n-\nIn case of a fail-over situation, requests are re-routed to another application server, which then\nloads the session data from the persistent storage.\n\n-\nThere are two session timeouts. A soft timeout occurs 30 minutes after the last request has been made.\nThe soft timeout logs out and clears all privacy data, but it is still possible to use the session ID\nto reopen the session. A hard timeout renders a session ID invalid after six hours, even if the session\nis still in use. The hard timeout prevents a session from being reopened. For example, if the session ID\nis pasted into a URL after the hard timeout, the session doesn't reopen.\n\nCertain rules apply for what and how much data can be stored in a session:\n\n-\nAll primitive types (boolean, number, string, Number, String, Boolean, Date) are supported.\n\n-\nAll B2C Commerce value types (Money, Quantity, Decimal, Calendar) are supported.\n\n-\nStrings are limited to 2000 characters.\n\n-\nNo other types can be stored in a session. In particular, persistent objects,\ncollections, and scripted objects cannot be stored in a session. B2C Commerce\nwill report unsupported values with a deprecation message in the log files.\nAn unsupported value will be stored in the session, but the results are undefined.\nSince version compatibility mode 19.10 unsupported types will no longer be accepted,\nand an exception will be thrown.\n\n-\nThere is a 10 KB size limit for the overall serialized session.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "session", + "dw.system.session", + "dw/system" + ], + "title": "Session" + }, + { + "description": "Returns the current click stream if this is an HTTP session, null otherwise.", + "id": "script-api:dw/system/Session#clickStream", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.clickStream", + "sections": [ + { + "body": "Returns the current click stream if this is an HTTP session, null otherwise.", + "heading": "Description" + } + ], + "signature": "readonly clickStream: ClickStream | null", + "source": "script-api", + "tags": [ + "clickstream", + "session.clickstream" + ], + "title": "Session.clickStream" + }, + { + "description": "Get the currency associated with the current session. The session currency is established at session construction time and is typically equal to the site default currency. In the case of a multi-currency site, the session currency may be different than the site default currency.", + "id": "script-api:dw/system/Session#currency", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.currency", + "sections": [ + { + "body": "Get the currency associated with the current session. The session\ncurrency is established at session construction time and is typically\nequal to the site default currency. In the case of a multi-currency site,\nthe session currency may be different than the site default currency.", + "heading": "Description" + } + ], + "signature": "currency: Currency", + "source": "script-api", + "tags": [ + "currency", + "session.currency" + ], + "title": "Session.currency" + }, + { + "description": "Returns the session's custom attributes. The attributes are stored for the lifetime of the session and are not cleared when the customer logs out.", + "id": "script-api:dw/system/Session#custom", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.custom", + "sections": [ + { + "body": "Returns the session's custom attributes. The\nattributes are stored for the lifetime of the session and are not\ncleared when the customer logs out.", + "heading": "Description" + } + ], + "signature": "readonly custom: CustomAttributes", + "source": "script-api", + "tags": [ + "custom", + "session.custom" + ], + "title": "Session.custom" + }, + { + "description": "Returns the customer associated with this storefront session. The method always returns `null` if called for a non-storefront session (e.g., within a job or within Business Manager). For a storefront session, the method always returns a customer. The returned customer may be anonymous if the customer could not be identified via the customer cookie.", + "id": "script-api:dw/system/Session#customer", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customer", + "sections": [ + { + "body": "Returns the customer associated with this storefront session. The method\nalways returns `null` if called for a non-storefront session\n(e.g., within a job or within Business Manager). For a storefront\nsession, the method always returns a customer. The returned customer\nmay be anonymous if the customer could not be identified via the\ncustomer cookie.", + "heading": "Description" + } + ], + "signature": "readonly customer: Customer | null", + "source": "script-api", + "tags": [ + "customer", + "session.customer" + ], + "title": "Session.customer" + }, + { + "description": "Identifies whether the customer associated with this session is authenticated. This call is equivalent to customer.isAuthenticated().", + "id": "script-api:dw/system/Session#customerAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customerAuthenticated", + "sections": [ + { + "body": "Identifies whether the customer associated with this session\nis authenticated. This call is equivalent to customer.isAuthenticated().", + "heading": "Description" + } + ], + "signature": "readonly customerAuthenticated: boolean", + "source": "script-api", + "tags": [ + "customerauthenticated", + "session.customerauthenticated" + ], + "title": "Session.customerAuthenticated" + }, + { + "description": "Identifies whether the customer associated with this session is externally authenticated.", + "id": "script-api:dw/system/Session#customerExternallyAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.customerExternallyAuthenticated", + "sections": [ + { + "body": "Identifies whether the customer associated with this session\nis externally authenticated.", + "heading": "Description" + } + ], + "signature": "readonly customerExternallyAuthenticated: boolean", + "source": "script-api", + "tags": [ + "customerexternallyauthenticated", + "session.customerexternallyauthenticated" + ], + "title": "Session.customerExternallyAuthenticated" + }, + { + "description": "Returns the forms object that provides access to all current forms of a customer in the session.", + "id": "script-api:dw/system/Session#forms", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.forms", + "sections": [ + { + "body": "Returns the forms object that provides access to all current forms of a customer in the session.", + "heading": "Description" + } + ], + "signature": "readonly forms: Forms", + "source": "script-api", + "tags": [ + "forms", + "session.forms" + ], + "title": "Session.forms" + }, + { + "description": "Generates a new guest session signature.", + "id": "script-api:dw/system/Session#generateGuestSessionSignature", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.generateGuestSessionSignature", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Generates a new guest session signature.\n\nThis is intended for guest authentication with the Shopper Login and API Access Service (SLAS).", + "heading": "Description" + } + ], + "signature": "generateGuestSessionSignature(): string", + "source": "script-api", + "tags": [ + "generateguestsessionsignature", + "session.generateguestsessionsignature" + ], + "title": "Session.generateGuestSessionSignature" + }, + { + "description": "Generates a new registered session signature.", + "id": "script-api:dw/system/Session#generateRegisteredSessionSignature", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.generateRegisteredSessionSignature", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Generates a new registered session signature.\n\nThis is intended for use with registered session-bridge call of Shopper Login and API Access Service (SLAS).", + "heading": "Description" + } + ], + "signature": "generateRegisteredSessionSignature(): string", + "source": "script-api", + "tags": [ + "generateregisteredsessionsignature", + "session.generateregisteredsessionsignature" + ], + "title": "Session.generateRegisteredSessionSignature" + }, + { + "description": "Returns the current click stream if this is an HTTP session, null otherwise.", + "id": "script-api:dw/system/Session#getClickStream", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getClickStream", + "returns": { + "type": "ClickStream | null" + }, + "sections": [ + { + "body": "Returns the current click stream if this is an HTTP session, null otherwise.", + "heading": "Description" + } + ], + "signature": "getClickStream(): ClickStream | null", + "source": "script-api", + "tags": [ + "getclickstream", + "session.getclickstream" + ], + "title": "Session.getClickStream" + }, + { + "description": "Get the currency associated with the current session. The session currency is established at session construction time and is typically equal to the site default currency. In the case of a multi-currency site, the session currency may be different than the site default currency.", + "id": "script-api:dw/system/Session#getCurrency", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCurrency", + "returns": { + "type": "Currency" + }, + "sections": [ + { + "body": "Get the currency associated with the current session. The session\ncurrency is established at session construction time and is typically\nequal to the site default currency. In the case of a multi-currency site,\nthe session currency may be different than the site default currency.", + "heading": "Description" + } + ], + "signature": "getCurrency(): Currency", + "source": "script-api", + "tags": [ + "getcurrency", + "session.getcurrency" + ], + "title": "Session.getCurrency" + }, + { + "description": "Returns the session's custom attributes. The attributes are stored for the lifetime of the session and are not cleared when the customer logs out.", + "id": "script-api:dw/system/Session#getCustom", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCustom", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns the session's custom attributes. The\nattributes are stored for the lifetime of the session and are not\ncleared when the customer logs out.", + "heading": "Description" + } + ], + "signature": "getCustom(): CustomAttributes", + "source": "script-api", + "tags": [ + "getcustom", + "session.getcustom" + ], + "title": "Session.getCustom" + }, + { + "description": "Returns the customer associated with this storefront session. The method always returns `null` if called for a non-storefront session (e.g., within a job or within Business Manager). For a storefront session, the method always returns a customer. The returned customer may be anonymous if the customer could not be identified via the customer cookie.", + "id": "script-api:dw/system/Session#getCustomer", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getCustomer", + "returns": { + "type": "Customer | null" + }, + "sections": [ + { + "body": "Returns the customer associated with this storefront session. The method\nalways returns `null` if called for a non-storefront session\n(e.g., within a job or within Business Manager). For a storefront\nsession, the method always returns a customer. The returned customer\nmay be anonymous if the customer could not be identified via the\ncustomer cookie.", + "heading": "Description" + } + ], + "signature": "getCustomer(): Customer | null", + "source": "script-api", + "tags": [ + "getcustomer", + "session.getcustomer" + ], + "title": "Session.getCustomer" + }, + { + "description": "Returns the forms object that provides access to all current forms of a customer in the session.", + "id": "script-api:dw/system/Session#getForms", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getForms", + "returns": { + "type": "Forms" + }, + "sections": [ + { + "body": "Returns the forms object that provides access to all current forms of a customer in the session.", + "heading": "Description" + } + ], + "signature": "getForms(): Forms", + "source": "script-api", + "tags": [ + "getforms", + "session.getforms" + ], + "title": "Session.getForms" + }, + { + "description": "Returns information on the last source code handled by the session. This may or may not be the session's active source code, e.g., the last received source code was inactive and therefore was not set as the session's active source code.", + "id": "script-api:dw/system/Session#getLastReceivedSourceCodeInfo", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getLastReceivedSourceCodeInfo", + "returns": { + "type": "SourceCodeInfo" + }, + "sections": [ + { + "body": "Returns information on the last source code handled by the session.\nThis may or may not be the session's active source code, e.g., the\nlast received source code was inactive and therefore was not\nset as the session's active source code.", + "heading": "Description" + } + ], + "signature": "getLastReceivedSourceCodeInfo(): SourceCodeInfo", + "source": "script-api", + "tags": [ + "getlastreceivedsourcecodeinfo", + "session.getlastreceivedsourcecodeinfo" + ], + "title": "Session.getLastReceivedSourceCodeInfo" + }, + { + "description": "Returns the session's custom privacy attributes. The attributes are stored for the lifetime of the session and are automatically cleared when the customer logs out.", + "id": "script-api:dw/system/Session#getPrivacy", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getPrivacy", + "returns": { + "type": "CustomAttributes" + }, + "sections": [ + { + "body": "Returns the session's custom privacy attributes.\nThe attributes are stored for the lifetime of the session and are\nautomatically cleared when the customer logs out.", + "heading": "Description" + } + ], + "signature": "getPrivacy(): CustomAttributes", + "source": "script-api", + "tags": [ + "getprivacy", + "session.getprivacy" + ], + "title": "Session.getPrivacy" + }, + { + "description": "Returns the unique session id. This can safely be used as an identifier against external systems.", + "id": "script-api:dw/system/Session#getSessionID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getSessionID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the unique session id. This can safely be used as an identifier\nagainst external systems.", + "heading": "Description" + } + ], + "signature": "getSessionID(): string", + "source": "script-api", + "tags": [ + "getsessionid", + "session.getsessionid" + ], + "title": "Session.getSessionID" + }, + { + "description": "Returns information on the session's active source-code.", + "id": "script-api:dw/system/Session#getSourceCodeInfo", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getSourceCodeInfo", + "returns": { + "type": "SourceCodeInfo" + }, + "sections": [ + { + "body": "Returns information on the session's active source-code.", + "heading": "Description" + } + ], + "signature": "getSourceCodeInfo(): SourceCodeInfo", + "source": "script-api", + "tags": [ + "getsourcecodeinfo", + "session.getsourcecodeinfo" + ], + "title": "Session.getSourceCodeInfo" + }, + { + "description": "Returns the current agent user name associated with this session.", + "id": "script-api:dw/system/Session#getUserName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.getUserName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current agent user name associated with this session.\n\nNote: this class allows access to sensitive security-related data.\nPay special attention to PCI DSS v3 requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "signature": "getUserName(): string", + "source": "script-api", + "tags": [ + "getusername", + "session.getusername" + ], + "title": "Session.getUserName" + }, + { + "description": "Identifies whether the customer associated with this session is authenticated. This call is equivalent to customer.isAuthenticated().", + "id": "script-api:dw/system/Session#isCustomerAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isCustomerAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies whether the customer associated with this session\nis authenticated. This call is equivalent to customer.isAuthenticated().", + "heading": "Description" + } + ], + "signature": "isCustomerAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "iscustomerauthenticated", + "session.iscustomerauthenticated" + ], + "title": "Session.isCustomerAuthenticated" + }, + { + "description": "Identifies whether the customer associated with this session is externally authenticated.", + "id": "script-api:dw/system/Session#isCustomerExternallyAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isCustomerExternallyAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies whether the customer associated with this session\nis externally authenticated.", + "heading": "Description" + } + ], + "signature": "isCustomerExternallyAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "iscustomerexternallyauthenticated", + "session.iscustomerexternallyauthenticated" + ], + "title": "Session.isCustomerExternallyAuthenticated" + }, + { + "description": "Returns whether the tracking allowed flag is set in the session. The value for newly created sessions defaults to the Site Preference \"TrackingAllowed\" unless a cookie named \"dw_dnt\" is found in which case the cookie value takes precedence.", + "id": "script-api:dw/system/Session#isTrackingAllowed", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isTrackingAllowed", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether the tracking allowed flag is set in the session.\nThe value for newly created sessions defaults to the Site Preference \"TrackingAllowed\" unless\na cookie named \"dw_dnt\" is found in which case the cookie value takes precedence.", + "heading": "Description" + } + ], + "signature": "isTrackingAllowed(): boolean", + "source": "script-api", + "tags": [ + "istrackingallowed", + "session.istrackingallowed" + ], + "title": "Session.isTrackingAllowed" + }, + { + "description": "Identifies whether the agent user associated with this session is authenticated.", + "id": "script-api:dw/system/Session#isUserAuthenticated", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.isUserAuthenticated", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies whether the agent user associated with this session\nis authenticated.", + "heading": "Description" + } + ], + "signature": "isUserAuthenticated(): boolean", + "source": "script-api", + "tags": [ + "isuserauthenticated", + "session.isuserauthenticated" + ], + "title": "Session.isUserAuthenticated" + }, + { + "description": "Returns information on the last source code handled by the session. This may or may not be the session's active source code, e.g., the last received source code was inactive and therefore was not set as the session's active source code.", + "id": "script-api:dw/system/Session#lastReceivedSourceCodeInfo", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.lastReceivedSourceCodeInfo", + "sections": [ + { + "body": "Returns information on the last source code handled by the session.\nThis may or may not be the session's active source code, e.g., the\nlast received source code was inactive and therefore was not\nset as the session's active source code.", + "heading": "Description" + } + ], + "signature": "readonly lastReceivedSourceCodeInfo: SourceCodeInfo", + "source": "script-api", + "tags": [ + "lastreceivedsourcecodeinfo", + "session.lastreceivedsourcecodeinfo" + ], + "title": "Session.lastReceivedSourceCodeInfo" + }, + { + "description": "Returns the session's custom privacy attributes. The attributes are stored for the lifetime of the session and are automatically cleared when the customer logs out.", + "id": "script-api:dw/system/Session#privacy", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.privacy", + "sections": [ + { + "body": "Returns the session's custom privacy attributes.\nThe attributes are stored for the lifetime of the session and are\nautomatically cleared when the customer logs out.", + "heading": "Description" + } + ], + "signature": "readonly privacy: CustomAttributes", + "source": "script-api", + "tags": [ + "privacy", + "session.privacy" + ], + "title": "Session.privacy" + }, + { + "description": "Returns the unique session id. This can safely be used as an identifier against external systems.", + "id": "script-api:dw/system/Session#sessionID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.sessionID", + "sections": [ + { + "body": "Returns the unique session id. This can safely be used as an identifier\nagainst external systems.", + "heading": "Description" + } + ], + "signature": "readonly sessionID: string", + "source": "script-api", + "tags": [ + "sessionid", + "session.sessionid" + ], + "title": "Session.sessionID" + }, + { + "description": "Sets the session currency.", + "id": "script-api:dw/system/Session#setCurrency", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "newCurrency", + "type": "Currency" + } + ], + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setCurrency", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the session currency.", + "heading": "Description" + } + ], + "signature": "setCurrency(newCurrency: Currency): void", + "source": "script-api", + "tags": [ + "setcurrency", + "session.setcurrency" + ], + "title": "Session.setCurrency" + }, + { + "description": "Applies the specified source code to the current session and basket. This API processes the source code exactly as if it were supplied on the URL query string, with the additional benefit of returning error information. If no input parameter is passed, then the active source code in the session and basket is removed. If a basket exists, and the modification fails, then the session is not written to either. This method may open and commit a transaction, if none is currently active.", + "id": "script-api:dw/system/Session#setSourceCode", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "sourceCode", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setSourceCode", + "returns": { + "type": "Status" + }, + "sections": [ + { + "body": "Applies the specified source code to the current session and basket. This API processes the source code exactly as if it\nwere supplied on the URL query string, with the additional benefit of returning error information. If no input\nparameter is passed, then the active source code in the session and basket is removed. If a basket exists, and the modification fails,\nthen the session is not written to either. This method may open and commit a transaction, if none is currently active.", + "heading": "Description" + } + ], + "signature": "setSourceCode(sourceCode: string): Status", + "source": "script-api", + "tags": [ + "setsourcecode", + "session.setsourcecode" + ], + "title": "Session.setSourceCode" + }, + { + "description": "Sets the tracking allowed flag for the session. If tracking is not allowed, multiple services depending on tracking will be restricted or disabled: Predictive Intelligence recommendations, Active Data, Analytics of the customer behavior in the storefront. Additionally, collected clicks in the session click stream will be cleared. Setting this property to either value also results in setting a session-scoped cookie named \"dw_dnt\" (1=DoNotTrack; 0=Track)", + "id": "script-api:dw/system/Session#setTrackingAllowed", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "trackingAllowed", + "type": "boolean" + } + ], + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.setTrackingAllowed", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the tracking allowed flag for the session. If tracking is not allowed, multiple services\ndepending on tracking will be restricted or disabled: Predictive Intelligence recommendations,\nActive Data, Analytics of the customer behavior in the storefront.\nAdditionally, collected clicks in the session click stream will be cleared.\nSetting this property to either value also results in setting a session-scoped cookie named \"dw_dnt\"\n(1=DoNotTrack; 0=Track)", + "heading": "Description" + } + ], + "signature": "setTrackingAllowed(trackingAllowed: boolean): void", + "source": "script-api", + "tags": [ + "settrackingallowed", + "session.settrackingallowed" + ], + "title": "Session.setTrackingAllowed" + }, + { + "description": "Returns information on the session's active source-code.", + "id": "script-api:dw/system/Session#sourceCodeInfo", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.sourceCodeInfo", + "sections": [ + { + "body": "Returns information on the session's active source-code.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeInfo: SourceCodeInfo", + "source": "script-api", + "tags": [ + "sourcecodeinfo", + "session.sourcecodeinfo" + ], + "title": "Session.sourceCodeInfo" + }, + { + "description": "Returns whether the tracking allowed flag is set in the session. The value for newly created sessions defaults to the Site Preference \"TrackingAllowed\" unless a cookie named \"dw_dnt\" is found in which case the cookie value takes precedence.", + "id": "script-api:dw/system/Session#trackingAllowed", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.trackingAllowed", + "sections": [ + { + "body": "Returns whether the tracking allowed flag is set in the session.\nThe value for newly created sessions defaults to the Site Preference \"TrackingAllowed\" unless\na cookie named \"dw_dnt\" is found in which case the cookie value takes precedence.", + "heading": "Description" + } + ], + "signature": "trackingAllowed: boolean", + "source": "script-api", + "tags": [ + "trackingallowed", + "session.trackingallowed" + ], + "title": "Session.trackingAllowed" + }, + { + "description": "Identifies whether the agent user associated with this session is authenticated.", + "id": "script-api:dw/system/Session#userAuthenticated", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.userAuthenticated", + "sections": [ + { + "body": "Identifies whether the agent user associated with this session\nis authenticated.", + "heading": "Description" + } + ], + "signature": "readonly userAuthenticated: boolean", + "source": "script-api", + "tags": [ + "userauthenticated", + "session.userauthenticated" + ], + "title": "Session.userAuthenticated" + }, + { + "description": "Returns the current agent user name associated with this session.", + "id": "script-api:dw/system/Session#userName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Session", + "qualifiedName": "dw.system.Session.userName", + "sections": [ + { + "body": "Returns the current agent user name associated with this session.\n\nNote: this class allows access to sensitive security-related data.\nPay special attention to PCI DSS v3 requirements 2, 4, and 12.", + "heading": "Description" + } + ], + "signature": "readonly userName: string", + "source": "script-api", + "tags": [ + "username", + "session.username" + ], + "title": "Session.userName" + }, + { + "description": "This class represents a site in Commerce Cloud Digital and provides access to several site-level configuration values which are managed from within the Business Manager. It is only possible to get a reference to the current site as determined by the current request. The static method dw.system.Site.getCurrent returns a reference to the current site.", + "id": "script-api:dw/system/Site", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Site", + "sections": [ + { + "body": "This class represents a site in Commerce Cloud Digital and provides access to\nseveral site-level configuration values which are managed from within the\nBusiness Manager. It is only possible to get a reference to the current site\nas determined by the current request. The static method\ndw.system.Site.getCurrent returns a reference to the current site.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "site", + "dw.system.site", + "dw/system" + ], + "title": "Site" + }, + { + "description": "Returns the ID of the site.", + "id": "script-api:dw/system/Site#ID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.ID", + "sections": [ + { + "body": "Returns the ID of the site.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "site.id" + ], + "title": "Site.ID" + }, + { + "deprecated": {}, + "description": "Whether oms is active in the current site. This depends on a general property which states whether oms is active for the server, and a site-dependent preference whether oms is available for the current site.", + "id": "script-api:dw/system/Site#OMSEnabled", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.OMSEnabled", + "sections": [ + { + "body": "Whether oms is active in the current site. This depends on a general\nproperty which states whether oms is active for the server,\nand a site-dependent preference whether oms is available for the current site.", + "heading": "Description" + } + ], + "signature": "readonly OMSEnabled: boolean", + "source": "script-api", + "tags": [ + "omsenabled", + "site.omsenabled" + ], + "title": "Site.OMSEnabled" + }, + { + "description": "Constant that represents the Site under maintenance/offline", + "id": "script-api:dw/system/Site#SITE_STATUS_MAINTENANCE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_MAINTENANCE", + "sections": [ + { + "body": "Constant that represents the Site under maintenance/offline", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_MAINTENANCE = 3", + "source": "script-api", + "tags": [ + "site_status_maintenance", + "site.site_status_maintenance" + ], + "title": "Site.SITE_STATUS_MAINTENANCE" + }, + { + "description": "Constant that represents the Site under maintenance/offline", + "id": "script-api:dw/system/Site#SITE_STATUS_MAINTENANCE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_MAINTENANCE", + "sections": [ + { + "body": "Constant that represents the Site under maintenance/offline", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_MAINTENANCE = 3", + "source": "script-api", + "tags": [ + "site_status_maintenance", + "site.site_status_maintenance" + ], + "title": "Site.SITE_STATUS_MAINTENANCE" + }, + { + "description": "Constant that represents the Site is Online", + "id": "script-api:dw/system/Site#SITE_STATUS_ONLINE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_ONLINE", + "sections": [ + { + "body": "Constant that represents the Site is Online", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_ONLINE = 1", + "source": "script-api", + "tags": [ + "site_status_online", + "site.site_status_online" + ], + "title": "Site.SITE_STATUS_ONLINE" + }, + { + "description": "Constant that represents the Site is Online", + "id": "script-api:dw/system/Site#SITE_STATUS_ONLINE", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_ONLINE", + "sections": [ + { + "body": "Constant that represents the Site is Online", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_ONLINE = 1", + "source": "script-api", + "tags": [ + "site_status_online", + "site.site_status_online" + ], + "title": "Site.SITE_STATUS_ONLINE" + }, + { + "description": "Constant that represents the Site is in preview mode or online/password (protected)", + "id": "script-api:dw/system/Site#SITE_STATUS_PROTECTED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_PROTECTED", + "sections": [ + { + "body": "Constant that represents the Site is in preview mode or online/password (protected)", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_PROTECTED = 5", + "source": "script-api", + "tags": [ + "site_status_protected", + "site.site_status_protected" + ], + "title": "Site.SITE_STATUS_PROTECTED" + }, + { + "description": "Constant that represents the Site is in preview mode or online/password (protected)", + "id": "script-api:dw/system/Site#SITE_STATUS_PROTECTED", + "kind": "constant", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.SITE_STATUS_PROTECTED", + "sections": [ + { + "body": "Constant that represents the Site is in preview mode or online/password (protected)", + "heading": "Description" + } + ], + "signature": "static readonly SITE_STATUS_PROTECTED = 5", + "source": "script-api", + "tags": [ + "site_status_protected", + "site.site_status_protected" + ], + "title": "Site.SITE_STATUS_PROTECTED" + }, + { + "description": "Returns all sites.", + "id": "script-api:dw/system/Site#allSites", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allSites", + "sections": [ + { + "body": "Returns all sites.", + "heading": "Description" + } + ], + "signature": "static readonly allSites: List", + "source": "script-api", + "tags": [ + "allsites", + "site.allsites" + ], + "title": "Site.allSites" + }, + { + "description": "Returns all sites.", + "id": "script-api:dw/system/Site#allSites", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allSites", + "sections": [ + { + "body": "Returns all sites.", + "heading": "Description" + } + ], + "signature": "static readonly allSites: List", + "source": "script-api", + "tags": [ + "allsites", + "site.allsites" + ], + "title": "Site.allSites" + }, + { + "description": "Returns the allowed currencies of the current site as a collection of currency codes.", + "id": "script-api:dw/system/Site#allowedCurrencies", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allowedCurrencies", + "sections": [ + { + "body": "Returns the allowed currencies of the current site as a collection of\ncurrency codes.", + "heading": "Description" + } + ], + "signature": "readonly allowedCurrencies: List", + "source": "script-api", + "tags": [ + "allowedcurrencies", + "site.allowedcurrencies" + ], + "title": "Site.allowedCurrencies" + }, + { + "description": "Returns the allowed locales of the current site as a collection of locale ID's.", + "id": "script-api:dw/system/Site#allowedLocales", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.allowedLocales", + "sections": [ + { + "body": "Returns the allowed locales of the current site as a collection of\nlocale ID's.", + "heading": "Description" + } + ], + "signature": "readonly allowedLocales: List", + "source": "script-api", + "tags": [ + "allowedlocales", + "site.allowedlocales" + ], + "title": "Site.allowedLocales" + }, + { + "description": "Returns a new Calendar object in the time zone of the current site.", + "id": "script-api:dw/system/Site#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.calendar", + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static readonly calendar: Calendar", + "source": "script-api", + "tags": [ + "calendar", + "site.calendar" + ], + "title": "Site.calendar" + }, + { + "description": "Returns a new Calendar object in the time zone of the current site.", + "id": "script-api:dw/system/Site#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.calendar", + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static readonly calendar: Calendar", + "source": "script-api", + "tags": [ + "calendar", + "site.calendar" + ], + "title": "Site.calendar" + }, + { + "deprecated": { + "message": "Use getDefaultCurrency method instead," + }, + "description": "Returns the default currency code for the current site.", + "id": "script-api:dw/system/Site#currencyCode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.currencyCode", + "sections": [ + { + "body": "Returns the default currency code for the current site.", + "heading": "Description" + } + ], + "signature": "readonly currencyCode: string", + "source": "script-api", + "tags": [ + "currencycode", + "site.currencycode" + ], + "title": "Site.currencyCode" + }, + { + "description": "Returns the current site.", + "id": "script-api:dw/system/Site#current", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.current", + "sections": [ + { + "body": "Returns the current site.", + "heading": "Description" + } + ], + "signature": "static readonly current: Site", + "source": "script-api", + "tags": [ + "current", + "site.current" + ], + "title": "Site.current" + }, + { + "description": "Returns the current site.", + "id": "script-api:dw/system/Site#current", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.current", + "sections": [ + { + "body": "Returns the current site.", + "heading": "Description" + } + ], + "signature": "static readonly current: Site", + "source": "script-api", + "tags": [ + "current", + "site.current" + ], + "title": "Site.current" + }, + { + "description": "Returns the default currency code for the current site.", + "id": "script-api:dw/system/Site#defaultCurrency", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.defaultCurrency", + "sections": [ + { + "body": "Returns the default currency code for the current site.", + "heading": "Description" + } + ], + "signature": "readonly defaultCurrency: string", + "source": "script-api", + "tags": [ + "defaultcurrency", + "site.defaultcurrency" + ], + "title": "Site.defaultCurrency" + }, + { + "description": "Return default locale for the site.", + "id": "script-api:dw/system/Site#defaultLocale", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.defaultLocale", + "sections": [ + { + "body": "Return default locale for the site.", + "heading": "Description" + } + ], + "signature": "readonly defaultLocale: string", + "source": "script-api", + "tags": [ + "defaultlocale", + "site.defaultlocale" + ], + "title": "Site.defaultLocale" + }, + { + "description": "Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id. It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm. Used when making calls to the Einstein APIs.", + "id": "script-api:dw/system/Site#einsteinSiteID", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.einsteinSiteID", + "sections": [ + { + "body": "Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id.\nIt can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm.\nUsed when making calls to the Einstein APIs.", + "heading": "Description" + } + ], + "signature": "readonly einsteinSiteID: string", + "source": "script-api", + "tags": [ + "einsteinsiteid", + "site.einsteinsiteid" + ], + "title": "Site.einsteinSiteID" + }, + { + "description": "Returns all sites.", + "id": "script-api:dw/system/Site#getAllSites", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllSites", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all sites.", + "heading": "Description" + } + ], + "signature": "static getAllSites(): List", + "source": "script-api", + "tags": [ + "getallsites", + "site.getallsites" + ], + "title": "Site.getAllSites" + }, + { + "description": "Returns all sites.", + "id": "script-api:dw/system/Site#getAllSites", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllSites", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all sites.", + "heading": "Description" + } + ], + "signature": "static getAllSites(): List", + "source": "script-api", + "tags": [ + "getallsites", + "site.getallsites" + ], + "title": "Site.getAllSites" + }, + { + "description": "Returns the allowed currencies of the current site as a collection of currency codes.", + "id": "script-api:dw/system/Site#getAllowedCurrencies", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllowedCurrencies", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the allowed currencies of the current site as a collection of\ncurrency codes.", + "heading": "Description" + } + ], + "signature": "getAllowedCurrencies(): List", + "source": "script-api", + "tags": [ + "getallowedcurrencies", + "site.getallowedcurrencies" + ], + "title": "Site.getAllowedCurrencies" + }, + { + "description": "Returns the allowed locales of the current site as a collection of locale ID's.", + "id": "script-api:dw/system/Site#getAllowedLocales", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getAllowedLocales", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the allowed locales of the current site as a collection of\nlocale ID's.", + "heading": "Description" + } + ], + "signature": "getAllowedLocales(): List", + "source": "script-api", + "tags": [ + "getallowedlocales", + "site.getallowedlocales" + ], + "title": "Site.getAllowedLocales" + }, + { + "description": "Returns a new Calendar object in the time zone of the current site.", + "id": "script-api:dw/system/Site#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCalendar", + "returns": { + "type": "Calendar" + }, + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static getCalendar(): Calendar", + "source": "script-api", + "tags": [ + "getcalendar", + "site.getcalendar" + ], + "title": "Site.getCalendar" + }, + { + "description": "Returns a new Calendar object in the time zone of the current site.", + "id": "script-api:dw/system/Site#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCalendar", + "returns": { + "type": "Calendar" + }, + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static getCalendar(): Calendar", + "source": "script-api", + "tags": [ + "getcalendar", + "site.getcalendar" + ], + "title": "Site.getCalendar" + }, + { + "deprecated": { + "message": "Use getDefaultCurrency method instead," + }, + "description": "Returns the default currency code for the current site.", + "id": "script-api:dw/system/Site#getCurrencyCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrencyCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the default currency code for the current site.", + "heading": "Description" + } + ], + "signature": "getCurrencyCode(): string", + "source": "script-api", + "tags": [ + "getcurrencycode", + "site.getcurrencycode" + ], + "title": "Site.getCurrencyCode" + }, + { + "description": "Returns the current site.", + "id": "script-api:dw/system/Site#getCurrent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrent", + "returns": { + "type": "Site" + }, + "sections": [ + { + "body": "Returns the current site.", + "heading": "Description" + } + ], + "signature": "static getCurrent(): Site", + "source": "script-api", + "tags": [ + "getcurrent", + "site.getcurrent" + ], + "title": "Site.getCurrent" + }, + { + "description": "Returns the current site.", + "id": "script-api:dw/system/Site#getCurrent", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCurrent", + "returns": { + "type": "Site" + }, + "sections": [ + { + "body": "Returns the current site.", + "heading": "Description" + } + ], + "signature": "static getCurrent(): Site", + "source": "script-api", + "tags": [ + "getcurrent", + "site.getcurrent" + ], + "title": "Site.getCurrent" + }, + { + "description": "Returns a custom preference value. If the preference does not exist the method returns null. This method is simply a shortcut method for accessing the value for a custom attribute defined on the dw.system.SitePreferences object.", + "id": "script-api:dw/system/Site#getCustomPreferenceValue", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "name", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getCustomPreferenceValue", + "returns": { + "type": "any | null" + }, + "sections": [ + { + "body": "Returns a custom preference value. If the preference does not exist the\nmethod returns null. This method is simply a shortcut method for\naccessing the value for a custom attribute defined on the\ndw.system.SitePreferences object.", + "heading": "Description" + } + ], + "signature": "getCustomPreferenceValue(name: string): any | null", + "source": "script-api", + "tags": [ + "getcustompreferencevalue", + "site.getcustompreferencevalue" + ], + "title": "Site.getCustomPreferenceValue" + }, + { + "description": "Returns the default currency code for the current site.", + "id": "script-api:dw/system/Site#getDefaultCurrency", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getDefaultCurrency", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the default currency code for the current site.", + "heading": "Description" + } + ], + "signature": "getDefaultCurrency(): string", + "source": "script-api", + "tags": [ + "getdefaultcurrency", + "site.getdefaultcurrency" + ], + "title": "Site.getDefaultCurrency" + }, + { + "description": "Return default locale for the site.", + "id": "script-api:dw/system/Site#getDefaultLocale", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getDefaultLocale", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Return default locale for the site.", + "heading": "Description" + } + ], + "signature": "getDefaultLocale(): string", + "source": "script-api", + "tags": [ + "getdefaultlocale", + "site.getdefaultlocale" + ], + "title": "Site.getDefaultLocale" + }, + { + "description": "Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id. It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm. Used when making calls to the Einstein APIs.", + "id": "script-api:dw/system/Site#getEinsteinSiteID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getEinsteinSiteID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id.\nIt can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm.\nUsed when making calls to the Einstein APIs.", + "heading": "Description" + } + ], + "signature": "getEinsteinSiteID(): string", + "source": "script-api", + "tags": [ + "geteinsteinsiteid", + "site.geteinsteinsiteid" + ], + "title": "Site.getEinsteinSiteID" + }, + { + "description": "Returns the configured HTTP host name. If no host name is configured the method returns the instance hostname.", + "id": "script-api:dw/system/Site#getHttpHostName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getHttpHostName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the configured HTTP host name. If no host name\nis configured the method returns the instance hostname.", + "heading": "Description" + } + ], + "signature": "getHttpHostName(): string", + "source": "script-api", + "tags": [ + "gethttphostname", + "site.gethttphostname" + ], + "title": "Site.getHttpHostName" + }, + { + "description": "Returns the configured HTTPS host name. If no host name is configured the method returns the HTTP host name or the instance hostname, if that is not configured as well.", + "id": "script-api:dw/system/Site#getHttpsHostName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getHttpsHostName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the configured HTTPS host name. If no host name\nis configured the method returns the HTTP host name or the instance hostname, if\nthat is not configured as well.", + "heading": "Description" + } + ], + "signature": "getHttpsHostName(): string", + "source": "script-api", + "tags": [ + "gethttpshostname", + "site.gethttpshostname" + ], + "title": "Site.getHttpsHostName" + }, + { + "description": "Returns the ID of the site.", + "id": "script-api:dw/system/Site#getID", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ID of the site.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "site.getid" + ], + "title": "Site.getID" + }, + { + "description": "Returns a descriptive name for the site.", + "id": "script-api:dw/system/Site#getName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a descriptive name for the site.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "site.getname" + ], + "title": "Site.getName" + }, + { + "description": "Returns the page meta tag for the specified id.", + "id": "script-api:dw/system/Site#getPageMetaTag", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "id", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPageMetaTag", + "returns": { + "type": "PageMetaTag | null" + }, + "sections": [ + { + "body": "Returns the page meta tag for the specified id.\n\nThe meta tag content is generated based on the home page meta tag context and rule.\nThe rule is obtained from the current repository domain.\n\nNull will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the\ncurrent context, or if the rule resolves to an empty string.", + "heading": "Description" + } + ], + "signature": "getPageMetaTag(id: string): PageMetaTag | null", + "source": "script-api", + "tags": [ + "getpagemetatag", + "site.getpagemetatag" + ], + "title": "Site.getPageMetaTag" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/system/Site#getPageMetaTags", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPageMetaTags", + "returns": { + "type": "Array" + }, + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the home page meta tag context and rules.\nThe rules are obtained from the current repository domain.", + "heading": "Description" + } + ], + "signature": "getPageMetaTags(): Array", + "source": "script-api", + "tags": [ + "getpagemetatags", + "site.getpagemetatags" + ], + "title": "Site.getPageMetaTags" + }, + { + "description": "This method returns a container of all site preferences of this site.", + "id": "script-api:dw/system/Site#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getPreferences", + "returns": { + "type": "SitePreferences" + }, + "sections": [ + { + "body": "This method returns a container of all site preferences of this site.", + "heading": "Description" + } + ], + "signature": "getPreferences(): SitePreferences", + "source": "script-api", + "tags": [ + "getpreferences", + "site.getpreferences" + ], + "title": "Site.getPreferences" + }, + { + "description": "Returns the status of this site.", + "id": "script-api:dw/system/Site#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getStatus", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status of this site.\n\nPossible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED", + "heading": "Description" + } + ], + "signature": "getStatus(): number", + "source": "script-api", + "tags": [ + "getstatus", + "site.getstatus" + ], + "title": "Site.getStatus" + }, + { + "description": "Returns the code for the time zone in which the storefront is running.", + "id": "script-api:dw/system/Site#getTimezone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getTimezone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the code for the time zone in which the storefront is\nrunning.", + "heading": "Description" + } + ], + "signature": "getTimezone(): string", + "source": "script-api", + "tags": [ + "gettimezone", + "site.gettimezone" + ], + "title": "Site.getTimezone" + }, + { + "description": "Returns time zone offset in which the storefront is running.", + "id": "script-api:dw/system/Site#getTimezoneOffset", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.getTimezoneOffset", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns time zone offset in which the storefront is running.", + "heading": "Description" + } + ], + "signature": "getTimezoneOffset(): number", + "source": "script-api", + "tags": [ + "gettimezoneoffset", + "site.gettimezoneoffset" + ], + "title": "Site.getTimezoneOffset" + }, + { + "description": "Returns the configured HTTP host name. If no host name is configured the method returns the instance hostname.", + "id": "script-api:dw/system/Site#httpHostName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.httpHostName", + "sections": [ + { + "body": "Returns the configured HTTP host name. If no host name\nis configured the method returns the instance hostname.", + "heading": "Description" + } + ], + "signature": "readonly httpHostName: string", + "source": "script-api", + "tags": [ + "httphostname", + "site.httphostname" + ], + "title": "Site.httpHostName" + }, + { + "description": "Returns the configured HTTPS host name. If no host name is configured the method returns the HTTP host name or the instance hostname, if that is not configured as well.", + "id": "script-api:dw/system/Site#httpsHostName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.httpsHostName", + "sections": [ + { + "body": "Returns the configured HTTPS host name. If no host name\nis configured the method returns the HTTP host name or the instance hostname, if\nthat is not configured as well.", + "heading": "Description" + } + ], + "signature": "readonly httpsHostName: string", + "source": "script-api", + "tags": [ + "httpshostname", + "site.httpshostname" + ], + "title": "Site.httpsHostName" + }, + { + "deprecated": {}, + "description": "Whether oms is active in the current site. This depends on a general property which states whether oms is active for the server, and a site-dependent preference whether oms is available for the current site.", + "id": "script-api:dw/system/Site#isOMSEnabled", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.isOMSEnabled", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Whether oms is active in the current site. This depends on a general\nproperty which states whether oms is active for the server,\nand a site-dependent preference whether oms is available for the current site.", + "heading": "Description" + } + ], + "signature": "isOMSEnabled(): boolean", + "source": "script-api", + "tags": [ + "isomsenabled", + "site.isomsenabled" + ], + "title": "Site.isOMSEnabled" + }, + { + "description": "Returns a descriptive name for the site.", + "id": "script-api:dw/system/Site#name", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.name", + "sections": [ + { + "body": "Returns a descriptive name for the site.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "site.name" + ], + "title": "Site.name" + }, + { + "description": "Returns all page meta tags, defined for this instance for which content can be generated.", + "id": "script-api:dw/system/Site#pageMetaTags", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.pageMetaTags", + "sections": [ + { + "body": "Returns all page meta tags, defined for this instance for which content can be generated.\n\nThe meta tag content is generated based on the home page meta tag context and rules.\nThe rules are obtained from the current repository domain.", + "heading": "Description" + } + ], + "signature": "readonly pageMetaTags: Array", + "source": "script-api", + "tags": [ + "pagemetatags", + "site.pagemetatags" + ], + "title": "Site.pageMetaTags" + }, + { + "description": "This method returns a container of all site preferences of this site.", + "id": "script-api:dw/system/Site#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.preferences", + "sections": [ + { + "body": "This method returns a container of all site preferences of this site.", + "heading": "Description" + } + ], + "signature": "readonly preferences: SitePreferences", + "source": "script-api", + "tags": [ + "preferences", + "site.preferences" + ], + "title": "Site.preferences" + }, + { + "description": "The method sets a value for a custom preference. The type of the value must match with the declared type of the preference definition.", + "id": "script-api:dw/system/Site#setCustomPreferenceValue", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.setCustomPreferenceValue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "The method sets a value for a custom preference. The type of the value\nmust match with the declared type of the preference definition.", + "heading": "Description" + } + ], + "signature": "setCustomPreferenceValue(name: string, value: any): void", + "source": "script-api", + "tags": [ + "setcustompreferencevalue", + "site.setcustompreferencevalue" + ], + "title": "Site.setCustomPreferenceValue" + }, + { + "description": "Returns the status of this site.", + "id": "script-api:dw/system/Site#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.status", + "sections": [ + { + "body": "Returns the status of this site.\n\nPossible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED", + "heading": "Description" + } + ], + "signature": "readonly status: number", + "source": "script-api", + "tags": [ + "status", + "site.status" + ], + "title": "Site.status" + }, + { + "description": "Returns the code for the time zone in which the storefront is running.", + "id": "script-api:dw/system/Site#timezone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.timezone", + "sections": [ + { + "body": "Returns the code for the time zone in which the storefront is\nrunning.", + "heading": "Description" + } + ], + "signature": "readonly timezone: string", + "source": "script-api", + "tags": [ + "timezone", + "site.timezone" + ], + "title": "Site.timezone" + }, + { + "description": "Returns time zone offset in which the storefront is running.", + "id": "script-api:dw/system/Site#timezoneOffset", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Site", + "qualifiedName": "dw.system.Site.timezoneOffset", + "sections": [ + { + "body": "Returns time zone offset in which the storefront is running.", + "heading": "Description" + } + ], + "signature": "readonly timezoneOffset: number", + "source": "script-api", + "tags": [ + "timezoneoffset", + "site.timezoneoffset" + ], + "title": "Site.timezoneOffset" + }, + { + "description": "SitePreferences is a container for custom site-level attributes. The object corresponds with system object type \"SitePreferences\". It has no system attributes and exists only as a place for merchants to define custom attributes which need to be available for each site.", + "examples": [ + "var sitePrefs : SitePreferences = dw.system.Site.getCurrent().getPreferences();\nvar mySitePrefValue : String = sitePrefs.getCustom()[\"mySitePref\"];" + ], + "id": "script-api:dw/system/SitePreferences", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.SitePreferences", + "sections": [ + { + "body": "SitePreferences is a container for custom site-level attributes. The object\ncorresponds with system object type \"SitePreferences\". It has no system\nattributes and exists only as a place for merchants to define custom\nattributes which need to be available for each site.\n\nLogically there is only one SitePreferences instance per site. The instance\nis obtained by calling dw.system.Site.getPreferences. Once an\ninstance of the container is obtained, it is possible to read/write site\npreference values by using the usual syntax for\ndw.object.ExtensibleObject instances. For example:\n\n\nNote: this class allows access to sensitive security-related data.\nPay special attention to PCI DSS v3. requirements 2, 4, and 12.\n\nCommerce Cloud Digital defines many site-level preferences, relating to\nbaskets, timezone, locales, customers, etc, which can be managed within the\n\"Site Preferences\" module of the Business Manager, but these preferences are\nnot accessible through this object. (SourceCodeURLParameterName is the one\nexception to this rule.)", + "heading": "Description" + }, + { + "body": "Extends `ExtensibleObject`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "sitepreferences", + "dw.system.sitepreferences", + "dw/system" + ], + "title": "SitePreferences" + }, + { + "description": "Returns the name of the source code url paremeter configured for the site.", + "id": "script-api:dw/system/SitePreferences#getSourceCodeURLParameterName", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SitePreferences", + "qualifiedName": "dw.system.SitePreferences.getSourceCodeURLParameterName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the name of the source code url paremeter configured for the\nsite.", + "heading": "Description" + } + ], + "signature": "getSourceCodeURLParameterName(): string", + "source": "script-api", + "tags": [ + "getsourcecodeurlparametername", + "sitepreferences.getsourcecodeurlparametername" + ], + "title": "SitePreferences.getSourceCodeURLParameterName" + }, + { + "description": "Returns the name of the source code url paremeter configured for the site.", + "id": "script-api:dw/system/SitePreferences#sourceCodeURLParameterName", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/SitePreferences", + "qualifiedName": "dw.system.SitePreferences.sourceCodeURLParameterName", + "sections": [ + { + "body": "Returns the name of the source code url paremeter configured for the\nsite.", + "heading": "Description" + } + ], + "signature": "readonly sourceCodeURLParameterName: string", + "source": "script-api", + "tags": [ + "sourcecodeurlparametername", + "sitepreferences.sourcecodeurlparametername" + ], + "title": "SitePreferences.sourceCodeURLParameterName" + }, + { + "description": "A Status is used for communicating an API status code back to a client. A status consists of multiple StatusItem. Most often a Status contains only one StatusItem. For convenience, a message with parameters is formatted using standard formatting patterns. If you want to display locale-specific messages in your application, you should use the Status.getCode() as key for a resource bundle.", + "id": "script-api:dw/system/Status", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Status", + "sections": [ + { + "body": "A Status is used for communicating an API status code back to a client. A status\nconsists of multiple StatusItem. Most often a Status contains only one StatusItem.\nFor convenience, a message with parameters is formatted using standard\nformatting patterns. If you want to display locale-specific messages in your\napplication, you should use the Status.getCode() as key for a resource bundle.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "status", + "dw.system.status", + "dw/system" + ], + "title": "Status" + }, + { + "description": "status value to indicate an ERROR status", + "id": "script-api:dw/system/Status#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.ERROR", + "sections": [ + { + "body": "status value to indicate an ERROR status", + "heading": "Description" + } + ], + "signature": "static ERROR: number", + "source": "script-api", + "tags": [ + "error", + "status.error" + ], + "title": "Status.ERROR" + }, + { + "description": "status value to indicate an ERROR status", + "id": "script-api:dw/system/Status#ERROR", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.ERROR", + "sections": [ + { + "body": "status value to indicate an ERROR status", + "heading": "Description" + } + ], + "signature": "static ERROR: number", + "source": "script-api", + "tags": [ + "error", + "status.error" + ], + "title": "Status.ERROR" + }, + { + "description": "status value to indicate an OK status", + "id": "script-api:dw/system/Status#OK", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.OK", + "sections": [ + { + "body": "status value to indicate an OK status", + "heading": "Description" + } + ], + "signature": "static OK: number", + "source": "script-api", + "tags": [ + "ok", + "status.ok" + ], + "title": "Status.OK" + }, + { + "description": "status value to indicate an OK status", + "id": "script-api:dw/system/Status#OK", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.OK", + "sections": [ + { + "body": "status value to indicate an OK status", + "heading": "Description" + } + ], + "signature": "static OK: number", + "source": "script-api", + "tags": [ + "ok", + "status.ok" + ], + "title": "Status.OK" + }, + { + "description": "Add detail information for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#addDetail", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.addDetail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Add detail information for the given key of the first ERROR StatusItem\nor when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "heading": "Description" + } + ], + "signature": "addDetail(key: string, value: any): void", + "source": "script-api", + "tags": [ + "adddetail", + "status.adddetail" + ], + "title": "Status.addDetail" + }, + { + "description": "Adds an additional status item to this status instance.", + "id": "script-api:dw/system/Status#addItem", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "item", + "type": "StatusItem" + } + ], + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.addItem", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds an additional status item to this status instance.", + "heading": "Description" + } + ], + "signature": "addItem(item: StatusItem): void", + "source": "script-api", + "tags": [ + "additem", + "status.additem" + ], + "title": "Status.addItem" + }, + { + "description": "Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#code", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.code", + "sections": [ + { + "body": "Returns the status code either of the first ERROR StatusItem or when there\nis no ERROR StatusITEM, the first StatusItem in the overall list.\n\nThe status code is the unique identifier for the message and can be used by\nclient programs to check for a specific status and to generate a localized\nmessage.", + "heading": "Description" + } + ], + "signature": "readonly code: string", + "source": "script-api", + "tags": [ + "code", + "status.code" + ], + "title": "Status.code" + }, + { + "description": "Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#details", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.details", + "sections": [ + { + "body": "Returns the details either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.", + "heading": "Description" + } + ], + "signature": "readonly details: utilMap", + "source": "script-api", + "tags": [ + "details", + "status.details" + ], + "title": "Status.details" + }, + { + "description": "Checks if the status is an ERROR. The Status is an ERROR if one of the contained StatusItems is an ERROR.", + "id": "script-api:dw/system/Status#error", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.error", + "sections": [ + { + "body": "Checks if the status is an ERROR. The Status is an ERROR if one of the\ncontained StatusItems is an ERROR.", + "heading": "Description" + } + ], + "signature": "readonly error: boolean", + "source": "script-api", + "tags": [ + "error", + "status.error" + ], + "title": "Status.error" + }, + { + "description": "Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#getCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the status code either of the first ERROR StatusItem or when there\nis no ERROR StatusITEM, the first StatusItem in the overall list.\n\nThe status code is the unique identifier for the message and can be used by\nclient programs to check for a specific status and to generate a localized\nmessage.", + "heading": "Description" + } + ], + "signature": "getCode(): string", + "source": "script-api", + "tags": [ + "getcode", + "status.getcode" + ], + "title": "Status.getCode" + }, + { + "description": "Returns the detail value for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#getDetail", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + } + ], + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getDetail", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the detail value for the given key of the first ERROR StatusItem\nor when there is no ERROR StatusItem, the first StatusItem in the\noverall list.", + "heading": "Description" + } + ], + "signature": "getDetail(key: string): any", + "source": "script-api", + "tags": [ + "getdetail", + "status.getdetail" + ], + "title": "Status.getDetail" + }, + { + "description": "Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#getDetails", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getDetails", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the details either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.", + "heading": "Description" + } + ], + "signature": "getDetails(): utilMap", + "source": "script-api", + "tags": [ + "getdetails", + "status.getdetails" + ], + "title": "Status.getDetails" + }, + { + "description": "Returns all status items.", + "id": "script-api:dw/system/Status#getItems", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getItems", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns all status items.", + "heading": "Description" + } + ], + "signature": "getItems(): List", + "source": "script-api", + "tags": [ + "getitems", + "status.getitems" + ], + "title": "Status.getItems" + }, + { + "description": "Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#getMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the message either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.\n\nNote: Custom code and client programs must not use this message to identify\na specific status. The getCode() must be used for that purpose. The actual\nmessage can change from release to release.", + "heading": "Description" + } + ], + "signature": "getMessage(): string", + "source": "script-api", + "tags": [ + "getmessage", + "status.getmessage" + ], + "title": "Status.getMessage" + }, + { + "description": "Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#getParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getParameters", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the parameters either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.", + "heading": "Description" + } + ], + "signature": "getParameters(): List", + "source": "script-api", + "tags": [ + "getparameters", + "status.getparameters" + ], + "title": "Status.getParameters" + }, + { + "description": "Returns the overall status. If all StatusItems are OK, the method returns OK. If one StatusItem is an ERROR it returns ERROR.", + "id": "script-api:dw/system/Status#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.getStatus", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the overall status. If all StatusItems are OK, the method returns\nOK. If one StatusItem is an ERROR it returns ERROR.", + "heading": "Description" + } + ], + "signature": "getStatus(): number", + "source": "script-api", + "tags": [ + "getstatus", + "status.getstatus" + ], + "title": "Status.getStatus" + }, + { + "description": "Checks if the status is an ERROR. The Status is an ERROR if one of the contained StatusItems is an ERROR.", + "id": "script-api:dw/system/Status#isError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.isError", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks if the status is an ERROR. The Status is an ERROR if one of the\ncontained StatusItems is an ERROR.", + "heading": "Description" + } + ], + "signature": "isError(): boolean", + "source": "script-api", + "tags": [ + "iserror", + "status.iserror" + ], + "title": "Status.isError" + }, + { + "description": "Returns all status items.", + "id": "script-api:dw/system/Status#items", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.items", + "sections": [ + { + "body": "Returns all status items.", + "heading": "Description" + } + ], + "signature": "readonly items: List", + "source": "script-api", + "tags": [ + "items", + "status.items" + ], + "title": "Status.items" + }, + { + "description": "Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#message", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.message", + "sections": [ + { + "body": "Returns the message either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.\n\nNote: Custom code and client programs must not use this message to identify\na specific status. The getCode() must be used for that purpose. The actual\nmessage can change from release to release.", + "heading": "Description" + } + ], + "signature": "readonly message: string", + "source": "script-api", + "tags": [ + "message", + "status.message" + ], + "title": "Status.message" + }, + { + "description": "Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.", + "id": "script-api:dw/system/Status#parameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.parameters", + "sections": [ + { + "body": "Returns the parameters either of the first ERROR StatusItem or when there\nis no ERROR StatusItem, the first StatusItem in the overall list.", + "heading": "Description" + } + ], + "signature": "readonly parameters: List", + "source": "script-api", + "tags": [ + "parameters", + "status.parameters" + ], + "title": "Status.parameters" + }, + { + "description": "Returns the overall status. If all StatusItems are OK, the method returns OK. If one StatusItem is an ERROR it returns ERROR.", + "id": "script-api:dw/system/Status#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Status", + "qualifiedName": "dw.system.Status.status", + "sections": [ + { + "body": "Returns the overall status. If all StatusItems are OK, the method returns\nOK. If one StatusItem is an ERROR it returns ERROR.", + "heading": "Description" + } + ], + "signature": "readonly status: number", + "source": "script-api", + "tags": [ + "status", + "status.status" + ], + "title": "Status.status" + }, + { + "description": "A StatusItem holds all the status information. Multi StatusItems are bundled together into a Status.", + "id": "script-api:dw/system/StatusItem", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.StatusItem", + "sections": [ + { + "body": "A StatusItem holds all the status information. Multi StatusItems are bundled\ntogether into a Status.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "statusitem", + "dw.system.statusitem", + "dw/system" + ], + "title": "StatusItem" + }, + { + "description": "Add an additional detail to this StatusItem.", + "id": "script-api:dw/system/StatusItem#addDetail", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "key", + "type": "string" + }, + { + "name": "value", + "type": "any" + } + ], + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.addDetail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Add an additional detail to this StatusItem.", + "heading": "Description" + } + ], + "signature": "addDetail(key: string, value: any): void", + "source": "script-api", + "tags": [ + "adddetail", + "statusitem.adddetail" + ], + "title": "StatusItem.addDetail" + }, + { + "description": "The status code is the unique identifier for the message and can be used by client programs to check for a specific status and to generate a localized message.", + "id": "script-api:dw/system/StatusItem#code", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.code", + "sections": [ + { + "body": "The status code is the unique identifier for the message and can be used by\nclient programs to check for a specific status and to generate a localized\nmessage.", + "heading": "Description" + } + ], + "signature": "code: string", + "source": "script-api", + "tags": [ + "code", + "statusitem.code" + ], + "title": "StatusItem.code" + }, + { + "description": "Returns the optional details for this StatusItem.", + "id": "script-api:dw/system/StatusItem#details", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.details", + "sections": [ + { + "body": "Returns the optional details for this StatusItem.", + "heading": "Description" + } + ], + "signature": "readonly details: utilMap", + "source": "script-api", + "tags": [ + "details", + "statusitem.details" + ], + "title": "StatusItem.details" + }, + { + "description": "Returns whether this Status Item represents and error.", + "id": "script-api:dw/system/StatusItem#error", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.error", + "sections": [ + { + "body": "Returns whether this Status Item represents and error.", + "heading": "Description" + } + ], + "signature": "readonly error: boolean", + "source": "script-api", + "tags": [ + "error", + "statusitem.error" + ], + "title": "StatusItem.error" + }, + { + "description": "The status code is the unique identifier for the message and can be used by client programs to check for a specific status and to generate a localized message.", + "id": "script-api:dw/system/StatusItem#getCode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "The status code is the unique identifier for the message and can be used by\nclient programs to check for a specific status and to generate a localized\nmessage.", + "heading": "Description" + } + ], + "signature": "getCode(): string", + "source": "script-api", + "tags": [ + "getcode", + "statusitem.getcode" + ], + "title": "StatusItem.getCode" + }, + { + "description": "Returns the optional details for this StatusItem.", + "id": "script-api:dw/system/StatusItem#getDetails", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getDetails", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns the optional details for this StatusItem.", + "heading": "Description" + } + ], + "signature": "getDetails(): utilMap", + "source": "script-api", + "tags": [ + "getdetails", + "statusitem.getdetails" + ], + "title": "StatusItem.getDetails" + }, + { + "description": "Returns the default human readable message for this Status.", + "id": "script-api:dw/system/StatusItem#getMessage", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getMessage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the default human readable message for this Status.\n\nNote: Custom code and client programs must not use this message to identify\na specific status. The getCode() must be used for that purpose. The actual\nmessage can change from release to release.", + "heading": "Description" + } + ], + "signature": "getMessage(): string", + "source": "script-api", + "tags": [ + "getmessage", + "statusitem.getmessage" + ], + "title": "StatusItem.getMessage" + }, + { + "description": "Returns the parameters to construct a custom message.", + "id": "script-api:dw/system/StatusItem#getParameters", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getParameters", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns the parameters to construct a custom message.", + "heading": "Description" + } + ], + "signature": "getParameters(): List", + "source": "script-api", + "tags": [ + "getparameters", + "statusitem.getparameters" + ], + "title": "StatusItem.getParameters" + }, + { + "description": "Returns the status.", + "id": "script-api:dw/system/StatusItem#getStatus", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.getStatus", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the status.", + "heading": "Description" + } + ], + "signature": "getStatus(): number", + "source": "script-api", + "tags": [ + "getstatus", + "statusitem.getstatus" + ], + "title": "StatusItem.getStatus" + }, + { + "description": "Returns whether this Status Item represents and error.", + "id": "script-api:dw/system/StatusItem#isError", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.isError", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns whether this Status Item represents and error.", + "heading": "Description" + } + ], + "signature": "isError(): boolean", + "source": "script-api", + "tags": [ + "iserror", + "statusitem.iserror" + ], + "title": "StatusItem.isError" + }, + { + "description": "Returns the default human readable message for this Status.", + "id": "script-api:dw/system/StatusItem#message", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.message", + "sections": [ + { + "body": "Returns the default human readable message for this Status.\n\nNote: Custom code and client programs must not use this message to identify\na specific status. The getCode() must be used for that purpose. The actual\nmessage can change from release to release.", + "heading": "Description" + } + ], + "signature": "message: string", + "source": "script-api", + "tags": [ + "message", + "statusitem.message" + ], + "title": "StatusItem.message" + }, + { + "description": "Returns the parameters to construct a custom message.", + "id": "script-api:dw/system/StatusItem#parameters", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.parameters", + "sections": [ + { + "body": "Returns the parameters to construct a custom message.", + "heading": "Description" + } + ], + "signature": "parameters: List", + "source": "script-api", + "tags": [ + "parameters", + "statusitem.parameters" + ], + "title": "StatusItem.parameters" + }, + { + "description": "Method to set the status code. The status code is the unique identifier for the message and can be used by client programs to check for a specific status and to generate a localized message.", + "id": "script-api:dw/system/StatusItem#setCode", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "code", + "type": "string" + } + ], + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setCode", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Method to set the status code.\nThe status code is the unique identifier for the message and can be used by\nclient programs to check for a specific status and to generate a localized\nmessage.", + "heading": "Description" + } + ], + "signature": "setCode(code: string): void", + "source": "script-api", + "tags": [ + "setcode", + "statusitem.setcode" + ], + "title": "StatusItem.setCode" + }, + { + "description": "Sets the default human readable message for this Status.", + "id": "script-api:dw/system/StatusItem#setMessage", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "message", + "type": "string" + } + ], + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setMessage", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the default human readable message for this Status.", + "heading": "Description" + } + ], + "signature": "setMessage(message: string): void", + "source": "script-api", + "tags": [ + "setmessage", + "statusitem.setmessage" + ], + "title": "StatusItem.setMessage" + }, + { + "description": "Sets the parameters for a custom message.", + "id": "script-api:dw/system/StatusItem#setParameters", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "parameters", + "type": "any[]" + } + ], + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setParameters", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the parameters for a custom message.", + "heading": "Description" + } + ], + "signature": "setParameters(parameters: any[]): void", + "source": "script-api", + "tags": [ + "setparameters", + "statusitem.setparameters" + ], + "title": "StatusItem.setParameters" + }, + { + "description": "Set the status.", + "id": "script-api:dw/system/StatusItem#setStatus", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "status", + "type": "number" + } + ], + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.setStatus", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Set the status.", + "heading": "Description" + } + ], + "signature": "setStatus(status: number): void", + "source": "script-api", + "tags": [ + "setstatus", + "statusitem.setstatus" + ], + "title": "StatusItem.setStatus" + }, + { + "description": "Returns the status.", + "id": "script-api:dw/system/StatusItem#status", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/StatusItem", + "qualifiedName": "dw.system.StatusItem.status", + "sections": [ + { + "body": "Returns the status.", + "heading": "Description" + } + ], + "signature": "status: number", + "source": "script-api", + "tags": [ + "status", + "statusitem.status" + ], + "title": "StatusItem.status" + }, + { + "description": "Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types, \"development system\", \"staging system\" or \"production system\".", + "id": "script-api:dw/system/System", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.System", + "sections": [ + { + "body": "Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types,\n\"development system\", \"staging system\" or \"production system\".", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "system", + "dw.system.system", + "dw/system" + ], + "title": "System" + }, + { + "description": "Represents the development system.", + "id": "script-api:dw/system/System#DEVELOPMENT_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.DEVELOPMENT_SYSTEM", + "sections": [ + { + "body": "Represents the development system.", + "heading": "Description" + } + ], + "signature": "static readonly DEVELOPMENT_SYSTEM: number", + "source": "script-api", + "tags": [ + "development_system", + "system.development_system" + ], + "title": "System.DEVELOPMENT_SYSTEM" + }, + { + "description": "Represents the development system.", + "id": "script-api:dw/system/System#DEVELOPMENT_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.DEVELOPMENT_SYSTEM", + "sections": [ + { + "body": "Represents the development system.", + "heading": "Description" + } + ], + "signature": "static readonly DEVELOPMENT_SYSTEM: number", + "source": "script-api", + "tags": [ + "development_system", + "system.development_system" + ], + "title": "System.DEVELOPMENT_SYSTEM" + }, + { + "description": "Represents the production system.", + "id": "script-api:dw/system/System#PRODUCTION_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.PRODUCTION_SYSTEM", + "sections": [ + { + "body": "Represents the production system.", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCTION_SYSTEM: number", + "source": "script-api", + "tags": [ + "production_system", + "system.production_system" + ], + "title": "System.PRODUCTION_SYSTEM" + }, + { + "description": "Represents the production system.", + "id": "script-api:dw/system/System#PRODUCTION_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.PRODUCTION_SYSTEM", + "sections": [ + { + "body": "Represents the production system.", + "heading": "Description" + } + ], + "signature": "static readonly PRODUCTION_SYSTEM: number", + "source": "script-api", + "tags": [ + "production_system", + "system.production_system" + ], + "title": "System.PRODUCTION_SYSTEM" + }, + { + "description": "Represents the staging system.", + "id": "script-api:dw/system/System#STAGING_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.STAGING_SYSTEM", + "sections": [ + { + "body": "Represents the staging system.", + "heading": "Description" + } + ], + "signature": "static readonly STAGING_SYSTEM: number", + "source": "script-api", + "tags": [ + "staging_system", + "system.staging_system" + ], + "title": "System.STAGING_SYSTEM" + }, + { + "description": "Represents the staging system.", + "id": "script-api:dw/system/System#STAGING_SYSTEM", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.STAGING_SYSTEM", + "sections": [ + { + "body": "Represents the staging system.", + "heading": "Description" + } + ], + "signature": "static readonly STAGING_SYSTEM: number", + "source": "script-api", + "tags": [ + "staging_system", + "system.staging_system" + ], + "title": "System.STAGING_SYSTEM" + }, + { + "description": "Returns a new Calendar object in the time zone of the current instance.", + "id": "script-api:dw/system/System#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.calendar", + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent instance.", + "heading": "Description" + } + ], + "signature": "static readonly calendar: Calendar", + "source": "script-api", + "tags": [ + "calendar", + "system.calendar" + ], + "title": "System.calendar" + }, + { + "description": "Returns a new Calendar object in the time zone of the current instance.", + "id": "script-api:dw/system/System#calendar", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.calendar", + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent instance.", + "heading": "Description" + } + ], + "signature": "static readonly calendar: Calendar", + "source": "script-api", + "tags": [ + "calendar", + "system.calendar" + ], + "title": "System.calendar" + }, + { + "description": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "id": "script-api:dw/system/System#compatibilityMode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.compatibilityMode", + "sections": [ + { + "body": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is\nreturned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "heading": "Description" + } + ], + "signature": "static readonly compatibilityMode: number", + "source": "script-api", + "tags": [ + "compatibilitymode", + "system.compatibilitymode" + ], + "title": "System.compatibilityMode" + }, + { + "description": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "id": "script-api:dw/system/System#compatibilityMode", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.compatibilityMode", + "sections": [ + { + "body": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is\nreturned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "heading": "Description" + } + ], + "signature": "static readonly compatibilityMode: number", + "source": "script-api", + "tags": [ + "compatibilitymode", + "system.compatibilitymode" + ], + "title": "System.compatibilityMode" + }, + { + "description": "Returns a new Calendar object in the time zone of the current instance.", + "id": "script-api:dw/system/System#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCalendar", + "returns": { + "type": "Calendar" + }, + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent instance.", + "heading": "Description" + } + ], + "signature": "static getCalendar(): Calendar", + "source": "script-api", + "tags": [ + "getcalendar", + "system.getcalendar" + ], + "title": "System.getCalendar" + }, + { + "description": "Returns a new Calendar object in the time zone of the current instance.", + "id": "script-api:dw/system/System#getCalendar", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCalendar", + "returns": { + "type": "Calendar" + }, + "sections": [ + { + "body": "Returns a new Calendar object in the time zone of the\ncurrent instance.", + "heading": "Description" + } + ], + "signature": "static getCalendar(): Calendar", + "source": "script-api", + "tags": [ + "getcalendar", + "system.getcalendar" + ], + "title": "System.getCalendar" + }, + { + "description": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "id": "script-api:dw/system/System#getCompatibilityMode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCompatibilityMode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is\nreturned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "heading": "Description" + } + ], + "signature": "static getCompatibilityMode(): number", + "source": "script-api", + "tags": [ + "getcompatibilitymode", + "system.getcompatibilitymode" + ], + "title": "System.getCompatibilityMode" + }, + { + "description": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "id": "script-api:dw/system/System#getCompatibilityMode", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getCompatibilityMode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is\nreturned as a number, e.g. compatibility mode \"15.5\" is returned as 1505.", + "heading": "Description" + } + ], + "signature": "static getCompatibilityMode(): number", + "source": "script-api", + "tags": [ + "getcompatibilitymode", + "system.getcompatibilitymode" + ], + "title": "System.getCompatibilityMode" + }, + { + "description": "Returns instance hostname.", + "id": "script-api:dw/system/System#getInstanceHostname", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceHostname", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns instance hostname.", + "heading": "Description" + } + ], + "signature": "static getInstanceHostname(): string", + "source": "script-api", + "tags": [ + "getinstancehostname", + "system.getinstancehostname" + ], + "title": "System.getInstanceHostname" + }, + { + "description": "Returns instance hostname.", + "id": "script-api:dw/system/System#getInstanceHostname", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceHostname", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns instance hostname.", + "heading": "Description" + } + ], + "signature": "static getInstanceHostname(): string", + "source": "script-api", + "tags": [ + "getinstancehostname", + "system.getinstancehostname" + ], + "title": "System.getInstanceHostname" + }, + { + "description": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.", + "id": "script-api:dw/system/System#getInstanceTimeZone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceTimeZone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or\nreporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.\nChanges will affect only new sessions.", + "heading": "Description" + } + ], + "signature": "static getInstanceTimeZone(): string", + "source": "script-api", + "tags": [ + "getinstancetimezone", + "system.getinstancetimezone" + ], + "title": "System.getInstanceTimeZone" + }, + { + "description": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.", + "id": "script-api:dw/system/System#getInstanceTimeZone", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceTimeZone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or\nreporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.\nChanges will affect only new sessions.", + "heading": "Description" + } + ], + "signature": "static getInstanceTimeZone(): string", + "source": "script-api", + "tags": [ + "getinstancetimezone", + "system.getinstancetimezone" + ], + "title": "System.getInstanceTimeZone" + }, + { + "description": "Returns the type of the instance. An application server instance is configured to be of one of three types, \"development system\", \"staging system\" or \"production system\".", + "id": "script-api:dw/system/System#getInstanceType", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of the instance. An application server instance is configured to be of one of three types,\n\"development system\", \"staging system\" or \"production system\".\n\nThis method returns a constant representing the instance type of this\napplication server.", + "heading": "Description" + } + ], + "signature": "static getInstanceType(): number", + "source": "script-api", + "tags": [ + "getinstancetype", + "system.getinstancetype" + ], + "title": "System.getInstanceType" + }, + { + "description": "Returns the type of the instance. An application server instance is configured to be of one of three types, \"development system\", \"staging system\" or \"production system\".", + "id": "script-api:dw/system/System#getInstanceType", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getInstanceType", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the type of the instance. An application server instance is configured to be of one of three types,\n\"development system\", \"staging system\" or \"production system\".\n\nThis method returns a constant representing the instance type of this\napplication server.", + "heading": "Description" + } + ], + "signature": "static getInstanceType(): number", + "source": "script-api", + "tags": [ + "getinstancetype", + "system.getinstancetype" + ], + "title": "System.getInstanceType" + }, + { + "description": "This method returns a container of all global preferences of this organization (instance).", + "id": "script-api:dw/system/System#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getPreferences", + "returns": { + "type": "OrganizationPreferences" + }, + "sections": [ + { + "body": "This method returns a container of all global preferences of this\norganization (instance).", + "heading": "Description" + } + ], + "signature": "static getPreferences(): OrganizationPreferences", + "source": "script-api", + "tags": [ + "getpreferences", + "system.getpreferences" + ], + "title": "System.getPreferences" + }, + { + "description": "This method returns a container of all global preferences of this organization (instance).", + "id": "script-api:dw/system/System#getPreferences", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.getPreferences", + "returns": { + "type": "OrganizationPreferences" + }, + "sections": [ + { + "body": "This method returns a container of all global preferences of this\norganization (instance).", + "heading": "Description" + } + ], + "signature": "static getPreferences(): OrganizationPreferences", + "source": "script-api", + "tags": [ + "getpreferences", + "system.getpreferences" + ], + "title": "System.getPreferences" + }, + { + "description": "Returns instance hostname.", + "id": "script-api:dw/system/System#instanceHostname", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceHostname", + "sections": [ + { + "body": "Returns instance hostname.", + "heading": "Description" + } + ], + "signature": "static readonly instanceHostname: string", + "source": "script-api", + "tags": [ + "instancehostname", + "system.instancehostname" + ], + "title": "System.instanceHostname" + }, + { + "description": "Returns instance hostname.", + "id": "script-api:dw/system/System#instanceHostname", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceHostname", + "sections": [ + { + "body": "Returns instance hostname.", + "heading": "Description" + } + ], + "signature": "static readonly instanceHostname: string", + "source": "script-api", + "tags": [ + "instancehostname", + "system.instancehostname" + ], + "title": "System.instanceHostname" + }, + { + "description": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.", + "id": "script-api:dw/system/System#instanceTimeZone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceTimeZone", + "sections": [ + { + "body": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or\nreporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.\nChanges will affect only new sessions.", + "heading": "Description" + } + ], + "signature": "static readonly instanceTimeZone: string", + "source": "script-api", + "tags": [ + "instancetimezone", + "system.instancetimezone" + ], + "title": "System.instanceTimeZone" + }, + { + "description": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.", + "id": "script-api:dw/system/System#instanceTimeZone", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceTimeZone", + "sections": [ + { + "body": "Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or\nreporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.\nChanges will affect only new sessions.", + "heading": "Description" + } + ], + "signature": "static readonly instanceTimeZone: string", + "source": "script-api", + "tags": [ + "instancetimezone", + "system.instancetimezone" + ], + "title": "System.instanceTimeZone" + }, + { + "description": "Returns the type of the instance. An application server instance is configured to be of one of three types, \"development system\", \"staging system\" or \"production system\".", + "id": "script-api:dw/system/System#instanceType", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceType", + "sections": [ + { + "body": "Returns the type of the instance. An application server instance is configured to be of one of three types,\n\"development system\", \"staging system\" or \"production system\".\n\nThis method returns a constant representing the instance type of this\napplication server.", + "heading": "Description" + } + ], + "signature": "static readonly instanceType: number", + "source": "script-api", + "tags": [ + "instancetype", + "system.instancetype" + ], + "title": "System.instanceType" + }, + { + "description": "Returns the type of the instance. An application server instance is configured to be of one of three types, \"development system\", \"staging system\" or \"production system\".", + "id": "script-api:dw/system/System#instanceType", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.instanceType", + "sections": [ + { + "body": "Returns the type of the instance. An application server instance is configured to be of one of three types,\n\"development system\", \"staging system\" or \"production system\".\n\nThis method returns a constant representing the instance type of this\napplication server.", + "heading": "Description" + } + ], + "signature": "static readonly instanceType: number", + "source": "script-api", + "tags": [ + "instancetype", + "system.instancetype" + ], + "title": "System.instanceType" + }, + { + "description": "This method returns a container of all global preferences of this organization (instance).", + "id": "script-api:dw/system/System#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.preferences", + "sections": [ + { + "body": "This method returns a container of all global preferences of this\norganization (instance).", + "heading": "Description" + } + ], + "signature": "static readonly preferences: OrganizationPreferences", + "source": "script-api", + "tags": [ + "preferences", + "system.preferences" + ], + "title": "System.preferences" + }, + { + "description": "This method returns a container of all global preferences of this organization (instance).", + "id": "script-api:dw/system/System#preferences", + "kind": "property", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/System", + "qualifiedName": "dw.system.System.preferences", + "sections": [ + { + "body": "This method returns a container of all global preferences of this\norganization (instance).", + "heading": "Description" + } + ], + "signature": "static readonly preferences: OrganizationPreferences", + "source": "script-api", + "tags": [ + "preferences", + "system.preferences" + ], + "title": "System.preferences" + }, + { + "description": "Represents the current transaction. A transaction provides a context for performing atomic changes to persistent business objects. Before a business object can be created, changed, or deleted, a transaction must be started using the begin method. All changes on the touched business objects will only be made durable when the transaction is committed with commit. If a transaction is rolled back, all changes so far will be reverted and the business object will have their previous state again. It is possible to begin a transaction multiple times in a nested way (like begin-begin-commit-commit). In this case, in order to commit the changes the commit method must be called symmetrically as often as begin. It is also possible to run multiple transactions within a single request, one after another (like begin-commit-begin-commit). In case of any exception while working with business objects inside of a transaction, the transaction cannot be committed anymore, but only be rolled back. Business code may try to take appropriate actions if it expects business-related problems at commit (for example, constraint violations). When a transaction is still open at the end of a pipeline call, controller call, or job step, the remaining changes are committed unless an exception is thrown.", + "examples": [ + "var txn = require('dw/system/Transaction');\ntxn.begin();\n// work with business objects here\ntxn.commit();" + ], + "id": "script-api:dw/system/Transaction", + "kind": "class", + "packagePath": "dw/system", + "parentId": "script-api:dw/system", + "qualifiedName": "dw.system.Transaction", + "sections": [ + { + "body": "Represents the current transaction. A transaction provides a context for performing atomic changes to persistent\nbusiness objects. Before a business object can be created, changed, or deleted, a transaction must be started using\nthe begin method. All changes on the touched business objects will only be made durable when the\ntransaction is committed with commit. If a transaction is rolled back, all changes so far will be reverted\nand the business object will have their previous state again. It is possible to begin a transaction multiple times in\na nested way (like begin-begin-commit-commit). In this case, in order to commit the changes the commit method must be\ncalled symmetrically as often as begin. It is also possible to run multiple transactions within a single request, one\nafter another (like begin-commit-begin-commit). In case of any exception while working with business objects inside\nof a transaction, the transaction cannot be committed anymore, but only be rolled back. Business code may try to take\nappropriate actions if it expects business-related problems at commit (for example, constraint violations). When a\ntransaction is still open at the end of a pipeline call, controller call, or job step, the remaining changes are\ncommitted unless an exception is thrown.\n\nThe following best practices exist for using transactions:\n\n- Avoid long running transactions in jobs.\n- Use one transaction for changes that belong together and need a joint rollback. In most cases, one transaction\nfor all changes in a request is better than multiple transactions for each individual object.\n- Don’t begin and commit a huge number of small transactions in a loop.\n- Avoid changing the same objects in parallel transactions.\n\nExample 1 - explicit control:\n\n\nExample 2 - implicit control:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "transaction", + "dw.system.transaction", + "dw/system" + ], + "title": "Transaction" + }, + { + "description": "Begins a transaction.", + "id": "script-api:dw/system/Transaction#begin", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.begin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Begins a transaction.", + "heading": "Description" + } + ], + "signature": "static begin(): void", + "source": "script-api", + "tags": [ + "begin", + "transaction.begin" + ], + "title": "Transaction.begin" + }, + { + "description": "Begins a transaction.", + "id": "script-api:dw/system/Transaction#begin", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.begin", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Begins a transaction.", + "heading": "Description" + } + ], + "signature": "static begin(): void", + "source": "script-api", + "tags": [ + "begin", + "transaction.begin" + ], + "title": "Transaction.begin" + }, + { + "description": "Commits the current transaction. The transaction must have been started with begin before.", + "id": "script-api:dw/system/Transaction#commit", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.commit", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Commits the current transaction. The transaction must have been started with begin before.", + "heading": "Description" + } + ], + "signature": "static commit(): void", + "source": "script-api", + "tags": [ + "commit", + "transaction.commit" + ], + "title": "Transaction.commit" + }, + { + "description": "Commits the current transaction. The transaction must have been started with begin before.", + "id": "script-api:dw/system/Transaction#commit", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.commit", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Commits the current transaction. The transaction must have been started with begin before.", + "heading": "Description" + } + ], + "signature": "static commit(): void", + "source": "script-api", + "tags": [ + "commit", + "transaction.commit" + ], + "title": "Transaction.commit" + }, + { + "description": "Rolls back the current transaction. The transaction must have been started with begin before.", + "id": "script-api:dw/system/Transaction#rollback", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.rollback", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Rolls back the current transaction. The transaction must have been started with begin before.", + "heading": "Description" + } + ], + "signature": "static rollback(): void", + "source": "script-api", + "tags": [ + "rollback", + "transaction.rollback" + ], + "title": "Transaction.rollback" + }, + { + "description": "Rolls back the current transaction. The transaction must have been started with begin before.", + "id": "script-api:dw/system/Transaction#rollback", + "kind": "method", + "packagePath": "dw/system", + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.rollback", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Rolls back the current transaction. The transaction must have been started with begin before.", + "heading": "Description" + } + ], + "signature": "static rollback(): void", + "source": "script-api", + "tags": [ + "rollback", + "transaction.rollback" + ], + "title": "Transaction.rollback" + }, + { + "description": "Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be committed successfully, it is rolled back instead and an exception is thrown.", + "id": "script-api:dw/system/Transaction#wrap", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "callback", + "type": "() => T" + } + ], + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.wrap", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be\ncommitted successfully, it is rolled back instead and an exception is thrown.", + "heading": "Description" + } + ], + "signature": "static wrap(callback: () => T): T", + "source": "script-api", + "tags": [ + "wrap", + "transaction.wrap" + ], + "title": "Transaction.wrap" + }, + { + "description": "Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be committed successfully, it is rolled back instead and an exception is thrown.", + "id": "script-api:dw/system/Transaction#wrap", + "kind": "method", + "packagePath": "dw/system", + "params": [ + { + "name": "callback", + "type": "() => T" + } + ], + "parentId": "script-api:dw/system/Transaction", + "qualifiedName": "dw.system.Transaction.wrap", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be\ncommitted successfully, it is rolled back instead and an exception is thrown.", + "heading": "Description" + } + ], + "signature": "static wrap(callback: () => T): T", + "source": "script-api", + "tags": [ + "wrap", + "transaction.wrap" + ], + "title": "Transaction.wrap" + }, + { + "description": "2 declarations", + "id": "script-api:dw/template", + "kind": "package", + "packagePath": "dw/template", + "qualifiedName": "dw.template", + "source": "script-api", + "tags": [ + "dw/template", + "dw.template" + ], + "title": "dw.template" + }, + { + "description": "This class provides support for rendering ISML templates. For more details about the ISML syntax, refer to the Commerce Cloud Digital developer documentation. Templates are stored as *.isml files. They are located in a locale-specific folder under the '/cartridge/templates' folder, with '/cartridge/template/default' being the default locale. The template name arguments of the various render methods represent the template path (without file ending) within this folder structure.", + "examples": [ + "let isml = require('dw/template/ISML');\nisml.renderTemplate('helloworld', {\nMessage: 'Hello, World!'\n});" + ], + "id": "script-api:dw/template/ISML", + "kind": "class", + "packagePath": "dw/template", + "parentId": "script-api:dw/template", + "qualifiedName": "dw.template.ISML", + "sections": [ + { + "body": "This class provides support for rendering ISML templates. For more details about the ISML syntax, refer to the\nCommerce Cloud Digital developer documentation. Templates are stored as *.isml files. They are located in a\nlocale-specific folder under the '/cartridge/templates' folder, with '/cartridge/template/default' being the default\nlocale. The template name arguments of the various render methods represent the template path (without file ending)\nwithin this folder structure.\n\nExample for rendering a template with arguments from JavaScript code:\n\n\nExample code for accessing the template arguments in the 'helloworld.isml' template from the above code snippet:", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "isml", + "dw.template.isml", + "dw/template" + ], + "title": "ISML" + }, + { + "description": "Renders an ISML template and writes the output to the current response. The template may contain ISML tags which control the character encoding, content type, caching behavior and so on of the response (see ISML documentation). This method takes an additional JavaScript object as argument. Its properties are accessible for script expressions in the template under the \"pdict.*\" variable.", + "id": "script-api:dw/template/ISML#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "template", + "type": "string" + }, + { + "name": "templateArgs", + "type": "any" + } + ], + "parentId": "script-api:dw/template/ISML", + "qualifiedName": "dw.template.ISML.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an ISML template and writes the output to the current response. The template may contain ISML tags which\ncontrol the character encoding, content type, caching behavior and so on of the response (see ISML\ndocumentation). This method takes an additional JavaScript object as argument. Its properties are accessible for\nscript expressions in the template under the \"pdict.*\" variable.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(template: string, templateArgs: any): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "isml.rendertemplate" + ], + "title": "ISML.renderTemplate" + }, + { + "description": "Renders an ISML template and writes the output to the current response. The template may contain ISML tags which control the character encoding, content type, caching behavior and so on of the response (see ISML documentation). This method takes an additional JavaScript object as argument. Its properties are accessible for script expressions in the template under the \"pdict.*\" variable.", + "id": "script-api:dw/template/ISML#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "template", + "type": "string" + }, + { + "name": "templateArgs", + "type": "any" + } + ], + "parentId": "script-api:dw/template/ISML", + "qualifiedName": "dw.template.ISML.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an ISML template and writes the output to the current response. The template may contain ISML tags which\ncontrol the character encoding, content type, caching behavior and so on of the response (see ISML\ndocumentation). This method takes an additional JavaScript object as argument. Its properties are accessible for\nscript expressions in the template under the \"pdict.*\" variable.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(template: string, templateArgs: any): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "isml.rendertemplate" + ], + "title": "ISML.renderTemplate" + }, + { + "description": "This class renders an Apache Velocity template. For Velocity template syntax, see Velocity 1.7.", + "examples": [ + "`\nvar urlUtil = require('dw/web/URLUtils');\nvelocity.render(\"$url.abs('Foo-Bar','cgid',$res.msg('key')\", {'url' : urlUtil, 'res' : dw.web.Resource});\n`" + ], + "id": "script-api:dw/template/Velocity", + "kind": "class", + "packagePath": "dw/template", + "parentId": "script-api:dw/template", + "qualifiedName": "dw.template.Velocity", + "sections": [ + { + "body": "This class renders an Apache Velocity template. For Velocity template syntax, see\nVelocity 1.7.\n\nThe render() methods identify the template to render from:\n\n- a template file name, which is resolved in the Dynamic WebDAV file location for the current site.\nTemplate file names must end with either '.vm' or '.vs'.\n- a dw.io.File object, which can point to any file system location that is accessible from a script\n- a string that holds the template content directly\nNote: Files included from an ISML template (either via `#parse` or `#include`) are always resolved\nin the Dynamic location, and it is not possible to provide an absolute path.\n\nOn the target side of rendering, by default the render() methods write to the current response writer. When needed,\na `dw.io.Writer` can be supplied as a target.\n\nParameters for rendering can be passed as a single object holding the parameters as properties.\n\nTo create a URL, pass the `URLUtils` class.\n\nTo access localized strings, pass the `Resource` class:\n\n\nThe complete set of VelocityTools\nare provided to the template. You can use the tools to escape dynamic data, format text, and for other common tasks.\n\nTemplate files are cached for different amounts of time, depending on the instance type.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "velocity", + "dw.template.velocity", + "dw/template" + ], + "title": "Velocity" + }, + { + "description": "Includes the rendered content of the specified action URL, which usually is a pipeline or controller. Must only be used inside a Velocity template, such as `$velocity.remoteInclude('Product-Show','sku','42')`", + "id": "script-api:dw/template/Velocity#remoteInclude", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "namesAndParams", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.remoteInclude", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Includes the rendered content of the specified action URL, which usually is a pipeline or controller. Must only be used inside a Velocity\ntemplate, such as `$velocity.remoteInclude('Product-Show','sku','42')`", + "heading": "Description" + } + ], + "signature": "static remoteInclude(action: string, namesAndParams?: string[]): string", + "source": "script-api", + "tags": [ + "remoteinclude", + "velocity.remoteinclude" + ], + "title": "Velocity.remoteInclude" + }, + { + "description": "Includes the rendered content of the specified action URL, which usually is a pipeline or controller. Must only be used inside a Velocity template, such as `$velocity.remoteInclude('Product-Show','sku','42')`", + "id": "script-api:dw/template/Velocity#remoteInclude", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "action", + "type": "string" + }, + { + "name": "namesAndParams", + "optional": true, + "type": "string[]" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.remoteInclude", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Includes the rendered content of the specified action URL, which usually is a pipeline or controller. Must only be used inside a Velocity\ntemplate, such as `$velocity.remoteInclude('Product-Show','sku','42')`", + "heading": "Description" + } + ], + "signature": "static remoteInclude(action: string, namesAndParams?: string[]): string", + "source": "script-api", + "tags": [ + "remoteinclude", + "velocity.remoteinclude" + ], + "title": "Velocity.remoteInclude" + }, + { + "description": "Renders an inline template to the response writer.", + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateContent", + "type": "string" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an inline template to the response writer.", + "heading": "Description" + } + ], + "signature": "static render(templateContent: string, args: Object): void", + "source": "script-api", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "description": "Renders an inline template to the provided writer.", + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateContent", + "type": "string" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an inline template to the provided writer.", + "heading": "Description" + } + ], + "signature": "static render(templateContent: string, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "description": "Renders an inline template to the response writer.", + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateContent", + "type": "string" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an inline template to the response writer.", + "heading": "Description" + } + ], + "signature": "static render(templateContent: string, args: Object): void", + "source": "script-api", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "description": "Renders an inline template to the provided writer.", + "id": "script-api:dw/template/Velocity#render", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateContent", + "type": "string" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.render", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders an inline template to the provided writer.", + "heading": "Description" + } + ], + "signature": "static render(templateContent: string, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "render", + "velocity.render" + ], + "title": "Velocity.render" + }, + { + "description": "Renders a template file to the response writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFileName", + "type": "string" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the response writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFileName: string, args: Object): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the provided writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFileName", + "type": "string" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the provided writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFileName: string, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the response writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFile", + "type": "File" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the response writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFile: File, args: Object): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the provided writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFile", + "type": "File" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the provided writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFile: File, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the response writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFileName", + "type": "string" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the response writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFileName: string, args: Object): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the provided writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFileName", + "type": "string" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the provided writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFileName: string, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the response writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFile", + "type": "File" + }, + { + "name": "args", + "type": "Object" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the response writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFile: File, args: Object): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "Renders a template file to the provided writer.", + "id": "script-api:dw/template/Velocity#renderTemplate", + "kind": "method", + "packagePath": "dw/template", + "params": [ + { + "name": "templateFile", + "type": "File" + }, + { + "name": "args", + "type": "Object" + }, + { + "name": "writer", + "type": "Writer" + } + ], + "parentId": "script-api:dw/template/Velocity", + "qualifiedName": "dw.template.Velocity.renderTemplate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Renders a template file to the provided writer.", + "heading": "Description" + } + ], + "signature": "static renderTemplate(templateFile: File, args: Object, writer: Writer): void", + "source": "script-api", + "tags": [ + "rendertemplate", + "velocity.rendertemplate" + ], + "title": "Velocity.renderTemplate" + }, + { + "description": "32 declarations", + "id": "script-api:dw/util", + "kind": "package", + "packagePath": "dw/util", + "qualifiedName": "dw.util", + "source": "script-api", + "tags": [ + "dw/util", + "dw.util" + ], + "title": "dw.util" + }, + { + "description": "The ArrayList class is a container for a list of objects.", + "id": "script-api:dw/util/ArrayList", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.ArrayList", + "sections": [ + { + "body": "The ArrayList class is a container for a list of objects.", + "heading": "Description" + }, + { + "body": "Extends `List`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "arraylist", + "dw.util.arraylist", + "dw/util" + ], + "title": "ArrayList" + }, + { + "description": "Returns a shallow copy of this array list.", + "id": "script-api:dw/util/ArrayList#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/ArrayList", + "qualifiedName": "dw.util.ArrayList.clone", + "returns": { + "type": "ArrayList" + }, + "sections": [ + { + "body": "Returns a shallow copy of this array list.", + "heading": "Description" + } + ], + "signature": "clone(): ArrayList", + "source": "script-api", + "tags": [ + "clone", + "arraylist.clone" + ], + "title": "ArrayList.clone" + }, + { + "description": "The Assert class provides utility methods for assertion events.", + "id": "script-api:dw/util/Assert", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Assert", + "sections": [ + { + "body": "The Assert class provides utility methods for assertion events.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "assert", + "dw.util.assert", + "dw/util" + ], + "title": "Assert" + }, + { + "description": "Propagates an assertion if the specified objects are not equal.", + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are not equal.", + "heading": "Description" + } + ], + "signature": "static areEqual(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are not equal.", + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are not equal.", + "heading": "Description" + } + ], + "signature": "static areEqual(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "description": "Propagates an assertion if the specified objects are not equal.", + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are not equal.", + "heading": "Description" + } + ], + "signature": "static areEqual(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are not equal.", + "id": "script-api:dw/util/Assert#areEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are not equal.", + "heading": "Description" + } + ], + "signature": "static areEqual(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "areequal", + "assert.areequal" + ], + "title": "Assert.areEqual" + }, + { + "description": "Propagates an assertion if the specified objects are equal.", + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are equal.", + "heading": "Description" + } + ], + "signature": "static areNotEqual(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are equal.", + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are equal.", + "heading": "Description" + } + ], + "signature": "static areNotEqual(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "description": "Propagates an assertion if the specified objects are equal.", + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are equal.", + "heading": "Description" + } + ], + "signature": "static areNotEqual(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are equal.", + "id": "script-api:dw/util/Assert#areNotEqual", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areNotEqual", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are equal.", + "heading": "Description" + } + ], + "signature": "static areNotEqual(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "arenotequal", + "assert.arenotequal" + ], + "title": "Assert.areNotEqual" + }, + { + "description": "Propagates an assertion if the specified objects are not the same.", + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are not the same.", + "heading": "Description" + } + ], + "signature": "static areSame(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are not the same.", + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are not the same.", + "heading": "Description" + } + ], + "signature": "static areSame(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "description": "Propagates an assertion if the specified objects are not the same.", + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified objects are not the same.", + "heading": "Description" + } + ], + "signature": "static areSame(arg1: any, arg2: any): void", + "source": "script-api", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "description": "Propagates an assertion using the specified message if the specified objects are not the same.", + "id": "script-api:dw/util/Assert#areSame", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.areSame", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified objects are not the same.", + "heading": "Description" + } + ], + "signature": "static areSame(arg1: any, arg2: any, msg: string): void", + "source": "script-api", + "tags": [ + "aresame", + "assert.aresame" + ], + "title": "Assert.areSame" + }, + { + "description": "Propagates a failure assertion.", + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates a failure assertion.", + "heading": "Description" + } + ], + "signature": "static fail(): void", + "source": "script-api", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "description": "Propagates a failure assertion using the specified message.", + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates a failure assertion using the\nspecified message.", + "heading": "Description" + } + ], + "signature": "static fail(msg: string): void", + "source": "script-api", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "description": "Propagates a failure assertion.", + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates a failure assertion.", + "heading": "Description" + } + ], + "signature": "static fail(): void", + "source": "script-api", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "description": "Propagates a failure assertion using the specified message.", + "id": "script-api:dw/util/Assert#fail", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.fail", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates a failure assertion using the\nspecified message.", + "heading": "Description" + } + ], + "signature": "static fail(msg: string): void", + "source": "script-api", + "tags": [ + "fail", + "assert.fail" + ], + "title": "Assert.fail" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to an empty object.", + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified check does not evaluate to\nan empty object.", + "heading": "Description" + } + ], + "signature": "static isEmpty(arg: any): void", + "source": "script-api", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.", + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to\nan empty object.", + "heading": "Description" + } + ], + "signature": "static isEmpty(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to an empty object.", + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified check does not evaluate to\nan empty object.", + "heading": "Description" + } + ], + "signature": "static isEmpty(arg: any): void", + "source": "script-api", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.", + "id": "script-api:dw/util/Assert#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to\nan empty object.", + "heading": "Description" + } + ], + "signature": "static isEmpty(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isempty", + "assert.isempty" + ], + "title": "Assert.isEmpty" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to false.", + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified check does not evaluate to false.", + "heading": "Description" + } + ], + "signature": "static isFalse(check: boolean): void", + "source": "script-api", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to false.", + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to false.", + "heading": "Description" + } + ], + "signature": "static isFalse(check: boolean, msg: string): void", + "source": "script-api", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to false.", + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified check does not evaluate to false.", + "heading": "Description" + } + ], + "signature": "static isFalse(check: boolean): void", + "source": "script-api", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to false.", + "id": "script-api:dw/util/Assert#isFalse", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isFalse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to false.", + "heading": "Description" + } + ], + "signature": "static isFalse(check: boolean, msg: string): void", + "source": "script-api", + "tags": [ + "isfalse", + "assert.isfalse" + ], + "title": "Assert.isFalse" + }, + { + "description": "Propagates an assertion if the specified object 'arg' is not an instance of the specified class 'clazz'.", + "examples": [ + "`\nvar test = new dw.util.HashMap();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`", + "`\nvar test = new dw.util.Set();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`" + ], + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "clazz", + "type": "any" + }, + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the specified object 'arg' is not an instance\nof the specified class 'clazz'.\n\nFor example, the following call does not propagate an assertion:\n\n\nBut the following call will propagate an assertion:\n\n\nNote that 'clazz' can only be a Demandware API Scripting class.", + "heading": "Description" + } + ], + "signature": "static isInstanceOf(clazz: any, arg: any): void", + "source": "script-api", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is not an instance of the specified class.", + "examples": [ + "`\nvar test = new dw.util.HashMap();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`", + "`\nvar test = new dw.util.Set();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`" + ], + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "clazz", + "type": "any" + }, + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is not an instance of the specified class.\n\nFor example, the following call does not propagate an assertion:\n\n\nBut the following call will propagate an assertion:\n\n\nNote that 'clazz' can only be a Demandware API Scripting class.", + "heading": "Description" + } + ], + "signature": "static isInstanceOf(clazz: any, arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "description": "Propagates an assertion if the specified object 'arg' is not an instance of the specified class 'clazz'.", + "examples": [ + "`\nvar test = new dw.util.HashMap();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`", + "`\nvar test = new dw.util.Set();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`" + ], + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "clazz", + "type": "any" + }, + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the specified object 'arg' is not an instance\nof the specified class 'clazz'.\n\nFor example, the following call does not propagate an assertion:\n\n\nBut the following call will propagate an assertion:\n\n\nNote that 'clazz' can only be a Demandware API Scripting class.", + "heading": "Description" + } + ], + "signature": "static isInstanceOf(clazz: any, arg: any): void", + "source": "script-api", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is not an instance of the specified class.", + "examples": [ + "`\nvar test = new dw.util.HashMap();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`", + "`\nvar test = new dw.util.Set();\ndw.util.Assert.isInstanceOf(dw.util.HashMap, test);\n`" + ], + "id": "script-api:dw/util/Assert#isInstanceOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "clazz", + "type": "any" + }, + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isInstanceOf", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is not an instance of the specified class.\n\nFor example, the following call does not propagate an assertion:\n\n\nBut the following call will propagate an assertion:\n\n\nNote that 'clazz' can only be a Demandware API Scripting class.", + "heading": "Description" + } + ], + "signature": "static isInstanceOf(clazz: any, arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isinstanceof", + "assert.isinstanceof" + ], + "title": "Assert.isInstanceOf" + }, + { + "description": "Propagates an assertion if the specified object is empty.", + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified object is empty.", + "heading": "Description" + } + ], + "signature": "static isNotEmpty(arg: any): void", + "source": "script-api", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is empty.", + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is empty.", + "heading": "Description" + } + ], + "signature": "static isNotEmpty(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "description": "Propagates an assertion if the specified object is empty.", + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified object is empty.", + "heading": "Description" + } + ], + "signature": "static isNotEmpty(arg: any): void", + "source": "script-api", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is empty.", + "id": "script-api:dw/util/Assert#isNotEmpty", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotEmpty", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is empty.", + "heading": "Description" + } + ], + "signature": "static isNotEmpty(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnotempty", + "assert.isnotempty" + ], + "title": "Assert.isNotEmpty" + }, + { + "description": "Propagates an assertion if the specified object is null.", + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified object is null.", + "heading": "Description" + } + ], + "signature": "static isNotNull(arg: any): void", + "source": "script-api", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is null.", + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is null.", + "heading": "Description" + } + ], + "signature": "static isNotNull(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "description": "Propagates an assertion if the specified object is null.", + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified object is null.", + "heading": "Description" + } + ], + "signature": "static isNotNull(arg: any): void", + "source": "script-api", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is null.", + "id": "script-api:dw/util/Assert#isNotNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNotNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is null.", + "heading": "Description" + } + ], + "signature": "static isNotNull(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnotnull", + "assert.isnotnull" + ], + "title": "Assert.isNotNull" + }, + { + "description": "Propagates an assertion if the specified object is not null.", + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified object is not null.", + "heading": "Description" + } + ], + "signature": "static isNull(arg: any): void", + "source": "script-api", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is not null.", + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is not null.", + "heading": "Description" + } + ], + "signature": "static isNull(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "description": "Propagates an assertion if the specified object is not null.", + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion\nif the specified object is not null.", + "heading": "Description" + } + ], + "signature": "static isNull(arg: any): void", + "source": "script-api", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "description": "Propagates an assertion using the specified message if the specified object is not null.", + "id": "script-api:dw/util/Assert#isNull", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg", + "type": "any" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isNull", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified object is not null.", + "heading": "Description" + } + ], + "signature": "static isNull(arg: any, msg: string): void", + "source": "script-api", + "tags": [ + "isnull", + "assert.isnull" + ], + "title": "Assert.isNull" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to true.", + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified check does not evaluate to true.", + "heading": "Description" + } + ], + "signature": "static isTrue(check: boolean): void", + "source": "script-api", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to true.", + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to true.", + "heading": "Description" + } + ], + "signature": "static isTrue(check: boolean, msg: string): void", + "source": "script-api", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "description": "Propagates an assertion if the specified check does not evaluate to true.", + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion if the\nspecified check does not evaluate to true.", + "heading": "Description" + } + ], + "signature": "static isTrue(check: boolean): void", + "source": "script-api", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "description": "Propagates an assertion using the specified message if the specified check does not evaluate to true.", + "id": "script-api:dw/util/Assert#isTrue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "check", + "type": "boolean" + }, + { + "name": "msg", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Assert", + "qualifiedName": "dw.util.Assert.isTrue", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Propagates an assertion using the specified message\nif the specified check does not evaluate to true.", + "heading": "Description" + } + ], + "signature": "static isTrue(check: boolean, msg: string): void", + "source": "script-api", + "tags": [ + "istrue", + "assert.istrue" + ], + "title": "Assert.isTrue" + }, + { + "deprecated": { + "message": "Replaced by TopLevel.BigInt." + }, + "description": "The BigInteger class is a helper class to represent an arbitrary long integer number. The Demandware framework doesn't use this class, but in some special cases web services that declare an XML element with \"xsd:integer\", which is by definition an arbitrary long integer number, require the use of this class.", + "examples": [ + "var i = new BigInteger( 10 );\nvar result = d.add( 2 ).sub( 3 ).get();" + ], + "id": "script-api:dw/util/BigInteger", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.BigInteger", + "sections": [ + { + "body": "The BigInteger class is a helper class to represent an arbitrary long integer number.\nThe Demandware framework doesn't use this class, but in some special cases\nweb services that declare an XML element with \"xsd:integer\", which is by definition\nan arbitrary long integer number, require the use of this class.\n\nThe class is designed in a way that it can be used very similar to a\ndesktop calculator. For example:\n\n\nThe above code will return 9 as result.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "biginteger", + "dw.util.biginteger", + "dw/util" + ], + "title": "BigInteger" + }, + { + "description": "Returns a new BigInteger with the absolute value of this BigInteger.", + "id": "script-api:dw/util/BigInteger#abs", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.abs", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Returns a new BigInteger with the absolute value of this BigInteger.", + "heading": "Description" + } + ], + "signature": "abs(): BigInteger", + "source": "script-api", + "tags": [ + "abs", + "biginteger.abs" + ], + "title": "BigInteger.abs" + }, + { + "description": "Adds a Number value to this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.add", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Adds a Number value to this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "add(value: number): BigInteger", + "source": "script-api", + "tags": [ + "add", + "biginteger.add" + ], + "title": "BigInteger.add" + }, + { + "description": "Adds an BigInteger value to this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "BigInteger" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.add", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Adds an BigInteger value to this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "add(value: BigInteger): BigInteger", + "source": "script-api", + "tags": [ + "add", + "biginteger.add" + ], + "title": "BigInteger.add" + }, + { + "description": "Divides this BigInteger by the specified BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#divide", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.divide", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Divides this BigInteger by the specified BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "divide(value: number): BigInteger", + "source": "script-api", + "tags": [ + "divide", + "biginteger.divide" + ], + "title": "BigInteger.divide" + }, + { + "description": "Divides this BigInteger by the specified BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#divide", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "BigInteger" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.divide", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Divides this BigInteger by the specified BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "divide(value: BigInteger): BigInteger", + "source": "script-api", + "tags": [ + "divide", + "biginteger.divide" + ], + "title": "BigInteger.divide" + }, + { + "description": "Compares two BigInteger values whether they are equivalent.", + "id": "script-api:dw/util/BigInteger#equals", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "any" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.equals", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Compares two BigInteger values whether they are equivalent.", + "heading": "Description" + } + ], + "signature": "equals(other: any): boolean", + "source": "script-api", + "tags": [ + "equals", + "biginteger.equals" + ], + "title": "BigInteger.equals" + }, + { + "description": "Returns the value of the BigInteger as a Number.", + "id": "script-api:dw/util/BigInteger#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.get", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value of the BigInteger as a Number.", + "heading": "Description" + } + ], + "signature": "get(): number", + "source": "script-api", + "tags": [ + "get", + "biginteger.get" + ], + "title": "BigInteger.get" + }, + { + "description": "Calculates the hash code for this BigInteger;", + "id": "script-api:dw/util/BigInteger#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.hashCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Calculates the hash code for this BigInteger;", + "heading": "Description" + } + ], + "signature": "hashCode(): number", + "source": "script-api", + "tags": [ + "hashcode", + "biginteger.hashcode" + ], + "title": "BigInteger.hashCode" + }, + { + "description": "Multiples the specified Number value with this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#multiply", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.multiply", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Multiples the specified Number value with this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "multiply(value: number): BigInteger", + "source": "script-api", + "tags": [ + "multiply", + "biginteger.multiply" + ], + "title": "BigInteger.multiply" + }, + { + "description": "Multiples the specified BigInteger value with this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#multiply", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "BigInteger" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.multiply", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Multiples the specified BigInteger value with this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "multiply(value: BigInteger): BigInteger", + "source": "script-api", + "tags": [ + "multiply", + "biginteger.multiply" + ], + "title": "BigInteger.multiply" + }, + { + "description": "Returns a new BigInteger with the negated value of this BigInteger.", + "id": "script-api:dw/util/BigInteger#negate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.negate", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Returns a new BigInteger with the negated value of this BigInteger.", + "heading": "Description" + } + ], + "signature": "negate(): BigInteger", + "source": "script-api", + "tags": [ + "negate", + "biginteger.negate" + ], + "title": "BigInteger.negate" + }, + { + "description": "Subtracts the specified Number value from this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#subtract", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.subtract", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Subtracts the specified Number value from this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "subtract(value: number): BigInteger", + "source": "script-api", + "tags": [ + "subtract", + "biginteger.subtract" + ], + "title": "BigInteger.subtract" + }, + { + "description": "Subtracts the specified BigInteger value from this BigInteger and returns the new BigInteger.", + "id": "script-api:dw/util/BigInteger#subtract", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "BigInteger" + } + ], + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.subtract", + "returns": { + "type": "BigInteger" + }, + "sections": [ + { + "body": "Subtracts the specified BigInteger value from this BigInteger and returns the new BigInteger.", + "heading": "Description" + } + ], + "signature": "subtract(value: BigInteger): BigInteger", + "source": "script-api", + "tags": [ + "subtract", + "biginteger.subtract" + ], + "title": "BigInteger.subtract" + }, + { + "description": "Returns a string representation of this object.", + "id": "script-api:dw/util/BigInteger#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this object.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "biginteger.tostring" + ], + "title": "BigInteger.toString" + }, + { + "description": "The valueOf() method is called by the ECMAScript interpret to return the \"natural\" value of an object. The BigInteger object returns its current value as number. With this behavior script snippets can be written like:", + "examples": [ + "var i = new BigInteger( 10 );\nvar x = 1 + d.add( 2 );" + ], + "id": "script-api:dw/util/BigInteger#valueOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/BigInteger", + "qualifiedName": "dw.util.BigInteger.valueOf", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "The valueOf() method is called by the ECMAScript interpret to return\nthe \"natural\" value of an object. The BigInteger object returns its\ncurrent value as number. With this behavior script snippets can\nbe written like:\n\n\nwhere x will be at the end 13.", + "heading": "Description" + } + ], + "signature": "valueOf(): any", + "source": "script-api", + "tags": [ + "valueof", + "biginteger.valueof" + ], + "title": "BigInteger.valueOf" + }, + { + "description": "A simple immutable class representing an array of bytes, used for working with binary data in a scripting context.", + "id": "script-api:dw/util/Bytes", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Bytes", + "sections": [ + { + "body": "A simple immutable class representing an array of bytes, used for working\nwith binary data in a scripting context.\n\nIt acts as a view to TopLevel.ArrayBuffer. The buffer can be accessed through asUint8Array.\n\nLimitation:\nThe size of the resulting byte representation is limited by the quota api.jsArrayBufferSize that is defining the max size for a TopLevel.ArrayBuffer.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "bytes", + "dw.util.bytes", + "dw/util" + ], + "title": "Bytes" + }, + { + "deprecated": { + "message": "No longer used by the Bytes class." + }, + "description": "The maximum number of bytes that a Bytes object can represent == 10KB", + "id": "script-api:dw/util/Bytes#MAX_BYTES", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.MAX_BYTES", + "sections": [ + { + "body": "The maximum number of bytes that a Bytes object can represent == 10KB", + "heading": "Description" + } + ], + "signature": "static readonly MAX_BYTES = 10240", + "source": "script-api", + "tags": [ + "max_bytes", + "bytes.max_bytes" + ], + "title": "Bytes.MAX_BYTES" + }, + { + "deprecated": { + "message": "No longer used by the Bytes class." + }, + "description": "The maximum number of bytes that a Bytes object can represent == 10KB", + "id": "script-api:dw/util/Bytes#MAX_BYTES", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.MAX_BYTES", + "sections": [ + { + "body": "The maximum number of bytes that a Bytes object can represent == 10KB", + "heading": "Description" + } + ], + "signature": "static readonly MAX_BYTES = 10240", + "source": "script-api", + "tags": [ + "max_bytes", + "bytes.max_bytes" + ], + "title": "Bytes.MAX_BYTES" + }, + { + "description": "Returns a TopLevel.Uint8Array based on the TopLevel.ArrayBuffer used for this Bytes object. Changes to the returned TopLevel.ArrayBuffer will be visible in the Bytes object.", + "id": "script-api:dw/util/Bytes#asUint8Array", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.asUint8Array", + "returns": { + "type": "Object" + }, + "sections": [ + { + "body": "Returns a TopLevel.Uint8Array based on the TopLevel.ArrayBuffer used for this Bytes object.\nChanges to the returned TopLevel.ArrayBuffer will be visible in the Bytes object.", + "heading": "Description" + } + ], + "signature": "asUint8Array(): Object", + "sinceApiVersion": "21.2", + "source": "script-api", + "tags": [ + "asuint8array", + "bytes.asuint8array" + ], + "title": "Bytes.asUint8Array" + }, + { + "description": "Returns the value of the byte at position index as an integer. If index is out of range an exception is thrown. The byte is interpreted as signed and so the value returned will always be between -128 and +127.", + "id": "script-api:dw/util/Bytes#byteAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.byteAt", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value of the byte at position index as an integer. If index\nis out of range an exception is thrown. The byte is interpreted as signed\nand so the value returned will always be between -128 and +127.", + "heading": "Description" + } + ], + "signature": "byteAt(index: number): number", + "source": "script-api", + "tags": [ + "byteat", + "bytes.byteat" + ], + "throws": [ + { + "description": "If the index argument is negative or not less than the length of this byte array.", + "type": "IndexOutOfBoundsException" + } + ], + "title": "Bytes.byteAt" + }, + { + "description": "Return a new Bytes object containing the subsequence of this object's bytes specified by the index and length parameters. The returned object is a new view onto the same data, no data is copied.", + "id": "script-api:dw/util/Bytes#bytesAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + }, + { + "name": "length", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.bytesAt", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Return a new Bytes object containing the subsequence of this object's bytes specified by the index and length\nparameters. The returned object is a new view onto the same data, no data is copied.", + "heading": "Description" + } + ], + "signature": "bytesAt(index: number, length: number): Bytes", + "source": "script-api", + "tags": [ + "bytesat", + "bytes.bytesat" + ], + "throws": [ + { + "description": "If index < 0 or index > getLength() or index + length > getLength()", + "type": "ArrayIndexOutOfBoundsException" + }, + { + "description": "If length < 0", + "type": "IllegalArgumentException" + } + ], + "title": "Bytes.bytesAt" + }, + { + "description": "Returns the number of bytes represented by this object.", + "id": "script-api:dw/util/Bytes#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.getLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the number of bytes represented by this object.", + "heading": "Description" + } + ], + "signature": "getLength(): number", + "source": "script-api", + "tags": [ + "getlength", + "bytes.getlength" + ], + "title": "Bytes.getLength" + }, + { + "description": "Absolute get method for reading a signed integer value (32 bit) in network byte order(= big endian).", + "id": "script-api:dw/util/Bytes#intAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.intAt", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Absolute get method for reading a signed integer value (32 bit) in\nnetwork byte order(= big endian).", + "heading": "Description" + } + ], + "signature": "intAt(index: number): number", + "source": "script-api", + "tags": [ + "intat", + "bytes.intat" + ], + "throws": [ + { + "description": "If index is negative or not smaller than the number of bytes minus three.", + "type": "IndexOutOfBoundsException" + } + ], + "title": "Bytes.intAt" + }, + { + "description": "Returns the number of bytes represented by this object.", + "id": "script-api:dw/util/Bytes#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.length", + "sections": [ + { + "body": "Returns the number of bytes represented by this object.", + "heading": "Description" + } + ], + "signature": "readonly length: number", + "source": "script-api", + "tags": [ + "length", + "bytes.length" + ], + "title": "Bytes.length" + }, + { + "description": "Return a new Bytes object which has the same bytes as this one in reverse order.", + "id": "script-api:dw/util/Bytes#reverse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.reverse", + "returns": { + "type": "Bytes" + }, + "sections": [ + { + "body": "Return a new Bytes object which has the same bytes as this one in reverse\norder.", + "heading": "Description" + } + ], + "signature": "reverse(): Bytes", + "source": "script-api", + "tags": [ + "reverse", + "bytes.reverse" + ], + "title": "Bytes.reverse" + }, + { + "description": "Absolute get method for reading a signed short value (16 bit) in network byte order(= big endian).", + "id": "script-api:dw/util/Bytes#shortAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.shortAt", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Absolute get method for reading a signed short value (16 bit) in network\nbyte order(= big endian).", + "heading": "Description" + } + ], + "signature": "shortAt(index: number): number", + "source": "script-api", + "tags": [ + "shortat", + "bytes.shortat" + ], + "throws": [ + { + "description": "If index is negative or not smaller than the number of bytes minus one.", + "type": "IndexOutOfBoundsException" + } + ], + "title": "Bytes.shortAt" + }, + { + "description": "Constructs a new String by decoding this array of bytes using the default encoding. Convenience for toString( \"UTF-8\" ). Limitation: The method is protected by the quota api.jsStringLength that prevents creation of too long strings.", + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Constructs a new String by decoding this array of bytes using the\ndefault encoding. Convenience for toString( \"UTF-8\" ).\nLimitation:\nThe method is protected by the quota api.jsStringLength that prevents creation of too long strings.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "bytes.tostring" + ], + "title": "Bytes.toString" + }, + { + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "returns": { + "type": "string" + }, + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "bytes.tostring" + ], + "title": "Bytes.toString" + }, + { + "description": "Constructs a new String by decoding this array of bytes using the specified encoding. Limitation: The method is protected by the quota api.jsStringLength that prevents creation of too long strings.", + "id": "script-api:dw/util/Bytes#toString", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "encoding", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Bytes", + "qualifiedName": "dw.util.Bytes.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Constructs a new String by decoding this array of bytes using the\nspecified encoding.\nLimitation:\nThe method is protected by the quota api.jsStringLength that prevents creation of too long strings.", + "heading": "Description" + } + ], + "signature": "toString(encoding: string): string", + "source": "script-api", + "tags": [ + "tostring", + "bytes.tostring" + ], + "throws": [ + { + "description": "If the named encoding is not supported.", + "type": "IllegalArgumentException" + } + ], + "title": "Bytes.toString" + }, + { + "description": "Represents a Calendar and is based on the java.util.Calendar class. Refer to the java.util.Calendar documentation for more information.", + "id": "script-api:dw/util/Calendar", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Calendar", + "sections": [ + { + "body": "Represents a Calendar and is based on the java.util.Calendar\nclass. Refer to the java.util.Calendar documentation for\nmore information.\n\nIMPORTANT NOTE: Please use the dw.util.StringUtils.formatCalendar\nfunctions to convert a Calendar object into a String.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "calendar", + "dw.util.calendar", + "dw/util" + ], + "title": "Calendar" + }, + { + "description": "Indicates whether the HOUR is before or after noon.", + "id": "script-api:dw/util/Calendar#AM_PM", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AM_PM", + "sections": [ + { + "body": "Indicates whether the HOUR is before or after noon.", + "heading": "Description" + } + ], + "signature": "static readonly AM_PM = 9", + "source": "script-api", + "tags": [ + "am_pm", + "calendar.am_pm" + ], + "title": "Calendar.AM_PM" + }, + { + "description": "Indicates whether the HOUR is before or after noon.", + "id": "script-api:dw/util/Calendar#AM_PM", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AM_PM", + "sections": [ + { + "body": "Indicates whether the HOUR is before or after noon.", + "heading": "Description" + } + ], + "signature": "static readonly AM_PM = 9", + "source": "script-api", + "tags": [ + "am_pm", + "calendar.am_pm" + ], + "title": "Calendar.AM_PM" + }, + { + "description": "Value for the month of year field representing April.", + "id": "script-api:dw/util/Calendar#APRIL", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.APRIL", + "sections": [ + { + "body": "Value for the month of year field representing April.", + "heading": "Description" + } + ], + "signature": "static readonly APRIL = 3", + "source": "script-api", + "tags": [ + "april", + "calendar.april" + ], + "title": "Calendar.APRIL" + }, + { + "description": "Value for the month of year field representing April.", + "id": "script-api:dw/util/Calendar#APRIL", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.APRIL", + "sections": [ + { + "body": "Value for the month of year field representing April.", + "heading": "Description" + } + ], + "signature": "static readonly APRIL = 3", + "source": "script-api", + "tags": [ + "april", + "calendar.april" + ], + "title": "Calendar.APRIL" + }, + { + "description": "Value for the month of year field representing August.", + "id": "script-api:dw/util/Calendar#AUGUST", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AUGUST", + "sections": [ + { + "body": "Value for the month of year field representing August.", + "heading": "Description" + } + ], + "signature": "static readonly AUGUST = 7", + "source": "script-api", + "tags": [ + "august", + "calendar.august" + ], + "title": "Calendar.AUGUST" + }, + { + "description": "Value for the month of year field representing August.", + "id": "script-api:dw/util/Calendar#AUGUST", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.AUGUST", + "sections": [ + { + "body": "Value for the month of year field representing August.", + "heading": "Description" + } + ], + "signature": "static readonly AUGUST = 7", + "source": "script-api", + "tags": [ + "august", + "calendar.august" + ], + "title": "Calendar.AUGUST" + }, + { + "description": "Represents a date.", + "id": "script-api:dw/util/Calendar#DATE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DATE", + "sections": [ + { + "body": "Represents a date.", + "heading": "Description" + } + ], + "signature": "static readonly DATE = 5", + "source": "script-api", + "tags": [ + "date", + "calendar.date" + ], + "title": "Calendar.DATE" + }, + { + "description": "Represents a date.", + "id": "script-api:dw/util/Calendar#DATE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DATE", + "sections": [ + { + "body": "Represents a date.", + "heading": "Description" + } + ], + "signature": "static readonly DATE = 5", + "source": "script-api", + "tags": [ + "date", + "calendar.date" + ], + "title": "Calendar.DATE" + }, + { + "description": "Represents a day of the month.", + "id": "script-api:dw/util/Calendar#DAY_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_MONTH", + "sections": [ + { + "body": "Represents a day of the month.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_MONTH = 5", + "source": "script-api", + "tags": [ + "day_of_month", + "calendar.day_of_month" + ], + "title": "Calendar.DAY_OF_MONTH" + }, + { + "description": "Represents a day of the month.", + "id": "script-api:dw/util/Calendar#DAY_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_MONTH", + "sections": [ + { + "body": "Represents a day of the month.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_MONTH = 5", + "source": "script-api", + "tags": [ + "day_of_month", + "calendar.day_of_month" + ], + "title": "Calendar.DAY_OF_MONTH" + }, + { + "description": "Represents a day of the week.", + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK", + "sections": [ + { + "body": "Represents a day of the week.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_WEEK = 7", + "source": "script-api", + "tags": [ + "day_of_week", + "calendar.day_of_week" + ], + "title": "Calendar.DAY_OF_WEEK" + }, + { + "description": "Represents a day of the week.", + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK", + "sections": [ + { + "body": "Represents a day of the week.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_WEEK = 7", + "source": "script-api", + "tags": [ + "day_of_week", + "calendar.day_of_week" + ], + "title": "Calendar.DAY_OF_WEEK" + }, + { + "description": "Represents a day of the week in a month.", + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK_IN_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK_IN_MONTH", + "sections": [ + { + "body": "Represents a day of the week in a month.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_WEEK_IN_MONTH = 8", + "source": "script-api", + "tags": [ + "day_of_week_in_month", + "calendar.day_of_week_in_month" + ], + "title": "Calendar.DAY_OF_WEEK_IN_MONTH" + }, + { + "description": "Represents a day of the week in a month.", + "id": "script-api:dw/util/Calendar#DAY_OF_WEEK_IN_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_WEEK_IN_MONTH", + "sections": [ + { + "body": "Represents a day of the week in a month.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_WEEK_IN_MONTH = 8", + "source": "script-api", + "tags": [ + "day_of_week_in_month", + "calendar.day_of_week_in_month" + ], + "title": "Calendar.DAY_OF_WEEK_IN_MONTH" + }, + { + "description": "Represents a day of the year.", + "id": "script-api:dw/util/Calendar#DAY_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_YEAR", + "sections": [ + { + "body": "Represents a day of the year.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_YEAR = 6", + "source": "script-api", + "tags": [ + "day_of_year", + "calendar.day_of_year" + ], + "title": "Calendar.DAY_OF_YEAR" + }, + { + "description": "Represents a day of the year.", + "id": "script-api:dw/util/Calendar#DAY_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DAY_OF_YEAR", + "sections": [ + { + "body": "Represents a day of the year.", + "heading": "Description" + } + ], + "signature": "static readonly DAY_OF_YEAR = 6", + "source": "script-api", + "tags": [ + "day_of_year", + "calendar.day_of_year" + ], + "title": "Calendar.DAY_OF_YEAR" + }, + { + "description": "Value for the month of year field representing December.", + "id": "script-api:dw/util/Calendar#DECEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DECEMBER", + "sections": [ + { + "body": "Value for the month of year field representing December.", + "heading": "Description" + } + ], + "signature": "static readonly DECEMBER = 11", + "source": "script-api", + "tags": [ + "december", + "calendar.december" + ], + "title": "Calendar.DECEMBER" + }, + { + "description": "Value for the month of year field representing December.", + "id": "script-api:dw/util/Calendar#DECEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DECEMBER", + "sections": [ + { + "body": "Value for the month of year field representing December.", + "heading": "Description" + } + ], + "signature": "static readonly DECEMBER = 11", + "source": "script-api", + "tags": [ + "december", + "calendar.december" + ], + "title": "Calendar.DECEMBER" + }, + { + "description": "Indicates the daylight savings offset in milliseconds.", + "id": "script-api:dw/util/Calendar#DST_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DST_OFFSET", + "sections": [ + { + "body": "Indicates the daylight savings offset in milliseconds.", + "heading": "Description" + } + ], + "signature": "static readonly DST_OFFSET = 16", + "source": "script-api", + "tags": [ + "dst_offset", + "calendar.dst_offset" + ], + "title": "Calendar.DST_OFFSET" + }, + { + "description": "Indicates the daylight savings offset in milliseconds.", + "id": "script-api:dw/util/Calendar#DST_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.DST_OFFSET", + "sections": [ + { + "body": "Indicates the daylight savings offset in milliseconds.", + "heading": "Description" + } + ], + "signature": "static readonly DST_OFFSET = 16", + "source": "script-api", + "tags": [ + "dst_offset", + "calendar.dst_offset" + ], + "title": "Calendar.DST_OFFSET" + }, + { + "description": "Indicates the era such as 'AD' or 'BC' in the Julian calendar.", + "id": "script-api:dw/util/Calendar#ERA", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ERA", + "sections": [ + { + "body": "Indicates the era such as 'AD' or 'BC' in the Julian calendar.", + "heading": "Description" + } + ], + "signature": "static readonly ERA = 0", + "source": "script-api", + "tags": [ + "era", + "calendar.era" + ], + "title": "Calendar.ERA" + }, + { + "description": "Indicates the era such as 'AD' or 'BC' in the Julian calendar.", + "id": "script-api:dw/util/Calendar#ERA", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ERA", + "sections": [ + { + "body": "Indicates the era such as 'AD' or 'BC' in the Julian calendar.", + "heading": "Description" + } + ], + "signature": "static readonly ERA = 0", + "source": "script-api", + "tags": [ + "era", + "calendar.era" + ], + "title": "Calendar.ERA" + }, + { + "description": "Value for the month of year field representing February.", + "id": "script-api:dw/util/Calendar#FEBRUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FEBRUARY", + "sections": [ + { + "body": "Value for the month of year field representing February.", + "heading": "Description" + } + ], + "signature": "static readonly FEBRUARY = 1", + "source": "script-api", + "tags": [ + "february", + "calendar.february" + ], + "title": "Calendar.FEBRUARY" + }, + { + "description": "Value for the month of year field representing February.", + "id": "script-api:dw/util/Calendar#FEBRUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FEBRUARY", + "sections": [ + { + "body": "Value for the month of year field representing February.", + "heading": "Description" + } + ], + "signature": "static readonly FEBRUARY = 1", + "source": "script-api", + "tags": [ + "february", + "calendar.february" + ], + "title": "Calendar.FEBRUARY" + }, + { + "description": "Value for the day of the week field representing Friday.", + "id": "script-api:dw/util/Calendar#FRIDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FRIDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Friday.", + "heading": "Description" + } + ], + "signature": "static readonly FRIDAY = 6", + "source": "script-api", + "tags": [ + "friday", + "calendar.friday" + ], + "title": "Calendar.FRIDAY" + }, + { + "description": "Value for the day of the week field representing Friday.", + "id": "script-api:dw/util/Calendar#FRIDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.FRIDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Friday.", + "heading": "Description" + } + ], + "signature": "static readonly FRIDAY = 6", + "source": "script-api", + "tags": [ + "friday", + "calendar.friday" + ], + "title": "Calendar.FRIDAY" + }, + { + "description": "Represents an hour.", + "id": "script-api:dw/util/Calendar#HOUR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR", + "sections": [ + { + "body": "Represents an hour.", + "heading": "Description" + } + ], + "signature": "static readonly HOUR = 10", + "source": "script-api", + "tags": [ + "hour", + "calendar.hour" + ], + "title": "Calendar.HOUR" + }, + { + "description": "Represents an hour.", + "id": "script-api:dw/util/Calendar#HOUR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR", + "sections": [ + { + "body": "Represents an hour.", + "heading": "Description" + } + ], + "signature": "static readonly HOUR = 10", + "source": "script-api", + "tags": [ + "hour", + "calendar.hour" + ], + "title": "Calendar.HOUR" + }, + { + "description": "Represents an hour of the day.", + "id": "script-api:dw/util/Calendar#HOUR_OF_DAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR_OF_DAY", + "sections": [ + { + "body": "Represents an hour of the day.", + "heading": "Description" + } + ], + "signature": "static readonly HOUR_OF_DAY = 11", + "source": "script-api", + "tags": [ + "hour_of_day", + "calendar.hour_of_day" + ], + "title": "Calendar.HOUR_OF_DAY" + }, + { + "description": "Represents an hour of the day.", + "id": "script-api:dw/util/Calendar#HOUR_OF_DAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.HOUR_OF_DAY", + "sections": [ + { + "body": "Represents an hour of the day.", + "heading": "Description" + } + ], + "signature": "static readonly HOUR_OF_DAY = 11", + "source": "script-api", + "tags": [ + "hour_of_day", + "calendar.hour_of_day" + ], + "title": "Calendar.HOUR_OF_DAY" + }, + { + "description": "The input date pattern, for instance MM/dd/yyyy", + "id": "script-api:dw/util/Calendar#INPUT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_PATTERN", + "sections": [ + { + "body": "The input date pattern, for instance MM/dd/yyyy", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_DATE_PATTERN = 3", + "source": "script-api", + "tags": [ + "input_date_pattern", + "calendar.input_date_pattern" + ], + "title": "Calendar.INPUT_DATE_PATTERN" + }, + { + "description": "The input date pattern, for instance MM/dd/yyyy", + "id": "script-api:dw/util/Calendar#INPUT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_PATTERN", + "sections": [ + { + "body": "The input date pattern, for instance MM/dd/yyyy", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_DATE_PATTERN = 3", + "source": "script-api", + "tags": [ + "input_date_pattern", + "calendar.input_date_pattern" + ], + "title": "Calendar.INPUT_DATE_PATTERN" + }, + { + "description": "The input date time pattern, for instance MM/dd/yyyy h:mm a", + "id": "script-api:dw/util/Calendar#INPUT_DATE_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_TIME_PATTERN", + "sections": [ + { + "body": "The input date time pattern, for instance MM/dd/yyyy h:mm a", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_DATE_TIME_PATTERN = 5", + "source": "script-api", + "tags": [ + "input_date_time_pattern", + "calendar.input_date_time_pattern" + ], + "title": "Calendar.INPUT_DATE_TIME_PATTERN" + }, + { + "description": "The input date time pattern, for instance MM/dd/yyyy h:mm a", + "id": "script-api:dw/util/Calendar#INPUT_DATE_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_DATE_TIME_PATTERN", + "sections": [ + { + "body": "The input date time pattern, for instance MM/dd/yyyy h:mm a", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_DATE_TIME_PATTERN = 5", + "source": "script-api", + "tags": [ + "input_date_time_pattern", + "calendar.input_date_time_pattern" + ], + "title": "Calendar.INPUT_DATE_TIME_PATTERN" + }, + { + "description": "The input time pattern, for instance h:mm a", + "id": "script-api:dw/util/Calendar#INPUT_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_TIME_PATTERN", + "sections": [ + { + "body": "The input time pattern, for instance h:mm a", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_TIME_PATTERN = 4", + "source": "script-api", + "tags": [ + "input_time_pattern", + "calendar.input_time_pattern" + ], + "title": "Calendar.INPUT_TIME_PATTERN" + }, + { + "description": "The input time pattern, for instance h:mm a", + "id": "script-api:dw/util/Calendar#INPUT_TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.INPUT_TIME_PATTERN", + "sections": [ + { + "body": "The input time pattern, for instance h:mm a", + "heading": "Description" + } + ], + "signature": "static readonly INPUT_TIME_PATTERN = 4", + "source": "script-api", + "tags": [ + "input_time_pattern", + "calendar.input_time_pattern" + ], + "title": "Calendar.INPUT_TIME_PATTERN" + }, + { + "description": "Value for the month of year field representing January.", + "id": "script-api:dw/util/Calendar#JANUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JANUARY", + "sections": [ + { + "body": "Value for the month of year field representing January.", + "heading": "Description" + } + ], + "signature": "static readonly JANUARY = 0", + "source": "script-api", + "tags": [ + "january", + "calendar.january" + ], + "title": "Calendar.JANUARY" + }, + { + "description": "Value for the month of year field representing January.", + "id": "script-api:dw/util/Calendar#JANUARY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JANUARY", + "sections": [ + { + "body": "Value for the month of year field representing January.", + "heading": "Description" + } + ], + "signature": "static readonly JANUARY = 0", + "source": "script-api", + "tags": [ + "january", + "calendar.january" + ], + "title": "Calendar.JANUARY" + }, + { + "description": "Value for the month of year field representing July.", + "id": "script-api:dw/util/Calendar#JULY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JULY", + "sections": [ + { + "body": "Value for the month of year field representing July.", + "heading": "Description" + } + ], + "signature": "static readonly JULY = 6", + "source": "script-api", + "tags": [ + "july", + "calendar.july" + ], + "title": "Calendar.JULY" + }, + { + "description": "Value for the month of year field representing July.", + "id": "script-api:dw/util/Calendar#JULY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JULY", + "sections": [ + { + "body": "Value for the month of year field representing July.", + "heading": "Description" + } + ], + "signature": "static readonly JULY = 6", + "source": "script-api", + "tags": [ + "july", + "calendar.july" + ], + "title": "Calendar.JULY" + }, + { + "description": "Value for the month of year field representing June.", + "id": "script-api:dw/util/Calendar#JUNE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JUNE", + "sections": [ + { + "body": "Value for the month of year field representing June.", + "heading": "Description" + } + ], + "signature": "static readonly JUNE = 5", + "source": "script-api", + "tags": [ + "june", + "calendar.june" + ], + "title": "Calendar.JUNE" + }, + { + "description": "Value for the month of year field representing June.", + "id": "script-api:dw/util/Calendar#JUNE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.JUNE", + "sections": [ + { + "body": "Value for the month of year field representing June.", + "heading": "Description" + } + ], + "signature": "static readonly JUNE = 5", + "source": "script-api", + "tags": [ + "june", + "calendar.june" + ], + "title": "Calendar.JUNE" + }, + { + "description": "The long date pattern, for instance MMM/d/yyyy", + "id": "script-api:dw/util/Calendar#LONG_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.LONG_DATE_PATTERN", + "sections": [ + { + "body": "The long date pattern, for instance MMM/d/yyyy", + "heading": "Description" + } + ], + "signature": "static readonly LONG_DATE_PATTERN = 1", + "source": "script-api", + "tags": [ + "long_date_pattern", + "calendar.long_date_pattern" + ], + "title": "Calendar.LONG_DATE_PATTERN" + }, + { + "description": "The long date pattern, for instance MMM/d/yyyy", + "id": "script-api:dw/util/Calendar#LONG_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.LONG_DATE_PATTERN", + "sections": [ + { + "body": "The long date pattern, for instance MMM/d/yyyy", + "heading": "Description" + } + ], + "signature": "static readonly LONG_DATE_PATTERN = 1", + "source": "script-api", + "tags": [ + "long_date_pattern", + "calendar.long_date_pattern" + ], + "title": "Calendar.LONG_DATE_PATTERN" + }, + { + "description": "Value for the month of year field representing March.", + "id": "script-api:dw/util/Calendar#MARCH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MARCH", + "sections": [ + { + "body": "Value for the month of year field representing March.", + "heading": "Description" + } + ], + "signature": "static readonly MARCH = 2", + "source": "script-api", + "tags": [ + "march", + "calendar.march" + ], + "title": "Calendar.MARCH" + }, + { + "description": "Value for the month of year field representing March.", + "id": "script-api:dw/util/Calendar#MARCH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MARCH", + "sections": [ + { + "body": "Value for the month of year field representing March.", + "heading": "Description" + } + ], + "signature": "static readonly MARCH = 2", + "source": "script-api", + "tags": [ + "march", + "calendar.march" + ], + "title": "Calendar.MARCH" + }, + { + "description": "Value for the month of year field representing May.", + "id": "script-api:dw/util/Calendar#MAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MAY", + "sections": [ + { + "body": "Value for the month of year field representing May.", + "heading": "Description" + } + ], + "signature": "static readonly MAY = 4", + "source": "script-api", + "tags": [ + "may", + "calendar.may" + ], + "title": "Calendar.MAY" + }, + { + "description": "Value for the month of year field representing May.", + "id": "script-api:dw/util/Calendar#MAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MAY", + "sections": [ + { + "body": "Value for the month of year field representing May.", + "heading": "Description" + } + ], + "signature": "static readonly MAY = 4", + "source": "script-api", + "tags": [ + "may", + "calendar.may" + ], + "title": "Calendar.MAY" + }, + { + "description": "Represents a millisecond.", + "id": "script-api:dw/util/Calendar#MILLISECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MILLISECOND", + "sections": [ + { + "body": "Represents a millisecond.", + "heading": "Description" + } + ], + "signature": "static readonly MILLISECOND = 14", + "source": "script-api", + "tags": [ + "millisecond", + "calendar.millisecond" + ], + "title": "Calendar.MILLISECOND" + }, + { + "description": "Represents a millisecond.", + "id": "script-api:dw/util/Calendar#MILLISECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MILLISECOND", + "sections": [ + { + "body": "Represents a millisecond.", + "heading": "Description" + } + ], + "signature": "static readonly MILLISECOND = 14", + "source": "script-api", + "tags": [ + "millisecond", + "calendar.millisecond" + ], + "title": "Calendar.MILLISECOND" + }, + { + "description": "Represents a minute.", + "id": "script-api:dw/util/Calendar#MINUTE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MINUTE", + "sections": [ + { + "body": "Represents a minute.", + "heading": "Description" + } + ], + "signature": "static readonly MINUTE = 12", + "source": "script-api", + "tags": [ + "minute", + "calendar.minute" + ], + "title": "Calendar.MINUTE" + }, + { + "description": "Represents a minute.", + "id": "script-api:dw/util/Calendar#MINUTE", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MINUTE", + "sections": [ + { + "body": "Represents a minute.", + "heading": "Description" + } + ], + "signature": "static readonly MINUTE = 12", + "source": "script-api", + "tags": [ + "minute", + "calendar.minute" + ], + "title": "Calendar.MINUTE" + }, + { + "description": "Value for the day of the week field representing Monday.", + "id": "script-api:dw/util/Calendar#MONDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Monday.", + "heading": "Description" + } + ], + "signature": "static readonly MONDAY = 2", + "source": "script-api", + "tags": [ + "monday", + "calendar.monday" + ], + "title": "Calendar.MONDAY" + }, + { + "description": "Value for the day of the week field representing Monday.", + "id": "script-api:dw/util/Calendar#MONDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Monday.", + "heading": "Description" + } + ], + "signature": "static readonly MONDAY = 2", + "source": "script-api", + "tags": [ + "monday", + "calendar.monday" + ], + "title": "Calendar.MONDAY" + }, + { + "description": "Represents a month where the first month of the year is 0.", + "id": "script-api:dw/util/Calendar#MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONTH", + "sections": [ + { + "body": "Represents a month where the first month of the year is 0.", + "heading": "Description" + } + ], + "signature": "static readonly MONTH = 2", + "source": "script-api", + "tags": [ + "month", + "calendar.month" + ], + "title": "Calendar.MONTH" + }, + { + "description": "Represents a month where the first month of the year is 0.", + "id": "script-api:dw/util/Calendar#MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.MONTH", + "sections": [ + { + "body": "Represents a month where the first month of the year is 0.", + "heading": "Description" + } + ], + "signature": "static readonly MONTH = 2", + "source": "script-api", + "tags": [ + "month", + "calendar.month" + ], + "title": "Calendar.MONTH" + }, + { + "description": "Value for the month of year field representing November.", + "id": "script-api:dw/util/Calendar#NOVEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.NOVEMBER", + "sections": [ + { + "body": "Value for the month of year field representing November.", + "heading": "Description" + } + ], + "signature": "static readonly NOVEMBER = 10", + "source": "script-api", + "tags": [ + "november", + "calendar.november" + ], + "title": "Calendar.NOVEMBER" + }, + { + "description": "Value for the month of year field representing November.", + "id": "script-api:dw/util/Calendar#NOVEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.NOVEMBER", + "sections": [ + { + "body": "Value for the month of year field representing November.", + "heading": "Description" + } + ], + "signature": "static readonly NOVEMBER = 10", + "source": "script-api", + "tags": [ + "november", + "calendar.november" + ], + "title": "Calendar.NOVEMBER" + }, + { + "description": "Value for the month of year field representing October.", + "id": "script-api:dw/util/Calendar#OCTOBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.OCTOBER", + "sections": [ + { + "body": "Value for the month of year field representing October.", + "heading": "Description" + } + ], + "signature": "static readonly OCTOBER = 9", + "source": "script-api", + "tags": [ + "october", + "calendar.october" + ], + "title": "Calendar.OCTOBER" + }, + { + "description": "Value for the month of year field representing October.", + "id": "script-api:dw/util/Calendar#OCTOBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.OCTOBER", + "sections": [ + { + "body": "Value for the month of year field representing October.", + "heading": "Description" + } + ], + "signature": "static readonly OCTOBER = 9", + "source": "script-api", + "tags": [ + "october", + "calendar.october" + ], + "title": "Calendar.OCTOBER" + }, + { + "description": "Value for the day of the week field representing Saturday.", + "id": "script-api:dw/util/Calendar#SATURDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SATURDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Saturday.", + "heading": "Description" + } + ], + "signature": "static readonly SATURDAY = 7", + "source": "script-api", + "tags": [ + "saturday", + "calendar.saturday" + ], + "title": "Calendar.SATURDAY" + }, + { + "description": "Value for the day of the week field representing Saturday.", + "id": "script-api:dw/util/Calendar#SATURDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SATURDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Saturday.", + "heading": "Description" + } + ], + "signature": "static readonly SATURDAY = 7", + "source": "script-api", + "tags": [ + "saturday", + "calendar.saturday" + ], + "title": "Calendar.SATURDAY" + }, + { + "description": "Represents a second.", + "id": "script-api:dw/util/Calendar#SECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SECOND", + "sections": [ + { + "body": "Represents a second.", + "heading": "Description" + } + ], + "signature": "static readonly SECOND = 13", + "source": "script-api", + "tags": [ + "second", + "calendar.second" + ], + "title": "Calendar.SECOND" + }, + { + "description": "Represents a second.", + "id": "script-api:dw/util/Calendar#SECOND", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SECOND", + "sections": [ + { + "body": "Represents a second.", + "heading": "Description" + } + ], + "signature": "static readonly SECOND = 13", + "source": "script-api", + "tags": [ + "second", + "calendar.second" + ], + "title": "Calendar.SECOND" + }, + { + "description": "Value for the month of year field representing September.", + "id": "script-api:dw/util/Calendar#SEPTEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SEPTEMBER", + "sections": [ + { + "body": "Value for the month of year field representing September.", + "heading": "Description" + } + ], + "signature": "static readonly SEPTEMBER = 8", + "source": "script-api", + "tags": [ + "september", + "calendar.september" + ], + "title": "Calendar.SEPTEMBER" + }, + { + "description": "Value for the month of year field representing September.", + "id": "script-api:dw/util/Calendar#SEPTEMBER", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SEPTEMBER", + "sections": [ + { + "body": "Value for the month of year field representing September.", + "heading": "Description" + } + ], + "signature": "static readonly SEPTEMBER = 8", + "source": "script-api", + "tags": [ + "september", + "calendar.september" + ], + "title": "Calendar.SEPTEMBER" + }, + { + "description": "The short date pattern, for instance M/d/yy", + "id": "script-api:dw/util/Calendar#SHORT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SHORT_DATE_PATTERN", + "sections": [ + { + "body": "The short date pattern, for instance M/d/yy", + "heading": "Description" + } + ], + "signature": "static readonly SHORT_DATE_PATTERN = 0", + "source": "script-api", + "tags": [ + "short_date_pattern", + "calendar.short_date_pattern" + ], + "title": "Calendar.SHORT_DATE_PATTERN" + }, + { + "description": "The short date pattern, for instance M/d/yy", + "id": "script-api:dw/util/Calendar#SHORT_DATE_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SHORT_DATE_PATTERN", + "sections": [ + { + "body": "The short date pattern, for instance M/d/yy", + "heading": "Description" + } + ], + "signature": "static readonly SHORT_DATE_PATTERN = 0", + "source": "script-api", + "tags": [ + "short_date_pattern", + "calendar.short_date_pattern" + ], + "title": "Calendar.SHORT_DATE_PATTERN" + }, + { + "description": "Value for the day of the week field representing Sunday.", + "id": "script-api:dw/util/Calendar#SUNDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SUNDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Sunday.", + "heading": "Description" + } + ], + "signature": "static readonly SUNDAY = 1", + "source": "script-api", + "tags": [ + "sunday", + "calendar.sunday" + ], + "title": "Calendar.SUNDAY" + }, + { + "description": "Value for the day of the week field representing Sunday.", + "id": "script-api:dw/util/Calendar#SUNDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.SUNDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Sunday.", + "heading": "Description" + } + ], + "signature": "static readonly SUNDAY = 1", + "source": "script-api", + "tags": [ + "sunday", + "calendar.sunday" + ], + "title": "Calendar.SUNDAY" + }, + { + "description": "Value for the day of the week field representing Thursday.", + "id": "script-api:dw/util/Calendar#THURSDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.THURSDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Thursday.", + "heading": "Description" + } + ], + "signature": "static readonly THURSDAY = 5", + "source": "script-api", + "tags": [ + "thursday", + "calendar.thursday" + ], + "title": "Calendar.THURSDAY" + }, + { + "description": "Value for the day of the week field representing Thursday.", + "id": "script-api:dw/util/Calendar#THURSDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.THURSDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Thursday.", + "heading": "Description" + } + ], + "signature": "static readonly THURSDAY = 5", + "source": "script-api", + "tags": [ + "thursday", + "calendar.thursday" + ], + "title": "Calendar.THURSDAY" + }, + { + "description": "The time pattern, for instance h:mm:ss a", + "id": "script-api:dw/util/Calendar#TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TIME_PATTERN", + "sections": [ + { + "body": "The time pattern, for instance h:mm:ss a", + "heading": "Description" + } + ], + "signature": "static readonly TIME_PATTERN = 2", + "source": "script-api", + "tags": [ + "time_pattern", + "calendar.time_pattern" + ], + "title": "Calendar.TIME_PATTERN" + }, + { + "description": "The time pattern, for instance h:mm:ss a", + "id": "script-api:dw/util/Calendar#TIME_PATTERN", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TIME_PATTERN", + "sections": [ + { + "body": "The time pattern, for instance h:mm:ss a", + "heading": "Description" + } + ], + "signature": "static readonly TIME_PATTERN = 2", + "source": "script-api", + "tags": [ + "time_pattern", + "calendar.time_pattern" + ], + "title": "Calendar.TIME_PATTERN" + }, + { + "description": "Value for the day of the week field representing Tuesday.", + "id": "script-api:dw/util/Calendar#TUESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TUESDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Tuesday.", + "heading": "Description" + } + ], + "signature": "static readonly TUESDAY = 3", + "source": "script-api", + "tags": [ + "tuesday", + "calendar.tuesday" + ], + "title": "Calendar.TUESDAY" + }, + { + "description": "Value for the day of the week field representing Tuesday.", + "id": "script-api:dw/util/Calendar#TUESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.TUESDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Tuesday.", + "heading": "Description" + } + ], + "signature": "static readonly TUESDAY = 3", + "source": "script-api", + "tags": [ + "tuesday", + "calendar.tuesday" + ], + "title": "Calendar.TUESDAY" + }, + { + "description": "Value for the day of the week field representing Wednesday.", + "id": "script-api:dw/util/Calendar#WEDNESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEDNESDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Wednesday.", + "heading": "Description" + } + ], + "signature": "static readonly WEDNESDAY = 4", + "source": "script-api", + "tags": [ + "wednesday", + "calendar.wednesday" + ], + "title": "Calendar.WEDNESDAY" + }, + { + "description": "Value for the day of the week field representing Wednesday.", + "id": "script-api:dw/util/Calendar#WEDNESDAY", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEDNESDAY", + "sections": [ + { + "body": "Value for the day of the week field representing Wednesday.", + "heading": "Description" + } + ], + "signature": "static readonly WEDNESDAY = 4", + "source": "script-api", + "tags": [ + "wednesday", + "calendar.wednesday" + ], + "title": "Calendar.WEDNESDAY" + }, + { + "description": "Represents a week of the month.", + "id": "script-api:dw/util/Calendar#WEEK_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_MONTH", + "sections": [ + { + "body": "Represents a week of the month.", + "heading": "Description" + } + ], + "signature": "static readonly WEEK_OF_MONTH = 4", + "source": "script-api", + "tags": [ + "week_of_month", + "calendar.week_of_month" + ], + "title": "Calendar.WEEK_OF_MONTH" + }, + { + "description": "Represents a week of the month.", + "id": "script-api:dw/util/Calendar#WEEK_OF_MONTH", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_MONTH", + "sections": [ + { + "body": "Represents a week of the month.", + "heading": "Description" + } + ], + "signature": "static readonly WEEK_OF_MONTH = 4", + "source": "script-api", + "tags": [ + "week_of_month", + "calendar.week_of_month" + ], + "title": "Calendar.WEEK_OF_MONTH" + }, + { + "description": "Represents a week in the year.", + "id": "script-api:dw/util/Calendar#WEEK_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_YEAR", + "sections": [ + { + "body": "Represents a week in the year.", + "heading": "Description" + } + ], + "signature": "static readonly WEEK_OF_YEAR = 3", + "source": "script-api", + "tags": [ + "week_of_year", + "calendar.week_of_year" + ], + "title": "Calendar.WEEK_OF_YEAR" + }, + { + "description": "Represents a week in the year.", + "id": "script-api:dw/util/Calendar#WEEK_OF_YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.WEEK_OF_YEAR", + "sections": [ + { + "body": "Represents a week in the year.", + "heading": "Description" + } + ], + "signature": "static readonly WEEK_OF_YEAR = 3", + "source": "script-api", + "tags": [ + "week_of_year", + "calendar.week_of_year" + ], + "title": "Calendar.WEEK_OF_YEAR" + }, + { + "description": "Represents a year.", + "id": "script-api:dw/util/Calendar#YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.YEAR", + "sections": [ + { + "body": "Represents a year.", + "heading": "Description" + } + ], + "signature": "static readonly YEAR = 1", + "source": "script-api", + "tags": [ + "year", + "calendar.year" + ], + "title": "Calendar.YEAR" + }, + { + "description": "Represents a year.", + "id": "script-api:dw/util/Calendar#YEAR", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.YEAR", + "sections": [ + { + "body": "Represents a year.", + "heading": "Description" + } + ], + "signature": "static readonly YEAR = 1", + "source": "script-api", + "tags": [ + "year", + "calendar.year" + ], + "title": "Calendar.YEAR" + }, + { + "description": "Indicates the raw offset from GMT in milliseconds.", + "id": "script-api:dw/util/Calendar#ZONE_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ZONE_OFFSET", + "sections": [ + { + "body": "Indicates the raw offset from GMT in milliseconds.", + "heading": "Description" + } + ], + "signature": "static readonly ZONE_OFFSET = 15", + "source": "script-api", + "tags": [ + "zone_offset", + "calendar.zone_offset" + ], + "title": "Calendar.ZONE_OFFSET" + }, + { + "description": "Indicates the raw offset from GMT in milliseconds.", + "id": "script-api:dw/util/Calendar#ZONE_OFFSET", + "kind": "constant", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.ZONE_OFFSET", + "sections": [ + { + "body": "Indicates the raw offset from GMT in milliseconds.", + "heading": "Description" + } + ], + "signature": "static readonly ZONE_OFFSET = 15", + "source": "script-api", + "tags": [ + "zone_offset", + "calendar.zone_offset" + ], + "title": "Calendar.ZONE_OFFSET" + }, + { + "description": "Adds or subtracts the specified amount of time to the given calendar field, based on the calendar's rules.", + "id": "script-api:dw/util/Calendar#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + }, + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.add", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds or subtracts the specified amount of time to the given\ncalendar field, based on the calendar's rules.", + "heading": "Description" + } + ], + "signature": "add(field: number, value: number): void", + "source": "script-api", + "tags": [ + "add", + "calendar.add" + ], + "title": "Calendar.add" + }, + { + "description": "Indicates if this Calendar represents a time after the time represented by the specified Object.", + "id": "script-api:dw/util/Calendar#after", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "obj", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.after", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if this Calendar represents a time after\nthe time represented by the specified Object.", + "heading": "Description" + } + ], + "signature": "after(obj: any): boolean", + "source": "script-api", + "tags": [ + "after", + "calendar.after" + ], + "title": "Calendar.after" + }, + { + "description": "Indicates if this Calendar represents a time before the time represented by the specified Object.", + "id": "script-api:dw/util/Calendar#before", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "obj", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.before", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if this Calendar represents a time before\nthe time represented by the specified Object.", + "heading": "Description" + } + ], + "signature": "before(obj: any): boolean", + "source": "script-api", + "tags": [ + "before", + "calendar.before" + ], + "title": "Calendar.before" + }, + { + "description": "Sets all the calendar field values and the time value (millisecond offset from the Epoch) of this Calendar undefined.", + "id": "script-api:dw/util/Calendar#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.clear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets all the calendar field values and the time value\n(millisecond offset from the Epoch) of this Calendar undefined.", + "heading": "Description" + } + ], + "signature": "clear(): void", + "source": "script-api", + "tags": [ + "clear", + "calendar.clear" + ], + "title": "Calendar.clear" + }, + { + "description": "Sets the given calendar field value and the time value (millisecond offset from the Epoch) of this Calendar undefined.", + "id": "script-api:dw/util/Calendar#clear", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.clear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the given calendar field value and the time value\n(millisecond offset from the Epoch) of this Calendar undefined.", + "heading": "Description" + } + ], + "signature": "clear(field: number): void", + "source": "script-api", + "tags": [ + "clear", + "calendar.clear" + ], + "title": "Calendar.clear" + }, + { + "description": "Compares the time values (millisecond offsets from the Epoch) represented by two Calendar objects.", + "id": "script-api:dw/util/Calendar#compareTo", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "anotherCalendar", + "type": "Calendar" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.compareTo", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Compares the time values (millisecond offsets from the Epoch)\nrepresented by two Calendar objects.", + "heading": "Description" + } + ], + "signature": "compareTo(anotherCalendar: Calendar): number", + "source": "script-api", + "tags": [ + "compareto", + "calendar.compareto" + ], + "title": "Calendar.compareTo" + }, + { + "description": "Compares two calendar values whether they are equivalent.", + "id": "script-api:dw/util/Calendar#equals", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.equals", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Compares two calendar values whether they are equivalent.", + "heading": "Description" + } + ], + "signature": "equals(other: any): boolean", + "source": "script-api", + "tags": [ + "equals", + "calendar.equals" + ], + "title": "Calendar.equals" + }, + { + "description": "Returns the first day of the week base on locale context. For example, in the US the first day of the week is SUNDAY. However, in France the first day of the week is MONDAY.", + "id": "script-api:dw/util/Calendar#firstDayOfWeek", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.firstDayOfWeek", + "sections": [ + { + "body": "Returns the first day of the week base on locale context. For example, in the US\nthe first day of the week is SUNDAY. However, in France the\nfirst day of the week is MONDAY.", + "heading": "Description" + } + ], + "signature": "firstDayOfWeek: number", + "source": "script-api", + "tags": [ + "firstdayofweek", + "calendar.firstdayofweek" + ], + "title": "Calendar.firstDayOfWeek" + }, + { + "description": "Returns the value of the given calendar field.", + "id": "script-api:dw/util/Calendar#get", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.get", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value of the given calendar field.", + "heading": "Description" + } + ], + "signature": "get(field: number): number", + "source": "script-api", + "tags": [ + "get", + "calendar.get" + ], + "title": "Calendar.get" + }, + { + "description": "Returns the maximum value that the specified calendar field could have.", + "id": "script-api:dw/util/Calendar#getActualMaximum", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getActualMaximum", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum value that the specified calendar\nfield could have.", + "heading": "Description" + } + ], + "signature": "getActualMaximum(field: number): number", + "source": "script-api", + "tags": [ + "getactualmaximum", + "calendar.getactualmaximum" + ], + "title": "Calendar.getActualMaximum" + }, + { + "description": "Returns the minimum value that the specified calendar field could have.", + "id": "script-api:dw/util/Calendar#getActualMinimum", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getActualMinimum", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum value that the specified calendar\nfield could have.", + "heading": "Description" + } + ], + "signature": "getActualMinimum(field: number): number", + "source": "script-api", + "tags": [ + "getactualminimum", + "calendar.getactualminimum" + ], + "title": "Calendar.getActualMinimum" + }, + { + "description": "Returns the first day of the week base on locale context. For example, in the US the first day of the week is SUNDAY. However, in France the first day of the week is MONDAY.", + "id": "script-api:dw/util/Calendar#getFirstDayOfWeek", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getFirstDayOfWeek", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the first day of the week base on locale context. For example, in the US\nthe first day of the week is SUNDAY. However, in France the\nfirst day of the week is MONDAY.", + "heading": "Description" + } + ], + "signature": "getFirstDayOfWeek(): number", + "source": "script-api", + "tags": [ + "getfirstdayofweek", + "calendar.getfirstdayofweek" + ], + "title": "Calendar.getFirstDayOfWeek" + }, + { + "description": "Returns the maximum value for the given calendar field.", + "id": "script-api:dw/util/Calendar#getMaximum", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getMaximum", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the maximum value for the given calendar\nfield.", + "heading": "Description" + } + ], + "signature": "getMaximum(field: number): number", + "source": "script-api", + "tags": [ + "getmaximum", + "calendar.getmaximum" + ], + "title": "Calendar.getMaximum" + }, + { + "description": "Returns the minimum value for the given calendar field.", + "id": "script-api:dw/util/Calendar#getMinimum", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getMinimum", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the minimum value for the given calendar\nfield.", + "heading": "Description" + } + ], + "signature": "getMinimum(field: number): number", + "source": "script-api", + "tags": [ + "getminimum", + "calendar.getminimum" + ], + "title": "Calendar.getMinimum" + }, + { + "description": "Returns the current time stamp of this calendar. This method is also used to convert a Calendar into a Date.", + "id": "script-api:dw/util/Calendar#getTime", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getTime", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current time stamp of this calendar. This method\nis also used to convert a Calendar into a Date.\n\nWARNING: Keep in mind that the returned Date object's time is always\ninterpreted in the time zone GMT. This means time zone information\nset at the calendar object will not be honored and gets lost.", + "heading": "Description" + } + ], + "signature": "getTime(): Date", + "source": "script-api", + "tags": [ + "gettime", + "calendar.gettime" + ], + "title": "Calendar.getTime" + }, + { + "description": "Returns the current time zone of this calendar.", + "id": "script-api:dw/util/Calendar#getTimeZone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.getTimeZone", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the current time zone of this calendar.", + "heading": "Description" + } + ], + "signature": "getTimeZone(): string", + "source": "script-api", + "tags": [ + "gettimezone", + "calendar.gettimezone" + ], + "title": "Calendar.getTimeZone" + }, + { + "description": "Calculates the hash code for a calendar;", + "id": "script-api:dw/util/Calendar#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.hashCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Calculates the hash code for a calendar;", + "heading": "Description" + } + ], + "signature": "hashCode(): number", + "source": "script-api", + "tags": [ + "hashcode", + "calendar.hashcode" + ], + "title": "Calendar.hashCode" + }, + { + "description": "Indicates if the specified year is a leap year.", + "id": "script-api:dw/util/Calendar#isLeapYear", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "year", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isLeapYear", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the specified year is a leap year.", + "heading": "Description" + } + ], + "signature": "isLeapYear(year: number): boolean", + "source": "script-api", + "tags": [ + "isleapyear", + "calendar.isleapyear" + ], + "title": "Calendar.isLeapYear" + }, + { + "description": "Checks, whether two calendar dates fall on the same day.", + "examples": [ + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDay( new Calendar( new Date( \"2002/02/28 06:01\" ) ) );", + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDay( new Calendar( new Date( \"2002/02/12 13:45\" ) ) );", + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDay( new Calendar( new Date( \"1970/02/28 13:45\" ) ) );", + "var cal1 = new Calendar( new Date( \"2002/02/28 02:00\" );\ncal1.setTimeZone( \"Etc/GMT+1\" );\nvar cal2 = new Calendar( new Date( \"2002/02/28 00:00\" );\ncal2.setTimeZone( \"Etc/GMT+1\" );\ncal1.isSameDay( cal2 );" + ], + "id": "script-api:dw/util/Calendar#isSameDay", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "Calendar" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSameDay", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks, whether two calendar dates fall on the same day.\n\nThe method performs comparison based on both calendar's\nfield values by honoring the defined time zones.\n\nExamples:\n\n\nwould return true.\n\n\nwould return false.\n\n\nwould return false.\n\n\nwould return false since the time zone is applied first which results in comparing `2002/02/28 01:00` for `cal1`\nwith `2002/02/27 23:00` for `cal2`.", + "heading": "Description" + } + ], + "signature": "isSameDay(other: Calendar): boolean", + "source": "script-api", + "tags": [ + "issameday", + "calendar.issameday" + ], + "title": "Calendar.isSameDay" + }, + { + "description": "Checks, whether two calendar dates fall on the same day.", + "examples": [ + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDayByTimestamp( new Calendar( new Date( \"2002/02/28 06:01\" ) ) );", + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDayByTimestamp( new Calendar( new Date( \"2002/02/12 13:45\" ) ) );", + "new Calendar( new Date( \"2002/02/28 13:45\" ).isSameDayByTimestamp( new Calendar( new Date( \"1970/02/28 13:45\" ) ) );", + "var cal1 = new Calendar( new Date( \"2002/02/28 02:00\" );\ncal1.setTimeZone( \"Etc/GMT+1\" );\nvar cal2 = new Calendar( new Date( \"2002/02/28 00:00\" );\ncal2.setTimeZone( \"Etc/GMT+1\" );\ncal1.isSameDayByTimestamp( cal2 );" + ], + "id": "script-api:dw/util/Calendar#isSameDayByTimestamp", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "Calendar" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSameDayByTimestamp", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Checks, whether two calendar dates fall on the same day.\n\nThe method performs comparison based on both calendar's\ntime stamps by ignoring any defined time zones.\n\nExamples:\n\n\nwould return true.\n\n\nwould return false.\n\n\nwould return false.\n\n\nwould return true since the time zone is not applied first which results in comparing `2002/02/28 02:00` for `cal1`\nwith `2002/02/28 00:00` for `cal2`.", + "heading": "Description" + } + ], + "signature": "isSameDayByTimestamp(other: Calendar): boolean", + "source": "script-api", + "tags": [ + "issamedaybytimestamp", + "calendar.issamedaybytimestamp" + ], + "title": "Calendar.isSameDayByTimestamp" + }, + { + "description": "Indicates if the field is set.", + "id": "script-api:dw/util/Calendar#isSet", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.isSet", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if the field is set.", + "heading": "Description" + } + ], + "signature": "isSet(field: number): boolean", + "source": "script-api", + "tags": [ + "isset", + "calendar.isset" + ], + "title": "Calendar.isSet" + }, + { + "description": "Parses the string according to the date and time format pattern and set the time at this calendar object. For the specification of the date and time format pattern see the javadoc of the JDK class java.text.SimpleDateFormat. If a time zone is included in the format string, this time zone is used to interpet the time. Otherwise the currently set calendar time zone is used to parse the given time string.", + "id": "script-api:dw/util/Calendar#parseByFormat", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "timeString", + "type": "string" + }, + { + "name": "format", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.parseByFormat", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Parses the string according to the date and time format pattern and set\nthe time at this calendar object. For the specification of the date and\ntime format pattern see the javadoc of the JDK class java.text.SimpleDateFormat.\nIf a time zone is included in the format string,\nthis time zone is used to interpet the time. Otherwise the currently set\ncalendar time zone is used to parse the given time string.", + "heading": "Description" + } + ], + "signature": "parseByFormat(timeString: string, format: string): void", + "source": "script-api", + "tags": [ + "parsebyformat", + "calendar.parsebyformat" + ], + "title": "Calendar.parseByFormat" + }, + { + "description": "Parses the string according the date format pattern of the given locale. If the locale name is invalid, an exception is thrown. The currently set calendar time zone is used to parse the given time string.", + "id": "script-api:dw/util/Calendar#parseByLocale", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "timeString", + "type": "string" + }, + { + "name": "locale", + "type": "string" + }, + { + "name": "pattern", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.parseByLocale", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Parses the string according the date format pattern of the given locale.\nIf the locale name is invalid, an exception is thrown. The currently set\ncalendar time zone is used to parse the given time string.", + "heading": "Description" + } + ], + "signature": "parseByLocale(timeString: string, locale: string, pattern: number): void", + "source": "script-api", + "tags": [ + "parsebylocale", + "calendar.parsebylocale" + ], + "title": "Calendar.parseByLocale" + }, + { + "description": "Rolls the specified field up or down one value.", + "id": "script-api:dw/util/Calendar#roll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + }, + { + "name": "up", + "type": "boolean" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.roll", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Rolls the specified field up or down one value.", + "heading": "Description" + } + ], + "signature": "roll(field: number, up: boolean): void", + "source": "script-api", + "tags": [ + "roll", + "calendar.roll" + ], + "title": "Calendar.roll" + }, + { + "description": "Rolls the specified field using the specified value.", + "id": "script-api:dw/util/Calendar#roll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + }, + { + "name": "amount", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.roll", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Rolls the specified field using the specified value.", + "heading": "Description" + } + ], + "signature": "roll(field: number, amount: number): void", + "source": "script-api", + "tags": [ + "roll", + "calendar.roll" + ], + "title": "Calendar.roll" + }, + { + "description": "Sets the given calendar field to the given value.", + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "field", + "type": "number" + }, + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the given calendar field to the given value.", + "heading": "Description" + } + ], + "signature": "set(field: number, value: number): void", + "source": "script-api", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "description": "Sets the values for the calendar fields YEAR, MONTH, and DAY_OF_MONTH.", + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "year", + "type": "number" + }, + { + "name": "month", + "type": "number" + }, + { + "name": "date", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the values for the calendar fields YEAR, MONTH, and DAY_OF_MONTH.", + "heading": "Description" + } + ], + "signature": "set(year: number, month: number, date: number): void", + "source": "script-api", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "description": "Sets the values for the calendar fields YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, and MINUTE.", + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "year", + "type": "number" + }, + { + "name": "month", + "type": "number" + }, + { + "name": "date", + "type": "number" + }, + { + "name": "hourOfDay", + "type": "number" + }, + { + "name": "minute", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the values for the calendar fields YEAR, MONTH,\nDAY_OF_MONTH, HOUR_OF_DAY, and MINUTE.", + "heading": "Description" + } + ], + "signature": "set(year: number, month: number, date: number, hourOfDay: number, minute: number): void", + "source": "script-api", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "description": "Sets the values for the calendar fields YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE and SECOND.", + "id": "script-api:dw/util/Calendar#set", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "year", + "type": "number" + }, + { + "name": "month", + "type": "number" + }, + { + "name": "date", + "type": "number" + }, + { + "name": "hourOfDay", + "type": "number" + }, + { + "name": "minute", + "type": "number" + }, + { + "name": "second", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.set", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the values for the calendar fields YEAR, MONTH,\nDAY_OF_MONTH, HOUR_OF_DAY, MINUTE and SECOND.", + "heading": "Description" + } + ], + "signature": "set(year: number, month: number, date: number, hourOfDay: number, minute: number, second: number): void", + "source": "script-api", + "tags": [ + "set", + "calendar.set" + ], + "title": "Calendar.set" + }, + { + "description": "Sets what the first day of the week is.", + "id": "script-api:dw/util/Calendar#setFirstDayOfWeek", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setFirstDayOfWeek", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets what the first day of the week is.", + "heading": "Description" + } + ], + "signature": "setFirstDayOfWeek(value: number): void", + "source": "script-api", + "tags": [ + "setfirstdayofweek", + "calendar.setfirstdayofweek" + ], + "title": "Calendar.setFirstDayOfWeek" + }, + { + "description": "Sets the current time stamp of this calendar.", + "id": "script-api:dw/util/Calendar#setTime", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "date", + "type": "Date" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setTime", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the current time stamp of this calendar.\n\nWARNING: Keep in mind that the set Date object's time is always\ninterpreted in the time zone GMT. This means that time zone\ninformation at the calendar object needs to be set separately by\nusing the setTimeZone method.", + "heading": "Description" + } + ], + "signature": "setTime(date: Date): void", + "source": "script-api", + "tags": [ + "settime", + "calendar.settime" + ], + "title": "Calendar.setTime" + }, + { + "description": "Sets the current time zone of this calendar.", + "id": "script-api:dw/util/Calendar#setTimeZone", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "timeZone", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.setTimeZone", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sets the current time zone of this calendar.\n\nWARNING: Keep in mind that the time stamp represented by the calendar is\nalways interpreted in the time zone GMT. Changing the time zone will not\nchange the calendar's time stamp.", + "heading": "Description" + } + ], + "signature": "setTimeZone(timeZone: string): void", + "source": "script-api", + "tags": [ + "settimezone", + "calendar.settimezone" + ], + "title": "Calendar.setTimeZone" + }, + { + "description": "Returns the current time stamp of this calendar. This method is also used to convert a Calendar into a Date.", + "id": "script-api:dw/util/Calendar#time", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.time", + "sections": [ + { + "body": "Returns the current time stamp of this calendar. This method\nis also used to convert a Calendar into a Date.\n\nWARNING: Keep in mind that the returned Date object's time is always\ninterpreted in the time zone GMT. This means time zone information\nset at the calendar object will not be honored and gets lost.", + "heading": "Description" + } + ], + "signature": "time: Date", + "source": "script-api", + "tags": [ + "time", + "calendar.time" + ], + "title": "Calendar.time" + }, + { + "description": "Returns the current time zone of this calendar.", + "id": "script-api:dw/util/Calendar#timeZone", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Calendar", + "qualifiedName": "dw.util.Calendar.timeZone", + "sections": [ + { + "body": "Returns the current time zone of this calendar.", + "heading": "Description" + } + ], + "signature": "timeZone: string", + "source": "script-api", + "tags": [ + "timezone", + "calendar.timezone" + ], + "title": "Calendar.timeZone" + }, + { + "description": "Represents a collection of objects.", + "id": "script-api:dw/util/Collection", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Collection", + "sections": [ + { + "body": "Represents a collection of objects.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "collection", + "dw.util.collection", + "dw/util" + ], + "title": "Collection" + }, + { + "description": "Adds the specified objects to the collection. The method can also be called with an ECMA array as argument.", + "id": "script-api:dw/util/Collection#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "values", + "optional": true, + "type": "T[]" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.add", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Adds the specified objects to the collection. The method can also\nbe called with an ECMA array as argument.\n\nIf called with a single ECMA array as argument the individual elements of\nthat array are added to the collection. If the array object itself should\nbe added use the method add1().", + "heading": "Description" + } + ], + "signature": "add(values?: T[]): boolean", + "source": "script-api", + "tags": [ + "add", + "collection.add" + ], + "title": "Collection.add" + }, + { + "description": "The method adds a single object to the collection.", + "id": "script-api:dw/util/Collection#add1", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "object", + "type": "T" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.add1", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "The method adds a single object to the collection.", + "heading": "Description" + } + ], + "signature": "add1(object: T): boolean", + "source": "script-api", + "tags": [ + "add1", + "collection.add1" + ], + "title": "Collection.add1" + }, + { + "description": "Adds the collection of objects to the collection.", + "id": "script-api:dw/util/Collection#addAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "objs", + "type": "Collection" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.addAll", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Adds the collection of objects to the collection.", + "heading": "Description" + } + ], + "signature": "addAll(objs: Collection): boolean", + "source": "script-api", + "tags": [ + "addall", + "collection.addall" + ], + "title": "Collection.addAll" + }, + { + "description": "Clears the collection.", + "id": "script-api:dw/util/Collection#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.clear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Clears the collection.", + "heading": "Description" + } + ], + "signature": "clear(): void", + "source": "script-api", + "tags": [ + "clear", + "collection.clear" + ], + "title": "Collection.clear" + }, + { + "description": "Returns true if the collection contains the specified object.", + "id": "script-api:dw/util/Collection#contains", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "obj", + "type": "T" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.contains", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the collection contains the specified object.", + "heading": "Description" + } + ], + "signature": "contains(obj: T): boolean", + "source": "script-api", + "tags": [ + "contains", + "collection.contains" + ], + "title": "Collection.contains" + }, + { + "description": "Returns true if the collection contains all of the objects in the specified collection.", + "id": "script-api:dw/util/Collection#containsAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "objs", + "type": "Collection" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.containsAll", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the collection contains all of the objects\nin the specified collection.", + "heading": "Description" + } + ], + "signature": "containsAll(objs: Collection): boolean", + "source": "script-api", + "tags": [ + "containsall", + "collection.containsall" + ], + "title": "Collection.containsAll" + }, + { + "description": "Returns true if the collection is empty.", + "id": "script-api:dw/util/Collection#empty", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.empty", + "sections": [ + { + "body": "Returns true if the collection is empty.", + "heading": "Description" + } + ], + "signature": "readonly empty: boolean", + "source": "script-api", + "tags": [ + "empty", + "collection.empty" + ], + "title": "Collection.empty" + }, + { + "description": "Returns the length of the collection. This is similar to to a ECMA array of 'products.length'.", + "id": "script-api:dw/util/Collection#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.getLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the length of the collection. This is similar to\nto a ECMA array of 'products.length'.", + "heading": "Description" + } + ], + "signature": "getLength(): number", + "source": "script-api", + "tags": [ + "getlength", + "collection.getlength" + ], + "title": "Collection.getLength" + }, + { + "description": "Returns true if the collection is empty.", + "id": "script-api:dw/util/Collection#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.isEmpty", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns true if the collection is empty.", + "heading": "Description" + } + ], + "signature": "isEmpty(): boolean", + "source": "script-api", + "tags": [ + "isempty", + "collection.isempty" + ], + "title": "Collection.isEmpty" + }, + { + "description": "Returns an iterator that can be used to access the members of the collection.", + "id": "script-api:dw/util/Collection#iterator", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.iterator", + "returns": { + "type": "utilIterator" + }, + "sections": [ + { + "body": "Returns an iterator that can be used to access\nthe members of the collection.", + "heading": "Description" + } + ], + "signature": "iterator(): utilIterator", + "source": "script-api", + "tags": [ + "iterator", + "collection.iterator" + ], + "title": "Collection.iterator" + }, + { + "description": "Returns the length of the collection. This is similar to to a ECMA array of 'products.length'.", + "id": "script-api:dw/util/Collection#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.length", + "sections": [ + { + "body": "Returns the length of the collection. This is similar to\nto a ECMA array of 'products.length'.", + "heading": "Description" + } + ], + "signature": "readonly length: number", + "source": "script-api", + "tags": [ + "length", + "collection.length" + ], + "title": "Collection.length" + }, + { + "description": "Removes the specified object from the collection.", + "id": "script-api:dw/util/Collection#remove", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "obj", + "type": "T" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.remove", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Removes the specified object from the collection.", + "heading": "Description" + } + ], + "signature": "remove(obj: T): boolean", + "source": "script-api", + "tags": [ + "remove", + "collection.remove" + ], + "title": "Collection.remove" + }, + { + "description": "Removes all of object in the specified object from the collection.", + "id": "script-api:dw/util/Collection#removeAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "objs", + "type": "Collection" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.removeAll", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Removes all of object in the specified object from the collection.", + "heading": "Description" + } + ], + "signature": "removeAll(objs: Collection): boolean", + "source": "script-api", + "tags": [ + "removeall", + "collection.removeall" + ], + "title": "Collection.removeAll" + }, + { + "description": "Removes all of object in the collection that are not in the specified collection.", + "id": "script-api:dw/util/Collection#retainAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "objs", + "type": "Collection" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.retainAll", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Removes all of object in the collection that are not in the\nspecified collection.", + "heading": "Description" + } + ], + "signature": "retainAll(objs: Collection): boolean", + "source": "script-api", + "tags": [ + "retainall", + "collection.retainall" + ], + "title": "Collection.retainAll" + }, + { + "description": "Returns the size of the collection.", + "id": "script-api:dw/util/Collection#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.size", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the collection.", + "heading": "Description" + } + ], + "signature": "size(): number", + "source": "script-api", + "tags": [ + "size", + "collection.size" + ], + "title": "Collection.size" + }, + { + "description": "Returns all elements of this collection in a newly created array. The returned array is independent of this collection and can be modified without changing the collection. The elements in the array are in the same order as they are returned when iterating over this collection.", + "id": "script-api:dw/util/Collection#toArray", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.toArray", + "returns": { + "type": "T[]" + }, + "sections": [ + { + "body": "Returns all elements of this collection in a newly created array. The returned array is independent of this collection and\ncan be modified without changing the collection. The elements in the array are in the same order as they are returned when\niterating over this collection.", + "heading": "Description" + } + ], + "signature": "toArray(): T[]", + "source": "script-api", + "tags": [ + "toarray", + "collection.toarray" + ], + "title": "Collection.toArray" + }, + { + "description": "Returns a subset of the elements of this collection in a newly created array. The returned array is independent of this collection and can be modified without changing the collection. The elements in the array are in the same order as they are returned when iterating over this collection.", + "id": "script-api:dw/util/Collection#toArray", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "start", + "type": "number" + }, + { + "name": "size", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Collection", + "qualifiedName": "dw.util.Collection.toArray", + "returns": { + "type": "T[]" + }, + "sections": [ + { + "body": "Returns a subset of the elements of this collection in a newly created array. The returned array is independent of this collection and\ncan be modified without changing the collection. The elements in the array are in the same order as they are returned when\niterating over this collection.", + "heading": "Description" + } + ], + "signature": "toArray(start: number, size: number): T[]", + "source": "script-api", + "tags": [ + "toarray", + "collection.toarray" + ], + "title": "Collection.toArray" + }, + { + "description": "Represents a currency supported by the system.", + "id": "script-api:dw/util/Currency", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Currency", + "sections": [ + { + "body": "Represents a currency supported by the system.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "currency", + "dw.util.currency", + "dw/util" + ], + "title": "Currency" + }, + { + "description": "Gets the ISO 4217 mnemonic currency code of this currency.", + "id": "script-api:dw/util/Currency#currencyCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.currencyCode", + "sections": [ + { + "body": "Gets the ISO 4217 mnemonic currency code of this currency.", + "heading": "Description" + } + ], + "signature": "readonly currencyCode: string", + "source": "script-api", + "tags": [ + "currencycode", + "currency.currencycode" + ], + "title": "Currency.currencyCode" + }, + { + "description": "Gets the default number of fraction digits used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it's 0.", + "id": "script-api:dw/util/Currency#defaultFractionDigits", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.defaultFractionDigits", + "sections": [ + { + "body": "Gets the default number of fraction digits used with this currency.\nFor example, the default number of fraction digits for the Euro is 2,\nwhile for the Japanese Yen it's 0.", + "heading": "Description" + } + ], + "signature": "readonly defaultFractionDigits: number", + "source": "script-api", + "tags": [ + "defaultfractiondigits", + "currency.defaultfractiondigits" + ], + "title": "Currency.defaultFractionDigits" + }, + { + "description": "Returns a `Currency` instance for the given currency code, or `null` if there is no such currency.", + "id": "script-api:dw/util/Currency#getCurrency", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "currencyCode", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrency", + "returns": { + "type": "Currency | null" + }, + "sections": [ + { + "body": "Returns a `Currency` instance for the given currency code,\nor `null` if there is no such currency.", + "heading": "Description" + } + ], + "signature": "static getCurrency(currencyCode: string): Currency | null", + "source": "script-api", + "tags": [ + "getcurrency", + "currency.getcurrency" + ], + "title": "Currency.getCurrency" + }, + { + "description": "Returns a `Currency` instance for the given currency code, or `null` if there is no such currency.", + "id": "script-api:dw/util/Currency#getCurrency", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "currencyCode", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrency", + "returns": { + "type": "Currency | null" + }, + "sections": [ + { + "body": "Returns a `Currency` instance for the given currency code,\nor `null` if there is no such currency.", + "heading": "Description" + } + ], + "signature": "static getCurrency(currencyCode: string): Currency | null", + "source": "script-api", + "tags": [ + "getcurrency", + "currency.getcurrency" + ], + "title": "Currency.getCurrency" + }, + { + "description": "Gets the ISO 4217 mnemonic currency code of this currency.", + "id": "script-api:dw/util/Currency#getCurrencyCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getCurrencyCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the ISO 4217 mnemonic currency code of this currency.", + "heading": "Description" + } + ], + "signature": "getCurrencyCode(): string", + "source": "script-api", + "tags": [ + "getcurrencycode", + "currency.getcurrencycode" + ], + "title": "Currency.getCurrencyCode" + }, + { + "description": "Gets the default number of fraction digits used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it's 0.", + "id": "script-api:dw/util/Currency#getDefaultFractionDigits", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getDefaultFractionDigits", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Gets the default number of fraction digits used with this currency.\nFor example, the default number of fraction digits for the Euro is 2,\nwhile for the Japanese Yen it's 0.", + "heading": "Description" + } + ], + "signature": "getDefaultFractionDigits(): number", + "source": "script-api", + "tags": [ + "getdefaultfractiondigits", + "currency.getdefaultfractiondigits" + ], + "title": "Currency.getDefaultFractionDigits" + }, + { + "description": "Gets a long name for this currency. e.g. \"United States Dollar\". The returned name is the one stored in the system for this currency. Currently only English names are available, but in the future this method may return a locale-specific name.", + "id": "script-api:dw/util/Currency#getName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets a long name for this currency. e.g. \"United States Dollar\".\nThe returned name is the one stored in the system for this currency.\nCurrently only English names are available, but in the future\nthis method may return a locale-specific name.", + "heading": "Description" + } + ], + "signature": "getName(): string", + "source": "script-api", + "tags": [ + "getname", + "currency.getname" + ], + "title": "Currency.getName" + }, + { + "description": "Gets the symbol of this currency. e.g. \"$\" for the US Dollar.", + "id": "script-api:dw/util/Currency#getSymbol", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.getSymbol", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the symbol of this currency. e.g. \"$\" for the US Dollar.", + "heading": "Description" + } + ], + "signature": "getSymbol(): string", + "source": "script-api", + "tags": [ + "getsymbol", + "currency.getsymbol" + ], + "title": "Currency.getSymbol" + }, + { + "description": "Gets a long name for this currency. e.g. \"United States Dollar\". The returned name is the one stored in the system for this currency. Currently only English names are available, but in the future this method may return a locale-specific name.", + "id": "script-api:dw/util/Currency#name", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.name", + "sections": [ + { + "body": "Gets a long name for this currency. e.g. \"United States Dollar\".\nThe returned name is the one stored in the system for this currency.\nCurrently only English names are available, but in the future\nthis method may return a locale-specific name.", + "heading": "Description" + } + ], + "signature": "readonly name: string", + "source": "script-api", + "tags": [ + "name", + "currency.name" + ], + "title": "Currency.name" + }, + { + "description": "Gets the symbol of this currency. e.g. \"$\" for the US Dollar.", + "id": "script-api:dw/util/Currency#symbol", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.symbol", + "sections": [ + { + "body": "Gets the symbol of this currency. e.g. \"$\" for the US Dollar.", + "heading": "Description" + } + ], + "signature": "readonly symbol: string", + "source": "script-api", + "tags": [ + "symbol", + "currency.symbol" + ], + "title": "Currency.symbol" + }, + { + "description": "Returns the ISO 4217 mnemonic currency code of this currency.", + "id": "script-api:dw/util/Currency#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Currency", + "qualifiedName": "dw.util.Currency.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the ISO 4217 mnemonic currency code of this currency.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "currency.tostring" + ], + "title": "Currency.toString" + }, + { + "deprecated": { + "message": "See each method for additional information." + }, + "description": "A class with several utility methods for Date objects.", + "id": "script-api:dw/util/DateUtils", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.DateUtils", + "sections": [ + { + "body": "A class with several utility methods for Date objects.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "dateutils", + "dw.util.dateutils", + "dw/util" + ], + "title": "DateUtils" + }, + { + "deprecated": { + "message": "Use dw.system.System.getCalendar instead." + }, + "description": "Returns the current time stamp in the time zone of the instance.", + "id": "script-api:dw/util/DateUtils#nowForInstance", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForInstance", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current time stamp in the time zone of the\ninstance.", + "heading": "Description" + } + ], + "signature": "static nowForInstance(): Date", + "source": "script-api", + "tags": [ + "nowforinstance", + "dateutils.nowforinstance" + ], + "title": "DateUtils.nowForInstance" + }, + { + "deprecated": { + "message": "Use dw.system.System.getCalendar instead." + }, + "description": "Returns the current time stamp in the time zone of the instance.", + "id": "script-api:dw/util/DateUtils#nowForInstance", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForInstance", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current time stamp in the time zone of the\ninstance.", + "heading": "Description" + } + ], + "signature": "static nowForInstance(): Date", + "source": "script-api", + "tags": [ + "nowforinstance", + "dateutils.nowforinstance" + ], + "title": "DateUtils.nowForInstance" + }, + { + "deprecated": { + "message": "Use dw.system.Site.getCalendar instead." + }, + "description": "Returns the current timestamp in the time zone of the current site.", + "id": "script-api:dw/util/DateUtils#nowForSite", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForSite", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current timestamp in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static nowForSite(): Date", + "source": "script-api", + "tags": [ + "nowforsite", + "dateutils.nowforsite" + ], + "title": "DateUtils.nowForSite" + }, + { + "deprecated": { + "message": "Use dw.system.Site.getCalendar instead." + }, + "description": "Returns the current timestamp in the time zone of the current site.", + "id": "script-api:dw/util/DateUtils#nowForSite", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowForSite", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current timestamp in the time zone of the\ncurrent site.", + "heading": "Description" + } + ], + "signature": "static nowForSite(): Date", + "source": "script-api", + "tags": [ + "nowforsite", + "dateutils.nowforsite" + ], + "title": "DateUtils.nowForSite" + }, + { + "deprecated": { + "message": "Create a new dw.util.Calendar object and set\nthe time zone \"UTC\" instead." + }, + "description": "Returns the current time stamp in UTC.", + "id": "script-api:dw/util/DateUtils#nowInUTC", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowInUTC", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current time stamp in UTC.", + "heading": "Description" + } + ], + "signature": "static nowInUTC(): Date", + "source": "script-api", + "tags": [ + "nowinutc", + "dateutils.nowinutc" + ], + "title": "DateUtils.nowInUTC" + }, + { + "deprecated": { + "message": "Create a new dw.util.Calendar object and set\nthe time zone \"UTC\" instead." + }, + "description": "Returns the current time stamp in UTC.", + "id": "script-api:dw/util/DateUtils#nowInUTC", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/DateUtils", + "qualifiedName": "dw.util.DateUtils.nowInUTC", + "returns": { + "type": "Date" + }, + "sections": [ + { + "body": "Returns the current time stamp in UTC.", + "heading": "Description" + } + ], + "signature": "static nowInUTC(): Date", + "source": "script-api", + "tags": [ + "nowinutc", + "dateutils.nowinutc" + ], + "title": "DateUtils.nowInUTC" + }, + { + "description": "The Decimal class is a helper class to perform decimal arithmetic in scripts and to represent a decimal number with arbitrary length. The decimal class avoids arithmetic errors, which are typical for calculating with floating numbers, that are based on a binary mantissa.", + "examples": [ + "var d = new Decimal( 10.0 );\nvar result = d.add( 2.0 ).sub( 3.0 ).get();" + ], + "id": "script-api:dw/util/Decimal", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Decimal", + "sections": [ + { + "body": "The Decimal class is a helper class to perform decimal arithmetic in\nscripts and to represent a decimal number with arbitrary length. The decimal\nclass avoids arithmetic errors, which are typical for calculating with\nfloating numbers, that are based on a binary mantissa.\n\nThe class is designed in a way that it can be used very similar to a\ndesktop calculator.\n\n\nThe above code will return 9 as result.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "decimal", + "dw.util.decimal", + "dw/util" + ], + "title": "Decimal" + }, + { + "description": "Returns a new Decimal with the absolute value of this Decimal.", + "id": "script-api:dw/util/Decimal#abs", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.abs", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Returns a new Decimal with the absolute value of this Decimal.", + "heading": "Description" + } + ], + "signature": "abs(): Decimal", + "source": "script-api", + "tags": [ + "abs", + "decimal.abs" + ], + "title": "Decimal.abs" + }, + { + "description": "Adds a Number value to this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.add", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Adds a Number value to this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "add(value: number): Decimal", + "source": "script-api", + "tags": [ + "add", + "decimal.add" + ], + "title": "Decimal.add" + }, + { + "description": "Adds a Decimal value to this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#add", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.add", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Adds a Decimal value to this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "add(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "add", + "decimal.add" + ], + "title": "Decimal.add" + }, + { + "description": "Adds a percentage value to the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.", + "id": "script-api:dw/util/Decimal#addPercent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.addPercent", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Adds a percentage value to the current value of the\ndecimal. For example a value of 10 represent 10% or a value of\n85 represents 85%.", + "heading": "Description" + } + ], + "signature": "addPercent(value: number): Decimal", + "source": "script-api", + "tags": [ + "addpercent", + "decimal.addpercent" + ], + "title": "Decimal.addPercent" + }, + { + "description": "Adds a percentage value to the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.", + "id": "script-api:dw/util/Decimal#addPercent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.addPercent", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Adds a percentage value to the current value of the\ndecimal. For example a value of 10 represent 10% or a value of\n85 represents 85%.", + "heading": "Description" + } + ], + "signature": "addPercent(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "addpercent", + "decimal.addpercent" + ], + "title": "Decimal.addPercent" + }, + { + "description": "Divides the specified Number value with this decimal and returns the new decimal.", + "id": "script-api:dw/util/Decimal#divide", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.divide", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Divides the specified Number value with this decimal and returns the new\ndecimal.\n\nWhen performing the division, 34 digits precision and a rounding mode of\nHALF_EVEN is used to prevent quotients with nonterminating decimal\nexpansions.", + "heading": "Description" + } + ], + "signature": "divide(value: number): Decimal", + "source": "script-api", + "tags": [ + "divide", + "decimal.divide" + ], + "title": "Decimal.divide" + }, + { + "description": "Divides the specified Decimal value with this decimal and returns the new decimal.", + "id": "script-api:dw/util/Decimal#divide", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.divide", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Divides the specified Decimal value with this decimal and returns the new\ndecimal.\n\nWhen performing the division, 34 digits precision and a rounding mode of\nHALF_EVEN is used to prevent quotients with nonterminating decimal\nexpansions.", + "heading": "Description" + } + ], + "signature": "divide(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "divide", + "decimal.divide" + ], + "title": "Decimal.divide" + }, + { + "description": "Compares two decimal values whether they are equivalent.", + "id": "script-api:dw/util/Decimal#equals", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "any" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.equals", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Compares two decimal values whether they are equivalent.", + "heading": "Description" + } + ], + "signature": "equals(other: any): boolean", + "source": "script-api", + "tags": [ + "equals", + "decimal.equals" + ], + "title": "Decimal.equals" + }, + { + "description": "Returns the value of the Decimal as a Number.", + "id": "script-api:dw/util/Decimal#get", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.get", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the value of the Decimal as a Number.", + "heading": "Description" + } + ], + "signature": "get(): number", + "source": "script-api", + "tags": [ + "get", + "decimal.get" + ], + "title": "Decimal.get" + }, + { + "description": "Calculates the hash code for this decimal;", + "id": "script-api:dw/util/Decimal#hashCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.hashCode", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Calculates the hash code for this decimal;", + "heading": "Description" + } + ], + "signature": "hashCode(): number", + "source": "script-api", + "tags": [ + "hashcode", + "decimal.hashcode" + ], + "title": "Decimal.hashCode" + }, + { + "description": "Multiples the specified Number value with this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#multiply", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.multiply", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Multiples the specified Number value with this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "multiply(value: number): Decimal", + "source": "script-api", + "tags": [ + "multiply", + "decimal.multiply" + ], + "title": "Decimal.multiply" + }, + { + "description": "Multiples the specified Decimal value with this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#multiply", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.multiply", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Multiples the specified Decimal value with this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "multiply(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "multiply", + "decimal.multiply" + ], + "title": "Decimal.multiply" + }, + { + "description": "Returns a new Decimal with the negated value of this Decimal.", + "id": "script-api:dw/util/Decimal#negate", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.negate", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Returns a new Decimal with the negated value of this Decimal.", + "heading": "Description" + } + ], + "signature": "negate(): Decimal", + "source": "script-api", + "tags": [ + "negate", + "decimal.negate" + ], + "title": "Decimal.negate" + }, + { + "description": "Rounds the current value of the decimal using the specified number of decimals. The parameter specifies the number of digest after the decimal point.", + "id": "script-api:dw/util/Decimal#round", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "decimals", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.round", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Rounds the current value of the decimal using the specified\nnumber of decimals. The parameter\nspecifies the number of digest after the decimal point.", + "heading": "Description" + } + ], + "signature": "round(decimals: number): Decimal", + "source": "script-api", + "tags": [ + "round", + "decimal.round" + ], + "title": "Decimal.round" + }, + { + "description": "Subtracts the specified Number value from this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#subtract", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtract", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Subtracts the specified Number value from this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "subtract(value: number): Decimal", + "source": "script-api", + "tags": [ + "subtract", + "decimal.subtract" + ], + "title": "Decimal.subtract" + }, + { + "description": "Subtracts the specified Decimal value from this Decimal and returns the new Decimal.", + "id": "script-api:dw/util/Decimal#subtract", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtract", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Subtracts the specified Decimal value from this Decimal and returns the new Decimal.", + "heading": "Description" + } + ], + "signature": "subtract(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "subtract", + "decimal.subtract" + ], + "title": "Decimal.subtract" + }, + { + "description": "Subtracts a percentage value from the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.", + "id": "script-api:dw/util/Decimal#subtractPercent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtractPercent", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Subtracts a percentage value from the current value of the\ndecimal. For example a value of 10 represent 10% or a value of\n85 represents 85%.", + "heading": "Description" + } + ], + "signature": "subtractPercent(value: number): Decimal", + "source": "script-api", + "tags": [ + "subtractpercent", + "decimal.subtractpercent" + ], + "title": "Decimal.subtractPercent" + }, + { + "description": "Subtracts a percentage value from the current value of the decimal. For example a value of 10 represent 10% or a value of 85 represents 85%.", + "id": "script-api:dw/util/Decimal#subtractPercent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "Decimal" + } + ], + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.subtractPercent", + "returns": { + "type": "Decimal" + }, + "sections": [ + { + "body": "Subtracts a percentage value from the current value of the\ndecimal. For example a value of 10 represent 10% or a value of\n85 represents 85%.", + "heading": "Description" + } + ], + "signature": "subtractPercent(value: Decimal): Decimal", + "source": "script-api", + "tags": [ + "subtractpercent", + "decimal.subtractpercent" + ], + "title": "Decimal.subtractPercent" + }, + { + "description": "Returns a string representation of this object.", + "id": "script-api:dw/util/Decimal#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns a string representation of this object.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "decimal.tostring" + ], + "title": "Decimal.toString" + }, + { + "description": "The valueOf() method is called by the ECMAScript interpret to return the \"natural\" value of an object. The Decimal object returns its current value as number. With this behavior script snippets can be written like:", + "id": "script-api:dw/util/Decimal#valueOf", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Decimal", + "qualifiedName": "dw.util.Decimal.valueOf", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "The valueOf() method is called by the ECMAScript interpret to return\nthe \"natural\" value of an object. The Decimal object returns its\ncurrent value as number. With this behavior script snippets can\nbe written like:\n\n`\nvar d = new Decimal( 10.0 );\nvar x = 1.0 + d.add( 2.0 );\n`\n\nwhere x will be at the end 13.0.", + "heading": "Description" + } + ], + "signature": "valueOf(): any", + "source": "script-api", + "tags": [ + "valueof", + "decimal.valueof" + ], + "title": "Decimal.valueOf" + }, + { + "description": "dw.util.FilteringCollection is an extension of dw.util.Collection which provides possibilities to", + "id": "script-api:dw/util/FilteringCollection", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.FilteringCollection", + "sections": [ + { + "body": "dw.util.FilteringCollection is an extension of\ndw.util.Collection which provides possibilities to\n\n- filter the elements to return a new\ndw.util.FilteringCollection with a filtered set of elements\n- sort the elements to return a new\ndw.util.FilteringCollection with a defined sort order\n- transform the elements to return a new\ndw.util.FilteringCollection containing related elements\n- provide a map of the elements against a predefined key\n\nUsage - In the current version each\ndw.util.FilteringCollection provides a set of predefined\nqualifier constants which can be passed into the\nselect method used to filter the elements. Generally\nqualifiers have the prefix QUALIFIER_. A second method\nsort is used to create a new instance with a different\nelement ordering, which takes an orderB< constant. Generally\norderBys have the prefix ORDERBY_: examples are\ndw.order.ShippingOrder.ORDERBY_ITEMID,\ndw.order.ShippingOrder.ORDERBY_ITEMPOSITION, and ORDERBY_REVERSE can\nbe used to provide a dw.util.FilteringCollection with the reverse\nordering. An example with method dw.order.ShippingOrder.getItems:\n\n`\n\nvar allItems : FilteringCollection = shippingOrder.items;\n\nvar productItems : FilteringCollection = allItems.select(ShippingOrder.QUALIFIER_PRODUCTITEMS);\n\nvar serviceItems : FilteringCollection = allItems.select(ShippingOrder.QUALIFIER_SERVICEITEMS);\n\nvar byPosition : FilteringCollection = productItems.sort(ShippingOrder.ORDERBY_ITEMPOSITION);\n\nvar revByPosition: FilteringCollection = byPosition.sort(FilteringCollection.ORDERBY_REVERSE);\n\nvar mapByItemID : Map = allItems.asMap();\n`", + "heading": "Description" + }, + { + "body": "Extends `Collection`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "filteringcollection", + "dw.util.filteringcollection", + "dw/util" + ], + "title": "FilteringCollection" + }, + { + "description": "Pass this orderBy with the sort method to obtain a new dw.util.FilteringCollection with the reversed sort order. Only use on a dw.util.FilteringCollection which has been previously sorted.", + "id": "script-api:dw/util/FilteringCollection#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.ORDERBY_REVERSE", + "sections": [ + { + "body": "Pass this orderBy with the sort method to\nobtain a new dw.util.FilteringCollection with the reversed sort\norder. Only use on a dw.util.FilteringCollection which has been\npreviously sorted.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_REVERSE: any", + "source": "script-api", + "tags": [ + "orderby_reverse", + "filteringcollection.orderby_reverse" + ], + "title": "FilteringCollection.ORDERBY_REVERSE" + }, + { + "description": "Pass this orderBy with the sort method to obtain a new dw.util.FilteringCollection with the reversed sort order. Only use on a dw.util.FilteringCollection which has been previously sorted.", + "id": "script-api:dw/util/FilteringCollection#ORDERBY_REVERSE", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.ORDERBY_REVERSE", + "sections": [ + { + "body": "Pass this orderBy with the sort method to\nobtain a new dw.util.FilteringCollection with the reversed sort\norder. Only use on a dw.util.FilteringCollection which has been\npreviously sorted.", + "heading": "Description" + } + ], + "signature": "static readonly ORDERBY_REVERSE: any", + "source": "script-api", + "tags": [ + "orderby_reverse", + "filteringcollection.orderby_reverse" + ], + "title": "FilteringCollection.ORDERBY_REVERSE" + }, + { + "description": "Returns a dw.util.Map containing the elements of this dw.util.FilteringCollection against a predefined key. The key used is documented in the method returning the dw.util.FilteringCollection and is typically the ItemID assigned to an element in the collection.", + "id": "script-api:dw/util/FilteringCollection#asMap", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.asMap", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a dw.util.Map containing the elements of this\ndw.util.FilteringCollection against a predefined key. The key\nused is documented in the method returning the\ndw.util.FilteringCollection and is typically the ItemID assigned\nto an element in the collection.", + "heading": "Description" + } + ], + "signature": "asMap(): utilMap", + "source": "script-api", + "tags": [ + "asmap", + "filteringcollection.asmap" + ], + "title": "FilteringCollection.asMap" + }, + { + "description": "Select a new dw.util.FilteringCollection instance by passing a predefined qualifier as an argument to this method. See dw.util.FilteringCollection.", + "id": "script-api:dw/util/FilteringCollection#select", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "qualifier", + "type": "any" + } + ], + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.select", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Select a new dw.util.FilteringCollection instance by passing a\npredefined qualifier as an argument to this method. See\ndw.util.FilteringCollection.", + "heading": "Description" + } + ], + "signature": "select(qualifier: any): FilteringCollection", + "source": "script-api", + "tags": [ + "select", + "filteringcollection.select" + ], + "title": "FilteringCollection.select" + }, + { + "description": "Select a new dw.util.FilteringCollection instance by passing a predefined orderBy as an argument to this method. See dw.util.FilteringCollection.", + "id": "script-api:dw/util/FilteringCollection#sort", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "qualifier", + "type": "any" + } + ], + "parentId": "script-api:dw/util/FilteringCollection", + "qualifiedName": "dw.util.FilteringCollection.sort", + "returns": { + "type": "FilteringCollection" + }, + "sections": [ + { + "body": "Select a new dw.util.FilteringCollection instance by passing a\npredefined orderBy as an argument to this method. See\ndw.util.FilteringCollection.", + "heading": "Description" + } + ], + "signature": "sort(qualifier: any): FilteringCollection", + "source": "script-api", + "tags": [ + "sort", + "filteringcollection.sort" + ], + "title": "FilteringCollection.sort" + }, + { + "description": "Read-only class representing a position on the earth (latitude and longitude) and information associated with that location (e.g. country, city, etc). The Commerce Cloud Digital system can provide geolocation information for a Request and this information can be used in customer group segmentation rules.", + "id": "script-api:dw/util/Geolocation", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Geolocation", + "sections": [ + { + "body": "Read-only class representing a position on the earth (latitude and longitude)\nand information associated with that location (e.g. country, city, etc). The\nCommerce Cloud Digital system can provide geolocation information for a Request\nand this information can be used in customer group segmentation rules.\n\nNote: This class is not related to the store locator API (i.e. the\nGetNearestStores pipelet) which uses a static set of store locations loaded\ninto the system by the merchant.\n\nThis product includes GeoLite2 data created by MaxMind, available from\nhttp://www.maxmind.com.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "geolocation", + "dw.util.geolocation", + "dw/util" + ], + "title": "Geolocation" + }, + { + "description": "Returns 'true' if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise.", + "id": "script-api:dw/util/Geolocation#available", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.available", + "sections": [ + { + "body": "Returns 'true' if a valid GeoLocation was found for the IP address\n(meaning at least Latitude and Longitude were found), false otherwise.", + "heading": "Description" + } + ], + "signature": "readonly available: boolean", + "source": "script-api", + "tags": [ + "available", + "geolocation.available" + ], + "title": "Geolocation.available" + }, + { + "description": "Get the city name in English associated with this location.", + "id": "script-api:dw/util/Geolocation#city", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.city", + "sections": [ + { + "body": "Get the city name in English associated with this location.", + "heading": "Description" + } + ], + "signature": "readonly city: string", + "source": "script-api", + "tags": [ + "city", + "geolocation.city" + ], + "title": "Geolocation.city" + }, + { + "description": "Get the ISO country code associated with this location.", + "id": "script-api:dw/util/Geolocation#countryCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.countryCode", + "sections": [ + { + "body": "Get the ISO country code associated with this location.", + "heading": "Description" + } + ], + "signature": "readonly countryCode: string", + "source": "script-api", + "tags": [ + "countrycode", + "geolocation.countrycode" + ], + "title": "Geolocation.countryCode" + }, + { + "description": "Get the country name in English that the system associates with this location on the earth.", + "id": "script-api:dw/util/Geolocation#countryName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.countryName", + "sections": [ + { + "body": "Get the country name in English that the system associates with this location on the\nearth.", + "heading": "Description" + } + ], + "signature": "readonly countryName: string", + "source": "script-api", + "tags": [ + "countryname", + "geolocation.countryname" + ], + "title": "Geolocation.countryName" + }, + { + "description": "Get the city name in English associated with this location.", + "id": "script-api:dw/util/Geolocation#getCity", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCity", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the city name in English associated with this location.", + "heading": "Description" + } + ], + "signature": "getCity(): string", + "source": "script-api", + "tags": [ + "getcity", + "geolocation.getcity" + ], + "title": "Geolocation.getCity" + }, + { + "description": "Get the ISO country code associated with this location.", + "id": "script-api:dw/util/Geolocation#getCountryCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCountryCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the ISO country code associated with this location.", + "heading": "Description" + } + ], + "signature": "getCountryCode(): string", + "source": "script-api", + "tags": [ + "getcountrycode", + "geolocation.getcountrycode" + ], + "title": "Geolocation.getCountryCode" + }, + { + "description": "Get the country name in English that the system associates with this location on the earth.", + "id": "script-api:dw/util/Geolocation#getCountryName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getCountryName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the country name in English that the system associates with this location on the\nearth.", + "heading": "Description" + } + ], + "signature": "getCountryName(): string", + "source": "script-api", + "tags": [ + "getcountryname", + "geolocation.getcountryname" + ], + "title": "Geolocation.getCountryName" + }, + { + "description": "Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0.", + "id": "script-api:dw/util/Geolocation#getLatitude", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getLatitude", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Get the latitude coordinate associated with this location which is a\nnumber between -90.0 and +90.0.", + "heading": "Description" + } + ], + "signature": "getLatitude(): number", + "source": "script-api", + "tags": [ + "getlatitude", + "geolocation.getlatitude" + ], + "title": "Geolocation.getLatitude" + }, + { + "description": "Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0.", + "id": "script-api:dw/util/Geolocation#getLongitude", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getLongitude", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Get the longitude coordinate associated with this location which is a\nnumber between -180.0 and +180.0.", + "heading": "Description" + } + ], + "signature": "getLongitude(): number", + "source": "script-api", + "tags": [ + "getlongitude", + "geolocation.getlongitude" + ], + "title": "Geolocation.getLongitude" + }, + { + "description": "Get the metro code associated with this location.", + "id": "script-api:dw/util/Geolocation#getMetroCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getMetroCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the metro code associated with this location.", + "heading": "Description" + } + ], + "signature": "getMetroCode(): string", + "source": "script-api", + "tags": [ + "getmetrocode", + "geolocation.getmetrocode" + ], + "title": "Geolocation.getMetroCode" + }, + { + "description": "Get the postal code associated with this location.", + "id": "script-api:dw/util/Geolocation#getPostalCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getPostalCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the postal code associated with this location.", + "heading": "Description" + } + ], + "signature": "getPostalCode(): string", + "source": "script-api", + "tags": [ + "getpostalcode", + "geolocation.getpostalcode" + ], + "title": "Geolocation.getPostalCode" + }, + { + "description": "Get the region (e.g. province or state) code for this location.", + "id": "script-api:dw/util/Geolocation#getRegionCode", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getRegionCode", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the region (e.g. province or state) code for this location.", + "heading": "Description" + } + ], + "signature": "getRegionCode(): string", + "source": "script-api", + "tags": [ + "getregioncode", + "geolocation.getregioncode" + ], + "title": "Geolocation.getRegionCode" + }, + { + "description": "Get the region (e.g. province in state) name in English that the system associates with this location.", + "id": "script-api:dw/util/Geolocation#getRegionName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.getRegionName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Get the region (e.g. province in state) name in English that the system\nassociates with this location.", + "heading": "Description" + } + ], + "signature": "getRegionName(): string", + "source": "script-api", + "tags": [ + "getregionname", + "geolocation.getregionname" + ], + "title": "Geolocation.getRegionName" + }, + { + "description": "Returns 'true' if a valid GeoLocation was found for the IP address (meaning at least Latitude and Longitude were found), false otherwise.", + "id": "script-api:dw/util/Geolocation#isAvailable", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.isAvailable", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Returns 'true' if a valid GeoLocation was found for the IP address\n(meaning at least Latitude and Longitude were found), false otherwise.", + "heading": "Description" + } + ], + "signature": "isAvailable(): boolean", + "source": "script-api", + "tags": [ + "isavailable", + "geolocation.isavailable" + ], + "title": "Geolocation.isAvailable" + }, + { + "description": "Get the latitude coordinate associated with this location which is a number between -90.0 and +90.0.", + "id": "script-api:dw/util/Geolocation#latitude", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.latitude", + "sections": [ + { + "body": "Get the latitude coordinate associated with this location which is a\nnumber between -90.0 and +90.0.", + "heading": "Description" + } + ], + "signature": "readonly latitude: number", + "source": "script-api", + "tags": [ + "latitude", + "geolocation.latitude" + ], + "title": "Geolocation.latitude" + }, + { + "description": "Get the longitude coordinate associated with this location which is a number between -180.0 and +180.0.", + "id": "script-api:dw/util/Geolocation#longitude", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.longitude", + "sections": [ + { + "body": "Get the longitude coordinate associated with this location which is a\nnumber between -180.0 and +180.0.", + "heading": "Description" + } + ], + "signature": "readonly longitude: number", + "source": "script-api", + "tags": [ + "longitude", + "geolocation.longitude" + ], + "title": "Geolocation.longitude" + }, + { + "description": "Get the metro code associated with this location.", + "id": "script-api:dw/util/Geolocation#metroCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.metroCode", + "sections": [ + { + "body": "Get the metro code associated with this location.", + "heading": "Description" + } + ], + "signature": "readonly metroCode: string", + "source": "script-api", + "tags": [ + "metrocode", + "geolocation.metrocode" + ], + "title": "Geolocation.metroCode" + }, + { + "description": "Get the postal code associated with this location.", + "id": "script-api:dw/util/Geolocation#postalCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.postalCode", + "sections": [ + { + "body": "Get the postal code associated with this location.", + "heading": "Description" + } + ], + "signature": "readonly postalCode: string", + "source": "script-api", + "tags": [ + "postalcode", + "geolocation.postalcode" + ], + "title": "Geolocation.postalCode" + }, + { + "description": "Get the region (e.g. province or state) code for this location.", + "id": "script-api:dw/util/Geolocation#regionCode", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.regionCode", + "sections": [ + { + "body": "Get the region (e.g. province or state) code for this location.", + "heading": "Description" + } + ], + "signature": "readonly regionCode: string", + "source": "script-api", + "tags": [ + "regioncode", + "geolocation.regioncode" + ], + "title": "Geolocation.regionCode" + }, + { + "description": "Get the region (e.g. province in state) name in English that the system associates with this location.", + "id": "script-api:dw/util/Geolocation#regionName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Geolocation", + "qualifiedName": "dw.util.Geolocation.regionName", + "sections": [ + { + "body": "Get the region (e.g. province in state) name in English that the system\nassociates with this location.", + "heading": "Description" + } + ], + "signature": "readonly regionName: string", + "source": "script-api", + "tags": [ + "regionname", + "geolocation.regionname" + ], + "title": "Geolocation.regionName" + }, + { + "description": "Represents a hash map of objects.", + "id": "script-api:dw/util/HashMap", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.HashMap", + "sections": [ + { + "body": "Represents a hash map of objects.", + "heading": "Description" + }, + { + "body": "Extends `utilMap`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "hashmap", + "dw.util.hashmap", + "dw/util" + ], + "title": "HashMap" + }, + { + "description": "Returns a shallow copy of this map.", + "id": "script-api:dw/util/HashMap#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/HashMap", + "qualifiedName": "dw.util.HashMap.clone", + "returns": { + "type": "HashMap" + }, + "sections": [ + { + "body": "Returns a shallow copy of this map.", + "heading": "Description" + } + ], + "signature": "clone(): HashMap", + "source": "script-api", + "tags": [ + "clone", + "hashmap.clone" + ], + "title": "HashMap.clone" + }, + { + "description": "Represents a HashSet", + "id": "script-api:dw/util/HashSet", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.HashSet", + "sections": [ + { + "body": "Represents a HashSet", + "heading": "Description" + }, + { + "body": "Extends `utilSet`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "hashset", + "dw.util.hashset", + "dw/util" + ], + "title": "HashSet" + }, + { + "description": "Returns a shallow copy of this set.", + "id": "script-api:dw/util/HashSet#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/HashSet", + "qualifiedName": "dw.util.HashSet.clone", + "returns": { + "type": "HashSet" + }, + "sections": [ + { + "body": "Returns a shallow copy of this set.", + "heading": "Description" + } + ], + "signature": "clone(): HashSet", + "source": "script-api", + "tags": [ + "clone", + "hashset.clone" + ], + "title": "HashSet.clone" + }, + { + "description": "The Iterator class allows you to access items in a collection.", + "id": "script-api:dw/util/Iterator", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Iterator", + "sections": [ + { + "body": "The Iterator class allows you to access items in a collection.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "iterator", + "dw.util.iterator", + "dw/util" + ], + "title": "Iterator" + }, + { + "description": "Convert the iterator into a list. After this conversion the iterator is empty and hasNext() will always return false.", + "id": "script-api:dw/util/Iterator#asList", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.asList", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Convert the iterator into a list. After this conversion the\niterator is empty and hasNext() will always return false.\n\nNote: This method should be used with care. For example a large database\nresult is pulled into memory completely with this method and can cause\nan OutOfMemory situation.", + "heading": "Description" + } + ], + "signature": "asList(): List", + "source": "script-api", + "tags": [ + "aslist", + "iterator.aslist" + ], + "title": "Iterator.asList" + }, + { + "description": "Converts a sub-sequence within the iterator into a list.", + "id": "script-api:dw/util/Iterator#asList", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "start", + "type": "number" + }, + { + "name": "size", + "type": "number" + } + ], + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.asList", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Converts a sub-sequence within the iterator into a list.\n\nNote: This method should be used with care. For example a large database\nresult is pulled into memory completely with this method and can cause\nan OutOfMemory situation.", + "heading": "Description" + } + ], + "signature": "asList(start: number, size: number): List", + "source": "script-api", + "tags": [ + "aslist", + "iterator.aslist" + ], + "title": "Iterator.asList" + }, + { + "description": "Indicates if there are more elements.", + "id": "script-api:dw/util/Iterator#hasNext", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.hasNext", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Indicates if there are more elements.", + "heading": "Description" + } + ], + "signature": "hasNext(): boolean", + "source": "script-api", + "tags": [ + "hasnext", + "iterator.hasnext" + ], + "title": "Iterator.hasNext" + }, + { + "description": "Returns the next element from the Iterator.", + "id": "script-api:dw/util/Iterator#next", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Iterator", + "qualifiedName": "dw.util.Iterator.next", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Returns the next element from the Iterator.", + "heading": "Description" + } + ], + "signature": "next(): T", + "source": "script-api", + "tags": [ + "next", + "iterator.next" + ], + "title": "Iterator.next" + }, + { + "description": "This class implements a HashMap, which guarantees a iteration order according the put-order of the elements in the map.", + "id": "script-api:dw/util/LinkedHashMap", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.LinkedHashMap", + "sections": [ + { + "body": "This class implements a HashMap, which guarantees a iteration order\naccording the put-order of the elements in the map.", + "heading": "Description" + }, + { + "body": "Extends `utilMap`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "linkedhashmap", + "dw.util.linkedhashmap", + "dw/util" + ], + "title": "LinkedHashMap" + }, + { + "description": "Returns a shallow copy of this map.", + "id": "script-api:dw/util/LinkedHashMap#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/LinkedHashMap", + "qualifiedName": "dw.util.LinkedHashMap.clone", + "returns": { + "type": "LinkedHashMap" + }, + "sections": [ + { + "body": "Returns a shallow copy of this map.", + "heading": "Description" + } + ], + "signature": "clone(): LinkedHashMap", + "source": "script-api", + "tags": [ + "clone", + "linkedhashmap.clone" + ], + "title": "LinkedHashMap.clone" + }, + { + "description": "The class LinkedHashSet implements a hash set with a guaranteed iteration order. The elements are iterated in the order they have been added to the HashSet.", + "id": "script-api:dw/util/LinkedHashSet", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.LinkedHashSet", + "sections": [ + { + "body": "The class LinkedHashSet implements a hash set with a guaranteed iteration\norder. The elements are iterated in the order they have been added to the\nHashSet.", + "heading": "Description" + }, + { + "body": "Extends `utilSet`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "linkedhashset", + "dw.util.linkedhashset", + "dw/util" + ], + "title": "LinkedHashSet" + }, + { + "description": "Returns a shallow copy of this set.", + "id": "script-api:dw/util/LinkedHashSet#clone", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/LinkedHashSet", + "qualifiedName": "dw.util.LinkedHashSet.clone", + "returns": { + "type": "LinkedHashSet" + }, + "sections": [ + { + "body": "Returns a shallow copy of this set.", + "heading": "Description" + } + ], + "signature": "clone(): LinkedHashSet", + "source": "script-api", + "tags": [ + "clone", + "linkedhashset.clone" + ], + "title": "LinkedHashSet.clone" + }, + { + "description": "An ordered collection of objects. The user of a List has precise control over where in the list each element is inserted. The user can access elements by their integer index (position in the list), and search for elements in the list. Lists are zero based similar to arrays. Unlike sets, lists allow duplicate elements.", + "id": "script-api:dw/util/List", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.List", + "sections": [ + { + "body": "An ordered collection of objects. The user of a List has precise control over\nwhere in the list each element is inserted. The user can access elements by\ntheir integer index (position in the list), and search for elements in the\nlist. Lists are zero based similar to arrays. Unlike sets, lists allow\nduplicate elements.", + "heading": "Description" + }, + { + "body": "Extends `Collection`", + "heading": "Inheritance" + } + ], + "source": "script-api", + "tags": [ + "list", + "dw.util.list", + "dw/util" + ], + "title": "List" + }, + { + "description": "Convenience variable, for an empty and immutable list.", + "id": "script-api:dw/util/List#EMPTY_LIST", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.EMPTY_LIST", + "sections": [ + { + "body": "Convenience variable, for an empty and immutable list.", + "heading": "Description" + } + ], + "signature": "static EMPTY_LIST: List", + "source": "script-api", + "tags": [ + "empty_list", + "list.empty_list" + ], + "title": "List.EMPTY_LIST" + }, + { + "description": "Convenience variable, for an empty and immutable list.", + "id": "script-api:dw/util/List#EMPTY_LIST", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.EMPTY_LIST", + "sections": [ + { + "body": "Convenience variable, for an empty and immutable list.", + "heading": "Description" + } + ], + "signature": "static EMPTY_LIST: List", + "source": "script-api", + "tags": [ + "empty_list", + "list.empty_list" + ], + "title": "List.EMPTY_LIST" + }, + { + "description": "Adds the specified object into the list at the specified index.", + "id": "script-api:dw/util/List#addAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + }, + { + "name": "value", + "type": "T" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.addAt", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Adds the specified object into the list at the specified index.", + "heading": "Description" + } + ], + "signature": "addAt(index: number, value: T): void", + "source": "script-api", + "tags": [ + "addat", + "list.addat" + ], + "title": "List.addAt" + }, + { + "description": "Creates and returns a new List that is the result of concatenating this list with each of the specified values. This list itself is unmodified. If any of the specified values is itself an array or a Collection, then the elements of that Collection or array are appended to the new list rather than the object itself.", + "id": "script-api:dw/util/List#concat", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "values", + "optional": true, + "type": "T[]" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.concat", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Creates and returns a new List that is the result of concatenating this\nlist with each of the specified values. This list itself is unmodified.\nIf any of the specified values is itself an array or a Collection, then\nthe elements of that Collection or array are appended to the new list\nrather than the object itself.", + "heading": "Description" + } + ], + "signature": "concat(values?: T[]): List", + "source": "script-api", + "tags": [ + "concat", + "list.concat" + ], + "title": "List.concat" + }, + { + "description": "Replaces all of the elements in the list with the given object.", + "id": "script-api:dw/util/List#fill", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "obj", + "type": "T" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.fill", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Replaces all of the elements in the list with the given object.", + "heading": "Description" + } + ], + "signature": "fill(obj: T): void", + "source": "script-api", + "tags": [ + "fill", + "list.fill" + ], + "title": "List.fill" + }, + { + "description": "Returns the object at the specified index.", + "id": "script-api:dw/util/List#get", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.get", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Returns the object at the specified index.", + "heading": "Description" + } + ], + "signature": "get(index: number): T", + "source": "script-api", + "tags": [ + "get", + "list.get" + ], + "title": "List.get" + }, + { + "description": "Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.", + "id": "script-api:dw/util/List#indexOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "T" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.indexOf", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the index of the first occurrence of the specified element in\nthis list, or -1 if this list does not contain the element.", + "heading": "Description" + } + ], + "signature": "indexOf(value: T): number", + "source": "script-api", + "tags": [ + "indexof", + "list.indexof" + ], + "title": "List.indexOf" + }, + { + "description": "Converts all elements of the list to a string by calling the toString() method and then concatenates them together, with a comma between elements.", + "id": "script-api:dw/util/List#join", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.join", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Converts all elements of the list to a string by calling the toString()\nmethod and then concatenates them together, with a comma between\nelements.", + "heading": "Description" + } + ], + "signature": "join(): string", + "source": "script-api", + "tags": [ + "join", + "list.join" + ], + "title": "List.join" + }, + { + "description": "Converts all elements of the list to a string by calling the toString() method and then concatenates them together, with the separator string between elements. If null is passed, then the comma character is used as a separator.", + "id": "script-api:dw/util/List#join", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "separator", + "type": "string | null" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.join", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Converts all elements of the list to a string by calling the toString()\nmethod and then concatenates them together, with the separator string\nbetween elements. If null is passed, then the comma character is used as\na separator.", + "heading": "Description" + } + ], + "signature": "join(separator: string | null): string", + "source": "script-api", + "tags": [ + "join", + "list.join" + ], + "title": "List.join" + }, + { + "description": "Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.", + "id": "script-api:dw/util/List#lastIndexOf", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "T" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.lastIndexOf", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the index of the last occurrence of the specified element in this\nlist, or -1 if this list does not contain the element.", + "heading": "Description" + } + ], + "signature": "lastIndexOf(value: T): number", + "source": "script-api", + "tags": [ + "lastindexof", + "list.lastindexof" + ], + "title": "List.lastIndexOf" + }, + { + "description": "Removes and returns the last element from the list.", + "id": "script-api:dw/util/List#pop", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.pop", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Removes and returns the last element from the list.", + "heading": "Description" + } + ], + "signature": "pop(): T", + "source": "script-api", + "tags": [ + "pop", + "list.pop" + ], + "title": "List.pop" + }, + { + "description": "Appends the specified values to the end of the list in order.", + "id": "script-api:dw/util/List#push", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "values", + "optional": true, + "type": "T[]" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.push", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Appends the specified values to the end of the list in order.", + "heading": "Description" + } + ], + "signature": "push(values?: T[]): number", + "source": "script-api", + "tags": [ + "push", + "list.push" + ], + "title": "List.push" + }, + { + "description": "Removes the object at the specified index.", + "id": "script-api:dw/util/List#removeAt", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.removeAt", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Removes the object at the specified index.", + "heading": "Description" + } + ], + "signature": "removeAt(index: number): T", + "source": "script-api", + "tags": [ + "removeat", + "list.removeat" + ], + "title": "List.removeAt" + }, + { + "description": "Replaces all occurrences of oldValue with newValue.", + "id": "script-api:dw/util/List#replaceAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "oldValue", + "type": "any" + }, + { + "name": "newValue", + "type": "any" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.replaceAll", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Replaces all occurrences of oldValue with newValue.", + "heading": "Description" + } + ], + "signature": "replaceAll(oldValue: any, newValue: any): boolean", + "source": "script-api", + "tags": [ + "replaceall", + "list.replaceall" + ], + "title": "List.replaceAll" + }, + { + "description": "Reverses the order of the elements in the list.", + "id": "script-api:dw/util/List#reverse", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.reverse", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Reverses the order of the elements in the list.", + "heading": "Description" + } + ], + "signature": "reverse(): void", + "source": "script-api", + "tags": [ + "reverse", + "list.reverse" + ], + "title": "List.reverse" + }, + { + "description": "Rotates the elements in the list by the specified distance.", + "id": "script-api:dw/util/List#rotate", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "distance", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.rotate", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Rotates the elements in the list by the specified distance.", + "heading": "Description" + } + ], + "signature": "rotate(distance: number): void", + "source": "script-api", + "tags": [ + "rotate", + "list.rotate" + ], + "title": "List.rotate" + }, + { + "description": "Replaces the object at the specified index in this list with the specified object.", + "id": "script-api:dw/util/List#set", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "index", + "type": "number" + }, + { + "name": "value", + "type": "T" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.set", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Replaces the object at the specified index in this list with the specified object.", + "heading": "Description" + } + ], + "signature": "set(index: number, value: T): T", + "source": "script-api", + "tags": [ + "set", + "list.set" + ], + "title": "List.set" + }, + { + "description": "Removes and returns the first element of the list. If the list is already empty, this method simply returns null.", + "id": "script-api:dw/util/List#shift", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.shift", + "returns": { + "type": "T" + }, + "sections": [ + { + "body": "Removes and returns the first element of the list. If the list is already\nempty, this method simply returns null.", + "heading": "Description" + } + ], + "signature": "shift(): T", + "source": "script-api", + "tags": [ + "shift", + "list.shift" + ], + "title": "List.shift" + }, + { + "description": "Randomly permutes the elements in the list.", + "id": "script-api:dw/util/List#shuffle", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.shuffle", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Randomly permutes the elements in the list.", + "heading": "Description" + } + ], + "signature": "shuffle(): void", + "source": "script-api", + "tags": [ + "shuffle", + "list.shuffle" + ], + "title": "List.shuffle" + }, + { + "description": "Returns the size of this list.", + "id": "script-api:dw/util/List#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.size", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of this list.", + "heading": "Description" + } + ], + "signature": "size(): number", + "source": "script-api", + "tags": [ + "size", + "list.size" + ], + "title": "List.size" + }, + { + "description": "Returns a slice, or sublist, of this list. The returned list contains the element specified by `from` and all subsequent elements up to the end of this list.", + "id": "script-api:dw/util/List#slice", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "from", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.slice", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a slice, or sublist, of this list. The returned list contains the\nelement specified by `from` and all subsequent elements up to\nthe end of this list.", + "heading": "Description" + } + ], + "signature": "slice(from: number): List", + "source": "script-api", + "tags": [ + "slice", + "list.slice" + ], + "title": "List.slice" + }, + { + "description": "Returns a slice, or sublist, of this list. The returned list contains the element specified by `from` and all subsequent elements up to, but not including, the element specified by `to`.", + "id": "script-api:dw/util/List#slice", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "from", + "type": "number" + }, + { + "name": "to", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.slice", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a slice, or sublist, of this list. The returned list contains the\nelement specified by `from` and all subsequent elements up to,\nbut not including, the element specified by `to`.", + "heading": "Description" + } + ], + "signature": "slice(from: number, to: number): List", + "source": "script-api", + "tags": [ + "slice", + "list.slice" + ], + "title": "List.slice" + }, + { + "description": "Sorts the elements of the list based on their natural order.", + "id": "script-api:dw/util/List#sort", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.sort", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sorts the elements of the list based on their natural\norder.\n\nThis sort is guaranteed to be stable: equal elements will\nnot be reordered as a result of the sort.", + "heading": "Description" + } + ], + "signature": "sort(): void", + "source": "script-api", + "tags": [ + "sort", + "list.sort" + ], + "title": "List.sort" + }, + { + "description": "Sorts the elements of a list. The order of the elements is determined with a comparator (see PropertyComparator) or with the help of the given function. The function must take two parameters and return a value <0 if the first parameter is smaller than the second, a value of 0 if both are equal and a value if >0 if the first one is greater than the second parameter.", + "id": "script-api:dw/util/List#sort", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "comparator", + "type": "Object" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.sort", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Sorts the elements of a list. The order of the elements is\ndetermined with a comparator (see PropertyComparator) or with the help\nof the given function. The function must take two parameters and return\na value <0 if the first parameter is smaller than the second, a value\nof 0 if both are equal and a value if >0 if the first one is greater\nthan the second parameter.\n\nThis sort is guaranteed to be stable: equal elements will\nnot be reordered as a result of the sort.", + "heading": "Description" + } + ], + "signature": "sort(comparator: Object): void", + "source": "script-api", + "tags": [ + "sort", + "list.sort" + ], + "title": "List.sort" + }, + { + "description": "Returns a list containing the elements in this list identified by the specified arguments.", + "id": "script-api:dw/util/List#subList", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "from", + "type": "number" + }, + { + "name": "to", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.subList", + "returns": { + "type": "List" + }, + "sections": [ + { + "body": "Returns a list containing the elements in this list identified\nby the specified arguments.", + "heading": "Description" + } + ], + "signature": "subList(from: number, to: number): List", + "source": "script-api", + "tags": [ + "sublist", + "list.sublist" + ], + "title": "List.subList" + }, + { + "description": "Swaps the elements at the specified positions in the list.", + "id": "script-api:dw/util/List#swap", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "i", + "type": "number" + }, + { + "name": "j", + "type": "number" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.swap", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Swaps the elements at the specified positions in the list.", + "heading": "Description" + } + ], + "signature": "swap(i: number, j: number): void", + "source": "script-api", + "tags": [ + "swap", + "list.swap" + ], + "title": "List.swap" + }, + { + "description": "Inserts values at the beginning of the list. The first argument becomes the new element 0; the second argument becomes element 1; and so on.", + "id": "script-api:dw/util/List#unshift", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "values", + "optional": true, + "type": "any[]" + } + ], + "parentId": "script-api:dw/util/List", + "qualifiedName": "dw.util.List.unshift", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Inserts values at the beginning of the list. The first argument\nbecomes the new element 0; the second argument becomes element 1;\nand so on.", + "heading": "Description" + } + ], + "signature": "unshift(values?: any[]): number", + "source": "script-api", + "tags": [ + "unshift", + "list.unshift" + ], + "title": "List.unshift" + }, + { + "description": "Represents a Locale supported by the system.", + "id": "script-api:dw/util/Locale", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Locale", + "sections": [ + { + "body": "Represents a Locale supported by the system.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "locale", + "dw.util.locale", + "dw/util" + ], + "title": "Locale" + }, + { + "description": "Returns the String representation of the localeID.", + "id": "script-api:dw/util/Locale#ID", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ID", + "sections": [ + { + "body": "Returns the String representation of the localeID.\n\nCombines the language and the country key, concatenated with \"_\".\nFor example: \"en_US\". This attribute is the primary key of the class.", + "heading": "Description" + } + ], + "signature": "readonly ID: string", + "source": "script-api", + "tags": [ + "id", + "locale.id" + ], + "title": "Locale.ID" + }, + { + "description": "Returns the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#ISO3Country", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ISO3Country", + "sections": [ + { + "body": "Returns the uppercase ISO 3166 3-letter country/region code for this Locale.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly ISO3Country: string", + "source": "script-api", + "tags": [ + "iso3country", + "locale.iso3country" + ], + "title": "Locale.ISO3Country" + }, + { + "description": "Returns the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#ISO3Language", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.ISO3Language", + "sections": [ + { + "body": "Returns the 3-letter ISO 639 language code for this Locale.\nIf no language has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly ISO3Language: string", + "source": "script-api", + "tags": [ + "iso3language", + "locale.iso3language" + ], + "title": "Locale.ISO3Language" + }, + { + "description": "Returns the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#country", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.country", + "sections": [ + { + "body": "Returns the uppercase ISO 3166 2-letter country/region code for this Locale.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly country: string", + "source": "script-api", + "tags": [ + "country", + "locale.country" + ], + "title": "Locale.country" + }, + { + "description": "Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#displayCountry", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayCountry", + "sections": [ + { + "body": "Returns the display name of this Locale's country, in this Locale's language,\nnot in the session locale's language.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly displayCountry: string", + "source": "script-api", + "tags": [ + "displaycountry", + "locale.displaycountry" + ], + "title": "Locale.displayCountry" + }, + { + "description": "Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#displayLanguage", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayLanguage", + "sections": [ + { + "body": "Returns the display name of this Locale's language, in this Locale's language,\nnot in the session locale's language.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly displayLanguage: string", + "source": "script-api", + "tags": [ + "displaylanguage", + "locale.displaylanguage" + ], + "title": "Locale.displayLanguage" + }, + { + "description": "Returns the display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#displayName", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.displayName", + "sections": [ + { + "body": "Returns the display name of this Locale, in this Locale's language,\nnot in the session locale's language.\nIf no display name has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly displayName: string", + "source": "script-api", + "tags": [ + "displayname", + "locale.displayname" + ], + "title": "Locale.displayName" + }, + { + "description": "Returns the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getCountry", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getCountry", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the uppercase ISO 3166 2-letter country/region code for this Locale.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getCountry(): string", + "source": "script-api", + "tags": [ + "getcountry", + "locale.getcountry" + ], + "title": "Locale.getCountry" + }, + { + "description": "Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getDisplayCountry", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayCountry", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of this Locale's country, in this Locale's language,\nnot in the session locale's language.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getDisplayCountry(): string", + "source": "script-api", + "tags": [ + "getdisplaycountry", + "locale.getdisplaycountry" + ], + "title": "Locale.getDisplayCountry" + }, + { + "description": "Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getDisplayLanguage", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayLanguage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of this Locale's language, in this Locale's language,\nnot in the session locale's language.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getDisplayLanguage(): string", + "source": "script-api", + "tags": [ + "getdisplaylanguage", + "locale.getdisplaylanguage" + ], + "title": "Locale.getDisplayLanguage" + }, + { + "description": "Returns the display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getDisplayName", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getDisplayName", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the display name of this Locale, in this Locale's language,\nnot in the session locale's language.\nIf no display name has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getDisplayName(): string", + "source": "script-api", + "tags": [ + "getdisplayname", + "locale.getdisplayname" + ], + "title": "Locale.getDisplayName" + }, + { + "description": "Returns the String representation of the localeID.", + "id": "script-api:dw/util/Locale#getID", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getID", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the String representation of the localeID.\n\nCombines the language and the country key, concatenated with \"_\".\nFor example: \"en_US\". This attribute is the primary key of the class.", + "heading": "Description" + } + ], + "signature": "getID(): string", + "source": "script-api", + "tags": [ + "getid", + "locale.getid" + ], + "title": "Locale.getID" + }, + { + "description": "Returns the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getISO3Country", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getISO3Country", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the uppercase ISO 3166 3-letter country/region code for this Locale.\nIf no country has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getISO3Country(): string", + "source": "script-api", + "tags": [ + "getiso3country", + "locale.getiso3country" + ], + "title": "Locale.getISO3Country" + }, + { + "description": "Returns the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getISO3Language", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getISO3Language", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the 3-letter ISO 639 language code for this Locale.\nIf no language has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getISO3Language(): string", + "source": "script-api", + "tags": [ + "getiso3language", + "locale.getiso3language" + ], + "title": "Locale.getISO3Language" + }, + { + "description": "Returns the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#getLanguage", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLanguage", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the lowercase ISO 639 language code for this Locale.\nIf no language has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "getLanguage(): string", + "source": "script-api", + "tags": [ + "getlanguage", + "locale.getlanguage" + ], + "title": "Locale.getLanguage" + }, + { + "description": "Returns a Locale instance for the given localeId, or `null` if no such Locale could be found.", + "id": "script-api:dw/util/Locale#getLocale", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "localeId", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLocale", + "returns": { + "type": "Locale | null" + }, + "sections": [ + { + "body": "Returns a Locale instance for the given localeId, or\n`null` if no such Locale could be found.", + "heading": "Description" + } + ], + "signature": "static getLocale(localeId: string): Locale | null", + "source": "script-api", + "tags": [ + "getlocale", + "locale.getlocale" + ], + "title": "Locale.getLocale" + }, + { + "description": "Returns a Locale instance for the given localeId, or `null` if no such Locale could be found.", + "id": "script-api:dw/util/Locale#getLocale", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "localeId", + "type": "string" + } + ], + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.getLocale", + "returns": { + "type": "Locale | null" + }, + "sections": [ + { + "body": "Returns a Locale instance for the given localeId, or\n`null` if no such Locale could be found.", + "heading": "Description" + } + ], + "signature": "static getLocale(localeId: string): Locale | null", + "source": "script-api", + "tags": [ + "getlocale", + "locale.getlocale" + ], + "title": "Locale.getLocale" + }, + { + "description": "Returns the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.", + "id": "script-api:dw/util/Locale#language", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.language", + "sections": [ + { + "body": "Returns the lowercase ISO 639 language code for this Locale.\nIf no language has been specified for this Locale, this value is an empty string.", + "heading": "Description" + } + ], + "signature": "readonly language: string", + "source": "script-api", + "tags": [ + "language", + "locale.language" + ], + "title": "Locale.language" + }, + { + "description": "Returns the String representation of the localeID.", + "id": "script-api:dw/util/Locale#toString", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Locale", + "qualifiedName": "dw.util.Locale.toString", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Returns the String representation of the localeID.\n\nCombines the language and the country key, concatenated with \"_\".\nFor example: \"en_US\". This attribute is the primary key of the class.", + "heading": "Description" + } + ], + "signature": "toString(): string", + "source": "script-api", + "tags": [ + "tostring", + "locale.tostring" + ], + "title": "Locale.toString" + }, + { + "description": "Represents a Map of objects.", + "id": "script-api:dw/util/Map", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.Map", + "sections": [ + { + "body": "Represents a Map of objects.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "map", + "dw.util.map", + "dw/util" + ], + "title": "Map" + }, + { + "description": "Convenience variable, for an empty and immutable list.", + "id": "script-api:dw/util/Map#EMPTY_MAP", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.EMPTY_MAP", + "sections": [ + { + "body": "Convenience variable, for an empty and immutable list.", + "heading": "Description" + } + ], + "signature": "static EMPTY_MAP: Map", + "source": "script-api", + "tags": [ + "empty_map", + "map.empty_map" + ], + "title": "Map.EMPTY_MAP" + }, + { + "description": "Convenience variable, for an empty and immutable list.", + "id": "script-api:dw/util/Map#EMPTY_MAP", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.EMPTY_MAP", + "sections": [ + { + "body": "Convenience variable, for an empty and immutable list.", + "heading": "Description" + } + ], + "signature": "static EMPTY_MAP: Map", + "source": "script-api", + "tags": [ + "empty_map", + "map.empty_map" + ], + "title": "Map.EMPTY_MAP" + }, + { + "description": "Clears the map of all objects.", + "id": "script-api:dw/util/Map#clear", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.clear", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Clears the map of all objects.", + "heading": "Description" + } + ], + "signature": "clear(): void", + "source": "script-api", + "tags": [ + "clear", + "map.clear" + ], + "title": "Map.clear" + }, + { + "description": "Identifies if this map contains an element identfied by the specified key.", + "id": "script-api:dw/util/Map#containsKey", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "key", + "type": "K" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.containsKey", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this map contains an element identfied\nby the specified key.", + "heading": "Description" + } + ], + "signature": "containsKey(key: K): boolean", + "source": "script-api", + "tags": [ + "containskey", + "map.containskey" + ], + "title": "Map.containsKey" + }, + { + "description": "Identifies if this map contains an element identfied by the specified value.", + "id": "script-api:dw/util/Map#containsValue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "value", + "type": "V" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.containsValue", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this map contains an element identfied\nby the specified value.", + "heading": "Description" + } + ], + "signature": "containsValue(value: V): boolean", + "source": "script-api", + "tags": [ + "containsvalue", + "map.containsvalue" + ], + "title": "Map.containsValue" + }, + { + "description": "Identifies if this map is empty.", + "id": "script-api:dw/util/Map#empty", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.empty", + "sections": [ + { + "body": "Identifies if this map is empty.", + "heading": "Description" + } + ], + "signature": "readonly empty: boolean", + "source": "script-api", + "tags": [ + "empty", + "map.empty" + ], + "title": "Map.empty" + }, + { + "description": "Returns a set of the map's entries. The returned set is actually a view to the entries of this map.", + "id": "script-api:dw/util/Map#entrySet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.entrySet", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns a set of the map's entries. The returned set is actually a view to the entries of this map.", + "heading": "Description" + } + ], + "signature": "entrySet(): utilSet", + "source": "script-api", + "tags": [ + "entryset", + "map.entryset" + ], + "title": "Map.entrySet" + }, + { + "description": "Returns the object associated with the key or null.", + "id": "script-api:dw/util/Map#get", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "key", + "type": "K" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.get", + "returns": { + "type": "V | null" + }, + "sections": [ + { + "body": "Returns the object associated with the key or null.", + "heading": "Description" + } + ], + "signature": "get(key: K): V | null", + "source": "script-api", + "tags": [ + "get", + "map.get" + ], + "title": "Map.get" + }, + { + "description": "REturns the size of the map. This is a bean attribute method and supports the access to the collections length similar to a ECMA array, such as 'products.length'.", + "id": "script-api:dw/util/Map#getLength", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.getLength", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "REturns the size of the map. This is a bean attribute method and\nsupports the access to the collections\nlength similar to a ECMA array, such as 'products.length'.", + "heading": "Description" + } + ], + "signature": "getLength(): number", + "source": "script-api", + "tags": [ + "getlength", + "map.getlength" + ], + "title": "Map.getLength" + }, + { + "description": "Identifies if this map is empty.", + "id": "script-api:dw/util/Map#isEmpty", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.isEmpty", + "returns": { + "type": "boolean" + }, + "sections": [ + { + "body": "Identifies if this map is empty.", + "heading": "Description" + } + ], + "signature": "isEmpty(): boolean", + "source": "script-api", + "tags": [ + "isempty", + "map.isempty" + ], + "title": "Map.isEmpty" + }, + { + "description": "Returns a set of the map's keys. The returned set is actually a view to the keys of this map.", + "id": "script-api:dw/util/Map#keySet", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.keySet", + "returns": { + "type": "utilSet" + }, + "sections": [ + { + "body": "Returns a set of the map's keys. The returned set is actually a view to the keys of this map.", + "heading": "Description" + } + ], + "signature": "keySet(): utilSet", + "source": "script-api", + "tags": [ + "keyset", + "map.keyset" + ], + "title": "Map.keySet" + }, + { + "description": "REturns the size of the map. This is a bean attribute method and supports the access to the collections length similar to a ECMA array, such as 'products.length'.", + "id": "script-api:dw/util/Map#length", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.length", + "sections": [ + { + "body": "REturns the size of the map. This is a bean attribute method and\nsupports the access to the collections\nlength similar to a ECMA array, such as 'products.length'.", + "heading": "Description" + } + ], + "signature": "readonly length: number", + "source": "script-api", + "tags": [ + "length", + "map.length" + ], + "title": "Map.length" + }, + { + "description": "Puts the specified value into the map using the specified key to identify it.", + "id": "script-api:dw/util/Map#put", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "key", + "type": "K" + }, + { + "name": "value", + "type": "V" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.put", + "returns": { + "type": "V | null" + }, + "sections": [ + { + "body": "Puts the specified value into the map using the\nspecified key to identify it.", + "heading": "Description" + } + ], + "signature": "put(key: K, value: V): V | null", + "source": "script-api", + "tags": [ + "put", + "map.put" + ], + "title": "Map.put" + }, + { + "description": "Copies all of the objects inside the specified map into this map.", + "id": "script-api:dw/util/Map#putAll", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "other", + "type": "Map" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.putAll", + "returns": { + "type": "void" + }, + "sections": [ + { + "body": "Copies all of the objects inside the specified map\ninto this map.", + "heading": "Description" + } + ], + "signature": "putAll(other: Map): void", + "source": "script-api", + "tags": [ + "putall", + "map.putall" + ], + "title": "Map.putAll" + }, + { + "description": "Removes the object from the map that is identified by the key.", + "id": "script-api:dw/util/Map#remove", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "key", + "type": "K" + } + ], + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.remove", + "returns": { + "type": "V | null" + }, + "sections": [ + { + "body": "Removes the object from the map that is identified by the key.", + "heading": "Description" + } + ], + "signature": "remove(key: K): V | null", + "source": "script-api", + "tags": [ + "remove", + "map.remove" + ], + "title": "Map.remove" + }, + { + "description": "Returns the size of the map.", + "id": "script-api:dw/util/Map#size", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.size", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Returns the size of the map.", + "heading": "Description" + } + ], + "signature": "size(): number", + "source": "script-api", + "tags": [ + "size", + "map.size" + ], + "title": "Map.size" + }, + { + "description": "Returns a collection of the values contained in this map.", + "id": "script-api:dw/util/Map#values", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/Map", + "qualifiedName": "dw.util.Map.values", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "Returns a collection of the values contained in this map.", + "heading": "Description" + } + ], + "signature": "values(): Collection", + "source": "script-api", + "tags": [ + "values", + "map.values" + ], + "title": "Map.values" + }, + { + "description": "The class represent an entry within a Map.", + "id": "script-api:dw/util/MapEntry", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MapEntry", + "sections": [ + { + "body": "The class represent an entry within a Map.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mapentry", + "dw.util.mapentry", + "dw/util" + ], + "title": "MapEntry" + }, + { + "description": "Returns the entry's key.", + "id": "script-api:dw/util/MapEntry#getKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.getKey", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the entry's key.", + "heading": "Description" + } + ], + "signature": "getKey(): any", + "source": "script-api", + "tags": [ + "getkey", + "mapentry.getkey" + ], + "title": "MapEntry.getKey" + }, + { + "description": "Returns the entry's value.", + "id": "script-api:dw/util/MapEntry#getValue", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.getValue", + "returns": { + "type": "any" + }, + "sections": [ + { + "body": "Returns the entry's value.", + "heading": "Description" + } + ], + "signature": "getValue(): any", + "source": "script-api", + "tags": [ + "getvalue", + "mapentry.getvalue" + ], + "title": "MapEntry.getValue" + }, + { + "description": "Returns the entry's key.", + "id": "script-api:dw/util/MapEntry#key", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.key", + "sections": [ + { + "body": "Returns the entry's key.", + "heading": "Description" + } + ], + "signature": "readonly key: any", + "source": "script-api", + "tags": [ + "key", + "mapentry.key" + ], + "title": "MapEntry.key" + }, + { + "description": "Returns the entry's value.", + "id": "script-api:dw/util/MapEntry#value", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MapEntry", + "qualifiedName": "dw.util.MapEntry.value", + "sections": [ + { + "body": "Returns the entry's value.", + "heading": "Description" + } + ], + "signature": "readonly value: any", + "source": "script-api", + "tags": [ + "value", + "mapentry.value" + ], + "title": "MapEntry.value" + }, + { + "description": "Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a single string (e.g. product id) or multiple string components (e.g. product id and site).", + "id": "script-api:dw/util/MappingKey", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MappingKey", + "sections": [ + { + "body": "Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a\nsingle string (e.g. product id) or multiple string components (e.g. product id and site).", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mappingkey", + "dw.util.mappingkey", + "dw/util" + ], + "title": "MappingKey" + }, + { + "description": "Gets the (possible compound) key. If the key consists of only of a single value, the string array will simply contain a single element.", + "id": "script-api:dw/util/MappingKey#getKeyComponents", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.getKeyComponents", + "returns": { + "type": "string[]" + }, + "sections": [ + { + "body": "Gets the (possible compound) key. If the key consists of only of a single value, the string array\nwill simply contain a single element.", + "heading": "Description" + } + ], + "signature": "getKeyComponents(): string[]", + "source": "script-api", + "tags": [ + "getkeycomponents", + "mappingkey.getkeycomponents" + ], + "title": "MappingKey.getKeyComponents" + }, + { + "description": "Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is not a single component key.", + "id": "script-api:dw/util/MappingKey#getSingleComponentKey", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.getSingleComponentKey", + "returns": { + "type": "string | null" + }, + "sections": [ + { + "body": "Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is\nnot a single component key.", + "heading": "Description" + } + ], + "signature": "getSingleComponentKey(): string | null", + "source": "script-api", + "tags": [ + "getsinglecomponentkey", + "mappingkey.getsinglecomponentkey" + ], + "title": "MappingKey.getSingleComponentKey" + }, + { + "description": "Gets the (possible compound) key. If the key consists of only of a single value, the string array will simply contain a single element.", + "id": "script-api:dw/util/MappingKey#keyComponents", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.keyComponents", + "sections": [ + { + "body": "Gets the (possible compound) key. If the key consists of only of a single value, the string array\nwill simply contain a single element.", + "heading": "Description" + } + ], + "signature": "readonly keyComponents: string[]", + "source": "script-api", + "tags": [ + "keycomponents", + "mappingkey.keycomponents" + ], + "title": "MappingKey.keyComponents" + }, + { + "description": "Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is not a single component key.", + "id": "script-api:dw/util/MappingKey#singleComponentKey", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingKey", + "qualifiedName": "dw.util.MappingKey.singleComponentKey", + "sections": [ + { + "body": "Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is\nnot a single component key.", + "heading": "Description" + } + ], + "signature": "readonly singleComponentKey: string | null", + "source": "script-api", + "tags": [ + "singlecomponentkey", + "mappingkey.singlecomponentkey" + ], + "title": "MappingKey.singleComponentKey" + }, + { + "description": "Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be used to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings.", + "id": "script-api:dw/util/MappingMgr", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.MappingMgr", + "sections": [ + { + "body": "Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be\nused to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings.\n\nMappings are read into the system using the ImportKeyValueMapping job step.\n\nGeneric mapping capability enables you to map keys to values, with the mapping stored in a high-performance data\nstore that is independent of the database. This supports large datasets, with high performance for lookup. An example\nof using this feature is to map SKUs from a backend system to Commerce Cloud Digital SKUs on-the-fly in Digital script, so\nthat interaction with the backend system is transparent and does not require adding Digital SKUs to the third\nparty system.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "mappingmgr", + "dw.util.mappingmgr", + "dw/util" + ], + "title": "MappingMgr" + }, + { + "description": "Returns a map containing value(s) associated to the specified key for the specified mapping.", + "id": "script-api:dw/util/MappingMgr#get", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + }, + { + "name": "key", + "type": "MappingKey" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.get", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a map containing value(s) associated to the specified key for the specified mapping.", + "heading": "Description" + } + ], + "signature": "static get(mappingName: string, key: MappingKey): utilMap", + "source": "script-api", + "tags": [ + "get", + "mappingmgr.get" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.get" + }, + { + "description": "Returns a map containing value(s) associated to the specified key for the specified mapping.", + "id": "script-api:dw/util/MappingMgr#get", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + }, + { + "name": "key", + "type": "MappingKey" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.get", + "returns": { + "type": "utilMap" + }, + "sections": [ + { + "body": "Returns a map containing value(s) associated to the specified key for the specified mapping.", + "heading": "Description" + } + ], + "signature": "static get(mappingName: string, key: MappingKey): utilMap", + "source": "script-api", + "tags": [ + "get", + "mappingmgr.get" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.get" + }, + { + "description": "Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an exception if mappingName does not exist.", + "id": "script-api:dw/util/MappingMgr#getFirst", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + }, + { + "name": "key", + "type": "MappingKey" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getFirst", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an\nexception if mappingName does not exist.", + "heading": "Description" + } + ], + "signature": "static getFirst(mappingName: string, key: MappingKey): string", + "source": "script-api", + "tags": [ + "getfirst", + "mappingmgr.getfirst" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.getFirst" + }, + { + "description": "Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an exception if mappingName does not exist.", + "id": "script-api:dw/util/MappingMgr#getFirst", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + }, + { + "name": "key", + "type": "MappingKey" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getFirst", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an\nexception if mappingName does not exist.", + "heading": "Description" + } + ], + "signature": "static getFirst(mappingName: string, key: MappingKey): string", + "source": "script-api", + "tags": [ + "getfirst", + "mappingmgr.getfirst" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.getFirst" + }, + { + "description": "List all known mappings.", + "id": "script-api:dw/util/MappingMgr#getMappingNames", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getMappingNames", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "List all known mappings.", + "heading": "Description" + } + ], + "signature": "static getMappingNames(): Collection", + "source": "script-api", + "tags": [ + "getmappingnames", + "mappingmgr.getmappingnames" + ], + "title": "MappingMgr.getMappingNames" + }, + { + "description": "List all known mappings.", + "id": "script-api:dw/util/MappingMgr#getMappingNames", + "kind": "method", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.getMappingNames", + "returns": { + "type": "Collection" + }, + "sections": [ + { + "body": "List all known mappings.", + "heading": "Description" + } + ], + "signature": "static getMappingNames(): Collection", + "source": "script-api", + "tags": [ + "getmappingnames", + "mappingmgr.getmappingnames" + ], + "title": "MappingMgr.getMappingNames" + }, + { + "description": "Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.", + "id": "script-api:dw/util/MappingMgr#keyIterator", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.keyIterator", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.", + "heading": "Description" + } + ], + "signature": "static keyIterator(mappingName: string): SeekableIterator", + "source": "script-api", + "tags": [ + "keyiterator", + "mappingmgr.keyiterator" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.keyIterator" + }, + { + "description": "Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.", + "id": "script-api:dw/util/MappingMgr#keyIterator", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "mappingName", + "type": "string" + } + ], + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.keyIterator", + "returns": { + "type": "SeekableIterator" + }, + "sections": [ + { + "body": "Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.", + "heading": "Description" + } + ], + "signature": "static keyIterator(mappingName: string): SeekableIterator", + "source": "script-api", + "tags": [ + "keyiterator", + "mappingmgr.keyiterator" + ], + "throws": [ + { + "description": "if mappingName is unknown", + "type": "IllegalArgumentException" + } + ], + "title": "MappingMgr.keyIterator" + }, + { + "description": "List all known mappings.", + "id": "script-api:dw/util/MappingMgr#mappingNames", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.mappingNames", + "sections": [ + { + "body": "List all known mappings.", + "heading": "Description" + } + ], + "signature": "static readonly mappingNames: Collection", + "source": "script-api", + "tags": [ + "mappingnames", + "mappingmgr.mappingnames" + ], + "title": "MappingMgr.mappingNames" + }, + { + "description": "List all known mappings.", + "id": "script-api:dw/util/MappingMgr#mappingNames", + "kind": "property", + "packagePath": "dw/util", + "parentId": "script-api:dw/util/MappingMgr", + "qualifiedName": "dw.util.MappingMgr.mappingNames", + "sections": [ + { + "body": "List all known mappings.", + "heading": "Description" + } + ], + "signature": "static readonly mappingNames: Collection", + "source": "script-api", + "tags": [ + "mappingnames", + "mappingmgr.mappingnames" + ], + "title": "MappingMgr.mappingNames" + }, + { + "description": "This comparator can be used for the List sort() methods and for the SortSet and SortedMap classes. The comparator can be used to make a comparison based on a property of the contained objects. The Comparison is done based on the natural order of the values. It is guaranteed to work for Numbers, Strings, Dates, Money and Quantity values.", + "id": "script-api:dw/util/PropertyComparator", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.PropertyComparator", + "sections": [ + { + "body": "This comparator can be used for the List sort() methods and for the SortSet\nand SortedMap classes. The comparator can be used to make a comparison based\non a property of the contained objects. The Comparison is done based on the\nnatural order of the values. It is guaranteed to work for Numbers, Strings,\nDates, Money and Quantity values.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "propertycomparator", + "dw.util.propertycomparator", + "dw/util" + ], + "title": "PropertyComparator" + }, + { + "description": "Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. By default a null value is treated always greater than any other value. In the constructor of a PropertyComparator this default behavior can be changed.", + "id": "script-api:dw/util/PropertyComparator#compare", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "arg1", + "type": "any" + }, + { + "name": "arg2", + "type": "any" + } + ], + "parentId": "script-api:dw/util/PropertyComparator", + "qualifiedName": "dw.util.PropertyComparator.compare", + "returns": { + "type": "number" + }, + "sections": [ + { + "body": "Compares its two arguments for order. Returns a negative integer, zero,\nor a positive integer as the first argument is less than, equal to, or\ngreater than the second. By default a null value is treated always\ngreater than any other value. In the constructor of a PropertyComparator\nthis default behavior can be changed.", + "heading": "Description" + } + ], + "signature": "compare(arg1: any, arg2: any): number", + "source": "script-api", + "tags": [ + "compare", + "propertycomparator.compare" + ], + "title": "PropertyComparator.compare" + }, + { + "description": "SecureEncoder contains many methods for manipulating untrusted data Strings into RFC-Compliant Strings for a given context by encoding \"bad\" data into the proper format.", + "id": "script-api:dw/util/SecureEncoder", + "kind": "class", + "packagePath": "dw/util", + "parentId": "script-api:dw/util", + "qualifiedName": "dw.util.SecureEncoder", + "sections": [ + { + "body": "SecureEncoder contains many methods for manipulating untrusted data Strings\ninto RFC-Compliant Strings for a given context by encoding \"bad\" data into\nthe proper format.", + "heading": "Description" + } + ], + "source": "script-api", + "tags": [ + "secureencoder", + "dw.util.secureencoder", + "dw/util" + ], + "title": "SecureEncoder" + }, + { + "description": "Encodes a given input for use in a general HTML context. E.g. text content and text attributes. This method takes the UNION of allowed characters between the two context, so may be more imprecise that the more specific contexts. Generally, this method is preferred unless you specifically understand the context in which untrusted data will be output.", + "examples": [ + "
    ${SecureEncoder.forHtmlContent(unsafeData)}
    \n\n" + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlContent", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in a general HTML context. E.g.\ntext content and text attributes. This method takes the UNION of allowed\ncharacters between the two context, so may be more imprecise that the\nmore specific contexts. Generally, this method is preferred unless you\nspecifically understand the context in which untrusted data will be\noutput.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlContent(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlcontent", + "secureencoder.forhtmlcontent" + ], + "title": "SecureEncoder.forHtmlContent" + }, + { + "description": "Encodes a given input for use in a general HTML context. E.g. text content and text attributes. This method takes the UNION of allowed characters between the two context, so may be more imprecise that the more specific contexts. Generally, this method is preferred unless you specifically understand the context in which untrusted data will be output.", + "examples": [ + "
    ${SecureEncoder.forHtmlContent(unsafeData)}
    \n\n" + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlContent", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlContent", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in a general HTML context. E.g.\ntext content and text attributes. This method takes the UNION of allowed\ncharacters between the two context, so may be more imprecise that the\nmore specific contexts. Generally, this method is preferred unless you\nspecifically understand the context in which untrusted data will be\noutput.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlContent(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlcontent", + "secureencoder.forhtmlcontent" + ], + "title": "SecureEncoder.forHtmlContent" + }, + { + "description": "Encodes a given input for use in an HTML Attribute guarded by a double quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInDoubleQuoteAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute guarded by a double\nquote. This method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlInDoubleQuoteAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlindoublequoteattribute", + "secureencoder.forhtmlindoublequoteattribute" + ], + "title": "SecureEncoder.forHtmlInDoubleQuoteAttribute" + }, + { + "description": "Encodes a given input for use in an HTML Attribute guarded by a double quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlInDoubleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInDoubleQuoteAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute guarded by a double\nquote. This method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlInDoubleQuoteAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlindoublequoteattribute", + "secureencoder.forhtmlindoublequoteattribute" + ], + "title": "SecureEncoder.forHtmlInDoubleQuoteAttribute" + }, + { + "description": "Encodes a given input for use in an HTML Attribute guarded by a single quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInSingleQuoteAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute guarded by a single\nquote. This method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlInSingleQuoteAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlinsinglequoteattribute", + "secureencoder.forhtmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forHtmlInSingleQuoteAttribute" + }, + { + "description": "Encodes a given input for use in an HTML Attribute guarded by a single quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlInSingleQuoteAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlInSingleQuoteAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute guarded by a single\nquote. This method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlInSingleQuoteAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlinsinglequoteattribute", + "secureencoder.forhtmlinsinglequoteattribute" + ], + "title": "SecureEncoder.forHtmlInSingleQuoteAttribute" + }, + { + "description": "Encodes a given input for use in an HTML Attribute left unguarded. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlUnquotedAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute left unguarded.\nThis method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlUnquotedAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlunquotedattribute", + "secureencoder.forhtmlunquotedattribute" + ], + "title": "SecureEncoder.forHtmlUnquotedAttribute" + }, + { + "description": "Encodes a given input for use in an HTML Attribute left unguarded. This method is preferred if you understand exactly how the output of this will be used in the HTML document.", + "examples": [ + "
    " + ], + "id": "script-api:dw/util/SecureEncoder#forHtmlUnquotedAttribute", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forHtmlUnquotedAttribute", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in an HTML Attribute left unguarded.\nThis method is preferred if you understand exactly how the output\nof this will be used in the HTML document.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics and some Special characters\n- Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F)\nwith �, the Unicode Replacement Character\n- Replace special HTML characters with their HTML Entity equivalents", + "heading": "Description" + } + ], + "signature": "static forHtmlUnquotedAttribute(input: string): string", + "source": "script-api", + "tags": [ + "forhtmlunquotedattribute", + "secureencoder.forhtmlunquotedattribute" + ], + "title": "SecureEncoder.forHtmlUnquotedAttribute" + }, + { + "description": "Encodes a given input for use in a JSON Object Value to prevent escaping into a trusted context.", + "examples": [ + "var json = {\"trusted_data\" : SecureEncoder.forJSONValue(unsafeData)};\nreturn JSON.stringify(json);" + ], + "id": "script-api:dw/util/SecureEncoder#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJSONValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in a JSON Object Value to prevent\nescaping into a trusted context.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics\n- Slash escape certain illegal characters\n- Replace all other characters with their Hex Encoded\nequivalents prepended with \\\\u", + "heading": "Description" + } + ], + "signature": "static forJSONValue(input: string): string", + "source": "script-api", + "tags": [ + "forjsonvalue", + "secureencoder.forjsonvalue" + ], + "title": "SecureEncoder.forJSONValue" + }, + { + "description": "Encodes a given input for use in a JSON Object Value to prevent escaping into a trusted context.", + "examples": [ + "var json = {\"trusted_data\" : SecureEncoder.forJSONValue(unsafeData)};\nreturn JSON.stringify(json);" + ], + "id": "script-api:dw/util/SecureEncoder#forJSONValue", + "kind": "method", + "packagePath": "dw/util", + "params": [ + { + "name": "input", + "type": "string" + } + ], + "parentId": "script-api:dw/util/SecureEncoder", + "qualifiedName": "dw.util.SecureEncoder.forJSONValue", + "returns": { + "type": "string" + }, + "sections": [ + { + "body": "Encodes a given input for use in a JSON Object Value to prevent\nescaping into a trusted context.\n\nExample Usage:\n\n\nFlow:\n\n- Allow AlphaNumerics\n- Slash escape certain illegal characters\n- Replace all other characters with their Hex Encoded\nequivalents prepended with \\\\u", + "heading": "Description" + } + ], + "signature": "static forJSONValue(input: string): string", + "source": "script-api", + "tags": [ + "forjsonvalue", + "secureencoder.forjsonvalue" + ], + "title": "SecureEncoder.forJSONValue" + }, + { + "description": "Encodes a given input for use in JavaScript inside an HTML attribute. This method is preferred if you understand exactly how the output of the will be used in the page", + "examples": [ + "